blob: 362a66782fa7a84807b6a54c6acf5df378ace256 [file] [log] [blame]
Paul Bakkerb0c19a42013-06-24 19:26:38 +02001/**
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +02002 * \file pkcs5.h
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003 *
4 * \brief PKCS#5 functions
5 *
6 * \author Mathias Olsson <mathias@kompetensum.com>
Darryl Greena40a1012018-01-05 15:33:17 +00007 */
8/*
Manuel Pégourié-Gonnard6fb81872015-07-27 11:11:48 +02009 * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
Bence Szépkúti4e9f7122020-06-05 13:02:18 +020010 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
11 *
12 * This file is provided under the Apache License 2.0, or the
13 * GNU General Public License v2.0 or later.
14 *
15 * **********
16 * Apache License 2.0:
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +020017 *
18 * Licensed under the Apache License, Version 2.0 (the "License"); you may
19 * not use this file except in compliance with the License.
20 * You may obtain a copy of the License at
21 *
22 * http://www.apache.org/licenses/LICENSE-2.0
23 *
24 * Unless required by applicable law or agreed to in writing, software
25 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
26 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
27 * See the License for the specific language governing permissions and
28 * limitations under the License.
Paul Bakkerb0c19a42013-06-24 19:26:38 +020029 *
Bence Szépkúti4e9f7122020-06-05 13:02:18 +020030 * **********
31 *
32 * **********
33 * GNU General Public License v2.0 or later:
34 *
35 * This program is free software; you can redistribute it and/or modify
36 * it under the terms of the GNU General Public License as published by
37 * the Free Software Foundation; either version 2 of the License, or
38 * (at your option) any later version.
39 *
40 * This program is distributed in the hope that it will be useful,
41 * but WITHOUT ANY WARRANTY; without even the implied warranty of
42 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
43 * GNU General Public License for more details.
44 *
45 * You should have received a copy of the GNU General Public License along
46 * with this program; if not, write to the Free Software Foundation, Inc.,
47 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
48 *
49 * **********
50 *
Manuel Pégourié-Gonnardfe446432015-03-06 13:17:10 +000051 * This file is part of mbed TLS (https://tls.mbed.org)
Paul Bakkerb0c19a42013-06-24 19:26:38 +020052 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020053#ifndef MBEDTLS_PKCS5_H
54#define MBEDTLS_PKCS5_H
Paul Bakkerb0c19a42013-06-24 19:26:38 +020055
Ron Eldor3625e562018-12-16 12:14:37 +020056#if !defined(MBEDTLS_CONFIG_FILE)
57#include "config.h"
58#else
59#include MBEDTLS_CONFIG_FILE
60#endif
61
Paul Bakker28144de2013-06-24 19:28:55 +020062#include "asn1.h"
Paul Bakkerb0c19a42013-06-24 19:26:38 +020063#include "md.h"
64
Rich Evans00ab4702015-02-06 13:43:58 +000065#include <stddef.h>
Manuel Pégourié-Gonnardab229102015-04-15 11:53:16 +020066#include <stdint.h>
Paul Bakkerb0c19a42013-06-24 19:26:38 +020067
Manuel Pégourié-Gonnardeed55a42015-04-09 17:31:59 +020068#define MBEDTLS_ERR_PKCS5_BAD_INPUT_DATA -0x2f80 /**< Bad input parameters to function. */
69#define MBEDTLS_ERR_PKCS5_INVALID_FORMAT -0x2f00 /**< Unexpected ASN.1 data. */
70#define MBEDTLS_ERR_PKCS5_FEATURE_UNAVAILABLE -0x2e80 /**< Requested encryption or digest alg not available. */
71#define MBEDTLS_ERR_PKCS5_PASSWORD_MISMATCH -0x2e00 /**< Given private key password does not allow for correct decryption. */
Paul Bakker28144de2013-06-24 19:28:55 +020072
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020073#define MBEDTLS_PKCS5_DECRYPT 0
74#define MBEDTLS_PKCS5_ENCRYPT 1
Paul Bakker28144de2013-06-24 19:28:55 +020075
Paul Bakkerb0c19a42013-06-24 19:26:38 +020076#ifdef __cplusplus
77extern "C" {
78#endif
79
Hanno Becker5ed03552018-10-12 10:57:33 +010080#if defined(MBEDTLS_ASN1_PARSE_C)
81
Paul Bakkerb0c19a42013-06-24 19:26:38 +020082/**
Paul Bakker28144de2013-06-24 19:28:55 +020083 * \brief PKCS#5 PBES2 function
84 *
85 * \param pbe_params the ASN.1 algorithm parameters
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020086 * \param mode either MBEDTLS_PKCS5_DECRYPT or MBEDTLS_PKCS5_ENCRYPT
Paul Bakker28144de2013-06-24 19:28:55 +020087 * \param pwd password to use when generating key
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +020088 * \param pwdlen length of password
Paul Bakker28144de2013-06-24 19:28:55 +020089 * \param data data to process
90 * \param datalen length of data
91 * \param output output buffer
92 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020093 * \returns 0 on success, or a MBEDTLS_ERR_XXX code if verification fails.
Paul Bakker28144de2013-06-24 19:28:55 +020094 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020095int mbedtls_pkcs5_pbes2( const mbedtls_asn1_buf *pbe_params, int mode,
Paul Bakker28144de2013-06-24 19:28:55 +020096 const unsigned char *pwd, size_t pwdlen,
97 const unsigned char *data, size_t datalen,
98 unsigned char *output );
99
Hanno Becker5ed03552018-10-12 10:57:33 +0100100#endif /* MBEDTLS_ASN1_PARSE_C */
101
Paul Bakker28144de2013-06-24 19:28:55 +0200102/**
Paul Bakkerb0c19a42013-06-24 19:26:38 +0200103 * \brief PKCS#5 PBKDF2 using HMAC
104 *
105 * \param ctx Generic HMAC context
106 * \param password Password to use when generating key
107 * \param plen Length of password
108 * \param salt Salt to use when generating key
109 * \param slen Length of salt
110 * \param iteration_count Iteration count
Manuel Pégourié-Gonnard898e0aa2015-06-18 15:28:12 +0200111 * \param key_length Length of generated key in bytes
Paul Bakkerb0c19a42013-06-24 19:26:38 +0200112 * \param output Generated key. Must be at least as big as key_length
113 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200114 * \returns 0 on success, or a MBEDTLS_ERR_XXX code if verification fails.
Paul Bakkerb0c19a42013-06-24 19:26:38 +0200115 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200116int mbedtls_pkcs5_pbkdf2_hmac( mbedtls_md_context_t *ctx, const unsigned char *password,
Paul Bakkerb0c19a42013-06-24 19:26:38 +0200117 size_t plen, const unsigned char *salt, size_t slen,
118 unsigned int iteration_count,
119 uint32_t key_length, unsigned char *output );
120
121/**
122 * \brief Checkup routine
123 *
124 * \return 0 if successful, or 1 if the test failed
125 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200126int mbedtls_pkcs5_self_test( int verbose );
Paul Bakkerb0c19a42013-06-24 19:26:38 +0200127
128#ifdef __cplusplus
129}
130#endif
131
132#endif /* pkcs5.h */