sandbox / mbedtls

mbedtls ported to mbed-classic

Fork of mbedtls by Christopher Haster

Embed: (wiki syntax)

« Back to documentation index

des.h File Reference
Data Structures | Functions

des.h File Reference

DES block cipher. More...

Go to the source code of this file.

Data Structures

struct  mbedtls_des_context
 DES context structure. More...
struct  mbedtls_des3_context
 Triple-DES context structure. More...

Functions

void mbedtls_des_init (mbedtls_des_context *ctx)
 Initialize DES context.
void mbedtls_des_free (mbedtls_des_context *ctx)
 Clear DES context.
void mbedtls_des3_init (mbedtls_des3_context *ctx)
 Initialize Triple-DES context.
void mbedtls_des3_free (mbedtls_des3_context *ctx)
 Clear Triple-DES context.
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_key_check_weak (const unsigned char key[MBEDTLS_DES_KEY_SIZE])
 Check that key is not a weak or semi-weak DES key.
int mbedtls_des_setkey_enc (mbedtls_des_context *ctx, const unsigned char key[MBEDTLS_DES_KEY_SIZE])
 DES key schedule (56-bit, encryption)
int mbedtls_des_setkey_dec (mbedtls_des_context *ctx, const unsigned char key[MBEDTLS_DES_KEY_SIZE])
 DES key schedule (56-bit, decryption)
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_set2key_dec (mbedtls_des3_context *ctx, const unsigned char key[MBEDTLS_DES_KEY_SIZE *2])
 Triple-DES key schedule (112-bit, decryption)
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_des3_set3key_dec (mbedtls_des3_context *ctx, const unsigned char key[MBEDTLS_DES_KEY_SIZE *3])
 Triple-DES key schedule (168-bit, decryption)
int mbedtls_des_crypt_ecb (mbedtls_des_context *ctx, const unsigned char input[8], unsigned char output[8])
 DES-ECB block encryption/decryption.
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_des3_crypt_ecb (mbedtls_des3_context *ctx, const unsigned char input[8], unsigned char output[8])
 3DES-ECB block encryption/decryption
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_setkey (uint32_t SK[32], const unsigned char key[MBEDTLS_DES_KEY_SIZE])
 Internal function for key expansion.
int mbedtls_des_self_test (int verbose)
 Checkup routine.

Detailed Description

DES block cipher.

Copyright (C) 2006-2015, ARM Limited, All Rights Reserved SPDX-License-Identifier: Apache-2.0

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

This file is part of mbed TLS (https://tls.mbed.org)

Definition in file des.h.

Function Documentation

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

Note:
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.
Parameters:
ctx3DES context
modeMBEDTLS_DES_ENCRYPT or MBEDTLS_DES_DECRYPT
lengthlength of the input data
ivinitialization vector (updated after use)
inputbuffer holding the input data
outputbuffer holding the output data
Returns:
0 if successful, or MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH

Definition at line 762 of file des.c.

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

3DES-ECB block encryption/decryption

Parameters:
ctx3DES context
input64-bit input block
output64-bit output block
Returns:
0 if successful

Definition at line 717 of file des.c.

void mbedtls_des3_free ( mbedtls_des3_context *  ctx )

Clear Triple-DES context.

Parameters:
ctxDES3 context to be cleared

Definition at line 327 of file des.c.

void mbedtls_des3_init ( mbedtls_des3_context *  ctx )

Initialize Triple-DES context.

Parameters:
ctxDES3 context to be initialized

Definition at line 322 of file des.c.

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)

Parameters:
ctx3DES context to be initialized
key16-byte secret key
Returns:
0

Definition at line 564 of file des.c.

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)

Parameters:
ctx3DES context to be initialized
key16-byte secret key
Returns:
0

Definition at line 550 of file des.c.

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)

Parameters:
ctx3DES context to be initialized
key24-byte secret key
Returns:
0

Definition at line 615 of file des.c.

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)

Parameters:
ctx3DES context to be initialized
key24-byte secret key
Returns:
0

Definition at line 601 of file des.c.

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.

Note:
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.
Parameters:
ctxDES context
modeMBEDTLS_DES_ENCRYPT or MBEDTLS_DES_DECRYPT
lengthlength of the input data
ivinitialization vector (updated after use)
inputbuffer holding the input data
outputbuffer holding the output data

Definition at line 663 of file des.c.

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

DES-ECB block encryption/decryption.

Parameters:
ctxDES context
input64-bit input block
output64-bit output block
Returns:
0 if successful

Definition at line 630 of file des.c.

void mbedtls_des_free ( mbedtls_des_context *  ctx )

Clear DES context.

Parameters:
ctxDES context to be cleared

Definition at line 314 of file des.c.

void mbedtls_des_init ( mbedtls_des_context *  ctx )

Initialize DES context.

Parameters:
ctxDES context to be initialized

Definition at line 309 of file des.c.

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.

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

Parameters:
key8-byte secret key
Returns:
0 is parity was ok, 1 if parity was not correct.

Definition at line 357 of file des.c.

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.

Parameters:
key8-byte secret key
Returns:
0 if no weak key was found, 1 if a weak key was identified.

Definition at line 412 of file des.c.

void 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.

Parameters:
key8-byte secret key

Definition at line 346 of file des.c.

int mbedtls_des_self_test ( int  verbose )

Checkup routine.

Returns:
0 if successful, or 1 if the test failed

Definition at line 870 of file des.c.

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)

Parameters:
SKRound keys
keyBase key

Definition at line 424 of file des.c.

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

DES key schedule (56-bit, decryption)

Parameters:
ctxDES context to be initialized
key8-byte secret key
Returns:
0

Definition at line 507 of file des.c.

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

DES key schedule (56-bit, encryption)

Parameters:
ctxDES context to be initialized
key8-byte secret key
Returns:
0

Definition at line 497 of file des.c.

Generated on Tue Jul 12 2022 12:52:51 by  doxygen 1.7.2