blob: 72c998edfde983a49ec0dfa94d6f2833c3a3fef7 [file] [log] [blame]
Paul Bakker7a7c78f2009-01-04 18:15:48 +00001/**
2 * \file xtea.h
3 *
Paul Bakker37ca75d2011-01-06 12:28:03 +00004 * \brief XTEA block cipher (32-bit)
Darryl Greena40a1012018-01-05 15:33:17 +00005 */
6/*
Bence Szépkúti1e148272020-08-07 13:07:28 +02007 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02008 * 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.
Paul Bakker7a7c78f2009-01-04 18:15:48 +000021 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020022#ifndef MBEDTLS_XTEA_H
23#define MBEDTLS_XTEA_H
Mateusz Starzyk846f0212021-05-19 19:44:07 +020024#include "mbedtls/private_access.h"
Paul Bakker7a7c78f2009-01-04 18:15:48 +000025
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020026#if !defined(MBEDTLS_CONFIG_FILE)
Jaeden Ameroc49fbbf2019-07-04 20:01:14 +010027#include "mbedtls/config.h"
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020028#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020029#include MBEDTLS_CONFIG_FILE
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020030#endif
Paul Bakker90995b52013-06-24 19:20:35 +020031
Rich Evans00ab4702015-02-06 13:43:58 +000032#include <stddef.h>
Manuel Pégourié-Gonnardab229102015-04-15 11:53:16 +020033#include <stdint.h>
Paul Bakker0fdf3ca2009-05-03 12:54:07 +000034
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020035#define MBEDTLS_XTEA_ENCRYPT 1
36#define MBEDTLS_XTEA_DECRYPT 0
Paul Bakker7a7c78f2009-01-04 18:15:48 +000037
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020038#define MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH -0x0028 /**< The data input has an invalid length. */
Ron Eldor9924bdc2018-10-04 10:59:13 +030039
Paul Bakker407a0da2013-06-27 14:29:21 +020040#ifdef __cplusplus
41extern "C" {
42#endif
43
Ron Eldorb2aacec2017-05-18 16:53:08 +030044#if !defined(MBEDTLS_XTEA_ALT)
45// Regular implementation
46//
47
Paul Bakker7a7c78f2009-01-04 18:15:48 +000048/**
49 * \brief XTEA context structure
50 */
Dawid Drozd428cc522018-07-24 10:02:47 +020051typedef struct mbedtls_xtea_context
Paul Bakker7a7c78f2009-01-04 18:15:48 +000052{
Mateusz Starzyk846f0212021-05-19 19:44:07 +020053 uint32_t MBEDTLS_PRIVATE(k)[4]; /*!< key */
Paul Bakker7a7c78f2009-01-04 18:15:48 +000054}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020055mbedtls_xtea_context;
Paul Bakker7a7c78f2009-01-04 18:15:48 +000056
Ron Eldorb2aacec2017-05-18 16:53:08 +030057#else /* MBEDTLS_XTEA_ALT */
58#include "xtea_alt.h"
59#endif /* MBEDTLS_XTEA_ALT */
60
Paul Bakker7a7c78f2009-01-04 18:15:48 +000061/**
Paul Bakkerc7ea99a2014-06-18 11:12:03 +020062 * \brief Initialize XTEA context
63 *
64 * \param ctx XTEA context to be initialized
65 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020066void mbedtls_xtea_init( mbedtls_xtea_context *ctx );
Paul Bakkerc7ea99a2014-06-18 11:12:03 +020067
68/**
69 * \brief Clear XTEA context
70 *
71 * \param ctx XTEA context to be cleared
72 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020073void mbedtls_xtea_free( mbedtls_xtea_context *ctx );
Paul Bakkerc7ea99a2014-06-18 11:12:03 +020074
75/**
Paul Bakker7a7c78f2009-01-04 18:15:48 +000076 * \brief XTEA key schedule
77 *
78 * \param ctx XTEA context to be initialized
79 * \param key the secret key
80 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020081void mbedtls_xtea_setup( mbedtls_xtea_context *ctx, const unsigned char key[16] );
Paul Bakker7a7c78f2009-01-04 18:15:48 +000082
83/**
84 * \brief XTEA cipher function
85 *
86 * \param ctx XTEA context
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020087 * \param mode MBEDTLS_XTEA_ENCRYPT or MBEDTLS_XTEA_DECRYPT
Paul Bakker7a7c78f2009-01-04 18:15:48 +000088 * \param input 8-byte input block
89 * \param output 8-byte output block
Paul Bakkerf3ccc682010-03-18 21:21:02 +000090 *
Paul Bakker27caa8a2010-03-21 15:43:59 +000091 * \return 0 if successful
Paul Bakker7a7c78f2009-01-04 18:15:48 +000092 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020093int mbedtls_xtea_crypt_ecb( mbedtls_xtea_context *ctx,
Paul Bakker23986e52011-04-24 08:57:21 +000094 int mode,
Paul Bakkerb6c5d2e2013-06-25 16:25:17 +020095 const unsigned char input[8],
Paul Bakker23986e52011-04-24 08:57:21 +000096 unsigned char output[8] );
Paul Bakker7a7c78f2009-01-04 18:15:48 +000097
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020098#if defined(MBEDTLS_CIPHER_MODE_CBC)
Paul Bakkerb6ecaf52011-04-19 14:29:23 +000099/**
100 * \brief XTEA CBC cipher function
101 *
102 * \param ctx XTEA context
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200103 * \param mode MBEDTLS_XTEA_ENCRYPT or MBEDTLS_XTEA_DECRYPT
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000104 * \param length the length of input, multiple of 8
105 * \param iv initialization vector for CBC mode
106 * \param input input block
107 * \param output output block
108 *
109 * \return 0 if successful,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200110 * MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH if the length % 8 != 0
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000111 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200112int mbedtls_xtea_crypt_cbc( mbedtls_xtea_context *ctx,
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000113 int mode,
Paul Bakker23986e52011-04-24 08:57:21 +0000114 size_t length,
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000115 unsigned char iv[8],
Paul Bakkerb6c5d2e2013-06-25 16:25:17 +0200116 const unsigned char *input,
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000117 unsigned char *output);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200118#endif /* MBEDTLS_CIPHER_MODE_CBC */
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000119
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500120#if defined(MBEDTLS_SELF_TEST)
121
Paul Bakker9a736322012-11-14 12:39:52 +0000122/**
Paul Bakker7a7c78f2009-01-04 18:15:48 +0000123 * \brief Checkup routine
124 *
125 * \return 0 if successful, or 1 if the test failed
126 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200127int mbedtls_xtea_self_test( int verbose );
Paul Bakker7a7c78f2009-01-04 18:15:48 +0000128
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500129#endif /* MBEDTLS_SELF_TEST */
130
Paul Bakker7a7c78f2009-01-04 18:15:48 +0000131#ifdef __cplusplus
132}
133#endif
134
135#endif /* xtea.h */