libcrypto/man/PKCS12_PBE_keyivgen.3

 $NetBSD: PKCS12_PBE_keyivgen.3,v 1.5 2026/04/08 17:06:46 christos Exp $

 -*- mode: troff; coding: utf-8 -*-
 Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)

 Standard preamble:
 ========================================================================
..
..

..
 \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` ""
. ds C' ""
'br\}
. ds C`
. ds C'
'br\}

 Escape single quotes in literal strings from groff's Unicode transform.

 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'.
..
.nr rF 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.
 ========================================================================

 Title "PKCS12_PBE_keyivgen 3"  PKCS12_PBE_keyivgen 3 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.
.nh
 NAME
PKCS12_PBE_keyivgen, PKCS12_PBE_keyivgen_ex,
PKCS12_pbe_crypt, PKCS12_pbe_crypt_ex - PKCS#12 Password based encryption
 SYNOPSIS
 Header "SYNOPSIS" .Vb 1
 #include <openssl/evp.h>
\&
 int PKCS12_PBE_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass, int passlen,
  ASN1_TYPE *param, const EVP_CIPHER *cipher,
  const EVP_MD *md_type, int en_de);
 int PKCS12_PBE_keyivgen_ex(EVP_CIPHER_CTX *ctx, const char *pass, int passlen,
  ASN1_TYPE *param, const EVP_CIPHER *cipher,
  const EVP_MD *md_type, int en_de,
  OSSL_LIB_CTX *libctx, const char *propq);
 unsigned char *PKCS12_pbe_crypt(const X509_ALGOR *algor,
  const char *pass, int passlen,
  const unsigned char *in, int inlen,
  unsigned char **data, int *datalen,
  int en_de);
 unsigned char *PKCS12_pbe_crypt_ex(const X509_ALGOR *algor,
  const char *pass, int passlen,
  const unsigned char *in, int inlen,
  unsigned char **data, int *datalen,
  int en_de, OSSL_LIB_CTX *libctx,
  const char *propq);
.Ve
 DESCRIPTION
 Header "DESCRIPTION" \fBPKCS12_PBE_keyivgen() and PKCS12_PBE_keyivgen_ex() take a password pass of
length passlen, parameters param and a message digest function md_type
and perform a key derivation according to PKCS#12. The resulting key is
then used to initialise the cipher context ctx with a cipher cipher for
encryption (en_de=1) or decryption (en_de=0).

\fBPKCS12_PBE_keyivgen_ex() also allows the application to specify a library context
\fIlibctx and property query propq to select appropriate algorithm
implementations.

\fBPKCS12_pbe_crypt() and PKCS12_pbe_crypt_ex() will encrypt or decrypt a buffer
based on the algorithm in algor and password pass of length passlen.
The input is from in of length inlen and output is into a malloc\*(Aqd buffer
returned in *data of length datalen. The operation is determined by en_de,
encryption (en_de=1) or decryption (en_de=0).

\fBPKCS12_pbe_crypt_ex() allows the application to specify a library context
\fIlibctx and property query propq to select appropriate algorithm
implementations.

\fIpass is the password used in the derivation of length passlen. pass
is an optional parameter and can be NULL. If passlen is -1, then the
function will calculate the length of pass using strlen().

\fIsalt is the salt used in the derivation of length saltlen. If the
\fIsalt is NULL, then saltlen must be 0. The function will not
attempt to calculate the length of the salt because it is not assumed to
be NULL terminated.

\fIiter is the iteration count and its value should be greater than or
equal to 1. RFC 2898 suggests an iteration count of at least 1000. Any
\fIiter less than 1 is treated as a single iteration.

\fIdigest is the message digest function used in the derivation.

Functions ending in _ex() take optional parameters libctx and propq which
are used to select appropriate algorithm implementations.
 NOTES
 Header "NOTES" The functions are typically used in PKCS#12 to encrypt objects.

These functions make no assumption regarding the given password.
It will simply be treated as a byte sequence.
 "RETURN VALUES"
 Header "RETURN VALUES" \fBPKCS12_PBE_keyivgen(), PKCS12_PBE_keyivgen_ex() return 1 on success or 0 on error.

\fBPKCS12_pbe_crypt() and PKCS12_pbe_crypt_ex() return a buffer containing the
output or NULL if an error occurred.
 "CONFORMING TO"
 Header "CONFORMING TO" IETF RFC 7292 (<https://tools.ietf.org/html/rfc7292>)
 "SEE ALSO"
 Header "SEE ALSO" \fBEVP_PBE_CipherInit_ex\|(3),
\fBPKCS8_encrypt_ex\|(3),
\fBpassphrase-encoding\|(7)
 HISTORY
 Header "HISTORY" \fBPKCS12_PBE_keyivgen_ex() and PKCS12_pbe_crypt_ex() were added in OpenSSL 3.0.
 COPYRIGHT
 Header "COPYRIGHT" Copyright 2014-2021 The OpenSSL Project Authors. All Rights Reserved.

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>.