Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

Tspi_TPM_ClearOwner (3)

Name

Tspi_TPM_ClearOwner - clear TPM ownership

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_TPM_ClearOwner(TSS_HTPM hTPM, TSS_BOOL fForcedClear);

Description

Tspi_TPM_ClearOwner(3)     Library Functions Manual     Tspi_TPM_ClearOwner(3)



                   TCG Software Stack Developer's Reference

NAME
       Tspi_TPM_ClearOwner - clear TPM ownership

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_TPM_ClearOwner(TSS_HTPM hTPM, TSS_BOOL fForcedClear);



DESCRIPTION
       Tspi_TPM_ClearOwner  wipes  the  TPM  of everything but its endorsement
       key. It will wipe the SRK, so anything locked to the SRK will also dis-
       appear  when this command is executed.  This is the only way to be cer-
       tain that keys are gone, as it is the only way to guarantee that  noth-
       ing  can  keep a copy of the key. You must assert either physical pres-
       ence or owner authorization in order to use this command.


PARAMETERS
   hTPM
       The hTPM parameter is used to specify the handle of the TPM object.

   fForcedClear
       The fForcedClear parameter is used to tell whether this command is  be-
       ing  executed  with  owner  authorization or with physical presence. If
       FALSE, then TPM owner authorization is used.  If  TRUE,  then  physical
       presence is required to clear the TPM.


RETURN CODES
       Tspi_TPM_ClearOwner  returns  TSS_SUCCESS  on success, otherwise one of
       the following values is returned:

       TSS_E_INVALID_HANDLE
              hTPM is not a valid handle.


       TSS_E_INTERNAL_ERROR
              An internal SW error has been detected.


CONFORMING TO
       Tspi_TPM_ClearOwner 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_TPM_TakeOwnership(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-25            Tspi_TPM_ClearOwner(3)