Austin Blackstone / Mbed 2 deprecated client-lwip-lightswitch-demo-expanded

mbed client lightswitch demo

Dependencies:   mbed Socket lwip-eth lwip-sys lwip

Fork of mbed-client-classic-example-lwip by Austin Blackstone

mbedtls/mbedtls/des.h@11:cada08fc8a70, 2016-06-09 (annotated)

Committer:
mbedAustin
Date:
Thu Jun 09 17:08:36 2016 +0000
Revision:
11:cada08fc8a70
Commit for public Consumption

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbedAustin 11:cada08fc8a70 1 /**
mbedAustin 11:cada08fc8a70 2 * \file des.h
mbedAustin 11:cada08fc8a70 3 *
mbedAustin 11:cada08fc8a70 4 * \brief DES block cipher
mbedAustin 11:cada08fc8a70 5 *
mbedAustin 11:cada08fc8a70 6 * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
mbedAustin 11:cada08fc8a70 7 * SPDX-License-Identifier: Apache-2.0
mbedAustin 11:cada08fc8a70 8 *
mbedAustin 11:cada08fc8a70 9 * Licensed under the Apache License, Version 2.0 (the "License"); you may
mbedAustin 11:cada08fc8a70 10 * not use this file except in compliance with the License.
mbedAustin 11:cada08fc8a70 11 * You may obtain a copy of the License at
mbedAustin 11:cada08fc8a70 12 *
mbedAustin 11:cada08fc8a70 13 * http://www.apache.org/licenses/LICENSE-2.0
mbedAustin 11:cada08fc8a70 14 *
mbedAustin 11:cada08fc8a70 15 * Unless required by applicable law or agreed to in writing, software
mbedAustin 11:cada08fc8a70 16 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
mbedAustin 11:cada08fc8a70 17 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
mbedAustin 11:cada08fc8a70 18 * See the License for the specific language governing permissions and
mbedAustin 11:cada08fc8a70 19 * limitations under the License.
mbedAustin 11:cada08fc8a70 20 *
mbedAustin 11:cada08fc8a70 21 * This file is part of mbed TLS (https://tls.mbed.org)
mbedAustin 11:cada08fc8a70 22 */
mbedAustin 11:cada08fc8a70 23 #ifndef MBEDTLS_DES_H
mbedAustin 11:cada08fc8a70 24 #define MBEDTLS_DES_H
mbedAustin 11:cada08fc8a70 25
mbedAustin 11:cada08fc8a70 26 #if !defined(MBEDTLS_CONFIG_FILE)
mbedAustin 11:cada08fc8a70 27 #include "config.h"
mbedAustin 11:cada08fc8a70 28 #else
mbedAustin 11:cada08fc8a70 29 #include MBEDTLS_CONFIG_FILE
mbedAustin 11:cada08fc8a70 30 #endif
mbedAustin 11:cada08fc8a70 31
mbedAustin 11:cada08fc8a70 32 #include <stddef.h>
mbedAustin 11:cada08fc8a70 33 #include <stdint.h>
mbedAustin 11:cada08fc8a70 34
mbedAustin 11:cada08fc8a70 35 #define MBEDTLS_DES_ENCRYPT 1
mbedAustin 11:cada08fc8a70 36 #define MBEDTLS_DES_DECRYPT 0
mbedAustin 11:cada08fc8a70 37
mbedAustin 11:cada08fc8a70 38 #define MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH -0x0032 /**< The data input has an invalid length. */
mbedAustin 11:cada08fc8a70 39
mbedAustin 11:cada08fc8a70 40 #define MBEDTLS_DES_KEY_SIZE 8
mbedAustin 11:cada08fc8a70 41
mbedAustin 11:cada08fc8a70 42 #if !defined(MBEDTLS_DES_ALT)
mbedAustin 11:cada08fc8a70 43 // Regular implementation
mbedAustin 11:cada08fc8a70 44 //
mbedAustin 11:cada08fc8a70 45
mbedAustin 11:cada08fc8a70 46 #ifdef __cplusplus
mbedAustin 11:cada08fc8a70 47 extern "C" {
mbedAustin 11:cada08fc8a70 48 #endif
mbedAustin 11:cada08fc8a70 49
mbedAustin 11:cada08fc8a70 50 /**
mbedAustin 11:cada08fc8a70 51 * \brief DES context structure
mbedAustin 11:cada08fc8a70 52 */
mbedAustin 11:cada08fc8a70 53 typedef struct
mbedAustin 11:cada08fc8a70 54 {
mbedAustin 11:cada08fc8a70 55 uint32_t sk[32]; /*!< DES subkeys */
mbedAustin 11:cada08fc8a70 56 }
mbedAustin 11:cada08fc8a70 57 mbedtls_des_context;
mbedAustin 11:cada08fc8a70 58
mbedAustin 11:cada08fc8a70 59 /**
mbedAustin 11:cada08fc8a70 60 * \brief Triple-DES context structure
mbedAustin 11:cada08fc8a70 61 */
mbedAustin 11:cada08fc8a70 62 typedef struct
mbedAustin 11:cada08fc8a70 63 {
mbedAustin 11:cada08fc8a70 64 uint32_t sk[96]; /*!< 3DES subkeys */
mbedAustin 11:cada08fc8a70 65 }
mbedAustin 11:cada08fc8a70 66 mbedtls_des3_context;
mbedAustin 11:cada08fc8a70 67
mbedAustin 11:cada08fc8a70 68 /**
mbedAustin 11:cada08fc8a70 69 * \brief Initialize DES context
mbedAustin 11:cada08fc8a70 70 *
mbedAustin 11:cada08fc8a70 71 * \param ctx DES context to be initialized
mbedAustin 11:cada08fc8a70 72 */
mbedAustin 11:cada08fc8a70 73 void mbedtls_des_init( mbedtls_des_context *ctx );
mbedAustin 11:cada08fc8a70 74
mbedAustin 11:cada08fc8a70 75 /**
mbedAustin 11:cada08fc8a70 76 * \brief Clear DES context
mbedAustin 11:cada08fc8a70 77 *
mbedAustin 11:cada08fc8a70 78 * \param ctx DES context to be cleared
mbedAustin 11:cada08fc8a70 79 */
mbedAustin 11:cada08fc8a70 80 void mbedtls_des_free( mbedtls_des_context *ctx );
mbedAustin 11:cada08fc8a70 81
mbedAustin 11:cada08fc8a70 82 /**
mbedAustin 11:cada08fc8a70 83 * \brief Initialize Triple-DES context
mbedAustin 11:cada08fc8a70 84 *
mbedAustin 11:cada08fc8a70 85 * \param ctx DES3 context to be initialized
mbedAustin 11:cada08fc8a70 86 */
mbedAustin 11:cada08fc8a70 87 void mbedtls_des3_init( mbedtls_des3_context *ctx );
mbedAustin 11:cada08fc8a70 88
mbedAustin 11:cada08fc8a70 89 /**
mbedAustin 11:cada08fc8a70 90 * \brief Clear Triple-DES context
mbedAustin 11:cada08fc8a70 91 *
mbedAustin 11:cada08fc8a70 92 * \param ctx DES3 context to be cleared
mbedAustin 11:cada08fc8a70 93 */
mbedAustin 11:cada08fc8a70 94 void mbedtls_des3_free( mbedtls_des3_context *ctx );
mbedAustin 11:cada08fc8a70 95
mbedAustin 11:cada08fc8a70 96 /**
mbedAustin 11:cada08fc8a70 97 * \brief Set key parity on the given key to odd.
mbedAustin 11:cada08fc8a70 98 *
mbedAustin 11:cada08fc8a70 99 * DES keys are 56 bits long, but each byte is padded with
mbedAustin 11:cada08fc8a70 100 * a parity bit to allow verification.
mbedAustin 11:cada08fc8a70 101 *
mbedAustin 11:cada08fc8a70 102 * \param key 8-byte secret key
mbedAustin 11:cada08fc8a70 103 */
mbedAustin 11:cada08fc8a70 104 void mbedtls_des_key_set_parity( unsigned char key[MBEDTLS_DES_KEY_SIZE] );
mbedAustin 11:cada08fc8a70 105
mbedAustin 11:cada08fc8a70 106 /**
mbedAustin 11:cada08fc8a70 107 * \brief Check that key parity on the given key is odd.
mbedAustin 11:cada08fc8a70 108 *
mbedAustin 11:cada08fc8a70 109 * DES keys are 56 bits long, but each byte is padded with
mbedAustin 11:cada08fc8a70 110 * a parity bit to allow verification.
mbedAustin 11:cada08fc8a70 111 *
mbedAustin 11:cada08fc8a70 112 * \param key 8-byte secret key
mbedAustin 11:cada08fc8a70 113 *
mbedAustin 11:cada08fc8a70 114 * \return 0 is parity was ok, 1 if parity was not correct.
mbedAustin 11:cada08fc8a70 115 */
mbedAustin 11:cada08fc8a70 116 int mbedtls_des_key_check_key_parity( const unsigned char key[MBEDTLS_DES_KEY_SIZE] );
mbedAustin 11:cada08fc8a70 117
mbedAustin 11:cada08fc8a70 118 /**
mbedAustin 11:cada08fc8a70 119 * \brief Check that key is not a weak or semi-weak DES key
mbedAustin 11:cada08fc8a70 120 *
mbedAustin 11:cada08fc8a70 121 * \param key 8-byte secret key
mbedAustin 11:cada08fc8a70 122 *
mbedAustin 11:cada08fc8a70 123 * \return 0 if no weak key was found, 1 if a weak key was identified.
mbedAustin 11:cada08fc8a70 124 */
mbedAustin 11:cada08fc8a70 125 int mbedtls_des_key_check_weak( const unsigned char key[MBEDTLS_DES_KEY_SIZE] );
mbedAustin 11:cada08fc8a70 126
mbedAustin 11:cada08fc8a70 127 /**
mbedAustin 11:cada08fc8a70 128 * \brief DES key schedule (56-bit, encryption)
mbedAustin 11:cada08fc8a70 129 *
mbedAustin 11:cada08fc8a70 130 * \param ctx DES context to be initialized
mbedAustin 11:cada08fc8a70 131 * \param key 8-byte secret key
mbedAustin 11:cada08fc8a70 132 *
mbedAustin 11:cada08fc8a70 133 * \return 0
mbedAustin 11:cada08fc8a70 134 */
mbedAustin 11:cada08fc8a70 135 int mbedtls_des_setkey_enc( mbedtls_des_context *ctx, const unsigned char key[MBEDTLS_DES_KEY_SIZE] );
mbedAustin 11:cada08fc8a70 136
mbedAustin 11:cada08fc8a70 137 /**
mbedAustin 11:cada08fc8a70 138 * \brief DES key schedule (56-bit, decryption)
mbedAustin 11:cada08fc8a70 139 *
mbedAustin 11:cada08fc8a70 140 * \param ctx DES context to be initialized
mbedAustin 11:cada08fc8a70 141 * \param key 8-byte secret key
mbedAustin 11:cada08fc8a70 142 *
mbedAustin 11:cada08fc8a70 143 * \return 0
mbedAustin 11:cada08fc8a70 144 */
mbedAustin 11:cada08fc8a70 145 int mbedtls_des_setkey_dec( mbedtls_des_context *ctx, const unsigned char key[MBEDTLS_DES_KEY_SIZE] );
mbedAustin 11:cada08fc8a70 146
mbedAustin 11:cada08fc8a70 147 /**
mbedAustin 11:cada08fc8a70 148 * \brief Triple-DES key schedule (112-bit, encryption)
mbedAustin 11:cada08fc8a70 149 *
mbedAustin 11:cada08fc8a70 150 * \param ctx 3DES context to be initialized
mbedAustin 11:cada08fc8a70 151 * \param key 16-byte secret key
mbedAustin 11:cada08fc8a70 152 *
mbedAustin 11:cada08fc8a70 153 * \return 0
mbedAustin 11:cada08fc8a70 154 */
mbedAustin 11:cada08fc8a70 155 int mbedtls_des3_set2key_enc( mbedtls_des3_context *ctx,
mbedAustin 11:cada08fc8a70 156 const unsigned char key[MBEDTLS_DES_KEY_SIZE * 2] );
mbedAustin 11:cada08fc8a70 157
mbedAustin 11:cada08fc8a70 158 /**
mbedAustin 11:cada08fc8a70 159 * \brief Triple-DES key schedule (112-bit, decryption)
mbedAustin 11:cada08fc8a70 160 *
mbedAustin 11:cada08fc8a70 161 * \param ctx 3DES context to be initialized
mbedAustin 11:cada08fc8a70 162 * \param key 16-byte secret key
mbedAustin 11:cada08fc8a70 163 *
mbedAustin 11:cada08fc8a70 164 * \return 0
mbedAustin 11:cada08fc8a70 165 */
mbedAustin 11:cada08fc8a70 166 int mbedtls_des3_set2key_dec( mbedtls_des3_context *ctx,
mbedAustin 11:cada08fc8a70 167 const unsigned char key[MBEDTLS_DES_KEY_SIZE * 2] );
mbedAustin 11:cada08fc8a70 168
mbedAustin 11:cada08fc8a70 169 /**
mbedAustin 11:cada08fc8a70 170 * \brief Triple-DES key schedule (168-bit, encryption)
mbedAustin 11:cada08fc8a70 171 *
mbedAustin 11:cada08fc8a70 172 * \param ctx 3DES context to be initialized
mbedAustin 11:cada08fc8a70 173 * \param key 24-byte secret key
mbedAustin 11:cada08fc8a70 174 *
mbedAustin 11:cada08fc8a70 175 * \return 0
mbedAustin 11:cada08fc8a70 176 */
mbedAustin 11:cada08fc8a70 177 int mbedtls_des3_set3key_enc( mbedtls_des3_context *ctx,
mbedAustin 11:cada08fc8a70 178 const unsigned char key[MBEDTLS_DES_KEY_SIZE * 3] );
mbedAustin 11:cada08fc8a70 179
mbedAustin 11:cada08fc8a70 180 /**
mbedAustin 11:cada08fc8a70 181 * \brief Triple-DES key schedule (168-bit, decryption)
mbedAustin 11:cada08fc8a70 182 *
mbedAustin 11:cada08fc8a70 183 * \param ctx 3DES context to be initialized
mbedAustin 11:cada08fc8a70 184 * \param key 24-byte secret key
mbedAustin 11:cada08fc8a70 185 *
mbedAustin 11:cada08fc8a70 186 * \return 0
mbedAustin 11:cada08fc8a70 187 */
mbedAustin 11:cada08fc8a70 188 int mbedtls_des3_set3key_dec( mbedtls_des3_context *ctx,
mbedAustin 11:cada08fc8a70 189 const unsigned char key[MBEDTLS_DES_KEY_SIZE * 3] );
mbedAustin 11:cada08fc8a70 190
mbedAustin 11:cada08fc8a70 191 /**
mbedAustin 11:cada08fc8a70 192 * \brief DES-ECB block encryption/decryption
mbedAustin 11:cada08fc8a70 193 *
mbedAustin 11:cada08fc8a70 194 * \param ctx DES context
mbedAustin 11:cada08fc8a70 195 * \param input 64-bit input block
mbedAustin 11:cada08fc8a70 196 * \param output 64-bit output block
mbedAustin 11:cada08fc8a70 197 *
mbedAustin 11:cada08fc8a70 198 * \return 0 if successful
mbedAustin 11:cada08fc8a70 199 */
mbedAustin 11:cada08fc8a70 200 int mbedtls_des_crypt_ecb( mbedtls_des_context *ctx,
mbedAustin 11:cada08fc8a70 201 const unsigned char input[8],
mbedAustin 11:cada08fc8a70 202 unsigned char output[8] );
mbedAustin 11:cada08fc8a70 203
mbedAustin 11:cada08fc8a70 204 #if defined(MBEDTLS_CIPHER_MODE_CBC)
mbedAustin 11:cada08fc8a70 205 /**
mbedAustin 11:cada08fc8a70 206 * \brief DES-CBC buffer encryption/decryption
mbedAustin 11:cada08fc8a70 207 *
mbedAustin 11:cada08fc8a70 208 * \note Upon exit, the content of the IV is updated so that you can
mbedAustin 11:cada08fc8a70 209 * call the function same function again on the following
mbedAustin 11:cada08fc8a70 210 * block(s) of data and get the same result as if it was
mbedAustin 11:cada08fc8a70 211 * encrypted in one call. This allows a "streaming" usage.
mbedAustin 11:cada08fc8a70 212 * If on the other hand you need to retain the contents of the
mbedAustin 11:cada08fc8a70 213 * IV, you should either save it manually or use the cipher
mbedAustin 11:cada08fc8a70 214 * module instead.
mbedAustin 11:cada08fc8a70 215 *
mbedAustin 11:cada08fc8a70 216 * \param ctx DES context
mbedAustin 11:cada08fc8a70 217 * \param mode MBEDTLS_DES_ENCRYPT or MBEDTLS_DES_DECRYPT
mbedAustin 11:cada08fc8a70 218 * \param length length of the input data
mbedAustin 11:cada08fc8a70 219 * \param iv initialization vector (updated after use)
mbedAustin 11:cada08fc8a70 220 * \param input buffer holding the input data
mbedAustin 11:cada08fc8a70 221 * \param output buffer holding the output data
mbedAustin 11:cada08fc8a70 222 */
mbedAustin 11:cada08fc8a70 223 int mbedtls_des_crypt_cbc( mbedtls_des_context *ctx,
mbedAustin 11:cada08fc8a70 224 int mode,
mbedAustin 11:cada08fc8a70 225 size_t length,
mbedAustin 11:cada08fc8a70 226 unsigned char iv[8],
mbedAustin 11:cada08fc8a70 227 const unsigned char *input,
mbedAustin 11:cada08fc8a70 228 unsigned char *output );
mbedAustin 11:cada08fc8a70 229 #endif /* MBEDTLS_CIPHER_MODE_CBC */
mbedAustin 11:cada08fc8a70 230
mbedAustin 11:cada08fc8a70 231 /**
mbedAustin 11:cada08fc8a70 232 * \brief 3DES-ECB block encryption/decryption
mbedAustin 11:cada08fc8a70 233 *
mbedAustin 11:cada08fc8a70 234 * \param ctx 3DES context
mbedAustin 11:cada08fc8a70 235 * \param input 64-bit input block
mbedAustin 11:cada08fc8a70 236 * \param output 64-bit output block
mbedAustin 11:cada08fc8a70 237 *
mbedAustin 11:cada08fc8a70 238 * \return 0 if successful
mbedAustin 11:cada08fc8a70 239 */
mbedAustin 11:cada08fc8a70 240 int mbedtls_des3_crypt_ecb( mbedtls_des3_context *ctx,
mbedAustin 11:cada08fc8a70 241 const unsigned char input[8],
mbedAustin 11:cada08fc8a70 242 unsigned char output[8] );
mbedAustin 11:cada08fc8a70 243
mbedAustin 11:cada08fc8a70 244 #if defined(MBEDTLS_CIPHER_MODE_CBC)
mbedAustin 11:cada08fc8a70 245 /**
mbedAustin 11:cada08fc8a70 246 * \brief 3DES-CBC buffer encryption/decryption
mbedAustin 11:cada08fc8a70 247 *
mbedAustin 11:cada08fc8a70 248 * \note Upon exit, the content of the IV is updated so that you can
mbedAustin 11:cada08fc8a70 249 * call the function same function again on the following
mbedAustin 11:cada08fc8a70 250 * block(s) of data and get the same result as if it was
mbedAustin 11:cada08fc8a70 251 * encrypted in one call. This allows a "streaming" usage.
mbedAustin 11:cada08fc8a70 252 * If on the other hand you need to retain the contents of the
mbedAustin 11:cada08fc8a70 253 * IV, you should either save it manually or use the cipher
mbedAustin 11:cada08fc8a70 254 * module instead.
mbedAustin 11:cada08fc8a70 255 *
mbedAustin 11:cada08fc8a70 256 * \param ctx 3DES context
mbedAustin 11:cada08fc8a70 257 * \param mode MBEDTLS_DES_ENCRYPT or MBEDTLS_DES_DECRYPT
mbedAustin 11:cada08fc8a70 258 * \param length length of the input data
mbedAustin 11:cada08fc8a70 259 * \param iv initialization vector (updated after use)
mbedAustin 11:cada08fc8a70 260 * \param input buffer holding the input data
mbedAustin 11:cada08fc8a70 261 * \param output buffer holding the output data
mbedAustin 11:cada08fc8a70 262 *
mbedAustin 11:cada08fc8a70 263 * \return 0 if successful, or MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH
mbedAustin 11:cada08fc8a70 264 */
mbedAustin 11:cada08fc8a70 265 int mbedtls_des3_crypt_cbc( mbedtls_des3_context *ctx,
mbedAustin 11:cada08fc8a70 266 int mode,
mbedAustin 11:cada08fc8a70 267 size_t length,
mbedAustin 11:cada08fc8a70 268 unsigned char iv[8],
mbedAustin 11:cada08fc8a70 269 const unsigned char *input,
mbedAustin 11:cada08fc8a70 270 unsigned char *output );
mbedAustin 11:cada08fc8a70 271 #endif /* MBEDTLS_CIPHER_MODE_CBC */
mbedAustin 11:cada08fc8a70 272
mbedAustin 11:cada08fc8a70 273 /**
mbedAustin 11:cada08fc8a70 274 * \brief Internal function for key expansion.
mbedAustin 11:cada08fc8a70 275 * (Only exposed to allow overriding it,
mbedAustin 11:cada08fc8a70 276 * see MBEDTLS_DES_SETKEY_ALT)
mbedAustin 11:cada08fc8a70 277 *
mbedAustin 11:cada08fc8a70 278 * \param SK Round keys
mbedAustin 11:cada08fc8a70 279 * \param key Base key
mbedAustin 11:cada08fc8a70 280 */
mbedAustin 11:cada08fc8a70 281 void mbedtls_des_setkey( uint32_t SK[32],
mbedAustin 11:cada08fc8a70 282 const unsigned char key[MBEDTLS_DES_KEY_SIZE] );
mbedAustin 11:cada08fc8a70 283 #ifdef __cplusplus
mbedAustin 11:cada08fc8a70 284 }
mbedAustin 11:cada08fc8a70 285 #endif
mbedAustin 11:cada08fc8a70 286
mbedAustin 11:cada08fc8a70 287 #else /* MBEDTLS_DES_ALT */
mbedAustin 11:cada08fc8a70 288 #include "des_alt.h"
mbedAustin 11:cada08fc8a70 289 #endif /* MBEDTLS_DES_ALT */
mbedAustin 11:cada08fc8a70 290
mbedAustin 11:cada08fc8a70 291 #ifdef __cplusplus
mbedAustin 11:cada08fc8a70 292 extern "C" {
mbedAustin 11:cada08fc8a70 293 #endif
mbedAustin 11:cada08fc8a70 294
mbedAustin 11:cada08fc8a70 295 /**
mbedAustin 11:cada08fc8a70 296 * \brief Checkup routine
mbedAustin 11:cada08fc8a70 297 *
mbedAustin 11:cada08fc8a70 298 * \return 0 if successful, or 1 if the test failed
mbedAustin 11:cada08fc8a70 299 */
mbedAustin 11:cada08fc8a70 300 int mbedtls_des_self_test( int verbose );
mbedAustin 11:cada08fc8a70 301
mbedAustin 11:cada08fc8a70 302 #ifdef __cplusplus
mbedAustin 11:cada08fc8a70 303 }
mbedAustin 11:cada08fc8a70 304 #endif
mbedAustin 11:cada08fc8a70 305
mbedAustin 11:cada08fc8a70 306 #endif /* des.h */