Debian Codegraph @

upstream/debian-unstable/man3/PKCS12_decrypt_skey.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_DECRYPT_SKEY 3SSL"
58 .TH PKCS12_DECRYPT_SKEY 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_decrypt_skey, PKCS12_decrypt_skey_ex \- PKCS12 shrouded keyBag
65 decrypt functions
66 .SH SYNOPSIS
67 .IX Header "SYNOPSIS"
68 .Vb 1
69 \& #include <openssl/pkcs12.h>
70 \&
71 \& PKCS8_PRIV_KEY_INFO *PKCS12_decrypt_skey(const PKCS12_SAFEBAG *bag,
72 \& const char *pass, int passlen);
73 \& PKCS8_PRIV_KEY_INFO *PKCS12_decrypt_skey_ex(const PKCS12_SAFEBAG *bag,
74 \& const char *pass, int passlen,
75 \& OSSL_LIB_CTX *ctx,
76 \& const char *propq);
77 .Ve
78 .SH DESCRIPTION
79 .IX Header "DESCRIPTION"
80 \&\fBPKCS12_decrypt_skey()\fR Decrypt the PKCS#8 shrouded keybag contained within \fIbag\fR
81 using the supplied password \fIpass\fR of length \fIpasslen\fR.
82 .PP
83 \&\fBPKCS12_decrypt_skey_ex()\fR is similar to the above but allows for a library context
84 \&\fIctx\fR and property query \fIpropq\fR to be used to select algorithm implementations.
85 .SH "RETURN VALUES"
86 .IX Header "RETURN VALUES"
87 Both functions will return the decrypted key or NULL if an error occurred.
88 .SH "CONFORMING TO"
89 .IX Header "CONFORMING TO"
90 IETF RFC 7292 (<https://tools.ietf.org/html/rfc7292>)
91 .SH "SEE ALSO"
92 .IX Header "SEE ALSO"
93 \&\fBPKCS8_decrypt_ex\fR\|(3),
94 \&\fBPKCS8_encrypt_ex\fR\|(3),
95 \&\fBPKCS12_add_key_ex\fR\|(3),
96 \&\fBPKCS12_SAFEBAG_create_pkcs8_encrypt_ex\fR\|(3)
97 .SH HISTORY
98 .IX Header "HISTORY"
99 \&\fBPKCS12_decrypt_skey_ex()\fR was added in OpenSSL 3.0.
100 .SH COPYRIGHT
101 .IX Header "COPYRIGHT"
102 Copyright 2021\-2022 The OpenSSL Project Authors. All Rights Reserved.
103 .PP
104 Licensed under the Apache License 2.0 (the "License"). You may not use
105 this file except in compliance with the License. You can obtain a copy
106 in the file LICENSE in the source distribution or at
107 <https://www.openssl.org/source/license.html>.