Commit | Line | Data |
---|---|---|
e3261593 | 1 | .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.19) |
01185282 PA |
2 | .\" |
3 | .\" Standard preamble: | |
4 | .\" ======================================================================== | |
5 | .de Sp \" Vertical space (when we can't use .PP) | |
6 | .if t .sp .5v | |
7 | .if n .sp | |
8 | .. | |
9 | .de Vb \" Begin verbatim text | |
10 | .ft CW | |
11 | .nf | |
12 | .ne \\$1 | |
13 | .. | |
14 | .de Ve \" End verbatim text | |
15 | .ft R | |
16 | .fi | |
17 | .. | |
18 | .\" Set up some character translations and predefined strings. \*(-- will | |
19 | .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left | |
20 | .\" double quote, and \*(R" will give a right double quote. \*(C+ will | |
21 | .\" give a nicer C++. Capital omega is used to do unbreakable dashes and | |
22 | .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, | |
23 | .\" nothing in troff, for use with C<>. | |
24 | .tr \(*W- | |
25 | .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' | |
26 | .ie n \{\ | |
27 | . ds -- \(*W- | |
28 | . ds PI pi | |
29 | . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch | |
30 | . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch | |
31 | . ds L" "" | |
32 | . ds R" "" | |
33 | . ds C` "" | |
34 | . ds C' "" | |
35 | 'br\} | |
36 | .el\{\ | |
37 | . ds -- \|\(em\| | |
38 | . ds PI \(*p | |
39 | . ds L" `` | |
40 | . ds R" '' | |
41 | 'br\} | |
42 | .\" | |
43 | .\" Escape single quotes in literal strings from groff's Unicode transform. | |
44 | .ie \n(.g .ds Aq \(aq | |
45 | .el .ds Aq ' | |
46 | .\" | |
47 | .\" If the F register is turned on, we'll generate index entries on stderr for | |
48 | .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index | |
49 | .\" entries marked with X<> in POD. Of course, you'll have to process the | |
50 | .\" output yourself in some meaningful fashion. | |
51 | .ie \nF \{\ | |
52 | . de IX | |
53 | . tm Index:\\$1\t\\n%\t"\\$2" | |
54 | .. | |
55 | . nr % 0 | |
56 | . rr F | |
57 | .\} | |
58 | .el \{\ | |
59 | . de IX | |
60 | .. | |
61 | .\} | |
62 | .\" | |
63 | .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). | |
64 | .\" Fear. Run. Save yourself. No user-serviceable parts. | |
65 | . \" fudge factors for nroff and troff | |
66 | .if n \{\ | |
67 | . ds #H 0 | |
68 | . ds #V .8m | |
69 | . ds #F .3m | |
70 | . ds #[ \f1 | |
71 | . ds #] \fP | |
72 | .\} | |
73 | .if t \{\ | |
74 | . ds #H ((1u-(\\\\n(.fu%2u))*.13m) | |
75 | . ds #V .6m | |
76 | . ds #F 0 | |
77 | . ds #[ \& | |
78 | . ds #] \& | |
79 | .\} | |
80 | . \" simple accents for nroff and troff | |
81 | .if n \{\ | |
82 | . ds ' \& | |
83 | . ds ` \& | |
84 | . ds ^ \& | |
85 | . ds , \& | |
86 | . ds ~ ~ | |
87 | . ds / | |
88 | .\} | |
89 | .if t \{\ | |
90 | . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" | |
91 | . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' | |
92 | . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' | |
93 | . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' | |
94 | . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' | |
95 | . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' | |
96 | .\} | |
97 | . \" troff and (daisy-wheel) nroff accents | |
98 | .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' | |
99 | .ds 8 \h'\*(#H'\(*b\h'-\*(#H' | |
100 | .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] | |
101 | .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' | |
102 | .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' | |
103 | .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] | |
104 | .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] | |
105 | .ds ae a\h'-(\w'a'u*4/10)'e | |
106 | .ds Ae A\h'-(\w'A'u*4/10)'E | |
107 | . \" corrections for vroff | |
108 | .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' | |
109 | .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' | |
110 | . \" for low resolution devices (crt and lpr) | |
111 | .if \n(.H>23 .if \n(.V>19 \ | |
112 | \{\ | |
113 | . ds : e | |
114 | . ds 8 ss | |
115 | . ds o a | |
116 | . ds d- d\h'-1'\(ga | |
117 | . ds D- D\h'-1'\(hy | |
118 | . ds th \o'bp' | |
119 | . ds Th \o'LP' | |
120 | . ds ae ae | |
121 | . ds Ae AE | |
122 | .\} | |
123 | .rm #[ #] #H #V #F C | |
124 | .\" ======================================================================== | |
125 | .\" | |
126 | .IX Title "CMS_get0_SignerInfos 3" | |
e3261593 | 127 | .TH CMS_get0_SignerInfos 3 "2012-01-04" "1.0.0f" "OpenSSL" |
01185282 PA |
128 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes |
129 | .\" way too many mistakes in technical documents. | |
130 | .if n .ad l | |
131 | .nh | |
132 | .SH "NAME" | |
133 | .Vb 1 | |
134 | \& CMS_get0_SignerInfos, CMS_SignerInfo_get0_signer_id, CMS_SignerInfo_cert_cmp, CMS_set1_signer_certs \- CMS signedData signer functions. | |
135 | .Ve | |
136 | .SH "SYNOPSIS" | |
137 | .IX Header "SYNOPSIS" | |
138 | .Vb 1 | |
139 | \& #include <openssl/cms.h> | |
140 | \& | |
141 | \& STACK_OF(CMS_SignerInfo) *CMS_get0_SignerInfos(CMS_ContentInfo *cms); | |
142 | \& | |
143 | \& int CMS_SignerInfo_get0_signer_id(CMS_SignerInfo *si, ASN1_OCTET_STRING **keyid, X509_NAME **issuer, ASN1_INTEGER **sno); | |
144 | \& int CMS_SignerInfo_cert_cmp(CMS_SignerInfo *si, X509 *cert); | |
145 | \& void CMS_SignerInfo_set1_signer_cert(CMS_SignerInfo *si, X509 *signer); | |
146 | .Ve | |
147 | .SH "DESCRIPTION" | |
148 | .IX Header "DESCRIPTION" | |
149 | The function \fICMS_get0_SignerInfos()\fR returns all the CMS_SignerInfo structures | |
150 | associated with a \s-1CMS\s0 signedData structure. | |
151 | .PP | |
152 | \&\fICMS_SignerInfo_get0_signer_id()\fR retrieves the certificate signer identifier | |
153 | associated with a specific CMS_SignerInfo structure \fBsi\fR. Either the | |
154 | keyidentifier will be set in \fBkeyid\fR or \fBboth\fR issuer name and serial number | |
155 | in \fBissuer\fR and \fBsno\fR. | |
156 | .PP | |
157 | \&\fICMS_SignerInfo_cert_cmp()\fR compares the certificate \fBcert\fR against the signer | |
158 | identifier \fBsi\fR. It returns zero if the comparison is successful and non zero | |
159 | if not. | |
160 | .PP | |
161 | \&\fICMS_SignerInfo_set1_signer_cert()\fR sets the signers certificate of \fBsi\fR to | |
162 | \&\fBsigner\fR. | |
163 | .SH "NOTES" | |
164 | .IX Header "NOTES" | |
165 | The main purpose of these functions is to enable an application to lookup | |
166 | signers certificates using any appropriate technique when the simpler method | |
167 | of \fICMS_verify()\fR is not appropriate. | |
168 | .PP | |
169 | In typical usage and application will retrieve all CMS_SignerInfo structures | |
170 | using \fICMS_get0_SignerInfo()\fR and retrieve the identifier information using | |
171 | \&\s-1CMS\s0. It will then obtain the signer certificate by some unspecified means | |
172 | (or return and error if it cannot be found) and set it using | |
173 | \&\fICMS_SignerInfo_set1_signer_cert()\fR. | |
174 | .PP | |
175 | Once all signer certificates have been set \fICMS_verify()\fR can be used. | |
176 | .PP | |
177 | Although \fICMS_get0_SignerInfos()\fR can return \s-1NULL\s0 is an error occur \fBor\fR if | |
178 | there are no signers this is not a problem in practice because the only | |
179 | error which can occur is if the \fBcms\fR structure is not of type signedData | |
180 | due to application error. | |
181 | .SH "RETURN VALUES" | |
182 | .IX Header "RETURN VALUES" | |
183 | \&\fICMS_get0_SignerInfos()\fR returns all CMS_SignerInfo structures, or \s-1NULL\s0 there | |
184 | are no signers or an error occurs. | |
185 | .PP | |
186 | \&\fICMS_SignerInfo_get0_signer_id()\fR returns 1 for success and 0 for failure. | |
187 | .PP | |
188 | \&\fICMS_SignerInfo_cert_cmp()\fR returns 0 for a successful comparison and non | |
189 | zero otherwise. | |
190 | .PP | |
191 | \&\fICMS_SignerInfo_set1_signer_cert()\fR does not return a value. | |
192 | .PP | |
193 | Any error can be obtained from \fIERR_get_error\fR\|(3) | |
194 | .SH "SEE ALSO" | |
195 | .IX Header "SEE ALSO" | |
196 | \&\fIERR_get_error\fR\|(3), \fICMS_verify\fR\|(3) | |
197 | .SH "HISTORY" | |
198 | .IX Header "HISTORY" | |
199 | These functions were first was added to OpenSSL 0.9.8 |