mbed TLS v2.16.11
des.h
Go to the documentation of this file.
1 
10 /*
11  * Copyright The Mbed TLS Contributors
12  * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
13  *
14  * This file is provided under the Apache License 2.0, or the
15  * GNU General Public License v2.0 or later.
16  *
17  * **********
18  * Apache License 2.0:
19  *
20  * Licensed under the Apache License, Version 2.0 (the "License"); you may
21  * not use this file except in compliance with the License.
22  * You may obtain a copy of the License at
23  *
24  * http://www.apache.org/licenses/LICENSE-2.0
25  *
26  * Unless required by applicable law or agreed to in writing, software
27  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
28  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
29  * See the License for the specific language governing permissions and
30  * limitations under the License.
31  *
32  * **********
33  *
34  * **********
35  * GNU General Public License v2.0 or later:
36  *
37  * This program is free software; you can redistribute it and/or modify
38  * it under the terms of the GNU General Public License as published by
39  * the Free Software Foundation; either version 2 of the License, or
40  * (at your option) any later version.
41  *
42  * This program is distributed in the hope that it will be useful,
43  * but WITHOUT ANY WARRANTY; without even the implied warranty of
44  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
45  * GNU General Public License for more details.
46  *
47  * You should have received a copy of the GNU General Public License along
48  * with this program; if not, write to the Free Software Foundation, Inc.,
49  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
50  *
51  * **********
52  *
53  */
54 #ifndef MBEDTLS_DES_H
55 #define MBEDTLS_DES_H
56 
57 #if !defined(MBEDTLS_CONFIG_FILE)
58 #include "config.h"
59 #else
60 #include MBEDTLS_CONFIG_FILE
61 #endif
62 
63 #include <stddef.h>
64 #include <stdint.h>
65 
66 #define MBEDTLS_DES_ENCRYPT 1
67 #define MBEDTLS_DES_DECRYPT 0
68 
69 #define MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH -0x0032
71 /* MBEDTLS_ERR_DES_HW_ACCEL_FAILED is deprecated and should not be used. */
72 #define MBEDTLS_ERR_DES_HW_ACCEL_FAILED -0x0033
74 #define MBEDTLS_DES_KEY_SIZE 8
75 
76 #ifdef __cplusplus
77 extern "C" {
78 #endif
79 
80 #if !defined(MBEDTLS_DES_ALT)
81 // Regular implementation
82 //
83 
91 typedef struct mbedtls_des_context
92 {
93  uint32_t sk[32];
94 }
96 
100 typedef struct mbedtls_des3_context
101 {
102  uint32_t sk[96];
103 }
105 
106 #else /* MBEDTLS_DES_ALT */
107 #include "des_alt.h"
108 #endif /* MBEDTLS_DES_ALT */
109 
120 
131 
138 
145 
158 void mbedtls_des_key_set_parity( unsigned char key[MBEDTLS_DES_KEY_SIZE] );
159 
174 int mbedtls_des_key_check_key_parity( const unsigned char key[MBEDTLS_DES_KEY_SIZE] );
175 
187 int mbedtls_des_key_check_weak( const unsigned char key[MBEDTLS_DES_KEY_SIZE] );
188 
201 int mbedtls_des_setkey_enc( mbedtls_des_context *ctx, const unsigned char key[MBEDTLS_DES_KEY_SIZE] );
202 
215 int mbedtls_des_setkey_dec( mbedtls_des_context *ctx, const unsigned char key[MBEDTLS_DES_KEY_SIZE] );
216 
226  const unsigned char key[MBEDTLS_DES_KEY_SIZE * 2] );
227 
237  const unsigned char key[MBEDTLS_DES_KEY_SIZE * 2] );
238 
248  const unsigned char key[MBEDTLS_DES_KEY_SIZE * 3] );
249 
259  const unsigned char key[MBEDTLS_DES_KEY_SIZE * 3] );
260 
275  const unsigned char input[8],
276  unsigned char output[8] );
277 
278 #if defined(MBEDTLS_CIPHER_MODE_CBC)
279 
302  int mode,
303  size_t length,
304  unsigned char iv[8],
305  const unsigned char *input,
306  unsigned char *output );
307 #endif /* MBEDTLS_CIPHER_MODE_CBC */
308 
319  const unsigned char input[8],
320  unsigned char output[8] );
321 
322 #if defined(MBEDTLS_CIPHER_MODE_CBC)
323 
344  int mode,
345  size_t length,
346  unsigned char iv[8],
347  const unsigned char *input,
348  unsigned char *output );
349 #endif /* MBEDTLS_CIPHER_MODE_CBC */
350 
363 void mbedtls_des_setkey( uint32_t SK[32],
364  const unsigned char key[MBEDTLS_DES_KEY_SIZE] );
365 
366 #if defined(MBEDTLS_SELF_TEST)
367 
373 int mbedtls_des_self_test( int verbose );
374 
375 #endif /* MBEDTLS_SELF_TEST */
376 
377 #ifdef __cplusplus
378 }
379 #endif
380 
381 #endif /* des.h */
mbedtls_des_crypt_cbc
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.
mbedtls_des3_crypt_cbc
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
mbedtls_des_init
void mbedtls_des_init(mbedtls_des_context *ctx)
Initialize DES context.
mbedtls_des_context::sk
uint32_t sk[32]
Definition: des.h:93
mbedtls_des3_set3key_enc
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)
mbedtls_des3_set3key_dec
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)
mbedtls_des3_crypt_ecb
int mbedtls_des3_crypt_ecb(mbedtls_des3_context *ctx, const unsigned char input[8], unsigned char output[8])
3DES-ECB block encryption/decryption
mbedtls_des_key_set_parity
void mbedtls_des_key_set_parity(unsigned char key[MBEDTLS_DES_KEY_SIZE])
Set key parity on the given key to odd.
mbedtls_des3_context
struct mbedtls_des3_context mbedtls_des3_context
Triple-DES context structure.
mbedtls_des3_free
void mbedtls_des3_free(mbedtls_des3_context *ctx)
Clear Triple-DES context.
mbedtls_des_context
struct mbedtls_des_context mbedtls_des_context
DES context structure.
mbedtls_des_setkey
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...
mbedtls_des3_set2key_dec
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)
mbedtls_des_self_test
int mbedtls_des_self_test(int verbose)
Checkup routine.
mbedtls_des3_context::sk
uint32_t sk[96]
Definition: des.h:102
mbedtls_des_setkey_dec
int mbedtls_des_setkey_dec(mbedtls_des_context *ctx, const unsigned char key[MBEDTLS_DES_KEY_SIZE])
DES key schedule (56-bit, decryption)
mbedtls_des_crypt_ecb
int mbedtls_des_crypt_ecb(mbedtls_des_context *ctx, const unsigned char input[8], unsigned char output[8])
DES-ECB block encryption/decryption.
mbedtls_des_setkey_enc
int mbedtls_des_setkey_enc(mbedtls_des_context *ctx, const unsigned char key[MBEDTLS_DES_KEY_SIZE])
DES key schedule (56-bit, encryption)
mbedtls_des_key_check_weak
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.
mbedtls_des_key_check_key_parity
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.
mbedtls_des_context
DES context structure.
Definition: des.h:91
mbedtls_des3_context
Triple-DES context structure.
Definition: des.h:100
config.h
Configuration options (set of defines)
mbedtls_des_free
void mbedtls_des_free(mbedtls_des_context *ctx)
Clear DES context.
MBEDTLS_DES_KEY_SIZE
#define MBEDTLS_DES_KEY_SIZE
Definition: des.h:74
mbedtls_des3_set2key_enc
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)
mbedtls_des3_init
void mbedtls_des3_init(mbedtls_des3_context *ctx)
Initialize Triple-DES context.