tspi_key_wrapkey(3) [debian man page]

Tspi_Key_WrapKey(3)				     TCG Software Stack Developer's Reference				       Tspi_Key_WrapKey(3)

NAME

       Tspi_Key_WrapKey - wrap a key with the key addressed by hWrappingKey.

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_Key_WrapKey(TSS_HKEY  hKey, TSS_HKEY hWrappingKey,
				   TSS_HPCRS hPcrComposite);

DESCRIPTION

       TSS_Key_WrapKey	wraps  the  private  key hKey using the public key addressed by hWrappingKey. If hPcrComposite is not set to NULL (0), the
       created key blob is bound to its PCR values. The key object addressed by hKey must contain the key information needed for the creation.	On
       successful  return from this call, hKey can be loaded into a TPM. hKey must have been created as a migratable key and should have its usage
       and migrations secrets set using Tspi_Policy_SetSecret(3).  Also, hKey should have had its private key set to either RSA private component,
       p or q.

PARAMETERS

   hKey
       The handle of the key object that is wrapped.

   hWrappingKey
       The handle to the key used to wrap the newly created key.

   hPcrComposite
       The handle to an object, if the value of the handle doesn't equal NULL, the newly create key will be bound ot the PCR values described with
       this object.

RETURN CODES

       Tspi_Key_WrapKey returns TSS_SUCCESS on success, otherwise one of the following values are returned:

       TSS_E_INVALID_HANDLE - Either hKey, hWrappingKey or hPcrComposite are invalid handles.

       TSS_E_INTERNAL_ERROR - An error occurred internal to the TSS.

CONFORMING TO

       Tspi_Key_WrapKey conforms to the Trusted Computing Group Software Specification version 1.1 Golden

SEE ALSO

       Tspi_Key_CreateKey(3), Tspi_Key_CertifyKey(3), Tspi_Key_RegisterKey(3).

TSS 1.1 							    2004-05-26						       Tspi_Key_WrapKey(3)

Tspi_Context_LoadKeyByBlob(3)				     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 gotten 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

SEE ALSO

       Tspi_Context_LoadKeyByUUID(3), Tspi_Policy_SetSecret(3), Tspi_GetPolicyObject(3), Tspi_Key_CreateKey(3), Tspi_GetAttribUint32(3).

TSS 1.1 							    2004-05-25					     Tspi_Context_LoadKeyByBlob(3)