git.sur5r.net Git - freertos/blob - FreeRTOS-Labs/Source/mbedtls/include/mbedtls/pkcs12.h

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