Debian Codegraph @

upstream/debian-unstable/man3/CMS_EncryptedData_decrypt.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_ENCRYPTEDDATA_DECRYPT 3SSL"
58 .TH CMS_ENCRYPTEDDATA_DECRYPT 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_EncryptedData_decrypt, CMS_EnvelopedData_decrypt
65 \&\- Decrypt CMS EncryptedData or EnvelopedData
66 .SH SYNOPSIS
67 .IX Header "SYNOPSIS"
68 .Vb 1
69 \& #include <openssl/cms.h>
70 \&
71 \& int CMS_EncryptedData_decrypt(CMS_ContentInfo *cms,
72 \& const unsigned char *key, size_t keylen,
73 \& BIO *dcont, BIO *out, unsigned int flags);
74 \&
75 \& BIO *CMS_EnvelopedData_decrypt(CMS_EnvelopedData *env, BIO *detached_data,
76 \& EVP_PKEY *pkey, X509 *cert,
77 \& ASN1_OCTET_STRING *secret, unsigned int flags,
78 \& OSSL_LIB_CTX *libctx, const char *propq);
79 .Ve
80 .SH DESCRIPTION
81 .IX Header "DESCRIPTION"
82 \&\fBCMS_EncryptedData_decrypt()\fR decrypts a \fIcms\fR EncryptedData object using the
83 symmetric \fIkey\fR of size \fIkeylen\fR bytes. AEAD cipher algorithms are not
84 supported. \fIout\fR is a BIO to write the content to and \fIflags\fR is an optional
85 set of flags. \fIdcont\fR is used in the rare case where the encrypted content is
86 detached. It will normally be set to NULL.
87 .PP
88 The following flags can be passed in the \fIflags\fR parameter.
89 .PP
90 If the \fBCMS_TEXT\fR flag is set MIME headers for type \f(CW\*(C`text/plain\*(C'\fR are deleted
91 from the content. If the content is not of type \f(CW\*(C`text/plain\*(C'\fR then an error is
92 returned.
93 .PP
94 \&\fBCMS_EnvelopedData_decrypt()\fR decrypts, similarly to \fBCMS_decrypt\fR\|(3),
95 a CMS EnvelopedData object \fIenv\fR using the symmetric key \fIsecret\fR if it
96 is not NULL, otherwise the private key of the recipient \fIpkey\fR.
97 If \fIpkey\fR is given, it is recommended to provide also the associated
98 certificate in \fIcert\fR \- see \fBCMS_decrypt\fR\|(3) and the NOTES on \fIcert\fR there.
99 The optional parameters \fIflags\fR and \fIdcont\fR are used as described above.
100 The optional parameters library context \fIlibctx\fR and property query \fIpropq\fR
101 are used when retrieving algorithms from providers.
102 .SH "RETURN VALUES"
103 .IX Header "RETURN VALUES"
104 \&\fBCMS_EncryptedData_decrypt()\fR returns 0 if an error occurred otherwise returns 1.
105 .PP
106 \&\fBCMS_EnvelopedData_decrypt()\fR returns NULL if an error occurred,
107 otherwise a BIO containing the decypted content.
108 .SH "SEE ALSO"
109 .IX Header "SEE ALSO"
110 \&\fBERR_get_error\fR\|(3), \fBCMS_EncryptedData_encrypt\fR\|(3), \fBCMS_decrypt\fR\|(3)
111 .SH HISTORY
112 .IX Header "HISTORY"
113 \&\fBCMS_EnvelopedData_decrypt()\fR was added in OpenSSL 3.2.
114 .SH COPYRIGHT
115 .IX Header "COPYRIGHT"
116 Copyright 2020 The OpenSSL Project Authors. All Rights Reserved.
117 .PP
118 Licensed under the Apache License 2.0 (the "License"). You may not use
119 this file except in compliance with the License. You can obtain a copy
120 in the file LICENSE in the source distribution or at
121 <https://www.openssl.org/source/license.html>.