1 /** 2 * \file xtea.h 3 * 4 * \brief XTEA block cipher (32-bit) 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_XTEA_H 23 #define MBEDTLS_XTEA_H 24 25 #if !defined(MBEDTLS_CONFIG_FILE) 26 #include "mbedtls/config.h" 27 #else 28 #include MBEDTLS_CONFIG_FILE 29 #endif 30 31 #include <stddef.h> 32 #include <stdint.h> 33 34 #define MBEDTLS_XTEA_ENCRYPT 1 35 #define MBEDTLS_XTEA_DECRYPT 0 36 37 /** The data input has an invalid length. */ 38 #define MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH -0x0028 39 40 /* MBEDTLS_ERR_XTEA_HW_ACCEL_FAILED is deprecated and should not be used. */ 41 /** XTEA hardware accelerator failed. */ 42 #define MBEDTLS_ERR_XTEA_HW_ACCEL_FAILED -0x0029 43 44 #ifdef __cplusplus 45 extern "C" { 46 #endif 47 48 #if !defined(MBEDTLS_XTEA_ALT) 49 // Regular implementation 50 // 51 52 /** 53 * \brief XTEA context structure 54 */ 55 typedef struct mbedtls_xtea_context 56 { 57 uint32_t k[4]; /*!< key */ 58 } 59 mbedtls_xtea_context; 60 61 #else /* MBEDTLS_XTEA_ALT */ 62 #include "xtea_alt.h" 63 #endif /* MBEDTLS_XTEA_ALT */ 64 65 /** 66 * \brief Initialize XTEA context 67 * 68 * \param ctx XTEA context to be initialized 69 */ 70 void mbedtls_xtea_init( mbedtls_xtea_context *ctx ); 71 72 /** 73 * \brief Clear XTEA context 74 * 75 * \param ctx XTEA context to be cleared 76 */ 77 void mbedtls_xtea_free( mbedtls_xtea_context *ctx ); 78 79 /** 80 * \brief XTEA key schedule 81 * 82 * \param ctx XTEA context to be initialized 83 * \param key the secret key 84 */ 85 void mbedtls_xtea_setup( mbedtls_xtea_context *ctx, const unsigned char key[16] ); 86 87 /** 88 * \brief XTEA cipher function 89 * 90 * \param ctx XTEA context 91 * \param mode MBEDTLS_XTEA_ENCRYPT or MBEDTLS_XTEA_DECRYPT 92 * \param input 8-byte input block 93 * \param output 8-byte output block 94 * 95 * \return 0 if successful 96 */ 97 int mbedtls_xtea_crypt_ecb( mbedtls_xtea_context *ctx, 98 int mode, 99 const unsigned char input[8], 100 unsigned char output[8] ); 101 102 #if defined(MBEDTLS_CIPHER_MODE_CBC) 103 /** 104 * \brief XTEA CBC cipher function 105 * 106 * \param ctx XTEA context 107 * \param mode MBEDTLS_XTEA_ENCRYPT or MBEDTLS_XTEA_DECRYPT 108 * \param length the length of input, multiple of 8 109 * \param iv initialization vector for CBC mode 110 * \param input input block 111 * \param output output block 112 * 113 * \return 0 if successful, 114 * MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH if the length % 8 != 0 115 */ 116 int mbedtls_xtea_crypt_cbc( mbedtls_xtea_context *ctx, 117 int mode, 118 size_t length, 119 unsigned char iv[8], 120 const unsigned char *input, 121 unsigned char *output); 122 #endif /* MBEDTLS_CIPHER_MODE_CBC */ 123 124 #if defined(MBEDTLS_SELF_TEST) 125 126 /** 127 * \brief Checkup routine 128 * 129 * \return 0 if successful, or 1 if the test failed 130 */ 131 int mbedtls_xtea_self_test( int verbose ); 132 133 #endif /* MBEDTLS_SELF_TEST */ 134 135 #ifdef __cplusplus 136 } 137 #endif 138 139 #endif /* xtea.h */ 140