Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

Tspi_Policy_SetSecret (3)

Name

Tspi_Policy_SetSecret - set the authorization data of a policy object and define the handling of its retrieval

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_Policy_SetSecret(TSS_HPOLICY hPolicy,        TSS_FLAG secretMode,
UINT32      ulSecretLength, BYTE*    rgbSecret);

Description

TCG Software Stack Developer's Reference              Tspi_Policy_SetSecret(3)



NAME
       Tspi_Policy_SetSecret  -  set the authorization data of a policy object
       and define the handling of its retrieval

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_Policy_SetSecret(TSS_HPOLICY hPolicy,        TSS_FLAG secretMode,
                                        UINT32      ulSecretLength, BYTE*    rgbSecret);



DESCRIPTION
       TSS_Policy_SetSecret sets the authorization data for  an  object.  This
       mthod  also defines the handling of its retrieving. There are mand dif-
       ferent paths as specified by the secretMode Flag.

PARAMETERS
   hPolicy
       The handle of the policy object.

   secretMode
       Flag indicating the policy secret mode to set. Possible values are:
        TSS_SECRET_MODE_SHA1 - Secret in the form of 20 bytes of  SHA-1  data.
       The secret will not be touched by the TSP.
        TSS_SECRET_MODE_PLAIN  -  The data passed in will be hashed by the TSP
       using SHA-1.
        TSS_SECRET_MODE_POPUP - The TSP will ask for a secret by displaying  a
       GUI pop-up window.
        TSS_SECRET_MODE_CALLBACK  -  The  application  will provide a callback
       function for authorization data.
        TSS_SECRET_MODE_NONE - ulSecretLen and rgbSecret are ignored  and  any
       object requiring auth assigned this policy will return an error.

   ulSecretLength
       The length (in bytes) of the rgbSecret parameter.

   rgbSecret
       The secret data blob.

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

       TSS_E_INVALID_HANDLE - hPolicy is an invalid parameter.

       TSS_E_INTERNAL_ERROR - An error occurred internal to the TSS.

CONFORMING TO
       Tspi_Policy_SetSecret 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_Policy_FlushSecret(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_Policy_SetSecret(3)