~ubuntu-branches/ubuntu/hardy/trousers/hardy-proposed

« back to all changes in this revision

Viewing changes to man/man3/Tspi_TPM_OwnerGetSRKPubKey.3

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Baumann
  • Date: 2008-01-23 22:03:00 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20080123220300-fhtqja3c0oq0gp6z
Tags: 0.3.1-4
* Added patch from Aaron M. Ucko <ucko@debian.org> to allow trousers to
  build successfully on amd64, and presumably also other 64-bit
  architectures (Closes: #457400).
* Including udev rule for /dev/tpm from William Lima
  <wlima.amadeus@gmail.com> as suggested by David Smith <dds@google.com>
  (Closes: #459682).
* Added lintian overrides.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.\" Copyright (C) 2007 International Business Machines Corporation
 
2
.\" Written by Loulwa Salem based on the Trusted Computing Group Software Stack Specification Version 1.2
 
3
.\"
 
4
.de Sh \" Subsection
 
5
.br
 
6
.if t .Sp
 
7
.ne 5
 
8
.PP
 
9
\fB\\$1\fR
 
10
.PP
 
11
..
 
12
.de Sp \" Vertical space (when we can't use .PP)
 
13
.if t .sp .5v
 
14
.if n .sp
 
15
..
 
16
.de Ip \" List item
 
17
.br
 
18
.ie \\n(.$>=3 .ne \\$3
 
19
.el .ne 3
 
20
.IP "\\$1" \\$2
 
21
..
 
22
.TH "Tspi_TPM_OwnerGetSRKPubKey" 3 "2007-07-19" "TSS 1.1"
 
23
.ce 1
 
24
TCG Software Stack Developer's Reference
 
25
.SH NAME
 
26
Tspi_TPM_OwnerGetSRKPubKey \- get public key of the SRK 
 
27
.SH "SYNOPSIS"
 
28
.ad l
 
29
.hy 0
 
30
.nf
 
31
.sp
 
32
.B  "#include <tss/tspi.h>"
 
33
.B  ""
 
34
.BI "TSS_RESULT Tspi_TPM_OwnerGetSRKPubKey(TSS_HTPM " hTPM ","
 
35
.BI "                                      UINT32*  " pulPubKeyLength ","
 
36
.BI "                                      BYTE**   " prgbPubKey ");"
 
37
.fi
 
38
.sp
 
39
.ad
 
40
.hy
 
41
 
 
42
.SH "DESCRIPTION"
 
43
.PP
 
44
\fBTspi_TPM_OwnerGetSRKPubKey\fR
 
45
returns the public key of the key object using owner authorization.
 
46
This can only be used on 1.2 TPMs, and only to return the public key of the SRK.
 
47
 
 
48
.SH "PARAMETERS"
 
49
.PP
 
50
.SS hTPM
 
51
The \fIhTPM\fR parameter is used to specify the handle of the TPM object.
 
52
.SS pulPubKeyLength 
 
53
The \fIpulPubKeyLength\fR parameter is the length (in bytes) of the prgbPubKey parameter. 
 
54
.SS prgbPubKey 
 
55
The \fIprgbPubKey\fR parameter is the pointer to the memory block containing the public key blob retrieved for the key object referenced by hKey. 
 
56
 
 
57
.SH "RETURN CODES"
 
58
.PP
 
59
\fBTspi_TPM_OwnerGetSRKPubKey\fR returns TSS_SUCCESS on success, otherwise
 
60
one of the following values is returned:
 
61
.TP
 
62
.SM TSS_E_INVALID_HANDLE
 
63
\fIhTPM\fR is not a valid handle.
 
64
 
 
65
.TP
 
66
.SM TSS_E_BAD_PARAMETER
 
67
One or more parameters is bad.
 
68
 
 
69
.TP
 
70
.SM TSS_E_INTERNAL_ERROR
 
71
An internal SW error has been detected.
 
72
 
 
73
.TP 
 
74
.SM TSS_E_TPM_UNSUPPORTED
 
75
The TPM is not version 1.2 or later - (Note: still unimplemented)
 
76
 
 
77
.SH "CONFORMING TO"
 
78
 
 
79
.PP
 
80
\fBTspi_TPM_OwnerGetSRKPubKey\fR conforms to the Trusted Computing Group
 
81
Software Specification version 1.2
 
82
 
 
83
.SH "SEE ALSO"
 
84
 
 
85
.PP
 
86
\fBTspi_Context_FreeMemory\fR(3), \fBTspi_Key_GetPubKey\fR(3).
 
87