aboutsummaryrefslogtreecommitdiff
path: root/secure/lib/libcrypto/man/man3/PKCS12_gen_mac.3
diff options
context:
space:
mode:
Diffstat (limited to 'secure/lib/libcrypto/man/man3/PKCS12_gen_mac.3')
-rw-r--r--secure/lib/libcrypto/man/man3/PKCS12_gen_mac.3152
1 files changed, 48 insertions, 104 deletions
diff --git a/secure/lib/libcrypto/man/man3/PKCS12_gen_mac.3 b/secure/lib/libcrypto/man/man3/PKCS12_gen_mac.3
index 5cef6fb77747..4049e5b5c547 100644
--- a/secure/lib/libcrypto/man/man3/PKCS12_gen_mac.3
+++ b/secure/lib/libcrypto/man/man3/PKCS12_gen_mac.3
@@ -1,4 +1,5 @@
-.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
+.\" -*- mode: troff; coding: utf-8 -*-
+.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
@@ -15,29 +16,12 @@
.ft R
.fi
..
-.\" Set up some character translations and predefined strings. \*(-- will
-.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
-.\" double quote, and \*(R" will give a right double quote. \*(C+ will
-.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
-.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
-.\" nothing in troff, for use with C<>.
-.tr \(*W-
-.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
+.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
-. ds -- \(*W-
-. ds PI pi
-. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
-. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
-. ds L" ""
-. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
-. ds -- \|\(em\|
-. ds PI \(*p
-. ds L" ``
-. ds R" ''
. ds C`
. ds C'
'br\}
@@ -68,78 +52,19 @@
. \}
.\}
.rr rF
-.\" Fear. Run. Save yourself. No user-serviceable parts.
-. \" fudge factors for nroff and troff
-.if n \{\
-. ds #H 0
-. ds #V .8m
-. ds #F .3m
-. ds #[ \f1
-. ds #] \fP
-.\}
-.if t \{\
-. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
-. ds #V .6m
-. ds #F 0
-. ds #[ \&
-. ds #] \&
-.\}
-. \" simple accents for nroff and troff
-.if n \{\
-. ds ' \&
-. ds ` \&
-. ds ^ \&
-. ds , \&
-. ds ~ ~
-. ds /
-.\}
-.if t \{\
-. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
-. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
-. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
-. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
-. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
-. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
-.\}
-. \" troff and (daisy-wheel) nroff accents
-.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
-.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
-.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
-.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
-.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
-.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
-.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
-.ds ae a\h'-(\w'a'u*4/10)'e
-.ds Ae A\h'-(\w'A'u*4/10)'E
-. \" corrections for vroff
-.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
-.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
-. \" for low resolution devices (crt and lpr)
-.if \n(.H>23 .if \n(.V>19 \
-\{\
-. ds : e
-. ds 8 ss
-. ds o a
-. ds d- d\h'-1'\(ga
-. ds D- D\h'-1'\(hy
-. ds th \o'bp'
-. ds Th \o'LP'
-. ds ae ae
-. ds Ae AE
-.\}
-.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "PKCS12_GEN_MAC 3ossl"
-.TH PKCS12_GEN_MAC 3ossl "2023-09-19" "3.0.11" "OpenSSL"
+.TH PKCS12_GEN_MAC 3ossl 2025-07-01 3.5.1 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"
+.SH NAME
PKCS12_gen_mac, PKCS12_setup_mac, PKCS12_set_mac,
-PKCS12_verify_mac \- Functions to create and manipulate a PKCS#12 structure
-.SH "SYNOPSIS"
+PKCS12_set_pbmac1_pbkdf2, PKCS12_verify_mac, PKCS12_get0_mac \-
+Functions to create and manipulate a PKCS#12 MAC structure
+.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\& #include <openssl/pkcs12.h>
@@ -150,53 +75,72 @@ PKCS12_verify_mac \- Functions to create and manipulate a PKCS#12 structure
\& int PKCS12_set_mac(PKCS12 *p12, const char *pass, int passlen,
\& unsigned char *salt, int saltlen, int iter,
\& const EVP_MD *md_type);
+\& int PKCS12_set_pbmac1_pbkdf2(PKCS12 *p12, const char *pass, int passlen,
+\& unsigned char *salt, int saltlen, int iter,
+\& const EVP_MD *md_type,
+\& const char *prf_md_name);
\& int PKCS12_setup_mac(PKCS12 *p12, int iter, unsigned char *salt,
\& int saltlen, const EVP_MD *md_type);
+\&
+\& void PKCS12_get0_mac(const ASN1_OCTET_STRING **pmac,
+\& const X509_ALGOR **pmacalg,
+\& const ASN1_OCTET_STRING **psalt,
+\& const ASN1_INTEGER **piter,
+\& const PKCS12 *p12);
.Ve
-.SH "DESCRIPTION"
+.SH DESCRIPTION
.IX Header "DESCRIPTION"
-\&\fBPKCS12_gen_mac()\fR generates an \s-1HMAC\s0 over the entire PKCS#12 object using the
+\&\fBPKCS12_gen_mac()\fR generates an HMAC over the entire PKCS#12 object using the
supplied password along with a set of already configured parameters.
-The default key generation mechanism used is \s-1PKCS12KDF.\s0
+The default key generation mechanism used is PKCS12KDF.
.PP
-\&\fBPKCS12_verify_mac()\fR verifies the PKCS#12 object's \s-1HMAC\s0 using the supplied
+\&\fBPKCS12_verify_mac()\fR verifies the PKCS#12 object's HMAC using the supplied
password.
.PP
-\&\fBPKCS12_setup_mac()\fR sets the \s-1MAC\s0 part of the PKCS#12 structure with the supplied
+\&\fBPKCS12_setup_mac()\fR sets the MAC part of the PKCS#12 structure with the supplied
parameters.
.PP
-\&\fBPKCS12_set_mac()\fR sets the \s-1MAC\s0 and \s-1MAC\s0 parameters into the PKCS#12 object.
+\&\fBPKCS12_set_mac()\fR sets the MAC and MAC parameters into the PKCS#12 object.
+\&\fBPKCS12_set_pbmac1_pbkdf2()\fR sets the MAC and MAC parameters into the PKCS#12
+object when \fBPBMAC1\fR with PBKDF2 is used for protection of the PKCS#12 object.
+.PP
+\&\fIpass\fR is the passphrase to use in the HMAC. \fIsalt\fR is the salt value to use,
+\&\fIiter\fR is the iteration count and \fImd_type\fR is the message digest function to
+use. \fIprf_md_name\fR specifies the digest used for the PBKDF2 in PBMAC1 KDF.
.PP
-\&\fIpass\fR is the passphrase to use in the \s-1HMAC.\s0 \fIsalt\fR is the salt value to use,
-\&\fIiter\fR is the iteration count and \fImd_type\fR is the message digest
-function to use.
-.SH "NOTES"
+\&\fBPKCS12_get0_mac()\fR retrieves any included MAC value, \fBX509_ALGOR\fR object,
+\&\fIsalt\fR, and \fIiter\fR count from the PKCS12 object.
+.SH NOTES
.IX Header "NOTES"
-If \fIsalt\fR is \s-1NULL\s0 then a suitable salt will be generated and used.
+If \fIsalt\fR is NULL then a suitable salt will be generated and used.
.PP
If \fIiter\fR is 1 then an iteration count will be omitted from the PKCS#12
structure.
.PP
-\&\fBPKCS12_gen_mac()\fR, \fBPKCS12_verify_mac()\fR and \fBPKCS12_set_mac()\fR make assumptions
-regarding the encoding of the given passphrase. See \fBpassphrase\-encoding\fR\|(7)
-for more information.
+\&\fBPKCS12_gen_mac()\fR, \fBPKCS12_verify_mac()\fR, \fBPKCS12_set_mac()\fR and
+\&\fBPKCS12_set_pbmac1_pbkdf2()\fR make assumptions regarding the encoding of the
+given passphrase. See \fBpassphrase\-encoding\fR\|(7) for more information.
.SH "RETURN VALUES"
.IX Header "RETURN VALUES"
-All functions return 1 on success and 0 if an error occurred.
+All functions returning an integer return 1 on success and 0 if an error occurred.
.SH "CONFORMING TO"
.IX Header "CONFORMING TO"
-\&\s-1IETF RFC 7292\s0 (<https://tools.ietf.org/html/rfc7292>)
+IETF RFC 7292 (<https://tools.ietf.org/html/rfc7292>)
+IETF RFC 9579 (<https://tools.ietf.org/html/rfc9579>)
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBd2i_PKCS12\fR\|(3),
-\&\s-1\fBEVP_KDF\-PKCS12KDF\s0\fR\|(7),
+\&\fBEVP_KDF\-PKCS12KDF\fR\|(7),
\&\fBPKCS12_create\fR\|(3),
\&\fBpassphrase\-encoding\fR\|(7)
-.SH "COPYRIGHT"
+.SH HISTORY
+.IX Header "HISTORY"
+The \fIPKCS12_set_pbmac1_pbkdf2\fR function was added in OpenSSL 3.4.
+.SH COPYRIGHT
.IX Header "COPYRIGHT"
-Copyright 2021\-2023 The OpenSSL Project Authors. All Rights Reserved.
+Copyright 2021\-2024 The OpenSSL Project Authors. All Rights Reserved.
.PP
-Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use
+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 \s-1LICENSE\s0 in the source distribution or at
+in the file LICENSE in the source distribution or at
<https://www.openssl.org/source/license.html>.
generated by cgit v1.2.3 (git 2.25.1) at 2025-08-13 14:55:02 +0000