mbed TLS v2.11.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)
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)
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 
57 #define MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE -0x6080
58 #define MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA -0x6100
59 #define MBEDTLS_ERR_CIPHER_ALLOC_FAILED -0x6180
60 #define MBEDTLS_ERR_CIPHER_INVALID_PADDING -0x6200
61 #define MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED -0x6280
62 #define MBEDTLS_ERR_CIPHER_AUTH_FAILED -0x6300
63 #define MBEDTLS_ERR_CIPHER_INVALID_CONTEXT -0x6380
64 #define MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED -0x6400
66 #define MBEDTLS_CIPHER_VARIABLE_IV_LEN 0x01
67 #define MBEDTLS_CIPHER_VARIABLE_KEY_LEN 0x02
69 #ifdef __cplusplus
70 extern "C" {
71 #endif
72 
80 typedef enum {
91 
99 typedef enum {
173 
175 typedef enum {
187 
189 typedef enum {
196 
198 typedef enum {
203 
204 enum {
213 };
214 
216 #define MBEDTLS_MAX_IV_LENGTH 16
217 
218 #define MBEDTLS_MAX_BLOCK_LENGTH 16
219 
224 
229 
234 typedef struct {
239 
242 
247  unsigned int key_bitlen;
248 
250  const char * name;
251 
256  unsigned int iv_size;
257 
262  int flags;
263 
265  unsigned int block_size;
266 
269 
271 
275 typedef struct {
278 
281 
286 
287 #if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
288 
291  void (*add_padding)( unsigned char *output, size_t olen, size_t data_len );
292  int (*get_padding)( unsigned char *input, size_t ilen, size_t *data_len );
293 #endif
294 
296  unsigned char unprocessed_data[MBEDTLS_MAX_BLOCK_LENGTH];
297 
300 
303  unsigned char iv[MBEDTLS_MAX_IV_LENGTH];
304 
306  size_t iv_size;
307 
309  void *cipher_ctx;
310 
311 #if defined(MBEDTLS_CMAC_C)
312 
313  mbedtls_cmac_context_t *cmac_ctx;
314 #endif
316 
324 const int *mbedtls_cipher_list( void );
325 
336 const mbedtls_cipher_info_t *mbedtls_cipher_info_from_string( const char *cipher_name );
337 
349 
365  int key_bitlen,
366  const mbedtls_cipher_mode_t mode );
367 
372 
379 
380 
400 
409 static inline unsigned int mbedtls_cipher_get_block_size( const mbedtls_cipher_context_t *ctx )
410 {
411  if( NULL == ctx || NULL == ctx->cipher_info )
412  return 0;
413 
414  return ctx->cipher_info->block_size;
415 }
416 
427 {
428  if( NULL == ctx || NULL == ctx->cipher_info )
429  return MBEDTLS_MODE_NONE;
430 
431  return ctx->cipher_info->mode;
432 }
433 
445 {
446  if( NULL == ctx || NULL == ctx->cipher_info )
447  return 0;
448 
449  if( ctx->iv_size != 0 )
450  return (int) ctx->iv_size;
451 
452  return (int) ctx->cipher_info->iv_size;
453 }
454 
464 {
465  if( NULL == ctx || NULL == ctx->cipher_info )
466  return MBEDTLS_CIPHER_NONE;
467 
468  return ctx->cipher_info->type;
469 }
470 
480 static inline const char *mbedtls_cipher_get_name( const mbedtls_cipher_context_t *ctx )
481 {
482  if( NULL == ctx || NULL == ctx->cipher_info )
483  return 0;
484 
485  return ctx->cipher_info->name;
486 }
487 
498 {
499  if( NULL == ctx || NULL == ctx->cipher_info )
501 
502  return (int) ctx->cipher_info->key_bitlen;
503 }
504 
514 {
515  if( NULL == ctx || NULL == ctx->cipher_info )
516  return MBEDTLS_OPERATION_NONE;
517 
518  return ctx->operation;
519 }
520 
537 int mbedtls_cipher_setkey( mbedtls_cipher_context_t *ctx, const unsigned char *key,
538  int key_bitlen, const mbedtls_operation_t operation );
539 
540 #if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
541 
557 #endif /* MBEDTLS_CIPHER_MODE_WITH_PADDING */
558 
576  const unsigned char *iv, size_t iv_len );
577 
588 
589 #if defined(MBEDTLS_GCM_C)
590 
603  const unsigned char *ad, size_t ad_len );
604 #endif /* MBEDTLS_GCM_C */
605 
637 int mbedtls_cipher_update( mbedtls_cipher_context_t *ctx, const unsigned char *input,
638  size_t ilen, unsigned char *output, size_t *olen );
639 
660  unsigned char *output, size_t *olen );
661 
662 #if defined(MBEDTLS_GCM_C)
663 
676  unsigned char *tag, size_t tag_len );
677 
691  const unsigned char *tag, size_t tag_len );
692 #endif /* MBEDTLS_GCM_C */
693 
724  const unsigned char *iv, size_t iv_len,
725  const unsigned char *input, size_t ilen,
726  unsigned char *output, size_t *olen );
727 
728 #if defined(MBEDTLS_CIPHER_MODE_AEAD)
729 
753  const unsigned char *iv, size_t iv_len,
754  const unsigned char *ad, size_t ad_len,
755  const unsigned char *input, size_t ilen,
756  unsigned char *output, size_t *olen,
757  unsigned char *tag, size_t tag_len );
758 
788  const unsigned char *iv, size_t iv_len,
789  const unsigned char *ad, size_t ad_len,
790  const unsigned char *input, size_t ilen,
791  unsigned char *output, size_t *olen,
792  const unsigned char *tag, size_t tag_len );
793 #endif /* MBEDTLS_CIPHER_MODE_AEAD */
794 
795 #ifdef __cplusplus
796 }
797 #endif
798 
799 #endif /* MBEDTLS_CIPHER_H */
mbedtls_operation_t
Definition: cipher.h:198
unsigned int iv_size
Definition: cipher.h:256
mbedtls_cipher_padding_t
Definition: cipher.h:189
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:426
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:409
mbedtls_cipher_mode_t
Definition: cipher.h:175
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...
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:480
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:241
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:265
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:513
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:497
mbedtls_cipher_type_t
Supported {cipher type, cipher mode} pairs.
Definition: cipher.h:99
const mbedtls_cipher_info_t * cipher_info
Definition: cipher.h:277
struct mbedtls_cipher_base_t mbedtls_cipher_base_t
Definition: cipher.h:223
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:463
mbedtls_operation_t operation
Definition: cipher.h:285
mbedtls_cipher_id_t
Supported cipher types.
Definition: cipher.h:80
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:216
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:250
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. Only supported with GCM. Must be called exactly ...
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. Only supported with GCM. Must be called after mbedtls_...
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:444
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. Only supported with GCM. Must be called after mbedtls_ci...
#define MBEDTLS_MAX_BLOCK_LENGTH
Definition: cipher.h:218
unsigned int key_bitlen
Definition: cipher.h:247
mbedtls_cipher_type_t type
Definition: cipher.h:238
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:268