xref: /freebsd/crypto/openssl/doc/man3/PKCS12_pack_p7encdata.pod (revision 59c8e88e72633afbc47a4ace0d2170d00d51f7dc)
1=pod
2
3=head1 NAME
4
5PKCS12_pack_p7encdata, PKCS12_pack_p7encdata_ex - Pack a set of PKCS#12 safeBags
6into a PKCS#7 encrypted data object
7
8=head1 SYNOPSIS
9
10 #include <openssl/pkcs12.h>
11
12 PKCS7 *PKCS12_pack_p7encdata(int pbe_nid, const char *pass, int passlen,
13                              unsigned char *salt, int saltlen, int iter,
14                              STACK_OF(PKCS12_SAFEBAG) *bags);
15 PKCS7 *PKCS12_pack_p7encdata_ex(int pbe_nid, const char *pass, int passlen,
16                                 unsigned char *salt, int saltlen, int iter,
17                                 STACK_OF(PKCS12_SAFEBAG) *bags,
18                                 OSSL_LIB_CTX *ctx, const char *propq);
19
20=head1 DESCRIPTION
21
22PKCS12_pack_p7encdata() generates a PKCS#7 ContentInfo object of encrypted-data
23type from the set of safeBags I<bags>. The algorithm ID in I<pbe_nid> can be
24a PKCS#12 or PKCS#5 password based encryption algorithm, or a cipher algorithm.
25If a cipher algorithm is passed, the PKCS#5 PBES2 algorithm will be used with
26this cipher as a parameter.
27The password I<pass> of length I<passlen>, salt I<salt> of length I<saltlen>
28and iteration count I<iter> are inputs into the encryption operation.
29
30PKCS12_pack_p7encdata_ex() operates similar to the above but allows for a
31library context I<ctx> and property query I<propq> to be used to select the
32algorithm implementation.
33
34=head1 RETURN VALUES
35
36A B<PKCS7> object if successful, or NULL if an error occurred.
37
38=head1 CONFORMING TO
39
40IETF RFC 2315 (L<https://tools.ietf.org/html/rfc2315>)
41
42=head1 SEE ALSO
43
44L<PKCS12_pbe_crypt_ex(3)>
45
46=head1 HISTORY
47
48PKCS12_pack_p7encdata_ex() was added in OpenSSL 3.0.
49
50=head1 COPYRIGHT
51
52Copyright 2021 The OpenSSL Project Authors. All Rights Reserved.
53
54Licensed under the Apache License 2.0 (the "License").  You may not use
55this file except in compliance with the License.  You can obtain a copy
56in the file LICENSE in the source distribution or at
57L<https://www.openssl.org/source/license.html>.
58
59=cut
60