mbed TLS v2.16.3: des.h Source File

mbed TLS v2.16.3

des.h
Go to the documentation of this file.
1
10 /*
11 * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
12 * SPDX-License-Identifier: Apache-2.0
13 *
14 * Licensed under the Apache License, Version 2.0 (the "License"); you may
15 * not use this file except in compliance with the License.
16 * You may obtain a copy of the License at
17 *
18 * http://www.apache.org/licenses/LICENSE-2.0
19 *
20 * Unless required by applicable law or agreed to in writing, software
21 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
22 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
23 * See the License for the specific language governing permissions and
24 * limitations under the License.
25 *
26 * This file is part of mbed TLS (https://tls.mbed.org)
27 *
28 */
29 #ifndef MBEDTLS_DES_H
30 #define MBEDTLS_DES_H
31
32 #if !defined(MBEDTLS_CONFIG_FILE)
33 #include "config.h"
34 #else
35 #include MBEDTLS_CONFIG_FILE
36 #endif
37
38 #include <stddef.h>
39 #include <stdint.h>
40
41 #define MBEDTLS_DES_ENCRYPT 1
42 #define MBEDTLS_DES_DECRYPT 0
43
44 #define MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH -0x0032
46 /* MBEDTLS_ERR_DES_HW_ACCEL_FAILED is deprecated and should not be used. */
47 #define MBEDTLS_ERR_DES_HW_ACCEL_FAILED -0x0033
49 #define MBEDTLS_DES_KEY_SIZE 8
50
51 #ifdef __cplusplus
52 extern "C" {
53 #endif
54
55 #if !defined(MBEDTLS_DES_ALT)
56 // Regular implementation
57 //
58
66 typedef struct mbedtls_des_context
67 {
68 uint32_t sk[32];
69 }
70 mbedtls_des_context;
71
75 typedef struct mbedtls_des3_context
76 {
77 uint32_t sk[96];
78 }
79 mbedtls_des3_context;
80
81 #else /* MBEDTLS_DES_ALT */
82 #include "des_alt.h"
83 #endif /* MBEDTLS_DES_ALT */
84
94 void mbedtls_des_init( mbedtls_des_context *ctx );
95
105 void mbedtls_des_free( mbedtls_des_context *ctx );
106
112 void mbedtls_des3_init( mbedtls_des3_context *ctx );
113
119 void mbedtls_des3_free( mbedtls_des3_context *ctx );
120
133 void mbedtls_des_key_set_parity( unsigned char key[MBEDTLS_DES_KEY_SIZE] );
134
149 int mbedtls_des_key_check_key_parity( const unsigned char key[MBEDTLS_DES_KEY_SIZE] );
150
162 int mbedtls_des_key_check_weak( const unsigned char key[MBEDTLS_DES_KEY_SIZE] );
163
176 int mbedtls_des_setkey_enc( mbedtls_des_context *ctx, const unsigned char key[MBEDTLS_DES_KEY_SIZE] );
177
190 int mbedtls_des_setkey_dec( mbedtls_des_context *ctx, const unsigned char key[MBEDTLS_DES_KEY_SIZE] );
191
200 int mbedtls_des3_set2key_enc( mbedtls_des3_context *ctx,
201 const unsigned char key[MBEDTLS_DES_KEY_SIZE * 2] );
202
211 int mbedtls_des3_set2key_dec( mbedtls_des3_context *ctx,
212 const unsigned char key[MBEDTLS_DES_KEY_SIZE * 2] );
213
222 int mbedtls_des3_set3key_enc( mbedtls_des3_context *ctx,
223 const unsigned char key[MBEDTLS_DES_KEY_SIZE * 3] );
224
233 int mbedtls_des3_set3key_dec( mbedtls_des3_context *ctx,
234 const unsigned char key[MBEDTLS_DES_KEY_SIZE * 3] );
235
249 int mbedtls_des_crypt_ecb( mbedtls_des_context *ctx,
250 const unsigned char input[8],
251 unsigned char output[8] );
252
253 #if defined(MBEDTLS_CIPHER_MODE_CBC)
254
276 int mbedtls_des_crypt_cbc( mbedtls_des_context *ctx,
277 int mode,
278 size_t length,
279 unsigned char iv[8],
280 const unsigned char *input,
281 unsigned char *output );
282 #endif /* MBEDTLS_CIPHER_MODE_CBC */
283
293 int mbedtls_des3_crypt_ecb( mbedtls_des3_context *ctx,
294 const unsigned char input[8],
295 unsigned char output[8] );
296
297 #if defined(MBEDTLS_CIPHER_MODE_CBC)
298
318 int mbedtls_des3_crypt_cbc( mbedtls_des3_context *ctx,
319 int mode,
320 size_t length,
321 unsigned char iv[8],
322 const unsigned char *input,
323 unsigned char *output );
324 #endif /* MBEDTLS_CIPHER_MODE_CBC */
325
338 void mbedtls_des_setkey( uint32_t SK[32],
339 const unsigned char key[MBEDTLS_DES_KEY_SIZE] );
340
341 #if defined(MBEDTLS_SELF_TEST)
342
348 int mbedtls_des_self_test( int verbose );
349
350 #endif /* MBEDTLS_SELF_TEST */
351
352 #ifdef __cplusplus
353 }
354 #endif
355
356 #endif /* des.h */
mbedtls_des_crypt_cbc
int mbedtls_des_crypt_cbc(mbedtls_des_context *ctx, int mode, size_t length, unsigned char iv[8], const unsigned char *input, unsigned char *output)
DES-CBC buffer encryption/decryption.
mbedtls_des3_crypt_cbc
int mbedtls_des3_crypt_cbc(mbedtls_des3_context *ctx, int mode, size_t length, unsigned char iv[8], const unsigned char *input, unsigned char *output)
3DES-CBC buffer encryption/decryption
mbedtls_des_init
void mbedtls_des_init(mbedtls_des_context *ctx)
Initialize DES context.
mbedtls_des_context::sk
uint32_t sk[32]
Definition: des.h:68
mbedtls_des3_set3key_enc
int mbedtls_des3_set3key_enc(mbedtls_des3_context *ctx, const unsigned char key[MBEDTLS_DES_KEY_SIZE *3])
Triple-DES key schedule (168-bit, encryption)
mbedtls_des_context
struct mbedtls_des_context mbedtls_des_context
DES context structure.
mbedtls_des3_set3key_dec
int mbedtls_des3_set3key_dec(mbedtls_des3_context *ctx, const unsigned char key[MBEDTLS_DES_KEY_SIZE *3])
Triple-DES key schedule (168-bit, decryption)
mbedtls_des3_crypt_ecb
int mbedtls_des3_crypt_ecb(mbedtls_des3_context *ctx, const unsigned char input[8], unsigned char output[8])
3DES-ECB block encryption/decryption
mbedtls_des_key_set_parity
void mbedtls_des_key_set_parity(unsigned char key[MBEDTLS_DES_KEY_SIZE])
Set key parity on the given key to odd.
mbedtls_des3_free
void mbedtls_des3_free(mbedtls_des3_context *ctx)
Clear Triple-DES context.
mbedtls_des_setkey
void mbedtls_des_setkey(uint32_t SK[32], const unsigned char key[MBEDTLS_DES_KEY_SIZE])
Internal function for key expansion. (Only exposed to allow overriding it, see MBEDTLS_DES_SETKEY_ALT...
mbedtls_des3_set2key_dec
int mbedtls_des3_set2key_dec(mbedtls_des3_context *ctx, const unsigned char key[MBEDTLS_DES_KEY_SIZE *2])
Triple-DES key schedule (112-bit, decryption)
mbedtls_des_self_test
int mbedtls_des_self_test(int verbose)
Checkup routine.
mbedtls_des3_context::sk
uint32_t sk[96]
Definition: des.h:77
mbedtls_des_setkey_dec
int mbedtls_des_setkey_dec(mbedtls_des_context *ctx, const unsigned char key[MBEDTLS_DES_KEY_SIZE])
DES key schedule (56-bit, decryption)
mbedtls_des_crypt_ecb
int mbedtls_des_crypt_ecb(mbedtls_des_context *ctx, const unsigned char input[8], unsigned char output[8])
DES-ECB block encryption/decryption.
mbedtls_des_setkey_enc
int mbedtls_des_setkey_enc(mbedtls_des_context *ctx, const unsigned char key[MBEDTLS_DES_KEY_SIZE])
DES key schedule (56-bit, encryption)
mbedtls_des_key_check_weak
int mbedtls_des_key_check_weak(const unsigned char key[MBEDTLS_DES_KEY_SIZE])
Check that key is not a weak or semi-weak DES key.
mbedtls_des_key_check_key_parity
int mbedtls_des_key_check_key_parity(const unsigned char key[MBEDTLS_DES_KEY_SIZE])
Check that key parity on the given key is odd.
mbedtls_des_context
DES context structure.
Definition: des.h:66
mbedtls_des3_context
Triple-DES context structure.
Definition: des.h:75
config.h
Configuration options (set of defines)
mbedtls_des3_context
struct mbedtls_des3_context mbedtls_des3_context
Triple-DES context structure.
mbedtls_des_free
void mbedtls_des_free(mbedtls_des_context *ctx)
Clear DES context.
MBEDTLS_DES_KEY_SIZE
#define MBEDTLS_DES_KEY_SIZE
Definition: des.h:49
mbedtls_des3_set2key_enc
int mbedtls_des3_set2key_enc(mbedtls_des3_context *ctx, const unsigned char key[MBEDTLS_DES_KEY_SIZE *2])
Triple-DES key schedule (112-bit, encryption)
mbedtls_des3_init
void mbedtls_des3_init(mbedtls_des3_context *ctx)
Initialize Triple-DES context.