mbed TLS v2.28.3
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
29 
30 #if !defined(MBEDTLS_CONFIG_FILE)
31 #include "mbedtls/config.h"
32 #else
33 #include MBEDTLS_CONFIG_FILE
34 #endif
35 
36 #include <stddef.h>
37 #include "mbedtls/platform_util.h"
38 
39 #if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CCM_C) || defined(MBEDTLS_CHACHAPOLY_C)
40 #define MBEDTLS_CIPHER_MODE_AEAD
41 #endif
42 
43 #if defined(MBEDTLS_CIPHER_MODE_CBC)
44 #define MBEDTLS_CIPHER_MODE_WITH_PADDING
45 #endif
46 
47 #if defined(MBEDTLS_ARC4_C) || defined(MBEDTLS_CIPHER_NULL_CIPHER) || \
48  defined(MBEDTLS_CHACHA20_C)
49 #define MBEDTLS_CIPHER_MODE_STREAM
50 #endif
51 
52 #if (defined(__ARMCC_VERSION) || defined(_MSC_VER)) && \
53  !defined(inline) && !defined(__cplusplus)
54 #define inline __inline
55 #endif
56 
58 #define MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE -0x6080
60 #define MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA -0x6100
62 #define MBEDTLS_ERR_CIPHER_ALLOC_FAILED -0x6180
64 #define MBEDTLS_ERR_CIPHER_INVALID_PADDING -0x6200
66 #define MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED -0x6280
68 #define MBEDTLS_ERR_CIPHER_AUTH_FAILED -0x6300
70 #define MBEDTLS_ERR_CIPHER_INVALID_CONTEXT -0x6380
71 
72 /* MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED is deprecated and should not be used. */
74 #define MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED -0x6400
75 
76 #define MBEDTLS_CIPHER_VARIABLE_IV_LEN 0x01
77 #define MBEDTLS_CIPHER_VARIABLE_KEY_LEN 0x02
79 #ifdef __cplusplus
80 extern "C" {
81 #endif
82 
90 typedef enum {
102 
110 typedef enum {
192 
194 typedef enum {
209 
211 typedef enum {
218 
220 typedef enum {
225 
226 enum {
235 };
236 
238 /* This should ideally be derived automatically from list of ciphers.
239  * This should be kept in sync with MBEDTLS_SSL_MAX_IV_LENGTH defined
240  * in ssl_internal.h. */
241 #define MBEDTLS_MAX_IV_LENGTH 16
242 
244 /* This should ideally be derived automatically from list of ciphers.
245  * This should be kept in sync with MBEDTLS_SSL_MAX_BLOCK_LENGTH defined
246  * in ssl_internal.h. */
247 #define MBEDTLS_MAX_BLOCK_LENGTH 16
248 
250 /* This should ideally be derived automatically from list of ciphers.
251  * For now, only check whether XTS is enabled which uses 64 Byte keys,
252  * and use 32 Bytes as an upper bound for the maximum key length otherwise.
253  * This should be kept in sync with MBEDTLS_SSL_MAX_BLOCK_LENGTH defined
254  * in ssl_internal.h, which however deliberately ignores the case of XTS
255  * since the latter isn't used in SSL/TLS. */
256 #if defined(MBEDTLS_CIPHER_MODE_XTS)
257 #define MBEDTLS_MAX_KEY_LENGTH 64
258 #else
259 #define MBEDTLS_MAX_KEY_LENGTH 32
260 #endif /* MBEDTLS_CIPHER_MODE_XTS */
261 
266 
271 
276 typedef struct mbedtls_cipher_info_t {
281 
284 
289  unsigned int key_bitlen;
290 
292  const char *name;
293 
298  unsigned int iv_size;
299 
304  int flags;
305 
307  unsigned int block_size;
308 
311 
313 
317 typedef struct mbedtls_cipher_context_t {
320 
323 
328 
329 #if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
333  void (*add_padding)(unsigned char *output, size_t olen, size_t data_len);
334  int (*get_padding)(unsigned char *input, size_t ilen, size_t *data_len);
335 #endif
336 
339 
342 
345  unsigned char iv[MBEDTLS_MAX_IV_LENGTH];
346 
348  size_t iv_size;
349 
351  void *cipher_ctx;
352 
353 #if defined(MBEDTLS_CMAC_C)
355  mbedtls_cmac_context_t *cmac_ctx;
356 #endif
357 
358 #if defined(MBEDTLS_USE_PSA_CRYPTO)
366  unsigned char psa_enabled;
367 #endif /* MBEDTLS_USE_PSA_CRYPTO */
368 
370 
384 const int *mbedtls_cipher_list(void);
385 
398 
410 
426  int key_bitlen,
427  const mbedtls_cipher_mode_t mode);
428 
435 
446 
447 
466  const mbedtls_cipher_info_t *cipher_info);
467 
468 #if defined(MBEDTLS_USE_PSA_CRYPTO)
490 int mbedtls_cipher_setup_psa(mbedtls_cipher_context_t *ctx,
491  const mbedtls_cipher_info_t *cipher_info,
492  size_t taglen);
493 #endif /* MBEDTLS_USE_PSA_CRYPTO */
494 
503 static inline unsigned int mbedtls_cipher_get_block_size(
504  const mbedtls_cipher_context_t *ctx)
505 {
506  MBEDTLS_INTERNAL_VALIDATE_RET(ctx != NULL, 0);
507  if (ctx->cipher_info == NULL) {
508  return 0;
509  }
510 
511  return ctx->cipher_info->block_size;
512 }
513 
524  const mbedtls_cipher_context_t *ctx)
525 {
527  if (ctx->cipher_info == NULL) {
528  return MBEDTLS_MODE_NONE;
529  }
530 
531  return ctx->cipher_info->mode;
532 }
533 
544 static inline int mbedtls_cipher_get_iv_size(
545  const mbedtls_cipher_context_t *ctx)
546 {
547  MBEDTLS_INTERNAL_VALIDATE_RET(ctx != NULL, 0);
548  if (ctx->cipher_info == NULL) {
549  return 0;
550  }
551 
552  if (ctx->iv_size != 0) {
553  return (int) ctx->iv_size;
554  }
555 
556  return (int) ctx->cipher_info->iv_size;
557 }
558 
568  const mbedtls_cipher_context_t *ctx)
569 {
571  ctx != NULL, MBEDTLS_CIPHER_NONE);
572  if (ctx->cipher_info == NULL) {
573  return MBEDTLS_CIPHER_NONE;
574  }
575 
576  return ctx->cipher_info->type;
577 }
578 
588 static inline const char *mbedtls_cipher_get_name(
589  const mbedtls_cipher_context_t *ctx)
590 {
591  MBEDTLS_INTERNAL_VALIDATE_RET(ctx != NULL, 0);
592  if (ctx->cipher_info == NULL) {
593  return 0;
594  }
595 
596  return ctx->cipher_info->name;
597 }
598 
609  const mbedtls_cipher_context_t *ctx)
610 {
612  ctx != NULL, MBEDTLS_KEY_LENGTH_NONE);
613  if (ctx->cipher_info == NULL) {
615  }
616 
617  return (int) ctx->cipher_info->key_bitlen;
618 }
619 
629  const mbedtls_cipher_context_t *ctx)
630 {
632  ctx != NULL, MBEDTLS_OPERATION_NONE);
633  if (ctx->cipher_info == NULL) {
634  return MBEDTLS_OPERATION_NONE;
635  }
636 
637  return ctx->operation;
638 }
639 
657  const unsigned char *key,
658  int key_bitlen,
659  const mbedtls_operation_t operation);
660 
661 #if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
680 #endif /* MBEDTLS_CIPHER_MODE_WITH_PADDING */
681 
701  const unsigned char *iv,
702  size_t iv_len);
703 
714 
715 #if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CHACHAPOLY_C)
731  const unsigned char *ad, size_t ad_len);
732 #endif /* MBEDTLS_GCM_C || MBEDTLS_CHACHAPOLY_C */
733 
769  const unsigned char *input,
770  size_t ilen, unsigned char *output,
771  size_t *olen);
772 
796  unsigned char *output, size_t *olen);
797 
798 #if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CHACHAPOLY_C)
816  unsigned char *tag, size_t tag_len);
817 
832  const unsigned char *tag, size_t tag_len);
833 #endif /* MBEDTLS_GCM_C || MBEDTLS_CHACHAPOLY_C */
834 
869  const unsigned char *iv, size_t iv_len,
870  const unsigned char *input, size_t ilen,
871  unsigned char *output, size_t *olen);
872 
873 #if defined(MBEDTLS_CIPHER_MODE_AEAD)
874 #if !defined(MBEDTLS_DEPRECATED_REMOVED)
875 #if defined(MBEDTLS_DEPRECATED_WARNING)
876 #define MBEDTLS_DEPRECATED __attribute__((deprecated))
877 #else
878 #define MBEDTLS_DEPRECATED
879 #endif /* MBEDTLS_DEPRECATED_WARNING */
928  const unsigned char *iv, size_t iv_len,
929  const unsigned char *ad, size_t ad_len,
930  const unsigned char *input, size_t ilen,
931  unsigned char *output, size_t *olen,
932  unsigned char *tag, size_t tag_len);
933 
987  const unsigned char *iv, size_t iv_len,
988  const unsigned char *ad, size_t ad_len,
989  const unsigned char *input, size_t ilen,
990  unsigned char *output, size_t *olen,
991  const unsigned char *tag, size_t tag_len);
992 #undef MBEDTLS_DEPRECATED
993 #endif /* MBEDTLS_DEPRECATED_REMOVED */
994 #endif /* MBEDTLS_CIPHER_MODE_AEAD */
995 
996 #if defined(MBEDTLS_CIPHER_MODE_AEAD) || defined(MBEDTLS_NIST_KW_C)
1042  const unsigned char *iv, size_t iv_len,
1043  const unsigned char *ad, size_t ad_len,
1044  const unsigned char *input, size_t ilen,
1045  unsigned char *output, size_t output_len,
1046  size_t *olen, size_t tag_len);
1047 
1098  const unsigned char *iv, size_t iv_len,
1099  const unsigned char *ad, size_t ad_len,
1100  const unsigned char *input, size_t ilen,
1101  unsigned char *output, size_t output_len,
1102  size_t *olen, size_t tag_len);
1103 #endif /* MBEDTLS_CIPHER_MODE_AEAD || MBEDTLS_NIST_KW_C */
1104 #ifdef __cplusplus
1105 }
1106 #endif
1107 
1108 #endif /* MBEDTLS_CIPHER_H */
int mbedtls_cipher_setup(mbedtls_cipher_context_t *ctx, const mbedtls_cipher_info_t *cipher_info)
This function initializes a cipher context for use with the given cipher primitive.
mbedtls_cipher_type_t
Supported {cipher type, cipher mode} pairs.
Definition: cipher.h:110
@ MBEDTLS_CIPHER_AES_128_ECB
Definition: cipher.h:113
@ MBEDTLS_CIPHER_ARIA_256_CTR
Definition: cipher.h:171
@ MBEDTLS_CIPHER_CAMELLIA_128_GCM
Definition: cipher.h:140
@ MBEDTLS_CIPHER_AES_128_XTS
Definition: cipher.h:181
@ MBEDTLS_CIPHER_CHACHA20
Definition: cipher.h:183
@ MBEDTLS_CIPHER_DES_EDE3_CBC
Definition: cipher.h:148
@ MBEDTLS_CIPHER_DES_ECB
Definition: cipher.h:143
@ MBEDTLS_CIPHER_ARIA_128_GCM
Definition: cipher.h:172
@ MBEDTLS_CIPHER_AES_128_CBC
Definition: cipher.h:116
@ MBEDTLS_CIPHER_AES_192_GCM
Definition: cipher.h:126
@ MBEDTLS_CIPHER_BLOWFISH_CTR
Definition: cipher.h:152
@ MBEDTLS_CIPHER_AES_128_OFB
Definition: cipher.h:178
@ MBEDTLS_CIPHER_ARIA_192_ECB
Definition: cipher.h:161
@ MBEDTLS_CIPHER_CAMELLIA_256_GCM
Definition: cipher.h:142
@ MBEDTLS_CIPHER_DES_EDE_ECB
Definition: cipher.h:145
@ MBEDTLS_CIPHER_BLOWFISH_CFB64
Definition: cipher.h:151
@ MBEDTLS_CIPHER_ARIA_256_CFB128
Definition: cipher.h:168
@ MBEDTLS_CIPHER_ARIA_192_CBC
Definition: cipher.h:164
@ MBEDTLS_CIPHER_CAMELLIA_192_CBC
Definition: cipher.h:132
@ MBEDTLS_CIPHER_ARIA_128_CTR
Definition: cipher.h:169
@ MBEDTLS_CIPHER_ARIA_192_CCM
Definition: cipher.h:176
@ MBEDTLS_CIPHER_CAMELLIA_192_GCM
Definition: cipher.h:141
@ MBEDTLS_CIPHER_AES_192_OFB
Definition: cipher.h:179
@ MBEDTLS_CIPHER_AES_256_ECB
Definition: cipher.h:115
@ MBEDTLS_CIPHER_AES_256_CTR
Definition: cipher.h:124
@ MBEDTLS_CIPHER_AES_192_CCM
Definition: cipher.h:155
@ MBEDTLS_CIPHER_AES_128_CFB128
Definition: cipher.h:119
@ MBEDTLS_CIPHER_CAMELLIA_192_CFB128
Definition: cipher.h:135
@ MBEDTLS_CIPHER_CAMELLIA_128_CCM
Definition: cipher.h:157
@ MBEDTLS_CIPHER_AES_128_CTR
Definition: cipher.h:122
@ MBEDTLS_CIPHER_ARIA_192_GCM
Definition: cipher.h:173
@ MBEDTLS_CIPHER_AES_256_XTS
Definition: cipher.h:182
@ MBEDTLS_CIPHER_AES_192_CFB128
Definition: cipher.h:120
@ MBEDTLS_CIPHER_ARIA_256_ECB
Definition: cipher.h:162
@ MBEDTLS_CIPHER_CAMELLIA_256_CCM
Definition: cipher.h:159
@ MBEDTLS_CIPHER_AES_256_GCM
Definition: cipher.h:127
@ MBEDTLS_CIPHER_DES_CBC
Definition: cipher.h:144
@ MBEDTLS_CIPHER_CAMELLIA_128_CFB128
Definition: cipher.h:134
@ MBEDTLS_CIPHER_CAMELLIA_128_CBC
Definition: cipher.h:131
@ MBEDTLS_CIPHER_AES_256_CCM
Definition: cipher.h:156
@ MBEDTLS_CIPHER_CAMELLIA_256_CFB128
Definition: cipher.h:136
@ MBEDTLS_CIPHER_ARIA_192_CTR
Definition: cipher.h:170
@ MBEDTLS_CIPHER_BLOWFISH_CBC
Definition: cipher.h:150
@ MBEDTLS_CIPHER_CAMELLIA_256_ECB
Definition: cipher.h:130
@ MBEDTLS_CIPHER_AES_256_KW
Definition: cipher.h:187
@ MBEDTLS_CIPHER_AES_128_GCM
Definition: cipher.h:125
@ MBEDTLS_CIPHER_CAMELLIA_192_ECB
Definition: cipher.h:129
@ MBEDTLS_CIPHER_AES_256_CFB128
Definition: cipher.h:121
@ MBEDTLS_CIPHER_NONE
Definition: cipher.h:111
@ MBEDTLS_CIPHER_CHACHA20_POLY1305
Definition: cipher.h:184
@ MBEDTLS_CIPHER_CAMELLIA_128_ECB
Definition: cipher.h:128
@ MBEDTLS_CIPHER_AES_192_CBC
Definition: cipher.h:117
@ MBEDTLS_CIPHER_CAMELLIA_192_CCM
Definition: cipher.h:158
@ MBEDTLS_CIPHER_ARIA_128_CCM
Definition: cipher.h:175
@ MBEDTLS_CIPHER_AES_192_CTR
Definition: cipher.h:123
@ MBEDTLS_CIPHER_AES_128_CCM
Definition: cipher.h:154
@ MBEDTLS_CIPHER_DES_EDE_CBC
Definition: cipher.h:146
@ MBEDTLS_CIPHER_NULL
Definition: cipher.h:112
@ MBEDTLS_CIPHER_ARIA_256_CBC
Definition: cipher.h:165
@ MBEDTLS_CIPHER_AES_256_OFB
Definition: cipher.h:180
@ MBEDTLS_CIPHER_ARIA_192_CFB128
Definition: cipher.h:167
@ MBEDTLS_CIPHER_CAMELLIA_128_CTR
Definition: cipher.h:137
@ MBEDTLS_CIPHER_BLOWFISH_ECB
Definition: cipher.h:149
@ MBEDTLS_CIPHER_AES_256_KWP
Definition: cipher.h:190
@ MBEDTLS_CIPHER_AES_256_CBC
Definition: cipher.h:118
@ MBEDTLS_CIPHER_ARC4_128
Definition: cipher.h:153
@ MBEDTLS_CIPHER_CAMELLIA_192_CTR
Definition: cipher.h:138
@ MBEDTLS_CIPHER_AES_128_KW
Definition: cipher.h:185
@ MBEDTLS_CIPHER_AES_192_KW
Definition: cipher.h:186
@ MBEDTLS_CIPHER_AES_192_KWP
Definition: cipher.h:189
@ MBEDTLS_CIPHER_AES_192_ECB
Definition: cipher.h:114
@ MBEDTLS_CIPHER_ARIA_256_GCM
Definition: cipher.h:174
@ MBEDTLS_CIPHER_AES_128_KWP
Definition: cipher.h:188
@ MBEDTLS_CIPHER_DES_EDE3_ECB
Definition: cipher.h:147
@ MBEDTLS_CIPHER_ARIA_128_CBC
Definition: cipher.h:163
@ MBEDTLS_CIPHER_CAMELLIA_256_CTR
Definition: cipher.h:139
@ MBEDTLS_CIPHER_ARIA_128_ECB
Definition: cipher.h:160
@ MBEDTLS_CIPHER_CAMELLIA_256_CBC
Definition: cipher.h:133
@ MBEDTLS_CIPHER_ARIA_256_CCM
Definition: cipher.h:177
@ MBEDTLS_CIPHER_ARIA_128_CFB128
Definition: cipher.h:166
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_KEY_LENGTH_DES
Definition: cipher.h:230
@ MBEDTLS_KEY_LENGTH_NONE
Definition: cipher.h:228
@ MBEDTLS_KEY_LENGTH_DES_EDE
Definition: cipher.h:232
@ MBEDTLS_KEY_LENGTH_DES_EDE3
Definition: cipher.h:234
struct mbedtls_cipher_info_t mbedtls_cipher_info_t
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.
int mbedtls_cipher_reset(mbedtls_cipher_context_t *ctx)
This function resets the cipher state.
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.
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:211
@ MBEDTLS_PADDING_ZEROS
Definition: cipher.h:215
@ MBEDTLS_PADDING_ONE_AND_ZEROS
Definition: cipher.h:213
@ MBEDTLS_PADDING_PKCS7
Definition: cipher.h:212
@ MBEDTLS_PADDING_ZEROS_AND_LEN
Definition: cipher.h:214
@ MBEDTLS_PADDING_NONE
Definition: cipher.h:216
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:608
const int * mbedtls_cipher_list(void)
This function retrieves the list of ciphers supported by the generic cipher module.
struct mbedtls_cipher_context_t mbedtls_cipher_context_t
void mbedtls_cipher_init(mbedtls_cipher_context_t *ctx)
This function initializes a cipher_context as NONE.
int MBEDTLS_DEPRECATED 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 authenticated decryption (AEAD) function.
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...
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:628
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.
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:544
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....
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,...
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.
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:567
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:503
struct mbedtls_cipher_base_t mbedtls_cipher_base_t
Definition: cipher.h:265
#define MBEDTLS_DEPRECATED
Definition: cipher.h:878
mbedtls_operation_t
Definition: cipher.h:220
@ MBEDTLS_DECRYPT
Definition: cipher.h:222
@ MBEDTLS_OPERATION_NONE
Definition: cipher.h:221
@ MBEDTLS_ENCRYPT
Definition: cipher.h:223
#define MBEDTLS_MAX_BLOCK_LENGTH
Definition: cipher.h:247
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:588
int MBEDTLS_DEPRECATED 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 authenticated encryption (AEAD) function.
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_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:523
mbedtls_cipher_mode_t
Definition: cipher.h:194
@ MBEDTLS_MODE_ECB
Definition: cipher.h:196
@ MBEDTLS_MODE_CCM
Definition: cipher.h:203
@ MBEDTLS_MODE_STREAM
Definition: cipher.h:202
@ MBEDTLS_MODE_NONE
Definition: cipher.h:195
@ MBEDTLS_MODE_CFB
Definition: cipher.h:198
@ MBEDTLS_MODE_CTR
Definition: cipher.h:200
@ MBEDTLS_MODE_GCM
Definition: cipher.h:201
@ MBEDTLS_MODE_KW
Definition: cipher.h:206
@ MBEDTLS_MODE_CBC
Definition: cipher.h:197
@ MBEDTLS_MODE_OFB
Definition: cipher.h:199
@ MBEDTLS_MODE_KWP
Definition: cipher.h:207
@ MBEDTLS_MODE_CHACHAPOLY
Definition: cipher.h:205
@ MBEDTLS_MODE_XTS
Definition: cipher.h:204
#define MBEDTLS_MAX_IV_LENGTH
Definition: cipher.h:241
mbedtls_cipher_id_t
Supported cipher types.
Definition: cipher.h:90
@ MBEDTLS_CIPHER_ID_3DES
Definition: cipher.h:95
@ MBEDTLS_CIPHER_ID_CAMELLIA
Definition: cipher.h:96
@ MBEDTLS_CIPHER_ID_DES
Definition: cipher.h:94
@ MBEDTLS_CIPHER_ID_ARC4
Definition: cipher.h:98
@ MBEDTLS_CIPHER_ID_NULL
Definition: cipher.h:92
@ MBEDTLS_CIPHER_ID_AES
Definition: cipher.h:93
@ MBEDTLS_CIPHER_ID_ARIA
Definition: cipher.h:99
@ MBEDTLS_CIPHER_ID_NONE
Definition: cipher.h:91
@ MBEDTLS_CIPHER_ID_CHACHA20
Definition: cipher.h:100
@ MBEDTLS_CIPHER_ID_BLOWFISH
Definition: cipher.h:97
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.
Configuration options (set of defines)
Common and shared functions used by multiple modules in the Mbed TLS library.
#define MBEDTLS_INTERNAL_VALIDATE_RET(cond, ret)
mbedtls_operation_t operation
Definition: cipher.h:327
unsigned char iv[MBEDTLS_MAX_IV_LENGTH]
Definition: cipher.h:345
void(* add_padding)(unsigned char *output, size_t olen, size_t data_len)
Definition: cipher.h:333
unsigned char unprocessed_data[MBEDTLS_MAX_BLOCK_LENGTH]
Definition: cipher.h:338
int(* get_padding)(unsigned char *input, size_t ilen, size_t *data_len)
Definition: cipher.h:334
const mbedtls_cipher_info_t * cipher_info
Definition: cipher.h:319
unsigned int key_bitlen
Definition: cipher.h:289
unsigned int iv_size
Definition: cipher.h:298
mbedtls_cipher_type_t type
Definition: cipher.h:280
mbedtls_cipher_mode_t mode
Definition: cipher.h:283
unsigned int block_size
Definition: cipher.h:307
const char * name
Definition: cipher.h:292
const mbedtls_cipher_base_t * base
Definition: cipher.h:310