des.h
mbedtls/config.h
mbedtls/platform_util.h
stddef.h
stdint.h
mbedtls/check_config.h
mbedtls/config.h
des.h
mbedtls/platform_time.h
mbedtls/platform_util.h
limits.h
stddef.h
stdint.h
time.h
mbedtls_des_context
mbedtls_des3_context
MBEDTLS_DES_ENCRYPT
1
MBEDTLS_DES_DECRYPT
0
MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH
-0x0032

The data input has an invalid length.

MBEDTLS_ERR_DES_HW_ACCEL_FAILED
-0x0033

DES hardware accelerator failed.

MBEDTLS_DES_KEY_SIZE
8
struct mbedtls_des_context typedef struct mbedtls_des_context mbedtls_des_context mbedtls_des_context

DES context structure.

DES/3DES are considered weak ciphers and their use constitutes a security risk. We recommend considering stronger ciphers instead.

struct mbedtls_des3_context typedef struct mbedtls_des3_context mbedtls_des3_context mbedtls_des3_context

Triple-DES context structure.

DES/3DES are considered weak ciphers and their use constitutes a security risk. We recommend considering stronger ciphers instead.

void void mbedtls_des_init (mbedtls_des_context *ctx) mbedtls_des_init mbedtls_des_context * ctx

Initialize DES context.

ctx

DES context to be initialized

DES/3DES are considered weak ciphers and their use constitutes a security risk. We recommend considering stronger ciphers instead.

void void mbedtls_des_free (mbedtls_des_context *ctx) mbedtls_des_free mbedtls_des_context * ctx

Clear DES context.

ctx

DES context to be cleared

DES/3DES are considered weak ciphers and their use constitutes a security risk. We recommend considering stronger ciphers instead.

void void mbedtls_des3_init (mbedtls_des3_context *ctx) mbedtls_des3_init mbedtls_des3_context * ctx

Initialize Triple-DES context.

ctx

DES3 context to be initialized

DES/3DES are considered weak ciphers and their use constitutes a security risk. We recommend considering stronger ciphers instead.

void void mbedtls_des3_free (mbedtls_des3_context *ctx) mbedtls_des3_free mbedtls_des3_context * ctx

Clear Triple-DES context.

ctx

DES3 context to be cleared

DES/3DES are considered weak ciphers and their use constitutes a security risk. We recommend considering stronger ciphers instead.

void void mbedtls_des_key_set_parity (unsigned char key[MBEDTLS_DES_KEY_SIZE]) mbedtls_des_key_set_parity unsigned char key [MBEDTLS_DES_KEY_SIZE]

Set key parity on the given key to odd.

DES keys are 56 bits long, but each byte is padded with a parity bit to allow verification. key

8-byte secret key

DES/3DES are considered weak ciphers and their use constitutes a security risk. We recommend considering stronger ciphers instead.

int int mbedtls_des_key_check_key_parity (const unsigned char key[MBEDTLS_DES_KEY_SIZE]) mbedtls_des_key_check_key_parity const unsigned char key [MBEDTLS_DES_KEY_SIZE]

Check that key parity on the given key is odd.

DES keys are 56 bits long, but each byte is padded with a parity bit to allow verification. key

8-byte secret key

0 is parity was ok, 1 if parity was not correct.

DES/3DES are considered weak ciphers and their use constitutes a security risk. We recommend considering stronger ciphers instead.

int int mbedtls_des_key_check_weak (const unsigned char key[MBEDTLS_DES_KEY_SIZE]) 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.

key

8-byte secret key

0 if no weak key was found, 1 if a weak key was identified.

DES/3DES are considered weak ciphers and their use constitutes a security risk. We recommend considering stronger ciphers instead.

int int mbedtls_des_setkey_enc (mbedtls_des_context *ctx, const unsigned char key[MBEDTLS_DES_KEY_SIZE]) mbedtls_des_setkey_enc mbedtls_des_context * ctx const unsigned char key [MBEDTLS_DES_KEY_SIZE]

DES key schedule (56-bit, encryption)

ctx

DES context to be initialized

key

8-byte secret key

0

DES/3DES are considered weak ciphers and their use constitutes a security risk. We recommend considering stronger ciphers instead.

int int mbedtls_des_setkey_dec (mbedtls_des_context *ctx, const unsigned char key[MBEDTLS_DES_KEY_SIZE]) mbedtls_des_setkey_dec mbedtls_des_context * ctx const unsigned char key [MBEDTLS_DES_KEY_SIZE]

DES key schedule (56-bit, decryption)

ctx

DES context to be initialized

key

8-byte secret key

0

DES/3DES are considered weak ciphers and their use constitutes a security risk. We recommend considering stronger ciphers instead.

int int mbedtls_des3_set2key_enc (mbedtls_des3_context *ctx, const unsigned char key[MBEDTLS_DES_KEY_SIZE *2]) mbedtls_des3_set2key_enc mbedtls_des3_context * ctx const unsigned char key [MBEDTLS_DES_KEY_SIZE *2]

Triple-DES key schedule (112-bit, encryption)

