mbed TLS v2.23.0
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 "mbedtls/config.h"
34 #else
35 #include MBEDTLS_CONFIG_FILE
36 #endif
37 
38 #include <stddef.h>
39 #include "mbedtls/platform_util.h"
40 
41 #if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CCM_C) || defined(MBEDTLS_CHACHAPOLY_C)
42 #define MBEDTLS_CIPHER_MODE_AEAD
43 #endif
44 
45 #if defined(MBEDTLS_CIPHER_MODE_CBC)
46 #define MBEDTLS_CIPHER_MODE_WITH_PADDING
47 #endif
48 
49 #if defined(MBEDTLS_ARC4_C) || defined(MBEDTLS_CIPHER_NULL_CIPHER) || \
50  defined(MBEDTLS_CHACHA20_C)
51 #define MBEDTLS_CIPHER_MODE_STREAM
52 #endif
53 
54 #if ( defined(__ARMCC_VERSION) || defined(_MSC_VER) ) && \
55  !defined(inline) && !defined(__cplusplus)
56 #define inline __inline
57 #endif
58 
59 #define MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE -0x6080
60 #define MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA -0x6100
61 #define MBEDTLS_ERR_CIPHER_ALLOC_FAILED -0x6180
62 #define MBEDTLS_ERR_CIPHER_INVALID_PADDING -0x6200
63 #define MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED -0x6280
64 #define MBEDTLS_ERR_CIPHER_AUTH_FAILED -0x6300
65 #define MBEDTLS_ERR_CIPHER_INVALID_CONTEXT -0x6380
67 /* MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED is deprecated and should not be used. */
68 #define MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED -0x6400
70 #define MBEDTLS_CIPHER_VARIABLE_IV_LEN 0x01
71 #define MBEDTLS_CIPHER_VARIABLE_KEY_LEN 0x02
73 #ifdef __cplusplus
74 extern "C" {
75 #endif
76 
84 typedef enum {
96 
104 typedef enum {
186 
188 typedef enum {
203 
205 typedef enum {
212 
214 typedef enum {
219 
220 enum {
229 };
230 
232 #define MBEDTLS_MAX_IV_LENGTH 16
233 
234 #define MBEDTLS_MAX_BLOCK_LENGTH 16
235 
240 
245 
250 typedef struct mbedtls_cipher_info_t
251 {
256 
259 
264  unsigned int key_bitlen;
265 
267  const char * name;
268 
273  unsigned int iv_size;
274 
279  int flags;
280 
282  unsigned int block_size;
283 
286 
288 
293 {
296 
299 
304 
305 #if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
306 
309  void (*add_padding)( unsigned char *output, size_t olen, size_t data_len );
310  int (*get_padding)( unsigned char *input, size_t ilen, size_t *data_len );
311 #endif
312 
315 
318 
321  unsigned char iv[MBEDTLS_MAX_IV_LENGTH];
322 
324  size_t iv_size;
325 
327  void *cipher_ctx;
328 
329 #if defined(MBEDTLS_CMAC_C)
330 
331  mbedtls_cmac_context_t *cmac_ctx;
332 #endif
333 
334 #if defined(MBEDTLS_USE_PSA_CRYPTO)
335 
342  unsigned char psa_enabled;
343 #endif /* MBEDTLS_USE_PSA_CRYPTO */
344 
346 
360 const int *mbedtls_cipher_list( void );
361 
373 const mbedtls_cipher_info_t *mbedtls_cipher_info_from_string( const char *cipher_name );
374 
386 
402  int key_bitlen,
403  const mbedtls_cipher_mode_t mode );
404 
411 
422 
423 
442  const mbedtls_cipher_info_t *cipher_info );
443 
444 #if defined(MBEDTLS_USE_PSA_CRYPTO)
445 
466 int mbedtls_cipher_setup_psa( mbedtls_cipher_context_t *ctx,
467  const mbedtls_cipher_info_t *cipher_info,
468  size_t taglen );
469 #endif /* MBEDTLS_USE_PSA_CRYPTO */
470 
479 static inline unsigned int mbedtls_cipher_get_block_size(
480  const mbedtls_cipher_context_t *ctx )
481 {
482  MBEDTLS_INTERNAL_VALIDATE_RET( ctx != NULL, 0 );
483  if( ctx->cipher_info == NULL )
484  return 0;
485 
486  return ctx->cipher_info->block_size;
487 }
488 
499  const mbedtls_cipher_context_t *ctx )
500 {
502  if( ctx->cipher_info == NULL )
503  return MBEDTLS_MODE_NONE;
504 
505  return ctx->cipher_info->mode;
506 }
507 
518 static inline int mbedtls_cipher_get_iv_size(
519  const mbedtls_cipher_context_t *ctx )
520 {
521  MBEDTLS_INTERNAL_VALIDATE_RET( ctx != NULL, 0 );
522  if( ctx->cipher_info == NULL )
523  return 0;
524 
525  if( ctx->iv_size != 0 )
526  return (int) ctx->iv_size;
527 
528  return (int) ctx->cipher_info->iv_size;
529 }
530 
540  const mbedtls_cipher_context_t *ctx )
541 {
543  ctx != NULL, MBEDTLS_CIPHER_NONE );
544  if( ctx->cipher_info == NULL )
545  return MBEDTLS_CIPHER_NONE;
546 
547  return ctx->cipher_info->type;
548 }
549 
559 static inline const char *mbedtls_cipher_get_name(
560  const mbedtls_cipher_context_t *ctx )
561 {
562  MBEDTLS_INTERNAL_VALIDATE_RET( ctx != NULL, 0 );
563  if( ctx->cipher_info == NULL )
564  return 0;
565 
566  return ctx->cipher_info->name;
567 }
568 
579  const mbedtls_cipher_context_t *ctx )
580 {
582  ctx != NULL, MBEDTLS_KEY_LENGTH_NONE );
583  if( ctx->cipher_info == NULL )
585 
586  return (int) ctx->cipher_info->key_bitlen;
587 }
588 
598  const mbedtls_cipher_context_t *ctx )
599 {
601  ctx != NULL, MBEDTLS_OPERATION_NONE );
602  if( ctx->cipher_info == NULL )
603  return MBEDTLS_OPERATION_NONE;
604 
605  return ctx->operation;
606 }
607 
625  const unsigned char *key,
626  int key_bitlen,
627  const mbedtls_operation_t operation );
628 
629 #if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
630 
648 #endif /* MBEDTLS_CIPHER_MODE_WITH_PADDING */
649 
669  const unsigned char *iv,
670  size_t iv_len );
671 
682 
683 #if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CHACHAPOLY_C)
684 
699  const unsigned char *ad, size_t ad_len );
700 #endif /* MBEDTLS_GCM_C || MBEDTLS_CHACHAPOLY_C */
701 
737  const unsigned char *input,
738  size_t ilen, unsigned char *output,
739  size_t *olen );
740 
764  unsigned char *output, size_t *olen );
765 
766 #if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CHACHAPOLY_C)
767 
784  unsigned char *tag, size_t tag_len );
785 
800  const unsigned char *tag, size_t tag_len );
801 #endif /* MBEDTLS_GCM_C || MBEDTLS_CHACHAPOLY_C */
802 
837  const unsigned char *iv, size_t iv_len,
838  const unsigned char *input, size_t ilen,
839  unsigned char *output, size_t *olen );
840 
841 #if defined(MBEDTLS_CIPHER_MODE_AEAD)
842 
873  const unsigned char *iv, size_t iv_len,
874  const unsigned char *ad, size_t ad_len,
875  const unsigned char *input, size_t ilen,
876  unsigned char *output, size_t *olen,
877  unsigned char *tag, size_t tag_len );
878 
915  const unsigned char *iv, size_t iv_len,
916  const unsigned char *ad, size_t ad_len,
917  const unsigned char *input, size_t ilen,
918  unsigned char *output, size_t *olen,
919  const unsigned char *tag, size_t tag_len );
920 #endif /* MBEDTLS_CIPHER_MODE_AEAD */
921 
922 #ifdef __cplusplus
923 }
924 #endif
925 
926 #endif /* MBEDTLS_CIPHER_H */
MBEDTLS_CIPHER_CAMELLIA_256_CFB128
@ MBEDTLS_CIPHER_CAMELLIA_256_CFB128
Definition: cipher.h:130
MBEDTLS_CIPHER_ARIA_192_CCM
@ MBEDTLS_CIPHER_ARIA_192_CCM
Definition: cipher.h:170
MBEDTLS_CIPHER_ARIA_256_GCM
@ MBEDTLS_CIPHER_ARIA_256_GCM
Definition: cipher.h:168
mbedtls_cipher_info_t
struct mbedtls_cipher_info_t mbedtls_cipher_info_t
MBEDTLS_CIPHER_AES_128_KW
@ MBEDTLS_CIPHER_AES_128_KW
Definition: cipher.h:179
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:597
MBEDTLS_CIPHER_ARIA_192_CBC
@ MBEDTLS_CIPHER_ARIA_192_CBC
Definition: cipher.h:158
MBEDTLS_CIPHER_AES_256_CTR
@ MBEDTLS_CIPHER_AES_256_CTR
Definition: cipher.h:118
mbedtls_cipher_list
const int * mbedtls_cipher_list(void)
This function retrieves the list of ciphers supported by the generic cipher module.
mbedtls_cipher_context_t::unprocessed_len
size_t unprocessed_len
Definition: cipher.h:317
MBEDTLS_CIPHER_DES_EDE3_CBC
@ MBEDTLS_CIPHER_DES_EDE3_CBC
Definition: cipher.h:142
MBEDTLS_CIPHER_AES_192_CFB128
@ MBEDTLS_CIPHER_AES_192_CFB128
Definition: cipher.h:114
mbedtls_cipher_init
void mbedtls_cipher_init(mbedtls_cipher_context_t *ctx)
This function initializes a cipher_context as NONE.
MBEDTLS_CIPHER_CAMELLIA_128_CCM
@ MBEDTLS_CIPHER_CAMELLIA_128_CCM
Definition: cipher.h:151
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....
MBEDTLS_CIPHER_AES_192_KW
@ MBEDTLS_CIPHER_AES_192_KW
Definition: cipher.h:180
mbedtls_cipher_context_t::operation
mbedtls_operation_t operation
Definition: cipher.h:303
MBEDTLS_CIPHER_ID_BLOWFISH
@ MBEDTLS_CIPHER_ID_BLOWFISH
Definition: cipher.h:91
MBEDTLS_CIPHER_ARIA_128_GCM
@ MBEDTLS_CIPHER_ARIA_128_GCM
Definition: cipher.h:166
mbedtls_cipher_setup
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_CAMELLIA_192_CTR
@ MBEDTLS_CIPHER_CAMELLIA_192_CTR
Definition: cipher.h:132
MBEDTLS_CIPHER_AES_192_CBC
@ MBEDTLS_CIPHER_AES_192_CBC
Definition: cipher.h:111
MBEDTLS_CIPHER_AES_192_CTR
@ MBEDTLS_CIPHER_AES_192_CTR
Definition: cipher.h:117
MBEDTLS_MODE_CTR
@ MBEDTLS_MODE_CTR
Definition: cipher.h:194
MBEDTLS_CIPHER_AES_256_ECB
@ MBEDTLS_CIPHER_AES_256_ECB
Definition: cipher.h:109
MBEDTLS_DECRYPT
@ MBEDTLS_DECRYPT
Definition: cipher.h:216
MBEDTLS_CIPHER_ARIA_192_CFB128
@ MBEDTLS_CIPHER_ARIA_192_CFB128
Definition: cipher.h:161
MBEDTLS_CIPHER_ARIA_128_CTR
@ MBEDTLS_CIPHER_ARIA_128_CTR
Definition: cipher.h:163
mbedtls_cipher_info_t::type
mbedtls_cipher_type_t type
Definition: cipher.h:255
MBEDTLS_CIPHER_CHACHA20_POLY1305
@ MBEDTLS_CIPHER_CHACHA20_POLY1305
Definition: cipher.h:178
MBEDTLS_CIPHER_AES_192_ECB
@ MBEDTLS_CIPHER_AES_192_ECB
Definition: cipher.h:108
MBEDTLS_CIPHER_ARIA_256_CFB128
@ MBEDTLS_CIPHER_ARIA_256_CFB128
Definition: cipher.h:162
MBEDTLS_CIPHER_ID_CHACHA20
@ MBEDTLS_CIPHER_ID_CHACHA20
Definition: cipher.h:94
mbedtls_cipher_info_t::base
const mbedtls_cipher_base_t * base
Definition: cipher.h:285
MBEDTLS_CIPHER_AES_128_OFB
@ MBEDTLS_CIPHER_AES_128_OFB
Definition: cipher.h:172
MBEDTLS_CIPHER_ARIA_192_GCM
@ MBEDTLS_CIPHER_ARIA_192_GCM
Definition: cipher.h:167
MBEDTLS_CIPHER_AES_192_KWP
@ MBEDTLS_CIPHER_AES_192_KWP
Definition: cipher.h:183
MBEDTLS_CIPHER_ID_NONE
@ MBEDTLS_CIPHER_ID_NONE
Definition: cipher.h:85
MBEDTLS_CIPHER_AES_128_CBC
@ MBEDTLS_CIPHER_AES_128_CBC
Definition: cipher.h:110
mbedtls_cipher_id_t
mbedtls_cipher_id_t
Supported cipher types.
Definition: cipher.h:84
MBEDTLS_CIPHER_CAMELLIA_128_GCM
@ MBEDTLS_CIPHER_CAMELLIA_128_GCM
Definition: cipher.h:134
mbedtls_cipher_context_t::iv_size
size_t iv_size
Definition: cipher.h:324
MBEDTLS_KEY_LENGTH_DES_EDE3
@ MBEDTLS_KEY_LENGTH_DES_EDE3
Definition: cipher.h:228
MBEDTLS_CIPHER_AES_256_OFB
@ MBEDTLS_CIPHER_AES_256_OFB
Definition: cipher.h:174
MBEDTLS_CIPHER_CAMELLIA_256_GCM
@ MBEDTLS_CIPHER_CAMELLIA_256_GCM
Definition: cipher.h:136
MBEDTLS_MODE_NONE
@ MBEDTLS_MODE_NONE
Definition: cipher.h:189
mbedtls_cipher_info_t
Definition: cipher.h:251
mbedtls_cipher_info_t::iv_size
unsigned int iv_size
Definition: cipher.h:273
MBEDTLS_CIPHER_AES_128_CFB128
@ MBEDTLS_CIPHER_AES_128_CFB128
Definition: cipher.h:113
MBEDTLS_CIPHER_CHACHA20
@ MBEDTLS_CIPHER_CHACHA20
Definition: cipher.h:177
MBEDTLS_CIPHER_ARIA_256_CCM
@ MBEDTLS_CIPHER_ARIA_256_CCM
Definition: cipher.h:171
MBEDTLS_MODE_GCM
@ MBEDTLS_MODE_GCM
Definition: cipher.h:195
mbedtls_operation_t
mbedtls_operation_t
Definition: cipher.h:214
mbedtls_cipher_context_t
struct mbedtls_cipher_context_t mbedtls_cipher_context_t
MBEDTLS_CIPHER_AES_128_GCM
@ MBEDTLS_CIPHER_AES_128_GCM
Definition: cipher.h:119
MBEDTLS_PADDING_ONE_AND_ZEROS
@ MBEDTLS_PADDING_ONE_AND_ZEROS
Definition: cipher.h:207
MBEDTLS_CIPHER_DES_ECB
@ MBEDTLS_CIPHER_DES_ECB
Definition: cipher.h:137
MBEDTLS_CIPHER_DES_EDE_ECB
@ MBEDTLS_CIPHER_DES_EDE_ECB
Definition: cipher.h:139
MBEDTLS_CIPHER_AES_256_XTS
@ MBEDTLS_CIPHER_AES_256_XTS
Definition: cipher.h:176
MBEDTLS_CIPHER_ARIA_256_CBC
@ MBEDTLS_CIPHER_ARIA_256_CBC
Definition: cipher.h:159
mbedtls_cipher_info_t::key_bitlen
unsigned int key_bitlen
Definition: cipher.h:264
MBEDTLS_CIPHER_BLOWFISH_CTR
@ MBEDTLS_CIPHER_BLOWFISH_CTR
Definition: cipher.h:146
mbedtls_cipher_context_t::key_bitlen
int key_bitlen
Definition: cipher.h:298
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_CIPHER_BLOWFISH_CFB64
@ MBEDTLS_CIPHER_BLOWFISH_CFB64
Definition: cipher.h:145
mbedtls_cmac_context_t
Definition: cmac.h:61
mbedtls_cipher_mode_t
mbedtls_cipher_mode_t
Definition: cipher.h:188
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_CAMELLIA_256_CCM
@ MBEDTLS_CIPHER_CAMELLIA_256_CCM
Definition: cipher.h:153
MBEDTLS_PADDING_NONE
@ MBEDTLS_PADDING_NONE
Definition: cipher.h:210
mbedtls_cipher_padding_t
mbedtls_cipher_padding_t
Definition: cipher.h:205
MBEDTLS_CIPHER_ARIA_128_CFB128
@ MBEDTLS_CIPHER_ARIA_128_CFB128
Definition: cipher.h:160
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_MODE_XTS
@ MBEDTLS_MODE_XTS
Definition: cipher.h:198
MBEDTLS_CIPHER_CAMELLIA_256_CBC
@ MBEDTLS_CIPHER_CAMELLIA_256_CBC
Definition: cipher.h:127
MBEDTLS_OPERATION_NONE
@ MBEDTLS_OPERATION_NONE
Definition: cipher.h:215
MBEDTLS_CIPHER_CAMELLIA_192_CFB128
@ MBEDTLS_CIPHER_CAMELLIA_192_CFB128
Definition: cipher.h:129
MBEDTLS_CIPHER_AES_256_KW
@ MBEDTLS_CIPHER_AES_256_KW
Definition: cipher.h:181
MBEDTLS_CIPHER_ID_DES
@ MBEDTLS_CIPHER_ID_DES
Definition: cipher.h:88
MBEDTLS_CIPHER_ARIA_256_ECB
@ MBEDTLS_CIPHER_ARIA_256_ECB
Definition: cipher.h:156
MBEDTLS_CIPHER_NULL
@ MBEDTLS_CIPHER_NULL
Definition: cipher.h:106
mbedtls_cipher_info_t::mode
mbedtls_cipher_mode_t mode
Definition: cipher.h:258
MBEDTLS_CIPHER_BLOWFISH_CBC
@ MBEDTLS_CIPHER_BLOWFISH_CBC
Definition: cipher.h:144
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_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....
mbedtls_cipher_info_t::block_size
unsigned int block_size
Definition: cipher.h:282
MBEDTLS_MODE_STREAM
@ MBEDTLS_MODE_STREAM
Definition: cipher.h:196
MBEDTLS_CIPHER_ID_ARC4
@ MBEDTLS_CIPHER_ID_ARC4
Definition: cipher.h:92
MBEDTLS_CIPHER_AES_256_GCM
@ MBEDTLS_CIPHER_AES_256_GCM
Definition: cipher.h:121
MBEDTLS_CIPHER_AES_256_CBC
@ MBEDTLS_CIPHER_AES_256_CBC
Definition: cipher.h:112
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_CAMELLIA_192_CCM
@ MBEDTLS_CIPHER_CAMELLIA_192_CCM
Definition: cipher.h:152
MBEDTLS_CIPHER_DES_EDE_CBC
@ MBEDTLS_CIPHER_DES_EDE_CBC
Definition: cipher.h:140
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_MODE_CBC
@ MBEDTLS_MODE_CBC
Definition: cipher.h:191
mbedtls_cipher_reset
int mbedtls_cipher_reset(mbedtls_cipher_context_t *ctx)
This function resets the cipher state.
MBEDTLS_PADDING_PKCS7
@ MBEDTLS_PADDING_PKCS7
Definition: cipher.h:206
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:518
MBEDTLS_CIPHER_CAMELLIA_256_CTR
@ MBEDTLS_CIPHER_CAMELLIA_256_CTR
Definition: cipher.h:133
MBEDTLS_MODE_CCM
@ MBEDTLS_MODE_CCM
Definition: cipher.h:197
MBEDTLS_MODE_KW
@ MBEDTLS_MODE_KW
Definition: cipher.h:200
MBEDTLS_MODE_ECB
@ MBEDTLS_MODE_ECB
Definition: cipher.h:190
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_MAX_BLOCK_LENGTH
#define MBEDTLS_MAX_BLOCK_LENGTH
Definition: cipher.h:234
MBEDTLS_CIPHER_AES_256_KWP
@ MBEDTLS_CIPHER_AES_256_KWP
Definition: cipher.h:184
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_DES_EDE3_ECB
@ MBEDTLS_CIPHER_DES_EDE3_ECB
Definition: cipher.h:141
mbedtls_cipher_info_t::name
const char * name
Definition: cipher.h:267
MBEDTLS_CIPHER_AES_256_CCM
@ MBEDTLS_CIPHER_AES_256_CCM
Definition: cipher.h:150
MBEDTLS_CIPHER_CAMELLIA_128_CBC
@ MBEDTLS_CIPHER_CAMELLIA_128_CBC
Definition: cipher.h:125
MBEDTLS_ENCRYPT
@ MBEDTLS_ENCRYPT
Definition: cipher.h:217
mbedtls_cipher_context_t::unprocessed_data
unsigned char unprocessed_data[MBEDTLS_MAX_BLOCK_LENGTH]
Definition: cipher.h:314
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:578
MBEDTLS_CIPHER_AES_192_OFB
@ MBEDTLS_CIPHER_AES_192_OFB
Definition: cipher.h:173
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:539
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::flags
int flags
Definition: cipher.h:279
MBEDTLS_CIPHER_ARIA_128_CBC
@ MBEDTLS_CIPHER_ARIA_128_CBC
Definition: cipher.h:157
MBEDTLS_CIPHER_ARIA_256_CTR
@ MBEDTLS_CIPHER_ARIA_256_CTR
Definition: cipher.h:165
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:498
MBEDTLS_CIPHER_ID_CAMELLIA
@ MBEDTLS_CIPHER_ID_CAMELLIA
Definition: cipher.h:90
MBEDTLS_CIPHER_AES_128_CTR
@ MBEDTLS_CIPHER_AES_128_CTR
Definition: cipher.h:116
MBEDTLS_CIPHER_CAMELLIA_256_ECB
@ MBEDTLS_CIPHER_CAMELLIA_256_ECB
Definition: cipher.h:124
MBEDTLS_CIPHER_AES_192_GCM
@ MBEDTLS_CIPHER_AES_192_GCM
Definition: cipher.h:120
MBEDTLS_CIPHER_CAMELLIA_128_CFB128
@ MBEDTLS_CIPHER_CAMELLIA_128_CFB128
Definition: cipher.h:128
MBEDTLS_MODE_CHACHAPOLY
@ MBEDTLS_MODE_CHACHAPOLY
Definition: cipher.h:199
MBEDTLS_CIPHER_ARC4_128
@ MBEDTLS_CIPHER_ARC4_128
Definition: cipher.h:147
mbedtls_cipher_base_t
struct mbedtls_cipher_base_t mbedtls_cipher_base_t
Definition: cipher.h:239
mbedtls_cipher_context_t::add_padding
void(* add_padding)(unsigned char *output, size_t olen, size_t data_len)
Definition: cipher.h:309
MBEDTLS_CIPHER_DES_CBC
@ MBEDTLS_CIPHER_DES_CBC
Definition: cipher.h:138
MBEDTLS_CIPHER_ARIA_192_CTR
@ MBEDTLS_CIPHER_ARIA_192_CTR
Definition: cipher.h:164
mbedtls_cipher_context_t
Definition: cipher.h:293
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:479
MBEDTLS_CIPHER_ARIA_128_CCM
@ MBEDTLS_CIPHER_ARIA_128_CCM
Definition: cipher.h:169
MBEDTLS_KEY_LENGTH_DES
@ MBEDTLS_KEY_LENGTH_DES
Definition: cipher.h:224
MBEDTLS_MODE_KWP
@ MBEDTLS_MODE_KWP
Definition: cipher.h:201
MBEDTLS_MAX_IV_LENGTH
#define MBEDTLS_MAX_IV_LENGTH
Definition: cipher.h:232
config.h
Configuration options (set of defines)
MBEDTLS_CIPHER_NONE
@ MBEDTLS_CIPHER_NONE
Definition: cipher.h:105
MBEDTLS_PADDING_ZEROS_AND_LEN
@ MBEDTLS_PADDING_ZEROS_AND_LEN
Definition: cipher.h:208
MBEDTLS_CIPHER_ID_AES
@ MBEDTLS_CIPHER_ID_AES
Definition: cipher.h:87
MBEDTLS_CIPHER_AES_128_XTS
@ MBEDTLS_CIPHER_AES_128_XTS
Definition: cipher.h:175
platform_util.h
Common and shared functions used by multiple modules in the Mbed TLS library.
MBEDTLS_CIPHER_AES_192_CCM
@ MBEDTLS_CIPHER_AES_192_CCM
Definition: cipher.h:149
MBEDTLS_PADDING_ZEROS
@ MBEDTLS_PADDING_ZEROS
Definition: cipher.h:209
MBEDTLS_CIPHER_CAMELLIA_192_CBC
@ MBEDTLS_CIPHER_CAMELLIA_192_CBC
Definition: cipher.h:126
MBEDTLS_CIPHER_AES_128_KWP
@ MBEDTLS_CIPHER_AES_128_KWP
Definition: cipher.h:182
MBEDTLS_CIPHER_AES_128_ECB
@ MBEDTLS_CIPHER_AES_128_ECB
Definition: cipher.h:107
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_ID_3DES
@ MBEDTLS_CIPHER_ID_3DES
Definition: cipher.h:89
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_AES_256_CFB128
@ MBEDTLS_CIPHER_AES_256_CFB128
Definition: cipher.h:115
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_context_t::cipher_ctx
void * cipher_ctx
Definition: cipher.h:327
MBEDTLS_CIPHER_ARIA_128_ECB
@ MBEDTLS_CIPHER_ARIA_128_ECB
Definition: cipher.h:154
MBEDTLS_CIPHER_ID_NULL
@ MBEDTLS_CIPHER_ID_NULL
Definition: cipher.h:86
MBEDTLS_CIPHER_CAMELLIA_128_CTR
@ MBEDTLS_CIPHER_CAMELLIA_128_CTR
Definition: cipher.h:131
MBEDTLS_INTERNAL_VALIDATE_RET
#define MBEDTLS_INTERNAL_VALIDATE_RET(cond, ret)
Definition: platform_util.h:111
MBEDTLS_CIPHER_ARIA_192_ECB
@ MBEDTLS_CIPHER_ARIA_192_ECB
Definition: cipher.h:155
MBEDTLS_CIPHER_CAMELLIA_192_ECB
@ MBEDTLS_CIPHER_CAMELLIA_192_ECB
Definition: cipher.h:123
MBEDTLS_MODE_CFB
@ MBEDTLS_MODE_CFB
Definition: cipher.h:192
MBEDTLS_CIPHER_CAMELLIA_192_GCM
@ MBEDTLS_CIPHER_CAMELLIA_192_GCM
Definition: cipher.h:135
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:559
MBEDTLS_CIPHER_BLOWFISH_ECB
@ MBEDTLS_CIPHER_BLOWFISH_ECB
Definition: cipher.h:143
MBEDTLS_KEY_LENGTH_NONE
@ MBEDTLS_KEY_LENGTH_NONE
Definition: cipher.h:222
mbedtls_cipher_type_t
mbedtls_cipher_type_t
Supported {cipher type, cipher mode} pairs.
Definition: cipher.h:104
mbedtls_cipher_context_t::iv
unsigned char iv[MBEDTLS_MAX_IV_LENGTH]
Definition: cipher.h:321
MBEDTLS_CIPHER_ID_ARIA
@ MBEDTLS_CIPHER_ID_ARIA
Definition: cipher.h:93
MBEDTLS_CIPHER_AES_128_CCM
@ MBEDTLS_CIPHER_AES_128_CCM
Definition: cipher.h:148
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_cipher_context_t::cipher_info
const mbedtls_cipher_info_t * cipher_info
Definition: cipher.h:295
MBEDTLS_KEY_LENGTH_DES_EDE
@ MBEDTLS_KEY_LENGTH_DES_EDE
Definition: cipher.h:226
MBEDTLS_MODE_OFB
@ MBEDTLS_MODE_OFB
Definition: cipher.h:193
MBEDTLS_CIPHER_CAMELLIA_128_ECB
@ MBEDTLS_CIPHER_CAMELLIA_128_ECB
Definition: cipher.h:122
mbedtls_cipher_context_t::get_padding
int(* get_padding)(unsigned char *input, size_t ilen, size_t *data_len)
Definition: cipher.h:310