Debian Codegraph @

upstream/debian-unstable/man3/PKCS8_encrypt.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 "PKCS8_ENCRYPT 3SSL"
58 .TH PKCS8_ENCRYPT 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 PKCS8_decrypt, PKCS8_decrypt_ex, PKCS8_encrypt, PKCS8_encrypt_ex,
65 PKCS8_set0_pbe, PKCS8_set0_pbe_ex \- PKCS8 encrypt/decrypt functions
66 .SH SYNOPSIS
67 .IX Header "SYNOPSIS"
68 .Vb 1
69 \& #include <openssl/x509.h>
70 \&
71 \& PKCS8_PRIV_KEY_INFO *PKCS8_decrypt(const X509_SIG *p8, const char *pass,
72 \& int passlen);
73 \& PKCS8_PRIV_KEY_INFO *PKCS8_decrypt_ex(const X509_SIG *p8, const char *pass,
74 \& int passlen, OSSL_LIB_CTX *ctx,
75 \& const char *propq);
76 \& X509_SIG *PKCS8_encrypt(int pbe_nid, const EVP_CIPHER *cipher,
77 \& const char *pass, int passlen, unsigned char *salt,
78 \& int saltlen, int iter, PKCS8_PRIV_KEY_INFO *p8);
79 \& X509_SIG *PKCS8_encrypt_ex(int pbe_nid, const EVP_CIPHER *cipher,
80 \& const char *pass, int passlen, unsigned char *salt,
81 \& int saltlen, int iter, PKCS8_PRIV_KEY_INFO *p8,
82 \& OSSL_LIB_CTX *ctx, const char *propq);
83 \& X509_SIG *PKCS8_set0_pbe(const char *pass, int passlen,
84 \& PKCS8_PRIV_KEY_INFO *p8inf, X509_ALGOR *pbe);
85 \& X509_SIG *PKCS8_set0_pbe_ex(const char *pass, int passlen,
86 \& PKCS8_PRIV_KEY_INFO *p8inf, X509_ALGOR *pbe,
87 \& OSSL_LIB_CTX *ctx);
88 .Ve
89 .SH DESCRIPTION
90 .IX Header "DESCRIPTION"
91 \&\fBPKCS8_encrypt()\fR and \fBPKCS8_encrypt_ex()\fR perform encryption of an object \fIp8\fR using
92 the password \fIpass\fR of length \fIpasslen\fR, salt \fIsalt\fR of length \fIsaltlen\fR
93 and iteration count \fIiter\fR.
94 The resulting \fBX509_SIG\fR contains the encoded algorithm parameters and encrypted
95 key.
96 .PP
97 \&\fBPKCS8_decrypt()\fR and \fBPKCS8_decrypt_ex()\fR perform decryption of an \fBX509_SIG\fR in
98 \&\fIp8\fR using the password \fIpass\fR of length \fIpasslen\fR along with algorithm
99 parameters obtained from the \fIp8\fR.
100 .PP
101 \&\fBPKCS8_set0_pbe()\fR and \fBPKCS8_set0_pbe_ex()\fR perform encryption of the \fIp8inf\fR
102 using the password \fIpass\fR of length \fIpasslen\fR and parameters \fIpbe\fR.
103 .PP
104 Functions ending in \fB_ex()\fR allow for a library context \fIctx\fR and property query
105 \&\fIpropq\fR to be used to select algorithm implementations.
106 .SH "RETURN VALUES"
107 .IX Header "RETURN VALUES"
108 \&\fBPKCS8_encrypt()\fR, \fBPKCS8_encrypt_ex()\fR, \fBPKCS8_set0_pbe()\fR and \fBPKCS8_set0_pbe_ex()\fR
109 return an encrypted key in a \fBX509_SIG\fR structure or NULL if an error occurs.
110 .PP
111 \&\fBPKCS8_decrypt()\fR and \fBPKCS8_decrypt_ex()\fR return a \fBPKCS8_PRIV_KEY_INFO\fR or NULL
112 if an error occurs.
113 .SH "CONFORMING TO"
114 .IX Header "CONFORMING TO"
115 IETF RFC 7292 (<https://tools.ietf.org/html/rfc7292>)
116 .SH "SEE ALSO"
117 .IX Header "SEE ALSO"
118 \&\fBcrypto\fR\|(7)
119 .SH HISTORY
120 .IX Header "HISTORY"
121 \&\fBPKCS8_decrypt_ex()\fR, \fBPKCS8_encrypt_ex()\fR and \fBPKCS8_set0_pbe_ex()\fR were added in
122 OpenSSL 3.0.
123 .SH COPYRIGHT
124 .IX Header "COPYRIGHT"
125 Copyright 2021 The OpenSSL Project Authors. All Rights Reserved.
126 .PP
127 Licensed under the Apache License 2.0 (the "License"). You may not use
128 this file except in compliance with the License. You can obtain a copy
129 in the file LICENSE in the source distribution or at
130 <https://www.openssl.org/source/license.html>.