Debian Codegraph @

upstream/debian-unstable/man3/d2i_PKCS8PrivateKey_bio.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 "D2I_PKCS8PRIVATEKEY_BIO 3SSL"
58 .TH D2I_PKCS8PRIVATEKEY_BIO 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 d2i_PKCS8PrivateKey_bio, d2i_PKCS8PrivateKey_fp,
65 i2d_PKCS8PrivateKey_bio, i2d_PKCS8PrivateKey_fp,
66 i2d_PKCS8PrivateKey_nid_bio, i2d_PKCS8PrivateKey_nid_fp \- PKCS#8 format private key functions
67 .SH SYNOPSIS
68 .IX Header "SYNOPSIS"
69 .Vb 1
70 \& #include <openssl/pem.h>
71 \&
72 \& EVP_PKEY *d2i_PKCS8PrivateKey_bio(BIO *bp, EVP_PKEY **x, pem_password_cb *cb, void *u);
73 \& EVP_PKEY *d2i_PKCS8PrivateKey_fp(FILE *fp, EVP_PKEY **x, pem_password_cb *cb, void *u);
74 \&
75 \& int i2d_PKCS8PrivateKey_bio(BIO *bp, const EVP_PKEY *x, const EVP_CIPHER *enc,
76 \& char *kstr, int klen,
77 \& pem_password_cb *cb, void *u);
78 \&
79 \& int i2d_PKCS8PrivateKey_fp(FILE *fp, const EVP_PKEY *x, const EVP_CIPHER *enc,
80 \& char *kstr, int klen,
81 \& pem_password_cb *cb, void *u);
82 \&
83 \& int i2d_PKCS8PrivateKey_nid_bio(BIO *bp, const EVP_PKEY *x, int nid,
84 \& char *kstr, int klen,
85 \& pem_password_cb *cb, void *u);
86 \&
87 \& int i2d_PKCS8PrivateKey_nid_fp(FILE *fp, const EVP_PKEY *x, int nid,
88 \& char *kstr, int klen,
89 \& pem_password_cb *cb, void *u);
90 .Ve
91 .SH DESCRIPTION
92 .IX Header "DESCRIPTION"
93 The PKCS#8 functions encode and decode private keys in PKCS#8 format using both
94 PKCS#5 v1.5 and PKCS#5 v2.0 password based encryption algorithms.
95 .PP
96 Other than the use of DER as opposed to PEM these functions are identical to the
97 corresponding \fBPEM\fR function as described in \fBPEM_read_PrivateKey\fR\|(3).
98 .SH NOTES
99 .IX Header "NOTES"
100 These functions are currently the only way to store encrypted private keys using DER format.
101 .PP
102 Currently all the functions use BIOs or FILE pointers, there are no functions
103 which support password-protection and work directly on memory: this can be
104 readily worked around by converting the buffers to memory BIOs, see
105 \&\fBBIO_s_mem\fR\|(3) for details.
106 If password-protection is not required, the \fBi2d_PKCS8PrivateKey\fR\|(3) function
107 encodes a private key to an unencrypted DER \fBPKCS#8\fR form.
108 .PP
109 These functions make no assumption regarding the pass phrase received from the
110 password callback.
111 It will simply be treated as a byte sequence.
112 .SH "RETURN VALUES"
113 .IX Header "RETURN VALUES"
114 \&\fBd2i_PKCS8PrivateKey_bio()\fR and \fBd2i_PKCS8PrivateKey_fp()\fR return a valid \fBEVP_PKEY\fR
115 structure or NULL if an error occurred.
116 .PP
117 \&\fBi2d_PKCS8PrivateKey_bio()\fR, \fBi2d_PKCS8PrivateKey_fp()\fR, \fBi2d_PKCS8PrivateKey_nid_bio()\fR
118 and \fBi2d_PKCS8PrivateKey_nid_fp()\fR return 1 on success or 0 on error.
119 .SH "SEE ALSO"
120 .IX Header "SEE ALSO"
121 \&\fBi2d_PKCS8PrivateKey\fR\|(3),
122 \&\fBPEM_read_PrivateKey\fR\|(3),
123 \&\fBpassphrase\-encoding\fR\|(7)
124 .SH HISTORY
125 .IX Header "HISTORY"
126 \&\fBi2d_PKCS8PrivateKey\fR\|(3) was added in OpenSSL 3.6.
127 .SH COPYRIGHT
128 .IX Header "COPYRIGHT"
129 Copyright 2002\-2025 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>.