openssl/doc/man3/PKCS12_pack_p7encdata.pod

=pod

=head1 NAME

PKCS12_pack_p7encdata, PKCS12_pack_p7encdata_ex - Pack a set of PKCS#12 safeBags
into a PKCS#7 encrypted data object

=head1 SYNOPSIS

 #include <openssl/pkcs12.h>

 PKCS7 *PKCS12_pack_p7encdata(int pbe_nid, const char *pass, int passlen,
                              unsigned char *salt, int saltlen, int iter,
                              STACK_OF(PKCS12_SAFEBAG) *bags);
 PKCS7 *PKCS12_pack_p7encdata_ex(int pbe_nid, const char *pass, int passlen,
                                 unsigned char *salt, int saltlen, int iter,
                                 STACK_OF(PKCS12_SAFEBAG) *bags,
                                 OSSL_LIB_CTX *ctx, const char *propq);

=head1 DESCRIPTION

PKCS12_pack_p7encdata() generates a PKCS#7 ContentInfo object of encrypted-data
type from the set of safeBags I<bags>. The algorithm ID in I<pbe_nid> can be
a PKCS#12 or PKCS#5 password based encryption algorithm, or a cipher algorithm.
If a cipher algorithm is passed, the PKCS#5 PBES2 algorithm will be used with
this cipher as a parameter.
The password I<pass> of length I<passlen>, salt I<salt> of length I<saltlen>
and iteration count I<iter> are inputs into the encryption operation.

PKCS12_pack_p7encdata_ex() operates similar to the above but allows for a
library context I<ctx> and property query I<propq> to be used to select the
algorithm implementation.

=head1 RETURN VALUES

A B<PKCS7> object if successful, or NULL if an error occurred.

=head1 CONFORMING TO

IETF RFC 2315 (L<https://tools.ietf.org/html/rfc2315>)

=head1 SEE ALSO

L<PKCS12_pbe_crypt_ex(3)>

=head1 HISTORY

PKCS12_pack_p7encdata_ex() was added in OpenSSL 3.0.

=head1 COPYRIGHT

Copyright 2021 The OpenSSL Project Authors. All Rights Reserved.

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
L<https://www.openssl.org/source/license.html>.

=cut