man pages section 3: Library Interfaces and Headers

Tspi_Context_GetKeyByUUID (3)

Name

Tspi_Context_GetKeyByUUID - tent 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_GetKeyByUUID(TSS_HCONTEXT hContext, TSS_FLAG  persistentStorageType,
TSS_UUID     uuidData, TSS_HKEY* phKey);

Description

Library Functions Manual                          Tspi_Context_GetKeyByUUID(3)



                   TCG Software Stack Developers Reference

NAME
       Tspi_Context_GetKeyByUUID - get a handle to a key registered in persis-
       tent 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_GetKeyByUUID(TSS_HCONTEXT hContext, TSS_FLAG  persistentStorageType,
                                            TSS_UUID     uuidData, TSS_HKEY* phKey);



DESCRIPTION
       Tspi_Context_GetKeyByUUID searches the Persistent Storage database  for
       a  registered  key  using  the given UUID. It then creates a key object
       initialized to the found data and returns a handle to the key object.


PARAMETERS
   hContext
       The hContext parameter is the handle of the context object.

   persistentStorageType
       The persistentStorageType parameter indicates  the  persistent  storage
       the key is registered in.

   uuidData
       The  uuidData  parameter  is the UUID by which the key is registered in
       persistent storage.

   phKey
       The phKey parameter receives the handle of the key object  representing
       the key.


RETURN CODES
       Tspi_Context_GetKeyByUUID returns TSS_SUCCESS on success, otherwise one
       of the following values is returned:

       TSS_E_INVALID_HANDLE
              hContext is an invalid handle.


       TSS_E_PS_KEY_NOTFOUND
              The key cannot be found in the persistent storage database.


       TSS_E_INTERNAL_ERROR
              An internal SW error has been detected.


       TSS_E_BAD_PARAMETER
              One or more parameters is bad.


CONFORMING TO
       Tspi_Context_GetKeyByUUID conforms to the Trusted Computing Group Soft-
       ware 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_GetTpmObject(3),  Tspi_Context_LoadKeyByUUID(3), Tspi_Con-
       text_GetRegisteredKeysByUUID(3), Tspi_Context_GetKeyByPublicInfo(3).




NOTES
       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       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.15/trousers-0.3.15.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-25
                                                  Tspi_Context_GetKeyByUUID(3)