Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

Tspi_Data_Seal (3)

Name

Tspi_Data_Seal - able by Tspi_Data_Unseal on the same system.

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_Data_Seal(TSS_HENCDATA hEncData,     TSS_HKEY hEncKey,
UINT32       ulDataLength, BYTE*    rgbDataToSeal,
TSS_HPCRS    hPcrComposite);

Description

TCG Software Stack Developer's Reference                     Tspi_Data_Seal(3)



NAME
       Tspi_Data_Seal  - encrypt a data blob in a mannar that is only decrypt-
       able by Tspi_Data_Unseal on the same system.

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_Data_Seal(TSS_HENCDATA hEncData,     TSS_HKEY hEncKey,
                                 UINT32       ulDataLength, BYTE*    rgbDataToSeal,
                                 TSS_HPCRS    hPcrComposite);



DESCRIPTION
       Tspi_Data_Seal encrypts a data blob in a mannar that is  only  decrypt-
       able by Tspi_Data_Unseal on the same system. The data blob is encrypted
       using a public key operation with the nonmigratable  key  addressed  by
       the given encryption key object.

PARAMETERS
   hEncData
       Handle  of the data object which contains the sealed data on successful
       completion of the command.

   hEncKey
       Handle to the key object addressing the nonmigratable key which is used
       to encrypt the data.

   ulDataLength
       The Length (in bytes) of the rgbDataToSeal parameter.

   rgbDataToSeal
       Pointer to memory containing the data to be encrypted.

   hPcrComposite
       Handle  of  the PCR Composite object specifying the PCRs which are part
       of the sealed data blob. Set to NULL, if the encrypted data should only
       be bound to the system and PCRs are not of interest.

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

       TSS_E_INVALID_HANDLE - One of the following parameters hEncData, hEncK-
       ey, rgbDataToSeal is invalid.

       TSS_E_INTERNAL_ERROR - An error occurred internal to the TSS.


CONFORMING TO
       Tspi_Data_Seal  conforms to the Trusted Computing Group Software Speci-
       fication 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_Data_Unseal(3).






NOTES
       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       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.15/trousers-0.3.15.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_Data_Seal(3)