mbed TLS v1.3.14
Data Structures | Macros | Functions
des.h File Reference

DES block cipher. More...

#include "config.h"
#include <stddef.h>
#include <inttypes.h>
Include dependency graph for des.h:

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

Macros

#define DES_ENCRYPT   1
 
#define DES_DECRYPT   0
 
#define POLARSSL_ERR_DES_INVALID_INPUT_LENGTH   -0x0032
 The data input has an invalid length. More...
 
#define DES_KEY_SIZE   8
 

Functions

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

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.

Macro Definition Documentation

#define DES_DECRYPT   0

Definition at line 43 of file des.h.

#define DES_ENCRYPT   1

Definition at line 42 of file des.h.

#define DES_KEY_SIZE   8

Definition at line 47 of file des.h.

#define POLARSSL_ERR_DES_INVALID_INPUT_LENGTH   -0x0032

The data input has an invalid length.

Definition at line 45 of 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
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
void des3_free ( des3_context ctx)

Clear Triple-DES context.

Parameters
ctxDES3 context to be cleared
void des3_init ( des3_context ctx)

Initialize Triple-DES context.

Parameters
ctxDES3 context to be initialized
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
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
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
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
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
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
void des_free ( des_context ctx)

Clear DES context.

Parameters
ctxDES context to be cleared
void des_init ( des_context ctx)

Initialize DES context.

Parameters
ctxDES context to be initialized
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.
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.
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
int des_self_test ( int  verbose)

Checkup routine.

Returns
0 if successful, or 1 if the test failed
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
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