takashi kadono / Mbed OS Nucleo446_SSD1331

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.

Dependencies:   ssd1331

mbed-os/features/mbedtls/inc/mbedtls/cipher.h@0:8fdf9a60065b, 2018-10-10 (annotated)

Committer:
kadonotakashi
Date:
Wed Oct 10 00:33:53 2018 +0000
Revision:
0:8fdf9a60065b
how to make mbed librry

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kadonotakashi 0:8fdf9a60065b 1 /**
kadonotakashi 0:8fdf9a60065b 2 * \file cipher.h
kadonotakashi 0:8fdf9a60065b 3 *
kadonotakashi 0:8fdf9a60065b 4 * \brief This file contains an abstraction interface for use with the cipher
kadonotakashi 0:8fdf9a60065b 5 * primitives provided by the library. It provides a common interface to all of
kadonotakashi 0:8fdf9a60065b 6 * the available cipher operations.
kadonotakashi 0:8fdf9a60065b 7 *
kadonotakashi 0:8fdf9a60065b 8 * \author Adriaan de Jong <dejong@fox-it.com>
kadonotakashi 0:8fdf9a60065b 9 */
kadonotakashi 0:8fdf9a60065b 10 /*
kadonotakashi 0:8fdf9a60065b 11 * Copyright (C) 2006-2018, Arm Limited (or its affiliates), All Rights Reserved
kadonotakashi 0:8fdf9a60065b 12 * SPDX-License-Identifier: Apache-2.0
kadonotakashi 0:8fdf9a60065b 13 *
kadonotakashi 0:8fdf9a60065b 14 * Licensed under the Apache License, Version 2.0 (the "License"); you may
kadonotakashi 0:8fdf9a60065b 15 * not use this file except in compliance with the License.
kadonotakashi 0:8fdf9a60065b 16 * You may obtain a copy of the License at
kadonotakashi 0:8fdf9a60065b 17 *
kadonotakashi 0:8fdf9a60065b 18 * http://www.apache.org/licenses/LICENSE-2.0
kadonotakashi 0:8fdf9a60065b 19 *
kadonotakashi 0:8fdf9a60065b 20 * Unless required by applicable law or agreed to in writing, software
kadonotakashi 0:8fdf9a60065b 21 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
kadonotakashi 0:8fdf9a60065b 22 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
kadonotakashi 0:8fdf9a60065b 23 * See the License for the specific language governing permissions and
kadonotakashi 0:8fdf9a60065b 24 * limitations under the License.
kadonotakashi 0:8fdf9a60065b 25 *
kadonotakashi 0:8fdf9a60065b 26 * This file is part of Mbed TLS (https://tls.mbed.org)
kadonotakashi 0:8fdf9a60065b 27 */
kadonotakashi 0:8fdf9a60065b 28
kadonotakashi 0:8fdf9a60065b 29 #ifndef MBEDTLS_CIPHER_H
kadonotakashi 0:8fdf9a60065b 30 #define MBEDTLS_CIPHER_H
kadonotakashi 0:8fdf9a60065b 31
kadonotakashi 0:8fdf9a60065b 32 #if !defined(MBEDTLS_CONFIG_FILE)
kadonotakashi 0:8fdf9a60065b 33 #include "config.h"
kadonotakashi 0:8fdf9a60065b 34 #else
kadonotakashi 0:8fdf9a60065b 35 #include MBEDTLS_CONFIG_FILE
kadonotakashi 0:8fdf9a60065b 36 #endif
kadonotakashi 0:8fdf9a60065b 37
kadonotakashi 0:8fdf9a60065b 38 #include <stddef.h>
kadonotakashi 0:8fdf9a60065b 39
kadonotakashi 0:8fdf9a60065b 40 #if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CCM_C) || defined(MBEDTLS_CHACHAPOLY_C)
kadonotakashi 0:8fdf9a60065b 41 #define MBEDTLS_CIPHER_MODE_AEAD
kadonotakashi 0:8fdf9a60065b 42 #endif
kadonotakashi 0:8fdf9a60065b 43
kadonotakashi 0:8fdf9a60065b 44 #if defined(MBEDTLS_CIPHER_MODE_CBC)
kadonotakashi 0:8fdf9a60065b 45 #define MBEDTLS_CIPHER_MODE_WITH_PADDING
kadonotakashi 0:8fdf9a60065b 46 #endif
kadonotakashi 0:8fdf9a60065b 47
kadonotakashi 0:8fdf9a60065b 48 #if defined(MBEDTLS_ARC4_C) || defined(MBEDTLS_CIPHER_NULL_CIPHER) || \
kadonotakashi 0:8fdf9a60065b 49 defined(MBEDTLS_CHACHA20_C)
kadonotakashi 0:8fdf9a60065b 50 #define MBEDTLS_CIPHER_MODE_STREAM
kadonotakashi 0:8fdf9a60065b 51 #endif
kadonotakashi 0:8fdf9a60065b 52
kadonotakashi 0:8fdf9a60065b 53 #if ( defined(__ARMCC_VERSION) || defined(_MSC_VER) ) && \
kadonotakashi 0:8fdf9a60065b 54 !defined(inline) && !defined(__cplusplus)
kadonotakashi 0:8fdf9a60065b 55 #define inline __inline
kadonotakashi 0:8fdf9a60065b 56 #endif
kadonotakashi 0:8fdf9a60065b 57
kadonotakashi 0:8fdf9a60065b 58 #define MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE -0x6080 /**< The selected feature is not available. */
kadonotakashi 0:8fdf9a60065b 59 #define MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA -0x6100 /**< Bad input parameters. */
kadonotakashi 0:8fdf9a60065b 60 #define MBEDTLS_ERR_CIPHER_ALLOC_FAILED -0x6180 /**< Failed to allocate memory. */
kadonotakashi 0:8fdf9a60065b 61 #define MBEDTLS_ERR_CIPHER_INVALID_PADDING -0x6200 /**< Input data contains invalid padding and is rejected. */
kadonotakashi 0:8fdf9a60065b 62 #define MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED -0x6280 /**< Decryption of block requires a full block. */
kadonotakashi 0:8fdf9a60065b 63 #define MBEDTLS_ERR_CIPHER_AUTH_FAILED -0x6300 /**< Authentication failed (for AEAD modes). */
kadonotakashi 0:8fdf9a60065b 64 #define MBEDTLS_ERR_CIPHER_INVALID_CONTEXT -0x6380 /**< The context is invalid. For example, because it was freed. */
kadonotakashi 0:8fdf9a60065b 65 #define MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED -0x6400 /**< Cipher hardware accelerator failed. */
kadonotakashi 0:8fdf9a60065b 66
kadonotakashi 0:8fdf9a60065b 67 #define MBEDTLS_CIPHER_VARIABLE_IV_LEN 0x01 /**< Cipher accepts IVs of variable length. */
kadonotakashi 0:8fdf9a60065b 68 #define MBEDTLS_CIPHER_VARIABLE_KEY_LEN 0x02 /**< Cipher accepts keys of variable length. */
kadonotakashi 0:8fdf9a60065b 69
kadonotakashi 0:8fdf9a60065b 70 #ifdef __cplusplus
kadonotakashi 0:8fdf9a60065b 71 extern "C" {
kadonotakashi 0:8fdf9a60065b 72 #endif
kadonotakashi 0:8fdf9a60065b 73
kadonotakashi 0:8fdf9a60065b 74 /**
kadonotakashi 0:8fdf9a60065b 75 * \brief Supported cipher types.
kadonotakashi 0:8fdf9a60065b 76 *
kadonotakashi 0:8fdf9a60065b 77 * \warning RC4 and DES are considered weak ciphers and their use
kadonotakashi 0:8fdf9a60065b 78 * constitutes a security risk. Arm recommends considering stronger
kadonotakashi 0:8fdf9a60065b 79 * ciphers instead.
kadonotakashi 0:8fdf9a60065b 80 */
kadonotakashi 0:8fdf9a60065b 81 typedef enum {
kadonotakashi 0:8fdf9a60065b 82 MBEDTLS_CIPHER_ID_NONE = 0, /**< Placeholder to mark the end of cipher ID lists. */
kadonotakashi 0:8fdf9a60065b 83 MBEDTLS_CIPHER_ID_NULL, /**< The identity cipher, treated as a stream cipher. */
kadonotakashi 0:8fdf9a60065b 84 MBEDTLS_CIPHER_ID_AES, /**< The AES cipher. */
kadonotakashi 0:8fdf9a60065b 85 MBEDTLS_CIPHER_ID_DES, /**< The DES cipher. */
kadonotakashi 0:8fdf9a60065b 86 MBEDTLS_CIPHER_ID_3DES, /**< The Triple DES cipher. */
kadonotakashi 0:8fdf9a60065b 87 MBEDTLS_CIPHER_ID_CAMELLIA, /**< The Camellia cipher. */
kadonotakashi 0:8fdf9a60065b 88 MBEDTLS_CIPHER_ID_BLOWFISH, /**< The Blowfish cipher. */
kadonotakashi 0:8fdf9a60065b 89 MBEDTLS_CIPHER_ID_ARC4, /**< The RC4 cipher. */
kadonotakashi 0:8fdf9a60065b 90 MBEDTLS_CIPHER_ID_ARIA, /**< The Aria cipher. */
kadonotakashi 0:8fdf9a60065b 91 MBEDTLS_CIPHER_ID_CHACHA20, /**< The ChaCha20 cipher. */
kadonotakashi 0:8fdf9a60065b 92 } mbedtls_cipher_id_t;
kadonotakashi 0:8fdf9a60065b 93
kadonotakashi 0:8fdf9a60065b 94 /**
kadonotakashi 0:8fdf9a60065b 95 * \brief Supported {cipher type, cipher mode} pairs.
kadonotakashi 0:8fdf9a60065b 96 *
kadonotakashi 0:8fdf9a60065b 97 * \warning RC4 and DES are considered weak ciphers and their use
kadonotakashi 0:8fdf9a60065b 98 * constitutes a security risk. Arm recommends considering stronger
kadonotakashi 0:8fdf9a60065b 99 * ciphers instead.
kadonotakashi 0:8fdf9a60065b 100 */
kadonotakashi 0:8fdf9a60065b 101 typedef enum {
kadonotakashi 0:8fdf9a60065b 102 MBEDTLS_CIPHER_NONE = 0, /**< Placeholder to mark the end of cipher-pair lists. */
kadonotakashi 0:8fdf9a60065b 103 MBEDTLS_CIPHER_NULL, /**< The identity stream cipher. */
kadonotakashi 0:8fdf9a60065b 104 MBEDTLS_CIPHER_AES_128_ECB, /**< AES cipher with 128-bit ECB mode. */
kadonotakashi 0:8fdf9a60065b 105 MBEDTLS_CIPHER_AES_192_ECB, /**< AES cipher with 192-bit ECB mode. */
kadonotakashi 0:8fdf9a60065b 106 MBEDTLS_CIPHER_AES_256_ECB, /**< AES cipher with 256-bit ECB mode. */
kadonotakashi 0:8fdf9a60065b 107 MBEDTLS_CIPHER_AES_128_CBC, /**< AES cipher with 128-bit CBC mode. */
kadonotakashi 0:8fdf9a60065b 108 MBEDTLS_CIPHER_AES_192_CBC, /**< AES cipher with 192-bit CBC mode. */
kadonotakashi 0:8fdf9a60065b 109 MBEDTLS_CIPHER_AES_256_CBC, /**< AES cipher with 256-bit CBC mode. */
kadonotakashi 0:8fdf9a60065b 110 MBEDTLS_CIPHER_AES_128_CFB128, /**< AES cipher with 128-bit CFB128 mode. */
kadonotakashi 0:8fdf9a60065b 111 MBEDTLS_CIPHER_AES_192_CFB128, /**< AES cipher with 192-bit CFB128 mode. */
kadonotakashi 0:8fdf9a60065b 112 MBEDTLS_CIPHER_AES_256_CFB128, /**< AES cipher with 256-bit CFB128 mode. */
kadonotakashi 0:8fdf9a60065b 113 MBEDTLS_CIPHER_AES_128_CTR, /**< AES cipher with 128-bit CTR mode. */
kadonotakashi 0:8fdf9a60065b 114 MBEDTLS_CIPHER_AES_192_CTR, /**< AES cipher with 192-bit CTR mode. */
kadonotakashi 0:8fdf9a60065b 115 MBEDTLS_CIPHER_AES_256_CTR, /**< AES cipher with 256-bit CTR mode. */
kadonotakashi 0:8fdf9a60065b 116 MBEDTLS_CIPHER_AES_128_GCM, /**< AES cipher with 128-bit GCM mode. */
kadonotakashi 0:8fdf9a60065b 117 MBEDTLS_CIPHER_AES_192_GCM, /**< AES cipher with 192-bit GCM mode. */
kadonotakashi 0:8fdf9a60065b 118 MBEDTLS_CIPHER_AES_256_GCM, /**< AES cipher with 256-bit GCM mode. */
kadonotakashi 0:8fdf9a60065b 119 MBEDTLS_CIPHER_CAMELLIA_128_ECB, /**< Camellia cipher with 128-bit ECB mode. */
kadonotakashi 0:8fdf9a60065b 120 MBEDTLS_CIPHER_CAMELLIA_192_ECB, /**< Camellia cipher with 192-bit ECB mode. */
kadonotakashi 0:8fdf9a60065b 121 MBEDTLS_CIPHER_CAMELLIA_256_ECB, /**< Camellia cipher with 256-bit ECB mode. */
kadonotakashi 0:8fdf9a60065b 122 MBEDTLS_CIPHER_CAMELLIA_128_CBC, /**< Camellia cipher with 128-bit CBC mode. */
kadonotakashi 0:8fdf9a60065b 123 MBEDTLS_CIPHER_CAMELLIA_192_CBC, /**< Camellia cipher with 192-bit CBC mode. */
kadonotakashi 0:8fdf9a60065b 124 MBEDTLS_CIPHER_CAMELLIA_256_CBC, /**< Camellia cipher with 256-bit CBC mode. */
kadonotakashi 0:8fdf9a60065b 125 MBEDTLS_CIPHER_CAMELLIA_128_CFB128, /**< Camellia cipher with 128-bit CFB128 mode. */
kadonotakashi 0:8fdf9a60065b 126 MBEDTLS_CIPHER_CAMELLIA_192_CFB128, /**< Camellia cipher with 192-bit CFB128 mode. */
kadonotakashi 0:8fdf9a60065b 127 MBEDTLS_CIPHER_CAMELLIA_256_CFB128, /**< Camellia cipher with 256-bit CFB128 mode. */
kadonotakashi 0:8fdf9a60065b 128 MBEDTLS_CIPHER_CAMELLIA_128_CTR, /**< Camellia cipher with 128-bit CTR mode. */
kadonotakashi 0:8fdf9a60065b 129 MBEDTLS_CIPHER_CAMELLIA_192_CTR, /**< Camellia cipher with 192-bit CTR mode. */
kadonotakashi 0:8fdf9a60065b 130 MBEDTLS_CIPHER_CAMELLIA_256_CTR, /**< Camellia cipher with 256-bit CTR mode. */
kadonotakashi 0:8fdf9a60065b 131 MBEDTLS_CIPHER_CAMELLIA_128_GCM, /**< Camellia cipher with 128-bit GCM mode. */
kadonotakashi 0:8fdf9a60065b 132 MBEDTLS_CIPHER_CAMELLIA_192_GCM, /**< Camellia cipher with 192-bit GCM mode. */
kadonotakashi 0:8fdf9a60065b 133 MBEDTLS_CIPHER_CAMELLIA_256_GCM, /**< Camellia cipher with 256-bit GCM mode. */
kadonotakashi 0:8fdf9a60065b 134 MBEDTLS_CIPHER_DES_ECB, /**< DES cipher with ECB mode. */
kadonotakashi 0:8fdf9a60065b 135 MBEDTLS_CIPHER_DES_CBC, /**< DES cipher with CBC mode. */
kadonotakashi 0:8fdf9a60065b 136 MBEDTLS_CIPHER_DES_EDE_ECB, /**< DES cipher with EDE ECB mode. */
kadonotakashi 0:8fdf9a60065b 137 MBEDTLS_CIPHER_DES_EDE_CBC, /**< DES cipher with EDE CBC mode. */
kadonotakashi 0:8fdf9a60065b 138 MBEDTLS_CIPHER_DES_EDE3_ECB, /**< DES cipher with EDE3 ECB mode. */
kadonotakashi 0:8fdf9a60065b 139 MBEDTLS_CIPHER_DES_EDE3_CBC, /**< DES cipher with EDE3 CBC mode. */
kadonotakashi 0:8fdf9a60065b 140 MBEDTLS_CIPHER_BLOWFISH_ECB, /**< Blowfish cipher with ECB mode. */
kadonotakashi 0:8fdf9a60065b 141 MBEDTLS_CIPHER_BLOWFISH_CBC, /**< Blowfish cipher with CBC mode. */
kadonotakashi 0:8fdf9a60065b 142 MBEDTLS_CIPHER_BLOWFISH_CFB64, /**< Blowfish cipher with CFB64 mode. */
kadonotakashi 0:8fdf9a60065b 143 MBEDTLS_CIPHER_BLOWFISH_CTR, /**< Blowfish cipher with CTR mode. */
kadonotakashi 0:8fdf9a60065b 144 MBEDTLS_CIPHER_ARC4_128, /**< RC4 cipher with 128-bit mode. */
kadonotakashi 0:8fdf9a60065b 145 MBEDTLS_CIPHER_AES_128_CCM, /**< AES cipher with 128-bit CCM mode. */
kadonotakashi 0:8fdf9a60065b 146 MBEDTLS_CIPHER_AES_192_CCM, /**< AES cipher with 192-bit CCM mode. */
kadonotakashi 0:8fdf9a60065b 147 MBEDTLS_CIPHER_AES_256_CCM, /**< AES cipher with 256-bit CCM mode. */
kadonotakashi 0:8fdf9a60065b 148 MBEDTLS_CIPHER_CAMELLIA_128_CCM, /**< Camellia cipher with 128-bit CCM mode. */
kadonotakashi 0:8fdf9a60065b 149 MBEDTLS_CIPHER_CAMELLIA_192_CCM, /**< Camellia cipher with 192-bit CCM mode. */
kadonotakashi 0:8fdf9a60065b 150 MBEDTLS_CIPHER_CAMELLIA_256_CCM, /**< Camellia cipher with 256-bit CCM mode. */
kadonotakashi 0:8fdf9a60065b 151 MBEDTLS_CIPHER_ARIA_128_ECB, /**< Aria cipher with 128-bit key and ECB mode. */
kadonotakashi 0:8fdf9a60065b 152 MBEDTLS_CIPHER_ARIA_192_ECB, /**< Aria cipher with 192-bit key and ECB mode. */
kadonotakashi 0:8fdf9a60065b 153 MBEDTLS_CIPHER_ARIA_256_ECB, /**< Aria cipher with 256-bit key and ECB mode. */
kadonotakashi 0:8fdf9a60065b 154 MBEDTLS_CIPHER_ARIA_128_CBC, /**< Aria cipher with 128-bit key and CBC mode. */
kadonotakashi 0:8fdf9a60065b 155 MBEDTLS_CIPHER_ARIA_192_CBC, /**< Aria cipher with 192-bit key and CBC mode. */
kadonotakashi 0:8fdf9a60065b 156 MBEDTLS_CIPHER_ARIA_256_CBC, /**< Aria cipher with 256-bit key and CBC mode. */
kadonotakashi 0:8fdf9a60065b 157 MBEDTLS_CIPHER_ARIA_128_CFB128, /**< Aria cipher with 128-bit key and CFB-128 mode. */
kadonotakashi 0:8fdf9a60065b 158 MBEDTLS_CIPHER_ARIA_192_CFB128, /**< Aria cipher with 192-bit key and CFB-128 mode. */
kadonotakashi 0:8fdf9a60065b 159 MBEDTLS_CIPHER_ARIA_256_CFB128, /**< Aria cipher with 256-bit key and CFB-128 mode. */
kadonotakashi 0:8fdf9a60065b 160 MBEDTLS_CIPHER_ARIA_128_CTR, /**< Aria cipher with 128-bit key and CTR mode. */
kadonotakashi 0:8fdf9a60065b 161 MBEDTLS_CIPHER_ARIA_192_CTR, /**< Aria cipher with 192-bit key and CTR mode. */
kadonotakashi 0:8fdf9a60065b 162 MBEDTLS_CIPHER_ARIA_256_CTR, /**< Aria cipher with 256-bit key and CTR mode. */
kadonotakashi 0:8fdf9a60065b 163 MBEDTLS_CIPHER_ARIA_128_GCM, /**< Aria cipher with 128-bit key and GCM mode. */
kadonotakashi 0:8fdf9a60065b 164 MBEDTLS_CIPHER_ARIA_192_GCM, /**< Aria cipher with 192-bit key and GCM mode. */
kadonotakashi 0:8fdf9a60065b 165 MBEDTLS_CIPHER_ARIA_256_GCM, /**< Aria cipher with 256-bit key and GCM mode. */
kadonotakashi 0:8fdf9a60065b 166 MBEDTLS_CIPHER_ARIA_128_CCM, /**< Aria cipher with 128-bit key and CCM mode. */
kadonotakashi 0:8fdf9a60065b 167 MBEDTLS_CIPHER_ARIA_192_CCM, /**< Aria cipher with 192-bit key and CCM mode. */
kadonotakashi 0:8fdf9a60065b 168 MBEDTLS_CIPHER_ARIA_256_CCM, /**< Aria cipher with 256-bit key and CCM mode. */
kadonotakashi 0:8fdf9a60065b 169 MBEDTLS_CIPHER_AES_128_OFB, /**< AES 128-bit cipher in OFB mode. */
kadonotakashi 0:8fdf9a60065b 170 MBEDTLS_CIPHER_AES_192_OFB, /**< AES 192-bit cipher in OFB mode. */
kadonotakashi 0:8fdf9a60065b 171 MBEDTLS_CIPHER_AES_256_OFB, /**< AES 256-bit cipher in OFB mode. */
kadonotakashi 0:8fdf9a60065b 172 MBEDTLS_CIPHER_AES_128_XTS, /**< AES 128-bit cipher in XTS block mode. */
kadonotakashi 0:8fdf9a60065b 173 MBEDTLS_CIPHER_AES_256_XTS, /**< AES 256-bit cipher in XTS block mode. */
kadonotakashi 0:8fdf9a60065b 174 MBEDTLS_CIPHER_CHACHA20, /**< ChaCha20 stream cipher. */
kadonotakashi 0:8fdf9a60065b 175 MBEDTLS_CIPHER_CHACHA20_POLY1305, /**< ChaCha20-Poly1305 AEAD cipher. */
kadonotakashi 0:8fdf9a60065b 176 } mbedtls_cipher_type_t;
kadonotakashi 0:8fdf9a60065b 177
kadonotakashi 0:8fdf9a60065b 178 /** Supported cipher modes. */
kadonotakashi 0:8fdf9a60065b 179 typedef enum {
kadonotakashi 0:8fdf9a60065b 180 MBEDTLS_MODE_NONE = 0, /**< None. */
kadonotakashi 0:8fdf9a60065b 181 MBEDTLS_MODE_ECB, /**< The ECB cipher mode. */
kadonotakashi 0:8fdf9a60065b 182 MBEDTLS_MODE_CBC, /**< The CBC cipher mode. */
kadonotakashi 0:8fdf9a60065b 183 MBEDTLS_MODE_CFB, /**< The CFB cipher mode. */
kadonotakashi 0:8fdf9a60065b 184 MBEDTLS_MODE_OFB, /**< The OFB cipher mode. */
kadonotakashi 0:8fdf9a60065b 185 MBEDTLS_MODE_CTR, /**< The CTR cipher mode. */
kadonotakashi 0:8fdf9a60065b 186 MBEDTLS_MODE_GCM, /**< The GCM cipher mode. */
kadonotakashi 0:8fdf9a60065b 187 MBEDTLS_MODE_STREAM, /**< The stream cipher mode. */
kadonotakashi 0:8fdf9a60065b 188 MBEDTLS_MODE_CCM, /**< The CCM cipher mode. */
kadonotakashi 0:8fdf9a60065b 189 MBEDTLS_MODE_XTS, /**< The XTS cipher mode. */
kadonotakashi 0:8fdf9a60065b 190 MBEDTLS_MODE_CHACHAPOLY, /**< The ChaCha-Poly cipher mode. */
kadonotakashi 0:8fdf9a60065b 191 } mbedtls_cipher_mode_t;
kadonotakashi 0:8fdf9a60065b 192
kadonotakashi 0:8fdf9a60065b 193 /** Supported cipher padding types. */
kadonotakashi 0:8fdf9a60065b 194 typedef enum {
kadonotakashi 0:8fdf9a60065b 195 MBEDTLS_PADDING_PKCS7 = 0, /**< PKCS7 padding (default). */
kadonotakashi 0:8fdf9a60065b 196 MBEDTLS_PADDING_ONE_AND_ZEROS, /**< ISO/IEC 7816-4 padding. */
kadonotakashi 0:8fdf9a60065b 197 MBEDTLS_PADDING_ZEROS_AND_LEN, /**< ANSI X.923 padding. */
kadonotakashi 0:8fdf9a60065b 198 MBEDTLS_PADDING_ZEROS, /**< Zero padding (not reversible). */
kadonotakashi 0:8fdf9a60065b 199 MBEDTLS_PADDING_NONE, /**< Never pad (full blocks only). */
kadonotakashi 0:8fdf9a60065b 200 } mbedtls_cipher_padding_t;
kadonotakashi 0:8fdf9a60065b 201
kadonotakashi 0:8fdf9a60065b 202 /** Type of operation. */
kadonotakashi 0:8fdf9a60065b 203 typedef enum {
kadonotakashi 0:8fdf9a60065b 204 MBEDTLS_OPERATION_NONE = -1,
kadonotakashi 0:8fdf9a60065b 205 MBEDTLS_DECRYPT = 0,
kadonotakashi 0:8fdf9a60065b 206 MBEDTLS_ENCRYPT,
kadonotakashi 0:8fdf9a60065b 207 } mbedtls_operation_t;
kadonotakashi 0:8fdf9a60065b 208
kadonotakashi 0:8fdf9a60065b 209 enum {
kadonotakashi 0:8fdf9a60065b 210 /** Undefined key length. */
kadonotakashi 0:8fdf9a60065b 211 MBEDTLS_KEY_LENGTH_NONE = 0,
kadonotakashi 0:8fdf9a60065b 212 /** Key length, in bits (including parity), for DES keys. */
kadonotakashi 0:8fdf9a60065b 213 MBEDTLS_KEY_LENGTH_DES = 64,
kadonotakashi 0:8fdf9a60065b 214 /** Key length in bits, including parity, for DES in two-key EDE. */
kadonotakashi 0:8fdf9a60065b 215 MBEDTLS_KEY_LENGTH_DES_EDE = 128,
kadonotakashi 0:8fdf9a60065b 216 /** Key length in bits, including parity, for DES in three-key EDE. */
kadonotakashi 0:8fdf9a60065b 217 MBEDTLS_KEY_LENGTH_DES_EDE3 = 192,
kadonotakashi 0:8fdf9a60065b 218 };
kadonotakashi 0:8fdf9a60065b 219
kadonotakashi 0:8fdf9a60065b 220 /** Maximum length of any IV, in Bytes. */
kadonotakashi 0:8fdf9a60065b 221 #define MBEDTLS_MAX_IV_LENGTH 16
kadonotakashi 0:8fdf9a60065b 222 /** Maximum block size of any cipher, in Bytes. */
kadonotakashi 0:8fdf9a60065b 223 #define MBEDTLS_MAX_BLOCK_LENGTH 16
kadonotakashi 0:8fdf9a60065b 224
kadonotakashi 0:8fdf9a60065b 225 /**
kadonotakashi 0:8fdf9a60065b 226 * Base cipher information (opaque struct).
kadonotakashi 0:8fdf9a60065b 227 */
kadonotakashi 0:8fdf9a60065b 228 typedef struct mbedtls_cipher_base_t mbedtls_cipher_base_t;
kadonotakashi 0:8fdf9a60065b 229
kadonotakashi 0:8fdf9a60065b 230 /**
kadonotakashi 0:8fdf9a60065b 231 * CMAC context (opaque struct).
kadonotakashi 0:8fdf9a60065b 232 */
kadonotakashi 0:8fdf9a60065b 233 typedef struct mbedtls_cmac_context_t mbedtls_cmac_context_t;
kadonotakashi 0:8fdf9a60065b 234
kadonotakashi 0:8fdf9a60065b 235 /**
kadonotakashi 0:8fdf9a60065b 236 * Cipher information. Allows calling cipher functions
kadonotakashi 0:8fdf9a60065b 237 * in a generic way.
kadonotakashi 0:8fdf9a60065b 238 */
kadonotakashi 0:8fdf9a60065b 239 typedef struct mbedtls_cipher_info_t
kadonotakashi 0:8fdf9a60065b 240 {
kadonotakashi 0:8fdf9a60065b 241 /** Full cipher identifier. For example,
kadonotakashi 0:8fdf9a60065b 242 * MBEDTLS_CIPHER_AES_256_CBC.
kadonotakashi 0:8fdf9a60065b 243 */
kadonotakashi 0:8fdf9a60065b 244 mbedtls_cipher_type_t type;
kadonotakashi 0:8fdf9a60065b 245
kadonotakashi 0:8fdf9a60065b 246 /** The cipher mode. For example, MBEDTLS_MODE_CBC. */
kadonotakashi 0:8fdf9a60065b 247 mbedtls_cipher_mode_t mode;
kadonotakashi 0:8fdf9a60065b 248
kadonotakashi 0:8fdf9a60065b 249 /** The cipher key length, in bits. This is the
kadonotakashi 0:8fdf9a60065b 250 * default length for variable sized ciphers.
kadonotakashi 0:8fdf9a60065b 251 * Includes parity bits for ciphers like DES.
kadonotakashi 0:8fdf9a60065b 252 */
kadonotakashi 0:8fdf9a60065b 253 unsigned int key_bitlen;
kadonotakashi 0:8fdf9a60065b 254
kadonotakashi 0:8fdf9a60065b 255 /** Name of the cipher. */
kadonotakashi 0:8fdf9a60065b 256 const char * name;
kadonotakashi 0:8fdf9a60065b 257
kadonotakashi 0:8fdf9a60065b 258 /** IV or nonce size, in Bytes.
kadonotakashi 0:8fdf9a60065b 259 * For ciphers that accept variable IV sizes,
kadonotakashi 0:8fdf9a60065b 260 * this is the recommended size.
kadonotakashi 0:8fdf9a60065b 261 */
kadonotakashi 0:8fdf9a60065b 262 unsigned int iv_size;
kadonotakashi 0:8fdf9a60065b 263
kadonotakashi 0:8fdf9a60065b 264 /** Bitflag comprised of MBEDTLS_CIPHER_VARIABLE_IV_LEN and
kadonotakashi 0:8fdf9a60065b 265 * MBEDTLS_CIPHER_VARIABLE_KEY_LEN indicating whether the
kadonotakashi 0:8fdf9a60065b 266 * cipher supports variable IV or variable key sizes, respectively.
kadonotakashi 0:8fdf9a60065b 267 */
kadonotakashi 0:8fdf9a60065b 268 int flags;
kadonotakashi 0:8fdf9a60065b 269
kadonotakashi 0:8fdf9a60065b 270 /** The block size, in Bytes. */
kadonotakashi 0:8fdf9a60065b 271 unsigned int block_size;
kadonotakashi 0:8fdf9a60065b 272
kadonotakashi 0:8fdf9a60065b 273 /** Struct for base cipher information and functions. */
kadonotakashi 0:8fdf9a60065b 274 const mbedtls_cipher_base_t *base;
kadonotakashi 0:8fdf9a60065b 275
kadonotakashi 0:8fdf9a60065b 276 } mbedtls_cipher_info_t;
kadonotakashi 0:8fdf9a60065b 277
kadonotakashi 0:8fdf9a60065b 278 /**
kadonotakashi 0:8fdf9a60065b 279 * Generic cipher context.
kadonotakashi 0:8fdf9a60065b 280 */
kadonotakashi 0:8fdf9a60065b 281 typedef struct mbedtls_cipher_context_t
kadonotakashi 0:8fdf9a60065b 282 {
kadonotakashi 0:8fdf9a60065b 283 /** Information about the associated cipher. */
kadonotakashi 0:8fdf9a60065b 284 const mbedtls_cipher_info_t *cipher_info;
kadonotakashi 0:8fdf9a60065b 285
kadonotakashi 0:8fdf9a60065b 286 /** Key length to use. */
kadonotakashi 0:8fdf9a60065b 287 int key_bitlen;
kadonotakashi 0:8fdf9a60065b 288
kadonotakashi 0:8fdf9a60065b 289 /** Operation that the key of the context has been
kadonotakashi 0:8fdf9a60065b 290 * initialized for.
kadonotakashi 0:8fdf9a60065b 291 */
kadonotakashi 0:8fdf9a60065b 292 mbedtls_operation_t operation;
kadonotakashi 0:8fdf9a60065b 293
kadonotakashi 0:8fdf9a60065b 294 #if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
kadonotakashi 0:8fdf9a60065b 295 /** Padding functions to use, if relevant for
kadonotakashi 0:8fdf9a60065b 296 * the specific cipher mode.
kadonotakashi 0:8fdf9a60065b 297 */
kadonotakashi 0:8fdf9a60065b 298 void (*add_padding)( unsigned char *output, size_t olen, size_t data_len );
kadonotakashi 0:8fdf9a60065b 299 int (*get_padding)( unsigned char *input, size_t ilen, size_t *data_len );
kadonotakashi 0:8fdf9a60065b 300 #endif
kadonotakashi 0:8fdf9a60065b 301
kadonotakashi 0:8fdf9a60065b 302 /** Buffer for input that has not been processed yet. */
kadonotakashi 0:8fdf9a60065b 303 unsigned char unprocessed_data[MBEDTLS_MAX_BLOCK_LENGTH];
kadonotakashi 0:8fdf9a60065b 304
kadonotakashi 0:8fdf9a60065b 305 /** Number of Bytes that have not been processed yet. */
kadonotakashi 0:8fdf9a60065b 306 size_t unprocessed_len;
kadonotakashi 0:8fdf9a60065b 307
kadonotakashi 0:8fdf9a60065b 308 /** Current IV or NONCE_COUNTER for CTR-mode, data unit (or sector) number
kadonotakashi 0:8fdf9a60065b 309 * for XTS-mode. */
kadonotakashi 0:8fdf9a60065b 310 unsigned char iv[MBEDTLS_MAX_IV_LENGTH];
kadonotakashi 0:8fdf9a60065b 311
kadonotakashi 0:8fdf9a60065b 312 /** IV size in Bytes, for ciphers with variable-length IVs. */
kadonotakashi 0:8fdf9a60065b 313 size_t iv_size;
kadonotakashi 0:8fdf9a60065b 314
kadonotakashi 0:8fdf9a60065b 315 /** The cipher-specific context. */
kadonotakashi 0:8fdf9a60065b 316 void *cipher_ctx;
kadonotakashi 0:8fdf9a60065b 317
kadonotakashi 0:8fdf9a60065b 318 #if defined(MBEDTLS_CMAC_C)
kadonotakashi 0:8fdf9a60065b 319 /** CMAC-specific context. */
kadonotakashi 0:8fdf9a60065b 320 mbedtls_cmac_context_t *cmac_ctx;
kadonotakashi 0:8fdf9a60065b 321 #endif
kadonotakashi 0:8fdf9a60065b 322 } mbedtls_cipher_context_t;
kadonotakashi 0:8fdf9a60065b 323
kadonotakashi 0:8fdf9a60065b 324 /**
kadonotakashi 0:8fdf9a60065b 325 * \brief This function retrieves the list of ciphers supported by the generic
kadonotakashi 0:8fdf9a60065b 326 * cipher module.
kadonotakashi 0:8fdf9a60065b 327 *
kadonotakashi 0:8fdf9a60065b 328 * \return A statically-allocated array of ciphers. The last entry
kadonotakashi 0:8fdf9a60065b 329 * is zero.
kadonotakashi 0:8fdf9a60065b 330 */
kadonotakashi 0:8fdf9a60065b 331 const int *mbedtls_cipher_list( void );
kadonotakashi 0:8fdf9a60065b 332
kadonotakashi 0:8fdf9a60065b 333 /**
kadonotakashi 0:8fdf9a60065b 334 * \brief This function retrieves the cipher-information
kadonotakashi 0:8fdf9a60065b 335 * structure associated with the given cipher name.
kadonotakashi 0:8fdf9a60065b 336 *
kadonotakashi 0:8fdf9a60065b 337 * \param cipher_name Name of the cipher to search for.
kadonotakashi 0:8fdf9a60065b 338 *
kadonotakashi 0:8fdf9a60065b 339 * \return The cipher information structure associated with the
kadonotakashi 0:8fdf9a60065b 340 * given \p cipher_name.
kadonotakashi 0:8fdf9a60065b 341 * \return NULL if the associated cipher information is not found.
kadonotakashi 0:8fdf9a60065b 342 */
kadonotakashi 0:8fdf9a60065b 343 const mbedtls_cipher_info_t *mbedtls_cipher_info_from_string( const char *cipher_name );
kadonotakashi 0:8fdf9a60065b 344
kadonotakashi 0:8fdf9a60065b 345 /**
kadonotakashi 0:8fdf9a60065b 346 * \brief This function retrieves the cipher-information
kadonotakashi 0:8fdf9a60065b 347 * structure associated with the given cipher type.
kadonotakashi 0:8fdf9a60065b 348 *
kadonotakashi 0:8fdf9a60065b 349 * \param cipher_type Type of the cipher to search for.
kadonotakashi 0:8fdf9a60065b 350 *
kadonotakashi 0:8fdf9a60065b 351 * \return The cipher information structure associated with the
kadonotakashi 0:8fdf9a60065b 352 * given \p cipher_type.
kadonotakashi 0:8fdf9a60065b 353 * \return NULL if the associated cipher information is not found.
kadonotakashi 0:8fdf9a60065b 354 */
kadonotakashi 0:8fdf9a60065b 355 const mbedtls_cipher_info_t *mbedtls_cipher_info_from_type( const mbedtls_cipher_type_t cipher_type );
kadonotakashi 0:8fdf9a60065b 356
kadonotakashi 0:8fdf9a60065b 357 /**
kadonotakashi 0:8fdf9a60065b 358 * \brief This function retrieves the cipher-information
kadonotakashi 0:8fdf9a60065b 359 * structure associated with the given cipher ID,
kadonotakashi 0:8fdf9a60065b 360 * key size and mode.
kadonotakashi 0:8fdf9a60065b 361 *
kadonotakashi 0:8fdf9a60065b 362 * \param cipher_id The ID of the cipher to search for. For example,
kadonotakashi 0:8fdf9a60065b 363 * #MBEDTLS_CIPHER_ID_AES.
kadonotakashi 0:8fdf9a60065b 364 * \param key_bitlen The length of the key in bits.
kadonotakashi 0:8fdf9a60065b 365 * \param mode The cipher mode. For example, #MBEDTLS_MODE_CBC.
kadonotakashi 0:8fdf9a60065b 366 *
kadonotakashi 0:8fdf9a60065b 367 * \return The cipher information structure associated with the
kadonotakashi 0:8fdf9a60065b 368 * given \p cipher_id.
kadonotakashi 0:8fdf9a60065b 369 * \return NULL if the associated cipher information is not found.
kadonotakashi 0:8fdf9a60065b 370 */
kadonotakashi 0:8fdf9a60065b 371 const mbedtls_cipher_info_t *mbedtls_cipher_info_from_values( const mbedtls_cipher_id_t cipher_id,
kadonotakashi 0:8fdf9a60065b 372 int key_bitlen,
kadonotakashi 0:8fdf9a60065b 373 const mbedtls_cipher_mode_t mode );
kadonotakashi 0:8fdf9a60065b 374
kadonotakashi 0:8fdf9a60065b 375 /**
kadonotakashi 0:8fdf9a60065b 376 * \brief This function initializes a \p cipher_context as NONE.
kadonotakashi 0:8fdf9a60065b 377 */
kadonotakashi 0:8fdf9a60065b 378 void mbedtls_cipher_init( mbedtls_cipher_context_t *ctx );
kadonotakashi 0:8fdf9a60065b 379
kadonotakashi 0:8fdf9a60065b 380 /**
kadonotakashi 0:8fdf9a60065b 381 * \brief This function frees and clears the cipher-specific
kadonotakashi 0:8fdf9a60065b 382 * context of \p ctx. Freeing \p ctx itself remains the
kadonotakashi 0:8fdf9a60065b 383 * responsibility of the caller.
kadonotakashi 0:8fdf9a60065b 384 */
kadonotakashi 0:8fdf9a60065b 385 void mbedtls_cipher_free( mbedtls_cipher_context_t *ctx );
kadonotakashi 0:8fdf9a60065b 386
kadonotakashi 0:8fdf9a60065b 387
kadonotakashi 0:8fdf9a60065b 388 /**
kadonotakashi 0:8fdf9a60065b 389 * \brief This function initializes and fills the cipher-context
kadonotakashi 0:8fdf9a60065b 390 * structure with the appropriate values. It also clears
kadonotakashi 0:8fdf9a60065b 391 * the structure.
kadonotakashi 0:8fdf9a60065b 392 *
kadonotakashi 0:8fdf9a60065b 393 * \param ctx The context to initialize. May not be NULL.
kadonotakashi 0:8fdf9a60065b 394 * \param cipher_info The cipher to use.
kadonotakashi 0:8fdf9a60065b 395 *
kadonotakashi 0:8fdf9a60065b 396 * \return \c 0 on success.
kadonotakashi 0:8fdf9a60065b 397 * \return #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on
kadonotakashi 0:8fdf9a60065b 398 * parameter-verification failure.
kadonotakashi 0:8fdf9a60065b 399 * \return #MBEDTLS_ERR_CIPHER_ALLOC_FAILED if allocation of the
kadonotakashi 0:8fdf9a60065b 400 * cipher-specific context fails.
kadonotakashi 0:8fdf9a60065b 401 *
kadonotakashi 0:8fdf9a60065b 402 * \internal Currently, the function also clears the structure.
kadonotakashi 0:8fdf9a60065b 403 * In future versions, the caller will be required to call
kadonotakashi 0:8fdf9a60065b 404 * mbedtls_cipher_init() on the structure first.
kadonotakashi 0:8fdf9a60065b 405 */
kadonotakashi 0:8fdf9a60065b 406 int mbedtls_cipher_setup( mbedtls_cipher_context_t *ctx, const mbedtls_cipher_info_t *cipher_info );
kadonotakashi 0:8fdf9a60065b 407
kadonotakashi 0:8fdf9a60065b 408 /**
kadonotakashi 0:8fdf9a60065b 409 * \brief This function returns the block size of the given cipher.
kadonotakashi 0:8fdf9a60065b 410 *
kadonotakashi 0:8fdf9a60065b 411 * \param ctx The context of the cipher. Must be initialized.
kadonotakashi 0:8fdf9a60065b 412 *
kadonotakashi 0:8fdf9a60065b 413 * \return The size of the blocks of the cipher.
kadonotakashi 0:8fdf9a60065b 414 * \return 0 if \p ctx has not been initialized.
kadonotakashi 0:8fdf9a60065b 415 */
kadonotakashi 0:8fdf9a60065b 416 static inline unsigned int mbedtls_cipher_get_block_size( const mbedtls_cipher_context_t *ctx )
kadonotakashi 0:8fdf9a60065b 417 {
kadonotakashi 0:8fdf9a60065b 418 if( NULL == ctx || NULL == ctx->cipher_info )
kadonotakashi 0:8fdf9a60065b 419 return 0;
kadonotakashi 0:8fdf9a60065b 420
kadonotakashi 0:8fdf9a60065b 421 return ctx->cipher_info->block_size;
kadonotakashi 0:8fdf9a60065b 422 }
kadonotakashi 0:8fdf9a60065b 423
kadonotakashi 0:8fdf9a60065b 424 /**
kadonotakashi 0:8fdf9a60065b 425 * \brief This function returns the mode of operation for
kadonotakashi 0:8fdf9a60065b 426 * the cipher. For example, MBEDTLS_MODE_CBC.
kadonotakashi 0:8fdf9a60065b 427 *
kadonotakashi 0:8fdf9a60065b 428 * \param ctx The context of the cipher. Must be initialized.
kadonotakashi 0:8fdf9a60065b 429 *
kadonotakashi 0:8fdf9a60065b 430 * \return The mode of operation.
kadonotakashi 0:8fdf9a60065b 431 * \return #MBEDTLS_MODE_NONE if \p ctx has not been initialized.
kadonotakashi 0:8fdf9a60065b 432 */
kadonotakashi 0:8fdf9a60065b 433 static inline mbedtls_cipher_mode_t mbedtls_cipher_get_cipher_mode( const mbedtls_cipher_context_t *ctx )
kadonotakashi 0:8fdf9a60065b 434 {
kadonotakashi 0:8fdf9a60065b 435 if( NULL == ctx || NULL == ctx->cipher_info )
kadonotakashi 0:8fdf9a60065b 436 return MBEDTLS_MODE_NONE;
kadonotakashi 0:8fdf9a60065b 437
kadonotakashi 0:8fdf9a60065b 438 return ctx->cipher_info->mode;
kadonotakashi 0:8fdf9a60065b 439 }
kadonotakashi 0:8fdf9a60065b 440
kadonotakashi 0:8fdf9a60065b 441 /**
kadonotakashi 0:8fdf9a60065b 442 * \brief This function returns the size of the IV or nonce
kadonotakashi 0:8fdf9a60065b 443 * of the cipher, in Bytes.
kadonotakashi 0:8fdf9a60065b 444 *
kadonotakashi 0:8fdf9a60065b 445 * \param ctx The context of the cipher. Must be initialized.
kadonotakashi 0:8fdf9a60065b 446 *
kadonotakashi 0:8fdf9a60065b 447 * \return The recommended IV size if no IV has been set.
kadonotakashi 0:8fdf9a60065b 448 * \return \c 0 for ciphers not using an IV or a nonce.
kadonotakashi 0:8fdf9a60065b 449 * \return The actual size if an IV has been set.
kadonotakashi 0:8fdf9a60065b 450 */
kadonotakashi 0:8fdf9a60065b 451 static inline int mbedtls_cipher_get_iv_size( const mbedtls_cipher_context_t *ctx )
kadonotakashi 0:8fdf9a60065b 452 {
kadonotakashi 0:8fdf9a60065b 453 if( NULL == ctx || NULL == ctx->cipher_info )
kadonotakashi 0:8fdf9a60065b 454 return 0;
kadonotakashi 0:8fdf9a60065b 455
kadonotakashi 0:8fdf9a60065b 456 if( ctx->iv_size != 0 )
kadonotakashi 0:8fdf9a60065b 457 return (int) ctx->iv_size;
kadonotakashi 0:8fdf9a60065b 458
kadonotakashi 0:8fdf9a60065b 459 return (int) ctx->cipher_info->iv_size;
kadonotakashi 0:8fdf9a60065b 460 }
kadonotakashi 0:8fdf9a60065b 461
kadonotakashi 0:8fdf9a60065b 462 /**
kadonotakashi 0:8fdf9a60065b 463 * \brief This function returns the type of the given cipher.
kadonotakashi 0:8fdf9a60065b 464 *
kadonotakashi 0:8fdf9a60065b 465 * \param ctx The context of the cipher. Must be initialized.
kadonotakashi 0:8fdf9a60065b 466 *
kadonotakashi 0:8fdf9a60065b 467 * \return The type of the cipher.
kadonotakashi 0:8fdf9a60065b 468 * \return #MBEDTLS_CIPHER_NONE if \p ctx has not been initialized.
kadonotakashi 0:8fdf9a60065b 469 */
kadonotakashi 0:8fdf9a60065b 470 static inline mbedtls_cipher_type_t mbedtls_cipher_get_type( const mbedtls_cipher_context_t *ctx )
kadonotakashi 0:8fdf9a60065b 471 {
kadonotakashi 0:8fdf9a60065b 472 if( NULL == ctx || NULL == ctx->cipher_info )
kadonotakashi 0:8fdf9a60065b 473 return MBEDTLS_CIPHER_NONE;
kadonotakashi 0:8fdf9a60065b 474
kadonotakashi 0:8fdf9a60065b 475 return ctx->cipher_info->type;
kadonotakashi 0:8fdf9a60065b 476 }
kadonotakashi 0:8fdf9a60065b 477
kadonotakashi 0:8fdf9a60065b 478 /**
kadonotakashi 0:8fdf9a60065b 479 * \brief This function returns the name of the given cipher
kadonotakashi 0:8fdf9a60065b 480 * as a string.
kadonotakashi 0:8fdf9a60065b 481 *
kadonotakashi 0:8fdf9a60065b 482 * \param ctx The context of the cipher. Must be initialized.
kadonotakashi 0:8fdf9a60065b 483 *
kadonotakashi 0:8fdf9a60065b 484 * \return The name of the cipher.
kadonotakashi 0:8fdf9a60065b 485 * \return NULL if \p ctx has not been not initialized.
kadonotakashi 0:8fdf9a60065b 486 */
kadonotakashi 0:8fdf9a60065b 487 static inline const char *mbedtls_cipher_get_name( const mbedtls_cipher_context_t *ctx )
kadonotakashi 0:8fdf9a60065b 488 {
kadonotakashi 0:8fdf9a60065b 489 if( NULL == ctx || NULL == ctx->cipher_info )
kadonotakashi 0:8fdf9a60065b 490 return 0;
kadonotakashi 0:8fdf9a60065b 491
kadonotakashi 0:8fdf9a60065b 492 return ctx->cipher_info->name;
kadonotakashi 0:8fdf9a60065b 493 }
kadonotakashi 0:8fdf9a60065b 494
kadonotakashi 0:8fdf9a60065b 495 /**
kadonotakashi 0:8fdf9a60065b 496 * \brief This function returns the key length of the cipher.
kadonotakashi 0:8fdf9a60065b 497 *
kadonotakashi 0:8fdf9a60065b 498 * \param ctx The context of the cipher. Must be initialized.
kadonotakashi 0:8fdf9a60065b 499 *
kadonotakashi 0:8fdf9a60065b 500 * \return The key length of the cipher in bits.
kadonotakashi 0:8fdf9a60065b 501 * \return #MBEDTLS_KEY_LENGTH_NONE if ctx \p has not been
kadonotakashi 0:8fdf9a60065b 502 * initialized.
kadonotakashi 0:8fdf9a60065b 503 */
kadonotakashi 0:8fdf9a60065b 504 static inline int mbedtls_cipher_get_key_bitlen( const mbedtls_cipher_context_t *ctx )
kadonotakashi 0:8fdf9a60065b 505 {
kadonotakashi 0:8fdf9a60065b 506 if( NULL == ctx || NULL == ctx->cipher_info )
kadonotakashi 0:8fdf9a60065b 507 return MBEDTLS_KEY_LENGTH_NONE;
kadonotakashi 0:8fdf9a60065b 508
kadonotakashi 0:8fdf9a60065b 509 return (int) ctx->cipher_info->key_bitlen;
kadonotakashi 0:8fdf9a60065b 510 }
kadonotakashi 0:8fdf9a60065b 511
kadonotakashi 0:8fdf9a60065b 512 /**
kadonotakashi 0:8fdf9a60065b 513 * \brief This function returns the operation of the given cipher.
kadonotakashi 0:8fdf9a60065b 514 *
kadonotakashi 0:8fdf9a60065b 515 * \param ctx The context of the cipher. Must be initialized.
kadonotakashi 0:8fdf9a60065b 516 *
kadonotakashi 0:8fdf9a60065b 517 * \return The type of operation: #MBEDTLS_ENCRYPT or #MBEDTLS_DECRYPT.
kadonotakashi 0:8fdf9a60065b 518 * \return #MBEDTLS_OPERATION_NONE if \p ctx has not been initialized.
kadonotakashi 0:8fdf9a60065b 519 */
kadonotakashi 0:8fdf9a60065b 520 static inline mbedtls_operation_t mbedtls_cipher_get_operation( const mbedtls_cipher_context_t *ctx )
kadonotakashi 0:8fdf9a60065b 521 {
kadonotakashi 0:8fdf9a60065b 522 if( NULL == ctx || NULL == ctx->cipher_info )
kadonotakashi 0:8fdf9a60065b 523 return MBEDTLS_OPERATION_NONE;
kadonotakashi 0:8fdf9a60065b 524
kadonotakashi 0:8fdf9a60065b 525 return ctx->operation;
kadonotakashi 0:8fdf9a60065b 526 }
kadonotakashi 0:8fdf9a60065b 527
kadonotakashi 0:8fdf9a60065b 528 /**
kadonotakashi 0:8fdf9a60065b 529 * \brief This function sets the key to use with the given context.
kadonotakashi 0:8fdf9a60065b 530 *
kadonotakashi 0:8fdf9a60065b 531 * \param ctx The generic cipher context. May not be NULL. Must have
kadonotakashi 0:8fdf9a60065b 532 * been initialized using mbedtls_cipher_info_from_type()
kadonotakashi 0:8fdf9a60065b 533 * or mbedtls_cipher_info_from_string().
kadonotakashi 0:8fdf9a60065b 534 * \param key The key to use.
kadonotakashi 0:8fdf9a60065b 535 * \param key_bitlen The key length to use, in bits.
kadonotakashi 0:8fdf9a60065b 536 * \param operation The operation that the key will be used for:
kadonotakashi 0:8fdf9a60065b 537 * #MBEDTLS_ENCRYPT or #MBEDTLS_DECRYPT.
kadonotakashi 0:8fdf9a60065b 538 *
kadonotakashi 0:8fdf9a60065b 539 * \return \c 0 on success.
kadonotakashi 0:8fdf9a60065b 540 * \return #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on
kadonotakashi 0:8fdf9a60065b 541 * parameter-verification failure.
kadonotakashi 0:8fdf9a60065b 542 * \return A cipher-specific error code on failure.
kadonotakashi 0:8fdf9a60065b 543 */
kadonotakashi 0:8fdf9a60065b 544 int mbedtls_cipher_setkey( mbedtls_cipher_context_t *ctx, const unsigned char *key,
kadonotakashi 0:8fdf9a60065b 545 int key_bitlen, const mbedtls_operation_t operation );
kadonotakashi 0:8fdf9a60065b 546
kadonotakashi 0:8fdf9a60065b 547 #if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
kadonotakashi 0:8fdf9a60065b 548 /**
kadonotakashi 0:8fdf9a60065b 549 * \brief This function sets the padding mode, for cipher modes
kadonotakashi 0:8fdf9a60065b 550 * that use padding.
kadonotakashi 0:8fdf9a60065b 551 *
kadonotakashi 0:8fdf9a60065b 552 * The default passing mode is PKCS7 padding.
kadonotakashi 0:8fdf9a60065b 553 *
kadonotakashi 0:8fdf9a60065b 554 * \param ctx The generic cipher context.
kadonotakashi 0:8fdf9a60065b 555 * \param mode The padding mode.
kadonotakashi 0:8fdf9a60065b 556 *
kadonotakashi 0:8fdf9a60065b 557 * \return \c 0 on success.
kadonotakashi 0:8fdf9a60065b 558 * \return #MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE
kadonotakashi 0:8fdf9a60065b 559 * if the selected padding mode is not supported.
kadonotakashi 0:8fdf9a60065b 560 * \return #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA if the cipher mode
kadonotakashi 0:8fdf9a60065b 561 * does not support padding.
kadonotakashi 0:8fdf9a60065b 562 */
kadonotakashi 0:8fdf9a60065b 563 int mbedtls_cipher_set_padding_mode( mbedtls_cipher_context_t *ctx, mbedtls_cipher_padding_t mode );
kadonotakashi 0:8fdf9a60065b 564 #endif /* MBEDTLS_CIPHER_MODE_WITH_PADDING */
kadonotakashi 0:8fdf9a60065b 565
kadonotakashi 0:8fdf9a60065b 566 /**
kadonotakashi 0:8fdf9a60065b 567 * \brief This function sets the initialization vector (IV)
kadonotakashi 0:8fdf9a60065b 568 * or nonce.
kadonotakashi 0:8fdf9a60065b 569 *
kadonotakashi 0:8fdf9a60065b 570 * \note Some ciphers do not use IVs nor nonce. For these
kadonotakashi 0:8fdf9a60065b 571 * ciphers, this function has no effect.
kadonotakashi 0:8fdf9a60065b 572 *
kadonotakashi 0:8fdf9a60065b 573 * \param ctx The generic cipher context.
kadonotakashi 0:8fdf9a60065b 574 * \param iv The IV to use, or NONCE_COUNTER for CTR-mode ciphers.
kadonotakashi 0:8fdf9a60065b 575 * \param iv_len The IV length for ciphers with variable-size IV.
kadonotakashi 0:8fdf9a60065b 576 * This parameter is discarded by ciphers with fixed-size IV.
kadonotakashi 0:8fdf9a60065b 577 *
kadonotakashi 0:8fdf9a60065b 578 * \return \c 0 on success.
kadonotakashi 0:8fdf9a60065b 579 * \return #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on
kadonotakashi 0:8fdf9a60065b 580 * parameter-verification failure.
kadonotakashi 0:8fdf9a60065b 581 */
kadonotakashi 0:8fdf9a60065b 582 int mbedtls_cipher_set_iv( mbedtls_cipher_context_t *ctx,
kadonotakashi 0:8fdf9a60065b 583 const unsigned char *iv, size_t iv_len );
kadonotakashi 0:8fdf9a60065b 584
kadonotakashi 0:8fdf9a60065b 585 /**
kadonotakashi 0:8fdf9a60065b 586 * \brief This function resets the cipher state.
kadonotakashi 0:8fdf9a60065b 587 *
kadonotakashi 0:8fdf9a60065b 588 * \param ctx The generic cipher context.
kadonotakashi 0:8fdf9a60065b 589 *
kadonotakashi 0:8fdf9a60065b 590 * \return \c 0 on success.
kadonotakashi 0:8fdf9a60065b 591 * \return #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on
kadonotakashi 0:8fdf9a60065b 592 * parameter-verification failure.
kadonotakashi 0:8fdf9a60065b 593 */
kadonotakashi 0:8fdf9a60065b 594 int mbedtls_cipher_reset( mbedtls_cipher_context_t *ctx );
kadonotakashi 0:8fdf9a60065b 595
kadonotakashi 0:8fdf9a60065b 596 #if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CHACHAPOLY_C)
kadonotakashi 0:8fdf9a60065b 597 /**
kadonotakashi 0:8fdf9a60065b 598 * \brief This function adds additional data for AEAD ciphers.
kadonotakashi 0:8fdf9a60065b 599 * Currently supported with GCM and ChaCha20+Poly1305.
kadonotakashi 0:8fdf9a60065b 600 * Must be called exactly once, after mbedtls_cipher_reset().
kadonotakashi 0:8fdf9a60065b 601 *
kadonotakashi 0:8fdf9a60065b 602 * \param ctx The generic cipher context.
kadonotakashi 0:8fdf9a60065b 603 * \param ad The additional data to use.
kadonotakashi 0:8fdf9a60065b 604 * \param ad_len the Length of \p ad.
kadonotakashi 0:8fdf9a60065b 605 *
kadonotakashi 0:8fdf9a60065b 606 * \return \c 0 on success.
kadonotakashi 0:8fdf9a60065b 607 * \return A specific error code on failure.
kadonotakashi 0:8fdf9a60065b 608 */
kadonotakashi 0:8fdf9a60065b 609 int mbedtls_cipher_update_ad( mbedtls_cipher_context_t *ctx,
kadonotakashi 0:8fdf9a60065b 610 const unsigned char *ad, size_t ad_len );
kadonotakashi 0:8fdf9a60065b 611 #endif /* MBEDTLS_GCM_C || MBEDTLS_CHACHAPOLY_C */
kadonotakashi 0:8fdf9a60065b 612
kadonotakashi 0:8fdf9a60065b 613 /**
kadonotakashi 0:8fdf9a60065b 614 * \brief The generic cipher update function. It encrypts or
kadonotakashi 0:8fdf9a60065b 615 * decrypts using the given cipher context. Writes as
kadonotakashi 0:8fdf9a60065b 616 * many block-sized blocks of data as possible to output.
kadonotakashi 0:8fdf9a60065b 617 * Any data that cannot be written immediately is either
kadonotakashi 0:8fdf9a60065b 618 * added to the next block, or flushed when
kadonotakashi 0:8fdf9a60065b 619 * mbedtls_cipher_finish() is called.
kadonotakashi 0:8fdf9a60065b 620 * Exception: For MBEDTLS_MODE_ECB, expects a single block
kadonotakashi 0:8fdf9a60065b 621 * in size. For example, 16 Bytes for AES.
kadonotakashi 0:8fdf9a60065b 622 *
kadonotakashi 0:8fdf9a60065b 623 * \note If the underlying cipher is used in GCM mode, all calls
kadonotakashi 0:8fdf9a60065b 624 * to this function, except for the last one before
kadonotakashi 0:8fdf9a60065b 625 * mbedtls_cipher_finish(), must have \p ilen as a
kadonotakashi 0:8fdf9a60065b 626 * multiple of the block size of the cipher.
kadonotakashi 0:8fdf9a60065b 627 *
kadonotakashi 0:8fdf9a60065b 628 * \param ctx The generic cipher context.
kadonotakashi 0:8fdf9a60065b 629 * \param input The buffer holding the input data.
kadonotakashi 0:8fdf9a60065b 630 * \param ilen The length of the input data.
kadonotakashi 0:8fdf9a60065b 631 * \param output The buffer for the output data. Must be able to hold at
kadonotakashi 0:8fdf9a60065b 632 * least \p ilen + block_size. Must not be the same buffer
kadonotakashi 0:8fdf9a60065b 633 * as input.
kadonotakashi 0:8fdf9a60065b 634 * \param olen The length of the output data, to be updated with the
kadonotakashi 0:8fdf9a60065b 635 * actual number of Bytes written.
kadonotakashi 0:8fdf9a60065b 636 *
kadonotakashi 0:8fdf9a60065b 637 * \return \c 0 on success.
kadonotakashi 0:8fdf9a60065b 638 * \return #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on
kadonotakashi 0:8fdf9a60065b 639 * parameter-verification failure.
kadonotakashi 0:8fdf9a60065b 640 * \return #MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE on an
kadonotakashi 0:8fdf9a60065b 641 * unsupported mode for a cipher.
kadonotakashi 0:8fdf9a60065b 642 * \return A cipher-specific error code on failure.
kadonotakashi 0:8fdf9a60065b 643 */
kadonotakashi 0:8fdf9a60065b 644 int mbedtls_cipher_update( mbedtls_cipher_context_t *ctx, const unsigned char *input,
kadonotakashi 0:8fdf9a60065b 645 size_t ilen, unsigned char *output, size_t *olen );
kadonotakashi 0:8fdf9a60065b 646
kadonotakashi 0:8fdf9a60065b 647 /**
kadonotakashi 0:8fdf9a60065b 648 * \brief The generic cipher finalization function. If data still
kadonotakashi 0:8fdf9a60065b 649 * needs to be flushed from an incomplete block, the data
kadonotakashi 0:8fdf9a60065b 650 * contained in it is padded to the size of
kadonotakashi 0:8fdf9a60065b 651 * the last block, and written to the \p output buffer.
kadonotakashi 0:8fdf9a60065b 652 *
kadonotakashi 0:8fdf9a60065b 653 * \param ctx The generic cipher context.
kadonotakashi 0:8fdf9a60065b 654 * \param output The buffer to write data to. Needs block_size available.
kadonotakashi 0:8fdf9a60065b 655 * \param olen The length of the data written to the \p output buffer.
kadonotakashi 0:8fdf9a60065b 656 *
kadonotakashi 0:8fdf9a60065b 657 * \return \c 0 on success.
kadonotakashi 0:8fdf9a60065b 658 * \return #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on
kadonotakashi 0:8fdf9a60065b 659 * parameter-verification failure.
kadonotakashi 0:8fdf9a60065b 660 * \return #MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED on decryption
kadonotakashi 0:8fdf9a60065b 661 * expecting a full block but not receiving one.
kadonotakashi 0:8fdf9a60065b 662 * \return #MBEDTLS_ERR_CIPHER_INVALID_PADDING on invalid padding
kadonotakashi 0:8fdf9a60065b 663 * while decrypting.
kadonotakashi 0:8fdf9a60065b 664 * \return A cipher-specific error code on failure.
kadonotakashi 0:8fdf9a60065b 665 */
kadonotakashi 0:8fdf9a60065b 666 int mbedtls_cipher_finish( mbedtls_cipher_context_t *ctx,
kadonotakashi 0:8fdf9a60065b 667 unsigned char *output, size_t *olen );
kadonotakashi 0:8fdf9a60065b 668
kadonotakashi 0:8fdf9a60065b 669 #if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CHACHAPOLY_C)
kadonotakashi 0:8fdf9a60065b 670 /**
kadonotakashi 0:8fdf9a60065b 671 * \brief This function writes a tag for AEAD ciphers.
kadonotakashi 0:8fdf9a60065b 672 * Currently supported with GCM and ChaCha20+Poly1305.
kadonotakashi 0:8fdf9a60065b 673 * Must be called after mbedtls_cipher_finish().
kadonotakashi 0:8fdf9a60065b 674 *
kadonotakashi 0:8fdf9a60065b 675 * \param ctx The generic cipher context.
kadonotakashi 0:8fdf9a60065b 676 * \param tag The buffer to write the tag to.
kadonotakashi 0:8fdf9a60065b 677 * \param tag_len The length of the tag to write.
kadonotakashi 0:8fdf9a60065b 678 *
kadonotakashi 0:8fdf9a60065b 679 * \return \c 0 on success.
kadonotakashi 0:8fdf9a60065b 680 * \return A specific error code on failure.
kadonotakashi 0:8fdf9a60065b 681 */
kadonotakashi 0:8fdf9a60065b 682 int mbedtls_cipher_write_tag( mbedtls_cipher_context_t *ctx,
kadonotakashi 0:8fdf9a60065b 683 unsigned char *tag, size_t tag_len );
kadonotakashi 0:8fdf9a60065b 684
kadonotakashi 0:8fdf9a60065b 685 /**
kadonotakashi 0:8fdf9a60065b 686 * \brief This function checks the tag for AEAD ciphers.
kadonotakashi 0:8fdf9a60065b 687 * Currently supported with GCM and ChaCha20+Poly1305.
kadonotakashi 0:8fdf9a60065b 688 * Must be called after mbedtls_cipher_finish().
kadonotakashi 0:8fdf9a60065b 689 *
kadonotakashi 0:8fdf9a60065b 690 * \param ctx The generic cipher context.
kadonotakashi 0:8fdf9a60065b 691 * \param tag The buffer holding the tag.
kadonotakashi 0:8fdf9a60065b 692 * \param tag_len The length of the tag to check.
kadonotakashi 0:8fdf9a60065b 693 *
kadonotakashi 0:8fdf9a60065b 694 * \return \c 0 on success.
kadonotakashi 0:8fdf9a60065b 695 * \return A specific error code on failure.
kadonotakashi 0:8fdf9a60065b 696 */
kadonotakashi 0:8fdf9a60065b 697 int mbedtls_cipher_check_tag( mbedtls_cipher_context_t *ctx,
kadonotakashi 0:8fdf9a60065b 698 const unsigned char *tag, size_t tag_len );
kadonotakashi 0:8fdf9a60065b 699 #endif /* MBEDTLS_GCM_C || MBEDTLS_CHACHAPOLY_C */
kadonotakashi 0:8fdf9a60065b 700
kadonotakashi 0:8fdf9a60065b 701 /**
kadonotakashi 0:8fdf9a60065b 702 * \brief The generic all-in-one encryption/decryption function,
kadonotakashi 0:8fdf9a60065b 703 * for all ciphers except AEAD constructs.
kadonotakashi 0:8fdf9a60065b 704 *
kadonotakashi 0:8fdf9a60065b 705 * \param ctx The generic cipher context.
kadonotakashi 0:8fdf9a60065b 706 * \param iv The IV to use, or NONCE_COUNTER for CTR-mode ciphers.
kadonotakashi 0:8fdf9a60065b 707 * \param iv_len The IV length for ciphers with variable-size IV.
kadonotakashi 0:8fdf9a60065b 708 * This parameter is discarded by ciphers with fixed-size
kadonotakashi 0:8fdf9a60065b 709 * IV.
kadonotakashi 0:8fdf9a60065b 710 * \param input The buffer holding the input data.
kadonotakashi 0:8fdf9a60065b 711 * \param ilen The length of the input data.
kadonotakashi 0:8fdf9a60065b 712 * \param output The buffer for the output data. Must be able to hold at
kadonotakashi 0:8fdf9a60065b 713 * least \p ilen + block_size. Must not be the same buffer
kadonotakashi 0:8fdf9a60065b 714 * as input.
kadonotakashi 0:8fdf9a60065b 715 * \param olen The length of the output data, to be updated with the
kadonotakashi 0:8fdf9a60065b 716 * actual number of Bytes written.
kadonotakashi 0:8fdf9a60065b 717 *
kadonotakashi 0:8fdf9a60065b 718 * \note Some ciphers do not use IVs nor nonce. For these
kadonotakashi 0:8fdf9a60065b 719 * ciphers, use \p iv = NULL and \p iv_len = 0.
kadonotakashi 0:8fdf9a60065b 720 *
kadonotakashi 0:8fdf9a60065b 721 * \return \c 0 on success.
kadonotakashi 0:8fdf9a60065b 722 * \return #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on
kadonotakashi 0:8fdf9a60065b 723 * parameter-verification failure.
kadonotakashi 0:8fdf9a60065b 724 * \return #MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED on decryption
kadonotakashi 0:8fdf9a60065b 725 * expecting a full block but not receiving one.
kadonotakashi 0:8fdf9a60065b 726 * \return #MBEDTLS_ERR_CIPHER_INVALID_PADDING on invalid padding
kadonotakashi 0:8fdf9a60065b 727 * while decrypting.
kadonotakashi 0:8fdf9a60065b 728 * \return A cipher-specific error code on failure.
kadonotakashi 0:8fdf9a60065b 729 */
kadonotakashi 0:8fdf9a60065b 730 int mbedtls_cipher_crypt( mbedtls_cipher_context_t *ctx,
kadonotakashi 0:8fdf9a60065b 731 const unsigned char *iv, size_t iv_len,
kadonotakashi 0:8fdf9a60065b 732 const unsigned char *input, size_t ilen,
kadonotakashi 0:8fdf9a60065b 733 unsigned char *output, size_t *olen );
kadonotakashi 0:8fdf9a60065b 734
kadonotakashi 0:8fdf9a60065b 735 #if defined(MBEDTLS_CIPHER_MODE_AEAD)
kadonotakashi 0:8fdf9a60065b 736 /**
kadonotakashi 0:8fdf9a60065b 737 * \brief The generic autenticated encryption (AEAD) function.
kadonotakashi 0:8fdf9a60065b 738 *
kadonotakashi 0:8fdf9a60065b 739 * \param ctx The generic cipher context.
kadonotakashi 0:8fdf9a60065b 740 * \param iv The IV to use, or NONCE_COUNTER for CTR-mode ciphers.
kadonotakashi 0:8fdf9a60065b 741 * \param iv_len The IV length for ciphers with variable-size IV.
kadonotakashi 0:8fdf9a60065b 742 * This parameter is discarded by ciphers with fixed-size IV.
kadonotakashi 0:8fdf9a60065b 743 * \param ad The additional data to authenticate.
kadonotakashi 0:8fdf9a60065b 744 * \param ad_len The length of \p ad.
kadonotakashi 0:8fdf9a60065b 745 * \param input The buffer holding the input data.
kadonotakashi 0:8fdf9a60065b 746 * \param ilen The length of the input data.
kadonotakashi 0:8fdf9a60065b 747 * \param output The buffer for the output data.
kadonotakashi 0:8fdf9a60065b 748 * Must be able to hold at least \p ilen.
kadonotakashi 0:8fdf9a60065b 749 * \param olen The length of the output data, to be updated with the
kadonotakashi 0:8fdf9a60065b 750 * actual number of Bytes written.
kadonotakashi 0:8fdf9a60065b 751 * \param tag The buffer for the authentication tag.
kadonotakashi 0:8fdf9a60065b 752 * \param tag_len The desired length of the authentication tag.
kadonotakashi 0:8fdf9a60065b 753 *
kadonotakashi 0:8fdf9a60065b 754 * \return \c 0 on success.
kadonotakashi 0:8fdf9a60065b 755 * \return #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on
kadonotakashi 0:8fdf9a60065b 756 * parameter-verification failure.
kadonotakashi 0:8fdf9a60065b 757 * \return A cipher-specific error code on failure.
kadonotakashi 0:8fdf9a60065b 758 */
kadonotakashi 0:8fdf9a60065b 759 int mbedtls_cipher_auth_encrypt( mbedtls_cipher_context_t *ctx,
kadonotakashi 0:8fdf9a60065b 760 const unsigned char *iv, size_t iv_len,
kadonotakashi 0:8fdf9a60065b 761 const unsigned char *ad, size_t ad_len,
kadonotakashi 0:8fdf9a60065b 762 const unsigned char *input, size_t ilen,
kadonotakashi 0:8fdf9a60065b 763 unsigned char *output, size_t *olen,
kadonotakashi 0:8fdf9a60065b 764 unsigned char *tag, size_t tag_len );
kadonotakashi 0:8fdf9a60065b 765
kadonotakashi 0:8fdf9a60065b 766 /**
kadonotakashi 0:8fdf9a60065b 767 * \brief The generic autenticated decryption (AEAD) function.
kadonotakashi 0:8fdf9a60065b 768 *
kadonotakashi 0:8fdf9a60065b 769 * \note If the data is not authentic, then the output buffer
kadonotakashi 0:8fdf9a60065b 770 * is zeroed out to prevent the unauthentic plaintext being
kadonotakashi 0:8fdf9a60065b 771 * used, making this interface safer.
kadonotakashi 0:8fdf9a60065b 772 *
kadonotakashi 0:8fdf9a60065b 773 * \param ctx The generic cipher context.
kadonotakashi 0:8fdf9a60065b 774 * \param iv The IV to use, or NONCE_COUNTER for CTR-mode ciphers.
kadonotakashi 0:8fdf9a60065b 775 * \param iv_len The IV length for ciphers with variable-size IV.
kadonotakashi 0:8fdf9a60065b 776 * This parameter is discarded by ciphers with fixed-size IV.
kadonotakashi 0:8fdf9a60065b 777 * \param ad The additional data to be authenticated.
kadonotakashi 0:8fdf9a60065b 778 * \param ad_len The length of \p ad.
kadonotakashi 0:8fdf9a60065b 779 * \param input The buffer holding the input data.
kadonotakashi 0:8fdf9a60065b 780 * \param ilen The length of the input data.
kadonotakashi 0:8fdf9a60065b 781 * \param output The buffer for the output data.
kadonotakashi 0:8fdf9a60065b 782 * Must be able to hold at least \p ilen.
kadonotakashi 0:8fdf9a60065b 783 * \param olen The length of the output data, to be updated with the
kadonotakashi 0:8fdf9a60065b 784 * actual number of Bytes written.
kadonotakashi 0:8fdf9a60065b 785 * \param tag The buffer holding the authentication tag.
kadonotakashi 0:8fdf9a60065b 786 * \param tag_len The length of the authentication tag.
kadonotakashi 0:8fdf9a60065b 787 *
kadonotakashi 0:8fdf9a60065b 788 * \return \c 0 on success.
kadonotakashi 0:8fdf9a60065b 789 * \return #MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA on
kadonotakashi 0:8fdf9a60065b 790 * parameter-verification failure.
kadonotakashi 0:8fdf9a60065b 791 * \return #MBEDTLS_ERR_CIPHER_AUTH_FAILED if data is not authentic.
kadonotakashi 0:8fdf9a60065b 792 * \return A cipher-specific error code on failure.
kadonotakashi 0:8fdf9a60065b 793 */
kadonotakashi 0:8fdf9a60065b 794 int mbedtls_cipher_auth_decrypt( mbedtls_cipher_context_t *ctx,
kadonotakashi 0:8fdf9a60065b 795 const unsigned char *iv, size_t iv_len,
kadonotakashi 0:8fdf9a60065b 796 const unsigned char *ad, size_t ad_len,
kadonotakashi 0:8fdf9a60065b 797 const unsigned char *input, size_t ilen,
kadonotakashi 0:8fdf9a60065b 798 unsigned char *output, size_t *olen,
kadonotakashi 0:8fdf9a60065b 799 const unsigned char *tag, size_t tag_len );
kadonotakashi 0:8fdf9a60065b 800 #endif /* MBEDTLS_CIPHER_MODE_AEAD */
kadonotakashi 0:8fdf9a60065b 801
kadonotakashi 0:8fdf9a60065b 802 #ifdef __cplusplus
kadonotakashi 0:8fdf9a60065b 803 }
kadonotakashi 0:8fdf9a60065b 804 #endif
kadonotakashi 0:8fdf9a60065b 805
kadonotakashi 0:8fdf9a60065b 806 #endif /* MBEDTLS_CIPHER_H */