bionic (3) Tspi_TPM_CreateMaintenanceArchive.3.gz

NAME

       Tspi_TPM_CreateMaintenanceArchive - create the TPM manufacturer specific maintenance archive data.

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_CreateMaintenanceArchive(TSS_HTPM hTPM,                 TSS_BOOL fGenerateRndNumber,
                                                    UINT32*  pulRndNumberLength,   BYTE**   prgbRndNumber,
                                                    UINT32*  pulArchiveDataLength, BYTE**   prgbArchiveData);

DESCRIPTION

       Tspi_TPM_CreateMaintenanceArchive  creates  the TPM Manufacturer specific maintenance archive data.  This
       command is not currently implemented by any manufacturer.

PARAMETERS

   hTPM
       The hTPM parameter is used to specify the handle of the TPM object.

   fGenerateRndNumber
       The fGenerateRndNumber parameter determines how the random number is generated. If TRUE, a random  number
       is generated by the TPM and returned. If FALSE, a random number is calculated based on the owner secret.

   pulRndNumberLength
       The  pulRndNumberLength  parameter receives the length in bytes of the prgbRndNumber parameter. This is 0
       if fGenerateRndNumber is FALSE.

   prgbRndNumber
       The prgbRndNumber parameter receives a pointer to the random number data  attributes.  This  is  NULL  if
       fGenerateRndNumber is FALSE.

   pulArchiveDataLength
       The pulArchiveDataLength parameter receives the length in bytes of the prgbArchiveData parameter.

   prgbArchiveData
       The prgbArchiveData parameter receives a pointer to the archive data.

RETURN CODES

       Tspi_TPM_CreateMaintenanceArchive  returns  TSS_SUCCESS on success, otherwise one of the following values
       is returned:

       TSS_E_INVALID_HANDLE
              hTPM is not a valid handle.

       TSS_E_INTERNAL_ERROR
              An internal SW error has been detected.

       TSS_E_BAD_PARAMETER
              One or more parameters is bad.

       TSS_E_NOTIMPL
              The function is not implemented.

CONFORMING TO

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

SEE ALSO

       Tspi_TPM_KillMaintenanceFeature(3),                                    Tspi_TPM_LoadMaintenancePubKey(3),
       Tspi_TPM_CheckMaintenancePubKey(3).