1 /** 2 * \file camellia.h 3 * 4 * \brief Camellia block cipher 5 */ 6 /* 7 * Copyright The Mbed TLS Contributors 8 * SPDX-License-Identifier: Apache-2.0 9 * 10 * Licensed under the Apache License, Version 2.0 (the "License"); you may 11 * not use this file except in compliance with the License. 12 * You may obtain a copy of the License at 13 * 14 * http://www.apache.org/licenses/LICENSE-2.0 15 * 16 * Unless required by applicable law or agreed to in writing, software 17 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 18 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 19 * See the License for the specific language governing permissions and 20 * limitations under the License. 21 */ 22 #ifndef MBEDTLS_CAMELLIA_H 23 #define MBEDTLS_CAMELLIA_H 24 #include "mbedtls/private_access.h" 25 26 #include "mbedtls/build_info.h" 27 28 #include <stddef.h> 29 #include <stdint.h> 30 31 #include "mbedtls/platform_util.h" 32 33 #define MBEDTLS_CAMELLIA_ENCRYPT 1 34 #define MBEDTLS_CAMELLIA_DECRYPT 0 35 36 /** Bad input data. */ 37 #define MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA -0x0024 38 39 /** Invalid data input length. */ 40 #define MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH -0x0026 41 42 #ifdef __cplusplus 43 extern "C" { 44 #endif 45 46 #if !defined(MBEDTLS_CAMELLIA_ALT) 47 // Regular implementation 48 // 49 50 /** 51 * \brief CAMELLIA context structure 52 */ 53 typedef struct mbedtls_camellia_context { 54 int MBEDTLS_PRIVATE(nr); /*!< number of rounds */ 55 uint32_t MBEDTLS_PRIVATE(rk)[68]; /*!< CAMELLIA round keys */ 56 } 57 mbedtls_camellia_context; 58 59 #else /* MBEDTLS_CAMELLIA_ALT */ 60 #include "camellia_alt.h" 61 #endif /* MBEDTLS_CAMELLIA_ALT */ 62 63 /** 64 * \brief Initialize a CAMELLIA context. 65 * 66 * \param ctx The CAMELLIA context to be initialized. 67 * This must not be \c NULL. 68 */ 69 void mbedtls_camellia_init(mbedtls_camellia_context *ctx); 70 71 /** 72 * \brief Clear a CAMELLIA context. 73 * 74 * \param ctx The CAMELLIA context to be cleared. This may be \c NULL, 75 * in which case this function returns immediately. If it is not 76 * \c NULL, it must be initialized. 77 */ 78 void mbedtls_camellia_free(mbedtls_camellia_context *ctx); 79 80 /** 81 * \brief Perform a CAMELLIA key schedule operation for encryption. 82 * 83 * \param ctx The CAMELLIA context to use. This must be initialized. 84 * \param key The encryption key to use. This must be a readable buffer 85 * of size \p keybits Bits. 86 * \param keybits The length of \p key in Bits. This must be either \c 128, 87 * \c 192 or \c 256. 88 * 89 * \return \c 0 if successful. 90 * \return A negative error code on failure. 91 */ 92 int mbedtls_camellia_setkey_enc(mbedtls_camellia_context *ctx, 93 const unsigned char *key, 94 unsigned int keybits); 95 96 /** 97 * \brief Perform a CAMELLIA key schedule operation for decryption. 98 * 99 * \param ctx The CAMELLIA context to use. This must be initialized. 100 * \param key The decryption key. This must be a readable buffer 101 * of size \p keybits Bits. 102 * \param keybits The length of \p key in Bits. This must be either \c 128, 103 * \c 192 or \c 256. 104 * 105 * \return \c 0 if successful. 106 * \return A negative error code on failure. 107 */ 108 int mbedtls_camellia_setkey_dec(mbedtls_camellia_context *ctx, 109 const unsigned char *key, 110 unsigned int keybits); 111 112 /** 113 * \brief Perform a CAMELLIA-ECB block encryption/decryption operation. 114 * 115 * \param ctx The CAMELLIA context to use. This must be initialized 116 * and bound to a key. 117 * \param mode The mode of operation. This must be either 118 * #MBEDTLS_CAMELLIA_ENCRYPT or #MBEDTLS_CAMELLIA_DECRYPT. 119 * \param input The input block. This must be a readable buffer 120 * of size \c 16 Bytes. 121 * \param output The output block. This must be a writable buffer 122 * of size \c 16 Bytes. 123 * 124 * \return \c 0 if successful. 125 * \return A negative error code on failure. 126 */ 127 int mbedtls_camellia_crypt_ecb(mbedtls_camellia_context *ctx, 128 int mode, 129 const unsigned char input[16], 130 unsigned char output[16]); 131 132 #if defined(MBEDTLS_CIPHER_MODE_CBC) 133 /** 134 * \brief Perform a CAMELLIA-CBC buffer encryption/decryption operation. 135 * 136 * \note Upon exit, the content of the IV is updated so that you can 137 * call the function same function again on the following 138 * block(s) of data and get the same result as if it was 139 * encrypted in one call. This allows a "streaming" usage. 140 * If on the other hand you need to retain the contents of the 141 * IV, you should either save it manually or use the cipher 142 * module instead. 143 * 144 * \param ctx The CAMELLIA context to use. This must be initialized 145 * and bound to a key. 146 * \param mode The mode of operation. This must be either 147 * #MBEDTLS_CAMELLIA_ENCRYPT or #MBEDTLS_CAMELLIA_DECRYPT. 148 * \param length The length in Bytes of the input data \p input. 149 * This must be a multiple of \c 16 Bytes. 150 * \param iv The initialization vector. This must be a read/write buffer 151 * of length \c 16 Bytes. It is updated to allow streaming 152 * use as explained above. 153 * \param input The buffer holding the input data. This must point to a 154 * readable buffer of length \p length Bytes. 155 * \param output The buffer holding the output data. This must point to a 156 * writable buffer of length \p length Bytes. 157 * 158 * \return \c 0 if successful. 159 * \return A negative error code on failure. 160 */ 161 int mbedtls_camellia_crypt_cbc(mbedtls_camellia_context *ctx, 162 int mode, 163 size_t length, 164 unsigned char iv[16], 165 const unsigned char *input, 166 unsigned char *output); 167 #endif /* MBEDTLS_CIPHER_MODE_CBC */ 168 169 #if defined(MBEDTLS_CIPHER_MODE_CFB) 170 /** 171 * \brief Perform a CAMELLIA-CFB128 buffer encryption/decryption 172 * operation. 173 * 174 * \note Due to the nature of CFB mode, you should use the same 175 * key for both encryption and decryption. In particular, calls 176 * to this function should be preceded by a key-schedule via 177 * mbedtls_camellia_setkey_enc() regardless of whether \p mode 178 * is #MBEDTLS_CAMELLIA_ENCRYPT or #MBEDTLS_CAMELLIA_DECRYPT. 179 * 180 * \note Upon exit, the content of the IV is updated so that you can 181 * call the function same function again on the following 182 * block(s) of data and get the same result as if it was 183 * encrypted in one call. This allows a "streaming" usage. 184 * If on the other hand you need to retain the contents of the 185 * IV, you should either save it manually or use the cipher 186 * module instead. 187 * 188 * \param ctx The CAMELLIA context to use. This must be initialized 189 * and bound to a key. 190 * \param mode The mode of operation. This must be either 191 * #MBEDTLS_CAMELLIA_ENCRYPT or #MBEDTLS_CAMELLIA_DECRYPT. 192 * \param length The length of the input data \p input. Any value is allowed. 193 * \param iv_off The current offset in the IV. This must be smaller 194 * than \c 16 Bytes. It is updated after this call to allow 195 * the aforementioned streaming usage. 196 * \param iv The initialization vector. This must be a read/write buffer 197 * of length \c 16 Bytes. It is updated after this call to 198 * allow the aforementioned streaming usage. 199 * \param input The buffer holding the input data. This must be a readable 200 * buffer of size \p length Bytes. 201 * \param output The buffer to hold the output data. This must be a writable 202 * buffer of length \p length Bytes. 203 * 204 * \return \c 0 if successful. 205 * \return A negative error code on failure. 206 */ 207 int mbedtls_camellia_crypt_cfb128(mbedtls_camellia_context *ctx, 208 int mode, 209 size_t length, 210 size_t *iv_off, 211 unsigned char iv[16], 212 const unsigned char *input, 213 unsigned char *output); 214 #endif /* MBEDTLS_CIPHER_MODE_CFB */ 215 216 #if defined(MBEDTLS_CIPHER_MODE_CTR) 217 /** 218 * \brief Perform a CAMELLIA-CTR buffer encryption/decryption operation. 219 * 220 * *note Due to the nature of CTR mode, you should use the same 221 * key for both encryption and decryption. In particular, calls 222 * to this function should be preceded by a key-schedule via 223 * mbedtls_camellia_setkey_enc() regardless of whether \p mode 224 * is #MBEDTLS_CAMELLIA_ENCRYPT or #MBEDTLS_CAMELLIA_DECRYPT. 225 * 226 * \warning You must never reuse a nonce value with the same key. Doing so 227 * would void the encryption for the two messages encrypted with 228 * the same nonce and key. 229 * 230 * There are two common strategies for managing nonces with CTR: 231 * 232 * 1. You can handle everything as a single message processed over 233 * successive calls to this function. In that case, you want to 234 * set \p nonce_counter and \p nc_off to 0 for the first call, and 235 * then preserve the values of \p nonce_counter, \p nc_off and \p 236 * stream_block across calls to this function as they will be 237 * updated by this function. 238 * 239 * With this strategy, you must not encrypt more than 2**128 240 * blocks of data with the same key. 241 * 242 * 2. You can encrypt separate messages by dividing the \p 243 * nonce_counter buffer in two areas: the first one used for a 244 * per-message nonce, handled by yourself, and the second one 245 * updated by this function internally. 246 * 247 * For example, you might reserve the first \c 12 Bytes for the 248 * per-message nonce, and the last \c 4 Bytes for internal use. 249 * In that case, before calling this function on a new message you 250 * need to set the first \c 12 Bytes of \p nonce_counter to your 251 * chosen nonce value, the last four to \c 0, and \p nc_off to \c 0 252 * (which will cause \p stream_block to be ignored). That way, you 253 * can encrypt at most \c 2**96 messages of up to \c 2**32 blocks 254 * each with the same key. 255 * 256 * The per-message nonce (or information sufficient to reconstruct 257 * it) needs to be communicated with the ciphertext and must be 258 * unique. The recommended way to ensure uniqueness is to use a 259 * message counter. An alternative is to generate random nonces, 260 * but this limits the number of messages that can be securely 261 * encrypted: for example, with 96-bit random nonces, you should 262 * not encrypt more than 2**32 messages with the same key. 263 * 264 * Note that for both strategies, sizes are measured in blocks and 265 * that a CAMELLIA block is \c 16 Bytes. 266 * 267 * \warning Upon return, \p stream_block contains sensitive data. Its 268 * content must not be written to insecure storage and should be 269 * securely discarded as soon as it's no longer needed. 270 * 271 * \param ctx The CAMELLIA context to use. This must be initialized 272 * and bound to a key. 273 * \param length The length of the input data \p input in Bytes. 274 * Any value is allowed. 275 * \param nc_off The offset in the current \p stream_block (for resuming 276 * within current cipher stream). The offset pointer to 277 * should be \c 0 at the start of a stream. It is updated 278 * at the end of this call. 279 * \param nonce_counter The 128-bit nonce and counter. This must be a read/write 280 * buffer of length \c 16 Bytes. 281 * \param stream_block The saved stream-block for resuming. This must be a 282 * read/write buffer of length \c 16 Bytes. 283 * \param input The input data stream. This must be a readable buffer of 284 * size \p length Bytes. 285 * \param output The output data stream. This must be a writable buffer 286 * of size \p length Bytes. 287 * 288 * \return \c 0 if successful. 289 * \return A negative error code on failure. 290 */ 291 int mbedtls_camellia_crypt_ctr(mbedtls_camellia_context *ctx, 292 size_t length, 293 size_t *nc_off, 294 unsigned char nonce_counter[16], 295 unsigned char stream_block[16], 296 const unsigned char *input, 297 unsigned char *output); 298 #endif /* MBEDTLS_CIPHER_MODE_CTR */ 299 300 #if defined(MBEDTLS_SELF_TEST) 301 302 /** 303 * \brief Checkup routine 304 * 305 * \return 0 if successful, or 1 if the test failed 306 */ 307 int mbedtls_camellia_self_test(int verbose); 308 309 #endif /* MBEDTLS_SELF_TEST */ 310 311 #ifdef __cplusplus 312 } 313 #endif 314 315 #endif /* camellia.h */ 316
