1=pod 2 3=head1 NAME 4 5PKCS12_create, PKCS12_create_ex - create a PKCS#12 structure 6 7=head1 SYNOPSIS 8 9 #include <openssl/pkcs12.h> 10 11 PKCS12 *PKCS12_create(const char *pass, const char *name, EVP_PKEY *pkey, 12 X509 *cert, STACK_OF(X509) *ca, 13 int nid_key, int nid_cert, int iter, int mac_iter, int keytype); 14 PKCS12 *PKCS12_create_ex(const char *pass, const char *name, EVP_PKEY *pkey, 15 X509 *cert, STACK_OF(X509) *ca, int nid_key, int nid_cert, 16 int iter, int mac_iter, int keytype, 17 OSSL_LIB_CTX *ctx, const char *propq); 18 19=head1 DESCRIPTION 20 21PKCS12_create() creates a PKCS#12 structure. 22 23I<pass> is the passphrase to use. I<name> is the B<friendlyName> to use for 24the supplied certificate and key. I<pkey> is the private key to include in 25the structure and I<cert> its corresponding certificates. I<ca>, if not B<NULL> 26is an optional set of certificates to also include in the structure. 27 28I<nid_key> and I<nid_cert> are the encryption algorithms that should be used 29for the key and certificate respectively. The modes 30GCM, CCM, XTS, and OCB are unsupported. I<iter> is the encryption algorithm 31iteration count to use and I<mac_iter> is the MAC iteration count to use. 32I<keytype> is the type of key. 33 34PKCS12_create_ex() is identical to PKCS12_create() but allows for a library context 35I<ctx> and property query I<propq> to be used to select algorithm implementations. 36 37=head1 NOTES 38 39The parameters I<nid_key>, I<nid_cert>, I<iter>, I<mac_iter> and I<keytype> 40can all be set to zero and sensible defaults will be used. 41 42These defaults are: AES password based encryption (PBES2 with PBKDF2 and 43AES-256-CBC) for private keys and certificates, the PBKDF2 and MAC key 44derivation iteration count of B<PKCS12_DEFAULT_ITER> (currently 2048), and 45MAC algorithm HMAC with SHA2-256. The MAC key derivation algorithm used 46for the outer PKCS#12 structure is PKCS12KDF. 47 48The default MAC iteration count is 1 in order to retain compatibility with 49old software which did not interpret MAC iteration counts. If such compatibility 50is not required then I<mac_iter> should be set to PKCS12_DEFAULT_ITER. 51 52I<keytype> adds a flag to the store private key. This is a non standard extension 53that is only currently interpreted by MSIE. If set to zero the flag is omitted, 54if set to B<KEY_SIG> the key can be used for signing only, if set to B<KEY_EX> 55it can be used for signing and encryption. This option was useful for old 56export grade software which could use signing only keys of arbitrary size but 57had restrictions on the permissible sizes of keys which could be used for 58encryption. 59 60If I<name> is B<NULL> and I<cert> contains an I<alias> then this will be 61used for the corresponding B<friendlyName> in the PKCS12 structure instead. 62Similarly, if I<pkey> is NULL and I<cert> contains a I<keyid> then this will be 63used for the corresponding B<localKeyID> in the PKCS12 structure instead of the 64id calculated from the I<pkey>. 65 66For all certificates in I<ca> then if a certificate contains an I<alias> or 67I<keyid> then this will be used for the corresponding B<friendlyName> or 68B<localKeyID> in the PKCS12 structure. 69 70Either I<pkey>, I<cert> or both can be B<NULL> to indicate that no key or 71certificate is required. In previous versions both had to be present or 72a fatal error is returned. 73 74I<nid_key> or I<nid_cert> can be set to -1 indicating that no encryption 75should be used. 76 77I<mac_iter> can be set to -1 and the MAC will then be omitted entirely. 78This can be useful when running with the FIPS provider as the PKCS12KDF 79is not a FIPS approvable algorithm. 80 81PKCS12_create() makes assumptions regarding the encoding of the given pass 82phrase. 83See L<passphrase-encoding(7)> for more information. 84 85=head1 RETURN VALUES 86 87PKCS12_create() returns a valid B<PKCS12> structure or NULL if an error occurred. 88 89=head1 CONFORMING TO 90 91IETF RFC 7292 (L<https://tools.ietf.org/html/rfc7292>) 92 93=head1 SEE ALSO 94 95L<EVP_KDF-PKCS12KDF(7)>, 96L<d2i_PKCS12(3)>, 97L<OSSL_PROVIDER-FIPS(7)>, 98L<passphrase-encoding(7)> 99 100=head1 HISTORY 101 102PKCS12_create_ex() was added in OpenSSL 3.0. 103 104The defaults for encryption algorithms, MAC algorithm, and the MAC key 105derivation iteration count were changed in OpenSSL 3.0 to more modern 106standards. 107 108=head1 COPYRIGHT 109 110Copyright 2002-2024 The OpenSSL Project Authors. All Rights Reserved. 111 112Licensed under the Apache License 2.0 (the "License"). You may not use 113this file except in compliance with the License. You can obtain a copy 114in the file LICENSE in the source distribution or at 115L<https://www.openssl.org/source/license.html>. 116 117=cut 118