TSPI_CONTEXT_GETREGISTEREDKEYSBYUUID2(3)

💖 Tspi_Context_GetRegisteredKeysByUUID2(3) 💖

okay bestie, welcome to the TCG Software Stack Developer's Reference 🎀 — yes we're really doing this, and yes it's gonna slay

✨ NAME ✨

Tspi_Context_GetRegisteredKeysByUUID2 — bestie it gets you an array of TSS_KM_KEYINFO2 structures, based on the state of persistent storage 💅

🌸 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_Context_GetRegisteredKeysByUUID2(TSS_HCONTEXT     hContext,  TSS_FLAG persistentStorageType,
                                                TSS_UUID*        pUuidData, UINT32*  pulKeyHierarchySize,
                                                TSS_KM_KEYINFO2** ppKeyHierarchy);

🦋 DESCRIPTION 🦋

TSS_Context_GetRegisteredKeysByUUID2 gets an array of TSS_KM_KEYINFO2 structures. This info reflects the state of the registered key hierarchy.

and here's the tea 🫖 — the keys stored in the persistent storage are totally independent from either the context you passed in the function call or the context that was provided while processing the key registration. like, they don't know each other. no cap. 😭

🎀 PARAMETERS 🎀

💜 hContext

The handle of the context object. that's it. that's the whole vibe.

💜 persistentStorageType

Flag indicating the persistent storage the key is registered in 🔑

💜 pUuidData

The UUID the key was registered in the persistent storage (TSP or connected TCS) ⭐

so here's the situation, bestie:

• If no key UUID is provided — meaning KeyUUID is NULL — the returned array of the TSS_KM_KEYINFO2 structure contains data reflecting the whole key hierarchy starting with root key 👑
• If a certain key UUID is provided, the returned array of TSS_KM_KEYINFO2 structures only contains data reflecting the path of the key hierarchy regarding that key. The first array entry is the key addressed by the given UUID, followed by its parent key up to the root key 🌈

💜 pulKeyHierarchySize

Receives the length (number of array entries) of the ppKeyHierarchy parameter 📏

💜 ppKeyHierarchy

On successful completion of the command, this parameter points to a buffer containing the actual key hierarchy data. it's giving main character energy, honestly ✨

🔥 RETURN CODES 🔥

Tspi_Context_GetRegisteredKeysByUUID2 returns TSS_SUCCESS on success 🎉 otherwise one of these lil guys comes back:

• TSS_E_INVALID_HANDLE — hContext is an invalid handle 💀
• TSS_E_BAD_PARAMETER
• TSS_E_INTERNAL_ERROR — an error occurred internal to the TSS 😭

👑 CONFORMING TO 👑

Tspi_Context_GetRegisteredKeysByUUID2 conforms to the Trusted Computing Group Software Specification version 1.2 🫶

🌈 SEE ALSO 🌈

Tspi_Context_LoadKeyByUUID(3) — go read that one next, iykyk 💅

ngl bestie, that's the whole page. every flag, every struct, every error code, all of it. you're literally gonna pass your vibe check on the TSS API fr fr 💖

TSS 1.2 · 2007-07-06 · sending you so much love from the TCG Software Stack Developer's Reference, mwah 🎀💖✨