Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

tspi_policy_setsecret(3) [debian man page]

Tspi_Policy_SetSecret(3)			     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

SEE ALSO

       Tspi_Policy_FlushSecret(3).

TSS 1.1 							    2004-05-26						  Tspi_Policy_SetSecret(3)

Check Out this Related Man Page

Tspi_Change_Auth(3)				     TCG Software Stack Developer's Reference				       Tspi_Change_Auth(3)

NAME

       Tspi_ChangeAuth - change the authorization data of an entity.

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_ChangeAuth(TSS_HOBJECT hObjectToChange, TSS_HOBJECT hParentObject,
				  TSS_HPOLICY hNewPolicy );

DESCRIPTION

       Tspi_ChangeAuth	changes the authorization data (secret) of an entity (object) and assigns the object to the policy object. All classes us-
       ing secrets provide this method for changing their authorization data.

PARAMETERS

   hObjectToChange
       Handle of the object to change authorization for.

   hParentObject
       Handle of the parent object wrapping the object addressed by hObjectToChange.

   hNewPolicy
       Handle of the policy object providing the new authorization data.

RETURN CODES

       Tspi_ChangeAuth returns TSS_SUCCESS on success,otherwise one of the following values are returned:

       TSS_E_INVALID_HANDLE - Either hObjectToChange, or hParentObject are not a valid handle.

       TSS_E_INTERNAL_ERROR - An error occurred internal to the TSS.

CONFORMING TO

       Tspi_ChangeAuth conforms to the Trusted Computing Group Software Specification version 1.1 Golden

SEE ALSO

       Tspi_ChangeAuthAsym(3).

TSS 1.1 							    2004-05-26						       Tspi_Change_Auth(3)
Man Page