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 OR GPL-2.0-or-later 9 * 10 * This file is provided under the Apache License 2.0, or the 11 * GNU General Public License v2.0 or later. 12 * 13 * ********** 14 * Apache License 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 * 30 * ********** 31 * GNU General Public License v2.0 or later: 32 * 33 * This program is free software; you can redistribute it and/or modify 34 * it under the terms of the GNU General Public License as published by 35 * the Free Software Foundation; either version 2 of the License, or 36 * (at your option) any later version. 37 * 38 * This program is distributed in the hope that it will be useful, 39 * but WITHOUT ANY WARRANTY; without even the implied warranty of 40 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 41 * GNU General Public License for more details. 42 * 43 * You should have received a copy of the GNU General Public License along 44 * with this program; if not, write to the Free Software Foundation, Inc., 45 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 46 * 47 * ********** 48 */ 49 #ifndef MBEDTLS_XTEA_H 50 #define MBEDTLS_XTEA_H 51 52 #if !defined(MBEDTLS_CONFIG_FILE) 53 #include "config.h" 54 #else 55 #include MBEDTLS_CONFIG_FILE 56 #endif 57 58 #include <stddef.h> 59 #include <stdint.h> 60 61 #define MBEDTLS_XTEA_ENCRYPT 1 62 #define MBEDTLS_XTEA_DECRYPT 0 63 64 #define MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH -0x0028 /**< The data input has an invalid length. */ 65 66 /* MBEDTLS_ERR_XTEA_HW_ACCEL_FAILED is deprecated and should not be used. */ 67 #define MBEDTLS_ERR_XTEA_HW_ACCEL_FAILED -0x0029 /**< XTEA hardware accelerator failed. */ 68 69 #ifdef __cplusplus 70 extern "C" { 71 #endif 72 73 #if !defined(MBEDTLS_XTEA_ALT) 74 // Regular implementation 75 // 76 77 /** 78 * \brief XTEA context structure 79 */ 80 typedef struct mbedtls_xtea_context 81 { 82 uint32_t k[4]; /*!< key */ 83 } 84 mbedtls_xtea_context; 85 86 #else /* MBEDTLS_XTEA_ALT */ 87 #include "xtea_alt.h" 88 #endif /* MBEDTLS_XTEA_ALT */ 89 90 /** 91 * \brief Initialize XTEA context 92 * 93 * \param ctx XTEA context to be initialized 94 */ 95 void mbedtls_xtea_init( mbedtls_xtea_context *ctx ); 96 97 /** 98 * \brief Clear XTEA context 99 * 100 * \param ctx XTEA context to be cleared 101 */ 102 void mbedtls_xtea_free( mbedtls_xtea_context *ctx ); 103 104 /** 105 * \brief XTEA key schedule 106 * 107 * \param ctx XTEA context to be initialized 108 * \param key the secret key 109 */ 110 void mbedtls_xtea_setup( mbedtls_xtea_context *ctx, const unsigned char key[16] ); 111 112 /** 113 * \brief XTEA cipher function 114 * 115 * \param ctx XTEA context 116 * \param mode MBEDTLS_XTEA_ENCRYPT or MBEDTLS_XTEA_DECRYPT 117 * \param input 8-byte input block 118 * \param output 8-byte output block 119 * 120 * \return 0 if successful 121 */ 122 int mbedtls_xtea_crypt_ecb( mbedtls_xtea_context *ctx, 123 int mode, 124 const unsigned char input[8], 125 unsigned char output[8] ); 126 127 #if defined(MBEDTLS_CIPHER_MODE_CBC) 128 /** 129 * \brief XTEA CBC cipher function 130 * 131 * \param ctx XTEA context 132 * \param mode MBEDTLS_XTEA_ENCRYPT or MBEDTLS_XTEA_DECRYPT 133 * \param length the length of input, multiple of 8 134 * \param iv initialization vector for CBC mode 135 * \param input input block 136 * \param output output block 137 * 138 * \return 0 if successful, 139 * MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH if the length % 8 != 0 140 */ 141 int mbedtls_xtea_crypt_cbc( mbedtls_xtea_context *ctx, 142 int mode, 143 size_t length, 144 unsigned char iv[8], 145 const unsigned char *input, 146 unsigned char *output); 147 #endif /* MBEDTLS_CIPHER_MODE_CBC */ 148 149 #if defined(MBEDTLS_SELF_TEST) 150 151 /** 152 * \brief Checkup routine 153 * 154 * \return 0 if successful, or 1 if the test failed 155 */ 156 int mbedtls_xtea_self_test( int verbose ); 157 158 #endif /* MBEDTLS_SELF_TEST */ 159 160 #ifdef __cplusplus 161 } 162 #endif 163 164 #endif /* xtea.h */ 165