tspi_context_getkeybypublicinfo(3) [debian man page]

Tspi_Context_GetKeyByPublicInfo(3)		     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 completion 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 rgbPublicInfo.

   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
       prameter 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, otherwise 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

SEE ALSO

       Tspi_Context_LoadKeyByUUID(3).

TSS 1.1 							    2004-05-26					Tspi_Context_GetKeyByPublicInfo(3)

Tspi_Context_GetRegisteredKeysByUUID2(3)	     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 independent 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 connected 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 followed by its parent key up to the root key.

   pulKeyHierarchySize
       Recieves the length (number of array entries) of the ppKeyHierarchy parameter.

   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

SEE ALSO

       Tspi_Context_LoadKeyByUUID(3).

TSS 1.2 							    2007-07-06				  Tspi_Context_GetRegisteredKeysByUUID2(3)