Commit | Line | Data |
---|---|---|
1acffe94 | 1 | .\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28) |
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" '' | |
5a44c043 SW |
41 | . ds C` |
42 | . ds C' | |
01185282 PA |
43 | 'br\} |
44 | .\" | |
45 | .\" Escape single quotes in literal strings from groff's Unicode transform. | |
46 | .ie \n(.g .ds Aq \(aq | |
47 | .el .ds Aq ' | |
48 | .\" | |
49 | .\" If the F register is turned on, we'll generate index entries on stderr for | |
50 | .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index | |
51 | .\" entries marked with X<> in POD. Of course, you'll have to process the | |
52 | .\" output yourself in some meaningful fashion. | |
5a44c043 SW |
53 | .\" |
54 | .\" Avoid warning from groff about undefined register 'F'. | |
55 | .de IX | |
01185282 | 56 | .. |
5a44c043 SW |
57 | .nr rF 0 |
58 | .if \n(.g .if rF .nr rF 1 | |
59 | .if (\n(rF:(\n(.g==0)) \{ | |
60 | . if \nF \{ | |
61 | . de IX | |
62 | . tm Index:\\$1\t\\n%\t"\\$2" | |
01185282 | 63 | .. |
5a44c043 SW |
64 | . if !\nF==2 \{ |
65 | . nr % 0 | |
66 | . nr F 2 | |
67 | . \} | |
68 | . \} | |
01185282 | 69 | .\} |
5a44c043 | 70 | .rr rF |
01185282 PA |
71 | .\" |
72 | .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). | |
73 | .\" Fear. Run. Save yourself. No user-serviceable parts. | |
74 | . \" fudge factors for nroff and troff | |
75 | .if n \{\ | |
76 | . ds #H 0 | |
77 | . ds #V .8m | |
78 | . ds #F .3m | |
79 | . ds #[ \f1 | |
80 | . ds #] \fP | |
81 | .\} | |
82 | .if t \{\ | |
83 | . ds #H ((1u-(\\\\n(.fu%2u))*.13m) | |
84 | . ds #V .6m | |
85 | . ds #F 0 | |
86 | . ds #[ \& | |
87 | . ds #] \& | |
88 | .\} | |
89 | . \" simple accents for nroff and troff | |
90 | .if n \{\ | |
91 | . ds ' \& | |
92 | . ds ` \& | |
93 | . ds ^ \& | |
94 | . ds , \& | |
95 | . ds ~ ~ | |
96 | . ds / | |
97 | .\} | |
98 | .if t \{\ | |
99 | . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" | |
100 | . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' | |
101 | . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' | |
102 | . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' | |
103 | . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' | |
104 | . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' | |
105 | .\} | |
106 | . \" troff and (daisy-wheel) nroff accents | |
107 | .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' | |
108 | .ds 8 \h'\*(#H'\(*b\h'-\*(#H' | |
109 | .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] | |
110 | .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' | |
111 | .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' | |
112 | .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] | |
113 | .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] | |
114 | .ds ae a\h'-(\w'a'u*4/10)'e | |
115 | .ds Ae A\h'-(\w'A'u*4/10)'E | |
116 | . \" corrections for vroff | |
117 | .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' | |
118 | .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' | |
119 | . \" for low resolution devices (crt and lpr) | |
120 | .if \n(.H>23 .if \n(.V>19 \ | |
121 | \{\ | |
122 | . ds : e | |
123 | . ds 8 ss | |
124 | . ds o a | |
125 | . ds d- d\h'-1'\(ga | |
126 | . ds D- D\h'-1'\(hy | |
127 | . ds th \o'bp' | |
128 | . ds Th \o'LP' | |
129 | . ds ae ae | |
130 | . ds Ae AE | |
131 | .\} | |
132 | .rm #[ #] #H #V #F C | |
133 | .\" ======================================================================== | |
134 | .\" | |
135 | .IX Title "CMS_get0_type 3" | |
1acffe94 | 136 | .TH CMS_get0_type 3 "2015-12-03" "1.0.1q" "OpenSSL" |
01185282 PA |
137 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes |
138 | .\" way too many mistakes in technical documents. | |
139 | .if n .ad l | |
140 | .nh | |
141 | .SH "NAME" | |
142 | .Vb 1 | |
5a44c043 | 143 | \& CMS_get0_type, CMS_set1_eContentType, CMS_get0_eContentType, CMS_get0_content \- get and set CMS content types and content |
01185282 PA |
144 | .Ve |
145 | .SH "SYNOPSIS" | |
146 | .IX Header "SYNOPSIS" | |
147 | .Vb 1 | |
148 | \& #include <openssl/cms.h> | |
149 | \& | |
150 | \& const ASN1_OBJECT *CMS_get0_type(CMS_ContentInfo *cms); | |
151 | \& int CMS_set1_eContentType(CMS_ContentInfo *cms, const ASN1_OBJECT *oid); | |
152 | \& const ASN1_OBJECT *CMS_get0_eContentType(CMS_ContentInfo *cms); | |
5a44c043 | 153 | \& ASN1_OCTET_STRING **CMS_get0_content(CMS_ContentInfo *cms); |
01185282 PA |
154 | .Ve |
155 | .SH "DESCRIPTION" | |
156 | .IX Header "DESCRIPTION" | |
157 | \&\fICMS_get0_type()\fR returns the content type of a CMS_ContentInfo structure as | |
158 | and \s-1ASN1_OBJECT\s0 pointer. An application can then decide how to process the | |
159 | CMS_ContentInfo structure based on this value. | |
160 | .PP | |
161 | \&\fICMS_set1_eContentType()\fR sets the embedded content type of a CMS_ContentInfo | |
162 | structure. It should be called with \s-1CMS\s0 functions with the \fB\s-1CMS_PARTIAL\s0\fR | |
163 | flag and \fBbefore\fR the structure is finalised, otherwise the results are | |
164 | undefined. | |
165 | .PP | |
166 | \&\s-1ASN1_OBJECT\s0 *\fICMS_get0_eContentType()\fR returns a pointer to the embedded | |
167 | content type. | |
5a44c043 SW |
168 | .PP |
169 | \&\fICMS_get0_content()\fR returns a pointer to the \fB\s-1ASN1_OCTET_STRING\s0\fR pointer | |
170 | containing the embedded content. | |
01185282 PA |
171 | .SH "NOTES" |
172 | .IX Header "NOTES" | |
5a44c043 SW |
173 | As the \fB0\fR implies \fICMS_get0_type()\fR, \fICMS_get0_eContentType()\fR and |
174 | \&\fICMS_get0_content()\fR return internal pointers which should \fBnot\fR be freed up. | |
175 | \&\fICMS_set1_eContentType()\fR copies the supplied \s-1OID\s0 and it \fBshould\fR be freed up | |
176 | after use. | |
01185282 PA |
177 | .PP |
178 | The \fB\s-1ASN1_OBJECT\s0\fR values returned can be converted to an integer \fB\s-1NID\s0\fR value | |
179 | using \fIOBJ_obj2nid()\fR. For the currently supported content types the following | |
180 | values are returned: | |
181 | .PP | |
182 | .Vb 6 | |
183 | \& NID_pkcs7_data | |
184 | \& NID_pkcs7_signed | |
185 | \& NID_pkcs7_digest | |
186 | \& NID_id_smime_ct_compressedData: | |
187 | \& NID_pkcs7_encrypted | |
188 | \& NID_pkcs7_enveloped | |
189 | .Ve | |
5a44c043 SW |
190 | .PP |
191 | The return value of \fICMS_get0_content()\fR is a pointer to the \fB\s-1ASN1_OCTET_STRING\s0\fR | |
192 | content pointer. That means that for example: | |
193 | .PP | |
194 | .Vb 1 | |
195 | \& ASN1_OCTET_STRING **pconf = CMS_get0_content(cms); | |
196 | .Ve | |
197 | .PP | |
198 | \&\fB*pconf\fR could be \s-1NULL\s0 if there is no embedded content. Applications can | |
199 | access, modify or create the embedded content in a \fBCMS_ContentInfo\fR structure | |
200 | using this function. Applications usually will not need to modify the | |
201 | embedded content as it is normally set by higher level functions. | |
01185282 PA |
202 | .SH "RETURN VALUES" |
203 | .IX Header "RETURN VALUES" | |
204 | \&\fICMS_get0_type()\fR and \fICMS_get0_eContentType()\fR return and \s-1ASN1_OBJECT\s0 structure. | |
205 | .PP | |
206 | \&\fICMS_set1_eContentType()\fR returns 1 for success or 0 if an error occurred. The | |
207 | error can be obtained from \fIERR_get_error\fR\|(3). | |
208 | .SH "SEE ALSO" | |
209 | .IX Header "SEE ALSO" | |
210 | \&\fIERR_get_error\fR\|(3) | |
211 | .SH "HISTORY" | |
212 | .IX Header "HISTORY" | |
213 | \&\fICMS_get0_type()\fR, \fICMS_set1_eContentType()\fR and \fICMS_get0_eContentType()\fR were all | |
214 | first added to OpenSSL 0.9.8 |