public final class ModuleState
extends java.lang.Object
The possible module states include:
NOT_INITIALIZED
state, wich is the case before the power-up self-tests have been run. (See FIPS_140_2.powerUpSelfTest()
.)TESTING
state, which persists while the power-up self-tests are running.READY
state, which indicates that the power-up self-tests have been run and passed, and that no conditional self-test has failed.isErrorState()
, isRecoverableErrorState()
and isUnrecoverableErrorState()
methods.
A recoverable error state is one reached as a result of failure of one of the conditional self-tests. These include the testKeyPair
methods and the continuous random number generation tests in the RNGTest
class.
An unrecoverable error state is one reached as a result of failure of one of the power-up self-tests, whether run unconditionally at module load time or, optionally, by user code at any subsequent time.
Operational (non-error) states have integer values in the range 0 to 99 inclusive. Recoverable error state codes are between 100 to 199 inclusive. Unrecoverable error state codes are between 200 and 299 inclusive.
A recoverable error state may be cleared by invoking the FIPS_140_2.clearModuleState()
method, which resets the module state to NOT_INITIALIZED
.
An unrecoverable error state may not be cleared, and results in inoperability of the module until it is unloaded from the system and reloaded.
FIPS_140_2
, RNGTest
, ModuleStateException
, SelfTestException
Modifier and Type | Field and Description |
---|---|
static ModuleState |
ERROR_TEST_3DES_KNOWN_ANSWER
Power-up Triple-DES known-answer test failed.
|
static ModuleState |
ERROR_TEST_AES_KNOWN_ANSWER
Power-up AES known-answer test failed.
|
static ModuleState |
ERROR_TEST_DES_KNOWN_ANSWER
Power-up DES known-answer test failed.
|
static ModuleState |
ERROR_TEST_DH_KEY_GENERATION
Conditional Diffie-Hellman key generation pair-wise consistency test failed.
|
static ModuleState |
ERROR_TEST_DSA
Power-up DSA sign/verify test failed.
|
static ModuleState |
ERROR_TEST_DSA_KEY_GENERATION
Conditional DSA key generation pair-wise consistency test failed.
|
static ModuleState |
ERROR_TEST_HMAC_KNOWN_ANSWER
Power-up HMAC known-answer test failed.
|
static ModuleState |
ERROR_TEST_RNG_CONTINUOUS
Conditional continuous Random Number Generator test failed.
|
static ModuleState |
ERROR_TEST_RNG_KNOWN_ANSWER
Power-up Random Number Generator known-answer test failed.
|
static ModuleState |
ERROR_TEST_RSA
Power-up RSA encrypt/decrypt or sign/verify test failed.
|
static ModuleState |
ERROR_TEST_RSA_KEY_GENERATION
Conditional RSA key generation pair-wise consistency test failed.
|
static ModuleState |
ERROR_TEST_SHA1_KNOWN_ANSWER
Power-up SHA-1 known-answer test failed.
|
static ModuleState |
ERROR_TEST_SOFTWARE_INTEGRITY
Power-up software integrity self-test failed.
|
static ModuleState |
NOT_INITIALIZED
Power-up self-tests have not yet been run.
|
static ModuleState |
READY
Power-up self-tests have been run and passed, and no conditional tests have failed.
|
static ModuleState |
TESTING
Power-up self-tests in progress.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getDescription()
Returns the string description of this
IntConstant , or null if none is set. |
int |
getValue()
Returns the internally held int value.
|
boolean |
isErrorState()
Returns
true if this ModuleState represents an error state, otherwise returns false . |
boolean |
isRecoverableErrorState()
Returns
true if this ModuleState represents a recoverable error state, otherwise returns false . |
boolean |
isUnrecoverableErrorState()
Returns
true if this ModuleState represents a recoverable error state, otherwise returns false . |
java.lang.String |
toString()
Returns a string representation of this object, of the form "description(value)".
|
public static final ModuleState READY
public static final ModuleState NOT_INITIALIZED
public static final ModuleState TESTING
public static final ModuleState ERROR_TEST_DSA_KEY_GENERATION
public static final ModuleState ERROR_TEST_RSA_KEY_GENERATION
public static final ModuleState ERROR_TEST_DH_KEY_GENERATION
public static final ModuleState ERROR_TEST_RNG_CONTINUOUS
public static final ModuleState ERROR_TEST_DES_KNOWN_ANSWER
public static final ModuleState ERROR_TEST_3DES_KNOWN_ANSWER
public static final ModuleState ERROR_TEST_AES_KNOWN_ANSWER
public static final ModuleState ERROR_TEST_SHA1_KNOWN_ANSWER
public static final ModuleState ERROR_TEST_DSA
public static final ModuleState ERROR_TEST_RSA
public static final ModuleState ERROR_TEST_SOFTWARE_INTEGRITY
public static final ModuleState ERROR_TEST_HMAC_KNOWN_ANSWER
public static final ModuleState ERROR_TEST_RNG_KNOWN_ANSWER
public int getValue()
public java.lang.String getDescription()
IntConstant
, or null
if none is set.public java.lang.String toString()
toString
in class java.lang.Object
public boolean isErrorState()
true
if this ModuleState
represents an error state, otherwise returns false
.public boolean isRecoverableErrorState()
true
if this ModuleState
represents a recoverable error state, otherwise returns false
.
A recoverable error state is one reached as a result of failure of one of the conditional self-tests. These include the testKeyPair
methods and the continuous random number generation tests in the RNGTest
class.
A recoverable error state may be cleared by invoking the FIPS_140_2.clearModuleState()
method, which resets the module state to NOT_INITIALIZED
.
public boolean isUnrecoverableErrorState()
true
if this ModuleState
represents a recoverable error state, otherwise returns false
.
An unrecoverable error state is one reached as a result of failure of one of the power-up self-tests, whether run unconditionally at module load time or, optionally, by user code at any subsequent time.