| 1 | =pod
|
|---|
| 2 |
|
|---|
| 3 | =head1 NAME
|
|---|
| 4 |
|
|---|
| 5 | PKCS12_add_safe, PKCS12_add_safe_ex,
|
|---|
| 6 | PKCS12_add_safes, PKCS12_add_safes_ex - Create and add objects to a PKCS#12 structure
|
|---|
| 7 |
|
|---|
| 8 | =head1 SYNOPSIS
|
|---|
| 9 |
|
|---|
| 10 | #include <openssl/pkcs12.h>
|
|---|
| 11 |
|
|---|
| 12 | int PKCS12_add_safe(STACK_OF(PKCS7) **psafes, STACK_OF(PKCS12_SAFEBAG) *bags,
|
|---|
| 13 | int safe_nid, int iter, const char *pass);
|
|---|
| 14 | int PKCS12_add_safe_ex(STACK_OF(PKCS7) **psafes, STACK_OF(PKCS12_SAFEBAG) *bags,
|
|---|
| 15 | int safe_nid, int iter, const char *pass,
|
|---|
| 16 | OSSL_LIB_CTX *ctx, const char *propq);
|
|---|
| 17 |
|
|---|
| 18 | PKCS12 *PKCS12_add_safes(STACK_OF(PKCS7) *safes, int p7_nid);
|
|---|
| 19 | PKCS12 *PKCS12_add_safes_ex(STACK_OF(PKCS7) *safes, int p7_nid,
|
|---|
| 20 | OSSL_LIB_CTX *ctx, const char *propq);
|
|---|
| 21 |
|
|---|
| 22 | =head1 DESCRIPTION
|
|---|
| 23 |
|
|---|
| 24 | PKCS12_add_safe() creates a new PKCS7 contentInfo containing the supplied
|
|---|
| 25 | B<PKCS12_SAFEBAG>s and adds this to a set of PKCS7 contentInfos. Its type
|
|---|
| 26 | depends on the value of B<safe_nid>:
|
|---|
| 27 |
|
|---|
| 28 | =over 4
|
|---|
| 29 |
|
|---|
| 30 | =item * If I<safe_nid> is -1, a plain PKCS7 I<data> contentInfo is created.
|
|---|
| 31 |
|
|---|
| 32 | =item * If I<safe_nid> is a valid PBE algorithm NID, a PKCS7 B<encryptedData>
|
|---|
| 33 | contentInfo is created. The algorithm uses I<pass> as the passphrase and I<iter>
|
|---|
| 34 | as the iteration count. If I<iter> is zero then a default value for iteration
|
|---|
| 35 | count of 2048 is used.
|
|---|
| 36 |
|
|---|
| 37 | =item * If I<safe_nid> is 0, a PKCS7 B<encryptedData> contentInfo is created using
|
|---|
| 38 | a default encryption algorithm, currently B<NID_pbe_WithSHA1And3_Key_TripleDES_CBC>.
|
|---|
| 39 |
|
|---|
| 40 | =back
|
|---|
| 41 |
|
|---|
| 42 | PKCS12_add_safe_ex() is identical to PKCS12_add_safe() but allows for a library
|
|---|
| 43 | context I<ctx> and property query I<propq> to be used to select algorithm
|
|---|
| 44 | implementations.
|
|---|
| 45 |
|
|---|
| 46 | PKCS12_add_safes() creates a B<PKCS12> structure containing the supplied set of
|
|---|
| 47 | PKCS7 contentInfos. The I<safes> are enclosed first within a PKCS7 contentInfo
|
|---|
| 48 | of type I<p7_nid>. Currently the only supported type is B<NID_pkcs7_data>.
|
|---|
| 49 |
|
|---|
| 50 | PKCS12_add_safes_ex() is identical to PKCS12_add_safes() but allows for a
|
|---|
| 51 | library context I<ctx> and property query I<propq> to be used to select
|
|---|
| 52 | algorithm implementations.
|
|---|
| 53 |
|
|---|
| 54 | =head1 NOTES
|
|---|
| 55 |
|
|---|
| 56 | PKCS12_add_safe() makes assumptions regarding the encoding of the given pass
|
|---|
| 57 | phrase.
|
|---|
| 58 | See L<passphrase-encoding(7)> for more information.
|
|---|
| 59 |
|
|---|
| 60 | =head1 RETURN VALUES
|
|---|
| 61 |
|
|---|
| 62 | PKCS12_add_safe() returns a value of 1 indicating success or 0 for failure.
|
|---|
| 63 |
|
|---|
| 64 | PKCS12_add_safes() returns a valid B<PKCS12> structure or NULL if an error occurred.
|
|---|
| 65 |
|
|---|
| 66 | =head1 CONFORMING TO
|
|---|
| 67 |
|
|---|
| 68 | IETF RFC 7292 (L<https://tools.ietf.org/html/rfc7292>)
|
|---|
| 69 |
|
|---|
| 70 | =head1 SEE ALSO
|
|---|
| 71 |
|
|---|
| 72 | L<PKCS12_create(3)>
|
|---|
| 73 |
|
|---|
| 74 | =head1 HISTORY
|
|---|
| 75 |
|
|---|
| 76 | PKCS12_add_safe_ex() and PKCS12_add_safes_ex() were added in OpenSSL 3.0.
|
|---|
| 77 |
|
|---|
| 78 | =head1 COPYRIGHT
|
|---|
| 79 |
|
|---|
| 80 | Copyright 2020-2021 The OpenSSL Project Authors. All Rights Reserved.
|
|---|
| 81 |
|
|---|
| 82 | Licensed under the Apache License 2.0 (the "License"). You may not use
|
|---|
| 83 | this file except in compliance with the License. You can obtain a copy
|
|---|
| 84 | in the file LICENSE in the source distribution or at
|
|---|
| 85 | L<https://www.openssl.org/source/license.html>.
|
|---|
| 86 |
|
|---|
| 87 | =cut
|
|---|
