Willie Solano / mbedtls-slave-prot-prod

mbed TLS Build

Dependents:   Slave-prot-prod

include/mbedtls/pkcs12.h@0:cdf462088d13, 2017-01-05 (annotated)

Committer:
markrad
Date:
Thu Jan 05 00:18:44 2017 +0000
Revision:
0:cdf462088d13
Initial commit

Who changed what in which revision?

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