2 This library is used by other modules to send TPM2 command.
4 Copyright (c) 2013 - 2016, Intel Corporation. All rights reserved. <BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #ifndef _TPM2_COMMAND_LIB_H_
16 #define _TPM2_COMMAND_LIB_H_
18 #include <IndustryStandard/Tpm20.h>
21 This command starts a hash or an Event sequence.
22 If hashAlg is an implemented hash, then a hash sequence is started.
23 If hashAlg is TPM_ALG_NULL, then an Event sequence is started.
25 @param[in] HashAlg The hash algorithm to use for the hash sequence
26 An Event sequence starts if this is TPM_ALG_NULL.
27 @param[out] SequenceHandle A handle to reference the sequence
29 @retval EFI_SUCCESS Operation completed successfully.
30 @retval EFI_DEVICE_ERROR Unexpected device behavior.
34 Tpm2HashSequenceStart (
35 IN TPMI_ALG_HASH HashAlg
,
36 OUT TPMI_DH_OBJECT
*SequenceHandle
40 This command is used to add data to a hash or HMAC sequence.
41 The amount of data in buffer may be any size up to the limits of the TPM.
42 NOTE: In all TPM, a buffer size of 1,024 octets is allowed.
44 @param[in] SequenceHandle Handle for the sequence object
45 @param[in] Buffer Data to be added to hash
47 @retval EFI_SUCCESS Operation completed successfully.
48 @retval EFI_DEVICE_ERROR Unexpected device behavior.
53 IN TPMI_DH_OBJECT SequenceHandle
,
54 IN TPM2B_MAX_BUFFER
*Buffer
58 This command adds the last part of data, if any, to an Event sequence and returns the result in a digest list.
59 If pcrHandle references a PCR and not TPM_RH_NULL, then the returned digest list is processed in
60 the same manner as the digest list input parameter to TPM2_PCR_Extend() with the pcrHandle in each
61 bank extended with the associated digest value.
63 @param[in] PcrHandle PCR to be extended with the Event data
64 @param[in] SequenceHandle Authorization for the sequence
65 @param[in] Buffer Data to be added to the Event
66 @param[out] Results List of digests computed for the PCR
68 @retval EFI_SUCCESS Operation completed successfully.
69 @retval EFI_DEVICE_ERROR Unexpected device behavior.
73 Tpm2EventSequenceComplete (
74 IN TPMI_DH_PCR PcrHandle
,
75 IN TPMI_DH_OBJECT SequenceHandle
,
76 IN TPM2B_MAX_BUFFER
*Buffer
,
77 OUT TPML_DIGEST_VALUES
*Results
81 This command adds the last part of data, if any, to a hash/HMAC sequence and returns the result.
83 @param[in] SequenceHandle Authorization for the sequence
84 @param[in] Buffer Data to be added to the hash/HMAC
85 @param[out] Result The returned HMAC or digest in a sized buffer
87 @retval EFI_SUCCESS Operation completed successfully.
88 @retval EFI_DEVICE_ERROR Unexpected device behavior.
92 Tpm2SequenceComplete (
93 IN TPMI_DH_OBJECT SequenceHandle
,
94 IN TPM2B_MAX_BUFFER
*Buffer
,
95 OUT TPM2B_DIGEST
*Result
99 Send Startup command to TPM2.
101 @param[in] StartupType TPM_SU_CLEAR or TPM_SU_STATE
103 @retval EFI_SUCCESS Operation completed successfully.
104 @retval EFI_DEVICE_ERROR Unexpected device behavior.
109 IN TPM_SU StartupType
113 Send Shutdown command to TPM2.
115 @param[in] ShutdownType TPM_SU_CLEAR or TPM_SU_STATE.
117 @retval EFI_SUCCESS Operation completed successfully.
118 @retval EFI_DEVICE_ERROR Unexpected device behavior.
123 IN TPM_SU ShutdownType
127 This command causes the TPM to perform a test of its capabilities.
128 If the fullTest is YES, the TPM will test all functions.
129 If fullTest = NO, the TPM will only test those functions that have not previously been tested.
131 @param[in] FullTest YES if full test to be performed
132 NO if only test of untested functions required
134 @retval EFI_SUCCESS Operation completed successfully.
135 @retval EFI_DEVICE_ERROR Unexpected device behavior.
140 IN TPMI_YES_NO FullTest
144 This command allows setting of the authorization policy for the platform hierarchy (platformPolicy), the
145 storage hierarchy (ownerPolicy), and and the endorsement hierarchy (endorsementPolicy).
147 @param[in] AuthHandle TPM_RH_ENDORSEMENT, TPM_RH_OWNER or TPM_RH_PLATFORM+{PP} parameters to be validated
148 @param[in] AuthSession Auth Session context
149 @param[in] AuthPolicy An authorization policy hash
150 @param[in] HashAlg The hash algorithm to use for the policy
152 @retval EFI_SUCCESS Operation completed successfully.
153 @retval EFI_DEVICE_ERROR Unexpected device behavior.
157 Tpm2SetPrimaryPolicy (
158 IN TPMI_RH_HIERARCHY_AUTH AuthHandle
,
159 IN TPMS_AUTH_COMMAND
*AuthSession
,
160 IN TPM2B_DIGEST
*AuthPolicy
,
161 IN TPMI_ALG_HASH HashAlg
165 This command removes all TPM context associated with a specific Owner.
167 @param[in] AuthHandle TPM_RH_LOCKOUT or TPM_RH_PLATFORM+{PP}
168 @param[in] AuthSession Auth Session context
170 @retval EFI_SUCCESS Operation completed successfully.
171 @retval EFI_DEVICE_ERROR Unexpected device behavior.
176 IN TPMI_RH_CLEAR AuthHandle
,
177 IN TPMS_AUTH_COMMAND
*AuthSession OPTIONAL
181 Disables and enables the execution of TPM2_Clear().
183 @param[in] AuthHandle TPM_RH_LOCKOUT or TPM_RH_PLATFORM+{PP}
184 @param[in] AuthSession Auth Session context
185 @param[in] Disable YES if the disableOwnerClear flag is to be SET,
186 NO if the flag is to be CLEAR.
188 @retval EFI_SUCCESS Operation completed successfully.
189 @retval EFI_DEVICE_ERROR Unexpected device behavior.
194 IN TPMI_RH_CLEAR AuthHandle
,
195 IN TPMS_AUTH_COMMAND
*AuthSession
, OPTIONAL
196 IN TPMI_YES_NO Disable
200 This command allows the authorization secret for a hierarchy or lockout to be changed using the current
201 authorization value as the command authorization.
203 @param[in] AuthHandle TPM_RH_LOCKOUT, TPM_RH_ENDORSEMENT, TPM_RH_OWNER or TPM_RH_PLATFORM+{PP}
204 @param[in] AuthSession Auth Session context
205 @param[in] NewAuth New authorization secret
207 @retval EFI_SUCCESS Operation completed successfully.
208 @retval EFI_DEVICE_ERROR Unexpected device behavior.
212 Tpm2HierarchyChangeAuth (
213 IN TPMI_RH_HIERARCHY_AUTH AuthHandle
,
214 IN TPMS_AUTH_COMMAND
*AuthSession
,
215 IN TPM2B_AUTH
*NewAuth
219 This replaces the current EPS with a value from the RNG and sets the Endorsement hierarchy controls to
220 their default initialization values.
222 @param[in] AuthHandle TPM_RH_PLATFORM+{PP}
223 @param[in] AuthSession Auth Session context
225 @retval EFI_SUCCESS Operation completed successfully.
226 @retval EFI_DEVICE_ERROR Unexpected device behavior.
231 IN TPMI_RH_PLATFORM AuthHandle
,
232 IN TPMS_AUTH_COMMAND
*AuthSession
236 This replaces the current PPS with a value from the RNG and sets platformPolicy to the default
237 initialization value (the Empty Buffer).
239 @param[in] AuthHandle TPM_RH_PLATFORM+{PP}
240 @param[in] AuthSession Auth Session context
242 @retval EFI_SUCCESS Operation completed successfully.
243 @retval EFI_DEVICE_ERROR Unexpected device behavior.
248 IN TPMI_RH_PLATFORM AuthHandle
,
249 IN TPMS_AUTH_COMMAND
*AuthSession
253 This command enables and disables use of a hierarchy.
255 @param[in] AuthHandle TPM_RH_ENDORSEMENT, TPM_RH_OWNER or TPM_RH_PLATFORM+{PP}
256 @param[in] AuthSession Auth Session context
257 @param[in] Hierarchy Hierarchy of the enable being modified
258 @param[in] State YES if the enable should be SET,
259 NO if the enable should be CLEAR
261 @retval EFI_SUCCESS Operation completed successfully.
262 @retval EFI_DEVICE_ERROR Unexpected device behavior.
266 Tpm2HierarchyControl (
267 IN TPMI_RH_HIERARCHY AuthHandle
,
268 IN TPMS_AUTH_COMMAND
*AuthSession
,
269 IN TPMI_RH_HIERARCHY Hierarchy
,
274 This command cancels the effect of a TPM lockout due to a number of successive authorization failures.
275 If this command is properly authorized, the lockout counter is set to zero.
277 @param[in] LockHandle LockHandle
278 @param[in] AuthSession Auth Session context
280 @retval EFI_SUCCESS Operation completed successfully.
281 @retval EFI_DEVICE_ERROR Unexpected device behavior.
285 Tpm2DictionaryAttackLockReset (
286 IN TPMI_RH_LOCKOUT LockHandle
,
287 IN TPMS_AUTH_COMMAND
*AuthSession
291 This command cancels the effect of a TPM lockout due to a number of successive authorization failures.
292 If this command is properly authorized, the lockout counter is set to zero.
294 @param[in] LockHandle LockHandle
295 @param[in] AuthSession Auth Session context
296 @param[in] NewMaxTries Count of authorization failures before the lockout is imposed
297 @param[in] NewRecoveryTime Time in seconds before the authorization failure count is automatically decremented
298 @param[in] LockoutRecovery Time in seconds after a lockoutAuth failure before use of lockoutAuth is allowed
300 @retval EFI_SUCCESS Operation completed successfully.
301 @retval EFI_DEVICE_ERROR Unexpected device behavior.
305 Tpm2DictionaryAttackParameters (
306 IN TPMI_RH_LOCKOUT LockHandle
,
307 IN TPMS_AUTH_COMMAND
*AuthSession
,
308 IN UINT32 NewMaxTries
,
309 IN UINT32 NewRecoveryTime
,
310 IN UINT32 LockoutRecovery
314 This command is used to read the public area and Name of an NV Index.
316 @param[in] NvIndex The NV Index.
317 @param[out] NvPublic The public area of the index.
318 @param[out] NvName The Name of the nvIndex.
320 @retval EFI_SUCCESS Operation completed successfully.
321 @retval EFI_DEVICE_ERROR The command was unsuccessful.
326 IN TPMI_RH_NV_INDEX NvIndex
,
327 OUT TPM2B_NV_PUBLIC
*NvPublic
,
328 OUT TPM2B_NAME
*NvName
332 This command defines the attributes of an NV Index and causes the TPM to
333 reserve space to hold the data associated with the index.
334 If a definition already exists at the index, the TPM will return TPM_RC_NV_DEFINED.
336 @param[in] AuthHandle TPM_RH_OWNER or TPM_RH_PLATFORM+{PP}.
337 @param[in] AuthSession Auth Session context
338 @param[in] Auth The authorization data.
339 @param[in] NvPublic The public area of the index.
341 @retval EFI_SUCCESS Operation completed successfully.
342 @retval EFI_DEVICE_ERROR The command was unsuccessful.
343 @retval EFI_ALREADY_STARTED The command was returned successfully, but NvIndex is already defined.
348 IN TPMI_RH_PROVISION AuthHandle
,
349 IN TPMS_AUTH_COMMAND
*AuthSession
, OPTIONAL
351 IN TPM2B_NV_PUBLIC
*NvPublic
355 This command removes an index from the TPM.
357 @param[in] AuthHandle TPM_RH_OWNER or TPM_RH_PLATFORM+{PP}.
358 @param[in] NvIndex The NV Index.
359 @param[in] AuthSession Auth Session context
361 @retval EFI_SUCCESS Operation completed successfully.
362 @retval EFI_DEVICE_ERROR The command was unsuccessful.
363 @retval EFI_NOT_FOUND The command was returned successfully, but NvIndex is not found.
367 Tpm2NvUndefineSpace (
368 IN TPMI_RH_PROVISION AuthHandle
,
369 IN TPMI_RH_NV_INDEX NvIndex
,
370 IN TPMS_AUTH_COMMAND
*AuthSession OPTIONAL
374 This command reads a value from an area in NV memory previously defined by TPM2_NV_DefineSpace().
376 @param[in] AuthHandle the handle indicating the source of the authorization value.
377 @param[in] NvIndex The index to be read.
378 @param[in] AuthSession Auth Session context
379 @param[in] Size Number of bytes to read.
380 @param[in] Offset Byte offset into the area.
381 @param[in,out] OutData The data read.
383 @retval EFI_SUCCESS Operation completed successfully.
384 @retval EFI_DEVICE_ERROR The command was unsuccessful.
385 @retval EFI_NOT_FOUND The command was returned successfully, but NvIndex is not found.
390 IN TPMI_RH_NV_AUTH AuthHandle
,
391 IN TPMI_RH_NV_INDEX NvIndex
,
392 IN TPMS_AUTH_COMMAND
*AuthSession
, OPTIONAL
395 IN OUT TPM2B_MAX_BUFFER
*OutData
399 This command writes a value to an area in NV memory that was previously defined by TPM2_NV_DefineSpace().
401 @param[in] AuthHandle the handle indicating the source of the authorization value.
402 @param[in] NvIndex The NV Index of the area to write.
403 @param[in] AuthSession Auth Session context
404 @param[in] InData The data to write.
405 @param[in] Offset The offset into the NV Area.
407 @retval EFI_SUCCESS Operation completed successfully.
408 @retval EFI_DEVICE_ERROR The command was unsuccessful.
409 @retval EFI_NOT_FOUND The command was returned successfully, but NvIndex is not found.
414 IN TPMI_RH_NV_AUTH AuthHandle
,
415 IN TPMI_RH_NV_INDEX NvIndex
,
416 IN TPMS_AUTH_COMMAND
*AuthSession
, OPTIONAL
417 IN TPM2B_MAX_BUFFER
*InData
,
422 This command may be used to prevent further reads of the Index until the next TPM2_Startup (TPM_SU_CLEAR).
424 @param[in] AuthHandle the handle indicating the source of the authorization value.
425 @param[in] NvIndex The NV Index of the area to lock.
426 @param[in] AuthSession Auth Session context
428 @retval EFI_SUCCESS Operation completed successfully.
429 @retval EFI_DEVICE_ERROR The command was unsuccessful.
430 @retval EFI_NOT_FOUND The command was returned successfully, but NvIndex is not found.
435 IN TPMI_RH_NV_AUTH AuthHandle
,
436 IN TPMI_RH_NV_INDEX NvIndex
,
437 IN TPMS_AUTH_COMMAND
*AuthSession OPTIONAL
441 This command may be used to inhibit further writes of the Index.
443 @param[in] AuthHandle the handle indicating the source of the authorization value.
444 @param[in] NvIndex The NV Index of the area to lock.
445 @param[in] AuthSession Auth Session context
447 @retval EFI_SUCCESS Operation completed successfully.
448 @retval EFI_DEVICE_ERROR The command was unsuccessful.
449 @retval EFI_NOT_FOUND The command was returned successfully, but NvIndex is not found.
454 IN TPMI_RH_NV_AUTH AuthHandle
,
455 IN TPMI_RH_NV_INDEX NvIndex
,
456 IN TPMS_AUTH_COMMAND
*AuthSession OPTIONAL
460 The command will SET TPMA_NV_WRITELOCKED for all indexes that have their TPMA_NV_GLOBALLOCK attribute SET.
462 @param[in] AuthHandle TPM_RH_OWNER or TPM_RH_PLATFORM+{PP}.
463 @param[in] AuthSession Auth Session context
465 @retval EFI_SUCCESS Operation completed successfully.
466 @retval EFI_DEVICE_ERROR The command was unsuccessful.
467 @retval EFI_NOT_FOUND The command was returned successfully, but NvIndex is not found.
471 Tpm2NvGlobalWriteLock (
472 IN TPMI_RH_PROVISION AuthHandle
,
473 IN TPMS_AUTH_COMMAND
*AuthSession OPTIONAL
477 This command is used to cause an update to the indicated PCR.
478 The digests parameter contains one or more tagged digest value identified by an algorithm ID.
479 For each digest, the PCR associated with pcrHandle is Extended into the bank identified by the tag (hashAlg).
481 @param[in] PcrHandle Handle of the PCR
482 @param[in] Digests List of tagged digest values to be extended
484 @retval EFI_SUCCESS Operation completed successfully.
485 @retval EFI_DEVICE_ERROR Unexpected device behavior.
490 IN TPMI_DH_PCR PcrHandle
,
491 IN TPML_DIGEST_VALUES
*Digests
495 This command is used to cause an update to the indicated PCR.
496 The data in eventData is hashed using the hash algorithm associated with each bank in which the
497 indicated PCR has been allocated. After the data is hashed, the digests list is returned. If the pcrHandle
498 references an implemented PCR and not TPM_ALG_NULL, digests list is processed as in
500 A TPM shall support an Event.size of zero through 1,024 inclusive.
502 @param[in] PcrHandle Handle of the PCR
503 @param[in] EventData Event data in sized buffer
504 @param[out] Digests List of digest
506 @retval EFI_SUCCESS Operation completed successfully.
507 @retval EFI_DEVICE_ERROR Unexpected device behavior.
512 IN TPMI_DH_PCR PcrHandle
,
513 IN TPM2B_EVENT
*EventData
,
514 OUT TPML_DIGEST_VALUES
*Digests
518 This command returns the values of all PCR specified in pcrSelect.
520 @param[in] PcrSelectionIn The selection of PCR to read.
521 @param[out] PcrUpdateCounter The current value of the PCR update counter.
522 @param[out] PcrSelectionOut The PCR in the returned list.
523 @param[out] PcrValues The contents of the PCR indicated in pcrSelect.
525 @retval EFI_SUCCESS Operation completed successfully.
526 @retval EFI_DEVICE_ERROR The command was unsuccessful.
531 IN TPML_PCR_SELECTION
*PcrSelectionIn
,
532 OUT UINT32
*PcrUpdateCounter
,
533 OUT TPML_PCR_SELECTION
*PcrSelectionOut
,
534 OUT TPML_DIGEST
*PcrValues
538 This command is used to set the desired PCR allocation of PCR and algorithms.
540 @param[in] AuthHandle TPM_RH_PLATFORM+{PP}
541 @param[in] AuthSession Auth Session context
542 @param[in] PcrAllocation The requested allocation
543 @param[out] AllocationSuccess YES if the allocation succeeded
544 @param[out] MaxPCR maximum number of PCR that may be in a bank
545 @param[out] SizeNeeded number of octets required to satisfy the request
546 @param[out] SizeAvailable Number of octets available. Computed before the allocation
548 @retval EFI_SUCCESS Operation completed successfully.
549 @retval EFI_DEVICE_ERROR The command was unsuccessful.
554 IN TPMI_RH_PLATFORM AuthHandle
,
555 IN TPMS_AUTH_COMMAND
*AuthSession
,
556 IN TPML_PCR_SELECTION
*PcrAllocation
,
557 OUT TPMI_YES_NO
*AllocationSuccess
,
559 OUT UINT32
*SizeNeeded
,
560 OUT UINT32
*SizeAvailable
566 @param[in] PlatformAuth platform auth value. NULL means no platform auth change.
567 @param[in] SupportedPCRBanks Supported PCR banks
568 @param[in] PCRBanks PCR banks
570 @retval EFI_SUCCESS Operation completed successfully.
574 Tpm2PcrAllocateBanks (
575 IN TPM2B_AUTH
*PlatformAuth
, OPTIONAL
576 IN UINT32 SupportedPCRBanks
,
581 This command returns various information regarding the TPM and its current state.
583 The capability parameter determines the category of data returned. The property parameter
584 selects the first value of the selected category to be returned. If there is no property
585 that corresponds to the value of property, the next higher value is returned, if it exists.
586 The moreData parameter will have a value of YES if there are more values of the requested
587 type that were not returned.
588 If no next capability exists, the TPM will return a zero-length list and moreData will have
592 To simplify this function, leave returned CapabilityData for caller to unpack since there are
593 many capability categories and only few categories will be used in firmware. It means the caller
594 need swap the byte order for the feilds in CapabilityData.
596 @param[in] Capability Group selection; determines the format of the response.
597 @param[in] Property Further definition of information.
598 @param[in] PropertyCount Number of properties of the indicated type to return.
599 @param[out] MoreData Flag to indicate if there are more values of this type.
600 @param[out] CapabilityData The capability data.
602 @retval EFI_SUCCESS Operation completed successfully.
603 @retval EFI_DEVICE_ERROR The command was unsuccessful.
608 IN TPM_CAP Capability
,
610 IN UINT32 PropertyCount
,
611 OUT TPMI_YES_NO
*MoreData
,
612 OUT TPMS_CAPABILITY_DATA
*CapabilityData
616 This command returns the information of TPM Family.
618 This function parse the value got from TPM2_GetCapability and return the Family.
620 @param[out] Family The Family of TPM. (a 4-octet character string)
622 @retval EFI_SUCCESS Operation completed successfully.
623 @retval EFI_DEVICE_ERROR The command was unsuccessful.
627 Tpm2GetCapabilityFamily (
632 This command returns the information of TPM manufacture ID.
634 This function parse the value got from TPM2_GetCapability and return the TPM manufacture ID.
636 @param[out] ManufactureId The manufacture ID of TPM.
638 @retval EFI_SUCCESS Operation completed successfully.
639 @retval EFI_DEVICE_ERROR The command was unsuccessful.
643 Tpm2GetCapabilityManufactureID (
644 OUT UINT32
*ManufactureId
648 This command returns the information of TPM FirmwareVersion.
650 This function parse the value got from TPM2_GetCapability and return the TPM FirmwareVersion.
652 @param[out] FirmwareVersion1 The FirmwareVersion1.
653 @param[out] FirmwareVersion2 The FirmwareVersion2.
655 @retval EFI_SUCCESS Operation completed successfully.
656 @retval EFI_DEVICE_ERROR The command was unsuccessful.
660 Tpm2GetCapabilityFirmwareVersion (
661 OUT UINT32
*FirmwareVersion1
,
662 OUT UINT32
*FirmwareVersion2
666 This command returns the information of the maximum value for commandSize and responseSize in a command.
668 This function parse the value got from TPM2_GetCapability and return the max command size and response size
670 @param[out] MaxCommandSize The maximum value for commandSize in a command.
671 @param[out] MaxResponseSize The maximum value for responseSize in a command.
673 @retval EFI_SUCCESS Operation completed successfully.
674 @retval EFI_DEVICE_ERROR The command was unsuccessful.
678 Tpm2GetCapabilityMaxCommandResponseSize (
679 OUT UINT32
*MaxCommandSize
,
680 OUT UINT32
*MaxResponseSize
684 This command returns Returns a list of TPMS_ALG_PROPERTIES. Each entry is an
685 algorithm ID and a set of properties of the algorithm.
687 This function parse the value got from TPM2_GetCapability and return the list.
689 @param[out] AlgList List of algorithm.
691 @retval EFI_SUCCESS Operation completed successfully.
692 @retval EFI_DEVICE_ERROR The command was unsuccessful.
696 Tpm2GetCapabilitySupportedAlg (
697 OUT TPML_ALG_PROPERTY
*AlgList
701 This command returns the information of TPM LockoutCounter.
703 This function parse the value got from TPM2_GetCapability and return the LockoutCounter.
705 @param[out] LockoutCounter The LockoutCounter of TPM.
707 @retval EFI_SUCCESS Operation completed successfully.
708 @retval EFI_DEVICE_ERROR The command was unsuccessful.
712 Tpm2GetCapabilityLockoutCounter (
713 OUT UINT32
*LockoutCounter
717 This command returns the information of TPM LockoutInterval.
719 This function parse the value got from TPM2_GetCapability and return the LockoutInterval.
721 @param[out] LockoutInterval The LockoutInterval of TPM.
723 @retval EFI_SUCCESS Operation completed successfully.
724 @retval EFI_DEVICE_ERROR The command was unsuccessful.
728 Tpm2GetCapabilityLockoutInterval (
729 OUT UINT32
*LockoutInterval
733 This command returns the information of TPM InputBufferSize.
735 This function parse the value got from TPM2_GetCapability and return the InputBufferSize.
737 @param[out] InputBufferSize The InputBufferSize of TPM.
738 the maximum size of a parameter (typically, a TPM2B_MAX_BUFFER)
740 @retval EFI_SUCCESS Operation completed successfully.
741 @retval EFI_DEVICE_ERROR The command was unsuccessful.
745 Tpm2GetCapabilityInputBufferSize (
746 OUT UINT32
*InputBufferSize
750 This command returns the information of TPM PCRs.
752 This function parse the value got from TPM2_GetCapability and return the PcrSelection.
754 @param[out] Pcrs The Pcr Selection
756 @retval EFI_SUCCESS Operation completed successfully.
757 @retval EFI_DEVICE_ERROR The command was unsuccessful.
761 Tpm2GetCapabilityPcrs (
762 OUT TPML_PCR_SELECTION
*Pcrs
766 This function will query the TPM to determine which hashing algorithms
767 are supported and which PCR banks are currently active.
769 @param[out] TpmHashAlgorithmBitmap A bitmask containing the algorithms supported by the TPM.
770 @param[out] ActivePcrBanks A bitmask containing the PCRs currently allocated.
772 @retval EFI_SUCCESS TPM was successfully queried and return values can be trusted.
773 @retval Others An error occurred, likely in communication with the TPM.
778 Tpm2GetCapabilitySupportedAndActivePcrs(
779 OUT UINT32
*TpmHashAlgorithmBitmap
,
780 OUT UINT32
*ActivePcrBanks
784 This command returns the information of TPM AlgorithmSet.
786 This function parse the value got from TPM2_GetCapability and return the AlgorithmSet.
788 @param[out] AlgorithmSet The AlgorithmSet of TPM.
790 @retval EFI_SUCCESS Operation completed successfully.
791 @retval EFI_DEVICE_ERROR The command was unsuccessful.
795 Tpm2GetCapabilityAlgorithmSet (
796 OUT UINT32
*AlgorithmSet
800 This command is used to check to see if specific combinations of algorithm parameters are supported.
802 @param[in] Parameters Algorithm parameters to be validated
804 @retval EFI_SUCCESS Operation completed successfully.
805 @retval EFI_DEVICE_ERROR Unexpected device behavior.
810 IN TPMT_PUBLIC_PARMS
*Parameters
814 This command allows the platform to change the set of algorithms that are used by the TPM.
815 The algorithmSet setting is a vendor-dependent value.
817 @param[in] AuthHandle TPM_RH_PLATFORM
818 @param[in] AuthSession Auth Session context
819 @param[in] AlgorithmSet A TPM vendor-dependent value indicating the
820 algorithm set selection
822 @retval EFI_SUCCESS Operation completed successfully.
823 @retval EFI_DEVICE_ERROR Unexpected device behavior.
827 Tpm2SetAlgorithmSet (
828 IN TPMI_RH_PLATFORM AuthHandle
,
829 IN TPMS_AUTH_COMMAND
*AuthSession
,
830 IN UINT32 AlgorithmSet
834 This command is used to start an authorization session using alternative methods of
835 establishing the session key (sessionKey) that is used for authorization and encrypting value.
837 @param[in] TpmKey Handle of a loaded decrypt key used to encrypt salt.
838 @param[in] Bind Entity providing the authValue.
839 @param[in] NonceCaller Initial nonceCaller, sets nonce size for the session.
840 @param[in] Salt Value encrypted according to the type of tpmKey.
841 @param[in] SessionType Indicates the type of the session.
842 @param[in] Symmetric The algorithm and key size for parameter encryption.
843 @param[in] AuthHash Hash algorithm to use for the session.
844 @param[out] SessionHandle Handle for the newly created session.
845 @param[out] NonceTPM The initial nonce from the TPM, used in the computation of the sessionKey.
847 @retval EFI_SUCCESS Operation completed successfully.
848 @retval EFI_DEVICE_ERROR The command was unsuccessful.
852 Tpm2StartAuthSession (
853 IN TPMI_DH_OBJECT TpmKey
,
854 IN TPMI_DH_ENTITY Bind
,
855 IN TPM2B_NONCE
*NonceCaller
,
856 IN TPM2B_ENCRYPTED_SECRET
*Salt
,
857 IN TPM_SE SessionType
,
858 IN TPMT_SYM_DEF
*Symmetric
,
859 IN TPMI_ALG_HASH AuthHash
,
860 OUT TPMI_SH_AUTH_SESSION
*SessionHandle
,
861 OUT TPM2B_NONCE
*NonceTPM
865 This command causes all context associated with a loaded object or session to be removed from TPM memory.
867 @param[in] FlushHandle The handle of the item to flush.
869 @retval EFI_SUCCESS Operation completed successfully.
870 @retval EFI_DEVICE_ERROR The command was unsuccessful.
875 IN TPMI_DH_CONTEXT FlushHandle
879 This command includes a secret-based authorization to a policy.
880 The caller proves knowledge of the secret value using an authorization
881 session using the authValue associated with authHandle.
883 @param[in] AuthHandle Handle for an entity providing the authorization
884 @param[in] PolicySession Handle for the policy session being extended.
885 @param[in] AuthSession Auth Session context
886 @param[in] NonceTPM The policy nonce for the session.
887 @param[in] CpHashA Digest of the command parameters to which this authorization is limited.
888 @param[in] PolicyRef A reference to a policy relating to the authorization.
889 @param[in] Expiration Time when authorization will expire, measured in seconds from the time that nonceTPM was generated.
890 @param[out] Timeout Time value used to indicate to the TPM when the ticket expires.
891 @param[out] PolicyTicket A ticket that includes a value indicating when the authorization expires.
893 @retval EFI_SUCCESS Operation completed successfully.
894 @retval EFI_DEVICE_ERROR The command was unsuccessful.
899 IN TPMI_DH_ENTITY AuthHandle
,
900 IN TPMI_SH_POLICY PolicySession
,
901 IN TPMS_AUTH_COMMAND
*AuthSession
, OPTIONAL
902 IN TPM2B_NONCE
*NonceTPM
,
903 IN TPM2B_DIGEST
*CpHashA
,
904 IN TPM2B_NONCE
*PolicyRef
,
906 OUT TPM2B_TIMEOUT
*Timeout
,
907 OUT TPMT_TK_AUTH
*PolicyTicket
911 This command allows options in authorizations without requiring that the TPM evaluate all of the options.
912 If a policy may be satisfied by different sets of conditions, the TPM need only evaluate one set that
913 satisfies the policy. This command will indicate that one of the required sets of conditions has been
916 @param[in] PolicySession Handle for the policy session being extended.
917 @param[in] HashList the list of hashes to check for a match.
919 @retval EFI_SUCCESS Operation completed successfully.
920 @retval EFI_DEVICE_ERROR The command was unsuccessful.
925 IN TPMI_SH_POLICY PolicySession
,
926 IN TPML_DIGEST
*HashList
930 This command indicates that the authorization will be limited to a specific command code.
932 @param[in] PolicySession Handle for the policy session being extended.
933 @param[in] Code The allowed commandCode.
935 @retval EFI_SUCCESS Operation completed successfully.
936 @retval EFI_DEVICE_ERROR The command was unsuccessful.
940 Tpm2PolicyCommandCode (
941 IN TPMI_SH_POLICY PolicySession
,
946 This command returns the current policyDigest of the session. This command allows the TPM
947 to be used to perform the actions required to precompute the authPolicy for an object.
949 @param[in] PolicySession Handle for the policy session.
950 @param[out] PolicyHash the current value of the policyHash of policySession.
952 @retval EFI_SUCCESS Operation completed successfully.
953 @retval EFI_DEVICE_ERROR The command was unsuccessful.
957 Tpm2PolicyGetDigest (
958 IN TPMI_SH_POLICY PolicySession
,
959 OUT TPM2B_DIGEST
*PolicyHash
967 Copy AuthSessionIn to TPM2 command buffer.
969 @param [in] AuthSessionIn Input AuthSession data
970 @param [out] AuthSessionOut Output AuthSession data in TPM2 command buffer
972 @return AuthSession size
976 CopyAuthSessionCommand (
977 IN TPMS_AUTH_COMMAND
*AuthSessionIn
, OPTIONAL
978 OUT UINT8
*AuthSessionOut
982 Copy AuthSessionIn from TPM2 response buffer.
984 @param [in] AuthSessionIn Input AuthSession data in TPM2 response buffer
985 @param [out] AuthSessionOut Output AuthSession data
987 @return AuthSession size
991 CopyAuthSessionResponse (
992 IN UINT8
*AuthSessionIn
,
993 OUT TPMS_AUTH_RESPONSE
*AuthSessionOut OPTIONAL
997 Return size of digest.
999 @param[in] HashAlgo Hash algorithm
1001 @return size of digest
1005 GetHashSizeFromAlgo (
1006 IN TPMI_ALG_HASH HashAlgo
1010 Copy TPML_DIGEST_VALUES into a buffer
1012 @param[in,out] Buffer Buffer to hold TPML_DIGEST_VALUES.
1013 @param[in] DigestList TPML_DIGEST_VALUES to be copied.
1014 @param[in] HashAlgorithmMask HASH bits corresponding to the desired digests to copy.
1016 @return The end of buffer to hold TPML_DIGEST_VALUES.
1020 CopyDigestListToBuffer(
1021 IN OUT VOID
*Buffer
,
1022 IN TPML_DIGEST_VALUES
*DigestList
,
1023 IN UINT32 HashAlgorithmMask
1027 Get TPML_DIGEST_VALUES data size.
1029 @param[in] DigestList TPML_DIGEST_VALUES data.
1031 @return TPML_DIGEST_VALUES data size.
1036 IN TPML_DIGEST_VALUES
*DigestList
1040 This function get digest from digest list.
1042 @param[in] HashAlg Digest algorithm
1043 @param[in] DigestList Digest list
1044 @param[out] Digest Digest
1046 @retval EFI_SUCCESS Digest is found and returned.
1047 @retval EFI_NOT_FOUND Digest is not found.
1051 GetDigestFromDigestList(
1052 IN TPMI_ALG_HASH HashAlg
,
1053 IN TPML_DIGEST_VALUES
*DigestList
,