man pages section 3: Library Interfaces and Headers

Tspi_TPM_GetRandom (3)

Name

Tspi_TPM_GetRandom - generate a random number on the TPM

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_GetRandom(TSS_HTPM hTPM, UINT32 size, BYTE** random);

Description

Tspi_TPM_GetRandom(3)      Library Functions Manual      Tspi_TPM_GetRandom(3)



                   TCG Software Stack Developer's Reference

NAME
       Tspi_TPM_GetRandom - generate a random number on the TPM

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_GetRandom(TSS_HTPM hTPM, UINT32 size, BYTE** random);


DESCRIPTION
       Tspi_TPM_GetRandom  gets a good random number for the purpose of gener-
       ating symmetric keys, nonces, or seeding a random number generator.


PARAMETERS
   hTPM
       The hTPM parameter is used to specify the handle of the TPM object. The
       command to get the TPM to test itself will be sent here.

   size
       The size parameter is the number of random bytes requested.

   random
       The random parameter is a pointer to memory containing the random data.
       This is where the generated number goes. Because this internally  allo-
       cates memory, Tspi_Context_FreeMemory should also be used.


RETURN CODES
       Tspi_TPM_GetRandom 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.


       TSS_E_BAD_PARAMETER
              One or more parameters is bad.


CONFORMING TO
       Tspi_TPM_GetRandom 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_Context_FreeMemory(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-25             Tspi_TPM_GetRandom(3)