Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

Tspi_Context_LoadKeyByBlob (3)

Name

Tspi_Context_LoadKeyByBlob - load a key into the TPM using the key's blob.

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_LoadKeyByBlob(TSS_HCONTEXT hContext,     TSS_HKEY hUnwrappingKey,
UINT32       ulBlobLength, BYTE*    rgbBlobData,
TSS_HKEY*    phKey);

Description

Library Functions Manual                         Tspi_Context_LoadKeyByBlob(3)



                   TCG Software Stack Developers Reference

NAME
       Tspi_Context_LoadKeyByBlob  -  load  a key into the TPM using the key's
       blob.

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_LoadKeyByBlob(TSS_HCONTEXT hContext,     TSS_HKEY hUnwrappingKey,
                                             UINT32       ulBlobLength, BYTE*    rgbBlobData,
                                             TSS_HKEY*    phKey);



DESCRIPTION
       Tspi_Context_LoadKeyByBlob creates a key based on the information  got-
       ten  by the key blob. It then loads the key into the TPM, which unwraps
       the key blob by using the key associated with hUnwrappingKey.  The  key
       blob addressed by hUnwrappingKey must have been already loaded into the
       TPM. This function returns a handle to the created key object.


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

   hUnwrappingKey
       The hUnwrappingKey parameter is the handle  of  the  key  object  which
       should be used to unwrap the key information associated with rgbBlobDa-
       ta.

   rgbBlobData
       The rgbBlobData parameter is the wrapped key to load.

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


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

       TSS_E_INVALID_HANDLE
              hContext is not a valid handle.


       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_LoadKeyByBlob 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_LoadKeyByUUID(3),  Tspi_Policy_SetSecret(3), Tspi_GetPoli-
       cyObject(3), Tspi_Key_CreateKey(3), Tspi_GetAttribUint32(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_LoadKeyByBlob(3)