Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

Tspi_Context_GetKeyByPublicInfo (3)

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);

Description

TCG Software Stack Developer's Reference
                                            Tspi_Context_GetKeyByPublicInfo(3)



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);



DESCRIPTION
       TSS_Context_GetKeyByPublicInfo  searches the persistent storage  for  a
       registered  key using the provided public key information and creates a
       key object initalized according to the found data. On  successful  com-
       pletion  of  the  method  a handle to the created new key object is re-
       turned.

PARAMETERS
   hContext
       The handle of the context object.

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

   algId
       This parameter indicates the algorithm of the requested key.

   ulPublicInfoLength
       The length of the public key info provided  at  the  parameter  rgbPub-
       licInfo.

   rgbPublicInfo
       The  public  key info is provided to identify the key to be look for at
       the persistent storage. In case algID equals to TSS_ALG_RSA this prame-
       ter contains the modulus of the public RSA key.

   hKey
       Recieves the handle of the key object representing the key. In case the
       key hasn't been found, this value will be NULL.

RETURN CODES
       Tspi_Context_GetKeyByPublicInfo returns TSS_SUCCESS on success,  other-
       wise one of the following values are returned:

       TSS_E_INVALID_HANDLE - hContext is an invalid handle.

       TSS_E_INTERNAL_ERROR - An error occurred internal to the TSS.

CONFORMING TO
       Tspi_Context_GetKeyByPublicInfo 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).



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_GetKeyByPublicInfo(3)