mbed TLS v2.28.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 #include "mbedtls/platform_util.h"
36 
37 #include <stddef.h>
38 #include <stdint.h>
39 
40 #define MBEDTLS_DES_ENCRYPT 1
41 #define MBEDTLS_DES_DECRYPT 0
42 
44 #define MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH -0x0032
45 
46 /* MBEDTLS_ERR_DES_HW_ACCEL_FAILED is deprecated and should not be used. */
48 #define MBEDTLS_ERR_DES_HW_ACCEL_FAILED -0x0033
49 
50 #define MBEDTLS_DES_KEY_SIZE 8
51 
52 #ifdef __cplusplus
53 extern "C" {
54 #endif
55 
56 #if !defined(MBEDTLS_DES_ALT)
57 // Regular implementation
58 //
59 
67 typedef struct mbedtls_des_context
68 {
69  uint32_t sk[32];
70 }
72 
76 typedef struct mbedtls_des3_context
77 {
78  uint32_t sk[96];
79 }
81 
82 #else /* MBEDTLS_DES_ALT */
83 #include "des_alt.h"
84 #endif /* MBEDTLS_DES_ALT */
85 
96 
107 
114 
121 
134 void mbedtls_des_key_set_parity( unsigned char key[MBEDTLS_DES_KEY_SIZE] );
135 
151 int mbedtls_des_key_check_key_parity( const unsigned char key[MBEDTLS_DES_KEY_SIZE] );
152 
165 int mbedtls_des_key_check_weak( const unsigned char key[MBEDTLS_DES_KEY_SIZE] );
166 
180 int mbedtls_des_setkey_enc( mbedtls_des_context *ctx, const unsigned char key[MBEDTLS_DES_KEY_SIZE] );
181 
195 int mbedtls_des_setkey_dec( mbedtls_des_context *ctx, const unsigned char key[MBEDTLS_DES_KEY_SIZE] );
196 
207  const unsigned char key[MBEDTLS_DES_KEY_SIZE * 2] );
208 
219  const unsigned char key[MBEDTLS_DES_KEY_SIZE * 2] );
220 
231  const unsigned char key[MBEDTLS_DES_KEY_SIZE * 3] );
232 
243  const unsigned char key[MBEDTLS_DES_KEY_SIZE * 3] );
244 
260  const unsigned char input[8],
261  unsigned char output[8] );
262 
263 #if defined(MBEDTLS_CIPHER_MODE_CBC)
264 
288  int mode,
289  size_t length,
290  unsigned char iv[8],
291  const unsigned char *input,
292  unsigned char *output );
293 #endif /* MBEDTLS_CIPHER_MODE_CBC */
294 
306  const unsigned char input[8],
307  unsigned char output[8] );
308 
309 #if defined(MBEDTLS_CIPHER_MODE_CBC)
310 
332  int mode,
333  size_t length,
334  unsigned char iv[8],
335  const unsigned char *input,
336  unsigned char *output );
337 #endif /* MBEDTLS_CIPHER_MODE_CBC */
338 
351 void mbedtls_des_setkey( uint32_t SK[32],
352  const unsigned char key[MBEDTLS_DES_KEY_SIZE] );
353 
354 #if defined(MBEDTLS_SELF_TEST)
355 
362 int mbedtls_des_self_test( int verbose );
363 
364 #endif /* MBEDTLS_SELF_TEST */
365 
366 #ifdef __cplusplus
367 }
368 #endif
369 
370 #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:50
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.
DES context structure.
Definition: des.h:67
Configuration options (set of defines)
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.
Triple-DES context structure.
Definition: des.h:76
struct mbedtls_des3_context mbedtls_des3_context
Triple-DES context structure.
void mbedtls_des_free(mbedtls_des_context *ctx)
Clear DES context.
struct mbedtls_des_context mbedtls_des_context
DES context structure.
void mbedtls_des_init(mbedtls_des_context *ctx)
Initialize DES context.
uint32_t sk[96]
Definition: des.h:78
uint32_t sk[32]
Definition: des.h:69
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
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)