des.h File Reference
DES block cipher.
More...
#include "config.h"
#include <stddef.h>
#include <stdint.h>
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...
|
Defines |
#define | MBEDTLS_DES_ENCRYPT 1 |
#define | MBEDTLS_DES_DECRYPT 0 |
#define | MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH -0x0032 |
| The data input has an invalid length.
|
#define | MBEDTLS_DES_KEY_SIZE 8 |
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.
Define Documentation
#define MBEDTLS_DES_DECRYPT 0 |
Definition at line 36 of file des.h.
#define MBEDTLS_DES_ENCRYPT 1 |
Definition at line 35 of file des.h.
#define MBEDTLS_DES_KEY_SIZE 8 |
Definition at line 40 of file des.h.
#define MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH -0x0032 |
The data input has an invalid length.
Definition at line 38 of 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:
-
| 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 |
- Returns:
- 0 if successful, or MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH
int mbedtls_des3_crypt_ecb |
( |
mbedtls_des3_context * |
ctx, |
|
|
const unsigned char |
input[8], |
|
|
unsigned char |
output[8] | |
|
) |
| | |
3DES-ECB block encryption/decryption
- Parameters:
-
| ctx | 3DES context |
| input | 64-bit input block |
| output | 64-bit output block |
- Returns:
- 0 if successful
Clear Triple-DES context.
- Parameters:
-
| ctx | DES3 context to be cleared |
Initialize Triple-DES context.
- Parameters:
-
| ctx | DES3 context to be initialized |
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:
-
| ctx | 3DES context to be initialized |
| key | 16-byte secret key |
- Returns:
- 0
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:
-
| ctx | 3DES context to be initialized |
| key | 16-byte secret key |
- Returns:
- 0
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:
-
| ctx | 3DES context to be initialized |
| key | 24-byte secret key |
- Returns:
- 0
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:
-
| ctx | 3DES context to be initialized |
| key | 24-byte secret key |
- Returns:
- 0
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:
-
| 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 |
int mbedtls_des_crypt_ecb |
( |
mbedtls_des_context * |
ctx, |
|
|
const unsigned char |
input[8], |
|
|
unsigned char |
output[8] | |
|
) |
| | |
DES-ECB block encryption/decryption.
- Parameters:
-
| ctx | DES context |
| input | 64-bit input block |
| output | 64-bit output block |
- Returns:
- 0 if successful
Clear DES context.
- Parameters:
-
| ctx | DES context to be cleared |
Initialize DES context.
- Parameters:
-
| ctx | DES context to be initialized |
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:
-
- Returns:
- 0 is parity was ok, 1 if parity was not correct.
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:
-
- Returns:
- 0 if no weak key was found, 1 if a weak key was identified.
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:
-
int mbedtls_des_self_test |
( |
int |
verbose |
) |
|
Checkup routine.
- Returns:
- 0 if successful, or 1 if the test failed
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:
-
| SK | Round keys |
| key | Base key |
int mbedtls_des_setkey_dec |
( |
mbedtls_des_context * |
ctx, |
|
|
const unsigned char |
key[MBEDTLS_DES_KEY_SIZE] | |
|
) |
| | |
DES key schedule (56-bit, decryption).
- Parameters:
-
| ctx | DES context to be initialized |
| key | 8-byte secret key |
- Returns:
- 0
int mbedtls_des_setkey_enc |
( |
mbedtls_des_context * |
ctx, |
|
|
const unsigned char |
key[MBEDTLS_DES_KEY_SIZE] | |
|
) |
| | |
DES key schedule (56-bit, encryption).
- Parameters:
-
| ctx | DES context to be initialized |
| key | 8-byte secret key |
- Returns:
- 0