Documentation
¶
Overview ¶
Package ppi provides a way of interacting with the TCG PC Client Physical Presence Interface
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ( // ErrOperationUnsupported indicates that the requested physical presence // operation is unsupported. ErrOperationUnsupported = errors.New("the requested PPI operation is unsupported") // ErrOperationFailed indicates that the requested physical presence // operation request failed. ErrOperationFailed = errors.New("the PPI operation request failed") )
View Source
var ( Version10 = Version{Major: 1, Minor: 0} Version11 = Version{Major: 1, Minor: 1} Version12 = Version{Major: 1, Minor: 2} Version13 = Version{Major: 1, Minor: 3} )
Functions ¶
This section is empty.
Types ¶
type HashAlgorithms ¶ added in v1.2.0
type HashAlgorithms uint64
HashAlgorithms is a bit field of digest algorithms.
const ( HashAlgorithmSHA1 HashAlgorithms = 1 << iota HashAlgorithmSHA256 HashAlgorithmSHA384 HashAlgorithmSHA512 HashAlgorithmSM3_256 HashAlgorithmSHA3_256 HashAlgorithmSHA3_384 HashAlgorithmSHA3_512 )
func MakeHashAlgorithms ¶ added in v1.2.0
func MakeHashAlgorithms(algs ...tpm2.HashAlgorithmId) HashAlgorithms
MakeHashAlgorithms coverts the supplied list of digest algorithms into a bit field.
type OperationError ¶
type OperationError uint64
OperationError represents an error associated with a PPI operation.
func (OperationError) Error ¶
func (e OperationError) Error() string
type OperationId ¶
type OperationId uint64
OperationId corresponds to a physical presence operation.
const ( NoOperation OperationId = 0 // OperationEnableTPM corresponds to the Enable operation. OperationEnableTPM OperationId = 1 // OperationDisableTPM corresponds to the Enable operation. OperationDisableTPM OperationId = 2 // OperationClearTPM corresponds to the Clear operation. OperationClearTPM OperationId = 5 // OperationEnableAndClearTPM corresponds to the Enable + Clear operation for TPM2 devices, or // the Clear + Enable + Activate operation for TPM1.2 devices. OperationEnableAndClearTPM OperationId = 14 // OperationSetPPRequiredForClearTPM corresponds to the SetPPRequiredForClear_True operation // for TPM2 devices, or the SetNoPPIClear_False for TPM1.2 devices. OperationSetPPRequiredForClearTPM OperationId = 17 // OperationClearPPRequiredForClearTPM corresponds to the SetPPRequiredForClear_False // operation for TPM2 devices, or the SetNoPPIClear_True for TPM1.2 devices. OperationClearPPRequiredForClearTPM OperationId = 18 // OperationSetPCRBanks corresponds to the SetPCRBanks operation for TPM2 devices. OperationSetPCRBanks OperationId = 23 // OperationChangeEPS corresponds to the ChangeEPS operation for TPM2 devices. OperationChangeEPS OperationId = 24 // OperationClearPPRequiredForChangePCRs corresponds to the SetPPRequiredForChangePCRs_False // operation for TPM2 devices. OperationClearPPRequiredForChangePCRs OperationId = 25 // OperationSetPPRequiredForChangePCRs corresponds to the SetPPRequiredForChangePCRs_True // operation for TPM2 devices. OperationSetPPRequiredForChangePCRs OperationId = 26 // OperationClearPPRequiredForEnableTPM corresponds to the SetPPRequiredForTurnOn_False // operation for TPM2 devices. OperationClearPPRequiredForEnableTPM OperationId = 27 // OperationSetPPRequiredForEnableTPM corresponds to the SetPPRequiredForTurnOn_True // operation for TPM2 devices. OperationSetPPRequiredForEnableTPM OperationId = 28 // OperationClearPPRequiredForDisableTPM corresponds to the SetPPRequiredForTurnOff_False // operation for TPM2 devices. OperationClearPPRequiredForDisableTPM OperationId = 29 // OperationSetPPRequiredForDisableTPM corresponds to the SetPPRequiredForTurnOff_True // operation for TPM2 devices. OperationSetPPRequiredForDisableTPM OperationId = 30 // OperationClearPPRequiredForChangeEPS corresponds to the SetPPRequiredForChangeEPS_False // operation for TPM2 devices. OperationClearPPRequiredForChangeEPS OperationId = 31 // OperationSetPPRequiredForChangeEPS corresponds to the SetPPRequiredForChangeEPS_True // operation for TPM2 devices. OperationSetPPRequiredForChangeEPS OperationId = 32 )
func (OperationId) ClearPPRequiredOperationId ¶ added in v1.2.0
func (op OperationId) ClearPPRequiredOperationId() OperationId
ClearPPRequiredOperationId returns the operation ID used to disable the physical presence requirement for this operation. If there isn't a corresponding operation for this, NoOperation will be returned.
func (OperationId) SetPPRequiredOperationId ¶ added in v1.2.0
func (op OperationId) SetPPRequiredOperationId() OperationId
SetPPRequiredOperationId returns the operation ID used to enable the physical presence requirement for this operation. If there isn't a corresponding operation for this, NoOperation will be returned.
type OperationResponse ¶
type OperationResponse struct {
Operation OperationId
Err error // Will be set if the operation failed.
}
OperationResponse provides the response of the last operation executed by the pre-OS environment.
type OperationStatus ¶
type OperationStatus uint64
OperationStatus indicates the status of a physical presence operation.
const ( // OperationNotImplemented indicates that an operation is not implemented. OperationNotImplemented OperationStatus = 0 // OperationFirmwareOnly indicates that an operation is supported but it // cannot be requested from the OS. OperationFirmwareOnly OperationStatus = 1 // OperationBlockedByFirmwareConfig indicates that an operation is supported // but it cannot be requested from the OS because the current firmware settings // don't permit this. OperationBlockedByFirmwareConfig OperationStatus = 2 // OperationPPRequired indicates that an operation can be requested from the // OS but the operation requires approval from a physically present user. OperationPPRequired OperationStatus = 3 // OperationPPNotRequired indicates that an operation can be requested from // the OS without approval from a physically present user. OperationPPNotRequired OperationStatus = 4 )
func (OperationStatus) String ¶
func (s OperationStatus) String() string
type PPI ¶
type PPI interface {
Version() Version
// StateTransitionAction returns the action required to transition the device to the pre-OS
// environment in order to complete the pending physical presence operation request.
StateTransitionAction() (StateTransitionAction, error)
// OperationStatus returns the status of the specified operation.
OperationStatus(op OperationId) (OperationStatus, error)
// EnableTPM requests that the TPM be enabled by the platform firmware.
// For TPM1.2 devices, the TPM is enabled by executing the TPM_PhysicalEnable command.
// For TPM2 devices, the TPM is enabled by not disabling the storage and endorsement hierarchies
// with TPM2_HierarchyControl after TPM2_Startup.
// The caller needs to perform the action described by [PPI.StateTransitionAction] in
// order to complete the request.
EnableTPM() error
// DisableTPM requests that the TPM be disabled by the platform firmware.
// For TPM1.2 devices, the TPM is disabled by executing the TPM_PhysicalDisable command.
// For TPM2 devices, the TPM is disabled by disabling the storage and endorsement hierarchies
// with TPM2_HierarchyControl after TPM2_Startup.
// The caller needs to perform the action described by [PPI.StateTransitionAction] in
// order to complete the request.
DisableTPM() error
// ClearTPM requests that the TPM is cleared by the platform firmware.
// The caller needs to perform the action described by [PPI.StateTransitionAction] in
// order to complete the request.
ClearTPM() error
// EnableAndClearTPM requests that the TPM is enabled and cleared by the platform firmware.
// For TPM1.2 devices, this also activates the device with the TPM_PhysicalSetDeactivated
// command.
// The caller needs to perform the action described by [PPI.StateTransitionAction] in
// order to complete the request.
EnableAndClearTPM() error
// SetPCRBanks requests that the PCR banks associated with the specified algorithms are enabled
// by the platform firmware.
// The caller needs to perform the action described by [PPI.StateTransitionAction] in
// order to complete the request.
SetPCRBanks(algs ...tpm2.HashAlgorithmId) error
// ChangeEPS requests that the TPM's endorsement primary seed is changed by the platform firmware.
// This is only implemented for TPM2 devices.
// The caller needs to perform the action described by [PPI.StateTransitionAction] in
// order to complete the request.
ChangeEPS() error
// SetPPRequiredForOperation requests that approval from a physically present user should be
// required for the specified operation.
// The caller needs to perform the action described by [PPI.StateTransitionAction] in
// order to complete the request.
SetPPRequiredForOperation(op OperationId) error
// ClearPPRequiredForOperation requests that approval from a physically present user should not be
// required for the specified operation.
// The caller needs to perform the action described by [PPI.StateTransitionAction] in
// order to complete the request.
ClearPPRequiredForOperation(op OperationId) error
// OperationResponse returns the response to the previously executed operation from the pre-OS
// environment.
OperationResponse() (*OperationResponse, error)
}
PPI provides a way to interact with the physical presence interface associated with a TPM.
type StateTransitionAction ¶
type StateTransitionAction uint64
StateTransitionAction describes the action required to transition to the pre-OS environment in order for the pending physical presence operation request to be executed.
const ( // StateTransitionNoAction indicates that no action is required. StateTransitionNoAction StateTransitionAction = 0 // StateTransitionShutdownRequired indicates that the OS must shut down // the machine in order to execute a pending operation. StateTransitionShutdownRequired StateTransitionAction = 1 // StateTransitionRebootRequired indicates that the OS must perform a warm // reboot of the machine in order to execute a pending operation. StateTransitionRebootRequired StateTransitionAction = 2 // StateTransitionActionOSVendorSpecific indicates that an OS-specific // action can take place. StateTransitionActionOSVendorSpecific StateTransitionAction = 3 )
func (StateTransitionAction) String ¶
func (a StateTransitionAction) String() string
type Version ¶
type Version struct {
Major, Minor uint
}
Version indicates the version of the physical presence interface.
func ParseVersion ¶ added in v1.2.0
ParseVersion parses the supplied physical presence interface version string.
Source Files
Click to show internal directories.
Click to hide internal directories.