Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

Tspi_Context_LoadKeyByUUID (3)

Name

Tspi_Context_LoadKeyByUUID - sistent 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_LoadKeyByUUID(TSS_HCONTEXT hContext, TSS_FLAG persistentStorageType,
TSS_UUID     uuidData, TSS_HKEY* phKey);

Description

TCG Software Stack Developer's Reference
                                                 Tspi_Context_LoadKeyByUUID(3)



NAME
       Tspi_Context_LoadKeyByUUID  - load a key that's been registered in per-
       sistent 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_LoadKeyByUUID(TSS_HCONTEXT hContext, TSS_FLAG persistentStorageType,
                                             TSS_UUID     uuidData, TSS_HKEY* phKey);



DESCRIPTION
       TSS_Context_LoadKeyByUUID creates a key object based on the information
       got from the manager using the UUID and loads the key into the TPM. The
       persistent storage provides all information to load the parent keys re-
       quired to load the key associated with the given UUID.

PARAMETERS
   hContext
       The handle of the context object.

   persistentStorageType
       Flag indicating the persistent storage the key is registered in. Should
       be either TSS_PS_TYPE_USER ot TSS_PS_TYPE_SYSTEM.

   uuidData
       The UUID of the key by which the key was registered in  the  persistent
       storage (TSP or connected TCS).

   phKey
       Receives the handle of the key object representing the loaded key.

RETURN CODES
       Tspi_Context_LoadKeyByUUID  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 - persistentStorageType is not valid.

       TSS_E_INTERNAL_ERROR
              An error occurred internal to the TSS.

CONFORMING TO
       Tspi_Context_LoadKeyByUUID conforms  to  the  Trusted  Computing  Group
       Software Specification version 1.1 Golden


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


       +---------------+---------------------------+
       |ATTRIBUTE TYPE |     ATTRIBUTE VALUE       |
       +---------------+---------------------------+
       |Availability   | library/security/trousers |
       +---------------+---------------------------+
       |Stability      | Uncommitted               |
       +---------------+---------------------------+
SEE ALSO
       Tspi_Context_LoadKeyByBlob(3), Tspi_Key_LoadKey(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.1                           2004-05-26
                                                 Tspi_Context_LoadKeyByUUID(3)