Imported Upstream version 0.3.9upstream/0.3.9upstream

1 files changed, 88 insertions, 0 deletions

diff --git a/man/man3/Tspi_TPM_GetRandom.3 b/man/man3/Tspi_TPM_GetRandom.3
new file mode 100644
index 0000000..c00089d
--- /dev/null
+++ b/man/man3/Tspi_TPM_GetRandom.3
@@ -0,0 +1,88 @@
+.\" Copyright (C) 2004 International Business Machines Corporation
+.\" Written by Megan Schneider based on the Trusted Computing Group Software Stack Specification Version 1.1 Golden
+.\"
+.de Sh \" Subsection
+.br
+.if t .Sp
+.ne 5
+.PP
+\fB\\$1\fR
+.PP
+..
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Ip \" List item
+.br
+.ie \\n(.$>=3 .ne \\$3
+.el .ne 3
+.IP "\\$1" \\$2
+..
+.TH "Tspi_TPM_GetRandom" 3 "2004-05-25" "TSS 1.1"
+.ce 1
+TCG Software Stack Developer's Reference
+.SH NAME
+Tspi_TPM_GetRandom \- generate a random number on the TPM
+.SH "SYNOPSIS"
+.ad l
+.hy 0
+.nf
+.B #include <tss/platform.h>
+.B #include <tss/tcpa_defines.h>
+.B #include <tss/tcpa_typedef.h>
+.B #include <tss/tcpa_struct.h>
+.B #include <tss/tss_typedef.h>
+.B #include <tss/tss_structs.h>
+.B #include <tss/tspi.h>
+.sp
+.BI "TSS_RESULT Tspi_TPM_GetRandom(TSS_HTPM " hTPM ", UINT32 " size ", BYTE** " random ");"
+.fi
+.ad
+.hy
+
+.SH "DESCRIPTION"
+.PP
+\fBTspi_TPM_GetRandom\fR gets a good random number
+for the purpose of generating symmetric keys, nonces, or
+seeding a random number generator.
+
+.SH "PARAMETERS"
+.PP
+.SS hTPM
+The \fIhTPM\fR parameter is used to specify the handle of the TPM
+object. The command to get the TPM to test itself will be sent here.
+.SS size
+The \fIsize\fR parameter is the number of random bytes requested.
+.SS random
+The \fIrandom\fR parameter is a pointer to memory containing the random
+data. This is where the generated number goes. Because this internally
+allocates memory, Tspi_Context_FreeMemory should also be used.
+
+.SH "RETURN CODES"
+.PP
+\fBTspi_TPM_GetRandom\fR returns TSS_SUCCESS on success, otherwise one
+of the following values is returned:
+.TP
+.SM TSS_E_INVALID_HANDLE
+\fIhTPM\fR is not a valid handle.
+
+.TP
+.SM TSS_E_INTERNAL_ERROR
+An internal SW error has been detected.
+
+.TP
+.SM TSS_E_BAD_PARAMETER
+One or more parameters is bad.
+
+.SH "CONFORMING TO"
+
+.PP
+\fBTspi_TPM_GetRandom\fR conforms to the Trusted Computing Group
+Software Specification version 1.1 Golden
+
+.SH "SEE ALSO"
+
+.PP
+\fBTspi_Context_FreeMemory\fR(3).
+