iaik.pkcs.pkcs11.provider

Interface Constants

public interface Constants

This is a public interface holding constants for this project.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ALGORITHM_PROPERTIES The name of the properties entry for the algorithms properties.
static java.lang.String	ALGORITHM_PROPERTIES_NAME The resource name of the list of the algorithms.
static java.lang.String	CHECK_MECHANISM_SUPPORTED The name of the properties entry for the mechanism-support-check feature.
static java.lang.String	CHECK_SESSION_INTEGRITY The name of the properties entry to check the session integrity after getting a session from the pool.
static boolean	DEBUG Specifies, if code in this package and all sub-packages are allowed to produce debug output.
static java.lang.String	DEFAULT_ALGORITHM_PROPERTIES_NAME The resource name of the default list of the algorithms.
static java.lang.String	DEFAULT_GLOBAL_PROPERTIES_NAME The resource name of the global default configuration properties.
static java.lang.String	DEFAULT_PROVIDER_PROPERTIES_NAME The resource name of the default configuration properties for a provider instance.
static java.lang.String	DELEGATE_PROVIDER The name of the properties entry for the delegate provider.
static java.lang.String	ENABLE_SOFTWARE_DELEGATION The name of the properties entry for the software delegation feature.
static java.lang.String	GLOBAL_DELEGATE_PROVIDER The name of the properties entry for the global delegate provider.
static java.lang.String	GLOBAL_KEY_HANDLER The name of the properties entry for the global key handler.
static java.lang.String	GLOBAL_PROPERTIES_NAME The resource name of the global configuration properties.
static java.lang.String	KEY_STORE_SUPPORT_PROVIDER The name of the properties entry for the key store support provider.
static java.lang.String	LINE_SEPARATOR The line separator used for debug outputs and in toString() methods.
static java.lang.String	LOGIN_KEYSTORE_SESSION_ON_DEMAND The name of the properties entry for the login on demand feature.
static java.lang.String	LOGIN_MANAGER The name of the properties entry for the login manager.
static java.lang.String	MODULE_ALREADY_INITIALIZED The name of the properties entry for the behavior in case of an CKR_CRYPTOKI_ALREADY_INITIALIZED error.
static java.lang.String	MODULE_INITIALIZATION_PARAMETERS The name of the properties entry for the module initialization parameter.
static java.lang.String	MULTI_THREAD_INIT The name of the properties entry for the multi-threaded initialization.
static java.lang.String	PKCS11_NATIVE_MODULE The name of the properties entry for the native module.
static java.lang.String	PKCS11_WRAPPER_NATIVE_DEBUG The name of the properties entry to use debug version of the PKCS#11 wrapper native library.
static java.lang.String	PKCS11_WRAPPER_PATH The name of the properties entry for the absolute path of the PKCS#11-Wrapper native library.
static java.lang.String	PROVIDER_INSTANCE_PREFIX The prefix of the name of the properties entry for each provider instance configuration in the global properties.
static java.lang.String	PROVIDER_PROPERTIES_NAME The resource name of the configuration properties for a provider instance.
static java.lang.String	SELF_AEAD_NONCE_HSM_MANUFACTURERS The (comma separated) list of manufacturer ids of HSMs that do not allow an external iv/nonce for encryption when an AEAD mode (like GCM or CCM) is used (default: Amazon AWS CloudHSM).
static java.lang.String	SESSION_POOL_MAX_SIZE The name of the properties entry for the maximum number of sessions to keep in the session pool (cache).
static java.lang.String	SLOT_ID The name of the properties entry for the slot ID.
static java.lang.String	USE_UTF8_ENCODING The name of the properties entry to set character encoding to UTF8.
static java.lang.String	USER_PIN The name of the properties entry for the user PIN.
static java.lang.String	ZERO_CHECK_HSM_GENERATED_AEAD_NONCE The name of the property deciding whether to check if an HSM generated iv/nonce does contain zeros only.

Field Detail

DEBUG

static final boolean DEBUG

Specifies, if code in this package and all sub-packages are allowed to produce debug output.

See Also:

Constant Field Values

LINE_SEPARATOR

static final java.lang.String LINE_SEPARATOR

The line separator used for debug outputs and in toString() methods.

PKCS11_NATIVE_MODULE

static final java.lang.String PKCS11_NATIVE_MODULE

The name of the properties entry for the native module.

See Also:

Constant Field Values

PKCS11_WRAPPER_PATH

static final java.lang.String PKCS11_WRAPPER_PATH

The name of the properties entry for the absolute path of the PKCS#11-Wrapper native library.

See Also:

Constant Field Values

USE_UTF8_ENCODING

static final java.lang.String USE_UTF8_ENCODING

The name of the properties entry to set character encoding to UTF8.

See Also:

Constant Field Values

MODULE_INITIALIZATION_PARAMETERS

static final java.lang.String MODULE_INITIALIZATION_PARAMETERS

The name of the properties entry for the module initialization parameter.

See Also:

Constant Field Values

SLOT_ID

static final java.lang.String SLOT_ID

The name of the properties entry for the slot ID.

See Also:

Constant Field Values

USER_PIN

static final java.lang.String USER_PIN

The name of the properties entry for the user PIN.

See Also:

Constant Field Values

LOGIN_KEYSTORE_SESSION_ON_DEMAND

static final java.lang.String LOGIN_KEYSTORE_SESSION_ON_DEMAND

The name of the properties entry for the login on demand feature.

See Also:

Constant Field Values

PKCS11_WRAPPER_NATIVE_DEBUG

static final java.lang.String PKCS11_WRAPPER_NATIVE_DEBUG

The name of the properties entry to use debug version of the PKCS#11 wrapper native library. Default value: false.

