Austin Blackstone / Mbed 2 deprecated client-lwip-lightswitch-demo-expanded

mbed client lightswitch demo

Dependencies:   mbed Socket lwip-eth lwip-sys lwip

Fork of mbed-client-classic-example-lwip by Austin Blackstone

mbedtls/mbedtls/pkcs12.h@11:cada08fc8a70, 2016-06-09 (annotated)

Committer:
mbedAustin
Date:
Thu Jun 09 17:08:36 2016 +0000
Revision:
11:cada08fc8a70
Commit for public Consumption

Who changed what in which revision?

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