sdk/include/reactos/libs/mbedtls/pkcs12.h

   1 /**
   2  * \file pkcs12.h
   3  *
   4  * \brief PKCS#12 Personal Information Exchange Syntax
   5  */
   6 /*
   7  *  Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
   8  *  SPDX-License-Identifier: GPL-2.0
   9  *
  10  *  This program is free software; you can redistribute it and/or modify
  11  *  it under the terms of the GNU General Public License as published by
  12  *  the Free Software Foundation; either version 2 of the License, or
  13  *  (at your option) any later version.
  14  *
  15  *  This program is distributed in the hope that it will be useful,
  16  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  *  GNU General Public License for more details.
  19  *
  20  *  You should have received a copy of the GNU General Public License along
  21  *  with this program; if not, write to the Free Software Foundation, Inc.,
  22  *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  23  *
  24  *  This file is part of mbed TLS (https://tls.mbed.org)
  25  */
  26 #ifndef MBEDTLS_PKCS12_H
  27 #define MBEDTLS_PKCS12_H
  28
  29 #if !defined(MBEDTLS_CONFIG_FILE)
  30 #include "config.h"
  31 #else
  32 #include MBEDTLS_CONFIG_FILE
  33 #endif
  34
  35 #include "md.h"
  36 #include "cipher.h"
  37 #include "asn1.h"
  38
  39 #include <stddef.h>
  40
  41 #define MBEDTLS_ERR_PKCS12_BAD_INPUT_DATA                 -0x1F80  /**< Bad input parameters to function. */
  42 #define MBEDTLS_ERR_PKCS12_FEATURE_UNAVAILABLE            -0x1F00  /**< Feature not available, e.g. unsupported encryption scheme. */
  43 #define MBEDTLS_ERR_PKCS12_PBE_INVALID_FORMAT             -0x1E80  /**< PBE ASN.1 data not as expected. */
  44 #define MBEDTLS_ERR_PKCS12_PASSWORD_MISMATCH              -0x1E00  /**< Given private key password does not allow for correct decryption. */
  45
  46 #define MBEDTLS_PKCS12_DERIVE_KEY       1   /**< encryption/decryption key */
  47 #define MBEDTLS_PKCS12_DERIVE_IV        2   /**< initialization vector     */
  48 #define MBEDTLS_PKCS12_DERIVE_MAC_KEY   3   /**< integrity / MAC key       */
  49
  50 #define MBEDTLS_PKCS12_PBE_DECRYPT      0
  51 #define MBEDTLS_PKCS12_PBE_ENCRYPT      1
  52
  53 #ifdef __cplusplus
  54 extern "C" {
  55 #endif
  56
  57 #if defined(MBEDTLS_ASN1_PARSE_C)
  58
  59 /**
  60  * \brief            PKCS12 Password Based function (encryption / decryption)
  61  *                   for pbeWithSHAAnd128BitRC4
  62  *
  63  * \param pbe_params an ASN1 buffer containing the pkcs-12PbeParams structure
  64  * \param mode       either MBEDTLS_PKCS12_PBE_ENCRYPT or MBEDTLS_PKCS12_PBE_DECRYPT
  65  * \param pwd        the password used (may be NULL if no password is used)
  66  * \param pwdlen     length of the password (may be 0)
  67  * \param input      the input data
  68  * \param len        data length
  69  * \param output     the output buffer
  70  *
  71  * \return           0 if successful, or a MBEDTLS_ERR_XXX code
  72  */
  73 int mbedtls_pkcs12_pbe_sha1_rc4_128( mbedtls_asn1_buf *pbe_params, int mode,
  74                              const unsigned char *pwd,  size_t pwdlen,
  75                              const unsigned char *input, size_t len,
  76                              unsigned char *output );
  77
  78 /**
  79  * \brief            PKCS12 Password Based function (encryption / decryption)
  80  *                   for cipher-based and mbedtls_md-based PBE's
  81  *
  82  * \param pbe_params an ASN1 buffer containing the pkcs-12PbeParams structure
  83  * \param mode       either MBEDTLS_PKCS12_PBE_ENCRYPT or MBEDTLS_PKCS12_PBE_DECRYPT
  84  * \param cipher_type the cipher used
  85  * \param md_type     the mbedtls_md used
  86  * \param pwd        the password used (may be NULL if no password is used)
  87  * \param pwdlen     length of the password (may be 0)
  88  * \param input      the input data
  89  * \param len        data length
  90  * \param output     the output buffer
  91  *
  92  * \return           0 if successful, or a MBEDTLS_ERR_XXX code
  93  */
  94 int mbedtls_pkcs12_pbe( mbedtls_asn1_buf *pbe_params, int mode,
  95                 mbedtls_cipher_type_t cipher_type, mbedtls_md_type_t md_type,
  96                 const unsigned char *pwd,  size_t pwdlen,
  97                 const unsigned char *input, size_t len,
  98                 unsigned char *output );
  99
 100 #endif /* MBEDTLS_ASN1_PARSE_C */
 101
 102 /**
 103  * \brief            The PKCS#12 derivation function uses a password and a salt
 104  *                   to produce pseudo-random bits for a particular "purpose".
 105  *
 106  *                   Depending on the given id, this function can produce an
 107  *                   encryption/decryption key, an nitialization vector or an
 108  *                   integrity key.
 109  *
 110  * \param data       buffer to store the derived data in
 111  * \param datalen    length to fill
 112  * \param pwd        password to use (may be NULL if no password is used)
 113  * \param pwdlen     length of the password (may be 0)
 114  * \param salt       salt buffer to use
 115  * \param saltlen    length of the salt
 116  * \param mbedtls_md         mbedtls_md type to use during the derivation
 117  * \param id         id that describes the purpose (can be MBEDTLS_PKCS12_DERIVE_KEY,
 118  *                   MBEDTLS_PKCS12_DERIVE_IV or MBEDTLS_PKCS12_DERIVE_MAC_KEY)
 119  * \param iterations number of iterations
 120  *
 121  * \return          0 if successful, or a MD, BIGNUM type error.
 122  */
 123 int mbedtls_pkcs12_derivation( unsigned char *data, size_t datalen,
 124                        const unsigned char *pwd, size_t pwdlen,
 125                        const unsigned char *salt, size_t saltlen,
 126                        mbedtls_md_type_t mbedtls_md, int id, int iterations );
 127
 128 #ifdef __cplusplus
 129 }
 130 #endif
 131
 132 #endif /* pkcs12.h */