1 /** 2 * \file aria.h 3 * 4 * \brief ARIA block cipher 5 * 6 * The ARIA algorithm is a symmetric block cipher that can encrypt and 7 * decrypt information. It is defined by the Korean Agency for 8 * Technology and Standards (KATS) in <em>KS X 1213:2004</em> (in 9 * Korean, but see http://210.104.33.10/ARIA/index-e.html in English) 10 * and also described by the IETF in <em>RFC 5794</em>. 11 */ 12 /* 13 * Copyright The Mbed TLS Contributors 14 * SPDX-License-Identifier: Apache-2.0 15 * 16 * Licensed under the Apache License, Version 2.0 (the "License"); you may 17 * not use this file except in compliance with the License. 18 * You may obtain a copy of the License at 19 * 20 * http://www.apache.org/licenses/LICENSE-2.0 21 * 22 * Unless required by applicable law or agreed to in writing, software 23 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 24 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 25 * See the License for the specific language governing permissions and 26 * limitations under the License. 27 */ 28 29 #ifndef MBEDTLS_ARIA_H 30 #define MBEDTLS_ARIA_H 31 32 #if !defined(MBEDTLS_CONFIG_FILE) 33 #include "mbedtls/config.h" 34 #else 35 #include MBEDTLS_CONFIG_FILE 36 #endif 37 38 #include <stddef.h> 39 #include <stdint.h> 40 41 #include "mbedtls/platform_util.h" 42 43 #define MBEDTLS_ARIA_ENCRYPT 1 /**< ARIA encryption. */ 44 #define MBEDTLS_ARIA_DECRYPT 0 /**< ARIA decryption. */ 45 46 #define MBEDTLS_ARIA_BLOCKSIZE 16 /**< ARIA block size in bytes. */ 47 #define MBEDTLS_ARIA_MAX_ROUNDS 16 /**< Maxiumum number of rounds in ARIA. */ 48 #define MBEDTLS_ARIA_MAX_KEYSIZE 32 /**< Maximum size of an ARIA key in bytes. */ 49 50 #if !defined(MBEDTLS_DEPRECATED_REMOVED) 51 #define MBEDTLS_ERR_ARIA_INVALID_KEY_LENGTH MBEDTLS_DEPRECATED_NUMERIC_CONSTANT( -0x005C ) 52 #endif /* !MBEDTLS_DEPRECATED_REMOVED */ 53 /** Bad input data. */ 54 #define MBEDTLS_ERR_ARIA_BAD_INPUT_DATA -0x005C 55 56 /** Invalid data input length. */ 57 #define MBEDTLS_ERR_ARIA_INVALID_INPUT_LENGTH -0x005E 58 59 /* MBEDTLS_ERR_ARIA_FEATURE_UNAVAILABLE is deprecated and should not be used. 60 */ 61 /** Feature not available. For example, an unsupported ARIA key size. */ 62 #define MBEDTLS_ERR_ARIA_FEATURE_UNAVAILABLE -0x005A 63 64 /* MBEDTLS_ERR_ARIA_HW_ACCEL_FAILED is deprecated and should not be used. */ 65 /** ARIA hardware accelerator failed. */ 66 #define MBEDTLS_ERR_ARIA_HW_ACCEL_FAILED -0x0058 67 68 #ifdef __cplusplus 69 extern "C" { 70 #endif 71 72 #if !defined(MBEDTLS_ARIA_ALT) 73 // Regular implementation 74 // 75 76 /** 77 * \brief The ARIA context-type definition. 78 */ 79 typedef struct mbedtls_aria_context 80 { 81 unsigned char nr; /*!< The number of rounds (12, 14 or 16) */ 82 /*! The ARIA round keys. */ 83 uint32_t rk[MBEDTLS_ARIA_MAX_ROUNDS + 1][MBEDTLS_ARIA_BLOCKSIZE / 4]; 84 } 85 mbedtls_aria_context; 86 87 #else /* MBEDTLS_ARIA_ALT */ 88 #include "aria_alt.h" 89 #endif /* MBEDTLS_ARIA_ALT */ 90 91 /** 92 * \brief This function initializes the specified ARIA context. 93 * 94 * It must be the first API called before using 95 * the context. 96 * 97 * \param ctx The ARIA context to initialize. This must not be \c NULL. 98 */ 99 void mbedtls_aria_init( mbedtls_aria_context *ctx ); 100 101 /** 102 * \brief This function releases and clears the specified ARIA context. 103 * 104 * \param ctx The ARIA context to clear. This may be \c NULL, in which 105 * case this function returns immediately. If it is not \c NULL, 106 * it must point to an initialized ARIA context. 107 */ 108 void mbedtls_aria_free( mbedtls_aria_context *ctx ); 109 110 /** 111 * \brief This function sets the encryption key. 112 * 113 * \param ctx The ARIA context to which the key should be bound. 114 * This must be initialized. 115 * \param key The encryption key. This must be a readable buffer 116 * of size \p keybits Bits. 117 * \param keybits The size of \p key in Bits. Valid options are: 118 * <ul><li>128 bits</li> 119 * <li>192 bits</li> 120 * <li>256 bits</li></ul> 121 * 122 * \return \c 0 on success. 123 * \return A negative error code on failure. 124 */ 125 int mbedtls_aria_setkey_enc( mbedtls_aria_context *ctx, 126 const unsigned char *key, 127 unsigned int keybits ); 128 129 /** 130 * \brief This function sets the decryption key. 131 * 132 * \param ctx The ARIA context to which the key should be bound. 133 * This must be initialized. 134 * \param key The decryption key. This must be a readable buffer 135 * of size \p keybits Bits. 136 * \param keybits The size of data passed. Valid options are: 137 * <ul><li>128 bits</li> 138 * <li>192 bits</li> 139 * <li>256 bits</li></ul> 140 * 141 * \return \c 0 on success. 142 * \return A negative error code on failure. 143 */ 144 int mbedtls_aria_setkey_dec( mbedtls_aria_context *ctx, 145 const unsigned char *key, 146 unsigned int keybits ); 147 148 /** 149 * \brief This function performs an ARIA single-block encryption or 150 * decryption operation. 151 * 152 * It performs encryption or decryption (depending on whether 153 * the key was set for encryption on decryption) on the input 154 * data buffer defined in the \p input parameter. 155 * 156 * mbedtls_aria_init(), and either mbedtls_aria_setkey_enc() or 157 * mbedtls_aria_setkey_dec() must be called before the first 158 * call to this API with the same context. 159 * 160 * \param ctx The ARIA context to use for encryption or decryption. 161 * This must be initialized and bound to a key. 162 * \param input The 16-Byte buffer holding the input data. 163 * \param output The 16-Byte buffer holding the output data. 164 165 * \return \c 0 on success. 166 * \return A negative error code on failure. 167 */ 168 int mbedtls_aria_crypt_ecb( mbedtls_aria_context *ctx, 169 const unsigned char input[MBEDTLS_ARIA_BLOCKSIZE], 170 unsigned char output[MBEDTLS_ARIA_BLOCKSIZE] ); 171 172 #if defined(MBEDTLS_CIPHER_MODE_CBC) 173 /** 174 * \brief This function performs an ARIA-CBC encryption or decryption operation 175 * on full blocks. 176 * 177 * It performs the operation defined in the \p mode 178 * parameter (encrypt/decrypt), on the input data buffer defined in 179 * the \p input parameter. 180 * 181 * It can be called as many times as needed, until all the input 182 * data is processed. mbedtls_aria_init(), and either 183 * mbedtls_aria_setkey_enc() or mbedtls_aria_setkey_dec() must be called 184 * before the first call to this API with the same context. 185 * 186 * \note This function operates on aligned blocks, that is, the input size 187 * must be a multiple of the ARIA block size of 16 Bytes. 188 * 189 * \note Upon exit, the content of the IV is updated so that you can 190 * call the same function again on the next 191 * block(s) of data and get the same result as if it was 192 * encrypted in one call. This allows a "streaming" usage. 193 * If you need to retain the contents of the IV, you should 194 * either save it manually or use the cipher module instead. 195 * 196 * 197 * \param ctx The ARIA context to use for encryption or decryption. 198 * This must be initialized and bound to a key. 199 * \param mode The mode of operation. This must be either 200 * #MBEDTLS_ARIA_ENCRYPT for encryption, or 201 * #MBEDTLS_ARIA_DECRYPT for decryption. 202 * \param length The length of the input data in Bytes. This must be a 203 * multiple of the block size (16 Bytes). 204 * \param iv Initialization vector (updated after use). 205 * This must be a readable buffer of size 16 Bytes. 206 * \param input The buffer holding the input data. This must 207 * be a readable buffer of length \p length Bytes. 208 * \param output The buffer holding the output data. This must 209 * be a writable buffer of length \p length Bytes. 210 * 211 * \return \c 0 on success. 212 * \return A negative error code on failure. 213 */ 214 int mbedtls_aria_crypt_cbc( mbedtls_aria_context *ctx, 215 int mode, 216 size_t length, 217 unsigned char iv[MBEDTLS_ARIA_BLOCKSIZE], 218 const unsigned char *input, 219 unsigned char *output ); 220 #endif /* MBEDTLS_CIPHER_MODE_CBC */ 221 222 #if defined(MBEDTLS_CIPHER_MODE_CFB) 223 /** 224 * \brief This function performs an ARIA-CFB128 encryption or decryption 225 * operation. 226 * 227 * It performs the operation defined in the \p mode 228 * parameter (encrypt or decrypt), on the input data buffer 229 * defined in the \p input parameter. 230 * 231 * For CFB, you must set up the context with mbedtls_aria_setkey_enc(), 232 * regardless of whether you are performing an encryption or decryption 233 * operation, that is, regardless of the \p mode parameter. This is 234 * because CFB mode uses the same key schedule for encryption and 235 * decryption. 236 * 237 * \note Upon exit, the content of the IV is updated so that you can 238 * call the same function again on the next 239 * block(s) of data and get the same result as if it was 240 * encrypted in one call. This allows a "streaming" usage. 241 * If you need to retain the contents of the 242 * IV, you must either save it manually or use the cipher 243 * module instead. 244 * 245 * 246 * \param ctx The ARIA context to use for encryption or decryption. 247 * This must be initialized and bound to a key. 248 * \param mode The mode of operation. This must be either 249 * #MBEDTLS_ARIA_ENCRYPT for encryption, or 250 * #MBEDTLS_ARIA_DECRYPT for decryption. 251 * \param length The length of the input data \p input in Bytes. 252 * \param iv_off The offset in IV (updated after use). 253 * This must not be larger than 15. 254 * \param iv The initialization vector (updated after use). 255 * This must be a readable buffer of size 16 Bytes. 256 * \param input The buffer holding the input data. This must 257 * be a readable buffer of length \p length Bytes. 258 * \param output The buffer holding the output data. This must 259 * be a writable buffer of length \p length Bytes. 260 * 261 * \return \c 0 on success. 262 * \return A negative error code on failure. 263 */ 264 int mbedtls_aria_crypt_cfb128( mbedtls_aria_context *ctx, 265 int mode, 266 size_t length, 267 size_t *iv_off, 268 unsigned char iv[MBEDTLS_ARIA_BLOCKSIZE], 269 const unsigned char *input, 270 unsigned char *output ); 271 #endif /* MBEDTLS_CIPHER_MODE_CFB */ 272 273 #if defined(MBEDTLS_CIPHER_MODE_CTR) 274 /** 275 * \brief This function performs an ARIA-CTR encryption or decryption 276 * operation. 277 * 278 * This function performs the operation defined in the \p mode 279 * parameter (encrypt/decrypt), on the input data buffer 280 * defined in the \p input parameter. 281 * 282 * Due to the nature of CTR, you must use the same key schedule 283 * for both encryption and decryption operations. Therefore, you 284 * must use the context initialized with mbedtls_aria_setkey_enc() 285 * for both #MBEDTLS_ARIA_ENCRYPT and #MBEDTLS_ARIA_DECRYPT. 286 * 287 * \warning You must never reuse a nonce value with the same key. Doing so 288 * would void the encryption for the two messages encrypted with 289 * the same nonce and key. 290 * 291 * There are two common strategies for managing nonces with CTR: 292 * 293 * 1. You can handle everything as a single message processed over 294 * successive calls to this function. In that case, you want to 295 * set \p nonce_counter and \p nc_off to 0 for the first call, and 296 * then preserve the values of \p nonce_counter, \p nc_off and \p 297 * stream_block across calls to this function as they will be 298 * updated by this function. 299 * 300 * With this strategy, you must not encrypt more than 2**128 301 * blocks of data with the same key. 302 * 303 * 2. You can encrypt separate messages by dividing the \p 304 * nonce_counter buffer in two areas: the first one used for a 305 * per-message nonce, handled by yourself, and the second one 306 * updated by this function internally. 307 * 308 * For example, you might reserve the first 12 bytes for the 309 * per-message nonce, and the last 4 bytes for internal use. In that 310 * case, before calling this function on a new message you need to 311 * set the first 12 bytes of \p nonce_counter to your chosen nonce 312 * value, the last 4 to 0, and \p nc_off to 0 (which will cause \p 313 * stream_block to be ignored). That way, you can encrypt at most 314 * 2**96 messages of up to 2**32 blocks each with the same key. 315 * 316 * The per-message nonce (or information sufficient to reconstruct 317 * it) needs to be communicated with the ciphertext and must be unique. 318 * The recommended way to ensure uniqueness is to use a message 319 * counter. An alternative is to generate random nonces, but this 320 * limits the number of messages that can be securely encrypted: 321 * for example, with 96-bit random nonces, you should not encrypt 322 * more than 2**32 messages with the same key. 323 * 324 * Note that for both stategies, sizes are measured in blocks and 325 * that an ARIA block is 16 bytes. 326 * 327 * \warning Upon return, \p stream_block contains sensitive data. Its 328 * content must not be written to insecure storage and should be 329 * securely discarded as soon as it's no longer needed. 330 * 331 * \param ctx The ARIA context to use for encryption or decryption. 332 * This must be initialized and bound to a key. 333 * \param length The length of the input data \p input in Bytes. 334 * \param nc_off The offset in Bytes in the current \p stream_block, 335 * for resuming within the current cipher stream. The 336 * offset pointer should be \c 0 at the start of a 337 * stream. This must not be larger than \c 15 Bytes. 338 * \param nonce_counter The 128-bit nonce and counter. This must point to 339 * a read/write buffer of length \c 16 bytes. 340 * \param stream_block The saved stream block for resuming. This must 341 * point to a read/write buffer of length \c 16 bytes. 342 * This is overwritten by the function. 343 * \param input The buffer holding the input data. This must 344 * be a readable buffer of length \p length Bytes. 345 * \param output The buffer holding the output data. This must 346 * be a writable buffer of length \p length Bytes. 347 * 348 * \return \c 0 on success. 349 * \return A negative error code on failure. 350 */ 351 int mbedtls_aria_crypt_ctr( mbedtls_aria_context *ctx, 352 size_t length, 353 size_t *nc_off, 354 unsigned char nonce_counter[MBEDTLS_ARIA_BLOCKSIZE], 355 unsigned char stream_block[MBEDTLS_ARIA_BLOCKSIZE], 356 const unsigned char *input, 357 unsigned char *output ); 358 #endif /* MBEDTLS_CIPHER_MODE_CTR */ 359 360 #if defined(MBEDTLS_SELF_TEST) 361 /** 362 * \brief Checkup routine. 363 * 364 * \return \c 0 on success, or \c 1 on failure. 365 */ 366 int mbedtls_aria_self_test( int verbose ); 367 #endif /* MBEDTLS_SELF_TEST */ 368 369 #ifdef __cplusplus 370 } 371 #endif 372 373 #endif /* aria.h */ 374
