[4c6a90]: man / man3 / Tspi_Context_GetKeyByPublicInfo.3  Maximize  Restore  History

Download this file

72 lines (68 with data), 2.4 kB

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
.\" Copyright (C) 2004 International Business Machines Corporation
.\" Written by Kathy Robertson 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_Context_GetKeyByPublicInfo" 3 "2004-05-26" "TSS 1.1" "TCG Software Stack Developer's Reference"
.SH NAME
Tspi_Context_GetKeyByPublicInfo \- search the persistent storage for a registered key using the provided public key information
.SH "SYNOPSIS"
.ad l
.hy 0
.B #include <tss/tss.h>
.sp
.BI "TSS_RESULT Tspi_Context_GetKeyByPublicInfo(TSS_HCONTEXT " hContext ", TSS_FLAG " persistentStorageType ", TSS_ALGORITHM_ID " algID ", UINT32 " ulPublicInfoLength ", BYTE* " rgbPublicInfo ", TSS_HKEY* " phKey ")
.sp
.ad
.hy
.SH "DESCRIPTION"
.PP
\fBTSS_Context_GetKeyByPublicInfo\fR searches the persistent storage for a registered key using the provided public key information and creates a key object initalized according to the found data. On successful completion of the method a handle to the created new key object is returned.
.SH "PARAMETERS"
.PP
.SS hContext
The handle of the context object.
.PP
.SS persistentStorageType
Flag indicating the persistent storage the key is registered in.
.PP
.SS algId
This parameter indicates the algorithm of the requested key.
.PP
.SS ulPublicInfoLength
The length of the public key info provided at the parameter rgbPublicInfo.
.PP
.SS rgbPublicInfo
The public key info is provided to identify the key to be look for at the persistent storage. In case algID equals to TSS_ALG_RSA this prameter contains the modulus of the public RSA key.
.PP
.SS hKey
Recieves the handle of the key object representing the key. In case the key hasn't been found, this value will be NULL.
.SH "RETURN CODES"
.PP
\fBTspi_Context_GetKeyByPublicInfo\fR returns TSS_SUCCESS on success, otherwise one of the following values are returned:
.TP
.SM TSS_E_INVALID_HANDLE - \fIhContext\fR is an invalid handle.
.TP
.SM TSS_E_INTERNAL_ERROR - The command failed the test.
.SH "CONFORMING TO"
.PP
\fBTspi_Context_GetKeyByPublicInfo\fR conforms to the Trusted Computing Group Software Specification version 1.1 Golden
.SH "SEE ALSO"
.PP
\fBTspi_Context_LoadKeyByUUID\fR(3).