ReactOS  0.4.15-dev-3451-gf606fec
cipher.h
Go to the documentation of this file.
1 
10 /*
11  * Copyright The Mbed TLS Contributors
12  * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
13  *
14  * This file is provided under the Apache License 2.0, or the
15  * GNU General Public License v2.0 or later.
16  *
17  * **********
18  * Apache License 2.0:
19  *
20  * Licensed under the Apache License, Version 2.0 (the "License"); you may
21  * not use this file except in compliance with the License.
22  * You may obtain a copy of the License at
23  *
24  * http://www.apache.org/licenses/LICENSE-2.0
25  *
26  * Unless required by applicable law or agreed to in writing, software
27  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
28  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
29  * See the License for the specific language governing permissions and
30  * limitations under the License.
31  *
32  * **********
33  *
34  * **********
35  * GNU General Public License v2.0 or later:
36  *
37  * This program is free software; you can redistribute it and/or modify
38  * it under the terms of the GNU General Public License as published by
39  * the Free Software Foundation; either version 2 of the License, or
40  * (at your option) any later version.
41  *
42  * This program is distributed in the hope that it will be useful,
43  * but WITHOUT ANY WARRANTY; without even the implied warranty of
44  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
45  * GNU General Public License for more details.
46  *
47  * You should have received a copy of the GNU General Public License along
48  * with this program; if not, write to the Free Software Foundation, Inc.,
49  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
50  *
51  * **********
52  */
53 
54 #ifndef MBEDTLS_CIPHER_H
55 #define MBEDTLS_CIPHER_H
56 
57 #if !defined(MBEDTLS_CONFIG_FILE)
58 #include "config.h"
59 #else
60 #include MBEDTLS_CONFIG_FILE
61 #endif
62 
63 #include <stddef.h>
64 #include "platform_util.h"
65 
66 #if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CCM_C) || defined(MBEDTLS_CHACHAPOLY_C)
67 #define MBEDTLS_CIPHER_MODE_AEAD
68 #endif
69 
70 #if defined(MBEDTLS_CIPHER_MODE_CBC)
71 #define MBEDTLS_CIPHER_MODE_WITH_PADDING
72 #endif
73 
74 #if defined(MBEDTLS_ARC4_C) || defined(MBEDTLS_CIPHER_NULL_CIPHER) || \
75  defined(MBEDTLS_CHACHA20_C)
76 #define MBEDTLS_CIPHER_MODE_STREAM
77 #endif
78 
79 #if ( defined(__ARMCC_VERSION) || defined(_MSC_VER) ) && \
80  !defined(inline) && !defined(__cplusplus)
81 #define inline __inline
82 #endif
83 
84 #define MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE -0x6080
85 #define MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA -0x6100
86 #define MBEDTLS_ERR_CIPHER_ALLOC_FAILED -0x6180
87 #define MBEDTLS_ERR_CIPHER_INVALID_PADDING -0x6200
88 #define MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED -0x6280
89 #define MBEDTLS_ERR_CIPHER_AUTH_FAILED -0x6300
90 #define MBEDTLS_ERR_CIPHER_INVALID_CONTEXT -0x6380
92 /* MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED is deprecated and should not be used. */
93 #define MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED -0x6400
95 #define MBEDTLS_CIPHER_VARIABLE_IV_LEN 0x01
96 #define MBEDTLS_CIPHER_VARIABLE_KEY_LEN 0x02
98 #ifdef __cplusplus
99 extern "C" {
100 #endif
101 
109 typedef enum {
121 
129 typedef enum {
205 
207 typedef enum {
220 
222 typedef enum {
229 
231 typedef enum {
236 
237 enum {
246 };
247 
249 #define MBEDTLS_MAX_IV_LENGTH 16
250 
251 #define MBEDTLS_MAX_BLOCK_LENGTH 16
252 
257 
262 
267 typedef struct mbedtls_cipher_info_t
268 {
273 
276 
281  unsigned int key_bitlen;
282 
284  const char * name;
285 
290  unsigned int iv_size;
291 
296  int flags;
297 
299  unsigned int block_size;
300 
303 
305 
310 {
313 
316 
321 
322 #if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
323 
326  void (*add_padding)( unsigned char *output, size_t olen, size_t data_len );
327  int (*get_padding)( unsigned char *input, size_t ilen, size_t *data_len );
328 #endif
329 
332 
335 
338  unsigned char iv[MBEDTLS_MAX_IV_LENGTH];
339 
341  size_t iv_size;
342 
344  void *cipher_ctx;
345 
346 #if defined(MBEDTLS_CMAC_C)
347 
348  mbedtls_cmac_context_t *cmac_ctx;
349 #endif
351 
359 const int *mbedtls_cipher_list( void );
360 
372 const mbedtls_cipher_info_t *mbedtls_cipher_info_from_string( const char *cipher_name );
373 
385 
401  int key_bitlen,
402  const mbedtls_cipher_mode_t mode );
403 
410 
421 
422 
442  const mbedtls_cipher_info_t *cipher_info );
443 
452 static inline unsigned int mbedtls_cipher_get_block_size(
454 {
456  if( ctx->cipher_info == NULL )
457  return 0;
458 
459  return ctx->cipher_info->block_size;
460 }
461 
473 {
475  if( ctx->cipher_info == NULL )
476  return MBEDTLS_MODE_NONE;
477 
478  return ctx->cipher_info->mode;
479 }
480 
491 static inline int mbedtls_cipher_get_iv_size(
493 {
495  if( ctx->cipher_info == NULL )
496  return 0;
497 
498  if( ctx->iv_size != 0 )
499  return (int) ctx->iv_size;
500 
501  return (int) ctx->cipher_info->iv_size;
502 }
503 
514 {
517  if( ctx->cipher_info == NULL )
518  return MBEDTLS_CIPHER_NONE;
519 
520  return ctx->cipher_info->type;
521 }
522 
532 static inline const char *mbedtls_cipher_get_name(
534 {
536  if( ctx->cipher_info == NULL )
537  return 0;
538 
539  return ctx->cipher_info->name;
540 }
541 
553 {
556  if( ctx->cipher_info == NULL )
558 
559  return (int) ctx->cipher_info->key_bitlen;
560 }
561 
572 {
575  if( ctx->cipher_info == NULL )
576  return MBEDTLS_OPERATION_NONE;
577 
578  return ctx->operation;
579 }
580 
598  const unsigned char *key,
599  int key_bitlen,
600  const mbedtls_operation_t operation );
601 
602 #if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
603 
621 #endif /* MBEDTLS_CIPHER_MODE_WITH_PADDING */
622 
642  const unsigned char *iv,
643  size_t iv_len );
644 
655 
656 #if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CHACHAPOLY_C)
657 
672  const unsigned char *ad, size_t ad_len );
673 #endif /* MBEDTLS_GCM_C || MBEDTLS_CHACHAPOLY_C */
674 
709 int mbedtls_cipher_update( mbedtls_cipher_context_t *ctx, const unsigned char *input,
710  size_t ilen, unsigned char *output, size_t *olen );
711 
735  unsigned char *output, size_t *olen );
736 
737 #if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CHACHAPOLY_C)
738 
755  unsigned char *tag, size_t tag_len );
756 
771  const unsigned char *tag, size_t tag_len );
772 #endif /* MBEDTLS_GCM_C || MBEDTLS_CHACHAPOLY_C */
773 
808  const unsigned char *iv, size_t iv_len,
809  const unsigned char *input, size_t ilen,
810  unsigned char *output, size_t *olen );
811 
812 #if defined(MBEDTLS_CIPHER_MODE_AEAD)
813 
844  const unsigned char *iv, size_t iv_len,
845  const unsigned char *ad, size_t ad_len,
846  const unsigned char *input, size_t ilen,
847  unsigned char *output, size_t *olen,
848  unsigned char *tag, size_t tag_len );
849 
886  const unsigned char *iv, size_t iv_len,
887  const unsigned char *ad, size_t ad_len,
888  const unsigned char *input, size_t ilen,
889  unsigned char *output, size_t *olen,
890  const unsigned char *tag, size_t tag_len );
891 #endif /* MBEDTLS_CIPHER_MODE_AEAD */
892 
893 #ifdef __cplusplus
894 }
895 #endif
896 
897 #endif /* MBEDTLS_CIPHER_H */
unsigned char unprocessed_data[MBEDTLS_MAX_BLOCK_LENGTH]
Definition: cipher.h:331
mbedtls_operation_t
Definition: cipher.h:231
static UCHAR ULONG UCHAR ULONG UCHAR * output
Definition: bcrypt.c:29
unsigned int iv_size
Definition: cipher.h:290
struct png_info_def **typedef void(__cdecl typeof(png_destroy_read_struct))(struct png_struct_def **
Definition: typeof.h:49
mbedtls_cipher_padding_t
Definition: cipher.h:222
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:471
#define MBEDTLS_INTERNAL_VALIDATE_RET(cond, ret)
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:452
mbedtls_cipher_mode_t
Definition: cipher.h:207
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:326
Definition: ecma_167.h:138
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:532
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:275
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:299
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:570
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:551
mbedtls_cipher_type_t
Supported {cipher type, cipher mode} pairs.
Definition: cipher.h:129
struct mbedtls_cipher_info_t mbedtls_cipher_info_t
Common and shared functions used by multiple modules in the Mbed TLS library.
const mbedtls_cipher_info_t * cipher_info
Definition: cipher.h:312
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:512
int(* get_padding)(unsigned char *input, size_t ilen, size_t *data_len)
Definition: cipher.h:327
mbedtls_operation_t operation
Definition: cipher.h:320
mbedtls_cipher_id_t
Supported cipher types.
Definition: cipher.h:109
unsigned char iv[MBEDTLS_MAX_IV_LENGTH]
Definition: cipher.h:338
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:249
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:284
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.
GLenum mode
Definition: glext.h:6217
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.
GLenum GLenum GLenum input
Definition: glext.h:9031
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....
#define NULL
Definition: types.h:112
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....
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:491
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....
#define MBEDTLS_MAX_BLOCK_LENGTH
Definition: cipher.h:251
unsigned int key_bitlen
Definition: cipher.h:281
mbedtls_cipher_type_t type
Definition: cipher.h:272
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:302
Definition: path.c:41
unsigned int(__cdecl typeof(jpeg_read_scanlines))(struct jpeg_decompress_struct *
Definition: typeof.h:31