Doug Anson / mbedTLSLibrary

mbed TLS library

Dependents:   HTTPClient-SSL WS_SERVER

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  des_context
 DES context structure. More...
struct  des3_context
 Triple-DES context structure. More...

Functions

void des_init (des_context *ctx)
 Initialize DES context.
void des_free (des_context *ctx)
 Clear DES context.
void des3_init (des3_context *ctx)
 Initialize Triple-DES context.
void des3_free (des3_context *ctx)
 Clear Triple-DES context.
void des_key_set_parity (unsigned char key[DES_KEY_SIZE])
 Set key parity on the given key to odd.
int des_key_check_key_parity (const unsigned char key[DES_KEY_SIZE])
 Check that key parity on the given key is odd.
int des_key_check_weak (const unsigned char key[DES_KEY_SIZE])
 Check that key is not a weak or semi-weak DES key.
int des_setkey_enc (des_context *ctx, const unsigned char key[DES_KEY_SIZE])
 DES key schedule (56-bit, encryption)
int des_setkey_dec (des_context *ctx, const unsigned char key[DES_KEY_SIZE])
 DES key schedule (56-bit, decryption)
int des3_set2key_enc (des3_context *ctx, const unsigned char key[DES_KEY_SIZE *2])
 Triple-DES key schedule (112-bit, encryption)
int des3_set2key_dec (des3_context *ctx, const unsigned char key[DES_KEY_SIZE *2])
 Triple-DES key schedule (112-bit, decryption)
int des3_set3key_enc (des3_context *ctx, const unsigned char key[DES_KEY_SIZE *3])
 Triple-DES key schedule (168-bit, encryption)
int des3_set3key_dec (des3_context *ctx, const unsigned char key[DES_KEY_SIZE *3])
 Triple-DES key schedule (168-bit, decryption)
int des_crypt_ecb (des_context *ctx, const unsigned char input[8], unsigned char output[8])
 DES-ECB block encryption/decryption.
int des_crypt_cbc (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 des3_crypt_ecb (des3_context *ctx, const unsigned char input[8], unsigned char output[8])
 3DES-ECB block encryption/decryption
int des3_crypt_cbc (des3_context *ctx, int mode, size_t length, unsigned char iv[8], const unsigned char *input, unsigned char *output)
 3DES-CBC buffer encryption/decryption
int des_self_test (int verbose)
 Checkup routine.

Detailed Description

DES block cipher.

Copyright (C) 2006-2014, ARM Limited, All Rights Reserved

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

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

Definition in file des.h.

Function Documentation

int des3_crypt_cbc ( 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
modeDES_ENCRYPT or 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 POLARSSL_ERR_DES_INVALID_INPUT_LENGTH

Definition at line 757 of file des.c.

int des3_crypt_ecb ( 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 713 of file des.c.

void des3_free ( des3_context *  ctx )

Clear Triple-DES context.

Parameters:
ctxDES3 context to be cleared

Definition at line 328 of file des.c.

void des3_init ( des3_context *  ctx )

Initialize Triple-DES context.

Parameters:
ctxDES3 context to be initialized

Definition at line 323 of file des.c.

int des3_set2key_dec ( des3_context *  ctx,
const unsigned char  key[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 563 of file des.c.

int des3_set2key_enc ( des3_context *  ctx,
const unsigned char  key[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 549 of file des.c.

int des3_set3key_dec ( des3_context *  ctx,
const unsigned char  key[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 614 of file des.c.

int des3_set3key_enc ( des3_context *  ctx,
const unsigned char  key[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 600 of file des.c.

int des_crypt_cbc ( 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
modeDES_ENCRYPT or 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 660 of file des.c.

int des_crypt_ecb ( 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 628 of file des.c.

void des_free ( des_context *  ctx )

Clear DES context.

Parameters:
ctxDES context to be cleared

Definition at line 315 of file des.c.

void des_init ( des_context *  ctx )

Initialize DES context.

Parameters:
ctxDES context to be initialized

Definition at line 310 of file des.c.

int des_key_check_key_parity ( const unsigned char  key[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 358 of file des.c.

int des_key_check_weak ( const unsigned char  key[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 413 of file des.c.

void des_key_set_parity ( unsigned char  key[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 347 of file des.c.

int des_self_test ( int  verbose )

Checkup routine.

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

Definition at line 865 of file des.c.

int des_setkey_dec ( des_context *  ctx,
const unsigned char  key[DES_KEY_SIZE] 
)

DES key schedule (56-bit, decryption)

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

Definition at line 506 of file des.c.

int des_setkey_enc ( des_context *  ctx,
const unsigned char  key[DES_KEY_SIZE] 
)

DES key schedule (56-bit, encryption)

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

Definition at line 496 of file des.c.

Generated on Tue Jul 12 2022 13:50:39 by  doxygen 1.7.2