| 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_GEN_MAC 3SSL" |
| 58 |
.TH PKCS12_GEN_MAC 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_gen_mac, PKCS12_setup_mac, PKCS12_set_mac, |
| 65 |
PKCS12_set_pbmac1_pbkdf2, PKCS12_verify_mac, PKCS12_get0_mac \- |
| 66 |
Functions to create and manipulate a PKCS#12 MAC structure |
| 67 |
.SH SYNOPSIS |
| 68 |
.IX Header "SYNOPSIS" |
| 69 |
.Vb 1 |
| 70 |
\& #include <openssl/pkcs12.h> |
| 71 |
\& |
| 72 |
\& int PKCS12_gen_mac(PKCS12 *p12, const char *pass, int passlen, |
| 73 |
\& unsigned char *mac, unsigned int *maclen); |
| 74 |
\& int PKCS12_verify_mac(PKCS12 *p12, const char *pass, int passlen); |
| 75 |
\& int PKCS12_set_mac(PKCS12 *p12, const char *pass, int passlen, |
| 76 |
\& unsigned char *salt, int saltlen, int iter, |
| 77 |
\& const EVP_MD *md_type); |
| 78 |
\& int PKCS12_set_pbmac1_pbkdf2(PKCS12 *p12, const char *pass, int passlen, |
| 79 |
\& unsigned char *salt, int saltlen, int iter, |
| 80 |
\& const EVP_MD *md_type, |
| 81 |
\& const char *prf_md_name); |
| 82 |
\& int PKCS12_setup_mac(PKCS12 *p12, int iter, unsigned char *salt, |
| 83 |
\& int saltlen, const EVP_MD *md_type); |
| 84 |
\& |
| 85 |
\& void PKCS12_get0_mac(const ASN1_OCTET_STRING **pmac, |
| 86 |
\& const X509_ALGOR **pmacalg, |
| 87 |
\& const ASN1_OCTET_STRING **psalt, |
| 88 |
\& const ASN1_INTEGER **piter, |
| 89 |
\& const PKCS12 *p12); |
| 90 |
.Ve |
| 91 |
.SH DESCRIPTION |
| 92 |
.IX Header "DESCRIPTION" |
| 93 |
\&\fBPKCS12_gen_mac()\fR generates an HMAC over the entire PKCS#12 object using the |
| 94 |
supplied password along with a set of already configured parameters. |
| 95 |
The default key generation mechanism used is PKCS12KDF. |
| 96 |
.PP |
| 97 |
\&\fBPKCS12_verify_mac()\fR verifies the PKCS#12 object's HMAC using the supplied |
| 98 |
password. |
| 99 |
.PP |
| 100 |
\&\fBPKCS12_setup_mac()\fR sets the MAC part of the PKCS#12 structure with the supplied |
| 101 |
parameters. |
| 102 |
.PP |
| 103 |
\&\fBPKCS12_set_mac()\fR sets the MAC and MAC parameters into the PKCS#12 object. |
| 104 |
\&\fBPKCS12_set_pbmac1_pbkdf2()\fR sets the MAC and MAC parameters into the PKCS#12 |
| 105 |
object when \fBPBMAC1\fR with PBKDF2 is used for protection of the PKCS#12 object. |
| 106 |
.PP |
| 107 |
\&\fIpass\fR is the passphrase to use in the HMAC. \fIsalt\fR is the salt value to use, |
| 108 |
\&\fIiter\fR is the iteration count and \fImd_type\fR is the message digest function to |
| 109 |
use. \fIprf_md_name\fR specifies the digest used for the PBKDF2 in PBMAC1 KDF. |
| 110 |
.PP |
| 111 |
\&\fBPKCS12_get0_mac()\fR retrieves any included MAC value, \fBX509_ALGOR\fR object, |
| 112 |
\&\fIsalt\fR, and \fIiter\fR count from the PKCS12 object. |
| 113 |
.SH NOTES |
| 114 |
.IX Header "NOTES" |
| 115 |
If \fIsalt\fR is NULL then a suitable salt will be generated and used. |
| 116 |
.PP |
| 117 |
If \fIiter\fR is 1 then an iteration count will be omitted from the PKCS#12 |
| 118 |
structure. |
| 119 |
.PP |
| 120 |
\&\fBPKCS12_gen_mac()\fR, \fBPKCS12_verify_mac()\fR, \fBPKCS12_set_mac()\fR and |
| 121 |
\&\fBPKCS12_set_pbmac1_pbkdf2()\fR make assumptions regarding the encoding of the |
| 122 |
given passphrase. See \fBpassphrase\-encoding\fR\|(7) for more information. |
| 123 |
.SH "RETURN VALUES" |
| 124 |
.IX Header "RETURN VALUES" |
| 125 |
All functions returning an integer return 1 on success and 0 if an error occurred. |
| 126 |
.SH ENVIRONMENT |
| 127 |
.IX Header "ENVIRONMENT" |
| 128 |
.IP \fBLEGACY_GOST_PKCS12\fR 4 |
| 129 |
.IX Item "LEGACY_GOST_PKCS12" |
| 130 |
If this environment variable is set, MAC generation that utilises |
| 131 |
GOST R 34.11\-94 or GOST 34.11\-2012 hashing algorithms is performed the usual |
| 132 |
way and not in accordance with the specification provided in the methodical |
| 133 |
recommendation MP 26.2.002\-2012 (or in its later versions, standardisation |
| 134 |
recommendation P 50.1.112\-2016 or P 1323565.1.041\-2022) |
| 135 |
of Technical Committee 26, that specifies that the key used for MAC |
| 136 |
generation should be the last 32 bytes of the 96\-byte sequence generated |
| 137 |
by \fBPKCS5_PBKDF2_HMAC\fR\|(3) and not the whole sequence. |
| 138 |
.SH "CONFORMING TO" |
| 139 |
.IX Header "CONFORMING TO" |
| 140 |
IETF RFC 7292 (<https://tools.ietf.org/html/rfc7292>) |
| 141 |
IETF RFC 9579 (<https://tools.ietf.org/html/rfc9579>) |
| 142 |
.SH "SEE ALSO" |
| 143 |
.IX Header "SEE ALSO" |
| 144 |
\&\fBd2i_PKCS12\fR\|(3), |
| 145 |
\&\fBEVP_KDF\-PKCS12KDF\fR\|(7), |
| 146 |
\&\fBPKCS12_create\fR\|(3), |
| 147 |
\&\fBpassphrase\-encoding\fR\|(7) |
| 148 |
.SH HISTORY |
| 149 |
.IX Header "HISTORY" |
| 150 |
The \fIPKCS12_set_pbmac1_pbkdf2\fR function was added in OpenSSL 3.4. |
| 151 |
.SH COPYRIGHT |
| 152 |
.IX Header "COPYRIGHT" |
| 153 |
Copyright 2021\-2025 The OpenSSL Project Authors. All Rights Reserved. |
| 154 |
.PP |
| 155 |
Licensed under the Apache License 2.0 (the "License"). You may not use |
| 156 |
this file except in compliance with the License. You can obtain a copy |
| 157 |
in the file LICENSE in the source distribution or at |
| 158 |
<https://www.openssl.org/source/license.html>. |