blob: 02cd8d6f0ada925549b8eec7cabf5cfb3d6a5460 [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)
5 *
Manuel Pégourié-Gonnarda658a402015-01-23 09:45:19 +00006 * Copyright (C) 2006-2013, ARM Limited, All Rights Reserved
Paul Bakkerb96f1542010-07-18 20:36:00 +00007 *
Manuel Pégourié-Gonnardfe446432015-03-06 13:17:10 +00008 * This file is part of mbed TLS (https://tls.mbed.org)
Paul Bakkerb96f1542010-07-18 20:36:00 +00009 *
Paul Bakker7a7c78f2009-01-04 18:15:48 +000010 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23 */
24#ifndef POLARSSL_XTEA_H
25#define POLARSSL_XTEA_H
26
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020027#if !defined(POLARSSL_CONFIG_FILE)
Paul Bakker90995b52013-06-24 19:20:35 +020028#include "config.h"
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020029#else
30#include POLARSSL_CONFIG_FILE
31#endif
Paul Bakker90995b52013-06-24 19:20:35 +020032
Rich Evans00ab4702015-02-06 13:43:58 +000033#include <stddef.h>
Paul Bakker23986e52011-04-24 08:57:21 +000034
Paul Bakkerfa6a6202013-10-28 18:48:30 +010035#if defined(_MSC_VER) && !defined(EFIX64) && !defined(EFI32)
Paul Bakker477fd322009-10-04 13:22:13 +000036#include <basetsd.h>
37typedef UINT32 uint32_t;
38#else
39#include <inttypes.h>
Paul Bakker80ab9f52009-05-24 14:42:46 +000040#endif
Paul Bakker0fdf3ca2009-05-03 12:54:07 +000041
Paul Bakker7a7c78f2009-01-04 18:15:48 +000042#define XTEA_ENCRYPT 1
43#define XTEA_DECRYPT 0
44
Paul Bakker9d781402011-05-09 16:17:09 +000045#define POLARSSL_ERR_XTEA_INVALID_INPUT_LENGTH -0x0028 /**< The data input has an invalid length. */
Paul Bakker7a7c78f2009-01-04 18:15:48 +000046
Paul Bakker90995b52013-06-24 19:20:35 +020047#if !defined(POLARSSL_XTEA_ALT)
48// Regular implementation
49//
50
Paul Bakker407a0da2013-06-27 14:29:21 +020051#ifdef __cplusplus
52extern "C" {
53#endif
54
Paul Bakker7a7c78f2009-01-04 18:15:48 +000055/**
56 * \brief XTEA context structure
57 */
58typedef struct
59{
Paul Bakker0fdf3ca2009-05-03 12:54:07 +000060 uint32_t k[4]; /*!< key */
Paul Bakker7a7c78f2009-01-04 18:15:48 +000061}
62xtea_context;
63
Paul Bakker7a7c78f2009-01-04 18:15:48 +000064/**
Paul Bakkerc7ea99a2014-06-18 11:12:03 +020065 * \brief Initialize XTEA context
66 *
67 * \param ctx XTEA context to be initialized
68 */
69void xtea_init( xtea_context *ctx );
70
71/**
72 * \brief Clear XTEA context
73 *
74 * \param ctx XTEA context to be cleared
75 */
76void xtea_free( xtea_context *ctx );
77
78/**
Paul Bakker7a7c78f2009-01-04 18:15:48 +000079 * \brief XTEA key schedule
80 *
81 * \param ctx XTEA context to be initialized
82 * \param key the secret key
83 */
Paul Bakkerb6c5d2e2013-06-25 16:25:17 +020084void xtea_setup( xtea_context *ctx, const unsigned char key[16] );
Paul Bakker7a7c78f2009-01-04 18:15:48 +000085
86/**
87 * \brief XTEA cipher function
88 *
89 * \param ctx XTEA context
90 * \param mode XTEA_ENCRYPT or XTEA_DECRYPT
91 * \param input 8-byte input block
92 * \param output 8-byte output block
Paul Bakkerf3ccc682010-03-18 21:21:02 +000093 *
Paul Bakker27caa8a2010-03-21 15:43:59 +000094 * \return 0 if successful
Paul Bakker7a7c78f2009-01-04 18:15:48 +000095 */
Paul Bakkerf3ccc682010-03-18 21:21:02 +000096int xtea_crypt_ecb( xtea_context *ctx,
Paul Bakker23986e52011-04-24 08:57:21 +000097 int mode,
Paul Bakkerb6c5d2e2013-06-25 16:25:17 +020098 const unsigned char input[8],
Paul Bakker23986e52011-04-24 08:57:21 +000099 unsigned char output[8] );
Paul Bakker7a7c78f2009-01-04 18:15:48 +0000100
Manuel Pégourié-Gonnard92cb1d32013-09-13 16:24:20 +0200101#if defined(POLARSSL_CIPHER_MODE_CBC)
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000102/**
103 * \brief XTEA CBC cipher function
104 *
105 * \param ctx XTEA context
106 * \param mode XTEA_ENCRYPT or XTEA_DECRYPT
107 * \param length the length of input, multiple of 8
108 * \param iv initialization vector for CBC mode
109 * \param input input block
110 * \param output output block
111 *
112 * \return 0 if successful,
113 * POLARSSL_ERR_XTEA_INVALID_INPUT_LENGTH if the length % 8 != 0
114 */
115int xtea_crypt_cbc( xtea_context *ctx,
116 int mode,
Paul Bakker23986e52011-04-24 08:57:21 +0000117 size_t length,
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000118 unsigned char iv[8],
Paul Bakkerb6c5d2e2013-06-25 16:25:17 +0200119 const unsigned char *input,
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000120 unsigned char *output);
Manuel Pégourié-Gonnard92cb1d32013-09-13 16:24:20 +0200121#endif /* POLARSSL_CIPHER_MODE_CBC */
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000122
Paul Bakker90995b52013-06-24 19:20:35 +0200123#ifdef __cplusplus
124}
125#endif
126
127#else /* POLARSSL_XTEA_ALT */
128#include "xtea_alt.h"
129#endif /* POLARSSL_XTEA_ALT */
130
131#ifdef __cplusplus
132extern "C" {
133#endif
134
Paul Bakker9a736322012-11-14 12:39:52 +0000135/**
Paul Bakker7a7c78f2009-01-04 18:15:48 +0000136 * \brief Checkup routine
137 *
138 * \return 0 if successful, or 1 if the test failed
139 */
140int xtea_self_test( int verbose );
141
142#ifdef __cplusplus
143}
144#endif
145
146#endif /* xtea.h */