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