Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

Tspi_Context_GetRegisteredKeysByUUID2 (3)

Name

Tspi_Context_GetRegisteredKeysByUUID2 - get 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

TCG Software Stack Developer's Reference
                                      Tspi_Context_GetRegisteredKeysByUUID2(3)



NAME
       Tspi_Context_GetRegisteredKeysByUUID2 - get 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  information reflects the state of the registered key
       hierarchy. The keys stored in the persistent storage are totallly inde-
       pendent  from  either  the context provided in the function call or the
       context, which was provided while processing the key registration.

PARAMETERS
   hContext
       The handle of the context object.

   persistentStorageType
       Flag indicating the persistent storage the key is registered in.

   pUuidData
       The UUID the key was registered in the persistent storage (TSP or  con-
       nected  TCS). If no key UUID is provided, thus KeyUUID is NULL, the re-
       turned array of the TSS_KM_KEYINFO2 structure contains data  reflecting
       the  whole  key  hierarchy  starting with root key. If a certain key is
       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  fol-
       lowed by its parent key up to the root key.

   pulKeyHierarchySize
       Recieves the length (number of array entries) of the ppKeyHierarchy pa-
       rameter.

   ppKeyHierarchy
       On successful completion of the command, this  parameter  points  to  a
       buffer containing the actual key hierarchy data.

RETURN CODES
       Tspi_Context_GetRegisteredKeysByUUID2  returns  TSS_SUCCESS on success,
       otherwise one of the following values are returned:

       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


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+---------------------------+
       |ATTRIBUTE TYPE |     ATTRIBUTE VALUE       |
       +---------------+---------------------------+
       |Availability   | library/security/trousers |
       +---------------+---------------------------+
       |Stability      | Uncommitted               |
       +---------------+---------------------------+
SEE ALSO
       Tspi_Context_LoadKeyByUUID(3).



NOTES
       This software was built from source available at https://github.com/or-
       acle/solaris-userland.  The original community  source  was  downloaded
       from                                                    https://source-
       forge.net/projects/trousers/files/trousers/0.3.13/trousers-0.3.13.tar.gz

       Further information about this software can be found on the open source
       community website at http://trousers.sourceforge.net/.



TSS 1.2                           2007-07-06
                                      Tspi_Context_GetRegisteredKeysByUUID2(3)