1Tspi_Context_GetRegiTsCtGerSeodfKtewyasrBeyUSUtIaDc2k(3DT)esvpeil_oCpoenrt'esxtR_eGfeetrReengciesteredKeysByUUID2(3)
2
3
4
6 Tspi_Context_GetRegisteredKeysByUUID2 - get an array of TSS_KM_KEYINFO2
7 structures based on the state of persistent storage.
8
10 #include <tss/platform.h>
11 #include <tss/tcpa_defines.h>
12 #include <tss/tcpa_typedef.h>
13 #include <tss/tcpa_struct.h>
14 #include <tss/tss_typedef.h>
15 #include <tss/tss_structs.h>
16 #include <tss/tspi.h>
17
18 TSS_RESULT Tspi_Context_GetRegisteredKeysByUUID2(TSS_HCONTEXT hContext, TSS_FLAG persistentStorageType,
19 TSS_UUID* pUuidData, UINT32* pulKeyHierarchySize,
20 TSS_KM_KEYINFO2** ppKeyHierarchy);
21
22
23
25 TSS_Context_GetRegisteredKeysByUUID2 gets an array of TSS_KM_KEYINFO2
26 structures. This information reflects the state of the registered key
27 hierarchy. The keys stored in the persistent storage are totallly inde‐
28 pendent from either the context provided in the function call or the
29 context, which was provided while processing the key registration.
30
32 hContext
33 The handle of the context object.
34
35 persistentStorageType
36 Flag indicating the persistent storage the key is registered in.
37
38 pUuidData
39 The UUID the key was registered in the persistent storage (TSP or con‐
40 nected TCS). If no key UUID is provided, thus KeyUUID is NULL, the re‐
41 turned array of the TSS_KM_KEYINFO2 structure contains data reflecting
42 the whole key hierarchy starting with root key. If a certain key is
43 UUID is provided, the returned array of TSS_KM_KEYINFO2 structures only
44 contains data reflecting the path of the key hierarchy regarding that
45 key. The first array entry is the key addressed by the given UUID fol‐
46 lowed by its parent key up to the root key.
47
48 pulKeyHierarchySize
49 Recieves the length (number of array entries) of the ppKeyHierarchy pa‐
50 rameter.
51
52 ppKeyHierarchy
53 On successful completion of the command, this parameter points to a
54 buffer containing the actual key hierarchy data.
55
57 Tspi_Context_GetRegisteredKeysByUUID2 returns TSS_SUCCESS on success,
58 otherwise one of the following values are returned:
59
60 TSS_E_INVALID_HANDLE - hContext is an invalid handle.
61
62 TSS_E_BAD_PARAMETER
63
64 TSS_E_INTERNAL_ERROR
65 An error occurred internal to the TSS.
66
68 Tspi_Context_GetRegisteredKeysByUUID2 conforms to the Trusted Computing
69 Group Software Specification version 1.2
70
72 Tspi_Context_LoadKeyByUUID(3).
73
74
75
76TSS 1.2 2007-T0s7p-i0_6Context_GetRegisteredKeysByUUID2(3)