PKCS12_init.pod 1.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  1. =pod
  2. =head1 NAME
  3. PKCS12_init, PKCS12_init_ex - Create a new empty PKCS#12 structure
  4. =head1 SYNOPSIS
  5. #include <openssl/pkcs12.h>
  6. PKCS12 *PKCS12_init(int mode);
  7. PKCS12 *PKCS12_init_ex(int mode, OSSL_LIB_CTX *ctx, const char *propq);
  8. =head1 DESCRIPTION
  9. PKCS12_init() creates an empty PKCS#12 structure. Any PKCS#7 authSafes added
  10. to this structure are enclosed first within a single PKCS#7 contentInfo
  11. of type I<mode>. Currently the only supported type is B<NID_pkcs7_data>.
  12. PKCS12_init_ex() creates an empty PKCS#12 structure and assigns the supplied
  13. I<ctx> and I<propq> to be used to select algorithm implementations for
  14. operations performed on the B<PKCS12> object.
  15. =head1 RETURN VALUES
  16. PKCS12_init() and PKCS12_init_ex() return a valid B<PKCS12> structure or NULL
  17. if an error occurred.
  18. =head1 SEE ALSO
  19. L<d2i_PKCS12(3)>,
  20. L<PKCS12_create(3)>,
  21. L<passphrase-encoding(7)>
  22. =head1 HISTORY
  23. PKCS12_init_ex() was added in OpenSSL 3.0.
  24. =head1 COPYRIGHT
  25. Copyright 2021 The OpenSSL Project Authors. All Rights Reserved.
  26. Licensed under the Apache License 2.0 (the "License"). You may not use
  27. this file except in compliance with the License. You can obtain a copy
  28. in the file LICENSE in the source distribution or at
  29. L<https://www.openssl.org/source/license.html>.
  30. =cut