| 1 | =pod
|
|---|
| 2 |
|
|---|
| 3 | =head1 NAME
|
|---|
| 4 |
|
|---|
| 5 | PKCS12_PBE_keyivgen, PKCS12_PBE_keyivgen_ex,
|
|---|
| 6 | PKCS12_pbe_crypt, PKCS12_pbe_crypt_ex - PKCS#12 Password based encryption
|
|---|
| 7 |
|
|---|
| 8 | =head1 SYNOPSIS
|
|---|
| 9 |
|
|---|
| 10 | #include <openssl/evp.h>
|
|---|
| 11 |
|
|---|
| 12 | int PKCS12_PBE_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass, int passlen,
|
|---|
| 13 | ASN1_TYPE *param, const EVP_CIPHER *cipher,
|
|---|
| 14 | const EVP_MD *md_type, int en_de);
|
|---|
| 15 | int PKCS12_PBE_keyivgen_ex(EVP_CIPHER_CTX *ctx, const char *pass, int passlen,
|
|---|
| 16 | ASN1_TYPE *param, const EVP_CIPHER *cipher,
|
|---|
| 17 | const EVP_MD *md_type, int en_de,
|
|---|
| 18 | OSSL_LIB_CTX *libctx, const char *propq);
|
|---|
| 19 | unsigned char *PKCS12_pbe_crypt(const X509_ALGOR *algor,
|
|---|
| 20 | const char *pass, int passlen,
|
|---|
| 21 | const unsigned char *in, int inlen,
|
|---|
| 22 | unsigned char **data, int *datalen,
|
|---|
| 23 | int en_de);
|
|---|
| 24 | unsigned char *PKCS12_pbe_crypt_ex(const X509_ALGOR *algor,
|
|---|
| 25 | const char *pass, int passlen,
|
|---|
| 26 | const unsigned char *in, int inlen,
|
|---|
| 27 | unsigned char **data, int *datalen,
|
|---|
| 28 | int en_de, OSSL_LIB_CTX *libctx,
|
|---|
| 29 | const char *propq);
|
|---|
| 30 |
|
|---|
| 31 | =head1 DESCRIPTION
|
|---|
| 32 |
|
|---|
| 33 | PKCS12_PBE_keyivgen() and PKCS12_PBE_keyivgen_ex() take a password I<pass> of
|
|---|
| 34 | length I<passlen>, parameters I<param> and a message digest function I<md_type>
|
|---|
| 35 | and perform a key derivation according to PKCS#12. The resulting key is
|
|---|
| 36 | then used to initialise the cipher context I<ctx> with a cipher I<cipher> for
|
|---|
| 37 | encryption (I<en_de>=1) or decryption (I<en_de>=0).
|
|---|
| 38 |
|
|---|
| 39 | PKCS12_PBE_keyivgen_ex() also allows the application to specify a library context
|
|---|
| 40 | I<libctx> and property query I<propq> to select appropriate algorithm
|
|---|
| 41 | implementations.
|
|---|
| 42 |
|
|---|
| 43 | PKCS12_pbe_crypt() and PKCS12_pbe_crypt_ex() will encrypt or decrypt a buffer
|
|---|
| 44 | based on the algorithm in I<algor> and password I<pass> of length I<passlen>.
|
|---|
| 45 | The input is from I<in> of length I<inlen> and output is into a malloc'd buffer
|
|---|
| 46 | returned in I<*data> of length I<datalen>. The operation is determined by I<en_de>,
|
|---|
| 47 | encryption (I<en_de>=1) or decryption (I<en_de>=0).
|
|---|
| 48 |
|
|---|
| 49 | PKCS12_pbe_crypt_ex() allows the application to specify a library context
|
|---|
| 50 | I<libctx> and property query I<propq> to select appropriate algorithm
|
|---|
| 51 | implementations.
|
|---|
| 52 |
|
|---|
| 53 | I<pass> is the password used in the derivation of length I<passlen>. I<pass>
|
|---|
| 54 | is an optional parameter and can be NULL. If I<passlen> is -1, then the
|
|---|
| 55 | function will calculate the length of I<pass> using strlen().
|
|---|
| 56 |
|
|---|
| 57 | I<salt> is the salt used in the derivation of length I<saltlen>. If the
|
|---|
| 58 | I<salt> is NULL, then I<saltlen> must be 0. The function will not
|
|---|
| 59 | attempt to calculate the length of the I<salt> because it is not assumed to
|
|---|
| 60 | be NULL terminated.
|
|---|
| 61 |
|
|---|
| 62 | I<iter> is the iteration count and its value should be greater than or
|
|---|
| 63 | equal to 1. RFC 2898 suggests an iteration count of at least 1000. Any
|
|---|
| 64 | I<iter> less than 1 is treated as a single iteration.
|
|---|
| 65 |
|
|---|
| 66 | I<digest> is the message digest function used in the derivation.
|
|---|
| 67 |
|
|---|
| 68 | Functions ending in _ex() take optional parameters I<libctx> and I<propq> which
|
|---|
| 69 | are used to select appropriate algorithm implementations.
|
|---|
| 70 |
|
|---|
| 71 | =head1 NOTES
|
|---|
| 72 |
|
|---|
| 73 | The functions are typically used in PKCS#12 to encrypt objects.
|
|---|
| 74 |
|
|---|
| 75 | These functions make no assumption regarding the given password.
|
|---|
| 76 | It will simply be treated as a byte sequence.
|
|---|
| 77 |
|
|---|
| 78 | =head1 RETURN VALUES
|
|---|
| 79 |
|
|---|
| 80 | PKCS12_PBE_keyivgen(), PKCS12_PBE_keyivgen_ex() return 1 on success or 0 on error.
|
|---|
| 81 |
|
|---|
| 82 | PKCS12_pbe_crypt() and PKCS12_pbe_crypt_ex() return a buffer containing the
|
|---|
| 83 | output or NULL if an error occurred.
|
|---|
| 84 |
|
|---|
| 85 | =head1 CONFORMING TO
|
|---|
| 86 |
|
|---|
| 87 | IETF RFC 7292 (L<https://tools.ietf.org/html/rfc7292>)
|
|---|
| 88 |
|
|---|
| 89 | =head1 SEE ALSO
|
|---|
| 90 |
|
|---|
| 91 | L<EVP_PBE_CipherInit_ex(3)>,
|
|---|
| 92 | L<PKCS8_encrypt_ex(3)>,
|
|---|
| 93 | L<passphrase-encoding(7)>
|
|---|
| 94 |
|
|---|
| 95 | =head1 HISTORY
|
|---|
| 96 |
|
|---|
| 97 | PKCS12_PBE_keyivgen_ex() and PKCS12_pbe_crypt_ex() were added in OpenSSL 3.0.
|
|---|
| 98 |
|
|---|
| 99 | =head1 COPYRIGHT
|
|---|
| 100 |
|
|---|
| 101 | Copyright 2014-2021 The OpenSSL Project Authors. All Rights Reserved.
|
|---|
| 102 |
|
|---|
| 103 | Licensed under the Apache License 2.0 (the "License"). You may not use
|
|---|
| 104 | this file except in compliance with the License. You can obtain a copy
|
|---|
| 105 | in the file LICENSE in the source distribution or at
|
|---|
| 106 | L<https://www.openssl.org/source/license.html>.
|
|---|
| 107 |
|
|---|
| 108 | =cut
|
|---|
