Package tss.tpm

Enum TPM_PT._N

  • All Implemented Interfaces:
    Serializable, Comparable<TPM_PT._N>
    Enclosing class:
    TPM_PT

    public static enum TPM_PT._N
    extends Enum<TPM_PT._N>
    Values from enum _N are only intended to be used in case labels of a switch statement using the result of this.asEnum() method as the switch condition. However, their Java names are identical to those of the constants defined in this class further below, so for any other usage just prepend them with the TPM_PT. qualifier.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ACTIVE_SESSIONS_MAX
      The number of authorization sessions that may be active at a time A session is active when it has a context associated with its handle.
      ALGORITHM_SET
      Code that limits the algorithms that may be used with the TPM
      AUDIT_COUNTER_0
      The high-order 32 bits of the command audit counter
      AUDIT_COUNTER_1
      The low-order 32 bits of the command audit counter
      CLOCK_UPDATE
      Interval, in milliseconds, between updates to the copy of TPMS_CLOCK_INFO.clock in NV
      CONTEXT_GAP_MAX
      The maximum allowed difference (unsigned) between the contextID values of two saved session contexts This value shall be 2n-1, where n is at least 16.
      CONTEXT_HASH
      The algorithm used for the integrity HMAC on saved contexts and for hashing the fuData of TPM2_FirmwareRead()
      CONTEXT_SYM
      TPM_ALG_ID, the algorithm used for encryption of saved contexts
      CONTEXT_SYM_SIZE
      TPM_KEY_BITS, the size of the key used for encryption of saved contexts
      DAY_OF_YEAR
      The specification day of year using TCG calendar EXAMPLE November 15, 2010, has a day of year value of 319 (0000013F16).
      FAMILY_INDICATOR
      A 4-octet character string containing the TPM Family value (TPM_SPEC_FAMILY)
      FIRMWARE_VERSION_1
      The most-significant 32 bits of a TPM vendor-specific value indicating the version number of the firmware.
      FIRMWARE_VERSION_2
      The least-significant 32 bits of a TPM vendor-specific value indicating the version number of the firmware.
      HR_ACTIVE
      The number of active authorization sessions currently being tracked by the TPM This is the sum of the loaded and saved sessions.
      HR_ACTIVE_AVAIL
      The number of additional authorization sessions, of any type, that could be created This value is an estimate.
      HR_LOADED
      The number of authorization sessions currently loaded into TPM RAM
      HR_LOADED_AVAIL
      The number of additional authorization sessions, of any type, that could be loaded into TPM RAM This value is an estimate.
      HR_LOADED_MIN
      The minimum number of authorization sessions that can be held in TPM RAM NOTE This minimum shall be no less than the minimum value required by the platform-specific specification to which the TPM is built.
      HR_NV_INDEX
      The number of NV Indexes currently defined
      HR_PERSISTENT
      The number of persistent objects currently loaded into TPM NV memory
      HR_PERSISTENT_AVAIL
      The number of additional persistent objects that could be loaded into NV memory This value is an estimate.
      HR_PERSISTENT_MIN
      The minimum number of persistent objects that can be held in TPM NV memory NOTE This minimum shall be no less than the minimum value required by the platform-specific specification to which the TPM is built.
      HR_TRANSIENT_AVAIL
      Estimate of the number of additional transient objects that could be loaded into TPM RAM This value is an estimate.
      HR_TRANSIENT_MIN
      The minimum number of transient objects that can be held in TPM RAM NOTE This minimum shall be no less than the minimum value required by the platform-specific specification to which the TPM is built.
      INPUT_BUFFER
      The maximum size of a parameter (typically, a TPM2B_MAX_BUFFER)
      LEVEL
      The level of the specification NOTE 1 For this specification, the level is zero.
      LIBRARY_COMMANDS
      Number of commands from the TPM library that are implemented
      LOADED_CURVES
      The number of loaded ECC curves
      LOCKOUT_COUNTER
      The current value of the lockout counter (failedTries)
      LOCKOUT_INTERVAL
      The number of seconds before the value reported by TPM_PT_LOCKOUT_COUNTER is decremented
      LOCKOUT_RECOVERY
      The number of seconds after a lockoutAuth failure before use of lockoutAuth may be attempted again
      MANUFACTURER
      The vendor ID unique to each TPM manufacturer
      MAX_AUTH_FAIL
      The number of authorization failures before DA lockout is invoked
      MAX_CAP_BUFFER
      The maximum size of a TPMS_CAPABILITY_DATA structure returned in TPM2_GetCapability().
      MAX_COMMAND_SIZE
      The maximum value for commandSize in a command
      MAX_DIGEST
      The maximum size of a digest that can be produced by the TPM
      MAX_OBJECT_CONTEXT
      The maximum size of an object context that will be returned by TPM2_ContextSave
      MAX_RESPONSE_SIZE
      The maximum value for responseSize in a response
      MAX_SESSION_CONTEXT
      The maximum size of a session context that will be returned by TPM2_ContextSave
      MEMORY
      A TPMA_MEMORY indicating the memory management method for the TPM
      MODES
      A TPMA_MODES value, indicating that the TPM is designed for these modes.
      NONE
      Indicates no property type
      NV_BUFFER_MAX
      The maximum data size in one NV write, NV read, NV extend, or NV certify command
      NV_COUNTERS
      The number of defined NV Indexes that have NV the TPM_NT_COUNTER attribute
      NV_COUNTERS_AVAIL
      The number of additional NV Indexes that can be defined with their TPM_NT of TPM_NV_COUNTER and the TPMA_NV_ORDERLY attribute SET This value is an estimate.
      NV_COUNTERS_MAX
      The maximum number of NV Indexes that are allowed to have the TPM_NT_COUNTER attribute NOTE 1 It is allowed for this value to be larger than the number of NV Indexes that can be defined.
      NV_INDEX_MAX
      The maximum size of an NV Index data area
      NV_WRITE_RECOVERY
      Number of milliseconds before the TPM will accept another command that will modify NV This value is an approximation and may go up or down over time.
      ORDERLY_COUNT
      The modulus - 1 of the count for NV update of an orderly counter The returned value is MAX_ORDERLY_COUNT.
      PCR_COUNT
      The number of PCR implemented NOTE This number is determined by the defined attributes, not the number of PCR that are populated.
      PCR_SELECT_MIN
      The minimum number of octets in a TPMS_PCR_SELECT.sizeOfSelect NOTE This value is not determined by the number of PCR implemented but by the number of PCR required by the platform-specific specification with which the TPM is compliant or by the implementer if not adhering to a platform-specific specification.
      PERMANENT
      TPMA_PERMANENT
      PS_DAY_OF_YEAR
      The platform-specific TPM specification day of year using TCG calendar EXAMPLE November 15, 2010, has a day of year value of 319 (0000013F16).
      PS_FAMILY_INDICATOR
      Platform-specific family (a TPM_PS value)(see Table 25) NOTE The platform-specific values for the TPM_PT_PS parameters are in the relevant platform-specific specification.
      PS_LEVEL
      The level of the platform-specific specification
      PS_REVISION
      A platform specific value
      PS_YEAR
      The platform-specific TPM specification year using the CE EXAMPLE The year 2010 has a value of 000007DA16.
      PT_FIXED
      The group of fixed properties returned as TPMS_TAGGED_PROPERTY The values in this group are only changed due to a firmware change in the TPM.
      PT_GROUP
      The number of properties in each group.
      PT_VAR
      The group of variable properties returned as TPMS_TAGGED_PROPERTY The properties in this group change because of a Protected Capability other than a firmware update.
      REVISION
      The specification Revision times 100 EXAMPLE Revision 01.01 would have a value of 101.
      SPLIT_MAX
      The number of split signing operations supported by the TPM
      STARTUP_CLEAR
      TPMA_STARTUP_CLEAR
      TOTAL_COMMANDS
      Total number of commands implemented in the TPM
      VENDOR_COMMANDS
      Number of vendor commands that are implemented
      VENDOR_STRING_1
      The first four characters of the vendor ID string NOTE When the vendor string is fewer than 16 octets, the additional property values do not have to be present.
      VENDOR_STRING_2
      The second four characters of the vendor ID string
      VENDOR_STRING_3
      The third four characters of the vendor ID string
      VENDOR_STRING_4
      The fourth four characters of the vendor ID sting
      VENDOR_TPM_TYPE
      Vendor-defined value indicating the TPM model
      YEAR
      The specification year using the CE EXAMPLE The year 2010 has a value of 000007DA16.
    • Enum Constant Detail

      • NONE

        public static final TPM_PT._N NONE
        Indicates no property type
      • PT_GROUP

        public static final TPM_PT._N PT_GROUP
        The number of properties in each group. NOTE The first group with any properties is group 1 (PT_GROUP * 1). Group 0 is reserved.
      • PT_FIXED

        public static final TPM_PT._N PT_FIXED
        The group of fixed properties returned as TPMS_TAGGED_PROPERTY The values in this group are only changed due to a firmware change in the TPM.
      • FAMILY_INDICATOR

        public static final TPM_PT._N FAMILY_INDICATOR
        A 4-octet character string containing the TPM Family value (TPM_SPEC_FAMILY)
      • LEVEL

        public static final TPM_PT._N LEVEL
        The level of the specification NOTE 1 For this specification, the level is zero. NOTE 2 The level is on the title page of the specification.
      • REVISION

        public static final TPM_PT._N REVISION
        The specification Revision times 100 EXAMPLE Revision 01.01 would have a value of 101. NOTE The Revision value is on the title page of the specification.
      • DAY_OF_YEAR

        public static final TPM_PT._N DAY_OF_YEAR
        The specification day of year using TCG calendar EXAMPLE November 15, 2010, has a day of year value of 319 (0000013F16). NOTE The specification date is on the title page of the specification or errata (see 6.1).
      • YEAR

        public static final TPM_PT._N YEAR
        The specification year using the CE EXAMPLE The year 2010 has a value of 000007DA16. NOTE The specification date is on the title page of the specification or errata (see 6.1).
      • MANUFACTURER

        public static final TPM_PT._N MANUFACTURER
        The vendor ID unique to each TPM manufacturer
      • VENDOR_STRING_1

        public static final TPM_PT._N VENDOR_STRING_1
        The first four characters of the vendor ID string NOTE When the vendor string is fewer than 16 octets, the additional property values do not have to be present. A vendor string of 4 octets can be represented in one 32-bit value and no null terminating character is required.
      • VENDOR_STRING_2

        public static final TPM_PT._N VENDOR_STRING_2
        The second four characters of the vendor ID string
      • VENDOR_STRING_3

        public static final TPM_PT._N VENDOR_STRING_3
        The third four characters of the vendor ID string
      • VENDOR_STRING_4

        public static final TPM_PT._N VENDOR_STRING_4
        The fourth four characters of the vendor ID sting
      • VENDOR_TPM_TYPE

        public static final TPM_PT._N VENDOR_TPM_TYPE
        Vendor-defined value indicating the TPM model
      • FIRMWARE_VERSION_1

        public static final TPM_PT._N FIRMWARE_VERSION_1
        The most-significant 32 bits of a TPM vendor-specific value indicating the version number of the firmware. See 10.12.2 and 10.12.12.
      • FIRMWARE_VERSION_2

        public static final TPM_PT._N FIRMWARE_VERSION_2
        The least-significant 32 bits of a TPM vendor-specific value indicating the version number of the firmware. See 10.12.2 and 10.12.12.
      • INPUT_BUFFER

        public static final TPM_PT._N INPUT_BUFFER
        The maximum size of a parameter (typically, a TPM2B_MAX_BUFFER)
      • HR_TRANSIENT_MIN

        public static final TPM_PT._N HR_TRANSIENT_MIN
        The minimum number of transient objects that can be held in TPM RAM NOTE This minimum shall be no less than the minimum value required by the platform-specific specification to which the TPM is built.
      • HR_PERSISTENT_MIN

        public static final TPM_PT._N HR_PERSISTENT_MIN
        The minimum number of persistent objects that can be held in TPM NV memory NOTE This minimum shall be no less than the minimum value required by the platform-specific specification to which the TPM is built.
      • HR_LOADED_MIN

        public static final TPM_PT._N HR_LOADED_MIN
        The minimum number of authorization sessions that can be held in TPM RAM NOTE This minimum shall be no less than the minimum value required by the platform-specific specification to which the TPM is built.
      • ACTIVE_SESSIONS_MAX

        public static final TPM_PT._N ACTIVE_SESSIONS_MAX
        The number of authorization sessions that may be active at a time A session is active when it has a context associated with its handle. The context may either be in TPM RAM or be context saved. NOTE This value shall be no less than the minimum value required by the platform-specific specification to which the TPM is built.
      • PCR_COUNT

        public static final TPM_PT._N PCR_COUNT
        The number of PCR implemented NOTE This number is determined by the defined attributes, not the number of PCR that are populated.
      • PCR_SELECT_MIN

        public static final TPM_PT._N PCR_SELECT_MIN
        The minimum number of octets in a TPMS_PCR_SELECT.sizeOfSelect NOTE This value is not determined by the number of PCR implemented but by the number of PCR required by the platform-specific specification with which the TPM is compliant or by the implementer if not adhering to a platform-specific specification.
      • CONTEXT_GAP_MAX

        public static final TPM_PT._N CONTEXT_GAP_MAX
        The maximum allowed difference (unsigned) between the contextID values of two saved session contexts This value shall be 2n-1, where n is at least 16.
      • NV_COUNTERS_MAX

        public static final TPM_PT._N NV_COUNTERS_MAX
        The maximum number of NV Indexes that are allowed to have the TPM_NT_COUNTER attribute NOTE 1 It is allowed for this value to be larger than the number of NV Indexes that can be defined. This would be indicative of a TPM implementation that did not use different implementation technology for different NV Index types. NOTE 2 The value zero indicates that there is no fixed maximum. The number of counter indexes is determined by the available NV memory pool.
      • NV_INDEX_MAX

        public static final TPM_PT._N NV_INDEX_MAX
        The maximum size of an NV Index data area
      • MEMORY

        public static final TPM_PT._N MEMORY
        A TPMA_MEMORY indicating the memory management method for the TPM
      • CLOCK_UPDATE

        public static final TPM_PT._N CLOCK_UPDATE
        Interval, in milliseconds, between updates to the copy of TPMS_CLOCK_INFO.clock in NV
      • CONTEXT_HASH

        public static final TPM_PT._N CONTEXT_HASH
        The algorithm used for the integrity HMAC on saved contexts and for hashing the fuData of TPM2_FirmwareRead()
      • CONTEXT_SYM

        public static final TPM_PT._N CONTEXT_SYM
        TPM_ALG_ID, the algorithm used for encryption of saved contexts
      • CONTEXT_SYM_SIZE

        public static final TPM_PT._N CONTEXT_SYM_SIZE
        TPM_KEY_BITS, the size of the key used for encryption of saved contexts
      • ORDERLY_COUNT

        public static final TPM_PT._N ORDERLY_COUNT
        The modulus - 1 of the count for NV update of an orderly counter The returned value is MAX_ORDERLY_COUNT. This will have a value of 2N 1 where 1 N 32 NOTE 1 An orderly counter is an NV Index with an TPM_NT of TPM_NV_COUNTER and TPMA_NV_ORDERLY SET. NOTE 2 When the low-order bits of a counter equal this value, an NV write occurs on the next increment.
      • MAX_COMMAND_SIZE

        public static final TPM_PT._N MAX_COMMAND_SIZE
        The maximum value for commandSize in a command
      • MAX_RESPONSE_SIZE

        public static final TPM_PT._N MAX_RESPONSE_SIZE
        The maximum value for responseSize in a response
      • MAX_DIGEST

        public static final TPM_PT._N MAX_DIGEST
        The maximum size of a digest that can be produced by the TPM
      • MAX_OBJECT_CONTEXT

        public static final TPM_PT._N MAX_OBJECT_CONTEXT
        The maximum size of an object context that will be returned by TPM2_ContextSave
      • MAX_SESSION_CONTEXT

        public static final TPM_PT._N MAX_SESSION_CONTEXT
        The maximum size of a session context that will be returned by TPM2_ContextSave
      • PS_FAMILY_INDICATOR

        public static final TPM_PT._N PS_FAMILY_INDICATOR
        Platform-specific family (a TPM_PS value)(see Table 25) NOTE The platform-specific values for the TPM_PT_PS parameters are in the relevant platform-specific specification. In the reference implementation, all of these values are 0.
      • PS_LEVEL

        public static final TPM_PT._N PS_LEVEL
        The level of the platform-specific specification
      • PS_REVISION

        public static final TPM_PT._N PS_REVISION
        A platform specific value
      • PS_DAY_OF_YEAR

        public static final TPM_PT._N PS_DAY_OF_YEAR
        The platform-specific TPM specification day of year using TCG calendar EXAMPLE November 15, 2010, has a day of year value of 319 (0000013F16).
      • PS_YEAR

        public static final TPM_PT._N PS_YEAR
        The platform-specific TPM specification year using the CE EXAMPLE The year 2010 has a value of 000007DA16.
      • SPLIT_MAX

        public static final TPM_PT._N SPLIT_MAX
        The number of split signing operations supported by the TPM
      • TOTAL_COMMANDS

        public static final TPM_PT._N TOTAL_COMMANDS
        Total number of commands implemented in the TPM
      • LIBRARY_COMMANDS

        public static final TPM_PT._N LIBRARY_COMMANDS
        Number of commands from the TPM library that are implemented
      • VENDOR_COMMANDS

        public static final TPM_PT._N VENDOR_COMMANDS
        Number of vendor commands that are implemented
      • NV_BUFFER_MAX

        public static final TPM_PT._N NV_BUFFER_MAX
        The maximum data size in one NV write, NV read, NV extend, or NV certify command
      • MODES

        public static final TPM_PT._N MODES
        A TPMA_MODES value, indicating that the TPM is designed for these modes.
      • MAX_CAP_BUFFER

        public static final TPM_PT._N MAX_CAP_BUFFER
        The maximum size of a TPMS_CAPABILITY_DATA structure returned in TPM2_GetCapability().
      • PT_VAR

        public static final TPM_PT._N PT_VAR
        The group of variable properties returned as TPMS_TAGGED_PROPERTY The properties in this group change because of a Protected Capability other than a firmware update. The values are not necessarily persistent across all power transitions.
      • PERMANENT

        public static final TPM_PT._N PERMANENT
        TPMA_PERMANENT
      • STARTUP_CLEAR

        public static final TPM_PT._N STARTUP_CLEAR
        TPMA_STARTUP_CLEAR
      • HR_NV_INDEX

        public static final TPM_PT._N HR_NV_INDEX
        The number of NV Indexes currently defined
      • HR_LOADED

        public static final TPM_PT._N HR_LOADED
        The number of authorization sessions currently loaded into TPM RAM
      • HR_LOADED_AVAIL

        public static final TPM_PT._N HR_LOADED_AVAIL
        The number of additional authorization sessions, of any type, that could be loaded into TPM RAM This value is an estimate. If this value is at least 1, then at least one authorization session of any type may be loaded. Any command that changes the RAM memory allocation can make this estimate invalid. NOTE A valid implementation may return 1 even if more than one authorization session would fit into RAM.
      • HR_ACTIVE

        public static final TPM_PT._N HR_ACTIVE
        The number of active authorization sessions currently being tracked by the TPM This is the sum of the loaded and saved sessions.
      • HR_ACTIVE_AVAIL

        public static final TPM_PT._N HR_ACTIVE_AVAIL
        The number of additional authorization sessions, of any type, that could be created This value is an estimate. If this value is at least 1, then at least one authorization session of any type may be created. Any command that changes the RAM memory allocation can make this estimate invalid. NOTE A valid implementation may return 1 even if more than one authorization session could be created.
      • HR_TRANSIENT_AVAIL

        public static final TPM_PT._N HR_TRANSIENT_AVAIL
        Estimate of the number of additional transient objects that could be loaded into TPM RAM This value is an estimate. If this value is at least 1, then at least one object of any type may be loaded. Any command that changes the memory allocation can make this estimate invalid. NOTE A valid implementation may return 1 even if more than one transient object would fit into RAM.
      • HR_PERSISTENT

        public static final TPM_PT._N HR_PERSISTENT
        The number of persistent objects currently loaded into TPM NV memory
      • HR_PERSISTENT_AVAIL

        public static final TPM_PT._N HR_PERSISTENT_AVAIL
        The number of additional persistent objects that could be loaded into NV memory This value is an estimate. If this value is at least 1, then at least one object of any type may be made persistent. Any command that changes the NV memory allocation can make this estimate invalid. NOTE A valid implementation may return 1 even if more than one persistent object would fit into NV memory.
      • NV_COUNTERS

        public static final TPM_PT._N NV_COUNTERS
        The number of defined NV Indexes that have NV the TPM_NT_COUNTER attribute
      • NV_COUNTERS_AVAIL

        public static final TPM_PT._N NV_COUNTERS_AVAIL
        The number of additional NV Indexes that can be defined with their TPM_NT of TPM_NV_COUNTER and the TPMA_NV_ORDERLY attribute SET This value is an estimate. If this value is at least 1, then at least one NV Index may be created with a TPM_NT of TPM_NV_COUNTER and the TPMA_NV_ORDERLY attributes. Any command that changes the NV memory allocation can make this estimate invalid. NOTE A valid implementation may return 1 even if more than one NV counter could be defined.
      • ALGORITHM_SET

        public static final TPM_PT._N ALGORITHM_SET
        Code that limits the algorithms that may be used with the TPM
      • LOADED_CURVES

        public static final TPM_PT._N LOADED_CURVES
        The number of loaded ECC curves
      • LOCKOUT_COUNTER

        public static final TPM_PT._N LOCKOUT_COUNTER
        The current value of the lockout counter (failedTries)
      • MAX_AUTH_FAIL

        public static final TPM_PT._N MAX_AUTH_FAIL
        The number of authorization failures before DA lockout is invoked
      • LOCKOUT_INTERVAL

        public static final TPM_PT._N LOCKOUT_INTERVAL
        The number of seconds before the value reported by TPM_PT_LOCKOUT_COUNTER is decremented
      • LOCKOUT_RECOVERY

        public static final TPM_PT._N LOCKOUT_RECOVERY
        The number of seconds after a lockoutAuth failure before use of lockoutAuth may be attempted again
      • NV_WRITE_RECOVERY

        public static final TPM_PT._N NV_WRITE_RECOVERY
        Number of milliseconds before the TPM will accept another command that will modify NV This value is an approximation and may go up or down over time.
      • AUDIT_COUNTER_0

        public static final TPM_PT._N AUDIT_COUNTER_0
        The high-order 32 bits of the command audit counter
      • AUDIT_COUNTER_1

        public static final TPM_PT._N AUDIT_COUNTER_1
        The low-order 32 bits of the command audit counter
    • Method Detail

      • values

        public static TPM_PT._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 (TPM_PT._N c : TPM_PT._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 TPM_PT._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