Mbed TLS v3.5.0
cipher.h
Go to the documentation of this file.
1
10/*
11 * Copyright The Mbed TLS Contributors
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
27#ifndef MBEDTLS_CIPHER_H
28#define MBEDTLS_CIPHER_H
30
31#include "mbedtls/build_info.h"
32
33#include <stddef.h>
35
36#if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CCM_C) || defined(MBEDTLS_CHACHAPOLY_C)
37#define MBEDTLS_CIPHER_MODE_AEAD
38#endif
39
40#if defined(MBEDTLS_CIPHER_MODE_CBC)
41#define MBEDTLS_CIPHER_MODE_WITH_PADDING
42#endif
43
44#if defined(MBEDTLS_CIPHER_NULL_CIPHER) || \
45 defined(MBEDTLS_CHACHA20_C)
46#define MBEDTLS_CIPHER_MODE_STREAM
47#endif
48
50#define MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE -0x6080
52#define MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA -0x6100
54#define MBEDTLS_ERR_CIPHER_ALLOC_FAILED -0x6180
56#define MBEDTLS_ERR_CIPHER_INVALID_PADDING -0x6200
58#define MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED -0x6280
60#define MBEDTLS_ERR_CIPHER_AUTH_FAILED -0x6300
62#define MBEDTLS_ERR_CIPHER_INVALID_CONTEXT -0x6380
63
64#define MBEDTLS_CIPHER_VARIABLE_IV_LEN 0x01
65#define MBEDTLS_CIPHER_VARIABLE_KEY_LEN 0x02
67#ifdef __cplusplus
68extern "C" {
69#endif
70
78typedef enum {
88
96typedef enum {
182
184typedef enum {
200
202typedef enum {
209
211typedef enum {
216
217enum {
226};
227
229/* This should ideally be derived automatically from list of ciphers.
230 * This should be kept in sync with MBEDTLS_SSL_MAX_IV_LENGTH defined
231 * in library/ssl_misc.h. */
232#define MBEDTLS_MAX_IV_LENGTH 16
233
235/* This should ideally be derived automatically from list of ciphers.
236 * This should be kept in sync with MBEDTLS_SSL_MAX_BLOCK_LENGTH defined
237 * in library/ssl_misc.h. */
238#define MBEDTLS_MAX_BLOCK_LENGTH 16
239
241/* This should ideally be derived automatically from list of ciphers.
242 * For now, only check whether XTS is enabled which uses 64 Byte keys,
243 * and use 32 Bytes as an upper bound for the maximum key length otherwise.
244 * This should be kept in sync with MBEDTLS_SSL_MAX_BLOCK_LENGTH defined
245 * in library/ssl_misc.h, which however deliberately ignores the case of XTS
246 * since the latter isn't used in SSL/TLS. */
247#if defined(MBEDTLS_CIPHER_MODE_XTS)
248#define MBEDTLS_MAX_KEY_LENGTH 64
249#else
250#define MBEDTLS_MAX_KEY_LENGTH 32
251#endif /* MBEDTLS_CIPHER_MODE_XTS */
252
257
262
278typedef struct mbedtls_cipher_info_t {
280 const char *MBEDTLS_PRIVATE(name);
281
283 unsigned int MBEDTLS_PRIVATE(block_size) : 5;
284
289 unsigned int MBEDTLS_PRIVATE(iv_size) : 3;
290
295 unsigned int MBEDTLS_PRIVATE(key_bitlen) : 4;
296
300 unsigned int MBEDTLS_PRIVATE(mode) : 4;
301
308 unsigned int MBEDTLS_PRIVATE(type) : 8;
309
314 unsigned int MBEDTLS_PRIVATE(flags) : 2;
315
317 unsigned int MBEDTLS_PRIVATE(base_idx) : 5;
318
320
321/* For internal use only.
322 * These are used to more compactly represent the fields above. */
323#define MBEDTLS_KEY_BITLEN_SHIFT 6
324#define MBEDTLS_IV_SIZE_SHIFT 2
331
333 int MBEDTLS_PRIVATE(key_bitlen);
334
339
340#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
344 void(*MBEDTLS_PRIVATE(add_padding))(unsigned char *output, size_t olen, size_t data_len);
345 int(*MBEDTLS_PRIVATE(get_padding))(unsigned char *input, size_t ilen, size_t *data_len);
346#endif
347
349 unsigned char MBEDTLS_PRIVATE(unprocessed_data)[MBEDTLS_MAX_BLOCK_LENGTH];
350
352 size_t MBEDTLS_PRIVATE(unprocessed_len);
353
357
359 size_t MBEDTLS_PRIVATE(iv_size);
360
362 void *MBEDTLS_PRIVATE(cipher_ctx);
363
364#if defined(MBEDTLS_CMAC_C)
367#endif
368
369#if defined(MBEDTLS_USE_PSA_CRYPTO) && !defined(MBEDTLS_DEPRECATED_REMOVED)
377 unsigned char MBEDTLS_PRIVATE(psa_enabled);
378#endif /* MBEDTLS_USE_PSA_CRYPTO && !MBEDTLS_DEPRECATED_REMOVED */
379
381
395const int *mbedtls_cipher_list(void);
396
409
421
437 int key_bitlen,
438 const mbedtls_cipher_mode_t mode);
439
450 const mbedtls_cipher_info_t *info)
451{
452 if (info == NULL) {
453 return MBEDTLS_CIPHER_NONE;
454 } else {
455 return (mbedtls_cipher_type_t) info->MBEDTLS_PRIVATE(type);
456 }
457}
458
469 const mbedtls_cipher_info_t *info)
470{
471 if (info == NULL) {
472 return MBEDTLS_MODE_NONE;
473 } else {
474 return (mbedtls_cipher_mode_t) info->MBEDTLS_PRIVATE(mode);
475 }
476}
477
490 const mbedtls_cipher_info_t *info)
491{
492 if (info == NULL) {
493 return 0;
494 } else {
495 return info->MBEDTLS_PRIVATE(key_bitlen) << MBEDTLS_KEY_BITLEN_SHIFT;
496 }
497}
498
510static inline const char *mbedtls_cipher_info_get_name(
511 const mbedtls_cipher_info_t *info)
512{
513 if (info == NULL) {
514 return NULL;
515 } else {
516 return info->MBEDTLS_PRIVATE(name);
517 }
518}
519
531 const mbedtls_cipher_info_t *info)
532{
533 if (info == NULL) {
534 return 0;
535 }
536
537 return ((size_t) info->MBEDTLS_PRIVATE(iv_size)) << MBEDTLS_IV_SIZE_SHIFT;
538}
539
551 const mbedtls_cipher_info_t *info)
552{
553 if (info == NULL) {
554 return 0;
555 }
556
557 return (size_t) (info->MBEDTLS_PRIVATE(block_size));
558}
559
570 const mbedtls_cipher_info_t *info)
571{
572 if (info == NULL) {
573 return 0;
574 }
575
576 return info->MBEDTLS_PRIVATE(flags) & MBEDTLS_CIPHER_VARIABLE_KEY_LEN;
577}
578
589 const mbedtls_cipher_info_t *info)
590{
591 if (info == NULL) {
592 return 0;
593 }
594
595 return info->MBEDTLS_PRIVATE(flags) & MBEDTLS_CIPHER_VARIABLE_IV_LEN;
596}
597
604
615
616
644 const mbedtls_cipher_info_t *cipher_info);
645
646#if defined(MBEDTLS_USE_PSA_CRYPTO)
647#if !defined(MBEDTLS_DEPRECATED_REMOVED)
674int MBEDTLS_DEPRECATED mbedtls_cipher_setup_psa(mbedtls_cipher_context_t *ctx,
675 const mbedtls_cipher_info_t *cipher_info,
676 size_t taglen);
677#endif /* MBEDTLS_DEPRECATED_REMOVED */
678#endif /* MBEDTLS_USE_PSA_CRYPTO */
679
690static inline unsigned int mbedtls_cipher_get_block_size(
691 const mbedtls_cipher_context_t *ctx)
692{
693 MBEDTLS_INTERNAL_VALIDATE_RET(ctx != NULL, 0);
694 if (ctx->MBEDTLS_PRIVATE(cipher_info) == NULL) {
695 return 0;
696 }
697
698 return (unsigned int) ctx->MBEDTLS_PRIVATE(cipher_info)->MBEDTLS_PRIVATE(block_size);
699}
700
711 const mbedtls_cipher_context_t *ctx)
712{
714 if (ctx->MBEDTLS_PRIVATE(cipher_info) == NULL) {
715 return MBEDTLS_MODE_NONE;
716 }
717
718 return (mbedtls_cipher_mode_t) ctx->MBEDTLS_PRIVATE(cipher_info)->MBEDTLS_PRIVATE(mode);
719}
720
732 const mbedtls_cipher_context_t *ctx)
733{
734 MBEDTLS_INTERNAL_VALIDATE_RET(ctx != NULL, 0);
735 if (ctx->MBEDTLS_PRIVATE(cipher_info) == NULL) {
736 return 0;
737 }
738
739 if (ctx->MBEDTLS_PRIVATE(iv_size) != 0) {
740 return (int) ctx->MBEDTLS_PRIVATE(iv_size);
741 }
742
743 return (int) (((int) ctx->MBEDTLS_PRIVATE(cipher_info)->MBEDTLS_PRIVATE(iv_size)) <<
745}
746
756 const mbedtls_cipher_context_t *ctx)
757{
759 ctx != NULL, MBEDTLS_CIPHER_NONE);
760 if (ctx->MBEDTLS_PRIVATE(cipher_info) == NULL) {
761 return MBEDTLS_CIPHER_NONE;
762 }
763
764 return (mbedtls_cipher_type_t) ctx->MBEDTLS_PRIVATE(cipher_info)->MBEDTLS_PRIVATE(type);
765}
766
776static inline const char *mbedtls_cipher_get_name(
777 const mbedtls_cipher_context_t *ctx)
778{
779 MBEDTLS_INTERNAL_VALIDATE_RET(ctx != NULL, 0);
780 if (ctx->MBEDTLS_PRIVATE(cipher_info) == NULL) {
781 return 0;
782 }
783
784 return ctx->MBEDTLS_PRIVATE(cipher_info)->MBEDTLS_PRIVATE(name);
785}
786
797 const mbedtls_cipher_context_t *ctx)
798{
800 ctx != NULL, MBEDTLS_KEY_LENGTH_NONE);
801 if (ctx->MBEDTLS_PRIVATE(cipher_info) == NULL) {
803 }
804
805 return (int) ctx->MBEDTLS_PRIVATE(cipher_info)->MBEDTLS_PRIVATE(key_bitlen) <<
807}
808
818 const mbedtls_cipher_context_t *ctx)
819{
821 ctx != NULL, MBEDTLS_OPERATION_NONE);
822 if (ctx->MBEDTLS_PRIVATE(cipher_info) == NULL) {
824 }
825
826 return ctx->MBEDTLS_PRIVATE(operation);
827}
828
846 const unsigned char *key,
847 int key_bitlen,
848 const mbedtls_operation_t operation);
849
850#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
868#endif /* MBEDTLS_CIPHER_MODE_WITH_PADDING */
869
895 const unsigned char *iv,
896 size_t iv_len);
897
931
932#if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CHACHAPOLY_C)
946 const unsigned char *ad, size_t ad_len);
947#endif /* MBEDTLS_GCM_C || MBEDTLS_CHACHAPOLY_C */
948
979 const unsigned char *input,
980 size_t ilen, unsigned char *output,
981 size_t *olen);
982
1006 unsigned char *output, size_t *olen);
1007
1008#if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CHACHAPOLY_C)
1026 unsigned char *tag, size_t tag_len);
1027
1042 const unsigned char *tag, size_t tag_len);
1043#endif /* MBEDTLS_GCM_C || MBEDTLS_CHACHAPOLY_C */
1044
1079 const unsigned char *iv, size_t iv_len,
1080 const unsigned char *input, size_t ilen,
1081 unsigned char *output, size_t *olen);
1082
1083#if defined(MBEDTLS_CIPHER_MODE_AEAD) || defined(MBEDTLS_NIST_KW_C)
1129 const unsigned char *iv, size_t iv_len,
1130 const unsigned char *ad, size_t ad_len,
1131 const unsigned char *input, size_t ilen,
1132 unsigned char *output, size_t output_len,
1133 size_t *olen, size_t tag_len);
1134
1185 const unsigned char *iv, size_t iv_len,
1186 const unsigned char *ad, size_t ad_len,
1187 const unsigned char *input, size_t ilen,
1188 unsigned char *output, size_t output_len,
1189 size_t *olen, size_t tag_len);
1190#endif /* MBEDTLS_CIPHER_MODE_AEAD || MBEDTLS_NIST_KW_C */
1191#ifdef __cplusplus
1192}
1193#endif
1194
1195#endif /* MBEDTLS_CIPHER_H */
int mbedtls_cipher_setup(mbedtls_cipher_context_t *ctx, const mbedtls_cipher_info_t *cipher_info)
This function prepares a cipher context for use with the given cipher primitive.
mbedtls_cipher_type_t
Supported {cipher type, cipher mode} pairs.
Definition: cipher.h:96
@ MBEDTLS_CIPHER_AES_128_ECB
Definition: cipher.h:99
@ MBEDTLS_CIPHER_ARIA_256_CTR
Definition: cipher.h:158
@ MBEDTLS_CIPHER_CAMELLIA_128_GCM
Definition: cipher.h:126
@ MBEDTLS_CIPHER_AES_128_XTS
Definition: cipher.h:171
@ MBEDTLS_CIPHER_CAMELLIA_128_CCM_STAR_NO_TAG
Definition: cipher.h:144
@ MBEDTLS_CIPHER_CHACHA20
Definition: cipher.h:173
@ MBEDTLS_CIPHER_DES_EDE3_CBC
Definition: cipher.h:134
@ MBEDTLS_CIPHER_DES_ECB
Definition: cipher.h:129
@ MBEDTLS_CIPHER_ARIA_128_GCM
Definition: cipher.h:159
@ MBEDTLS_CIPHER_AES_128_CCM_STAR_NO_TAG
Definition: cipher.h:138
@ MBEDTLS_CIPHER_AES_128_CBC
Definition: cipher.h:102
@ MBEDTLS_CIPHER_AES_192_GCM
Definition: cipher.h:112
@ MBEDTLS_CIPHER_AES_128_OFB
Definition: cipher.h:168
@ MBEDTLS_CIPHER_ARIA_192_ECB
Definition: cipher.h:148
@ MBEDTLS_CIPHER_CAMELLIA_256_GCM
Definition: cipher.h:128
@ MBEDTLS_CIPHER_DES_EDE_ECB
Definition: cipher.h:131
@ MBEDTLS_CIPHER_AES_192_CCM_STAR_NO_TAG
Definition: cipher.h:139
@ MBEDTLS_CIPHER_ARIA_256_CFB128
Definition: cipher.h:155
@ MBEDTLS_CIPHER_ARIA_192_CBC
Definition: cipher.h:151
@ MBEDTLS_CIPHER_CAMELLIA_192_CBC
Definition: cipher.h:118
@ MBEDTLS_CIPHER_ARIA_128_CTR
Definition: cipher.h:156
@ MBEDTLS_CIPHER_ARIA_192_CCM
Definition: cipher.h:163
@ MBEDTLS_CIPHER_CAMELLIA_192_GCM
Definition: cipher.h:127
@ MBEDTLS_CIPHER_AES_192_OFB
Definition: cipher.h:169
@ MBEDTLS_CIPHER_AES_256_CCM_STAR_NO_TAG
Definition: cipher.h:140
@ MBEDTLS_CIPHER_AES_256_ECB
Definition: cipher.h:101
@ MBEDTLS_CIPHER_AES_256_CTR
Definition: cipher.h:110
@ MBEDTLS_CIPHER_AES_192_CCM
Definition: cipher.h:136
@ MBEDTLS_CIPHER_AES_128_CFB128
Definition: cipher.h:105
@ MBEDTLS_CIPHER_CAMELLIA_192_CFB128
Definition: cipher.h:121
@ MBEDTLS_CIPHER_CAMELLIA_128_CCM
Definition: cipher.h:141
@ MBEDTLS_CIPHER_AES_128_CTR
Definition: cipher.h:108
@ MBEDTLS_CIPHER_ARIA_192_GCM
Definition: cipher.h:160
@ MBEDTLS_CIPHER_AES_256_XTS
Definition: cipher.h:172
@ MBEDTLS_CIPHER_AES_192_CFB128
Definition: cipher.h:106
@ MBEDTLS_CIPHER_ARIA_256_ECB
Definition: cipher.h:149
@ MBEDTLS_CIPHER_CAMELLIA_256_CCM
Definition: cipher.h:143
@ MBEDTLS_CIPHER_AES_256_GCM
Definition: cipher.h:113
@ MBEDTLS_CIPHER_DES_CBC
Definition: cipher.h:130
@ MBEDTLS_CIPHER_CAMELLIA_128_CFB128
Definition: cipher.h:120
@ MBEDTLS_CIPHER_CAMELLIA_128_CBC
Definition: cipher.h:117
@ MBEDTLS_CIPHER_AES_256_CCM
Definition: cipher.h:137
@ MBEDTLS_CIPHER_CAMELLIA_256_CFB128
Definition: cipher.h:122
@ MBEDTLS_CIPHER_CAMELLIA_256_CCM_STAR_NO_TAG
Definition: cipher.h:146
@ MBEDTLS_CIPHER_CAMELLIA_192_CCM_STAR_NO_TAG
Definition: cipher.h:145
@ MBEDTLS_CIPHER_ARIA_192_CTR
Definition: cipher.h:157
@ MBEDTLS_CIPHER_ARIA_192_CCM_STAR_NO_TAG
Definition: cipher.h:166
@ MBEDTLS_CIPHER_CAMELLIA_256_ECB
Definition: cipher.h:116
@ MBEDTLS_CIPHER_AES_256_KW
Definition: cipher.h:177
@ MBEDTLS_CIPHER_AES_128_GCM
Definition: cipher.h:111
@ MBEDTLS_CIPHER_CAMELLIA_192_ECB
Definition: cipher.h:115
@ MBEDTLS_CIPHER_ARIA_256_CCM_STAR_NO_TAG
Definition: cipher.h:167
@ MBEDTLS_CIPHER_AES_256_CFB128
Definition: cipher.h:107
@ MBEDTLS_CIPHER_NONE
Definition: cipher.h:97
@ MBEDTLS_CIPHER_CHACHA20_POLY1305
Definition: cipher.h:174
@ MBEDTLS_CIPHER_CAMELLIA_128_ECB
Definition: cipher.h:114
@ MBEDTLS_CIPHER_AES_192_CBC
Definition: cipher.h:103
@ MBEDTLS_CIPHER_CAMELLIA_192_CCM
Definition: cipher.h:142
@ MBEDTLS_CIPHER_ARIA_128_CCM
Definition: cipher.h:162
@ MBEDTLS_CIPHER_AES_192_CTR
Definition: cipher.h:109
@ MBEDTLS_CIPHER_AES_128_CCM
Definition: cipher.h:135
@ MBEDTLS_CIPHER_DES_EDE_CBC
Definition: cipher.h:132
@ MBEDTLS_CIPHER_NULL
Definition: cipher.h:98
@ MBEDTLS_CIPHER_ARIA_256_CBC
Definition: cipher.h:152
@ MBEDTLS_CIPHER_AES_256_OFB
Definition: cipher.h:170
@ MBEDTLS_CIPHER_ARIA_192_CFB128
Definition: cipher.h:154
@ MBEDTLS_CIPHER_CAMELLIA_128_CTR
Definition: cipher.h:123
@ MBEDTLS_CIPHER_AES_256_KWP
Definition: cipher.h:180
@ MBEDTLS_CIPHER_AES_256_CBC
Definition: cipher.h:104
@ MBEDTLS_CIPHER_CAMELLIA_192_CTR
Definition: cipher.h:124
@ MBEDTLS_CIPHER_AES_128_KW
Definition: cipher.h:175
@ MBEDTLS_CIPHER_AES_192_KW
Definition: cipher.h:176
@ MBEDTLS_CIPHER_AES_192_KWP
Definition: cipher.h:179
@ MBEDTLS_CIPHER_AES_192_ECB
Definition: cipher.h:100
@ MBEDTLS_CIPHER_ARIA_256_GCM
Definition: cipher.h:161
@ MBEDTLS_CIPHER_AES_128_KWP
Definition: cipher.h:178
@ MBEDTLS_CIPHER_DES_EDE3_ECB
Definition: cipher.h:133
@ MBEDTLS_CIPHER_ARIA_128_CCM_STAR_NO_TAG
Definition: cipher.h:165
@ MBEDTLS_CIPHER_ARIA_128_CBC
Definition: cipher.h:150
@ MBEDTLS_CIPHER_CAMELLIA_256_CTR
Definition: cipher.h:125
@ MBEDTLS_CIPHER_ARIA_128_ECB
Definition: cipher.h:147
@ MBEDTLS_CIPHER_CAMELLIA_256_CBC
Definition: cipher.h:119
@ MBEDTLS_CIPHER_ARIA_256_CCM
Definition: cipher.h:164
@ MBEDTLS_CIPHER_ARIA_128_CFB128
Definition: cipher.h:153
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.
#define MBEDTLS_IV_SIZE_SHIFT
Definition: cipher.h:324
static size_t mbedtls_cipher_info_get_iv_size(const mbedtls_cipher_info_t *info)
This function returns the size of the IV or nonce for the cipher info structure, in bytes.
Definition: cipher.h:530
@ MBEDTLS_KEY_LENGTH_DES
Definition: cipher.h:221
@ MBEDTLS_KEY_LENGTH_NONE
Definition: cipher.h:219
@ MBEDTLS_KEY_LENGTH_DES_EDE
Definition: cipher.h:223
@ MBEDTLS_KEY_LENGTH_DES_EDE3
Definition: cipher.h:225
struct mbedtls_cipher_info_t mbedtls_cipher_info_t
#define MBEDTLS_KEY_BITLEN_SHIFT
Definition: cipher.h:323
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.
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.
int mbedtls_cipher_reset(mbedtls_cipher_context_t *ctx)
This function resets the cipher state.
static mbedtls_cipher_mode_t mbedtls_cipher_info_get_mode(const mbedtls_cipher_info_t *info)
Retrieve the operation mode for a cipher info structure.
Definition: cipher.h:468
static size_t mbedtls_cipher_info_get_block_size(const mbedtls_cipher_info_t *info)
This function returns the block size of the given cipher info structure in bytes.
Definition: cipher.h:550
int mbedtls_cipher_auth_decrypt_ext(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 output_len, size_t *olen, size_t tag_len)
The authenticated encryption (AEAD/NIST_KW) function.
#define MBEDTLS_CIPHER_VARIABLE_IV_LEN
Definition: cipher.h:64
static int mbedtls_cipher_info_has_variable_iv_size(const mbedtls_cipher_info_t *info)
This function returns a non-zero value if the IV size for the given cipher is variable.
Definition: cipher.h:588
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_padding_t
Definition: cipher.h:202
@ MBEDTLS_PADDING_ZEROS
Definition: cipher.h:206
@ MBEDTLS_PADDING_ONE_AND_ZEROS
Definition: cipher.h:204
@ MBEDTLS_PADDING_PKCS7
Definition: cipher.h:203
@ MBEDTLS_PADDING_ZEROS_AND_LEN
Definition: cipher.h:205
@ MBEDTLS_PADDING_NONE
Definition: cipher.h:207
int mbedtls_cipher_auth_encrypt_ext(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 output_len, size_t *olen, size_t tag_len)
The authenticated encryption (AEAD/NIST_KW) function.
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,...
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:796
struct mbedtls_cipher_context_t mbedtls_cipher_context_t
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,...
void mbedtls_cipher_init(mbedtls_cipher_context_t *ctx)
This function initializes a ctx as NONE.
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...
#define MBEDTLS_CIPHER_VARIABLE_KEY_LEN
Definition: cipher.h:65
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....
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:817
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...
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:731
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....
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:755
static unsigned int mbedtls_cipher_get_block_size(const mbedtls_cipher_context_t *ctx)
This function returns the block size of the given cipher in bytes.
Definition: cipher.h:690
static const char * mbedtls_cipher_info_get_name(const mbedtls_cipher_info_t *info)
Retrieve the human-readable name for a cipher info structure.
Definition: cipher.h:510
struct mbedtls_cipher_base_t mbedtls_cipher_base_t
Definition: cipher.h:256
mbedtls_operation_t
Definition: cipher.h:211
@ MBEDTLS_DECRYPT
Definition: cipher.h:213
@ MBEDTLS_OPERATION_NONE
Definition: cipher.h:212
@ MBEDTLS_ENCRYPT
Definition: cipher.h:214
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.
const int * mbedtls_cipher_list(void)
This function retrieves the list of ciphers supported by the generic cipher module.
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:776
#define MBEDTLS_MAX_BLOCK_LENGTH
Definition: cipher.h:238
static int mbedtls_cipher_info_has_variable_key_bitlen(const mbedtls_cipher_info_t *info)
This function returns a non-zero value if the key length for the given cipher is variable.
Definition: cipher.h:569
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....
static mbedtls_cipher_type_t mbedtls_cipher_info_get_type(const mbedtls_cipher_info_t *info)
Retrieve the identifier for a cipher info structure.
Definition: cipher.h:449
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:710
mbedtls_cipher_mode_t
Definition: cipher.h:184
@ MBEDTLS_MODE_ECB
Definition: cipher.h:186
@ MBEDTLS_MODE_CCM
Definition: cipher.h:193
@ MBEDTLS_MODE_STREAM
Definition: cipher.h:192
@ MBEDTLS_MODE_NONE
Definition: cipher.h:185
@ MBEDTLS_MODE_CFB
Definition: cipher.h:188
@ MBEDTLS_MODE_CTR
Definition: cipher.h:190
@ MBEDTLS_MODE_GCM
Definition: cipher.h:191
@ MBEDTLS_MODE_CCM_STAR_NO_TAG
Definition: cipher.h:194
@ MBEDTLS_MODE_KW
Definition: cipher.h:197
@ MBEDTLS_MODE_CBC
Definition: cipher.h:187
@ MBEDTLS_MODE_OFB
Definition: cipher.h:189
@ MBEDTLS_MODE_KWP
Definition: cipher.h:198
@ MBEDTLS_MODE_CHACHAPOLY
Definition: cipher.h:196
@ MBEDTLS_MODE_XTS
Definition: cipher.h:195
#define MBEDTLS_MAX_IV_LENGTH
Definition: cipher.h:232
mbedtls_cipher_id_t
Supported cipher types.
Definition: cipher.h:78
@ MBEDTLS_CIPHER_ID_3DES
Definition: cipher.h:83
@ MBEDTLS_CIPHER_ID_CAMELLIA
Definition: cipher.h:84
@ MBEDTLS_CIPHER_ID_DES
Definition: cipher.h:82
@ MBEDTLS_CIPHER_ID_NULL
Definition: cipher.h:80
@ MBEDTLS_CIPHER_ID_AES
Definition: cipher.h:81
@ MBEDTLS_CIPHER_ID_ARIA
Definition: cipher.h:85
@ MBEDTLS_CIPHER_ID_NONE
Definition: cipher.h:79
@ MBEDTLS_CIPHER_ID_CHACHA20
Definition: cipher.h:86
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.
static size_t mbedtls_cipher_info_get_key_bitlen(const mbedtls_cipher_info_t *info)
Retrieve the key size for a cipher info structure.
Definition: cipher.h:489
Build-time configuration info.
Common and shared functions used by multiple modules in the Mbed TLS library.
#define MBEDTLS_INTERNAL_VALIDATE_RET(cond, ret)
Definition: platform_util.h:39
#define MBEDTLS_DEPRECATED
Definition: platform_util.h:45
Macro wrapper for struct's members.
#define MBEDTLS_PRIVATE(member)