TPMA_NV._N (TSS.Java 0.2.0 API)

java.lang.Object
- java.lang.Enum<TPMA_NV._N>
- - tss.tpm.TPMA_NV._N

All Implemented Interfaces:

Serializable, Comparable<TPMA_NV._N>

Enclosing class:

TPMA_NV
```
public static enum TPMA_NV._N
extends Enum<TPMA_NV._N>
```

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AUTHREAD` SET (1): The Index data may be read if the authValue is provided.
`AUTHWRITE` SET (1): Authorizations to change the Index contents that require USER role may be provided with an HMAC session or password.
`BITS` Bit Field contains an 8-octet value to be used as a bit field and can only be modified with TPM2_NV_SetBits().
`CLEAR_STCLEAR` SET (1): TPMA_NV_WRITTEN for the Index is CLEAR by TPM Reset or TPM Restart.
`COUNTER` Counter contains an 8-octet value that is to be used as a counter and can only be modified with TPM2_NV_Increment()
`EXTEND` Extend contains a digest-sized value used like a PCR.
`GLOBALLOCK` SET (1): If TPM2_NV_GlobalWriteLock() is successful, then further writes to this location are not permitted until the next TPM Reset or TPM Restart.
`NO_DA` SET (1): Authorization failures of the Index do not affect the DA logic and authorization of the Index is not blocked when the TPM is in Lockout mode.
`ORDERLY` SET (1): NV Index state is only required to be saved when the TPM performs an orderly shutdown (TPM2_Shutdown()).
`ORDINARY` Ordinary contains data that is opaque to the TPM that can only be modified using TPM2_NV_Write().
`OWNERREAD` SET (1): The Index data can be read if Owner Authorization is provided.
`OWNERWRITE` SET (1): The Index data can be written if Owner Authorization is provided.
`PIN_FAIL` PIN Fail - contains pinCount that increments on a PIN authorization failure and a pinLimit
`PIN_PASS` PIN Pass - contains pinCount that increments on a PIN authorization success and a pinLimit
`PLATFORMCREATE` SET (1): This Index may be undefined with Platform Authorization but not with Owner Authorization.
`POLICY_DELETE` SET (1): Index may not be deleted unless the authPolicy is satisfied using TPM2_NV_UndefineSpaceSpecial().
`POLICYREAD` SET (1): The Index data may be read if the authPolicy is satisfied.
`POLICYWRITE` SET (1): Authorizations to change the Index contents that require USER role may be provided with a policy session.
`PPREAD` SET (1): The Index data can be read if Platform Authorization is provided.
`PPWRITE` SET (1): The Index data can be written if Platform Authorization is provided.
`READ_STCLEAR` SET (1): TPM2_NV_ReadLock() may be used to SET TPMA_NV_READLOCKED for this Index.
`READLOCKED` SET (1): Reads of the Index are blocked until the next TPM Reset or TPM Restart.
`TpmNt_BIT_0` The type of the index.
`TpmNt_BIT_1`
`TpmNt_BIT_2`
`TpmNt_BIT_3`
`WRITE_STCLEAR` SET (1): TPM2_NV_WriteLock() may be used to prevent further writes to this location until the next TPM Reset or TPM Restart.
`WRITEALL` SET (1): A partial write of the Index data is not allowed.
`WRITEDEFINE` SET (1): TPM2_NV_WriteLock() may be used to prevent further writes to this location.
`WRITELOCKED` SET (1): Index cannot be written.
`WRITTEN` SET (1): Index has been written.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static TPMA_NV._N`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static TPMA_NV._N[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - PPWRITE
```
public static final TPMA_NV._N PPWRITE
```
    SET (1): The Index data can be written if Platform Authorization is provided. CLEAR (0): Writing of the Index data cannot be authorized with Platform Authorization.
  - OWNERWRITE
```
public static final TPMA_NV._N OWNERWRITE
```
    SET (1): The Index data can be written if Owner Authorization is provided. CLEAR (0): Writing of the Index data cannot be authorized with Owner Authorization.
  - AUTHWRITE
```
public static final TPMA_NV._N AUTHWRITE
```
    SET (1): Authorizations to change the Index contents that require USER role may be provided with an HMAC session or password. CLEAR (0): Authorizations to change the Index contents that require USER role may not be provided with an HMAC session or password.
  - POLICYWRITE
```
public static final TPMA_NV._N POLICYWRITE
```
    SET (1): Authorizations to change the Index contents that require USER role may be provided with a policy session. CLEAR (0): Authorizations to change the Index contents that require USER role may not be provided with a policy session. NOTE TPM2_NV_ChangeAuth() always requires that authorization be provided in a policy session.
  - ORDINARY
```
public static final TPMA_NV._N ORDINARY
```
    Ordinary contains data that is opaque to the TPM that can only be modified using TPM2_NV_Write().
  - COUNTER
```
public static final TPMA_NV._N COUNTER
```
    Counter contains an 8-octet value that is to be used as a counter and can only be modified with TPM2_NV_Increment()
  - BITS
```
public static final TPMA_NV._N BITS
```
    Bit Field contains an 8-octet value to be used as a bit field and can only be modified with TPM2_NV_SetBits().
  - EXTEND
```
public static final TPMA_NV._N EXTEND
```
    Extend contains a digest-sized value used like a PCR. The Index can only be modified using TPM2_NV_Extend(). The extend will use the nameAlg of the Index.
  - PIN_FAIL
```
public static final TPMA_NV._N PIN_FAIL
```
    PIN Fail - contains pinCount that increments on a PIN authorization failure and a pinLimit
  - PIN_PASS
```
public static final TPMA_NV._N PIN_PASS
```
    PIN Pass - contains pinCount that increments on a PIN authorization success and a pinLimit
  - TpmNt_BIT_0
```
public static final TPMA_NV._N TpmNt_BIT_0
```
    The type of the index. NOTE A TPM is not required to support all TPM_NT values
  - TpmNt_BIT_1
```
public static final TPMA_NV._N TpmNt_BIT_1
```
  - TpmNt_BIT_2
```
public static final TPMA_NV._N TpmNt_BIT_2
```
  - TpmNt_BIT_3
```
public static final TPMA_NV._N TpmNt_BIT_3
```
  - POLICY_DELETE
```
public static final TPMA_NV._N POLICY_DELETE
```
    SET (1): Index may not be deleted unless the authPolicy is satisfied using TPM2_NV_UndefineSpaceSpecial(). CLEAR (0): Index may be deleted with proper platform or owner authorization using TPM2_NV_UndefineSpace(). NOTE An Index with this attribute and a policy that cannot be satisfied (e.g., an Empty Policy) cannot be deleted.
  - WRITELOCKED
```
public static final TPMA_NV._N WRITELOCKED
```
    SET (1): Index cannot be written. CLEAR (0): Index can be written.
  - WRITEALL
```
public static final TPMA_NV._N WRITEALL
```
    SET (1): A partial write of the Index data is not allowed. The write size shall match the defined space size. CLEAR (0): Partial writes are allowed. This setting is required if the .dataSize of the Index is larger than NV_MAX_BUFFER_SIZE for the implementation.
  - WRITEDEFINE
```
public static final TPMA_NV._N WRITEDEFINE
```
    SET (1): TPM2_NV_WriteLock() may be used to prevent further writes to this location. CLEAR (0): TPM2_NV_WriteLock() does not block subsequent writes if TPMA_NV_WRITE_STCLEAR is also CLEAR.
  - WRITE_STCLEAR
```
public static final TPMA_NV._N WRITE_STCLEAR
```
    SET (1): TPM2_NV_WriteLock() may be used to prevent further writes to this location until the next TPM Reset or TPM Restart. CLEAR (0): TPM2_NV_WriteLock() does not block subsequent writes if TPMA_NV_WRITEDEFINE is also CLEAR.
  - GLOBALLOCK
```
public static final TPMA_NV._N GLOBALLOCK
```
    SET (1): If TPM2_NV_GlobalWriteLock() is successful, then further writes to this location are not permitted until the next TPM Reset or TPM Restart. CLEAR (0): TPM2_NV_GlobalWriteLock() has no effect on the writing of the data at this Index.
  - PPREAD
```
public static final TPMA_NV._N PPREAD
```
    SET (1): The Index data can be read if Platform Authorization is provided. CLEAR (0): Reading of the Index data cannot be authorized with Platform Authorization.
  - OWNERREAD
```
public static final TPMA_NV._N OWNERREAD
```
    SET (1): The Index data can be read if Owner Authorization is provided. CLEAR (0): Reading of the Index data cannot be authorized with Owner Authorization.
  - AUTHREAD
```
public static final TPMA_NV._N AUTHREAD
```
    SET (1): The Index data may be read if the authValue is provided. CLEAR (0): Reading of the Index data cannot be authorized with the Index authValue.
  - POLICYREAD
```
public static final TPMA_NV._N POLICYREAD
```
    SET (1): The Index data may be read if the authPolicy is satisfied. CLEAR (0): Reading of the Index data cannot be authorized with the Index authPolicy.
  - NO_DA
```
public static final TPMA_NV._N NO_DA
```
    SET (1): Authorization failures of the Index do not affect the DA logic and authorization of the Index is not blocked when the TPM is in Lockout mode. CLEAR (0): Authorization failures of the Index will increment the authorization failure counter and authorizations of this Index are not allowed when the TPM is in Lockout mode.
  - ORDERLY
```
public static final TPMA_NV._N ORDERLY
```
    SET (1): NV Index state is only required to be saved when the TPM performs an orderly shutdown (TPM2_Shutdown()). CLEAR (0): NV Index state is required to be persistent after the command to update the Index completes successfully (that is, the NV update is synchronous with the update command). NOTE If TPMA_NV_ORDERLY is SET, TPMA_NV_WRITTEN will be CLEAR by TPM Reset.
  - CLEAR_STCLEAR
```
public static final TPMA_NV._N CLEAR_STCLEAR
```
    SET (1): TPMA_NV_WRITTEN for the Index is CLEAR by TPM Reset or TPM Restart. CLEAR (0): TPMA_NV_WRITTEN is not changed by TPM Restart. NOTE This attribute may only be SET if TPM_NT is not TPM_NT_COUNTER.
  - READLOCKED
```
public static final TPMA_NV._N READLOCKED
```
    SET (1): Reads of the Index are blocked until the next TPM Reset or TPM Restart. CLEAR (0): Reads of the Index are allowed if proper authorization is provided.
  - WRITTEN
```
public static final TPMA_NV._N WRITTEN
```
    SET (1): Index has been written. CLEAR (0): Index has not been written.
  - PLATFORMCREATE
```
public static final TPMA_NV._N PLATFORMCREATE
```
    SET (1): This Index may be undefined with Platform Authorization but not with Owner Authorization. CLEAR (0): This Index may be undefined using Owner Authorization but not with Platform Authorization. The TPM will validate that this attribute is SET when the Index is defined using Platform Authorization and will validate that this attribute is CLEAR when the Index is defined using Owner Authorization.
  - READ_STCLEAR
```
public static final TPMA_NV._N READ_STCLEAR
```
    SET (1): TPM2_NV_ReadLock() may be used to SET TPMA_NV_READLOCKED for this Index. CLEAR (0): TPM2_NV_ReadLock() has no effect on this Index.
- Method Detail
  - values
```
public static TPMA_NV._N[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (TPMA_NV._N c : TPMA_NV._N.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static TPMA_NV._N valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null

Enum TPMA_NV._N

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

PPWRITE

OWNERWRITE

AUTHWRITE

POLICYWRITE

ORDINARY

COUNTER

BITS

EXTEND

PIN_FAIL

PIN_PASS

TpmNt_BIT_0

TpmNt_BIT_1

TpmNt_BIT_2

TpmNt_BIT_3

POLICY_DELETE

WRITELOCKED

WRITEALL

WRITEDEFINE

WRITE_STCLEAR

GLOBALLOCK

PPREAD

OWNERREAD

AUTHREAD

POLICYREAD

NO_DA

ORDERLY

CLEAR_STCLEAR

READLOCKED

WRITTEN

PLATFORMCREATE

READ_STCLEAR

Method Detail

values

valueOf