summaryrefslogtreecommitdiff
path: root/static/netbsd/man3/CMS_EncryptedData_decrypt.3
diff options
context:
space:
mode:
authorJacob McDonnell <jacob@jacobmcdonnell.com>2026-04-25 19:55:15 -0400
committerJacob McDonnell <jacob@jacobmcdonnell.com>2026-04-25 19:55:15 -0400
commit253e67c8b3a72b3a4757fdbc5845297628db0a4a (patch)
treeadf53b66087aa30dfbf8bf391a1dadb044c3bf4d /static/netbsd/man3/CMS_EncryptedData_decrypt.3
parenta9157ce950dfe2fc30795d43b9d79b9d1bffc48b (diff)
docs: Added All NetBSD Manuals
Diffstat (limited to 'static/netbsd/man3/CMS_EncryptedData_decrypt.3')
-rw-r--r--static/netbsd/man3/CMS_EncryptedData_decrypt.3126
1 files changed, 126 insertions, 0 deletions
diff --git a/static/netbsd/man3/CMS_EncryptedData_decrypt.3 b/static/netbsd/man3/CMS_EncryptedData_decrypt.3
new file mode 100644
index 00000000..bc7b788c
--- /dev/null
+++ b/static/netbsd/man3/CMS_EncryptedData_decrypt.3
@@ -0,0 +1,126 @@
+.\" $NetBSD: CMS_EncryptedData_decrypt.3,v 1.5 2026/04/08 17:06:41 christos Exp $
+.\"
+.\" -*- mode: troff; coding: utf-8 -*-
+.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
+.\"
+.\" Standard preamble:
+.\" ========================================================================
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Vb \" Begin verbatim text
+.ft CW
+.nf
+.ne \\$1
+..
+.de Ve \" End verbatim text
+.ft R
+.fi
+..
+.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
+.ie n \{\
+. ds C` ""
+. ds C' ""
+'br\}
+.el\{\
+. ds C`
+. ds C'
+'br\}
+.\"
+.\" Escape single quotes in literal strings from groff's Unicode transform.
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\"
+.\" If the F register is >0, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
+.\" entries marked with X<> in POD. Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
+.\"
+.\" Avoid warning from groff about undefined register 'F'.
+.de IX
+..
+.nr rF 0
+.if \n(.g .if rF .nr rF 1
+.if (\n(rF:(\n(.g==0)) \{\
+. if \nF \{\
+. de IX
+. tm Index:\\$1\t\\n%\t"\\$2"
+..
+. if !\nF==2 \{\
+. nr % 0
+. nr F 2
+. \}
+. \}
+.\}
+.rr rF
+.\"
+.\" Required to disable full justification in groff 1.23.0.
+.if n .ds AD l
+.\" ========================================================================
+.\"
+.IX Title "CMS_EncryptedData_decrypt 3"
+.TH CMS_EncryptedData_decrypt 3 2026-04-07 3.5.6 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
+CMS_EncryptedData_decrypt, CMS_EnvelopedData_decrypt
+\&\- Decrypt CMS EncryptedData or EnvelopedData
+.SH SYNOPSIS
+.IX Header "SYNOPSIS"
+.Vb 1
+\& #include <openssl/cms.h>
+\&
+\& int CMS_EncryptedData_decrypt(CMS_ContentInfo *cms,
+\& const unsigned char *key, size_t keylen,
+\& BIO *dcont, BIO *out, unsigned int flags);
+\&
+\& BIO *CMS_EnvelopedData_decrypt(CMS_EnvelopedData *env, BIO *detached_data,
+\& EVP_PKEY *pkey, X509 *cert,
+\& ASN1_OCTET_STRING *secret, unsigned int flags,
+\& OSSL_LIB_CTX *libctx, const char *propq);
+.Ve
+.SH DESCRIPTION
+.IX Header "DESCRIPTION"
+\&\fBCMS_EncryptedData_decrypt()\fR decrypts a \fIcms\fR EncryptedData object using the
+symmetric \fIkey\fR of size \fIkeylen\fR bytes. AEAD cipher algorithms are not
+supported. \fIout\fR is a BIO to write the content to and \fIflags\fR is an optional
+set of flags. \fIdcont\fR is used in the rare case where the encrypted content is
+detached. It will normally be set to NULL.
+.PP
+The following flags can be passed in the \fIflags\fR parameter.
+.PP
+If the \fBCMS_TEXT\fR flag is set MIME headers for type \f(CW\*(C`text/plain\*(C'\fR are deleted
+from the content. If the content is not of type \f(CW\*(C`text/plain\*(C'\fR then an error is
+returned.
+.PP
+\&\fBCMS_EnvelopedData_decrypt()\fR decrypts, similarly to \fBCMS_decrypt\fR\|(3),
+a CMS EnvelopedData object \fIenv\fR using the symmetric key \fIsecret\fR if it
+is not NULL, otherwise the private key of the recipient \fIpkey\fR.
+If \fIpkey\fR is given, it is recommended to provide also the associated
+certificate in \fIcert\fR \- see \fBCMS_decrypt\fR\|(3) and the NOTES on \fIcert\fR there.
+The optional parameters \fIflags\fR and \fIdcont\fR are used as described above.
+The optional parameters library context \fIlibctx\fR and property query \fIpropq\fR
+are used when retrieving algorithms from providers.
+.SH "RETURN VALUES"
+.IX Header "RETURN VALUES"
+\&\fBCMS_EncryptedData_decrypt()\fR returns 0 if an error occurred otherwise returns 1.
+.PP
+\&\fBCMS_EnvelopedData_decrypt()\fR returns NULL if an error occurred,
+otherwise a BIO containing the decypted content.
+.SH "SEE ALSO"
+.IX Header "SEE ALSO"
+\&\fBERR_get_error\fR\|(3), \fBCMS_EncryptedData_encrypt\fR\|(3), \fBCMS_decrypt\fR\|(3)
+.SH HISTORY
+.IX Header "HISTORY"
+\&\fBCMS_EnvelopedData_decrypt()\fR was added in OpenSSL 3.2.
+.SH COPYRIGHT
+.IX Header "COPYRIGHT"
+Copyright 2020 The OpenSSL Project Authors. All Rights Reserved.
+.PP
+Licensed under the Apache License 2.0 (the "License"). You may not use
+this file except in compliance with the License. You can obtain a copy
+in the file LICENSE in the source distribution or at
+<https://www.openssl.org/source/license.html>.