mirror of https://github.com/openssl/openssl.git
82 lines
2.8 KiB
Plaintext
82 lines
2.8 KiB
Plaintext
=pod
|
|
|
|
=head1 NAME
|
|
|
|
PKCS12_add_cert, PKCS12_add_key, PKCS12_add_key_ex,
|
|
PKCS12_add_secret - Add an object to a set of PKCS#12 safeBags
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
#include <openssl/pkcs12.h>
|
|
|
|
PKCS12_SAFEBAG *PKCS12_add_cert(STACK_OF(PKCS12_SAFEBAG) **pbags, X509 *cert);
|
|
PKCS12_SAFEBAG *PKCS12_add_key(STACK_OF(PKCS12_SAFEBAG) **pbags,
|
|
EVP_PKEY *key, int key_usage, int iter,
|
|
int key_nid, const char *pass);
|
|
PKCS12_SAFEBAG *PKCS12_add_key_ex(STACK_OF(PKCS12_SAFEBAG) **pbags,
|
|
EVP_PKEY *key, int key_usage, int iter,
|
|
int key_nid, const char *pass,
|
|
OSSL_LIB_CTX *ctx, const char *propq);
|
|
|
|
PKCS12_SAFEBAG *PKCS12_add_secret(STACK_OF(PKCS12_SAFEBAG) **pbags,
|
|
int nid_type, const unsigned char *value, int len);
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
These functions create a new B<PKCS12_SAFEBAG> and add it to the set of safeBags
|
|
in I<pbags>.
|
|
|
|
PKCS12_add_cert() creates a PKCS#12 certBag containing the supplied
|
|
certificate and adds this to the set of PKCS#12 safeBags.
|
|
|
|
PKCS12_add_key() creates a PKCS#12 keyBag (unencrypted) or a pkcs8shroudedKeyBag
|
|
(encrypted) containing the supplied B<EVP_PKEY> and adds this to the set of PKCS#12
|
|
safeBags. If I<key_nid> is not -1 then the key is encrypted with the supplied
|
|
algorithm, using I<pass> as the passphrase and I<iter> as the iteration count. If
|
|
I<iter> is zero then a default value for iteration count of 2048 is used.
|
|
|
|
PKCS12_add_key_ex() is identical to PKCS12_add_key() but allows for a library
|
|
context I<ctx> and property query I<propq> to be used to select algorithm
|
|
implementations.
|
|
|
|
PKCS12_add_secret() creates a PKCS#12 secretBag with an OID corresponding to
|
|
the supplied I<nid_type> containing the supplied value as an ASN1 octet string.
|
|
This is then added to the set of PKCS#12 safeBags.
|
|
|
|
=head1 NOTES
|
|
|
|
If a certificate contains an I<alias> or a I<keyid> then this will be
|
|
used for the corresponding B<friendlyName> or B<localKeyID> in the
|
|
PKCS12 structure.
|
|
|
|
PKCS12_add_key() makes assumptions regarding the encoding of the given pass
|
|
phrase.
|
|
See L<passphrase-encoding(7)> for more information.
|
|
|
|
=head1 RETURN VALUES
|
|
|
|
A valid B<PKCS12_SAFEBAG> structure or NULL if an error occurred.
|
|
|
|
=head1 CONFORMING TO
|
|
|
|
IETF RFC 7292 (L<https://tools.ietf.org/html/rfc7292>)
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<PKCS12_create(3)>
|
|
|
|
=head1 HISTORY
|
|
|
|
PKCS12_add_secret() and PKCS12_add_key_ex() were added in OpenSSL 3.0.
|
|
|
|
=head1 COPYRIGHT
|
|
|
|
Copyright 2020-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
|