Overview (Luna Java Security Provider API)

Packages
Package	Description
com.safenetinc.luna	Proprietary API for the LunaProvider (front end to Luna HSM).
com.safenetinc.luna.exception	Proprietary exception class support for LunaProvider (Luna-specific Java exceptions).
com.safenetinc.luna.provider	JCA-compliant implementation of the entry points for LunaProvider.
com.safenetinc.luna.provider.cipher	JCA-compliant implementation of various cryptographic ciphers for LunaProvider.
com.safenetinc.luna.provider.digest	JCA-compliant implementation of various message digest algorithms for LunaProvider.
com.safenetinc.luna.provider.key	JCA-compliant implementation of public, private and secret key data for LunaProvider.
com.safenetinc.luna.provider.keyagree	JCA-compliant implementation of key agreement algorithms for LunaProvider.
com.safenetinc.luna.provider.keyderive	SOON TO BE MOVED TO com.safenetinc.luna.provider.keyfactory
com.safenetinc.luna.provider.keyfactory	JCA-compliant implementation of key factories that translate and create Luna keys for LunaProvider.
com.safenetinc.luna.provider.keygen	JCA-compliant implementation of key generator classes to create new Luna secret keys and public/private key pairs for LunaProvider.
com.safenetinc.luna.provider.mac	JCA-compliant implementation of hashed message authentication code (HMAC) functionality for LunaProvider.
com.safenetinc.luna.provider.param	JCA-compliant implementation of algorithm parameters for LunaProvider.
com.safenetinc.luna.provider.signature	JCA-compliant implementation of message signing and verification mechanisms using keys on the Luna HSM for LunaProvider.

This is the API specification for version 6+ of the LunaProvider( Gemalto SafeNet Luna HSM-based Java Security Provider). There are two main ways to use this provider:

JCA interface: This is an implementation of the Java Security Provider specification that uses the Luna HSM for cryptographic operations and key storage. It is meant to be used as a drop-in replacement for the standard SUN provider, with certain limitations due to the nature of the HSM (i.e. methods that involve exporting private key data in clear text directly are unsupported).
Proprietary interface: This makes use of the classes in the com.safenetinc.luna package. It allows for a more direct interface to the HSM, using objects that wrap a PKCS11-like API. Users that choose to use this interface should be have a good understanding of the workings of the Luna HSM in addition to basic cryptographic knowledge. See the table in that section of the Javadoc for more details.

There are many samples which are continually evolving to provide practical demonstrations as to how to employ primarily the JCA implementation but also, to a lesser degree, the proprietary API.

For the samples see:

<Luna client Install dir>/jsp/samples

(i.e. /usr/safenetinc/lunaclient/jsp/samples))

The basic architecture is as follows:

insert diagram here

The proprietary(non-JCA) API is described in detail in package com.safenetinc.luna

SafeNet Inc. Luna JSP API Specification