TSPI_CONTEXT_GETKEYBYPUBLICINFO(3)

💖 Tspi_Context_GetKeyByPublicInfo(3) 💖

okay bestie, gather round, because this one is a TCG Software Stack Developer's Reference page and it's genuinely kind of iconic. it's from the TSS crew, manual name Tspi_C...licInfo(3) (yes the title gets truncated like that, it's giving "my name is too long for the header", we love her anyway) 🎀

✨ NAME ✨

Tspi_Context_GetKeyByPublicInfo — search the persistent storage for a registered key using the provided public key information

🌸 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_GetKeyByPublicInfo(TSS_HCONTEXT     hContext,      TSS_FLAG  persistentStorageType,
                                           TSS_ALGORITHM_ID algID,         UINT32    ulPublicInfoLength,
                                           BYTE*            rgbPublicInfo, TSS_HKEY* phKey);

like, look at that signature. seven includes just to say hi. she's high maintenance and she's worth it 💅

🦋 DESCRIPTION 🦋

so TSS_Context_GetKeyByPublicInfo goes and searches the persistent storage for a registered key, using the public key info you hand it, and then it creates a key object initialized according to the data it found. no cap, that's the whole vibe.

and when the method completes successfully? you get back a handle to that brand-new key object it just made. a little gift. a little treat. 🫶

👑 PARAMETERS 👑

hContext

the handle of the context object. your entry ticket, your little backstage pass. ✨

persistentStorageType

a flag indicating which persistent storage the key is registered in. i.e. where in the storage world we're looking. 🗺️

algId

this parameter indicates the algorithm of the requested key. what kind of key are we even asking for, bestie. 🤔

ulPublicInfoLength

the length of the public key info provided at the parameter rgbPublicInfo. just the size. the measurements. 📏

rgbPublicInfo

the public key info is provided to identify the key to look for in the persistent storage. important detail: in case algID equals TSS_ALG_RSA, this parameter contains the modulus of the public RSA key. so if you're doing RSA, that's the thing that goes here, not something else. noted. 📝

hKey

receives the handle of the key object representing the key. and — big mood — in case the key hasn't been found, this value will be NULL. so check it, fr fr. 😭

🔥 RETURN CODES 🔥

Tspi_Context_GetKeyByPublicInfo returns TSS_SUCCESS on success. otherwise one of these little guys comes back at you:

• TSS_E_INVALID_HANDLE — hContext is an invalid handle. 💀
• TSS_E_INTERNAL_ERROR — an error occurred internal to the TSS. not our fault, not your fault, the TSS is just going through something.

🌈 CONFORMING TO 🌈

Tspi_Context_GetKeyByPublicInfo conforms to the Trusted Computing Group Software Specification version 1.1 Golden. certified, spec-compliant, main character energy. ⭐

🎀 SEE ALSO 🎀

• Tspi_Context_LoadKeyByUUID(3)

like if you liked this one, you'll love that one. iykyk. 💜

ok and one last thing: algID vs algId — the docs spell it both ways in the description and the parameter name. i am simply reporting the lore, not fixing it. 🙈

that's the whole page, bestie! this one came to you from the TSS 1.1 era, dated 2004-05-26, out of the TCG Software Stack Developer's Reference set — so yeah, vintage, but she still ate. go forth and get those keys. 🧚‍♀️✨🍓