mbed TLS v2.14.1

cipher.h
Go to the documentation of this file.
1
10 /*
11 * Copyright (C) 2006-2018, Arm Limited (or its affiliates), All Rights Reserved
12 * SPDX-License-Identifier: Apache-2.0
13 *
14 * Licensed under the Apache License, Version 2.0 (the "License"); you may
15 * not use this file except in compliance with the License.
16 * You may obtain a copy of the License at
17 *
18 * http://www.apache.org/licenses/LICENSE-2.0
19 *
20 * Unless required by applicable law or agreed to in writing, software
21 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
22 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
23 * See the License for the specific language governing permissions and
24 * limitations under the License.
25 *
26 * This file is part of Mbed TLS (https://tls.mbed.org)
27 */
28
29 #ifndef MBEDTLS_CIPHER_H
30 #define MBEDTLS_CIPHER_H
31
32 #if !defined(MBEDTLS_CONFIG_FILE)
33 #include "config.h"
34 #else
35 #include MBEDTLS_CONFIG_FILE
36 #endif
37
38 #include <stddef.h>
39
40 #if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CCM_C) || defined(MBEDTLS_CHACHAPOLY_C)
41 #define MBEDTLS_CIPHER_MODE_AEAD
42 #endif
43
44 #if defined(MBEDTLS_CIPHER_MODE_CBC)
45 #define MBEDTLS_CIPHER_MODE_WITH_PADDING
46 #endif
47
48 #if defined(MBEDTLS_ARC4_C) || defined(MBEDTLS_CIPHER_NULL_CIPHER) || \
49 defined(MBEDTLS_CHACHA20_C)
50 #define MBEDTLS_CIPHER_MODE_STREAM
51 #endif
52
53 #if ( defined(__ARMCC_VERSION) || defined(_MSC_VER) ) && \
54 !defined(inline) && !defined(__cplusplus)
55 #define inline __inline
56 #endif
57
58 #define MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE -0x6080
59 #define MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA -0x6100
60 #define MBEDTLS_ERR_CIPHER_ALLOC_FAILED -0x6180
61 #define MBEDTLS_ERR_CIPHER_INVALID_PADDING -0x6200
62 #define MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED -0x6280
63 #define MBEDTLS_ERR_CIPHER_AUTH_FAILED -0x6300
64 #define MBEDTLS_ERR_CIPHER_INVALID_CONTEXT -0x6380
66 /* MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED is deprecated and should not be used. */
67 #define MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED -0x6400
69 #define MBEDTLS_CIPHER_VARIABLE_IV_LEN 0x01
70 #define MBEDTLS_CIPHER_VARIABLE_KEY_LEN 0x02
72 #ifdef __cplusplus
73 extern "C" {
74 #endif
75
83 typedef enum {
84 MBEDTLS_CIPHER_ID_NONE = 0,
85 MBEDTLS_CIPHER_ID_NULL,
86 MBEDTLS_CIPHER_ID_AES,
87 MBEDTLS_CIPHER_ID_DES,
88 MBEDTLS_CIPHER_ID_3DES,
89 MBEDTLS_CIPHER_ID_CAMELLIA,
90 MBEDTLS_CIPHER_ID_BLOWFISH,
91 MBEDTLS_CIPHER_ID_ARC4,
92 MBEDTLS_CIPHER_ID_ARIA,
93 MBEDTLS_CIPHER_ID_CHACHA20,
94 } mbedtls_cipher_id_t;
95
103 typedef enum {
104 MBEDTLS_CIPHER_NONE = 0,
105 MBEDTLS_CIPHER_NULL,
106 MBEDTLS_CIPHER_AES_128_ECB,
107 MBEDTLS_CIPHER_AES_192_ECB,
108 MBEDTLS_CIPHER_AES_256_ECB,
109 MBEDTLS_CIPHER_AES_128_CBC,
110 MBEDTLS_CIPHER_AES_192_CBC,
111 MBEDTLS_CIPHER_AES_256_CBC,
112 MBEDTLS_CIPHER_AES_128_CFB128,
113 MBEDTLS_CIPHER_AES_192_CFB128,
114 MBEDTLS_CIPHER_AES_256_CFB128,
115 MBEDTLS_CIPHER_AES_128_CTR,
116 MBEDTLS_CIPHER_AES_192_CTR,
117 MBEDTLS_CIPHER_AES_256_CTR,
118 MBEDTLS_CIPHER_AES_128_GCM,
119 MBEDTLS_CIPHER_AES_192_GCM,
120 MBEDTLS_CIPHER_AES_256_GCM,
121 MBEDTLS_CIPHER_CAMELLIA_128_ECB,
122 MBEDTLS_CIPHER_CAMELLIA_192_ECB,
123 MBEDTLS_CIPHER_CAMELLIA_256_ECB,
124 MBEDTLS_CIPHER_CAMELLIA_128_CBC,
125 MBEDTLS_CIPHER_CAMELLIA_192_CBC,
126 MBEDTLS_CIPHER_CAMELLIA_256_CBC,
127 MBEDTLS_CIPHER_CAMELLIA_128_CFB128,
128 MBEDTLS_CIPHER_CAMELLIA_192_CFB128,
129 MBEDTLS_CIPHER_CAMELLIA_256_CFB128,
130 MBEDTLS_CIPHER_CAMELLIA_128_CTR,
131 MBEDTLS_CIPHER_CAMELLIA_192_CTR,
132 MBEDTLS_CIPHER_CAMELLIA_256_CTR,
133 MBEDTLS_CIPHER_CAMELLIA_128_GCM,
134 MBEDTLS_CIPHER_CAMELLIA_192_GCM,
135 MBEDTLS_CIPHER_CAMELLIA_256_GCM,
136 MBEDTLS_CIPHER_DES_ECB,
137 MBEDTLS_CIPHER_DES_CBC,
138 MBEDTLS_CIPHER_DES_EDE_ECB,
139 MBEDTLS_CIPHER_DES_EDE_CBC,
140 MBEDTLS_CIPHER_DES_EDE3_ECB,
141 MBEDTLS_CIPHER_DES_EDE3_CBC,
142 MBEDTLS_CIPHER_BLOWFISH_ECB,
143 MBEDTLS_CIPHER_BLOWFISH_CBC,
144 MBEDTLS_CIPHER_BLOWFISH_CFB64,
145 MBEDTLS_CIPHER_BLOWFISH_CTR,
146 MBEDTLS_CIPHER_ARC4_128,
147 MBEDTLS_CIPHER_AES_128_CCM,
148 MBEDTLS_CIPHER_AES_192_CCM,
149 MBEDTLS_CIPHER_AES_256_CCM,
150 MBEDTLS_CIPHER_CAMELLIA_128_CCM,
151 MBEDTLS_CIPHER_CAMELLIA_192_CCM,
152 MBEDTLS_CIPHER_CAMELLIA_256_CCM,
153 MBEDTLS_CIPHER_ARIA_128_ECB,
154 MBEDTLS_CIPHER_ARIA_192_ECB,
155 MBEDTLS_CIPHER_ARIA_256_ECB,
156 MBEDTLS_CIPHER_ARIA_128_CBC,
157 MBEDTLS_CIPHER_ARIA_192_CBC,
158 MBEDTLS_CIPHER_ARIA_256_CBC,
159 MBEDTLS_CIPHER_ARIA_128_CFB128,
160 MBEDTLS_CIPHER_ARIA_192_CFB128,
161 MBEDTLS_CIPHER_ARIA_256_CFB128,
162 MBEDTLS_CIPHER_ARIA_128_CTR,
163 MBEDTLS_CIPHER_ARIA_192_CTR,
164 MBEDTLS_CIPHER_ARIA_256_CTR,
165 MBEDTLS_CIPHER_ARIA_128_GCM,
166 MBEDTLS_CIPHER_ARIA_192_GCM,
167 MBEDTLS_CIPHER_ARIA_256_GCM,
168 MBEDTLS_CIPHER_ARIA_128_CCM,
169 MBEDTLS_CIPHER_ARIA_192_CCM,
170 MBEDTLS_CIPHER_ARIA_256_CCM,
171 MBEDTLS_CIPHER_AES_128_OFB,
172 MBEDTLS_CIPHER_AES_192_OFB,
173 MBEDTLS_CIPHER_AES_256_OFB,
174 MBEDTLS_CIPHER_AES_128_XTS,
175 MBEDTLS_CIPHER_AES_256_XTS,
176 MBEDTLS_CIPHER_CHACHA20,
177 MBEDTLS_CIPHER_CHACHA20_POLY1305,
178 } mbedtls_cipher_type_t;
179
181 typedef enum {
182 MBEDTLS_MODE_NONE = 0,
183 MBEDTLS_MODE_ECB,
184 MBEDTLS_MODE_CBC,
185 MBEDTLS_MODE_CFB,
186 MBEDTLS_MODE_OFB,
187 MBEDTLS_MODE_CTR,
188 MBEDTLS_MODE_GCM,
189 MBEDTLS_MODE_STREAM,
190 MBEDTLS_MODE_CCM,
191 MBEDTLS_MODE_XTS,
192 MBEDTLS_MODE_CHACHAPOLY,
193 } mbedtls_cipher_mode_t;
194
196 typedef enum {
197 MBEDTLS_PADDING_PKCS7 = 0,
198 MBEDTLS_PADDING_ONE_AND_ZEROS,
199 MBEDTLS_PADDING_ZEROS_AND_LEN,
200 MBEDTLS_PADDING_ZEROS,
201 MBEDTLS_PADDING_NONE,
202 } mbedtls_cipher_padding_t;
203
205 typedef enum {
206 MBEDTLS_OPERATION_NONE = -1,
207 MBEDTLS_DECRYPT = 0,
208 MBEDTLS_ENCRYPT,
209 } mbedtls_operation_t;
210
211 enum {
213 MBEDTLS_KEY_LENGTH_NONE = 0,
215 MBEDTLS_KEY_LENGTH_DES = 64,
217 MBEDTLS_KEY_LENGTH_DES_EDE = 128,
219 MBEDTLS_KEY_LENGTH_DES_EDE3 = 192,
220 };
221
223 #define MBEDTLS_MAX_IV_LENGTH 16
224
225 #define MBEDTLS_MAX_BLOCK_LENGTH 16
226
230 typedef struct mbedtls_cipher_base_t mbedtls_cipher_base_t;
231
235 typedef struct mbedtls_cmac_context_t mbedtls_cmac_context_t;
236
241 typedef struct mbedtls_cipher_info_t
242 {
246 mbedtls_cipher_type_t type;
247
249 mbedtls_cipher_mode_t mode;
250
255 unsigned int key_bitlen;
256
258 const char * name;
259
264 unsigned int iv_size;
265
270 int flags;
271
273 unsigned int block_size;
274
276 const mbedtls_cipher_base_t *base;
277
278 } mbedtls_cipher_info_t;
279
283 typedef struct mbedtls_cipher_context_t
284 {
286 const mbedtls_cipher_info_t *cipher_info;
287
289 int key_bitlen;
290
294 mbedtls_operation_t operation;
295
296 #if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
297
300 void (*add_padding)( unsigned char *output, size_t olen, size_t data_len );
301 int (*get_padding)( unsigned char *input, size_t ilen, size_t *data_len );
302 #endif
303
305 unsigned char unprocessed_data[MBEDTLS_MAX_BLOCK_LENGTH];
306
308 size_t unprocessed_len;
309
312 unsigned char iv[MBEDTLS_MAX_IV_LENGTH];
313
315 size_t iv_size;
316
318 void *cipher_ctx;
319
320 #if defined(MBEDTLS_CMAC_C)
321
322 mbedtls_cmac_context_t *cmac_ctx;
323 #endif
324 } mbedtls_cipher_context_t;
325
333 const int *mbedtls_cipher_list( void );
334
345 const mbedtls_cipher_info_t *mbedtls_cipher_info_from_string( const char *cipher_name );
346
357 const mbedtls_cipher_info_t *mbedtls_cipher_info_from_type( const mbedtls_cipher_type_t cipher_type );
358
373 const mbedtls_cipher_info_t *mbedtls_cipher_info_from_values( const mbedtls_cipher_id_t cipher_id,
374 int key_bitlen,
375 const mbedtls_cipher_mode_t mode );
376
380 void mbedtls_cipher_init( mbedtls_cipher_context_t *ctx );
381
387 void mbedtls_cipher_free( mbedtls_cipher_context_t *ctx );
388
389
408 int mbedtls_cipher_setup( mbedtls_cipher_context_t *ctx, const mbedtls_cipher_info_t *cipher_info );
409
418 static inline unsigned int mbedtls_cipher_get_block_size( const mbedtls_cipher_context_t *ctx )
419 {
420 if( NULL == ctx || NULL == ctx->cipher_info )
421 return 0;
422
423 return ctx->cipher_info->block_size;
424 }
425
435 static inline mbedtls_cipher_mode_t mbedtls_cipher_get_cipher_mode( const mbedtls_cipher_context_t *ctx )
436 {
437 if( NULL == ctx || NULL == ctx->cipher_info )
438 return MBEDTLS_MODE_NONE;
439
440 return ctx->cipher_info->mode;
441 }
442
453 static inline int mbedtls_cipher_get_iv_size( const mbedtls_cipher_context_t *ctx )
454 {
455 if( NULL == ctx || NULL == ctx->cipher_info )
456 return 0;
457
458 if( ctx->iv_size != 0 )
459 return (int) ctx->iv_size;
460
461 return (int) ctx->cipher_info->iv_size;
462 }
463
472 static inline mbedtls_cipher_type_t mbedtls_cipher_get_type( const mbedtls_cipher_context_t *ctx )
473 {
474 if( NULL == ctx || NULL == ctx->cipher_info )
475 return MBEDTLS_CIPHER_NONE;
476
477 return ctx->cipher_info->type;
478 }
479
489 static inline const char *mbedtls_cipher_get_name( const mbedtls_cipher_context_t *ctx )
490 {
491 if( NULL == ctx || NULL == ctx->cipher_info )
492 return 0;
493
494 return ctx->cipher_info->name;
495 }
496
506 static inline int mbedtls_cipher_get_key_bitlen( const mbedtls_cipher_context_t *ctx )
507 {
508 if( NULL == ctx || NULL == ctx->cipher_info )
509 return MBEDTLS_KEY_LENGTH_NONE;
510
511 return (int) ctx->cipher_info->key_bitlen;
512 }
513
522 static inline mbedtls_operation_t mbedtls_cipher_get_operation( const mbedtls_cipher_context_t *ctx )
523 {
524 if( NULL == ctx || NULL == ctx->cipher_info )
525 return MBEDTLS_OPERATION_NONE;
526
527 return ctx->operation;
528 }
529
546 int mbedtls_cipher_setkey( mbedtls_cipher_context_t *ctx, const unsigned char *key,
547 int key_bitlen, const mbedtls_operation_t operation );
548
549 #if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
550
565 int mbedtls_cipher_set_padding_mode( mbedtls_cipher_context_t *ctx, mbedtls_cipher_padding_t mode );
566 #endif /* MBEDTLS_CIPHER_MODE_WITH_PADDING */
567
584 int mbedtls_cipher_set_iv( mbedtls_cipher_context_t *ctx,
585 const unsigned char *iv, size_t iv_len );
586
596 int mbedtls_cipher_reset( mbedtls_cipher_context_t *ctx );
597
598 #if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CHACHAPOLY_C)
599
611 int mbedtls_cipher_update_ad( mbedtls_cipher_context_t *ctx,
612 const unsigned char *ad, size_t ad_len );
613 #endif /* MBEDTLS_GCM_C || MBEDTLS_CHACHAPOLY_C */
614
646 int mbedtls_cipher_update( mbedtls_cipher_context_t *ctx, const unsigned char *input,
647 size_t ilen, unsigned char *output, size_t *olen );
648
668 int mbedtls_cipher_finish( mbedtls_cipher_context_t *ctx,
669 unsigned char *output, size_t *olen );
670
671 #if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CHACHAPOLY_C)
672
684 int mbedtls_cipher_write_tag( mbedtls_cipher_context_t *ctx,
685 unsigned char *tag, size_t tag_len );
686
699 int mbedtls_cipher_check_tag( mbedtls_cipher_context_t *ctx,
700 const unsigned char *tag, size_t tag_len );
701 #endif /* MBEDTLS_GCM_C || MBEDTLS_CHACHAPOLY_C */
702
732 int mbedtls_cipher_crypt( mbedtls_cipher_context_t *ctx,
733 const unsigned char *iv, size_t iv_len,
734 const unsigned char *input, size_t ilen,
735 unsigned char *output, size_t *olen );
736
737 #if defined(MBEDTLS_CIPHER_MODE_AEAD)
738
761 int mbedtls_cipher_auth_encrypt( mbedtls_cipher_context_t *ctx,
762 const unsigned char *iv, size_t iv_len,
763 const unsigned char *ad, size_t ad_len,
764 const unsigned char *input, size_t ilen,
765 unsigned char *output, size_t *olen,
766 unsigned char *tag, size_t tag_len );
767
796 int mbedtls_cipher_auth_decrypt( mbedtls_cipher_context_t *ctx,
797 const unsigned char *iv, size_t iv_len,
798 const unsigned char *ad, size_t ad_len,
799 const unsigned char *input, size_t ilen,
800 unsigned char *output, size_t *olen,
801 const unsigned char *tag, size_t tag_len );
802 #endif /* MBEDTLS_CIPHER_MODE_AEAD */
803
804 #ifdef __cplusplus
805 }
806 #endif
807
808 #endif /* MBEDTLS_CIPHER_H */
MBEDTLS_CIPHER_CAMELLIA_128_CTR
Definition: cipher.h:130
MBEDTLS_CIPHER_ID_3DES
Definition: cipher.h:88
MBEDTLS_CIPHER_AES_128_GCM
Definition: cipher.h:118
MBEDTLS_CIPHER_DES_EDE_ECB
Definition: cipher.h:138
mbedtls_cipher_context_t::unprocessed_data
unsigned char unprocessed_data[MBEDTLS_MAX_BLOCK_LENGTH]
Definition: cipher.h:305
MBEDTLS_CIPHER_AES_128_CCM
Definition: cipher.h:147
MBEDTLS_CIPHER_ARIA_256_CTR
Definition: cipher.h:164
mbedtls_operation_t
mbedtls_operation_t
Definition: cipher.h:205
MBEDTLS_CIPHER_CAMELLIA_256_CFB128
Definition: cipher.h:129
mbedtls_cipher_info_t::iv_size
unsigned int iv_size
Definition: cipher.h:264
MBEDTLS_KEY_LENGTH_DES_EDE
Definition: cipher.h:217
MBEDTLS_CIPHER_ARIA_128_GCM
Definition: cipher.h:165
MBEDTLS_CIPHER_NONE
Definition: cipher.h:104
MBEDTLS_CIPHER_AES_128_CBC
Definition: cipher.h:109
mbedtls_cipher_padding_t
mbedtls_cipher_padding_t
Definition: cipher.h:196
MBEDTLS_PADDING_NONE
Definition: cipher.h:201
mbedtls_cipher_get_cipher_mode
static mbedtls_cipher_mode_t mbedtls_cipher_get_cipher_mode(const mbedtls_cipher_context_t *ctx)
This function returns the mode of operation for the cipher. For example, MBEDTLS_MODE_CBC.
Definition: cipher.h:435
MBEDTLS_CIPHER_AES_192_CBC
Definition: cipher.h:110
MBEDTLS_CIPHER_ID_ARIA
Definition: cipher.h:92
MBEDTLS_CIPHER_CAMELLIA_128_GCM
Definition: cipher.h:133
mbedtls_cipher_info_t::flags
int flags
Definition: cipher.h:270
mbedtls_cipher_get_block_size
static unsigned int mbedtls_cipher_get_block_size(const mbedtls_cipher_context_t *ctx)
This function returns the block size of the given cipher.
Definition: cipher.h:418
MBEDTLS_CIPHER_ARIA_256_CBC
Definition: cipher.h:158
mbedtls_cipher_mode_t
mbedtls_cipher_mode_t
Definition: cipher.h:181
MBEDTLS_MODE_OFB
Definition: cipher.h:186
MBEDTLS_CIPHER_NULL
Definition: cipher.h:105
MBEDTLS_CIPHER_CAMELLIA_128_CCM
Definition: cipher.h:150
mbedtls_cmac_context_t
Definition: cmac.h:54
MBEDTLS_CIPHER_ARIA_192_CCM
Definition: cipher.h:169
mbedtls_cipher_info_from_string
const mbedtls_cipher_info_t * mbedtls_cipher_info_from_string(const char *cipher_name)
This function retrieves the cipher-information structure associated with the given cipher name...
mbedtls_cipher_finish
int mbedtls_cipher_finish(mbedtls_cipher_context_t *ctx, unsigned char *output, size_t *olen)
The generic cipher finalization function. If data still needs to be flushed from an incomplete block...
mbedtls_cipher_context_t::add_padding
void(* add_padding)(unsigned char *output, size_t olen, size_t data_len)
Definition: cipher.h:300
mbedtls_cipher_context_t
Definition: cipher.h:283
mbedtls_cipher_reset
int mbedtls_cipher_reset(mbedtls_cipher_context_t *ctx)
This function resets the cipher state.
MBEDTLS_CIPHER_CAMELLIA_256_ECB
Definition: cipher.h:123
MBEDTLS_CIPHER_CAMELLIA_192_CCM
Definition: cipher.h:151
MBEDTLS_CIPHER_AES_256_XTS
Definition: cipher.h:175
MBEDTLS_CIPHER_CAMELLIA_192_CFB128
Definition: cipher.h:128
mbedtls_cipher_get_name
static const char * mbedtls_cipher_get_name(const mbedtls_cipher_context_t *ctx)
This function returns the name of the given cipher as a string.
Definition: cipher.h:489
MBEDTLS_MODE_CTR
Definition: cipher.h:187
MBEDTLS_CIPHER_AES_256_CFB128
Definition: cipher.h:114
config.h
Configuration options (set of defines)
MBEDTLS_CIPHER_BLOWFISH_CTR
Definition: cipher.h:145
mbedtls_cipher_set_iv
int mbedtls_cipher_set_iv(mbedtls_cipher_context_t *ctx, const unsigned char *iv, size_t iv_len)
This function sets the initialization vector (IV) or nonce.
mbedtls_cipher_info_t
Definition: cipher.h:241
MBEDTLS_CIPHER_AES_192_ECB
Definition: cipher.h:107
MBEDTLS_CIPHER_ARIA_256_CFB128
Definition: cipher.h:161
MBEDTLS_CIPHER_ID_CHACHA20
Definition: cipher.h:93
MBEDTLS_MODE_CHACHAPOLY
Definition: cipher.h:192
mbedtls_cipher_set_padding_mode
int mbedtls_cipher_set_padding_mode(mbedtls_cipher_context_t *ctx, mbedtls_cipher_padding_t mode)
This function sets the padding mode, for cipher modes that use padding.
MBEDTLS_CIPHER_ARIA_192_ECB
Definition: cipher.h:154
mbedtls_cipher_info_t::mode
mbedtls_cipher_mode_t mode
Definition: cipher.h:249
mbedtls_cipher_update
int mbedtls_cipher_update(mbedtls_cipher_context_t *ctx, const unsigned char *input, size_t ilen, unsigned char *output, size_t *olen)
The generic cipher update function. It encrypts or decrypts using the given cipher context...
mbedtls_cipher_info_t::block_size
unsigned int block_size
Definition: cipher.h:273
mbedtls_cipher_free
void mbedtls_cipher_free(mbedtls_cipher_context_t *ctx)
This function frees and clears the cipher-specific context of ctx. Freeing ctx itself remains the res...
mbedtls_cipher_get_operation
static mbedtls_operation_t mbedtls_cipher_get_operation(const mbedtls_cipher_context_t *ctx)
This function returns the operation of the given cipher.
Definition: cipher.h:522
mbedtls_cipher_list
const int * mbedtls_cipher_list(void)
This function retrieves the list of ciphers supported by the generic cipher module.
MBEDTLS_PADDING_ZEROS_AND_LEN
Definition: cipher.h:199
mbedtls_cipher_get_key_bitlen
static int mbedtls_cipher_get_key_bitlen(const mbedtls_cipher_context_t *ctx)
This function returns the key length of the cipher.
Definition: cipher.h:506
MBEDTLS_CIPHER_ARIA_192_CFB128
Definition: cipher.h:160
mbedtls_cipher_type_t
mbedtls_cipher_type_t
Supported {cipher type, cipher mode} pairs.
Definition: cipher.h:103
MBEDTLS_CIPHER_CAMELLIA_256_CBC
Definition: cipher.h:126
MBEDTLS_CIPHER_CAMELLIA_128_ECB
Definition: cipher.h:121
MBEDTLS_ENCRYPT
Definition: cipher.h:208
mbedtls_cipher_info_t
struct mbedtls_cipher_info_t mbedtls_cipher_info_t
mbedtls_cipher_context_t::cipher_info
const mbedtls_cipher_info_t * cipher_info
Definition: cipher.h:286
MBEDTLS_CIPHER_AES_128_CFB128
Definition: cipher.h:112
MBEDTLS_CIPHER_BLOWFISH_CBC
Definition: cipher.h:143
MBEDTLS_PADDING_ZEROS
Definition: cipher.h:200
MBEDTLS_CIPHER_CHACHA20
Definition: cipher.h:176
mbedtls_cipher_base_t
struct mbedtls_cipher_base_t mbedtls_cipher_base_t
Definition: cipher.h:230
mbedtls_cipher_info_from_values
const mbedtls_cipher_info_t * mbedtls_cipher_info_from_values(const mbedtls_cipher_id_t cipher_id, int key_bitlen, const mbedtls_cipher_mode_t mode)
This function retrieves the cipher-information structure associated with the given cipher ID...
MBEDTLS_CIPHER_ID_CAMELLIA
Definition: cipher.h:89
MBEDTLS_CIPHER_ID_ARC4
Definition: cipher.h:91
MBEDTLS_KEY_LENGTH_DES_EDE3
Definition: cipher.h:219
MBEDTLS_CIPHER_DES_CBC
Definition: cipher.h:137
mbedtls_cipher_get_type
static mbedtls_cipher_type_t mbedtls_cipher_get_type(const mbedtls_cipher_context_t *ctx)
This function returns the type of the given cipher.
Definition: cipher.h:472
MBEDTLS_KEY_LENGTH_NONE
Definition: cipher.h:213
mbedtls_cipher_context_t::get_padding
int(* get_padding)(unsigned char *input, size_t ilen, size_t *data_len)
Definition: cipher.h:301
MBEDTLS_MODE_STREAM
Definition: cipher.h:189
MBEDTLS_CIPHER_ID_NONE
Definition: cipher.h:84
mbedtls_cipher_context_t::cipher_ctx
void * cipher_ctx
Definition: cipher.h:318
MBEDTLS_CIPHER_AES_256_CBC
Definition: cipher.h:111
MBEDTLS_CIPHER_CAMELLIA_256_CCM
Definition: cipher.h:152
MBEDTLS_CIPHER_CAMELLIA_192_ECB
Definition: cipher.h:122
MBEDTLS_MODE_CFB
Definition: cipher.h:185
MBEDTLS_PADDING_ONE_AND_ZEROS
Definition: cipher.h:198
mbedtls_cipher_context_t::operation
mbedtls_operation_t operation
Definition: cipher.h:294
MBEDTLS_CIPHER_AES_256_GCM
Definition: cipher.h:120
MBEDTLS_CIPHER_CAMELLIA_192_CTR
Definition: cipher.h:131
MBEDTLS_MODE_CCM
Definition: cipher.h:190
MBEDTLS_DECRYPT
Definition: cipher.h:207
mbedtls_cipher_id_t
mbedtls_cipher_id_t
Supported cipher types.
Definition: cipher.h:83
MBEDTLS_MODE_XTS
Definition: cipher.h:191
mbedtls_cipher_context_t::iv
unsigned char iv[MBEDTLS_MAX_IV_LENGTH]
Definition: cipher.h:312
MBEDTLS_CIPHER_CAMELLIA_192_CBC
Definition: cipher.h:125
mbedtls_cipher_setkey
int mbedtls_cipher_setkey(mbedtls_cipher_context_t *ctx, const unsigned char *key, int key_bitlen, const mbedtls_operation_t operation)
This function sets the key to use with the given context.
MBEDTLS_CIPHER_AES_256_ECB
Definition: cipher.h:108
MBEDTLS_CIPHER_CAMELLIA_256_GCM
Definition: cipher.h:135
MBEDTLS_CIPHER_AES_128_OFB
Definition: cipher.h:171
MBEDTLS_CIPHER_BLOWFISH_CFB64
Definition: cipher.h:144
MBEDTLS_MAX_IV_LENGTH
#define MBEDTLS_MAX_IV_LENGTH
Definition: cipher.h:223
MBEDTLS_CIPHER_ARIA_256_ECB
Definition: cipher.h:155
MBEDTLS_CIPHER_ARIA_256_GCM
Definition: cipher.h:167
MBEDTLS_CIPHER_CAMELLIA_128_CFB128
Definition: cipher.h:127
MBEDTLS_CIPHER_ARC4_128
Definition: cipher.h:146
MBEDTLS_CIPHER_DES_EDE_CBC
Definition: cipher.h:139
mbedtls_cipher_context_t::unprocessed_len
size_t unprocessed_len
Definition: cipher.h:308
MBEDTLS_CIPHER_CAMELLIA_192_GCM
Definition: cipher.h:134
mbedtls_cipher_auth_decrypt
int mbedtls_cipher_auth_decrypt(mbedtls_cipher_context_t *ctx, const unsigned char *iv, size_t iv_len, const unsigned char *ad, size_t ad_len, const unsigned char *input, size_t ilen, unsigned char *output, size_t *olen, const unsigned char *tag, size_t tag_len)
The generic autenticated decryption (AEAD) function.
mbedtls_cipher_info_t::name
const char * name
Definition: cipher.h:258
MBEDTLS_CIPHER_BLOWFISH_ECB
Definition: cipher.h:142
MBEDTLS_MODE_CBC
Definition: cipher.h:184
MBEDTLS_CIPHER_ARIA_128_CBC
Definition: cipher.h:156
MBEDTLS_CIPHER_AES_128_CTR
Definition: cipher.h:115
MBEDTLS_CIPHER_CHACHA20_POLY1305
Definition: cipher.h:177
mbedtls_cipher_auth_encrypt
int mbedtls_cipher_auth_encrypt(mbedtls_cipher_context_t *ctx, const unsigned char *iv, size_t iv_len, const unsigned char *ad, size_t ad_len, const unsigned char *input, size_t ilen, unsigned char *output, size_t *olen, unsigned char *tag, size_t tag_len)
The generic autenticated encryption (AEAD) function.
MBEDTLS_MODE_GCM
Definition: cipher.h:188
MBEDTLS_MODE_ECB
Definition: cipher.h:183
MBEDTLS_CIPHER_ID_AES
Definition: cipher.h:86
MBEDTLS_CIPHER_AES_192_CCM
Definition: cipher.h:148
MBEDTLS_PADDING_PKCS7
Definition: cipher.h:197
mbedtls_cipher_crypt
int mbedtls_cipher_crypt(mbedtls_cipher_context_t *ctx, const unsigned char *iv, size_t iv_len, const unsigned char *input, size_t ilen, unsigned char *output, size_t *olen)
The generic all-in-one encryption/decryption function, for all ciphers except AEAD constructs...
MBEDTLS_OPERATION_NONE
Definition: cipher.h:206
MBEDTLS_CIPHER_ARIA_128_CCM
Definition: cipher.h:168
MBEDTLS_CIPHER_CAMELLIA_128_CBC
Definition: cipher.h:124
mbedtls_cipher_context_t::key_bitlen
int key_bitlen
Definition: cipher.h:289
mbedtls_cipher_init
void mbedtls_cipher_init(mbedtls_cipher_context_t *ctx)
This function initializes a cipher_context as NONE.
MBEDTLS_CIPHER_AES_192_OFB
Definition: cipher.h:172
MBEDTLS_CIPHER_DES_EDE3_CBC
Definition: cipher.h:141
MBEDTLS_CIPHER_ARIA_128_CFB128
Definition: cipher.h:159
mbedtls_cipher_update_ad
int mbedtls_cipher_update_ad(mbedtls_cipher_context_t *ctx, const unsigned char *ad, size_t ad_len)
This function adds additional data for AEAD ciphers. Currently supported with GCM and ChaCha20+Poly13...
MBEDTLS_CIPHER_ID_NULL
Definition: cipher.h:85
MBEDTLS_CIPHER_AES_128_XTS
Definition: cipher.h:174
MBEDTLS_CIPHER_ID_BLOWFISH
Definition: cipher.h:90
mbedtls_cipher_setup
int mbedtls_cipher_setup(mbedtls_cipher_context_t *ctx, const mbedtls_cipher_info_t *cipher_info)
This function initializes and fills the cipher-context structure with the appropriate values...
MBEDTLS_CIPHER_ARIA_192_CBC
Definition: cipher.h:157
MBEDTLS_CIPHER_DES_EDE3_ECB
Definition: cipher.h:140
MBEDTLS_CIPHER_AES_192_CTR
Definition: cipher.h:116
MBEDTLS_CIPHER_DES_ECB
Definition: cipher.h:136
mbedtls_cipher_check_tag
int mbedtls_cipher_check_tag(mbedtls_cipher_context_t *ctx, const unsigned char *tag, size_t tag_len)
This function checks the tag for AEAD ciphers. Currently supported with GCM and ChaCha20+Poly1305. Must be called after mbedtls_cipher_finish().
mbedtls_cipher_get_iv_size
static int mbedtls_cipher_get_iv_size(const mbedtls_cipher_context_t *ctx)
This function returns the size of the IV or nonce of the cipher, in Bytes.
Definition: cipher.h:453
MBEDTLS_KEY_LENGTH_DES
Definition: cipher.h:215
MBEDTLS_CIPHER_ARIA_128_ECB
Definition: cipher.h:153
MBEDTLS_CIPHER_ARIA_128_CTR
Definition: cipher.h:162
mbedtls_cipher_context_t
struct mbedtls_cipher_context_t mbedtls_cipher_context_t
mbedtls_cipher_write_tag
int mbedtls_cipher_write_tag(mbedtls_cipher_context_t *ctx, unsigned char *tag, size_t tag_len)
This function writes a tag for AEAD ciphers. Currently supported with GCM and ChaCha20+Poly1305. Must be called after mbedtls_cipher_finish().
MBEDTLS_CIPHER_AES_192_GCM
Definition: cipher.h:119
mbedtls_cipher_context_t::iv_size
size_t iv_size
Definition: cipher.h:315
MBEDTLS_MAX_BLOCK_LENGTH
#define MBEDTLS_MAX_BLOCK_LENGTH
Definition: cipher.h:225
MBEDTLS_CIPHER_ARIA_192_CTR
Definition: cipher.h:163
MBEDTLS_CIPHER_AES_128_ECB
Definition: cipher.h:106
MBEDTLS_CIPHER_AES_256_CTR
Definition: cipher.h:117
MBEDTLS_CIPHER_AES_256_OFB
Definition: cipher.h:173
MBEDTLS_CIPHER_CAMELLIA_256_CTR
Definition: cipher.h:132
MBEDTLS_MODE_NONE
Definition: cipher.h:182
MBEDTLS_CIPHER_ARIA_192_GCM
Definition: cipher.h:166
MBEDTLS_CIPHER_ID_DES
Definition: cipher.h:87
MBEDTLS_CIPHER_AES_192_CFB128
Definition: cipher.h:113
mbedtls_cipher_info_t::key_bitlen
unsigned int key_bitlen
Definition: cipher.h:255
mbedtls_cipher_info_t::type
mbedtls_cipher_type_t type
Definition: cipher.h:246
mbedtls_cipher_info_from_type
const mbedtls_cipher_info_t * mbedtls_cipher_info_from_type(const mbedtls_cipher_type_t cipher_type)
This function retrieves the cipher-information structure associated with the given cipher type...
mbedtls_cipher_info_t::base
const mbedtls_cipher_base_t * base
Definition: cipher.h:276
MBEDTLS_CIPHER_ARIA_256_CCM
Definition: cipher.h:170
MBEDTLS_CIPHER_AES_256_CCM
Definition: cipher.h:149