Debian Codegraph @

upstream/debian-unstable/man3/CMS_EncryptedData_encrypt.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_ENCRYPT 3SSL"
58 .TH CMS_ENCRYPTEDDATA_ENCRYPT 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_encrypt_ex, CMS_EncryptedData_encrypt
65 \&\- Create CMS EncryptedData
66 .SH SYNOPSIS
67 .IX Header "SYNOPSIS"
68 .Vb 1
69 \& #include <openssl/cms.h>
70 \&
71 \& CMS_ContentInfo *CMS_EncryptedData_encrypt_ex(BIO *in,
72 \& const EVP_CIPHER *cipher,
73 \& const unsigned char *key,
74 \& size_t keylen,
75 \& unsigned int flags,
76 \& OSSL_LIB_CTX *ctx,
77 \& const char *propq);
78 \&
79 \& CMS_ContentInfo *CMS_EncryptedData_encrypt(BIO *in,
80 \& const EVP_CIPHER *cipher, const unsigned char *key, size_t keylen,
81 \& unsigned int flags);
82 .Ve
83 .SH DESCRIPTION
84 .IX Header "DESCRIPTION"
85 \&\fBCMS_EncryptedData_encrypt_ex()\fR creates a \fBCMS_ContentInfo\fR structure
86 with a type \fBNID_pkcs7_encrypted\fR. \fIin\fR is a BIO containing the data to
87 encrypt using \fIcipher\fR and the encryption key \fIkey\fR of size \fIkeylen\fR bytes.
88 The library context \fIlibctx\fR and the property query \fIpropq\fR are used when
89 retrieving algorithms from providers. \fIflags\fR is a set of optional flags.
90 .PP
91 The \fIflags\fR field supports the options \fBCMS_DETACHED\fR, \fBCMS_STREAM\fR and
92 \&\fBCMS_PARTIAL\fR. Internally \fBCMS_final()\fR is called unless \fBCMS_STREAM\fR and/or
93 \&\fBCMS_PARTIAL\fR is specified.
94 .PP
95 The algorithm passed in the \fIcipher\fR parameter must support ASN1 encoding of
96 its parameters. AEAD cipher algorithms are not supported.
97 .PP
98 The \fBCMS_ContentInfo\fR structure can be freed using \fBCMS_ContentInfo_free\fR\|(3).
99 .PP
100 \&\fBCMS_EncryptedData_encrypt()\fR is similar to \fBCMS_EncryptedData_encrypt_ex()\fR
101 but uses default values of NULL for the library context \fIlibctx\fR and the
102 property query \fIpropq\fR.
103 .SH "RETURN VALUES"
104 .IX Header "RETURN VALUES"
105 If the allocation fails, \fBCMS_EncryptedData_encrypt_ex()\fR and
106 \&\fBCMS_EncryptedData_encrypt()\fR return NULL and set an error code that can be
107 obtained by \fBERR_get_error\fR\|(3). Otherwise they return a pointer to the newly
108 allocated structure.
109 .SH "SEE ALSO"
110 .IX Header "SEE ALSO"
111 \&\fBERR_get_error\fR\|(3), \fBCMS_final\fR\|(3), \fBCMS_EncryptedData_decrypt\fR\|(3)
112 .SH HISTORY
113 .IX Header "HISTORY"
114 The \fBCMS_EncryptedData_encrypt_ex()\fR method was added in OpenSSL 3.0.
115 .SH COPYRIGHT
116 .IX Header "COPYRIGHT"
117 Copyright 2020\-2021 The OpenSSL Project Authors. All Rights Reserved.
118 .PP
119 Licensed under the Apache License 2.0 (the "License"). You may not use
120 this file except in compliance with the License. You can obtain a copy
121 in the file LICENSE in the source distribution or at
122 <https://www.openssl.org/source/license.html>.