aboutsummaryrefslogtreecommitdiff
path: root/secure/lib/libcrypto/man/man3/PKCS12_decrypt_skey.3
diff options
context:
space:
mode:
Diffstat (limited to 'secure/lib/libcrypto/man/man3/PKCS12_decrypt_skey.3')
-rw-r--r--secure/lib/libcrypto/man/man3/PKCS12_decrypt_skey.3110
1 files changed, 110 insertions, 0 deletions
diff --git a/secure/lib/libcrypto/man/man3/PKCS12_decrypt_skey.3 b/secure/lib/libcrypto/man/man3/PKCS12_decrypt_skey.3
new file mode 100644
index 000000000000..31ee41c1c8fc
--- /dev/null
+++ b/secure/lib/libcrypto/man/man3/PKCS12_decrypt_skey.3
@@ -0,0 +1,110 @@
+.\" -*- mode: troff; coding: utf-8 -*-
+.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
+.\"
+.\" Standard preamble:
+.\" ========================================================================
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Vb \" Begin verbatim text
+.ft CW
+.nf
+.ne \\$1
+..
+.de Ve \" End verbatim text
+.ft R
+.fi
+..
+.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
+.ie n \{\
+. ds C` ""
+. ds C' ""
+'br\}
+.el\{\
+. ds C`
+. ds C'
+'br\}
+.\"
+.\" Escape single quotes in literal strings from groff's Unicode transform.
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\"
+.\" If the F register is >0, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
+.\" entries marked with X<> in POD. Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
+.\"
+.\" Avoid warning from groff about undefined register 'F'.
+.de IX
+..
+.nr rF 0
+.if \n(.g .if rF .nr rF 1
+.if (\n(rF:(\n(.g==0)) \{\
+. if \nF \{\
+. de IX
+. tm Index:\\$1\t\\n%\t"\\$2"
+..
+. if !\nF==2 \{\
+. nr % 0
+. nr F 2
+. \}
+. \}
+.\}
+.rr rF
+.\"
+.\" Required to disable full justification in groff 1.23.0.
+.if n .ds AD l
+.\" ========================================================================
+.\"
+.IX Title "PKCS12_DECRYPT_SKEY 3ossl"
+.TH PKCS12_DECRYPT_SKEY 3ossl 2026-04-07 3.5.6 OpenSSL
+.\" For nroff, turn off justification. Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.if n .ad l
+.nh
+.SH NAME
+PKCS12_decrypt_skey, PKCS12_decrypt_skey_ex \- PKCS12 shrouded keyBag
+decrypt functions
+.SH SYNOPSIS
+.IX Header "SYNOPSIS"
+.Vb 1
+\& #include <openssl/pkcs12.h>
+\&
+\& PKCS8_PRIV_KEY_INFO *PKCS12_decrypt_skey(const PKCS12_SAFEBAG *bag,
+\& const char *pass, int passlen);
+\& PKCS8_PRIV_KEY_INFO *PKCS12_decrypt_skey_ex(const PKCS12_SAFEBAG *bag,
+\& const char *pass, int passlen,
+\& OSSL_LIB_CTX *ctx,
+\& const char *propq);
+.Ve
+.SH DESCRIPTION
+.IX Header "DESCRIPTION"
+\&\fBPKCS12_decrypt_skey()\fR Decrypt the PKCS#8 shrouded keybag contained within \fIbag\fR
+using the supplied password \fIpass\fR of length \fIpasslen\fR.
+.PP
+\&\fBPKCS12_decrypt_skey_ex()\fR is similar to the above but allows for a library context
+\&\fIctx\fR and property query \fIpropq\fR to be used to select algorithm implementations.
+.SH "RETURN VALUES"
+.IX Header "RETURN VALUES"
+Both functions will return the decrypted key or NULL if an error occurred.
+.SH "CONFORMING TO"
+.IX Header "CONFORMING TO"
+IETF RFC 7292 (<https://tools.ietf.org/html/rfc7292>)
+.SH "SEE ALSO"
+.IX Header "SEE ALSO"
+\&\fBPKCS8_decrypt_ex\fR\|(3),
+\&\fBPKCS8_encrypt_ex\fR\|(3),
+\&\fBPKCS12_add_key_ex\fR\|(3),
+\&\fBPKCS12_SAFEBAG_create_pkcs8_encrypt_ex\fR\|(3)
+.SH HISTORY
+.IX Header "HISTORY"
+\&\fBPKCS12_decrypt_skey_ex()\fR was added in OpenSSL 3.0.
+.SH COPYRIGHT
+.IX Header "COPYRIGHT"
+Copyright 2021\-2022 The OpenSSL Project Authors. All Rights Reserved.
+.PP
+Licensed under the Apache License 2.0 (the "License"). You may not use
+this file except in compliance with the License. You can obtain a copy
+in the file LICENSE in the source distribution or at
+<https://www.openssl.org/source/license.html>.