ctx

3DES context to be initialized

key

16-byte secret key

0

DES/3DES are considered weak ciphers and their use constitutes a security risk. We recommend considering stronger ciphers instead.

int int mbedtls_des3_set2key_dec (mbedtls_des3_context *ctx, const unsigned char key[MBEDTLS_DES_KEY_SIZE *2]) mbedtls_des3_set2key_dec mbedtls_des3_context * ctx const unsigned char key [MBEDTLS_DES_KEY_SIZE *2]

Triple-DES key schedule (112-bit, decryption)

ctx

3DES context to be initialized

key

16-byte secret key

0

DES/3DES are considered weak ciphers and their use constitutes a security risk. We recommend considering stronger ciphers instead.

int int mbedtls_des3_set3key_enc (mbedtls_des3_context *ctx, const unsigned char key[MBEDTLS_DES_KEY_SIZE *3]) mbedtls_des3_set3key_enc mbedtls_des3_context * ctx const unsigned char key [MBEDTLS_DES_KEY_SIZE *3]

Triple-DES key schedule (168-bit, encryption)

ctx

3DES context to be initialized

key

24-byte secret key

0

DES/3DES are considered weak ciphers and their use constitutes a security risk. We recommend considering stronger ciphers instead.

int int mbedtls_des3_set3key_dec (mbedtls_des3_context *ctx, const unsigned char key[MBEDTLS_DES_KEY_SIZE *3]) mbedtls_des3_set3key_dec mbedtls_des3_context * ctx const unsigned char key [MBEDTLS_DES_KEY_SIZE *3]

Triple-DES key schedule (168-bit, decryption)

ctx

3DES context to be initialized

key

24-byte secret key

0

DES/3DES are considered weak ciphers and their use constitutes a security risk. We recommend considering stronger ciphers instead.

int int mbedtls_des_crypt_ecb (mbedtls_des_context *ctx, const unsigned char input[8], unsigned char output[8]) mbedtls_des_crypt_ecb mbedtls_des_context * ctx const unsigned char input [8] unsigned char output [8]

DES-ECB block encryption/decryption.

ctx

DES context

input

64-bit input block

output

64-bit output block

0 if successful

DES/3DES are considered weak ciphers and their use constitutes a security risk. We recommend considering stronger ciphers instead.

int 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) 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.

Upon exit, the content of the IV is updated so that you can call the function same function again on the following block(s) of data and get the same result as if it was encrypted in one call. This allows a "streaming" usage. If on the other hand you need to retain the contents of the IV, you should either save it manually or use the cipher module instead.

ctx

DES context

mode

MBEDTLS_DES_ENCRYPT or MBEDTLS_DES_DECRYPT

length

length of the input data

iv

initialization vector (updated after use)

input

buffer holding the input data

output

buffer holding the output data

DES/3DES are considered weak ciphers and their use constitutes a security risk. We recommend considering stronger ciphers instead.

int int mbedtls_des3_crypt_ecb (mbedtls_des3_context *ctx, const unsigned char input[8], unsigned char output[8]) mbedtls_des3_crypt_ecb mbedtls_des3_context * ctx const unsigned char input [8] unsigned char output [8]

3DES-ECB block encryption/decryption

ctx

3DES context

input

64-bit input block

output

64-bit output block

0 if successful

DES/3DES are considered weak ciphers and their use constitutes a security risk. We recommend considering stronger ciphers instead.

int 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) 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

Upon exit, the content of the IV is updated so that you can call the function same function again on the following block(s) of data and get the same result as if it was encrypted in one call. This allows a "streaming" usage. If on the other hand you need to retain the contents of the IV, you should either save it manually or use the cipher module instead.

ctx

3DES context

mode

MBEDTLS_DES_ENCRYPT or MBEDTLS_DES_DECRYPT

length

length of the input data

iv

initialization vector (updated after use)

input

buffer holding the input data

output

buffer holding the output data

0 if successful, or MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH

DES/3DES are considered weak ciphers and their use constitutes a security risk. We recommend considering stronger ciphers instead.

void void mbedtls_des_setkey (uint32_t SK[32], const unsigned char key[MBEDTLS_DES_KEY_SIZE]) 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)

SK

Round keys

key

Base key

DES/3DES are considered weak ciphers and their use constitutes a security risk. We recommend considering stronger ciphers instead.

int int mbedtls_des_self_test (int verbose) mbedtls_des_self_test int verbose

Checkup routine.

0 if successful, or 1 if the test failed

DES block cipher.

