Debian Codegraph @

upstream/debian-unstable/man3/PKCS12_add_cert.3ssl

raw
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_CERT 3SSL"
58 .TH PKCS12_ADD_CERT 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_cert, PKCS12_add_key, PKCS12_add_key_ex,
65 PKCS12_add_secret \- Add an object to a set of PKCS#12 safeBags
66 .SH SYNOPSIS
67 .IX Header "SYNOPSIS"
68 .Vb 1
69 \& #include <openssl/pkcs12.h>
70 \&
71 \& PKCS12_SAFEBAG *PKCS12_add_cert(STACK_OF(PKCS12_SAFEBAG) **pbags, X509 *cert);
72 \& PKCS12_SAFEBAG *PKCS12_add_key(STACK_OF(PKCS12_SAFEBAG) **pbags,
73 \& EVP_PKEY *key, int key_usage, int iter,
74 \& int key_nid, const char *pass);
75 \& PKCS12_SAFEBAG *PKCS12_add_key_ex(STACK_OF(PKCS12_SAFEBAG) **pbags,
76 \& EVP_PKEY *key, int key_usage, int iter,
77 \& int key_nid, const char *pass,
78 \& OSSL_LIB_CTX *ctx, const char *propq);
79 \&
80 \& PKCS12_SAFEBAG *PKCS12_add_secret(STACK_OF(PKCS12_SAFEBAG) **pbags,
81 \& int nid_type, const unsigned char *value, int len);
82 .Ve
83 .SH DESCRIPTION
84 .IX Header "DESCRIPTION"
85 These functions create a new \fBPKCS12_SAFEBAG\fR and add it to the set of safeBags
86 in \fIpbags\fR.
87 .PP
88 \&\fBPKCS12_add_cert()\fR creates a PKCS#12 certBag containing the supplied
89 certificate and adds this to the set of PKCS#12 safeBags.
90 .PP
91 \&\fBPKCS12_add_key()\fR creates a PKCS#12 keyBag (unencrypted) or a pkcs8shroudedKeyBag
92 (encrypted) containing the supplied \fBEVP_PKEY\fR and adds this to the set of PKCS#12
93 safeBags. If \fIkey_nid\fR is not \-1 then the key is encrypted with the supplied
94 algorithm, using \fIpass\fR as the passphrase and \fIiter\fR as the iteration count. If
95 \&\fIiter\fR is zero then a default value for iteration count of 2048 is used.
96 .PP
97 \&\fBPKCS12_add_key_ex()\fR is identical to \fBPKCS12_add_key()\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_secret()\fR creates a PKCS#12 secretBag with an OID corresponding to
102 the supplied \fInid_type\fR containing the supplied value as an ASN1 octet string.
103 This is then added to the set of PKCS#12 safeBags.
104 .SH NOTES
105 .IX Header "NOTES"
106 If a certificate contains an \fIalias\fR or a \fIkeyid\fR then this will be
107 used for the corresponding \fBfriendlyName\fR or \fBlocalKeyID\fR in the
108 PKCS12 structure.
109 .PP
110 \&\fBPKCS12_add_key()\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 A valid \fBPKCS12_SAFEBAG\fR structure or NULL if an error occurred.
116 .SH "CONFORMING TO"
117 .IX Header "CONFORMING TO"
118 IETF RFC 7292 (<https://tools.ietf.org/html/rfc7292>)
119 .SH "SEE ALSO"
120 .IX Header "SEE ALSO"
121 \&\fBPKCS12_create\fR\|(3)
122 .SH HISTORY
123 .IX Header "HISTORY"
124 \&\fBPKCS12_add_secret()\fR and \fBPKCS12_add_key_ex()\fR were added in OpenSSL 3.0.
125 .SH COPYRIGHT
126 .IX Header "COPYRIGHT"
127 Copyright 2020\-2021 The OpenSSL Project Authors. All Rights Reserved.
128 .PP
129 Licensed under the Apache License 2.0 (the "License"). You may not use
130 this file except in compliance with the License. You can obtain a copy
131 in the file LICENSE in the source distribution or at
132 <https://www.openssl.org/source/license.html>.