mbed TLS v2.13.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 "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
65 #define MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED -0x6400
67 #define MBEDTLS_CIPHER_VARIABLE_IV_LEN 0x01
68 #define MBEDTLS_CIPHER_VARIABLE_KEY_LEN 0x02
70 #ifdef __cplusplus
71 extern "C" {
72 #endif
73 
81 typedef enum {
93 
101 typedef enum {
177 
179 typedef enum {
192 
194 typedef enum {
201 
203 typedef enum {
208 
209 enum {
218 };
219 
221 #define MBEDTLS_MAX_IV_LENGTH 16
222 
223 #define MBEDTLS_MAX_BLOCK_LENGTH 16
224 
229 
234 
239 typedef struct mbedtls_cipher_info_t
240 {
245 
248 
253  unsigned int key_bitlen;
254 
256  const char * name;
257 
262  unsigned int iv_size;
263 
268  int flags;
269 
271  unsigned int block_size;
272 
275 
277 
282 {
285 
288 
293 
294 #if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
295 
298  void (*add_padding)( unsigned char *output, size_t olen, size_t data_len );
299  int (*get_padding)( unsigned char *input, size_t ilen, size_t *data_len );
300 #endif
301 
304 
307 
310  unsigned char iv[MBEDTLS_MAX_IV_LENGTH];
311 
313  size_t iv_size;
314 
316  void *cipher_ctx;
317 
318 #if defined(MBEDTLS_CMAC_C)
319 
320  mbedtls_cmac_context_t *cmac_ctx;
321 #endif
323 
331 const int *mbedtls_cipher_list( void );
332 
343 const mbedtls_cipher_info_t *mbedtls_cipher_info_from_string( const char *cipher_name );
344 
356 
372  int key_bitlen,
373  const mbedtls_cipher_mode_t mode );
374 
379 
386 
387 
407 
416 static inline unsigned int mbedtls_cipher_get_block_size( const mbedtls_cipher_context_t *ctx )
417 {
418  if( NULL == ctx || NULL == ctx->cipher_info )
419  return 0;
420 
421  return ctx->cipher_info->block_size;
422 }
423 
434 {
435  if( NULL == ctx || NULL == ctx->cipher_info )
436  return MBEDTLS_MODE_NONE;
437 
438  return ctx->cipher_info->mode;
439 }
440 
452 {
453  if( NULL == ctx || NULL == ctx->cipher_info )
454  return 0;
455 
456  if( ctx->iv_size != 0 )
457  return (int) ctx->iv_size;
458 
459  return (int) ctx->cipher_info->iv_size;
460 }
461 
471 {
472  if( NULL == ctx || NULL == ctx->cipher_info )
473  return MBEDTLS_CIPHER_NONE;
474 
475  return ctx->cipher_info->type;
476 }
477 
487 static inline const char *mbedtls_cipher_get_name( const mbedtls_cipher_context_t *ctx )
488 {
489  if( NULL == ctx || NULL == ctx->cipher_info )
490  return 0;
491 
492  return ctx->cipher_info->name;
493 }
494 
505 {
506  if( NULL == ctx || NULL == ctx->cipher_info )
508 
509  return (int) ctx->cipher_info->key_bitlen;
510 }
511 
521 {
522  if( NULL == ctx || NULL == ctx->cipher_info )
523  return MBEDTLS_OPERATION_NONE;
524 
525  return ctx->operation;
526 }
527 
544 int mbedtls_cipher_setkey( mbedtls_cipher_context_t *ctx, const unsigned char *key,
545  int key_bitlen, const mbedtls_operation_t operation );
546 
547 #if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
548 
564 #endif /* MBEDTLS_CIPHER_MODE_WITH_PADDING */
565 
583  const unsigned char *iv, size_t iv_len );
584 
595 
596 #if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CHACHAPOLY_C)
597 
610  const unsigned char *ad, size_t ad_len );
611 #endif /* MBEDTLS_GCM_C || MBEDTLS_CHACHAPOLY_C */
612 
644 int mbedtls_cipher_update( mbedtls_cipher_context_t *ctx, const unsigned char *input,
645  size_t ilen, unsigned char *output, size_t *olen );
646 
667  unsigned char *output, size_t *olen );
668 
669 #if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CHACHAPOLY_C)
670 
683  unsigned char *tag, size_t tag_len );
684 
698  const unsigned char *tag, size_t tag_len );
699 #endif /* MBEDTLS_GCM_C || MBEDTLS_CHACHAPOLY_C */
700 
731  const unsigned char *iv, size_t iv_len,
732  const unsigned char *input, size_t ilen,
733  unsigned char *output, size_t *olen );
734 
735 #if defined(MBEDTLS_CIPHER_MODE_AEAD)
736 
760  const unsigned char *iv, size_t iv_len,
761  const unsigned char *ad, size_t ad_len,
762  const unsigned char *input, size_t ilen,
763  unsigned char *output, size_t *olen,
764  unsigned char *tag, size_t tag_len );
765 
795  const unsigned char *iv, size_t iv_len,
796  const unsigned char *ad, size_t ad_len,
797  const unsigned char *input, size_t ilen,
798  unsigned char *output, size_t *olen,
799  const unsigned char *tag, size_t tag_len );
800 #endif /* MBEDTLS_CIPHER_MODE_AEAD */
801 
802 #ifdef __cplusplus
803 }
804 #endif
805 
806 #endif /* MBEDTLS_CIPHER_H */
unsigned char unprocessed_data[MBEDTLS_MAX_BLOCK_LENGTH]
Definition: cipher.h:303
mbedtls_operation_t
Definition: cipher.h:203
unsigned int iv_size
Definition: cipher.h:262
mbedtls_cipher_padding_t
Definition: cipher.h:194
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:433
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:416
mbedtls_cipher_mode_t
Definition: cipher.h:179
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...
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...
void(* add_padding)(unsigned char *output, size_t olen, size_t data_len)
Definition: cipher.h:298
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:487
Configuration options (set of defines)
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.
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_mode_t mode
Definition: cipher.h:247
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...
unsigned int block_size
Definition: cipher.h:271
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:520
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:504
mbedtls_cipher_type_t
Supported {cipher type, cipher mode} pairs.
Definition: cipher.h:101
struct mbedtls_cipher_info_t mbedtls_cipher_info_t
const mbedtls_cipher_info_t * cipher_info
Definition: cipher.h:284
struct mbedtls_cipher_base_t mbedtls_cipher_base_t
Definition: cipher.h:228
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:470
int(* get_padding)(unsigned char *input, size_t ilen, size_t *data_len)
Definition: cipher.h:299
mbedtls_operation_t operation
Definition: cipher.h:292
mbedtls_cipher_id_t
Supported cipher types.
Definition: cipher.h:81
unsigned char iv[MBEDTLS_MAX_IV_LENGTH]
Definition: cipher.h:310
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_MAX_IV_LENGTH
Definition: cipher.h:221
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.
const char * name
Definition: cipher.h:256
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.
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...
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 initializes and fills the cipher-context structure with the appropriate values...
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().
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:451
struct mbedtls_cipher_context_t mbedtls_cipher_context_t
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().
#define MBEDTLS_MAX_BLOCK_LENGTH
Definition: cipher.h:223
unsigned int key_bitlen
Definition: cipher.h:253
mbedtls_cipher_type_t type
Definition: cipher.h:244
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...
const mbedtls_cipher_base_t * base
Definition: cipher.h:274