mbed TLS v3.1.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
29 #include "mbedtls/private_access.h"
30 
31 #include "mbedtls/build_info.h"
32 
33 #include <stddef.h>
34 #include "mbedtls/platform_util.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 
49 #if ( defined(__ARMCC_VERSION) || defined(_MSC_VER) ) && \
50  !defined(inline) && !defined(__cplusplus)
51 #define inline __inline
52 #endif
53 
55 #define MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE -0x6080
56 
57 #define MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA -0x6100
58 
59 #define MBEDTLS_ERR_CIPHER_ALLOC_FAILED -0x6180
60 
61 #define MBEDTLS_ERR_CIPHER_INVALID_PADDING -0x6200
62 
63 #define MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED -0x6280
64 
65 #define MBEDTLS_ERR_CIPHER_AUTH_FAILED -0x6300
66 
67 #define MBEDTLS_ERR_CIPHER_INVALID_CONTEXT -0x6380
68 
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 {
93 
101 typedef enum {
187 
189 typedef enum {
205 
207 typedef enum {
214 
216 typedef enum {
221 
222 enum {
231 };
232 
234 /* This should ideally be derived automatically from list of ciphers.
235  * This should be kept in sync with MBEDTLS_SSL_MAX_IV_LENGTH defined
236  * in library/ssl_misc.h. */
237 #define MBEDTLS_MAX_IV_LENGTH 16
238 
240 /* This should ideally be derived automatically from list of ciphers.
241  * This should be kept in sync with MBEDTLS_SSL_MAX_BLOCK_LENGTH defined
242  * in library/ssl_misc.h. */
243 #define MBEDTLS_MAX_BLOCK_LENGTH 16
244 
246 /* This should ideally be derived automatically from list of ciphers.
247  * For now, only check whether XTS is enabled which uses 64 Byte keys,
248  * and use 32 Bytes as an upper bound for the maximum key length otherwise.
249  * This should be kept in sync with MBEDTLS_SSL_MAX_BLOCK_LENGTH defined
250  * in library/ssl_misc.h, which however deliberately ignores the case of XTS
251  * since the latter isn't used in SSL/TLS. */
252 #if defined(MBEDTLS_CIPHER_MODE_XTS)
253 #define MBEDTLS_MAX_KEY_LENGTH 64
254 #else
255 #define MBEDTLS_MAX_KEY_LENGTH 32
256 #endif /* MBEDTLS_CIPHER_MODE_XTS */
257 
262 
267 
279 typedef struct mbedtls_cipher_info_t
280 {
285 
288 
293  unsigned int MBEDTLS_PRIVATE(key_bitlen);
294 
296  const char * MBEDTLS_PRIVATE(name);
297 
302  unsigned int MBEDTLS_PRIVATE(iv_size);
303 
308  int MBEDTLS_PRIVATE(flags);
309 
311  unsigned int MBEDTLS_PRIVATE(block_size);
312 
315 
317 
322 {
325 
327  int MBEDTLS_PRIVATE(key_bitlen);
328 
333 
334 #if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
335 
338  void (*MBEDTLS_PRIVATE(add_padding))( unsigned char *output, size_t olen, size_t data_len );
339  int (*MBEDTLS_PRIVATE(get_padding))( unsigned char *input, size_t ilen, size_t *data_len );
340 #endif
341 
343  unsigned char MBEDTLS_PRIVATE(unprocessed_data)[MBEDTLS_MAX_BLOCK_LENGTH];
344 
346  size_t MBEDTLS_PRIVATE(unprocessed_len);
347 
351 
353  size_t MBEDTLS_PRIVATE(iv_size);
354 
356  void *MBEDTLS_PRIVATE(cipher_ctx);
357 
358 #if defined(MBEDTLS_CMAC_C)
359 
361 #endif
362 
363 #if defined(MBEDTLS_USE_PSA_CRYPTO)
364 
371  unsigned char MBEDTLS_PRIVATE(psa_enabled);
372 #endif /* MBEDTLS_USE_PSA_CRYPTO */
373 
375 
389 const int *mbedtls_cipher_list( void );
390 
402 const mbedtls_cipher_info_t *mbedtls_cipher_info_from_string( const char *cipher_name );
403 
415 
431  int key_bitlen,
432  const mbedtls_cipher_mode_t mode );
433 
444  const mbedtls_cipher_info_t *info )
445 {
446  if( info == NULL )
447  return( MBEDTLS_CIPHER_NONE );
448  else
449  return( info->MBEDTLS_PRIVATE(type) );
450 }
451 
462  const mbedtls_cipher_info_t *info )
463 {
464  if( info == NULL )
465  return( MBEDTLS_MODE_NONE );
466  else
467  return( info->MBEDTLS_PRIVATE(mode) );
468 }
469 
482  const mbedtls_cipher_info_t *info )
483 {
484  if( info == NULL )
485  return( 0 );
486  else
487  return( info->MBEDTLS_PRIVATE(key_bitlen) );
488 }
489 
501 static inline const char *mbedtls_cipher_info_get_name(
502  const mbedtls_cipher_info_t *info )
503 {
504  if( info == NULL )
505  return( NULL );
506  else
507  return( info->MBEDTLS_PRIVATE(name) );
508 }
509 
520 static inline size_t mbedtls_cipher_info_get_iv_size(
521  const mbedtls_cipher_info_t *info )
522 {
523  if( info == NULL )
524  return( 0 );
525 
526  return( (size_t) info->MBEDTLS_PRIVATE(iv_size) );
527 }
528 
540  const mbedtls_cipher_info_t *info )
541 {
542  if( info == NULL )
543  return( 0 );
544 
545  return( (size_t) info->MBEDTLS_PRIVATE(block_size) );
546 }
547 
558  const mbedtls_cipher_info_t *info )
559 {
560  if( info == NULL )
561  return( 0 );
562 
563  return( info->MBEDTLS_PRIVATE(flags) & MBEDTLS_CIPHER_VARIABLE_KEY_LEN );
564 }
565 
576  const mbedtls_cipher_info_t *info )
577 {
578  if( info == NULL )
579  return( 0 );
580 
581  return( info->MBEDTLS_PRIVATE(flags) & MBEDTLS_CIPHER_VARIABLE_IV_LEN );
582 }
583 
590 
601 
602 
630  const mbedtls_cipher_info_t *cipher_info );
631 
632 #if defined(MBEDTLS_USE_PSA_CRYPTO)
633 
655  const mbedtls_cipher_info_t *cipher_info,
656  size_t taglen );
657 #endif /* MBEDTLS_USE_PSA_CRYPTO */
658 
669 static inline unsigned int mbedtls_cipher_get_block_size(
670  const mbedtls_cipher_context_t *ctx )
671 {
672  MBEDTLS_INTERNAL_VALIDATE_RET( ctx != NULL, 0 );
673  if( ctx->MBEDTLS_PRIVATE(cipher_info) == NULL )
674  return 0;
675 
676  return ctx->MBEDTLS_PRIVATE(cipher_info)->MBEDTLS_PRIVATE(block_size);
677 }
678 
689  const mbedtls_cipher_context_t *ctx )
690 {
692  if( ctx->MBEDTLS_PRIVATE(cipher_info) == NULL )
693  return MBEDTLS_MODE_NONE;
694 
695  return ctx->MBEDTLS_PRIVATE(cipher_info)->MBEDTLS_PRIVATE(mode);
696 }
697 
708 static inline int mbedtls_cipher_get_iv_size(
709  const mbedtls_cipher_context_t *ctx )
710 {
711  MBEDTLS_INTERNAL_VALIDATE_RET( ctx != NULL, 0 );
712  if( ctx->MBEDTLS_PRIVATE(cipher_info) == NULL )
713  return 0;
714 
715  if( ctx->MBEDTLS_PRIVATE(iv_size) != 0 )
716  return (int) ctx->MBEDTLS_PRIVATE(iv_size);
717 
718  return (int) ctx->MBEDTLS_PRIVATE(cipher_info)->MBEDTLS_PRIVATE(iv_size);
719 }
720 
730  const mbedtls_cipher_context_t *ctx )
731 {
733  ctx != NULL, MBEDTLS_CIPHER_NONE );
734  if( ctx->MBEDTLS_PRIVATE(cipher_info) == NULL )
735  return MBEDTLS_CIPHER_NONE;
736 
737  return ctx->MBEDTLS_PRIVATE(cipher_info)->MBEDTLS_PRIVATE(type);
738 }
739 
749 static inline const char *mbedtls_cipher_get_name(
750  const mbedtls_cipher_context_t *ctx )
751 {
752  MBEDTLS_INTERNAL_VALIDATE_RET( ctx != NULL, 0 );
753  if( ctx->MBEDTLS_PRIVATE(cipher_info) == NULL )
754  return 0;
755 
756  return ctx->MBEDTLS_PRIVATE(cipher_info)->MBEDTLS_PRIVATE(name);
757 }
758 
769  const mbedtls_cipher_context_t *ctx )
770 {
772  ctx != NULL, MBEDTLS_KEY_LENGTH_NONE );
773  if( ctx->MBEDTLS_PRIVATE(cipher_info) == NULL )
775 
776  return (int) ctx->MBEDTLS_PRIVATE(cipher_info)->MBEDTLS_PRIVATE(key_bitlen);
777 }
778 
788  const mbedtls_cipher_context_t *ctx )
789 {
791  ctx != NULL, MBEDTLS_OPERATION_NONE );
792  if( ctx->MBEDTLS_PRIVATE(cipher_info) == NULL )
793  return MBEDTLS_OPERATION_NONE;
794 
795  return ctx->MBEDTLS_PRIVATE(operation);
796 }
797 
815  const unsigned char *key,
816  int key_bitlen,
817  const mbedtls_operation_t operation );
818 
819 #if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
820 
838 #endif /* MBEDTLS_CIPHER_MODE_WITH_PADDING */
839 
859  const unsigned char *iv,
860  size_t iv_len );
861 
895 
896 #if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CHACHAPOLY_C)
897 
910  const unsigned char *ad, size_t ad_len );
911 #endif /* MBEDTLS_GCM_C || MBEDTLS_CHACHAPOLY_C */
912 
943  const unsigned char *input,
944  size_t ilen, unsigned char *output,
945  size_t *olen );
946 
970  unsigned char *output, size_t *olen );
971 
972 #if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CHACHAPOLY_C)
973 
990  unsigned char *tag, size_t tag_len );
991 
1006  const unsigned char *tag, size_t tag_len );
1007 #endif /* MBEDTLS_GCM_C || MBEDTLS_CHACHAPOLY_C */
1008 
1043  const unsigned char *iv, size_t iv_len,
1044  const unsigned char *input, size_t ilen,
1045  unsigned char *output, size_t *olen );
1046 
1047 #if defined(MBEDTLS_CIPHER_MODE_AEAD) || defined(MBEDTLS_NIST_KW_C)
1048 
1093  const unsigned char *iv, size_t iv_len,
1094  const unsigned char *ad, size_t ad_len,
1095  const unsigned char *input, size_t ilen,
1096  unsigned char *output, size_t output_len,
1097  size_t *olen, size_t tag_len );
1098 
1149  const unsigned char *iv, size_t iv_len,
1150  const unsigned char *ad, size_t ad_len,
1151  const unsigned char *input, size_t ilen,
1152  unsigned char *output, size_t output_len,
1153  size_t *olen, size_t tag_len );
1154 #endif /* MBEDTLS_CIPHER_MODE_AEAD || MBEDTLS_NIST_KW_C */
1155 #ifdef __cplusplus
1156 }
1157 #endif
1158 
1159 #endif /* MBEDTLS_CIPHER_H */
#define MBEDTLS_CIPHER_VARIABLE_KEY_LEN
Definition: cipher.h:70
#define MBEDTLS_CIPHER_VARIABLE_IV_LEN
Definition: cipher.h:69
mbedtls_operation_t
Definition: cipher.h:216
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:501
mbedtls_cipher_padding_t
Definition: cipher.h:207
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:688
#define MBEDTLS_INTERNAL_VALIDATE_RET(cond, ret)
Definition: platform_util.h:39
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:669
int mbedtls_cipher_setup_psa(mbedtls_cipher_context_t *ctx, const mbedtls_cipher_info_t *cipher_info, size_t taglen)
This function initializes a cipher context for PSA-based use with the given cipher primitive...
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:481
mbedtls_cipher_mode_t
Definition: cipher.h:189
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 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:575
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...
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_reset(mbedtls_cipher_context_t *ctx)
This function resets the cipher state.
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:749
#define MBEDTLS_PRIVATE(member)
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.
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:557
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_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:520
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...
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 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:787
const int * mbedtls_cipher_list(void)
This function retrieves the list of ciphers supported by the generic cipher module.
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:768
mbedtls_cipher_type_t
Supported {cipher type, cipher mode} pairs.
Definition: cipher.h:101
struct mbedtls_cipher_info_t mbedtls_cipher_info_t
Common and shared functions used by multiple modules in the Mbed TLS library.
struct mbedtls_cipher_base_t mbedtls_cipher_base_t
Definition: cipher.h:261
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...
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:729
mbedtls_cipher_id_t
Supported cipher types.
Definition: cipher.h:83
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.
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:461
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.
#define MBEDTLS_MAX_IV_LENGTH
Definition: cipher.h:237
Macro wrapper for struct's memebrs.
Build-time configuration info.
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...
struct mbedtls_cmac_context_t mbedtls_cmac_context_t
Definition: cipher.h:266
void mbedtls_cipher_init(mbedtls_cipher_context_t *ctx)
This function initializes a cipher_context 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...
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.
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. This must be called after mbedtls_cipher_finish().
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:708
struct mbedtls_cipher_context_t mbedtls_cipher_context_t
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:443
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. This must be called after mbedtls_cipher_finish().
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:539
#define MBEDTLS_MAX_BLOCK_LENGTH
Definition: cipher.h:243
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...