~ubuntu-branches/ubuntu/precise/trousers/precise-proposed

« back to all changes in this revision

Viewing changes to man/man3/Tspi_Data_Bind.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:
 
1
.\" Copyright (C) 2004 International Business Machines Corporation
 
2
.\" Written by Megan Schneider 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_Data_Bind" 3 "2004-05-25" "TSS 1.1"
 
23
.ce 1
 
24
TCG Software Stack Developer's Reference
 
25
.SH NAME
 
26
Tspi_Data_Bind \- Encrypts a data blob
 
27
.SH "SYNOPSIS"
 
28
.ad l
 
29
.hy 0
 
30
.nf
 
31
.B #include <tss/platform.h>
 
32
.B #include <tss/tcpa_defines.h>
 
33
.B #include <tss/tcpa_typedef.h>
 
34
.B #include <tss/tcpa_struct.h>
 
35
.B #include <tss/tss_typedef.h>
 
36
.B #include <tss/tss_structs.h>
 
37
.B #include <tss/tspi.h>
 
38
.sp
 
39
.BI "TSS_RESULT Tspi_Data_Bind(TSS_HENCDATA " hEncData ",     TSS_HKEY " hEncKey ","
 
40
.BI "                          UINT32       " ulDataLength ", BYTE*    " rgbDataToBind ");"
 
41
.fi
 
42
.sp
 
43
.ad
 
44
.hy
 
45
 
 
46
.SH "DESCRIPTION"
 
47
.PP
 
48
\fBTspi_Data_Bind\fR encrypts a data blob in a manner
 
49
that is decryptable by \fBTspi_Data_Unbind\fR. The data blob is
 
50
encrypted using a public key operation with the key addressed by the
 
51
given encryption key object. To bind data that is larger than the RSA
 
52
public key modulus is the responsibility of the caller to perform the
 
53
blocking and subsequent combination of data. The bound data blob is
 
54
stored in the data object addressed by \fIhEncData\fR and can be
 
55
exported from the object by \fBTspi_GetAttribData\fR. The caller of
 
56
this function should perform validations that the public key presented
 
57
to it is from a valid TPM.
 
58
 
 
59
.SH "PARAMETERS"
 
60
.PP
 
61
.SS hEncData
 
62
The handle of the data object which contains the encrypted data on
 
63
successful completion of the command.
 
64
.SS hEncKey
 
65
Handle to the key object addressing the public key which is used
 
66
to encrypt the data.
 
67
.SS ulDataLength
 
68
Indicates the length of the data provided at the parameter \fIrgbDataToBind\fR.
 
69
.SS rgbDataToBind
 
70
A pointer to the data to be encrypted.
 
71
 
 
72
.SH "RETURN CODES"
 
73
.PP
 
74
\fBTspi_Data_Bind\fR returns TSS_SUCCESS on success, otherwise one of
 
75
the following values is returned:
 
76
.TP
 
77
.SM TSS_E_INVALID_HANDLE
 
78
\fIhHash\fR is not a valid handle.
 
79
 
 
80
.TP
 
81
.SM TSS_E_INTERNAL_ERROR
 
82
An internal SW error has been detected.
 
83
 
 
84
.TP
 
85
.SM TSS_E_BAD_PARAMETER
 
86
One or more parameters is bad.
 
87
 
 
88
.TP
 
89
.SM TSS_E_INVALID_ENCSCHEME
 
90
Invalid encryption scheme.
 
91
 
 
92
.TP
 
93
.SM TSS_E_ENC_INVALID_LENGTH
 
94
Invalid length of data to be encypted.
 
95
 
 
96
.TP
 
97
.SM TSS_E_ENC_NO_DATA
 
98
No data to encrypt.
 
99
 
 
100
.TP
 
101
.SM TSS_E_ENC_INVALID_TYPE
 
102
Invalid encryption type.
 
103
 
 
104
 
 
105
.SH "CONFORMING TO"
 
106
 
 
107
.PP
 
108
\fBTspi_Data_Bind\fR conforms to the Trusted Computing Group Software
 
109
Specification version 1.1 Golden
 
110
 
 
111
.SH "SEE ALSO"
 
112
 
 
113
.PP
 
114
\fBTspi_Data_Unbind\fR(3), \fBTspi_Data_Unseal\fR(3),
 
115
\fBTspi_Data_Seal\fR(3).
 
116