mbed TLS v2.24.0
des.h
Go to the documentation of this file.
1 
10 /*
11  * Copyright The Mbed TLS Contributors
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  */
27 #ifndef MBEDTLS_DES_H
28 #define MBEDTLS_DES_H
29 
30 #if !defined(MBEDTLS_CONFIG_FILE)
31 #include "mbedtls/config.h"
32 #else
33 #include MBEDTLS_CONFIG_FILE
34 #endif
35 
36 #include <stddef.h>
37 #include <stdint.h>
38 
39 #define MBEDTLS_DES_ENCRYPT 1
40 #define MBEDTLS_DES_DECRYPT 0
41 
42 #define MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH -0x0032
44 /* MBEDTLS_ERR_DES_HW_ACCEL_FAILED is deprecated and should not be used. */
45 #define MBEDTLS_ERR_DES_HW_ACCEL_FAILED -0x0033
47 #define MBEDTLS_DES_KEY_SIZE 8
48 
49 #ifdef __cplusplus
50 extern "C" {
51 #endif
52 
53 #if !defined(MBEDTLS_DES_ALT)
54 // Regular implementation
55 //
56 
64 typedef struct mbedtls_des_context
65 {
66  uint32_t sk[32];
67 }
68 mbedtls_des_context;
69 
73 typedef struct mbedtls_des3_context
74 {
75  uint32_t sk[96];
76 }
77 mbedtls_des3_context;
78 
79 #else /* MBEDTLS_DES_ALT */
80 #include "des_alt.h"
81 #endif /* MBEDTLS_DES_ALT */
82 
92 void mbedtls_des_init( mbedtls_des_context *ctx );
93 
103 void mbedtls_des_free( mbedtls_des_context *ctx );
104 
110 void mbedtls_des3_init( mbedtls_des3_context *ctx );
111 
117 void mbedtls_des3_free( mbedtls_des3_context *ctx );
118 
131 void mbedtls_des_key_set_parity( unsigned char key[MBEDTLS_DES_KEY_SIZE] );
132 
147 int mbedtls_des_key_check_key_parity( const unsigned char key[MBEDTLS_DES_KEY_SIZE] );
148 
160 int mbedtls_des_key_check_weak( const unsigned char key[MBEDTLS_DES_KEY_SIZE] );
161 
174 int mbedtls_des_setkey_enc( mbedtls_des_context *ctx, const unsigned char key[MBEDTLS_DES_KEY_SIZE] );
175 
188 int mbedtls_des_setkey_dec( mbedtls_des_context *ctx, const unsigned char key[MBEDTLS_DES_KEY_SIZE] );
189 
198 int mbedtls_des3_set2key_enc( mbedtls_des3_context *ctx,
199  const unsigned char key[MBEDTLS_DES_KEY_SIZE * 2] );
200 
209 int mbedtls_des3_set2key_dec( mbedtls_des3_context *ctx,
210  const unsigned char key[MBEDTLS_DES_KEY_SIZE * 2] );
211 
220 int mbedtls_des3_set3key_enc( mbedtls_des3_context *ctx,
221  const unsigned char key[MBEDTLS_DES_KEY_SIZE * 3] );
222 
231 int mbedtls_des3_set3key_dec( mbedtls_des3_context *ctx,
232  const unsigned char key[MBEDTLS_DES_KEY_SIZE * 3] );
233 
247 int mbedtls_des_crypt_ecb( mbedtls_des_context *ctx,
248  const unsigned char input[8],
249  unsigned char output[8] );
250 
251 #if defined(MBEDTLS_CIPHER_MODE_CBC)
252 
274 int mbedtls_des_crypt_cbc( mbedtls_des_context *ctx,
275  int mode,
276  size_t length,
277  unsigned char iv[8],
278  const unsigned char *input,
279  unsigned char *output );
280 #endif /* MBEDTLS_CIPHER_MODE_CBC */
281 
291 int mbedtls_des3_crypt_ecb( mbedtls_des3_context *ctx,
292  const unsigned char input[8],
293  unsigned char output[8] );
294 
295 #if defined(MBEDTLS_CIPHER_MODE_CBC)
296 
316 int mbedtls_des3_crypt_cbc( mbedtls_des3_context *ctx,
317  int mode,
318  size_t length,
319  unsigned char iv[8],
320  const unsigned char *input,
321  unsigned char *output );
322 #endif /* MBEDTLS_CIPHER_MODE_CBC */
323 
336 void mbedtls_des_setkey( uint32_t SK[32],
337  const unsigned char key[MBEDTLS_DES_KEY_SIZE] );
338 
339 #if defined(MBEDTLS_SELF_TEST)
340 
346 int mbedtls_des_self_test( int verbose );
347 
348 #endif /* MBEDTLS_SELF_TEST */
349 
350 #ifdef __cplusplus
351 }
352 #endif
353 
354 #endif /* des.h */
int mbedtls_des3_crypt_ecb(mbedtls_des3_context *ctx, const unsigned char input[8], unsigned char output[8])
3DES-ECB block encryption/decryption
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.
void mbedtls_des3_init(mbedtls_des3_context *ctx)
Initialize Triple-DES context.
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)
#define MBEDTLS_DES_KEY_SIZE
Definition: des.h:47
Configuration options (set of defines)
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)
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)
int mbedtls_des_self_test(int verbose)
Checkup routine.
int mbedtls_des_crypt_ecb(mbedtls_des_context *ctx, const unsigned char input[8], unsigned char output[8])
DES-ECB block encryption/decryption.
void mbedtls_des_free(mbedtls_des_context *ctx)
Clear DES context.
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
void mbedtls_des_init(mbedtls_des_context *ctx)
Initialize DES context.
void mbedtls_des3_free(mbedtls_des3_context *ctx)
Clear Triple-DES context.
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)
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...
int mbedtls_des_setkey_enc(mbedtls_des_context *ctx, const unsigned char key[MBEDTLS_DES_KEY_SIZE])
DES key schedule (56-bit, encryption)
void mbedtls_des_key_set_parity(unsigned char key[MBEDTLS_DES_KEY_SIZE])
Set key parity on the given key to odd.
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.
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.
int mbedtls_des_setkey_dec(mbedtls_des_context *ctx, const unsigned char key[MBEDTLS_DES_KEY_SIZE])
DES key schedule (56-bit, decryption)