xref: /freebsd/secure/lib/libcrypto/man/man3/PKCS12_add_safe.3 (revision 2f9966ff63d65bd474478888c9088eeae3f9c669)
Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)

Standard preamble:
========================================================================
..
..
.. Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================

Title "PKCS12_ADD_SAFE 3ossl"
PKCS12_ADD_SAFE 3ossl "2023-09-19" "3.0.11" "OpenSSL"
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
"NAME"
PKCS12_add_safe, PKCS12_add_safe_ex, PKCS12_add_safes, PKCS12_add_safes_ex - Create and add objects to a PKCS#12 structure
"SYNOPSIS"
Header "SYNOPSIS" .Vb 1 #include <openssl/pkcs12.h> \& int PKCS12_add_safe(STACK_OF(PKCS7) **psafes, STACK_OF(PKCS12_SAFEBAG) *bags, int safe_nid, int iter, const char *pass); int PKCS12_add_safe_ex(STACK_OF(PKCS7) **psafes, STACK_OF(PKCS12_SAFEBAG) *bags, int safe_nid, int iter, const char *pass, OSSL_LIB_CTX *ctx, const char *propq); \& PKCS12 *PKCS12_add_safes(STACK_OF(PKCS7) *safes, int p7_nid); PKCS12 *PKCS12_add_safes_ex(STACK_OF(PKCS7) *safes, int p7_nid, OSSL_LIB_CTX *ctx, const char *propq); .Ve
"DESCRIPTION"
Header "DESCRIPTION" \fBPKCS12_add_safe() creates a new \s-1PKCS7\s0 contentInfo containing the supplied \fB\s-1PKCS12_SAFEBAG\s0s and adds this to a set of \s-1PKCS7\s0 contentInfos. Its type depends on the value of safe_nid:
"\(bu" 4
If safe_nid is -1, a plain \s-1PKCS7\s0 data contentInfo is created.
"\(bu" 4
If safe_nid is a valid \s-1PBE\s0 algorithm \s-1NID,\s0 a \s-1PKCS7\s0 encryptedData contentInfo is created. The algorithm uses pass as the passphrase and iter as the iteration count. If iter is zero then a default value for iteration count of 2048 is used.
"\(bu" 4
If safe_nid is 0, a \s-1PKCS7\s0 encryptedData contentInfo is created using a default encryption algorithm, currently NID_pbe_WithSHA1And3_Key_TripleDES_CBC.

\fBPKCS12_add_safe_ex() is identical to PKCS12_add_safe() but allows for a library context ctx and property query propq to be used to select algorithm implementations.

\fBPKCS12_add_safes() creates a \s-1PKCS12\s0 structure containing the supplied set of \s-1PKCS7\s0 contentInfos. The safes are enclosed first within a \s-1PKCS7\s0 contentInfo of type p7_nid. Currently the only supported type is NID_pkcs7_data.

\fBPKCS12_add_safes_ex() is identical to PKCS12_add_safes() but allows for a library context ctx and property query propq to be used to select algorithm implementations.

"NOTES"
Header "NOTES" \fBPKCS12_add_safe() makes assumptions regarding the encoding of the given pass phrase. See passphrase-encoding\|(7) for more information.
"RETURN VALUES"
Header "RETURN VALUES" \fBPKCS12_add_safe() returns a value of 1 indicating success or 0 for failure.

\fBPKCS12_add_safes() returns a valid \s-1PKCS12\s0 structure or \s-1NULL\s0 if an error occurred.

"CONFORMING TO"
Header "CONFORMING TO" \s-1IETF RFC 7292\s0 (<https://tools.ietf.org/html/rfc7292>)
"SEE ALSO"
Header "SEE ALSO" \fBPKCS12_create\|(3)
"HISTORY"
Header "HISTORY" \fBPKCS12_add_safe_ex() and PKCS12_add_safes_ex() were added in OpenSSL 3.0.
"COPYRIGHT"
Header "COPYRIGHT" Copyright 2020-2021 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use this file except in compliance with the License. You can obtain a copy in the file \s-1LICENSE\s0 in the source distribution or at <https://www.openssl.org/source/license.html>.