summaryrefslogtreecommitdiffstats
path: root/secure/lib/libcrypto/man/CMS_get0_type.3
diff options
context:
space:
mode:
Diffstat (limited to 'secure/lib/libcrypto/man/CMS_get0_type.3')
-rw-r--r--secure/lib/libcrypto/man/CMS_get0_type.329
1 files changed, 23 insertions, 6 deletions
diff --git a/secure/lib/libcrypto/man/CMS_get0_type.3 b/secure/lib/libcrypto/man/CMS_get0_type.3
index f9c2704..8192327 100644
--- a/secure/lib/libcrypto/man/CMS_get0_type.3
+++ b/secure/lib/libcrypto/man/CMS_get0_type.3
@@ -1,4 +1,4 @@
-.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
+.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.30)
.\"
.\" Standard preamble:
.\" ========================================================================
@@ -133,14 +133,14 @@
.\" ========================================================================
.\"
.IX Title "CMS_get0_type 3"
-.TH CMS_get0_type 3 "2015-01-15" "1.0.1l" "OpenSSL"
+.TH CMS_get0_type 3 "2015-03-19" "1.0.1m" "OpenSSL"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
.Vb 1
-\& CMS_get0_type, CMS_set1_eContentType, CMS_get0_eContentType \- get and set CMS content types
+\& CMS_get0_type, CMS_set1_eContentType, CMS_get0_eContentType, CMS_get0_content \- get and set CMS content types and content
.Ve
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
@@ -150,6 +150,7 @@
\& const ASN1_OBJECT *CMS_get0_type(CMS_ContentInfo *cms);
\& int CMS_set1_eContentType(CMS_ContentInfo *cms, const ASN1_OBJECT *oid);
\& const ASN1_OBJECT *CMS_get0_eContentType(CMS_ContentInfo *cms);
+\& ASN1_OCTET_STRING **CMS_get0_content(CMS_ContentInfo *cms);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
@@ -164,11 +165,15 @@ undefined.
.PP
\&\s-1ASN1_OBJECT\s0 *\fICMS_get0_eContentType()\fR returns a pointer to the embedded
content type.
+.PP
+\&\fICMS_get0_content()\fR returns a pointer to the \fB\s-1ASN1_OCTET_STRING\s0\fR pointer
+containing the embedded content.
.SH "NOTES"
.IX Header "NOTES"
-As the \fB0\fR implies \fICMS_get0_type()\fR and \fICMS_get0_eContentType()\fR return internal
-pointers which should \fBnot\fR be freed up. \fICMS_set1_eContentType()\fR copies the
-supplied \s-1OID\s0 and it \fBshould\fR be freed up after use.
+As the \fB0\fR implies \fICMS_get0_type()\fR, \fICMS_get0_eContentType()\fR and
+\&\fICMS_get0_content()\fR return internal pointers which should \fBnot\fR be freed up.
+\&\fICMS_set1_eContentType()\fR copies the supplied \s-1OID\s0 and it \fBshould\fR be freed up
+after use.
.PP
The \fB\s-1ASN1_OBJECT\s0\fR values returned can be converted to an integer \fB\s-1NID\s0\fR value
using \fIOBJ_obj2nid()\fR. For the currently supported content types the following
@@ -182,6 +187,18 @@ values are returned:
\& NID_pkcs7_encrypted
\& NID_pkcs7_enveloped
.Ve
+.PP
+The return value of \fICMS_get0_content()\fR is a pointer to the \fB\s-1ASN1_OCTET_STRING\s0\fR
+content pointer. That means that for example:
+.PP
+.Vb 1
+\& ASN1_OCTET_STRING **pconf = CMS_get0_content(cms);
+.Ve
+.PP
+\&\fB*pconf\fR could be \s-1NULL\s0 if there is no embedded content. Applications can
+access, modify or create the embedded content in a \fBCMS_ContentInfo\fR structure
+using this function. Applications usually will not need to modify the
+embedded content as it is normally set by higher level functions.
.SH "RETURN VALUES"
.IX Header "RETURN VALUES"
\&\fICMS_get0_type()\fR and \fICMS_get0_eContentType()\fR return and \s-1ASN1_OBJECT\s0 structure.
OpenPOWER on IntegriCloud