common/mbedtls/xtea.h

   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
   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.
  21  */
  22 #ifndef MBEDTLS_XTEA_H
  23 #define MBEDTLS_XTEA_H
  24
  25 #if !defined(MBEDTLS_CONFIG_FILE)
  26 #include "mbedtls/config.h"
  27 #else
  28 #include MBEDTLS_CONFIG_FILE
  29 #endif
  30
  31 #include <stddef.h>
  32 #include <stdint.h>
  33
  34 #define MBEDTLS_XTEA_ENCRYPT     1
  35 #define MBEDTLS_XTEA_DECRYPT     0
  36
  37 #define MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH             -0x0028  /**< The data input has an invalid length. */
  38
  39 /* MBEDTLS_ERR_XTEA_HW_ACCEL_FAILED is deprecated and should not be used. */
  40 #define MBEDTLS_ERR_XTEA_HW_ACCEL_FAILED                  -0x0029  /**< XTEA hardware accelerator failed. */
  41
  42 #ifdef __cplusplus
  43 extern "C" {
  44 #endif
  45
  46 #if !defined(MBEDTLS_XTEA_ALT)
  47 // Regular implementation
  48 //
  49
  50 /**
  51  * \brief          XTEA context structure
  52  */
  53 typedef struct mbedtls_xtea_context {
  54     uint32_t k[4];       /*!< key */
  55 }
  56 mbedtls_xtea_context;
  57
  58 #else  /* MBEDTLS_XTEA_ALT */
  59 #include "xtea_alt.h"
  60 #endif /* MBEDTLS_XTEA_ALT */
  61
  62 /**
  63  * \brief          Initialize XTEA context
  64  *
  65  * \param ctx      XTEA context to be initialized
  66  */
  67 void mbedtls_xtea_init(mbedtls_xtea_context *ctx);
  68
  69 /**
  70  * \brief          Clear XTEA context
  71  *
  72  * \param ctx      XTEA context to be cleared
  73  */
  74 void mbedtls_xtea_free(mbedtls_xtea_context *ctx);
  75
  76 /**
  77  * \brief          XTEA key schedule
  78  *
  79  * \param ctx      XTEA context to be initialized
  80  * \param key      the secret key
  81  */
  82 void mbedtls_xtea_setup(mbedtls_xtea_context *ctx, const unsigned char key[16]);
  83
  84 /**
  85  * \brief          XTEA cipher function
  86  *
  87  * \param ctx      XTEA context
  88  * \param mode     MBEDTLS_XTEA_ENCRYPT or MBEDTLS_XTEA_DECRYPT
  89  * \param input    8-byte input block
  90  * \param output   8-byte output block
  91  *
  92  * \return         0 if successful
  93  */
  94 int mbedtls_xtea_crypt_ecb(mbedtls_xtea_context *ctx,
  95                            int mode,
  96                            const unsigned char input[8],
  97                            unsigned char output[8]);
  98
  99 #if defined(MBEDTLS_CIPHER_MODE_CBC)
 100 /**
 101  * \brief          XTEA CBC cipher function
 102  *
 103  * \param ctx      XTEA context
 104  * \param mode     MBEDTLS_XTEA_ENCRYPT or MBEDTLS_XTEA_DECRYPT
 105  * \param length   the length of input, multiple of 8
 106  * \param iv       initialization vector for CBC mode
 107  * \param input    input block
 108  * \param output   output block
 109  *
 110  * \return         0 if successful,
 111  *                 MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH if the length % 8 != 0
 112  */
 113 int mbedtls_xtea_crypt_cbc(mbedtls_xtea_context *ctx,
 114                            int mode,
 115                            size_t length,
 116                            unsigned char iv[8],
 117                            const unsigned char *input,
 118                            unsigned char *output);
 119 #endif /* MBEDTLS_CIPHER_MODE_CBC */
 120
 121 #if defined(MBEDTLS_SELF_TEST)
 122
 123 /**
 124  * \brief          Checkup routine
 125  *
 126  * \return         0 if successful, or 1 if the test failed
 127  */
 128 int mbedtls_xtea_self_test(int verbose);
 129
 130 #endif /* MBEDTLS_SELF_TEST */
 131
 132 #ifdef __cplusplus
 133 }
 134 #endif
 135
 136 #endif /* xtea.h */