summaryrefslogtreecommitdiff
path: root/man/man3/Tspi_TPM_CreateMaintenanceArchive.3
diff options
context:
space:
mode:
Diffstat (limited to 'man/man3/Tspi_TPM_CreateMaintenanceArchive.3')
-rw-r--r--man/man3/Tspi_TPM_CreateMaintenanceArchive.3107
1 files changed, 107 insertions, 0 deletions
diff --git a/man/man3/Tspi_TPM_CreateMaintenanceArchive.3 b/man/man3/Tspi_TPM_CreateMaintenanceArchive.3
new file mode 100644
index 0000000..edf0835
--- /dev/null
+++ b/man/man3/Tspi_TPM_CreateMaintenanceArchive.3
@@ -0,0 +1,107 @@
+.\" 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_CreateMaintenanceArchive" 3 "2004-05-25" "TSS 1.1"
+.ce 1
+TCG Software Stack Developer's Reference
+.SH NAME
+Tspi_TPM_CreateMaintenanceArchive \- create the TPM manufacturer specific maintenance archive data.
+.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_CreateMaintenanceArchive(TSS_HTPM " hTPM ", TSS_BOOL " fGenerateRndNumber ","
+.BI " UINT32* " pulRndNumberLength ", BYTE** " prgbRndNumber ","
+.BI " UINT32* " pulArchiveDataLength ", BYTE** " prgbArchiveData ");"
+.fi
+.sp
+.ad
+.hy
+
+.SH "DESCRIPTION"
+.PP
+\fBTspi_TPM_CreateMaintenanceArchive\fR
+creates the TPM Manufacturer specific maintenance archive data.
+\fBThis command is not currently implemented by any manufacturer\fR.
+
+.SH "PARAMETERS"
+.PP
+.SS hTPM
+The \fIhTPM\fR parameter is used to specify the handle of the TPM object.
+.SS fGenerateRndNumber
+The \fIfGenerateRndNumber\fR parameter determines how the random number
+is generated. If TRUE, a random number is generated by the TPM and
+returned. If FALSE, a random number is calculated based on the owner
+secret.
+.SS pulRndNumberLength
+The \fIpulRndNumberLength\fR parameter receives the length in bytes of
+the \fIprgbRndNumber\fR parameter. This is 0 if \fIfGenerateRndNumber\fR
+is FALSE.
+.SS prgbRndNumber
+The \fIprgbRndNumber\fR parameter receives a pointer to the random number
+data attributes. This is NULL if \fIfGenerateRndNumber\fR is FALSE.
+.SS pulArchiveDataLength
+The \fIpulArchiveDataLength\fR parameter receives the length in bytes of
+the \fIprgbArchiveData\fR parameter.
+.SS prgbArchiveData
+The \fIprgbArchiveData\fR parameter receives a pointer to the archive data.
+
+.SH "RETURN CODES"
+.PP
+\fBTspi_TPM_CreateMaintenanceArchive\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.
+
+.TP
+.SM TSS_E_NOTIMPL
+The function is not implemented.
+
+.SH "CONFORMING TO"
+
+.PP
+\fBTspi_TPM_CreateMaintenanceArchive\fR conforms to the Trusted Computing
+Group Software Specification version 1.1 Golden
+
+.SH "SEE ALSO"
+
+.PP
+\fBTspi_TPM_KillMaintenanceFeature\fR(3),
+\fBTspi_TPM_LoadMaintenancePubKey\fR(3),
+\fBTspi_TPM_CheckMaintenancePubKey\fR(3).
+