Daiki Kato / mbed-os-lychee

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   mbed-os-example-blinky-gr-lychee GR-Boads_Camera_sample GR-Boards_Audio_Recoder GR-Boads_Camera_DisplayApp ... more

features/mbedtls/inc/mbedtls/pkcs5.h@0:f782d9c66c49, 2018-02-02 (annotated)

Committer:
dkato
Date:
Fri Feb 02 05:42:23 2018 +0000
Revision:
0:f782d9c66c49
mbed-os for GR-LYCHEE

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dkato 0:f782d9c66c49 1 /**
dkato 0:f782d9c66c49 2 * \file pkcs5.h
dkato 0:f782d9c66c49 3 *
dkato 0:f782d9c66c49 4 * \brief PKCS#5 functions
dkato 0:f782d9c66c49 5 *
dkato 0:f782d9c66c49 6 * \author Mathias Olsson <mathias@kompetensum.com>
dkato 0:f782d9c66c49 7 *
dkato 0:f782d9c66c49 8 * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
dkato 0:f782d9c66c49 9 * SPDX-License-Identifier: Apache-2.0
dkato 0:f782d9c66c49 10 *
dkato 0:f782d9c66c49 11 * Licensed under the Apache License, Version 2.0 (the "License"); you may
dkato 0:f782d9c66c49 12 * not use this file except in compliance with the License.
dkato 0:f782d9c66c49 13 * You may obtain a copy of the License at
dkato 0:f782d9c66c49 14 *
dkato 0:f782d9c66c49 15 * http://www.apache.org/licenses/LICENSE-2.0
dkato 0:f782d9c66c49 16 *
dkato 0:f782d9c66c49 17 * Unless required by applicable law or agreed to in writing, software
dkato 0:f782d9c66c49 18 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
dkato 0:f782d9c66c49 19 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
dkato 0:f782d9c66c49 20 * See the License for the specific language governing permissions and
dkato 0:f782d9c66c49 21 * limitations under the License.
dkato 0:f782d9c66c49 22 *
dkato 0:f782d9c66c49 23 * This file is part of mbed TLS (https://tls.mbed.org)
dkato 0:f782d9c66c49 24 */
dkato 0:f782d9c66c49 25 #ifndef MBEDTLS_PKCS5_H
dkato 0:f782d9c66c49 26 #define MBEDTLS_PKCS5_H
dkato 0:f782d9c66c49 27
dkato 0:f782d9c66c49 28 #include "asn1.h"
dkato 0:f782d9c66c49 29 #include "md.h"
dkato 0:f782d9c66c49 30
dkato 0:f782d9c66c49 31 #include <stddef.h>
dkato 0:f782d9c66c49 32 #include <stdint.h>
dkato 0:f782d9c66c49 33
dkato 0:f782d9c66c49 34 #define MBEDTLS_ERR_PKCS5_BAD_INPUT_DATA -0x2f80 /**< Bad input parameters to function. */
dkato 0:f782d9c66c49 35 #define MBEDTLS_ERR_PKCS5_INVALID_FORMAT -0x2f00 /**< Unexpected ASN.1 data. */
dkato 0:f782d9c66c49 36 #define MBEDTLS_ERR_PKCS5_FEATURE_UNAVAILABLE -0x2e80 /**< Requested encryption or digest alg not available. */
dkato 0:f782d9c66c49 37 #define MBEDTLS_ERR_PKCS5_PASSWORD_MISMATCH -0x2e00 /**< Given private key password does not allow for correct decryption. */
dkato 0:f782d9c66c49 38
dkato 0:f782d9c66c49 39 #define MBEDTLS_PKCS5_DECRYPT 0
dkato 0:f782d9c66c49 40 #define MBEDTLS_PKCS5_ENCRYPT 1
dkato 0:f782d9c66c49 41
dkato 0:f782d9c66c49 42 #ifdef __cplusplus
dkato 0:f782d9c66c49 43 extern "C" {
dkato 0:f782d9c66c49 44 #endif
dkato 0:f782d9c66c49 45
dkato 0:f782d9c66c49 46 /**
dkato 0:f782d9c66c49 47 * \brief PKCS#5 PBES2 function
dkato 0:f782d9c66c49 48 *
dkato 0:f782d9c66c49 49 * \param pbe_params the ASN.1 algorithm parameters
dkato 0:f782d9c66c49 50 * \param mode either MBEDTLS_PKCS5_DECRYPT or MBEDTLS_PKCS5_ENCRYPT
dkato 0:f782d9c66c49 51 * \param pwd password to use when generating key
dkato 0:f782d9c66c49 52 * \param pwdlen length of password
dkato 0:f782d9c66c49 53 * \param data data to process
dkato 0:f782d9c66c49 54 * \param datalen length of data
dkato 0:f782d9c66c49 55 * \param output output buffer
dkato 0:f782d9c66c49 56 *
dkato 0:f782d9c66c49 57 * \returns 0 on success, or a MBEDTLS_ERR_XXX code if verification fails.
dkato 0:f782d9c66c49 58 */
dkato 0:f782d9c66c49 59 int mbedtls_pkcs5_pbes2( const mbedtls_asn1_buf *pbe_params, int mode,
dkato 0:f782d9c66c49 60 const unsigned char *pwd, size_t pwdlen,
dkato 0:f782d9c66c49 61 const unsigned char *data, size_t datalen,
dkato 0:f782d9c66c49 62 unsigned char *output );
dkato 0:f782d9c66c49 63
dkato 0:f782d9c66c49 64 /**
dkato 0:f782d9c66c49 65 * \brief PKCS#5 PBKDF2 using HMAC
dkato 0:f782d9c66c49 66 *
dkato 0:f782d9c66c49 67 * \param ctx Generic HMAC context
dkato 0:f782d9c66c49 68 * \param password Password to use when generating key
dkato 0:f782d9c66c49 69 * \param plen Length of password
dkato 0:f782d9c66c49 70 * \param salt Salt to use when generating key
dkato 0:f782d9c66c49 71 * \param slen Length of salt
dkato 0:f782d9c66c49 72 * \param iteration_count Iteration count
dkato 0:f782d9c66c49 73 * \param key_length Length of generated key in bytes
dkato 0:f782d9c66c49 74 * \param output Generated key. Must be at least as big as key_length
dkato 0:f782d9c66c49 75 *
dkato 0:f782d9c66c49 76 * \returns 0 on success, or a MBEDTLS_ERR_XXX code if verification fails.
dkato 0:f782d9c66c49 77 */
dkato 0:f782d9c66c49 78 int mbedtls_pkcs5_pbkdf2_hmac( mbedtls_md_context_t *ctx, const unsigned char *password,
dkato 0:f782d9c66c49 79 size_t plen, const unsigned char *salt, size_t slen,
dkato 0:f782d9c66c49 80 unsigned int iteration_count,
dkato 0:f782d9c66c49 81 uint32_t key_length, unsigned char *output );
dkato 0:f782d9c66c49 82
dkato 0:f782d9c66c49 83 /**
dkato 0:f782d9c66c49 84 * \brief Checkup routine
dkato 0:f782d9c66c49 85 *
dkato 0:f782d9c66c49 86 * \return 0 if successful, or 1 if the test failed
dkato 0:f782d9c66c49 87 */
dkato 0:f782d9c66c49 88 int mbedtls_pkcs5_self_test( int verbose );
dkato 0:f782d9c66c49 89
dkato 0:f782d9c66c49 90 #ifdef __cplusplus
dkato 0:f782d9c66c49 91 }
dkato 0:f782d9c66c49 92 #endif
dkato 0:f782d9c66c49 93
dkato 0:f782d9c66c49 94 #endif /* pkcs5.h */