mbed TLS v2.9.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 {
90 
98 typedef enum {
149 
151 typedef enum {
162 
164 typedef enum {
171 
173 typedef enum {
178 
179 enum {
188 };
189 
191 #define MBEDTLS_MAX_IV_LENGTH 16
192 
193 #define MBEDTLS_MAX_BLOCK_LENGTH 16
194 
199 
204 
209 typedef struct {
214 
217 
222  unsigned int key_bitlen;
223 
225  const char * name;
226 
231  unsigned int iv_size;
232 
237  int flags;
238 
240  unsigned int block_size;
241 
244 
246 
250 typedef struct {
253 
256 
261 
262 #if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
263 
266  void (*add_padding)( unsigned char *output, size_t olen, size_t data_len );
267  int (*get_padding)( unsigned char *input, size_t ilen, size_t *data_len );
268 #endif
269 
271  unsigned char unprocessed_data[MBEDTLS_MAX_BLOCK_LENGTH];
272 
275 
277  unsigned char iv[MBEDTLS_MAX_IV_LENGTH];
278 
280  size_t iv_size;
281 
283  void *cipher_ctx;
284 
285 #if defined(MBEDTLS_CMAC_C)
286 
287  mbedtls_cmac_context_t *cmac_ctx;
288 #endif
290 
298 const int *mbedtls_cipher_list( void );
299 
310 const mbedtls_cipher_info_t *mbedtls_cipher_info_from_string( const char *cipher_name );
311 
323 
339  int key_bitlen,
340  const mbedtls_cipher_mode_t mode );
341 
346 
353 
354 
374 
383 static inline unsigned int mbedtls_cipher_get_block_size( const mbedtls_cipher_context_t *ctx )
384 {
385  if( NULL == ctx || NULL == ctx->cipher_info )
386  return 0;
387 
388  return ctx->cipher_info->block_size;
389 }
390 
401 {
402  if( NULL == ctx || NULL == ctx->cipher_info )
403  return MBEDTLS_MODE_NONE;
404 
405  return ctx->cipher_info->mode;
406 }
407 
419 {
420  if( NULL == ctx || NULL == ctx->cipher_info )
421  return 0;
422 
423  if( ctx->iv_size != 0 )
424  return (int) ctx->iv_size;
425 
426  return (int) ctx->cipher_info->iv_size;
427 }
428 
438 {
439  if( NULL == ctx || NULL == ctx->cipher_info )
440  return MBEDTLS_CIPHER_NONE;
441 
442  return ctx->cipher_info->type;
443 }
444 
454 static inline const char *mbedtls_cipher_get_name( const mbedtls_cipher_context_t *ctx )
455 {
456  if( NULL == ctx || NULL == ctx->cipher_info )
457  return 0;
458 
459  return ctx->cipher_info->name;
460 }
461 
472 {
473  if( NULL == ctx || NULL == ctx->cipher_info )
475 
476  return (int) ctx->cipher_info->key_bitlen;
477 }
478 
488 {
489  if( NULL == ctx || NULL == ctx->cipher_info )
490  return MBEDTLS_OPERATION_NONE;
491 
492  return ctx->operation;
493 }
494 
511 int mbedtls_cipher_setkey( mbedtls_cipher_context_t *ctx, const unsigned char *key,
512  int key_bitlen, const mbedtls_operation_t operation );
513 
514 #if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
515 
531 #endif /* MBEDTLS_CIPHER_MODE_WITH_PADDING */
532 
550  const unsigned char *iv, size_t iv_len );
551 
562 
563 #if defined(MBEDTLS_GCM_C)
564 
577  const unsigned char *ad, size_t ad_len );
578 #endif /* MBEDTLS_GCM_C */
579 
611 int mbedtls_cipher_update( mbedtls_cipher_context_t *ctx, const unsigned char *input,
612  size_t ilen, unsigned char *output, size_t *olen );
613 
634  unsigned char *output, size_t *olen );
635 
636 #if defined(MBEDTLS_GCM_C)
637 
650  unsigned char *tag, size_t tag_len );
651 
665  const unsigned char *tag, size_t tag_len );
666 #endif /* MBEDTLS_GCM_C */
667 
698  const unsigned char *iv, size_t iv_len,
699  const unsigned char *input, size_t ilen,
700  unsigned char *output, size_t *olen );
701 
702 #if defined(MBEDTLS_CIPHER_MODE_AEAD)
703 
727  const unsigned char *iv, size_t iv_len,
728  const unsigned char *ad, size_t ad_len,
729  const unsigned char *input, size_t ilen,
730  unsigned char *output, size_t *olen,
731  unsigned char *tag, size_t tag_len );
732 
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  const unsigned char *tag, size_t tag_len );
767 #endif /* MBEDTLS_CIPHER_MODE_AEAD */
768 
769 #ifdef __cplusplus
770 }
771 #endif
772 
773 #endif /* MBEDTLS_CIPHER_H */
mbedtls_operation_t
Definition: cipher.h:173
unsigned int iv_size
Definition: cipher.h:231
mbedtls_cipher_padding_t
Definition: cipher.h:164
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:400
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:383
mbedtls_cipher_mode_t
Definition: cipher.h:151
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:454
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:216
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:240
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:487
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:471
mbedtls_cipher_type_t
Supported {cipher type, cipher mode} pairs.
Definition: cipher.h:98
const mbedtls_cipher_info_t * cipher_info
Definition: cipher.h:252
struct mbedtls_cipher_base_t mbedtls_cipher_base_t
Definition: cipher.h:198
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:437
mbedtls_operation_t operation
Definition: cipher.h:260
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:191
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:225
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:418
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:193
unsigned int key_bitlen
Definition: cipher.h:222
mbedtls_cipher_type_t type
Definition: cipher.h:213
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:243