See Also:

Constant Field Values

KEY_STORE_SUPPORT_PROVIDER

static final java.lang.String KEY_STORE_SUPPORT_PROVIDER

The name of the properties entry for the key store support provider.

See Also:

Constant Field Values

DELEGATE_PROVIDER

static final java.lang.String DELEGATE_PROVIDER

The name of the properties entry for the delegate provider. This refers to the per-instance configuration.

See Also:

Constant Field Values

LOGIN_MANAGER

static final java.lang.String LOGIN_MANAGER

The name of the properties entry for the login manager.

See Also:

Constant Field Values

DEFAULT_GLOBAL_PROPERTIES_NAME

static final java.lang.String DEFAULT_GLOBAL_PROPERTIES_NAME

The resource name of the global default configuration properties. This resource is loaded by a class loader.

See Also:

Constant Field Values

GLOBAL_PROPERTIES_NAME

static final java.lang.String GLOBAL_PROPERTIES_NAME

The resource name of the global configuration properties. This resource is loaded by a class loader.

See Also:

Constant Field Values

ENABLE_SOFTWARE_DELEGATION

static final java.lang.String ENABLE_SOFTWARE_DELEGATION

The name of the properties entry for the software delegation feature.

See Also:

Constant Field Values

GLOBAL_DELEGATE_PROVIDER

static final java.lang.String GLOBAL_DELEGATE_PROVIDER

The name of the properties entry for the global delegate provider.

See Also:

Constant Field Values

GLOBAL_KEY_HANDLER

static final java.lang.String GLOBAL_KEY_HANDLER

The name of the properties entry for the global key handler.

See Also:

Constant Field Values

PROVIDER_INSTANCE_PREFIX

static final java.lang.String PROVIDER_INSTANCE_PREFIX

The prefix of the name of the properties entry for each provider instance configuration in the global properties.

See Also:

Constant Field Values

DEFAULT_PROVIDER_PROPERTIES_NAME

static final java.lang.String DEFAULT_PROVIDER_PROPERTIES_NAME

The resource name of the default configuration properties for a provider instance. This resource is loaded by a class loader.

See Also:

Constant Field Values

PROVIDER_PROPERTIES_NAME

static final java.lang.String PROVIDER_PROPERTIES_NAME

The resource name of the configuration properties for a provider instance. This resource is loaded by a class loader.

See Also:

Constant Field Values

DEFAULT_ALGORITHM_PROPERTIES_NAME

static final java.lang.String DEFAULT_ALGORITHM_PROPERTIES_NAME

The resource name of the default list of the algorithms. This resource is loaded by a class loader.

See Also:

Constant Field Values

ALGORITHM_PROPERTIES_NAME

static final java.lang.String ALGORITHM_PROPERTIES_NAME

The resource name of the list of the algorithms. This resource is loaded by a class loader.

See Also:

Constant Field Values

ALGORITHM_PROPERTIES

static final java.lang.String ALGORITHM_PROPERTIES

The name of the properties entry for the algorithms properties.

See Also:

Constant Field Values

SESSION_POOL_MAX_SIZE

static final java.lang.String SESSION_POOL_MAX_SIZE

The name of the properties entry for the maximum number of sessions to keep in the session pool (cache).

See Also:

Constant Field Values

CHECK_MECHANISM_SUPPORTED

static final java.lang.String CHECK_MECHANISM_SUPPORTED

The name of the properties entry for the mechanism-support-check feature.

See Also:

Constant Field Values

MULTI_THREAD_INIT

static final java.lang.String MULTI_THREAD_INIT

The name of the properties entry for the multi-threaded initialization.

See Also:

Constant Field Values

MODULE_ALREADY_INITIALIZED

static final java.lang.String MODULE_ALREADY_INITIALIZED

The name of the properties entry for the behavior in case of an CKR_CRYPTOKI_ALREADY_INITIALIZED error.

See Also:

Constant Field Values

SELF_AEAD_NONCE_HSM_MANUFACTURERS

static final java.lang.String SELF_AEAD_NONCE_HSM_MANUFACTURERS

The (comma separated) list of manufacturer ids of HSMs that do not allow an external iv/nonce for encryption when an AEAD mode (like GCM or CCM) is used (default: Amazon AWS CloudHSM). If set, an all-zeros iv/nonce has to be passed to a HSM (if manufactured by any of the given manufacturers) advising the HSM to itself create a random iv/nonce.

See Also:

Constant Field Values

ZERO_CHECK_HSM_GENERATED_AEAD_NONCE

static final java.lang.String ZERO_CHECK_HSM_GENERATED_AEAD_NONCE

The name of the property deciding whether to check if an HSM generated iv/nonce does contain zeros only. Only meaningful during an encryption or wrapping operation when a Cipher is used in AEAD mode. Only meaningful for HSM of manufacturers that have been set by the SELF_AEAD_NONCE_HSM_MANUFACTURERS property (default: true). Amazon CloudHSM, for instance, requires to initialize a GCM encryption/wrapping operation with a 0-initialized iv/nonce to be passed to the HSM that then takes care for random iv/nonce creation. If the SELF_AEAD_NONCE_HSM_MANUFACTURERS property contains the manufacturer id of the Amazon CloudHSM and this ZERO_CHECK_HSM_GENERATED_AEAD_NONCE property is set (default: true) the PKCS#IAIKPkcs11 Provider throws an Exception if the HSM returns an all-zeros iv/nonce.

See Also:

Constant Field Values

CHECK_SESSION_INTEGRITY

static final java.lang.String CHECK_SESSION_INTEGRITY

The name of the properties entry to check the session integrity after getting a session from the pool.

See Also:

Constant Field Values