1Tspi_TPM_CollateIdenTtCiGtySRoefqtuweasrte(3S)tack DevelopTesrp'is_TRPeMf_eCroelnlcaeteIdentityRequest(3)
2
3
4

NAME

6       Tspi_TPM_CollateIdentityRequest  - Gets all the informatin necessary to
7       send to a trusted third party (TTP), repartory to  asking  the  TTP  to
8       create a certificate for identity.
9

SYNOPSIS

11       #include <tss/platform.h>
12       #include <tss/tcpa_defines.h>
13       #include <tss/tcpa_typedef.h>
14       #include <tss/tcpa_struct.h>
15       #include <tss/tss_typedef.h>
16       #include <tss/tss_structs.h>
17       #include <tss/tspi.h>
18
19       TSS_RESULT Tspi_TPM_CollateIdentityRequest(TSS_HTPM hTPM,                     TSS_HKEY         hKeySRK,
20                                                  TSS_HKEY hCAPPubKey,
21                                                  UINT32   ulIdentityLabelData,      BYTE*            rgbIdentityLabelData,
22                                                  TSS_HKEY hIdentityKey,             TSS_ALGORITHM_ID algid,
23                                                  UINT32*  pulTCPAIdentityReqLength, BYTE**           prgbTCPAIdentityReq);
24
25
26

DESCRIPTION

28       TSS_TPM_CollateIdentityRequest creates an identity key, binds it to the
29       label and returns a certificate request package. The  privacty  CA  re‐
30       quires this certificate request to attest the identity key.
31
32       Only  the Owner of the TPM has the privledge of creating a TPM identity
33       key.
34
35       The symmetric session key is required to provide confidentiality of the
36       "TCPA_IDENTITY_REQ" data structure, which should be sent to the Privacy
37       CA chosen by the owner.
38

PARAMETERS

40   hTPM
41       Handle of the TPM object.
42
43   hKeySRK
44       Handle to the key object representing the Storage Root Key
45
46   hCAPubKey
47       Handle to the key object representing the public key of  the  CA  which
48       signs the certificate of the created identity key.
49
50   ulIdentityLabelLength
51       Supplies the length (in bytes) of the rgbIdentityLabelData parameter
52
53   rgbLabelData
54       Pointer  to  a memory block containing the identity label, which should
55       be a UNICODE string
56
57   hIdentityKey
58       Handle to the identity key object
59
60   algid
61       The type of symmetric algorithm touse as requred by the Enhanced CA.
62
63   pulTCPAIdentityReqLength
64       Recieves the length (in bytes) of the prgbTCPAIdentityReq parameter
65
66   prgbTCPAIdentyReq
67       Pointer to the memory block containing the certicficate request  struc‐
68       ture.
69

RETURN CODES

71       Tspi_TPM_CollateIdentityRequest  returns TSS_SUCCESS on success, other‐
72       wise one of the following values are returned:
73
74       TSS_E_INVALID_HANDLE
75              Either hTPM or hKeySRK or hCAPubKey is not a valid handle.
76
77       TSS_E_BAD_PARAMETER
78
79
80       TSS_E_INTERNAL_ERROR
81              An error occurred internal to the TSS.
82

CONFORMING TO

84       Tspi_TPM_CollateIdentityRequest conforms to the Trusted Computing Group
85       Software Specification version 1.1 Golden
86

SEE ALSO

88       Tspi_Context_LoadKeyByUUID(3).
89
90
91
92TSS 1.1                           2004-05-26Tspi_TPM_CollateIdentityRequest(3)
Impressum