Debian Codegraph @

upstream/debian-unstable/man3/CMS_get0_type.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "CMS_GET0_TYPE 3SSL"
58 .TH CMS_GET0_TYPE 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 CMS_get0_type, CMS_set1_eContentType, CMS_get0_eContentType, CMS_get0_content \- get and set CMS content types and content
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/cms.h>
69 \&
70 \& const ASN1_OBJECT *CMS_get0_type(const CMS_ContentInfo *cms);
71 \& int CMS_set1_eContentType(CMS_ContentInfo *cms, const ASN1_OBJECT *oid);
72 \& const ASN1_OBJECT *CMS_get0_eContentType(CMS_ContentInfo *cms);
73 \& ASN1_OCTET_STRING **CMS_get0_content(CMS_ContentInfo *cms);
74 .Ve
75 .SH DESCRIPTION
76 .IX Header "DESCRIPTION"
77 \&\fBCMS_get0_type()\fR returns the content type of a CMS_ContentInfo structure as
78 an ASN1_OBJECT pointer. An application can then decide how to process the
79 CMS_ContentInfo structure based on this value.
80 .PP
81 \&\fBCMS_set1_eContentType()\fR sets the embedded content type of a CMS_ContentInfo
82 structure. It should be called with CMS functions (such as \fBCMS_sign\fR\|(3),
83 \&\fBCMS_encrypt\fR\|(3))
84 with the \fBCMS_PARTIAL\fR
85 flag and \fBbefore\fR the structure is finalised, otherwise the results are
86 undefined.
87 .PP
88 ASN1_OBJECT *\fBCMS_get0_eContentType()\fR returns a pointer to the embedded
89 content type.
90 .PP
91 \&\fBCMS_get0_content()\fR returns a pointer to the \fBASN1_OCTET_STRING\fR pointer
92 containing the embedded content.
93 .SH NOTES
94 .IX Header "NOTES"
95 As the \fB0\fR implies \fBCMS_get0_type()\fR, \fBCMS_get0_eContentType()\fR and
96 \&\fBCMS_get0_content()\fR return internal pointers which should \fBnot\fR be freed up.
97 \&\fBCMS_set1_eContentType()\fR copies the supplied OID and it \fBshould\fR be freed up
98 after use.
99 .PP
100 The \fBASN1_OBJECT\fR values returned can be converted to an integer \fBNID\fR value
101 using \fBOBJ_obj2nid()\fR. For the currently supported content types the following
102 values are returned:
103 .PP
104 .Vb 6
105 \& NID_pkcs7_data
106 \& NID_pkcs7_signed
107 \& NID_pkcs7_digest
108 \& NID_id_smime_ct_compressedData:
109 \& NID_pkcs7_encrypted
110 \& NID_pkcs7_enveloped
111 .Ve
112 .PP
113 The return value of \fBCMS_get0_content()\fR is a pointer to the \fBASN1_OCTET_STRING\fR
114 content pointer. That means that for example:
115 .PP
116 .Vb 1
117 \& ASN1_OCTET_STRING **pconf = CMS_get0_content(cms);
118 .Ve
119 .PP
120 \&\fB*pconf\fR could be NULL if there is no embedded content. Applications can
121 access, modify or create the embedded content in a \fBCMS_ContentInfo\fR structure
122 using this function. Applications usually will not need to modify the
123 embedded content as it is normally set by higher level functions.
124 .SH "RETURN VALUES"
125 .IX Header "RETURN VALUES"
126 \&\fBCMS_get0_type()\fR and \fBCMS_get0_eContentType()\fR return an ASN1_OBJECT structure.
127 .PP
128 \&\fBCMS_set1_eContentType()\fR returns 1 for success or 0 if an error occurred. The
129 error can be obtained from \fBERR_get_error\fR\|(3).
130 .SH "SEE ALSO"
131 .IX Header "SEE ALSO"
132 \&\fBERR_get_error\fR\|(3)
133 .SH COPYRIGHT
134 .IX Header "COPYRIGHT"
135 Copyright 2008\-2016 The OpenSSL Project Authors. All Rights Reserved.
136 .PP
137 Licensed under the Apache License 2.0 (the "License"). You may not use
138 this file except in compliance with the License. You can obtain a copy
139 in the file LICENSE in the source distribution or at
140 <https://www.openssl.org/source/license.html>.