Manual Pages for UNIX Operating System command usage for man Tspi_TPM_GetPubEndorsementKey

Introduction to Library Functions
                                 Tspi_TPM_GetPubEndorsementKey(3)



               TCG Software Stack Developer's Reference

NAME
     Tspi_TPM_GetPubEndorsementKey - create a TSS key object from
     the TPM's public endorsement key

SYNOPSIS
     #include 
     #include 
     #include 
     #include 
     #include 
     #include 
     #include 

     TSS_RESULT Tspi_TPM_GetPubEndorsementKey(TSS_HTPM        hTPM,            TSS_BOOL  fOwnerAuthorized,
                                              TSS_VALIDATION* pValidationData, TSS_HKEY* phEndorsementPubKey);



DESCRIPTION
     Tspi_TPM_GetPubEndorsementKey This  function  retrieves  the
     public  endorsement  key  (PubEK) from the TPM and creates a
     TSS key object for it, whose handle is returned in  phEndor-
     sementPubKey. Due to the fact that different TPM chips vali-
     date the PubEK in different ways,  application  verification
     of  the  PubEK  (using a non-NULL pValidationData is broken.
     Tspi_TPM_GetPubEndorsementKey should be called with  a  NULL
     pValidationData parameter to allow the TSS to verify the Pu-
     bEK itself.


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

  fOwnerAuthorized
     If TRUE, the TPM owner secret must be provided  to  get  the
     public  endorsement key.  If FALSE, no TPM owner secret must
     be provided to get the public endorsement key.

  pValidationData
     If   non-NULL,    the    application    should    set    the
     pValidationData->rgbExternalData  parameter  to  20 bytes of
     random data before calling Tspi_TPM_GetPubEndorsementKey. On
     successful  completion  of  the  command, the structure will
     provide buffers  containing  the  validation  data  and  the
     buffer the validation data was computed from.





TSS 1.1              Last change: 2004-05-25                    1






Introduction to Library Functions
                                 Tspi_TPM_GetPubEndorsementKey(3)



  phEndorsementPubKey
     Receives a handle to a key  object  representing  the  TPM's
     public endorsement key.


RETURN CODES
     Tspi_TPM_GetPubEndorsementKey returns  TSS_SUCCESS  on  suc-
     cess, 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.


     TPM_E_DISABLED_CMD
          Reading of PubEK from TPM has been disabled.


CONFORMING TO
     Tspi_TPM_GetPubEndorsementKey conforms to the  Trusted  Com-
     puting Group Software Specification version 1.1 Golden


SEE ALSO
     Tspi_Key_GetPubKey(3).


ATTRIBUTES
     See attributes(5) for descriptions of the  following  attri-
     butes:

     __________________________________________________
    |   ATTRIBUTE TYPE   |       ATTRIBUTE VALUE      |
    |____________________|_____________________________|_
    | Availability       |  library/security/trousers |
    |____________________|_____________________________|_
    | Interface Stability|  Uncommitted               |
    |____________________|____________________________|

NOTES
     Source for trousers is available  at  http://opensolaris.org
     and at http://sourceforge.net/projects/trousers.  Documenta-
     tion   is   available    at    file:///usr/share/man,    and
     http://sourceforge.net/projects/trousers.



TSS 1.1              Last change: 2004-05-25                    2






Introduction to Library Functions
                                 Tspi_TPM_GetPubEndorsementKey(3)






















































TSS 1.1              Last change: 2004-05-25                    3