Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

Tspi_Key_CreateMigrationBlob (3)

Name

Tspi_Key_CreateMigrationBlob - create a key blob suitable for migrating to another TPM.

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_CreateMigrationBlob(TSS_HKEY hKeyToMigrate,          TSS_HKEY hParentKey,
UINT32   ulMigTicketLength,      BYTE*    rgbMigTicket,
UINT32*  pulRandomLength,        BYTE**   prgbRandom,
UINT32*  pulMigrationBlobLength, BYTE**   prgbMigrationBlob);

Description

TCG Software Stack Developer's Reference
                                               Tspi_Key_CreateMigrationBlob(3)



NAME
       Tspi_Key_CreateMigrationBlob - create a key blob suitable for migrating
       to another TPM.

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_CreateMigrationBlob(TSS_HKEY hKeyToMigrate,          TSS_HKEY hParentKey,
                                               UINT32   ulMigTicketLength,      BYTE*    rgbMigTicket,
                                               UINT32*  pulRandomLength,        BYTE**   prgbRandom,
                                               UINT32*  pulMigrationBlobLength, BYTE**   prgbMigrationBlob);


DESCRIPTION
       Tspi_Key_CreateMigrationBlob returns a key blob containing an encrypted
       section,  which will be different depending on the migration scheme in-
       dicated within the migration ticket previously created  by  the  method
       Tspi_TPM_AuthorizeMigrationTicket().

PARAMETERS
   hKeyToMigrate
       Handle of the key object to migrate.

   hParentKey
       Handle to the parent key related to the key addressed by hKeyToMigrate.

   ulMigTicketLength
       The length (in bytes) of the rgbMigTickey parameter.

   rgbMigTicket
       Pointer to memory containing the migration ticket (migration public key
       and its authorization digest).

   pulRandomLength
       On successful completion this parameter returns the random data  length
       returned at the parameter prgbRandom.

   prgbRandom
       On successful completion this parameter returns the random data.

   pulMigrationBlobLength
       On  successful  completion this parameter returns the length of the mi-
       gration blob data returned at the parameter prgbMigrationBlob.

   prgbMigrationBlob
       On successful completion this  parameter  returns  the  migration  data
       blob.

RETURN CODES
       Tspi_Key_CreateMigrationBlob  returns TSS_SUCCESS on success, otherwise
       one of the following values are returned:

       TSS_E_INVALID_HANDLE - Either hKeyToMigrate, hParentKey or rgbMigTicket
       are invalid parameters.

       TSS_E_BAD_PARAMETER - One of the passed parameters is wrong.

       TSS_E_KEY_NO_MIGRATION_POLICY - No migration policy picked.

       TSS_E_INTERNAL_ERROR - An error occurred internal to the TSS.


CONFORMING TO
       Tspi_Key_CreateMigrationBlob  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_Key_CreateKey(3), Tspi_Key_CertifyKey(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_Key_CreateMigrationBlob(3)