← Back to branch summary

~ubuntu-branches/ubuntu/gutsy/trousers/gutsy

« back to all changes in this revision

Viewing changes to man/man3/Tspi_Key_CertifyKey.3

  • Committer: Bazaar Package Importer
  • Author(s): William Lima
  • Date: 2007-04-18 16:39:38 UTC
  • Revision ID: james.westby@ubuntu.com-20070418163938-opscl2mvvi76jiec
Tags: upstream-0.2.9.1
Import upstream version 0.2.9.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/man3/Tspi_Key_CertifyKey.3
 
1
.\" Copyright (C) 2004 International Business Machines Corporation
 
2
.\" Written by Kathy Robertson based on the Trusted Computing Group Software Stack Specification Version 1.1 Golden
 
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_Key_CertifyKey" 3 "2004-05-26" "TSS 1.1" "TCG Software Stack Developer's Reference"
 
23
.SH NAME
 
24
Tspi_Key_CertifyKey \- sign a public key.
 
25
.SH "SYNOPSIS"
 
26
.ad l
 
27
.hy 0
 
28
.nf
 
29
.B #include <tss/platform.h>
 
30
.B #include <tss/tcpa_defines.h>
 
31
.B #include <tss/tcpa_typedef.h>
 
32
.B #include <tss/tcpa_struct.h>
 
33
.B #include <tss/tss_typedef.h>
 
34
.B #include <tss/tss_structs.h>
 
35
.B #include <tss/tspi.h>
 
36
.sp
 
37
.BI "TSS_RESULT Tspi_Key_CertifyKey(TSS_HKEY        " hKey ", TSS_HKEY " hCertifyingKey ","
 
38
.BI "                               TSS_VALIDATION* " pValidationData ");"
 
39
.fi
 
40
.sp
 
41
.ad
 
42
.hy
 
43
.SH "DESCRIPTION"
 
44
.PP
 
45
\fBTspi_Key_CertifyKey\fR signs a public key.
 
46
.SH "PARAMETERS"
 
47
.PP
 
48
.SS hKey 
 
49
Handle of the key object to be loaded.
 
50
.PP
 
51
.SS hCertifyingKey
 
52
Handle to the certifying key used to sign the addressed by hKey.
 
53
.PP
 
54
.SS pValidationData
 
55
Pointer to a structure of the type TSS_VALIDATION. After successful completion of the call the member rgbValidationData of this structure contains the signature data of the command. The member prgbData of the structure points to a buffer containing a TCPA_CERTIFY_INFO data stream as specified within the TCPA 1.1b Main Specification. 
 
56
.SH "RETURN CODES"
 
57
.PP
 
58
\fBTspi_Key_CertifyKey\fR returns TSS_SUCCESS on success, otherwise one of the following values are returned:
 
59
.TP
 
60
.SM TSS_E_INVALID_HANDLE - Either \fIhKey\fR or \fIhCertifyingKey\fR are invalid handles.
 
61
.TP
 
62
.SM TSS_E_BAD_PARAMETER
 
63
.TP
 
64
.SM TSS_E_INTERNAL_ERROR - An error occurred internal to the TSS.
 
65
 
 
66
.SH "CONFORMING TO"
 
67
 
 
68
.PP
 
69
\fBTspi_Key_CertifyKey\fR conforms to the Trusted Computing Group Software Specification version 1.1 Golden
 
70
.SH "SEE ALSO"
 
71
 
 
72
.PP
 
73
\fBTspi_Key_CreateKey\fR(3), \fBTspi_Key_WrapKey\fR(3).
 
74
 
 
75
 
 
76