blob: 0db7bc8ebb38944a20a9a121e79a53c0f55bfca6 [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 *
Paul Bakker84f12b72010-07-18 10:13:04 +00006 * Copyright (C) 2006-2010, Brainspark B.V.
Paul Bakkerb96f1542010-07-18 20:36:00 +00007 *
8 * This file is part of PolarSSL (http://www.polarssl.org)
Paul Bakker84f12b72010-07-18 10:13:04 +00009 * Lead Maintainer: Paul Bakker <polarssl_maintainer at polarssl.org>
Paul Bakkerb96f1542010-07-18 20:36:00 +000010 *
Paul Bakker77b385e2009-07-28 17:23:11 +000011 * All rights reserved.
Paul Bakker7a7c78f2009-01-04 18:15:48 +000012 *
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
17 *
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
22 *
23 * You should have received a copy of the GNU General Public License along
24 * with this program; if not, write to the Free Software Foundation, Inc.,
25 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
26 */
27#ifndef POLARSSL_XTEA_H
28#define POLARSSL_XTEA_H
29
Paul Bakker23986e52011-04-24 08:57:21 +000030#include <string.h>
31
Paul Bakker477fd322009-10-04 13:22:13 +000032#ifdef _MSC_VER
33#include <basetsd.h>
34typedef UINT32 uint32_t;
35#else
36#include <inttypes.h>
Paul Bakker80ab9f52009-05-24 14:42:46 +000037#endif
Paul Bakker0fdf3ca2009-05-03 12:54:07 +000038
Paul Bakker7a7c78f2009-01-04 18:15:48 +000039#define XTEA_ENCRYPT 1
40#define XTEA_DECRYPT 0
41
Paul Bakker9d781402011-05-09 16:17:09 +000042#define POLARSSL_ERR_XTEA_INVALID_INPUT_LENGTH -0x0028 /**< The data input has an invalid length. */
Paul Bakker7a7c78f2009-01-04 18:15:48 +000043
44/**
45 * \brief XTEA context structure
46 */
47typedef struct
48{
Paul Bakker0fdf3ca2009-05-03 12:54:07 +000049 uint32_t k[4]; /*!< key */
Paul Bakker7a7c78f2009-01-04 18:15:48 +000050}
51xtea_context;
52
53#ifdef __cplusplus
54extern "C" {
55#endif
56
57/**
58 * \brief XTEA key schedule
59 *
60 * \param ctx XTEA context to be initialized
61 * \param key the secret key
62 */
63void xtea_setup( xtea_context *ctx, unsigned char key[16] );
64
65/**
66 * \brief XTEA cipher function
67 *
68 * \param ctx XTEA context
69 * \param mode XTEA_ENCRYPT or XTEA_DECRYPT
70 * \param input 8-byte input block
71 * \param output 8-byte output block
Paul Bakkerf3ccc682010-03-18 21:21:02 +000072 *
Paul Bakker27caa8a2010-03-21 15:43:59 +000073 * \return 0 if successful
Paul Bakker7a7c78f2009-01-04 18:15:48 +000074 */
Paul Bakkerf3ccc682010-03-18 21:21:02 +000075int xtea_crypt_ecb( xtea_context *ctx,
Paul Bakker23986e52011-04-24 08:57:21 +000076 int mode,
77 unsigned char input[8],
78 unsigned char output[8] );
Paul Bakker7a7c78f2009-01-04 18:15:48 +000079
Paul Bakkerb6ecaf52011-04-19 14:29:23 +000080/**
81 * \brief XTEA CBC cipher function
82 *
83 * \param ctx XTEA context
84 * \param mode XTEA_ENCRYPT or XTEA_DECRYPT
85 * \param length the length of input, multiple of 8
86 * \param iv initialization vector for CBC mode
87 * \param input input block
88 * \param output output block
89 *
90 * \return 0 if successful,
91 * POLARSSL_ERR_XTEA_INVALID_INPUT_LENGTH if the length % 8 != 0
92 */
93int xtea_crypt_cbc( xtea_context *ctx,
94 int mode,
Paul Bakker23986e52011-04-24 08:57:21 +000095 size_t length,
Paul Bakkerb6ecaf52011-04-19 14:29:23 +000096 unsigned char iv[8],
97 unsigned char *input,
98 unsigned char *output);
99
Paul Bakker9a736322012-11-14 12:39:52 +0000100/**
Paul Bakker7a7c78f2009-01-04 18:15:48 +0000101 * \brief Checkup routine
102 *
103 * \return 0 if successful, or 1 if the test failed
104 */
105int xtea_self_test( int verbose );
106
107#ifdef __cplusplus
108}
109#endif
110
111#endif /* xtea.h */