third_party/mbedtls/repo/include/mbedtls/cipher_internal.h

   1 /**
   2  * \file cipher_internal.h
   3  *
   4  * \brief Cipher wrappers.
   5  *
   6  * \author Adriaan de Jong <dejong@fox-it.com>
   7  */
   8 /*
   9  *  Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
  10  *  SPDX-License-Identifier: Apache-2.0
  11  *
  12  *  Licensed under the Apache License, Version 2.0 (the "License"); you may
  13  *  not use this file except in compliance with the License.
  14  *  You may obtain a copy of the License at
  15  *
  16  *  http://www.apache.org/licenses/LICENSE-2.0
  17  *
  18  *  Unless required by applicable law or agreed to in writing, software
  19  *  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  20  *  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  21  *  See the License for the specific language governing permissions and
  22  *  limitations under the License.
  23  *
  24  *  This file is part of mbed TLS (https://tls.mbed.org)
  25  */
  26 #ifndef MBEDTLS_CIPHER_WRAP_H
  27 #define MBEDTLS_CIPHER_WRAP_H
  28
  29 #if !defined(MBEDTLS_CONFIG_FILE)
  30 #include "config.h"
  31 #else
  32 #include MBEDTLS_CONFIG_FILE
  33 #endif
  34
  35 #include "cipher.h"
  36
  37 #if defined(MBEDTLS_USE_PSA_CRYPTO)
  38 #include "psa/crypto.h"
  39 #endif /* MBEDTLS_USE_PSA_CRYPTO */
  40
  41 #ifdef __cplusplus
  42 extern "C" {
  43 #endif
  44
  45 /**
  46  * Base cipher information. The non-mode specific functions and values.
  47  */
  48 struct mbedtls_cipher_base_t
  49 {
  50     /** Base Cipher type (e.g. MBEDTLS_CIPHER_ID_AES) */
  51     mbedtls_cipher_id_t cipher;
  52
  53     /** Encrypt using ECB */
  54     int (*ecb_func)( void *ctx, mbedtls_operation_t mode,
  55                      const unsigned char *input, unsigned char *output );
  56
  57 #if defined(MBEDTLS_CIPHER_MODE_CBC)
  58     /** Encrypt using CBC */
  59     int (*cbc_func)( void *ctx, mbedtls_operation_t mode, size_t length,
  60                      unsigned char *iv, const unsigned char *input,
  61                      unsigned char *output );
  62 #endif
  63
  64 #if defined(MBEDTLS_CIPHER_MODE_CFB)
  65     /** Encrypt using CFB (Full length) */
  66     int (*cfb_func)( void *ctx, mbedtls_operation_t mode, size_t length, size_t *iv_off,
  67                      unsigned char *iv, const unsigned char *input,
  68                      unsigned char *output );
  69 #endif
  70
  71 #if defined(MBEDTLS_CIPHER_MODE_OFB)
  72     /** Encrypt using OFB (Full length) */
  73     int (*ofb_func)( void *ctx, size_t length, size_t *iv_off,
  74                      unsigned char *iv,
  75                      const unsigned char *input,
  76                      unsigned char *output );
  77 #endif
  78
  79 #if defined(MBEDTLS_CIPHER_MODE_CTR)
  80     /** Encrypt using CTR */
  81     int (*ctr_func)( void *ctx, size_t length, size_t *nc_off,
  82                      unsigned char *nonce_counter, unsigned char *stream_block,
  83                      const unsigned char *input, unsigned char *output );
  84 #endif
  85
  86 #if defined(MBEDTLS_CIPHER_MODE_XTS)
  87     /** Encrypt or decrypt using XTS. */
  88     int (*xts_func)( void *ctx, mbedtls_operation_t mode, size_t length,
  89                      const unsigned char data_unit[16],
  90                      const unsigned char *input, unsigned char *output );
  91 #endif
  92
  93 #if defined(MBEDTLS_CIPHER_MODE_STREAM)
  94     /** Encrypt using STREAM */
  95     int (*stream_func)( void *ctx, size_t length,
  96                         const unsigned char *input, unsigned char *output );
  97 #endif
  98
  99     /** Set key for encryption purposes */
 100     int (*setkey_enc_func)( void *ctx, const unsigned char *key,
 101                             unsigned int key_bitlen );
 102
 103     /** Set key for decryption purposes */
 104     int (*setkey_dec_func)( void *ctx, const unsigned char *key,
 105                             unsigned int key_bitlen);
 106
 107     /** Allocate a new context */
 108     void * (*ctx_alloc_func)( void );
 109
 110     /** Free the given context */
 111     void (*ctx_free_func)( void *ctx );
 112
 113 };
 114
 115 typedef struct
 116 {
 117     mbedtls_cipher_type_t type;
 118     const mbedtls_cipher_info_t *info;
 119 } mbedtls_cipher_definition_t;
 120
 121 #if defined(MBEDTLS_USE_PSA_CRYPTO)
 122 typedef enum
 123 {
 124     MBEDTLS_CIPHER_PSA_KEY_UNSET = 0,
 125     MBEDTLS_CIPHER_PSA_KEY_OWNED, /* Used for PSA-based cipher contexts which */
 126                                   /* use raw key material internally imported */
 127                                   /* into a allocated key slot, and which     */
 128                                   /* hence need to destroy that key slot      */
 129                                   /* when they are no longer needed.          */
 130     MBEDTLS_CIPHER_PSA_KEY_NOT_OWNED, /* Used for PSA-based cipher contexts   */
 131                                       /* which use a key from a key slot      */
 132                                       /* provided by the user, and which      */
 133                                       /* hence should not be destroyed when   */
 134                                       /* the context is no longer needed.     */
 135 } mbedtls_cipher_psa_key_ownership;
 136
 137 typedef struct
 138 {
 139     psa_algorithm_t alg;
 140     psa_key_handle_t slot;
 141     mbedtls_cipher_psa_key_ownership slot_state;
 142 } mbedtls_cipher_context_psa;
 143 #endif /* MBEDTLS_USE_PSA_CRYPTO */
 144
 145 extern const mbedtls_cipher_definition_t mbedtls_cipher_definitions[];
 146
 147 extern int mbedtls_cipher_supported[];
 148
 149 #ifdef __cplusplus
 150 }
 151 #endif
 152
 153 #endif /* MBEDTLS_CIPHER_WRAP_H */