mbed TLS v3.1.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 #include "mbedtls/private_access.h"
30 
31 #include "mbedtls/build_info.h"
32 #include "mbedtls/platform_util.h"
33 
34 #include <stddef.h>
35 #include <stdint.h>
36 
37 #define MBEDTLS_DES_ENCRYPT 1
38 #define MBEDTLS_DES_DECRYPT 0
39 
41 #define MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH -0x0032
42 
43 #define MBEDTLS_DES_KEY_SIZE 8
44 
45 #ifdef __cplusplus
46 extern "C" {
47 #endif
48 
49 #if !defined(MBEDTLS_DES_ALT)
50 // Regular implementation
51 //
52 
60 typedef struct mbedtls_des_context
61 {
62  uint32_t MBEDTLS_PRIVATE(sk)[32];
63 }
64 mbedtls_des_context;
65 
69 typedef struct mbedtls_des3_context
70 {
71  uint32_t MBEDTLS_PRIVATE(sk)[96];
72 }
73 mbedtls_des3_context;
74 
75 #else /* MBEDTLS_DES_ALT */
76 #include "des_alt.h"
77 #endif /* MBEDTLS_DES_ALT */
78 
88 void mbedtls_des_init( mbedtls_des_context *ctx );
89 
99 void mbedtls_des_free( mbedtls_des_context *ctx );
100 
106 void mbedtls_des3_init( mbedtls_des3_context *ctx );
107 
113 void mbedtls_des3_free( mbedtls_des3_context *ctx );
114 
127 void mbedtls_des_key_set_parity( unsigned char key[MBEDTLS_DES_KEY_SIZE] );
128 
144 int mbedtls_des_key_check_key_parity( const unsigned char key[MBEDTLS_DES_KEY_SIZE] );
145 
158 int mbedtls_des_key_check_weak( const unsigned char key[MBEDTLS_DES_KEY_SIZE] );
159 
173 int mbedtls_des_setkey_enc( mbedtls_des_context *ctx, const unsigned char key[MBEDTLS_DES_KEY_SIZE] );
174 
188 int mbedtls_des_setkey_dec( mbedtls_des_context *ctx, const unsigned char key[MBEDTLS_DES_KEY_SIZE] );
189 
199 int mbedtls_des3_set2key_enc( mbedtls_des3_context *ctx,
200  const unsigned char key[MBEDTLS_DES_KEY_SIZE * 2] );
201 
211 int mbedtls_des3_set2key_dec( mbedtls_des3_context *ctx,
212  const unsigned char key[MBEDTLS_DES_KEY_SIZE * 2] );
213 
223 int mbedtls_des3_set3key_enc( mbedtls_des3_context *ctx,
224  const unsigned char key[MBEDTLS_DES_KEY_SIZE * 3] );
225 
235 int mbedtls_des3_set3key_dec( mbedtls_des3_context *ctx,
236  const unsigned char key[MBEDTLS_DES_KEY_SIZE * 3] );
237 
252 int mbedtls_des_crypt_ecb( mbedtls_des_context *ctx,
253  const unsigned char input[8],
254  unsigned char output[8] );
255 
256 #if defined(MBEDTLS_CIPHER_MODE_CBC)
257 
280 int mbedtls_des_crypt_cbc( mbedtls_des_context *ctx,
281  int mode,
282  size_t length,
283  unsigned char iv[8],
284  const unsigned char *input,
285  unsigned char *output );
286 #endif /* MBEDTLS_CIPHER_MODE_CBC */
287 
298 int mbedtls_des3_crypt_ecb( mbedtls_des3_context *ctx,
299  const unsigned char input[8],
300  unsigned char output[8] );
301 
302 #if defined(MBEDTLS_CIPHER_MODE_CBC)
303 
324 int mbedtls_des3_crypt_cbc( mbedtls_des3_context *ctx,
325  int mode,
326  size_t length,
327  unsigned char iv[8],
328  const unsigned char *input,
329  unsigned char *output );
330 #endif /* MBEDTLS_CIPHER_MODE_CBC */
331 
344 void mbedtls_des_setkey( uint32_t SK[32],
345  const unsigned char key[MBEDTLS_DES_KEY_SIZE] );
346 
347 #if defined(MBEDTLS_SELF_TEST)
348 
355 int mbedtls_des_self_test( int verbose );
356 
357 #endif /* MBEDTLS_SELF_TEST */
358 
359 #ifdef __cplusplus
360 }
361 #endif
362 
363 #endif /* des.h */
MBEDTLS_CHECK_RETURN_TYPICAL 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_CHECK_RETURN_TYPICAL int mbedtls_des_crypt_ecb(mbedtls_des_context *ctx, const unsigned char input[8], unsigned char output[8])
DES-ECB block encryption/decryption.
MBEDTLS_CHECK_RETURN_TYPICAL 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_CHECK_RETURN_TYPICAL 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_CHECK_RETURN_TYPICAL int mbedtls_des3_crypt_ecb(mbedtls_des3_context *ctx, const unsigned char input[8], unsigned char output[8])
3DES-ECB block encryption/decryption
void mbedtls_des3_init(mbedtls_des3_context *ctx)
Initialize Triple-DES context.
#define MBEDTLS_CHECK_RETURN_TYPICAL
MBEDTLS_CHECK_RETURN_TYPICAL int mbedtls_des_setkey_enc(mbedtls_des_context *ctx, const unsigned char key[MBEDTLS_DES_KEY_SIZE])
DES key schedule (56-bit, encryption)
#define MBEDTLS_DES_KEY_SIZE
Definition: des.h:43
MBEDTLS_CHECK_RETURN_TYPICAL 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.
#define MBEDTLS_PRIVATE(member)
MBEDTLS_CHECK_RETURN_TYPICAL 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_CHECK_RETURN_CRITICAL int mbedtls_des_self_test(int verbose)
Checkup routine.
MBEDTLS_CHECK_RETURN_TYPICAL 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.
Common and shared functions used by multiple modules in the Mbed TLS library.
Macro wrapper for struct's memebrs.
void mbedtls_des_free(mbedtls_des_context *ctx)
Clear DES context.
Build-time configuration info.
void mbedtls_des_init(mbedtls_des_context *ctx)
Initialize DES context.
void mbedtls_des3_free(mbedtls_des3_context *ctx)
Clear Triple-DES context.
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_CHECK_RETURN_TYPICAL 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)
void mbedtls_des_key_set_parity(unsigned char key[MBEDTLS_DES_KEY_SIZE])
Set key parity on the given key to odd.
#define MBEDTLS_CHECK_RETURN_CRITICAL
Definition: platform_util.h:93
MBEDTLS_CHECK_RETURN_TYPICAL 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_CHECK_RETURN_TYPICAL int mbedtls_des_setkey_dec(mbedtls_des_context *ctx, const unsigned char key[MBEDTLS_DES_KEY_SIZE])
DES key schedule (56-bit, decryption)