Debian Codegraph @

upstream/debian-unstable/man3/PKCS12_pack_p7encdata.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 "PKCS12_PACK_P7ENCDATA 3SSL"
58 .TH PKCS12_PACK_P7ENCDATA 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 PKCS12_pack_p7encdata, PKCS12_pack_p7encdata_ex \- Pack a set of PKCS#12 safeBags
65 into a PKCS#7 encrypted data object
66 .SH SYNOPSIS
67 .IX Header "SYNOPSIS"
68 .Vb 1
69 \& #include <openssl/pkcs12.h>
70 \&
71 \& PKCS7 *PKCS12_pack_p7encdata(int pbe_nid, const char *pass, int passlen,
72 \& unsigned char *salt, int saltlen, int iter,
73 \& STACK_OF(PKCS12_SAFEBAG) *bags);
74 \& PKCS7 *PKCS12_pack_p7encdata_ex(int pbe_nid, const char *pass, int passlen,
75 \& unsigned char *salt, int saltlen, int iter,
76 \& STACK_OF(PKCS12_SAFEBAG) *bags,
77 \& OSSL_LIB_CTX *ctx, const char *propq);
78 .Ve
79 .SH DESCRIPTION
80 .IX Header "DESCRIPTION"
81 \&\fBPKCS12_pack_p7encdata()\fR generates a PKCS#7 ContentInfo object of encrypted-data
82 type from the set of safeBags \fIbags\fR. The algorithm ID in \fIpbe_nid\fR can be
83 a PKCS#12 or PKCS#5 password based encryption algorithm, or a cipher algorithm.
84 If a cipher algorithm is passed, the PKCS#5 PBES2 algorithm will be used with
85 this cipher as a parameter.
86 The password \fIpass\fR of length \fIpasslen\fR, salt \fIsalt\fR of length \fIsaltlen\fR
87 and iteration count \fIiter\fR are inputs into the encryption operation.
88 .PP
89 \&\fBPKCS12_pack_p7encdata_ex()\fR operates similar to the above but allows for a
90 library context \fIctx\fR and property query \fIpropq\fR to be used to select the
91 algorithm implementation.
92 .SH "RETURN VALUES"
93 .IX Header "RETURN VALUES"
94 A \fBPKCS7\fR object if successful, or NULL if an error occurred.
95 .SH "CONFORMING TO"
96 .IX Header "CONFORMING TO"
97 IETF RFC 2315 (<https://tools.ietf.org/html/rfc2315>)
98 .SH "SEE ALSO"
99 .IX Header "SEE ALSO"
100 \&\fBPKCS12_pbe_crypt_ex\fR\|(3)
101 .SH HISTORY
102 .IX Header "HISTORY"
103 \&\fBPKCS12_pack_p7encdata_ex()\fR was added in OpenSSL 3.0.
104 .SH COPYRIGHT
105 .IX Header "COPYRIGHT"
106 Copyright 2021 The OpenSSL Project Authors. All Rights Reserved.
107 .PP
108 Licensed under the Apache License 2.0 (the "License"). You may not use
109 this file except in compliance with the License. You can obtain a copy
110 in the file LICENSE in the source distribution or at
111 <https://www.openssl.org/source/license.html>.