mbed TLS v2.14.1
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
66 /* MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED is deprecated and should not be used. */
67 #define MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED -0x6400
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 {
95 
103 typedef enum {
179 
181 typedef enum {
194 
196 typedef enum {
203 
205 typedef enum {
210 
211 enum {
220 };
221 
223 #define MBEDTLS_MAX_IV_LENGTH 16
224 
225 #define MBEDTLS_MAX_BLOCK_LENGTH 16
226 
231 
236 
241 typedef struct mbedtls_cipher_info_t
242 {
247 
250 
255  unsigned int key_bitlen;
256 
258  const char * name;
259 
264  unsigned int iv_size;
265 
270  int flags;
271 
273  unsigned int block_size;
274 
277 
279 
284 {
287 
290 
295 
296 #if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
297 
300  void (*add_padding)( unsigned char *output, size_t olen, size_t data_len );
301  int (*get_padding)( unsigned char *input, size_t ilen, size_t *data_len );
302 #endif
303 
306 
309 
312  unsigned char iv[MBEDTLS_MAX_IV_LENGTH];
313 
315  size_t iv_size;
316 
318  void *cipher_ctx;
319 
320 #if defined(MBEDTLS_CMAC_C)
321 
322  mbedtls_cmac_context_t *cmac_ctx;
323 #endif
325 
333 const int *mbedtls_cipher_list( void );
334 
345 const mbedtls_cipher_info_t *mbedtls_cipher_info_from_string( const char *cipher_name );
346 
358 
374  int key_bitlen,
375  const mbedtls_cipher_mode_t mode );
376 
381 
388 
389 
409 
418 static inline unsigned int mbedtls_cipher_get_block_size( const mbedtls_cipher_context_t *ctx )
419 {
420  if( NULL == ctx || NULL == ctx->cipher_info )
421  return 0;
422 
423  return ctx->cipher_info->block_size;
424 }
425 
436 {
437  if( NULL == ctx || NULL == ctx->cipher_info )
438  return MBEDTLS_MODE_NONE;
439 
440  return ctx->cipher_info->mode;
441 }
442 
454 {
455  if( NULL == ctx || NULL == ctx->cipher_info )
456  return 0;
457 
458  if( ctx->iv_size != 0 )
459  return (int) ctx->iv_size;
460 
461  return (int) ctx->cipher_info->iv_size;
462 }
463 
473 {
474  if( NULL == ctx || NULL == ctx->cipher_info )
475  return MBEDTLS_CIPHER_NONE;
476 
477  return ctx->cipher_info->type;
478 }
479 
489 static inline const char *mbedtls_cipher_get_name( const mbedtls_cipher_context_t *ctx )
490 {
491  if( NULL == ctx || NULL == ctx->cipher_info )
492  return 0;
493 
494  return ctx->cipher_info->name;
495 }
496 
507 {
508  if( NULL == ctx || NULL == ctx->cipher_info )
510 
511  return (int) ctx->cipher_info->key_bitlen;
512 }
513 
523 {
524  if( NULL == ctx || NULL == ctx->cipher_info )
525  return MBEDTLS_OPERATION_NONE;
526 
527  return ctx->operation;
528 }
529 
546 int mbedtls_cipher_setkey( mbedtls_cipher_context_t *ctx, const unsigned char *key,
547  int key_bitlen, const mbedtls_operation_t operation );
548 
549 #if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
550 
566 #endif /* MBEDTLS_CIPHER_MODE_WITH_PADDING */
567 
585  const unsigned char *iv, size_t iv_len );
586 
597 
598 #if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CHACHAPOLY_C)
599 
612  const unsigned char *ad, size_t ad_len );
613 #endif /* MBEDTLS_GCM_C || MBEDTLS_CHACHAPOLY_C */
614 
646 int mbedtls_cipher_update( mbedtls_cipher_context_t *ctx, const unsigned char *input,
647  size_t ilen, unsigned char *output, size_t *olen );
648 
669  unsigned char *output, size_t *olen );
670 
671 #if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CHACHAPOLY_C)
672 
685  unsigned char *tag, size_t tag_len );
686 
700  const unsigned char *tag, size_t tag_len );
701 #endif /* MBEDTLS_GCM_C || MBEDTLS_CHACHAPOLY_C */
702 
733  const unsigned char *iv, size_t iv_len,
734  const unsigned char *input, size_t ilen,
735  unsigned char *output, size_t *olen );
736 
737 #if defined(MBEDTLS_CIPHER_MODE_AEAD)
738 
762  const unsigned char *iv, size_t iv_len,
763  const unsigned char *ad, size_t ad_len,
764  const unsigned char *input, size_t ilen,
765  unsigned char *output, size_t *olen,
766  unsigned char *tag, size_t tag_len );
767 
797  const unsigned char *iv, size_t iv_len,
798  const unsigned char *ad, size_t ad_len,
799  const unsigned char *input, size_t ilen,
800  unsigned char *output, size_t *olen,
801  const unsigned char *tag, size_t tag_len );
802 #endif /* MBEDTLS_CIPHER_MODE_AEAD */
803 
804 #ifdef __cplusplus
805 }
806 #endif
807 
808 #endif /* MBEDTLS_CIPHER_H */
unsigned char unprocessed_data[MBEDTLS_MAX_BLOCK_LENGTH]
Definition: cipher.h:305
mbedtls_operation_t
Definition: cipher.h:205
unsigned int iv_size
Definition: cipher.h:264
mbedtls_cipher_padding_t
Definition: cipher.h:196
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:435
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:418
mbedtls_cipher_mode_t
Definition: cipher.h:181
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:300
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:489
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:249
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:273
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:522
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:506
mbedtls_cipher_type_t
Supported {cipher type, cipher mode} pairs.
Definition: cipher.h:103
struct mbedtls_cipher_info_t mbedtls_cipher_info_t
const mbedtls_cipher_info_t * cipher_info
Definition: cipher.h:286
struct mbedtls_cipher_base_t mbedtls_cipher_base_t
Definition: cipher.h:230
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:472
int(* get_padding)(unsigned char *input, size_t ilen, size_t *data_len)
Definition: cipher.h:301
mbedtls_operation_t operation
Definition: cipher.h:294
mbedtls_cipher_id_t
Supported cipher types.
Definition: cipher.h:83
unsigned char iv[MBEDTLS_MAX_IV_LENGTH]
Definition: cipher.h:312
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:223
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:258
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:453
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:225
unsigned int key_bitlen
Definition: cipher.h:255
mbedtls_cipher_type_t type
Definition: cipher.h:246
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:276