1 /** 2 * \file xtea.h 3 * 4 * \brief XTEA block cipher (32-bit) 5 */ 6 /* 7 * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved 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 * This file is part of mbed TLS (https://tls.mbed.org) 50 */ 51 #ifndef MBEDTLS_XTEA_H 52 #define MBEDTLS_XTEA_H 53 54 #if !defined(MBEDTLS_CONFIG_FILE) 55 #include "config.h" 56 #else 57 #include MBEDTLS_CONFIG_FILE 58 #endif 59 60 #include <stddef.h> 61 #include <stdint.h> 62 63 #define MBEDTLS_XTEA_ENCRYPT 1 64 #define MBEDTLS_XTEA_DECRYPT 0 65 66 #define MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH -0x0028 /**< The data input has an invalid length. */ 67 #define MBEDTLS_ERR_XTEA_HW_ACCEL_FAILED -0x0029 /**< XTEA hardware accelerator failed. */ 68 69 #if !defined(MBEDTLS_XTEA_ALT) 70 // Regular implementation 71 // 72 73 #ifdef __cplusplus 74 extern "C" { 75 #endif 76 77 /** 78 * \brief XTEA context structure 79 */ 80 typedef struct 81 { 82 uint32_t k[4]; /*!< key */ 83 } 84 mbedtls_xtea_context; 85 86 /** 87 * \brief Initialize XTEA context 88 * 89 * \param ctx XTEA context to be initialized 90 */ 91 void mbedtls_xtea_init( mbedtls_xtea_context *ctx ); 92 93 /** 94 * \brief Clear XTEA context 95 * 96 * \param ctx XTEA context to be cleared 97 */ 98 void mbedtls_xtea_free( mbedtls_xtea_context *ctx ); 99 100 /** 101 * \brief XTEA key schedule 102 * 103 * \param ctx XTEA context to be initialized 104 * \param key the secret key 105 */ 106 void mbedtls_xtea_setup( mbedtls_xtea_context *ctx, const unsigned char key[16] ); 107 108 /** 109 * \brief XTEA cipher function 110 * 111 * \param ctx XTEA context 112 * \param mode MBEDTLS_XTEA_ENCRYPT or MBEDTLS_XTEA_DECRYPT 113 * \param input 8-byte input block 114 * \param output 8-byte output block 115 * 116 * \return 0 if successful 117 */ 118 int mbedtls_xtea_crypt_ecb( mbedtls_xtea_context *ctx, 119 int mode, 120 const unsigned char input[8], 121 unsigned char output[8] ); 122 123 #if defined(MBEDTLS_CIPHER_MODE_CBC) 124 /** 125 * \brief XTEA CBC cipher function 126 * 127 * \param ctx XTEA context 128 * \param mode MBEDTLS_XTEA_ENCRYPT or MBEDTLS_XTEA_DECRYPT 129 * \param length the length of input, multiple of 8 130 * \param iv initialization vector for CBC mode 131 * \param input input block 132 * \param output output block 133 * 134 * \return 0 if successful, 135 * MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH if the length % 8 != 0 136 */ 137 int mbedtls_xtea_crypt_cbc( mbedtls_xtea_context *ctx, 138 int mode, 139 size_t length, 140 unsigned char iv[8], 141 const unsigned char *input, 142 unsigned char *output); 143 #endif /* MBEDTLS_CIPHER_MODE_CBC */ 144 145 #ifdef __cplusplus 146 } 147 #endif 148 149 #else /* MBEDTLS_XTEA_ALT */ 150 #include "xtea_alt.h" 151 #endif /* MBEDTLS_XTEA_ALT */ 152 153 #ifdef __cplusplus 154 extern "C" { 155 #endif 156 157 /** 158 * \brief Checkup routine 159 * 160 * \return 0 if successful, or 1 if the test failed 161 */ 162 int mbedtls_xtea_self_test( int verbose ); 163 164 #ifdef __cplusplus 165 } 166 #endif 167 168 #endif /* xtea.h */ 169