xref: /netbsd-src/crypto/external/cpl/trousers/dist/man/man3/Tspi_TPM_LoadMaintenancePubKey.3 (revision 2d5f7628c5531eb583b9313ac2fd1cf8582b4479)
Copyright (C) 2004 International Business Machines Corporation
Written by Megan Schneider based on the Trusted Computing Group Software Stack Specification Version 1.1 Golden

\\$1

.. ..

"\\$1" \\$2
..
"Tspi_TPM_LoadMaintenancePubKey" 3 "2004-05-26" "TSS 1.1"

1 TCG Software Stack Developer's Reference

NAME
Tspi_TPM_LoadMaintenancePubKey- load the public maintenance key into the TPM
"SYNOPSIS"
 #include <tss/platform.h>  #include <tss/tcpa_defines.h>  #include <tss/tcpa_typedef.h>  #include <tss/tcpa_struct.h>  #include <tss/tss_typedef.h>  #include <tss/tss_structs.h>  #include <tss/tspi.h>  "TSS_RESULT Tspi_TPM_LoadMaintenancePubKey(TSS_HTPM " hTPM ", TSS_HKEY " hMaintenanceKey ","  " TSS_VALIDATION* " pValidationData ");" 
"DESCRIPTION"

Tspi_TPM_LoadMaintenancePubKey loads the public maintenance key into the TPM. The maintenance key can only be loaded once; any subsequent calls to this function will fail. The key information for loading the maintenance public key must be set in the key object by Tspi_SetAttribData before this method is called. If pValidationData is NULL, the TSS service provider proofs the digest got internally from the TPM. Otherwise, the caller has to proof the digest by its own.

"PARAMETERS"

hTPM
Handle of the TPM object

hMaintenanceKey
Handle of the maintenance key object

pValidationData
Validation data structure. [IN] Provide externalData information required to compute the signature. [OUT] On successful completion of the ocmmand, the structure provides a buffer containing the validation data and a buffer containing the data the validation data was computed from.
"RETURN CODES"

Tspi_TPM_LoadMaintenancePubKey returns TSS_SUCCESS on success, otherwise one of the following values are returned:

TSS_E_INVALID_HANDLE hTPM or hMaintenanceKey is not a valid handle.

TSS_E_INTERNAL_ERROR An internal SW error has been detected.

TSS_E_BAD_PARAMETER One or more of the parameters is incorrect.

TSS_E_NOTIMPL The command is not implemented.

"CONFORMING TO"

Tspi_TPM_LoadMaintenancePubKey conforms to the Trusted Computing Group Software Specification version 1.1 Golden

"SEE ALSO"

Tspi_TPM_CheckMaintenancePubKey(3), Tspi_TPM_KillMaintenanceFeature(3), Tspi_TPM_CreateMaintenanceArchive(3).