1Tspi_TPM_GetPubEndorsementKeLyi(b3r)ary Functions MaTnsupail_TPM_GetPubEndorsementKey(3)
2
3
4
5                   TCG Software Stack Developer's Reference
6

NAME

8       Tspi_TPM_GetPubEndorsementKey  - create a TSS key object from the TPM's
9       public endorsement key
10

SYNOPSIS

12       #include <tss/platform.h>
13       #include <tss/tcpa_defines.h>
14       #include <tss/tcpa_typedef.h>
15       #include <tss/tcpa_struct.h>
16       #include <tss/tss_typedef.h>
17       #include <tss/tss_structs.h>
18       #include <tss/tspi.h>
19
20       TSS_RESULT Tspi_TPM_GetPubEndorsementKey(TSS_HTPM        hTPM,            TSS_BOOL  fOwnerAuthorized,
21                                                TSS_VALIDATION* pValidationData, TSS_HKEY* phEndorsementPubKey);
22
23
24

DESCRIPTION

26       Tspi_TPM_GetPubEndorsementKey This function retrieves  the  public  en‐
27       dorsement key (PubEK) from the TPM and creates a TSS key object for it,
28       whose handle is returned in phEndorsementPubKey. Due to the  fact  that
29       different  TPM  chips validate the PubEK in different ways, application
30       verification of the PubEK (using a non-NULL pValidationData is  broken.
31       Tspi_TPM_GetPubEndorsementKey should be called with a NULL pValidation‐
32       Data parameter to allow the TSS to verify the PubEK itself.
33
34

PARAMETERS

36   hTPM
37       The hTPM parameter is used to specify the handle of the TPM object.
38
39   fOwnerAuthorized
40       If TRUE, the TPM owner secret must be provided to get  the  public  en‐
41       dorsement  key.   If FALSE, no TPM owner secret must be provided to get
42       the public endorsement key.
43
44   pValidationData
45       If non-NULL, the application should set the  pValidationData->rgbExter‐
46       nalData   parameter   to   20  bytes  of  random  data  before  calling
47       Tspi_TPM_GetPubEndorsementKey. On successful completion of the command,
48       the  structure  will provide buffers containing the validation data and
49       the buffer the validation data was computed from.
50
51   phEndorsementPubKey
52       Receives a handle to a key object representing  the  TPM's  public  en‐
53       dorsement key.
54
55

RETURN CODES

57       Tspi_TPM_GetPubEndorsementKey returns TSS_SUCCESS on success, otherwise
58       one of the following values is returned:
59
60       TSS_E_INVALID_HANDLE
61              hTPM is not a valid handle.
62
63
64       TSS_E_INTERNAL_ERROR
65              An internal SW error has been detected.
66
67
68       TSS_E_BAD_PARAMETER
69              One or more parameters is bad.
70
71
72       TPM_E_DISABLED_CMD
73              Reading of PubEK from TPM has been disabled.
74
75

CONFORMING TO

77       Tspi_TPM_GetPubEndorsementKey conforms to the Trusted  Computing  Group
78       Software Specification version 1.1 Golden
79
80

SEE ALSO

82       Tspi_Key_GetPubKey(3).
83
84
85
86
87TSS 1.1                           2004-05-25  Tspi_TPM_GetPubEndorsementKey(3)
Impressum