Manual Pages for UNIX Operating System command usage for man Tspi_Key_WrapKey

Introduction to Library Functions             Tspi_Key_WrapKey(3)



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

SYNOPSIS
     #include 
     #include 
     #include 
     #include 
     #include 
     #include 
     #include 

     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  re-
     turn  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

     TSS_E_INTERNAL_ERROR - An error occurred internal

CONFORMING TO




TSS 1.1              Last change: 2004-05-26                    1






Introduction to Library Functions             Tspi_Key_WrapKey(3)



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

ATTRIBUTES
     See attributes(5) for descriptions of the  following  attri-
     butes:

     __________________________________________________
    |   ATTRIBUTE TYPE   |       ATTRIBUTE VALUE      |
    |____________________|_____________________________|_
    | Availability       |  library/security/trousers |
    |____________________|_____________________________|_
    | Interface Stability|  Uncommitted               |
    |____________________|____________________________|

NOTES
     Source for trousers is available  at  http://opensolaris.org
     and at http://sourceforge.net/projects/trousers.  Documenta-
     tion   is   available    at    file:///usr/share/man,    and
     http://sourceforge.net/projects/trousers.































TSS 1.1              Last change: 2004-05-26                    2