| 1 |
.\" -*- mode: troff; coding: utf-8 -*- |
| 2 |
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) |
| 3 |
.\" |
| 4 |
.\" Standard preamble: |
| 5 |
.\" ======================================================================== |
| 6 |
.de Sp \" Vertical space (when we can't use .PP) |
| 7 |
.if t .sp .5v |
| 8 |
.if n .sp |
| 9 |
.. |
| 10 |
.de Vb \" Begin verbatim text |
| 11 |
.ft CW |
| 12 |
.nf |
| 13 |
.ne \\$1 |
| 14 |
.. |
| 15 |
.de Ve \" End verbatim text |
| 16 |
.ft R |
| 17 |
.fi |
| 18 |
.. |
| 19 |
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. |
| 20 |
.ie n \{\ |
| 21 |
. ds C` "" |
| 22 |
. ds C' "" |
| 23 |
'br\} |
| 24 |
.el\{\ |
| 25 |
. ds C` |
| 26 |
. ds C' |
| 27 |
'br\} |
| 28 |
.\" |
| 29 |
.\" Escape single quotes in literal strings from groff's Unicode transform. |
| 30 |
.ie \n(.g .ds Aq \(aq |
| 31 |
.el .ds Aq ' |
| 32 |
.\" |
| 33 |
.\" If the F register is >0, we'll generate index entries on stderr for |
| 34 |
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
| 35 |
.\" entries marked with X<> in POD. Of course, you'll have to process the |
| 36 |
.\" output yourself in some meaningful fashion. |
| 37 |
.\" |
| 38 |
.\" Avoid warning from groff about undefined register 'F'. |
| 39 |
.de IX |
| 40 |
.. |
| 41 |
.nr rF 0 |
| 42 |
.if \n(.g .if rF .nr rF 1 |
| 43 |
.if (\n(rF:(\n(.g==0)) \{\ |
| 44 |
. if \nF \{\ |
| 45 |
. de IX |
| 46 |
. tm Index:\\$1\t\\n%\t"\\$2" |
| 47 |
.. |
| 48 |
. if !\nF==2 \{\ |
| 49 |
. nr % 0 |
| 50 |
. nr F 2 |
| 51 |
. \} |
| 52 |
. \} |
| 53 |
.\} |
| 54 |
.rr rF |
| 55 |
.\" ======================================================================== |
| 56 |
.\" |
| 57 |
.IX Title "PKCS12_ADD_SAFE 3SSL" |
| 58 |
.TH PKCS12_ADD_SAFE 3SSL 2026-04-07 3.6.2 OpenSSL |
| 59 |
.\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 60 |
.\" way too many mistakes in technical documents. |
| 61 |
.if n .ad l |
| 62 |
.nh |
| 63 |
.SH NAME |
| 64 |
PKCS12_add_safe, PKCS12_add_safe_ex, |
| 65 |
PKCS12_add_safes, PKCS12_add_safes_ex \- Create and add objects to a PKCS#12 structure |
| 66 |
.SH SYNOPSIS |
| 67 |
.IX Header "SYNOPSIS" |
| 68 |
.Vb 1 |
| 69 |
\& #include <openssl/pkcs12.h> |
| 70 |
\& |
| 71 |
\& int PKCS12_add_safe(STACK_OF(PKCS7) **psafes, STACK_OF(PKCS12_SAFEBAG) *bags, |
| 72 |
\& int safe_nid, int iter, const char *pass); |
| 73 |
\& int PKCS12_add_safe_ex(STACK_OF(PKCS7) **psafes, STACK_OF(PKCS12_SAFEBAG) *bags, |
| 74 |
\& int safe_nid, int iter, const char *pass, |
| 75 |
\& OSSL_LIB_CTX *ctx, const char *propq); |
| 76 |
\& |
| 77 |
\& PKCS12 *PKCS12_add_safes(STACK_OF(PKCS7) *safes, int p7_nid); |
| 78 |
\& PKCS12 *PKCS12_add_safes_ex(STACK_OF(PKCS7) *safes, int p7_nid, |
| 79 |
\& OSSL_LIB_CTX *ctx, const char *propq); |
| 80 |
.Ve |
| 81 |
.SH DESCRIPTION |
| 82 |
.IX Header "DESCRIPTION" |
| 83 |
\&\fBPKCS12_add_safe()\fR creates a new PKCS7 contentInfo containing the supplied |
| 84 |
\&\fBPKCS12_SAFEBAG\fRs and adds this to a set of PKCS7 contentInfos. Its type |
| 85 |
depends on the value of \fBsafe_nid\fR: |
| 86 |
.IP \(bu 4 |
| 87 |
If \fIsafe_nid\fR is \-1, a plain PKCS7 \fIdata\fR contentInfo is created. |
| 88 |
.IP \(bu 4 |
| 89 |
If \fIsafe_nid\fR is a valid PBE algorithm NID, a PKCS7 \fBencryptedData\fR |
| 90 |
contentInfo is created. The algorithm uses \fIpass\fR as the passphrase and \fIiter\fR |
| 91 |
as the iteration count. If \fIiter\fR is zero then a default value for iteration |
| 92 |
count of 2048 is used. |
| 93 |
.IP \(bu 4 |
| 94 |
If \fIsafe_nid\fR is 0, a PKCS7 \fBencryptedData\fR contentInfo is created using |
| 95 |
a default encryption algorithm, currently \fBNID_pbe_WithSHA1And3_Key_TripleDES_CBC\fR. |
| 96 |
.PP |
| 97 |
\&\fBPKCS12_add_safe_ex()\fR is identical to \fBPKCS12_add_safe()\fR but allows for a library |
| 98 |
context \fIctx\fR and property query \fIpropq\fR to be used to select algorithm |
| 99 |
implementations. |
| 100 |
.PP |
| 101 |
\&\fBPKCS12_add_safes()\fR creates a \fBPKCS12\fR structure containing the supplied set of |
| 102 |
PKCS7 contentInfos. The \fIsafes\fR are enclosed first within a PKCS7 contentInfo |
| 103 |
of type \fIp7_nid\fR. Currently the only supported type is \fBNID_pkcs7_data\fR. |
| 104 |
.PP |
| 105 |
\&\fBPKCS12_add_safes_ex()\fR is identical to \fBPKCS12_add_safes()\fR but allows for a |
| 106 |
library context \fIctx\fR and property query \fIpropq\fR to be used to select |
| 107 |
algorithm implementations. |
| 108 |
.SH NOTES |
| 109 |
.IX Header "NOTES" |
| 110 |
\&\fBPKCS12_add_safe()\fR makes assumptions regarding the encoding of the given pass |
| 111 |
phrase. |
| 112 |
See \fBpassphrase\-encoding\fR\|(7) for more information. |
| 113 |
.SH "RETURN VALUES" |
| 114 |
.IX Header "RETURN VALUES" |
| 115 |
\&\fBPKCS12_add_safe()\fR returns a value of 1 indicating success or 0 for failure. |
| 116 |
.PP |
| 117 |
\&\fBPKCS12_add_safes()\fR returns a valid \fBPKCS12\fR structure or NULL if an error occurred. |
| 118 |
.SH "CONFORMING TO" |
| 119 |
.IX Header "CONFORMING TO" |
| 120 |
IETF RFC 7292 (<https://tools.ietf.org/html/rfc7292>) |
| 121 |
.SH "SEE ALSO" |
| 122 |
.IX Header "SEE ALSO" |
| 123 |
\&\fBPKCS12_create\fR\|(3) |
| 124 |
.SH HISTORY |
| 125 |
.IX Header "HISTORY" |
| 126 |
\&\fBPKCS12_add_safe_ex()\fR and \fBPKCS12_add_safes_ex()\fR were added in OpenSSL 3.0. |
| 127 |
.SH COPYRIGHT |
| 128 |
.IX Header "COPYRIGHT" |
| 129 |
Copyright 2020\-2021 The OpenSSL Project Authors. All Rights Reserved. |
| 130 |
.PP |
| 131 |
Licensed under the Apache License 2.0 (the "License"). You may not use |
| 132 |
this file except in compliance with the License. You can obtain a copy |
| 133 |
in the file LICENSE in the source distribution or at |
| 134 |
<https://www.openssl.org/source/license.html>. |