xref: /netbsd-src/crypto/external/cpl/trousers/dist/man/man3/Tspi_Key_ConvertMigrationBlob.3 (revision 2d5f7628c5531eb583b9313ac2fd1cf8582b4479)
Copyright (C) 2004 International Business Machines Corporation
Written by Megan Schneider based on the Trusted Computing Group Software Stack Specification Version 1.1 Golden

\\$1

.. ..

"\\$1" \\$2
..
"Tspi_Key_ConvertMigrationBlob" 3 "2004-05-25" "TSS 1.1"

1 TCG Software Stack Developer's Reference

NAME
Tspi_Key_ConvertMigrationBlob - create a wrapped key from a migration 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_Key_ConvertMigrationBlob(TSS_HKEY " hKeyToMigrate ", TSS_HKEY " hParentKey ","  " UINT32 " ulRandomLength ", BYTE* " rgbRandom ","  " UINT32 " ulMigrationBlobLength ", BYTE* " rgbMigrationBlob ");" 
"DESCRIPTION"

Tspi_Key_ConvertMigrationBlob takes the migration blob built by Tspi_Key_CreateMigrationBlob using the migration scheme TSS_MS_MIGRATE and creates a normal wrapped key. The resulting normal wrapped key blob is stored in the instance associated with hKeyToMigrate and may be retrieved from that instance by Tspi_GetAttribData.

"PARAMETERS"

hKeyToMigrate
The handle of the key object to convert.
hParentKey
Handle to the parent key related to the key addressed by hKeyToMigrate.
ulRandomLength
Length of random data provided at the parameter rgbRandom.
rgbRandom
Random data as returned together with the migration blob by the method Tspi_Key_CreateMigrationBlob.
ulMigrationBlobLength
Length of the migration blob data provided at the parameter rgbMigrationBlob.
rgbMigrationBlob
Migration blob data as returned by a previously called method Tspi_Key_CreateMigrationBlob.
"RETURN CODES"

Tspi_Key_ConvertMigrationBlob returns TSS_SUCCESS on success, otherwise one of the following values is returned:

TSS_E_INVALID_HANDLE hKeyToMigrate or hParentKey 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_Key_ConvertMigrationBlob conforms to the Trusted Computing Group Software Specification version 1.1 Golden

"SEE ALSO"

Tspi_Key_LoadKey(3), Tspi_Key_UnloadKey(3), Tspi_Key_CertifyKey(3), Tspi_Key_CreateMigrationBlob(3).