d297157fe8
Now that descriptions of error codes no longer have to be on the same line for the sake of generate_errors.pl, move them to their own line before the definition. This aligns them with what we do for other definitions, and means that we no longer need to have very long lines containing both the C definition and the comment. ``` perl -i -pe 's~^(#define +MBEDTLS_ERR_\w+ +-\w+) */\*[*!]<(.*)\*/~/**$2*/\n$1~' include/mbedtls/*.h ``` This commit does not change the output of generate_errors.pl. Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
107 lines
3.3 KiB
C
107 lines
3.3 KiB
C
/**
|
|
* \file pkcs5.h
|
|
*
|
|
* \brief PKCS#5 functions
|
|
*
|
|
* \author Mathias Olsson <mathias@kompetensum.com>
|
|
*/
|
|
/*
|
|
* Copyright The Mbed TLS Contributors
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
* not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
#ifndef MBEDTLS_PKCS5_H
|
|
#define MBEDTLS_PKCS5_H
|
|
|
|
#include "mbedtls/build_info.h"
|
|
|
|
#include "mbedtls/asn1.h"
|
|
#include "mbedtls/md.h"
|
|
|
|
#include <stddef.h>
|
|
#include <stdint.h>
|
|
|
|
/** Bad input parameters to function. */
|
|
#define MBEDTLS_ERR_PKCS5_BAD_INPUT_DATA -0x2f80
|
|
/** Unexpected ASN.1 data. */
|
|
#define MBEDTLS_ERR_PKCS5_INVALID_FORMAT -0x2f00
|
|
/** Requested encryption or digest alg not available. */
|
|
#define MBEDTLS_ERR_PKCS5_FEATURE_UNAVAILABLE -0x2e80
|
|
/** Given private key password does not allow for correct decryption. */
|
|
#define MBEDTLS_ERR_PKCS5_PASSWORD_MISMATCH -0x2e00
|
|
|
|
#define MBEDTLS_PKCS5_DECRYPT 0
|
|
#define MBEDTLS_PKCS5_ENCRYPT 1
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#if defined(MBEDTLS_ASN1_PARSE_C)
|
|
|
|
/**
|
|
* \brief PKCS#5 PBES2 function
|
|
*
|
|
* \param pbe_params the ASN.1 algorithm parameters
|
|
* \param mode either MBEDTLS_PKCS5_DECRYPT or MBEDTLS_PKCS5_ENCRYPT
|
|
* \param pwd password to use when generating key
|
|
* \param pwdlen length of password
|
|
* \param data data to process
|
|
* \param datalen length of data
|
|
* \param output output buffer
|
|
*
|
|
* \returns 0 on success, or a MBEDTLS_ERR_XXX code if verification fails.
|
|
*/
|
|
int mbedtls_pkcs5_pbes2( const mbedtls_asn1_buf *pbe_params, int mode,
|
|
const unsigned char *pwd, size_t pwdlen,
|
|
const unsigned char *data, size_t datalen,
|
|
unsigned char *output );
|
|
|
|
#endif /* MBEDTLS_ASN1_PARSE_C */
|
|
|
|
/**
|
|
* \brief PKCS#5 PBKDF2 using HMAC
|
|
*
|
|
* \param ctx Generic HMAC context
|
|
* \param password Password to use when generating key
|
|
* \param plen Length of password
|
|
* \param salt Salt to use when generating key
|
|
* \param slen Length of salt
|
|
* \param iteration_count Iteration count
|
|
* \param key_length Length of generated key in bytes
|
|
* \param output Generated key. Must be at least as big as key_length
|
|
*
|
|
* \returns 0 on success, or a MBEDTLS_ERR_XXX code if verification fails.
|
|
*/
|
|
int mbedtls_pkcs5_pbkdf2_hmac( mbedtls_md_context_t *ctx, const unsigned char *password,
|
|
size_t plen, const unsigned char *salt, size_t slen,
|
|
unsigned int iteration_count,
|
|
uint32_t key_length, unsigned char *output );
|
|
|
|
#if defined(MBEDTLS_SELF_TEST)
|
|
|
|
/**
|
|
* \brief Checkup routine
|
|
*
|
|
* \return 0 if successful, or 1 if the test failed
|
|
*/
|
|
int mbedtls_pkcs5_self_test( int verbose );
|
|
|
|
#endif /* MBEDTLS_SELF_TEST */
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* pkcs5.h */
|