iaik.pkcs.pkcs11.parameters

Class UniqueIvParameters

java.lang.Object

iaik.pkcs.pkcs11.SelfDestructor

iaik.pkcs.pkcs11.parameters.UniqueIvParameters

Direct Known Subclasses:

CcmParameters, CK_CCM_PARAMS, CK_GCM_PARAMS, GcmParameters

public abstract class UniqueIvParameters
extends SelfDestructor

Class to hold the JNI pointer of an HSM generated IV/nonce when using a mode of operation that requires one. Stores a pointer to the Java byte array where the generated IV should eventually be written to and a pointer to the JNI byte array with its length when the IV/nonce is 0-initialized.

Field Summary

Fields

Modifier and Type	Field and Description
long	length Deprecated. This field is only used by the JNI code and should never be accessed directly.
long	pointer Deprecated. This field is only used by the JNI code and should never be accessed directly.

Constructor Summary

Constructors

Constructor and Description
UniqueIvParameters()

Method Summary

Modifier and Type	Method and Description
void	clean() Frees the native memory allocated for the IV buffer.
boolean	isConfiguredForIvWriteBack() Returns whether this object was successfully set up for write-back of an HSM generated IV/nonce after a call to C_EncryptInit

Methods inherited from class iaik.pkcs.pkcs11.SelfDestructor

close, finalize

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

pointer

@Deprecated
 @Unsafe(value="Usage may cause memory corruption or leaks!")
public volatile long pointer

Deprecated. This field is only used by the JNI code and should never be accessed directly.

The JNI pointer to the IV buffer used by the PKCS#11 library. This field is only used by the JNI code and should never be accessed directly.

length

@Deprecated
 @Unsafe(value="Usage may cause memory corruption or leaks!")
public volatile long length

Deprecated. This field is only used by the JNI code and should never be accessed directly.

The length of the IV buffer used by the PKCS#11 library. This field is only used by the JNI code and should never be accessed directly.

Constructor Detail

UniqueIvParameters

public UniqueIvParameters()

Method Detail

isConfiguredForIvWriteBack

public boolean isConfiguredForIvWriteBack()

Returns whether this object was successfully set up for write-back of an HSM generated IV/nonce after a call to C_EncryptInit

Returns:

true if this object is set up for IV/nonce write-back, false otherwise

clean

public void clean()

Frees the native memory allocated for the IV buffer.

Specified by:

clean in class SelfDestructor

See Also:

SelfDestructor.close()