DES/3DES are considered weak ciphers and their use constitutes a security risk. We recommend considering stronger ciphers instead.

    /*
    *CopyrightTheMbedTLSContributors
    *SPDX-License-Identifier:Apache-2.0ORGPL-2.0-or-later
    *
    */
    #ifndefMBEDTLS_DES_H
    #defineMBEDTLS_DES_H

    #if!defined(MBEDTLS_CONFIG_FILE)
    #include"mbedtls/config.h"
    #else
    #includeMBEDTLS_CONFIG_FILE
    #endif
    #include"mbedtls/platform_util.h"

    #include<stddef.h>
    #include<stdint.h>

    #defineMBEDTLS_DES_ENCRYPT1
    #defineMBEDTLS_DES_DECRYPT0

    #defineMBEDTLS_ERR_DES_INVALID_INPUT_LENGTH-0x0032

    /*MBEDTLS_ERR_DES_HW_ACCEL_FAILEDisdeprecatedandshouldnotbeused.*/
    #defineMBEDTLS_ERR_DES_HW_ACCEL_FAILED-0x0033

    #defineMBEDTLS_DES_KEY_SIZE8

    #ifdef__cplusplus
    extern"C"{
    #endif

    #if!defined(MBEDTLS_DES_ALT)
    //Regularimplementation
    //

    typedefstructmbedtls_des_context{
    uint32_tsk[32];
    }
    mbedtls_des_context;

    typedefstructmbedtls_des3_context{
    uint32_tsk[96];
    }
    mbedtls_des3_context;

    #else/*MBEDTLS_DES_ALT*/
    #include"des_alt.h"
    #endif/*MBEDTLS_DES_ALT*/

    voidmbedtls_des_init(mbedtls_des_context*ctx);

    voidmbedtls_des_free(mbedtls_des_context*ctx);

    voidmbedtls_des3_init(mbedtls_des3_context*ctx);

    voidmbedtls_des3_free(mbedtls_des3_context*ctx);

    voidmbedtls_des_key_set_parity(unsignedcharkey[MBEDTLS_DES_KEY_SIZE]);

    MBEDTLS_CHECK_RETURN_TYPICAL
    intmbedtls_des_key_check_key_parity(constunsignedcharkey[MBEDTLS_DES_KEY_SIZE]);

    MBEDTLS_CHECK_RETURN_TYPICAL
    intmbedtls_des_key_check_weak(constunsignedcharkey[MBEDTLS_DES_KEY_SIZE]);

    MBEDTLS_CHECK_RETURN_TYPICAL
    intmbedtls_des_setkey_enc(mbedtls_des_context*ctx,constunsignedcharkey[MBEDTLS_DES_KEY_SIZE]);

    MBEDTLS_CHECK_RETURN_TYPICAL
    intmbedtls_des_setkey_dec(mbedtls_des_context*ctx,constunsignedcharkey[MBEDTLS_DES_KEY_SIZE]);

    MBEDTLS_CHECK_RETURN_TYPICAL
    intmbedtls_des3_set2key_enc(mbedtls_des3_context*ctx,
    constunsignedcharkey[MBEDTLS_DES_KEY_SIZE*2]);

    MBEDTLS_CHECK_RETURN_TYPICAL
    intmbedtls_des3_set2key_dec(mbedtls_des3_context*ctx,
    constunsignedcharkey[MBEDTLS_DES_KEY_SIZE*2]);

    MBEDTLS_CHECK_RETURN_TYPICAL
    intmbedtls_des3_set3key_enc(mbedtls_des3_context*ctx,
    constunsignedcharkey[MBEDTLS_DES_KEY_SIZE*3]);

    MBEDTLS_CHECK_RETURN_TYPICAL
    intmbedtls_des3_set3key_dec(mbedtls_des3_context*ctx,
    constunsignedcharkey[MBEDTLS_DES_KEY_SIZE*3]);

    MBEDTLS_CHECK_RETURN_TYPICAL
    intmbedtls_des_crypt_ecb(mbedtls_des_context*ctx,
    constunsignedcharinput[8],
    unsignedcharoutput[8]);

    #ifdefined(MBEDTLS_CIPHER_MODE_CBC)
    MBEDTLS_CHECK_RETURN_TYPICAL
    intmbedtls_des_crypt_cbc(mbedtls_des_context*ctx,
    intmode,
    size_tlength,
    unsignedchariv[8],
    constunsignedchar*input,
    unsignedchar*output);
    #endif/*MBEDTLS_CIPHER_MODE_CBC*/

    MBEDTLS_CHECK_RETURN_TYPICAL
    intmbedtls_des3_crypt_ecb(mbedtls_des3_context*ctx,
    constunsignedcharinput[8],
    unsignedcharoutput[8]);

    #ifdefined(MBEDTLS_CIPHER_MODE_CBC)
    MBEDTLS_CHECK_RETURN_TYPICAL
    intmbedtls_des3_crypt_cbc(mbedtls_des3_context*ctx,
    intmode,
    size_tlength,
    unsignedchariv[8],
    constunsignedchar*input,
    unsignedchar*output);
    #endif/*MBEDTLS_CIPHER_MODE_CBC*/

    voidmbedtls_des_setkey(uint32_tSK[32],
    constunsignedcharkey[MBEDTLS_DES_KEY_SIZE]);

    #ifdefined(MBEDTLS_SELF_TEST)

    MBEDTLS_CHECK_RETURN_CRITICAL
    intmbedtls_des_self_test(intverbose);

    #endif/*MBEDTLS_SELF_TEST*/

    #ifdef__cplusplus
    }
    #endif

    #endif/*des.h*/