providers/implementations/include/prov/ciphercommon.h

   1 /*
   2  * Copyright 2019-2020 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the Apache License 2.0 (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 #include <openssl/params.h>
  11 #include <openssl/core_dispatch.h>
  12 #include <openssl/core_names.h>
  13 #include <openssl/evp.h>
  14 #include "internal/cryptlib.h"
  15 #include "crypto/modes.h"
  16
  17 #define MAXCHUNK    ((size_t)1 << (sizeof(long) * 8 - 2))
  18 #define MAXBITCHUNK ((size_t)1 << (sizeof(size_t) * 8 - 4))
  19
  20 #define GENERIC_BLOCK_SIZE 16
  21 #define IV_STATE_UNINITIALISED 0  /* initial state is not initialized */
  22 #define IV_STATE_BUFFERED      1  /* iv has been copied to the iv buffer */
  23 #define IV_STATE_COPIED        2  /* iv has been copied from the iv buffer */
  24 #define IV_STATE_FINISHED      3  /* the iv has been used - so don't reuse it */
  25
  26 #define PROV_CIPHER_FUNC(type, name, args) typedef type (* OSSL_##name##_fn)args
  27
  28 typedef struct prov_cipher_hw_st PROV_CIPHER_HW;
  29 typedef struct prov_cipher_ctx_st PROV_CIPHER_CTX;
  30
  31 typedef int (PROV_CIPHER_HW_FN)(PROV_CIPHER_CTX *dat, unsigned char *out,
  32                                 const unsigned char *in, size_t len);
  33
  34 /* TODO(3.0): VERIFY ME */
  35 #define MAX_TLS_MAC_SIZE    48
  36
  37 struct prov_cipher_ctx_st {
  38     block128_f block;
  39     union {
  40         cbc128_f cbc;
  41         ctr128_f ctr;
  42         ecb128_f ecb;
  43     } stream;
  44
  45     unsigned int mode;
  46     size_t keylen;           /* key size (in bytes) */
  47     size_t ivlen;
  48     size_t blocksize;
  49     size_t bufsz;            /* Number of bytes in buf */
  50     unsigned int cts_mode;   /* Use to set the type for CTS modes */
  51     unsigned int pad : 1;    /* Whether padding should be used or not */
  52     unsigned int enc : 1;    /* Set to 1 for encrypt, or 0 otherwise */
  53     unsigned int iv_set : 1; /* Set when the iv is copied to the iv/oiv buffers */
  54     unsigned int updated : 1; /* Set to 1 during update for one shot ciphers */
  55
  56
  57     unsigned int tlsversion; /* If TLS padding is in use the TLS version number */
  58     unsigned char *tlsmac;   /* tls MAC extracted from the last record */
  59     int alloced;             /*
  60                               * Whether the tlsmac data has been allocated or
  61                               * points into the user buffer.
  62                               */
  63     size_t tlsmacsize;       /* Size of the TLS MAC */
  64     size_t removetlspad;     /*
  65                               * Length of the fixed size data to remove when
  66                               * removing TLS padding (equals mac size plus
  67                               * IV size if applicable)
  68                               */
  69
  70     /*
  71      * num contains the number of bytes of |iv| which are valid for modes that
  72      * manage partial blocks themselves.
  73      */
  74     unsigned int num;
  75     uint64_t flags;
  76
  77     /* The original value of the iv */
  78     unsigned char oiv[GENERIC_BLOCK_SIZE];
  79     /* Buffer of partial blocks processed via update calls */
  80     unsigned char buf[GENERIC_BLOCK_SIZE];
  81     unsigned char iv[GENERIC_BLOCK_SIZE];
  82     const PROV_CIPHER_HW *hw; /* hardware specific functions */
  83     const void *ks; /* Pointer to algorithm specific key data */
  84     OSSL_LIB_CTX *libctx;
  85 };
  86
  87 struct prov_cipher_hw_st {
  88     int (*init)(PROV_CIPHER_CTX *dat, const uint8_t *key, size_t keylen);
  89     PROV_CIPHER_HW_FN *cipher;
  90     void (*copyctx)(PROV_CIPHER_CTX *dst, const PROV_CIPHER_CTX *src);
  91 };
  92
  93 void ossl_cipher_generic_reset_ctx(PROV_CIPHER_CTX *ctx);
  94 OSSL_FUNC_cipher_encrypt_init_fn ossl_cipher_generic_einit;
  95 OSSL_FUNC_cipher_decrypt_init_fn ossl_cipher_generic_dinit;
  96 OSSL_FUNC_cipher_update_fn ossl_cipher_generic_block_update;
  97 OSSL_FUNC_cipher_final_fn ossl_cipher_generic_block_final;
  98 OSSL_FUNC_cipher_update_fn ossl_cipher_generic_stream_update;
  99 OSSL_FUNC_cipher_final_fn ossl_cipher_generic_stream_final;
 100 OSSL_FUNC_cipher_cipher_fn ossl_cipher_generic_cipher;
 101 OSSL_FUNC_cipher_get_ctx_params_fn ossl_cipher_generic_get_ctx_params;
 102 OSSL_FUNC_cipher_set_ctx_params_fn ossl_cipher_generic_set_ctx_params;
 103 OSSL_FUNC_cipher_gettable_params_fn     ossl_cipher_generic_gettable_params;
 104 OSSL_FUNC_cipher_gettable_ctx_params_fn ossl_cipher_generic_gettable_ctx_params;
 105 OSSL_FUNC_cipher_settable_ctx_params_fn ossl_cipher_generic_settable_ctx_params;
 106 OSSL_FUNC_cipher_set_ctx_params_fn ossl_cipher_var_keylen_set_ctx_params;
 107 OSSL_FUNC_cipher_settable_ctx_params_fn ossl_cipher_var_keylen_settable_ctx_params;
 108 OSSL_FUNC_cipher_gettable_ctx_params_fn ossl_cipher_aead_gettable_ctx_params;
 109 OSSL_FUNC_cipher_settable_ctx_params_fn ossl_cipher_aead_settable_ctx_params;
 110
 111 int ossl_cipher_generic_get_params(OSSL_PARAM params[], unsigned int md,
 112                               unsigned long flags,
 113                               size_t kbits, size_t blkbits, size_t ivbits);
 114 void ossl_cipher_generic_initkey(void *vctx, size_t kbits, size_t blkbits,
 115                             size_t ivbits, unsigned int mode, uint64_t flags,
 116                             const PROV_CIPHER_HW *hw, void *provctx);
 117
 118 #define IMPLEMENT_generic_cipher_func(alg, UCALG, lcmode, UCMODE, flags, kbits,\
 119                                       blkbits, ivbits, typ)                    \
 120 const OSSL_DISPATCH ossl_##alg##kbits##lcmode##_functions[] = {                \
 121     { OSSL_FUNC_CIPHER_NEWCTX,                                                 \
 122       (void (*)(void)) alg##_##kbits##_##lcmode##_newctx },                    \
 123     { OSSL_FUNC_CIPHER_FREECTX, (void (*)(void)) alg##_freectx },              \
 124     { OSSL_FUNC_CIPHER_DUPCTX, (void (*)(void)) alg##_dupctx },                \
 125     { OSSL_FUNC_CIPHER_ENCRYPT_INIT, (void (*)(void))ossl_cipher_generic_einit },   \
 126     { OSSL_FUNC_CIPHER_DECRYPT_INIT, (void (*)(void))ossl_cipher_generic_dinit },   \
 127     { OSSL_FUNC_CIPHER_UPDATE, (void (*)(void))ossl_cipher_generic_##typ##_update },\
 128     { OSSL_FUNC_CIPHER_FINAL, (void (*)(void))ossl_cipher_generic_##typ##_final },  \
 129     { OSSL_FUNC_CIPHER_CIPHER, (void (*)(void))ossl_cipher_generic_cipher },        \
 130     { OSSL_FUNC_CIPHER_GET_PARAMS,                                             \
 131       (void (*)(void)) alg##_##kbits##_##lcmode##_get_params },                \
 132     { OSSL_FUNC_CIPHER_GET_CTX_PARAMS,                                         \
 133       (void (*)(void))ossl_cipher_generic_get_ctx_params },                    \
 134     { OSSL_FUNC_CIPHER_SET_CTX_PARAMS,                                         \
 135       (void (*)(void))ossl_cipher_generic_set_ctx_params },                    \
 136     { OSSL_FUNC_CIPHER_GETTABLE_PARAMS,                                        \
 137       (void (*)(void))ossl_cipher_generic_gettable_params },                   \
 138     { OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS,                                    \
 139       (void (*)(void))ossl_cipher_generic_gettable_ctx_params },               \
 140     { OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS,                                    \
 141      (void (*)(void))ossl_cipher_generic_settable_ctx_params },                \
 142     { 0, NULL }                                                                \
 143 };
 144
 145 #define IMPLEMENT_var_keylen_cipher_func(alg, UCALG, lcmode, UCMODE, flags,    \
 146                                          kbits, blkbits, ivbits, typ)          \
 147 const OSSL_DISPATCH ossl_##alg##kbits##lcmode##_functions[] = {                \
 148     { OSSL_FUNC_CIPHER_NEWCTX,                                                 \
 149       (void (*)(void)) alg##_##kbits##_##lcmode##_newctx },                    \
 150     { OSSL_FUNC_CIPHER_FREECTX, (void (*)(void)) alg##_freectx },              \
 151     { OSSL_FUNC_CIPHER_DUPCTX, (void (*)(void)) alg##_dupctx },                \
 152     { OSSL_FUNC_CIPHER_ENCRYPT_INIT, (void (*)(void))ossl_cipher_generic_einit },\
 153     { OSSL_FUNC_CIPHER_DECRYPT_INIT, (void (*)(void))ossl_cipher_generic_dinit },\
 154     { OSSL_FUNC_CIPHER_UPDATE, (void (*)(void))ossl_cipher_generic_##typ##_update },\
 155     { OSSL_FUNC_CIPHER_FINAL, (void (*)(void))ossl_cipher_generic_##typ##_final },  \
 156     { OSSL_FUNC_CIPHER_CIPHER, (void (*)(void))ossl_cipher_generic_cipher },   \
 157     { OSSL_FUNC_CIPHER_GET_PARAMS,                                             \
 158       (void (*)(void)) alg##_##kbits##_##lcmode##_get_params },                \
 159     { OSSL_FUNC_CIPHER_GET_CTX_PARAMS,                                         \
 160       (void (*)(void))ossl_cipher_generic_get_ctx_params },                    \
 161     { OSSL_FUNC_CIPHER_SET_CTX_PARAMS,                                         \
 162       (void (*)(void))ossl_cipher_var_keylen_set_ctx_params },                 \
 163     { OSSL_FUNC_CIPHER_GETTABLE_PARAMS,                                        \
 164       (void (*)(void))ossl_cipher_generic_gettable_params },                   \
 165     { OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS,                                    \
 166       (void (*)(void))ossl_cipher_generic_gettable_ctx_params },               \
 167     { OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS,                                    \
 168      (void (*)(void))ossl_cipher_var_keylen_settable_ctx_params },             \
 169     { 0, NULL }                                                                \
 170 };
 171
 172
 173 #define IMPLEMENT_generic_cipher_genfn(alg, UCALG, lcmode, UCMODE, flags,      \
 174                                        kbits, blkbits, ivbits, typ)            \
 175 static OSSL_FUNC_cipher_get_params_fn alg##_##kbits##_##lcmode##_get_params;   \
 176 static int alg##_##kbits##_##lcmode##_get_params(OSSL_PARAM params[])          \
 177 {                                                                              \
 178     return ossl_cipher_generic_get_params(params, EVP_CIPH_##UCMODE##_MODE,    \
 179                                           flags, kbits, blkbits, ivbits);      \
 180 }                                                                              \
 181 static OSSL_FUNC_cipher_newctx_fn alg##_##kbits##_##lcmode##_newctx;           \
 182 static void * alg##_##kbits##_##lcmode##_newctx(void *provctx)                 \
 183 {                                                                              \
 184      PROV_##UCALG##_CTX *ctx = ossl_prov_is_running() ? OPENSSL_zalloc(sizeof(*ctx))\
 185                                                      : NULL;                   \
 186      if (ctx != NULL) {                                                        \
 187          ossl_cipher_generic_initkey(ctx, kbits, blkbits, ivbits,              \
 188                                      EVP_CIPH_##UCMODE##_MODE, flags,          \
 189                                      ossl_prov_cipher_hw_##alg##_##lcmode(kbits),\
 190                                      provctx);                                 \
 191      }                                                                         \
 192      return ctx;                                                               \
 193 }                                                                              \
 194
 195 #define IMPLEMENT_generic_cipher(alg, UCALG, lcmode, UCMODE, flags, kbits,     \
 196                                  blkbits, ivbits, typ)                         \
 197 IMPLEMENT_generic_cipher_genfn(alg, UCALG, lcmode, UCMODE, flags, kbits,       \
 198                                blkbits, ivbits, typ)                           \
 199 IMPLEMENT_generic_cipher_func(alg, UCALG, lcmode, UCMODE, flags, kbits,        \
 200                               blkbits, ivbits, typ)
 201
 202 #define IMPLEMENT_var_keylen_cipher(alg, UCALG, lcmode, UCMODE, flags, kbits,  \
 203                                     blkbits, ivbits, typ)                      \
 204 IMPLEMENT_generic_cipher_genfn(alg, UCALG, lcmode, UCMODE, flags, kbits,       \
 205                                blkbits, ivbits, typ)                           \
 206 IMPLEMENT_var_keylen_cipher_func(alg, UCALG, lcmode, UCMODE, flags, kbits,     \
 207                                  blkbits, ivbits, typ)
 208
 209 PROV_CIPHER_HW_FN ossl_cipher_hw_generic_cbc;
 210 PROV_CIPHER_HW_FN ossl_cipher_hw_generic_ecb;
 211 PROV_CIPHER_HW_FN ossl_cipher_hw_generic_ofb128;
 212 PROV_CIPHER_HW_FN ossl_cipher_hw_generic_cfb128;
 213 PROV_CIPHER_HW_FN ossl_cipher_hw_generic_cfb8;
 214 PROV_CIPHER_HW_FN ossl_cipher_hw_generic_cfb1;
 215 PROV_CIPHER_HW_FN ossl_cipher_hw_generic_ctr;
 216 PROV_CIPHER_HW_FN ossl_cipher_hw_chunked_cbc;
 217 PROV_CIPHER_HW_FN ossl_cipher_hw_chunked_cfb8;
 218 PROV_CIPHER_HW_FN ossl_cipher_hw_chunked_cfb128;
 219 PROV_CIPHER_HW_FN ossl_cipher_hw_chunked_ofb128;
 220 #define ossl_cipher_hw_chunked_ecb  ossl_cipher_hw_generic_ecb
 221 #define ossl_cipher_hw_chunked_ctr  ossl_cipher_hw_generic_ctr
 222 #define ossl_cipher_hw_chunked_cfb1 ossl_cipher_hw_generic_cfb1
 223
 224 #define IMPLEMENT_CIPHER_HW_OFB(MODE, NAME, CTX_NAME, KEY_NAME, FUNC_PREFIX)   \
 225 static int cipher_hw_##NAME##_##MODE##_cipher(PROV_CIPHER_CTX *ctx,            \
 226                                          unsigned char *out,                   \
 227                                          const unsigned char *in, size_t len)  \
 228 {                                                                              \
 229     int num = ctx->num;                                                        \
 230     KEY_NAME *key = &(((CTX_NAME *)ctx)->ks.ks);                               \
 231                                                                                \
 232     while (len >= MAXCHUNK) {                                                  \
 233         FUNC_PREFIX##_encrypt(in, out, MAXCHUNK, key, ctx->iv, &num);          \
 234         len -= MAXCHUNK;                                                       \
 235         in += MAXCHUNK;                                                        \
 236         out += MAXCHUNK;                                                       \
 237     }                                                                          \
 238     if (len > 0) {                                                             \
 239         FUNC_PREFIX##_encrypt(in, out, (long)len, key, ctx->iv, &num);         \
 240     }                                                                          \
 241     ctx->num = num;                                                            \
 242     return 1;                                                                  \
 243 }
 244
 245 #define IMPLEMENT_CIPHER_HW_ECB(MODE, NAME, CTX_NAME, KEY_NAME, FUNC_PREFIX)   \
 246 static int cipher_hw_##NAME##_##MODE##_cipher(PROV_CIPHER_CTX *ctx,            \
 247                                          unsigned char *out,                   \
 248                                          const unsigned char *in, size_t len)  \
 249 {                                                                              \
 250     size_t i, bl = ctx->blocksize;                                             \
 251     KEY_NAME *key = &(((CTX_NAME *)ctx)->ks.ks);                               \
 252                                                                                \
 253     if (len < bl)                                                              \
 254         return 1;                                                              \
 255     for (i = 0, len -= bl; i <= len; i += bl)                                  \
 256         FUNC_PREFIX##_encrypt(in + i, out + i, key, ctx->enc);                 \
 257     return 1;                                                                  \
 258 }
 259
 260 #define IMPLEMENT_CIPHER_HW_CBC(MODE, NAME, CTX_NAME, KEY_NAME, FUNC_PREFIX)   \
 261 static int cipher_hw_##NAME##_##MODE##_cipher(PROV_CIPHER_CTX *ctx,            \
 262                                          unsigned char *out,                   \
 263                                          const unsigned char *in, size_t len)  \
 264 {                                                                              \
 265     KEY_NAME *key = &(((CTX_NAME *)ctx)->ks.ks);                               \
 266                                                                                \
 267     while (len >= MAXCHUNK) {                                                  \
 268         FUNC_PREFIX##_encrypt(in, out, MAXCHUNK, key, ctx->iv, ctx->enc);      \
 269         len -= MAXCHUNK;                                                       \
 270         in += MAXCHUNK;                                                        \
 271         out += MAXCHUNK;                                                       \
 272     }                                                                          \
 273     if (len > 0)                                                               \
 274         FUNC_PREFIX##_encrypt(in, out, (long)len, key, ctx->iv, ctx->enc);     \
 275     return 1;                                                                  \
 276 }
 277
 278 #define IMPLEMENT_CIPHER_HW_CFB(MODE, NAME, CTX_NAME, KEY_NAME, FUNC_PREFIX)   \
 279 static int cipher_hw_##NAME##_##MODE##_cipher(PROV_CIPHER_CTX *ctx,            \
 280                                          unsigned char *out,                   \
 281                                          const unsigned char *in, size_t len)  \
 282 {                                                                              \
 283     size_t chunk = MAXCHUNK;                                                   \
 284     KEY_NAME *key = &(((CTX_NAME *)ctx)->ks.ks);                               \
 285     int num = ctx->num;                                                        \
 286                                                                                \
 287     if (len < chunk)                                                           \
 288         chunk = len;                                                           \
 289     while (len > 0 && len >= chunk) {                                          \
 290         FUNC_PREFIX##_encrypt(in, out, (long)chunk, key, ctx->iv, &num,        \
 291                               ctx->enc);                                       \
 292         len -= chunk;                                                          \
 293         in += chunk;                                                           \
 294         out += chunk;                                                          \
 295         if (len < chunk)                                                       \
 296             chunk = len;                                                       \
 297     }                                                                          \
 298     ctx->num = num;                                                            \
 299     return 1;                                                                  \
 300 }
 301
 302 #define IMPLEMENT_CIPHER_HW_COPYCTX(name, CTX_TYPE)                            \
 303 static void name(PROV_CIPHER_CTX *dst, const PROV_CIPHER_CTX *src)             \
 304 {                                                                              \
 305     CTX_TYPE *sctx = (CTX_TYPE *)src;                                          \
 306     CTX_TYPE *dctx = (CTX_TYPE *)dst;                                          \
 307                                                                                \
 308     *dctx = *sctx;                                                             \
 309     dst->ks = &dctx->ks.ks;                                                    \
 310 }
 311
 312 #define CIPHER_DEFAULT_GETTABLE_CTX_PARAMS_START(name)                         \
 313 static const OSSL_PARAM name##_known_gettable_ctx_params[] = {                 \
 314     OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN, NULL),                         \
 315     OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_IVLEN, NULL),                          \
 316     OSSL_PARAM_uint(OSSL_CIPHER_PARAM_PADDING, NULL),                          \
 317     OSSL_PARAM_uint(OSSL_CIPHER_PARAM_NUM, NULL),                              \
 318     OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_IV, NULL, 0),                    \
 319     OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_IV_STATE, NULL, 0),
 320
 321 #define CIPHER_DEFAULT_GETTABLE_CTX_PARAMS_END(name)                           \
 322     OSSL_PARAM_END                                                             \
 323 };                                                                             \
 324 const OSSL_PARAM * name##_gettable_ctx_params(ossl_unused void *provctx)       \
 325 {                                                                              \
 326     return name##_known_gettable_ctx_params;                                   \
 327 }
 328
 329 #define CIPHER_DEFAULT_SETTABLE_CTX_PARAMS_START(name)                         \
 330 static const OSSL_PARAM name##_known_settable_ctx_params[] = {                 \
 331     OSSL_PARAM_uint(OSSL_CIPHER_PARAM_PADDING, NULL),                          \
 332     OSSL_PARAM_uint(OSSL_CIPHER_PARAM_NUM, NULL),
 333 #define CIPHER_DEFAULT_SETTABLE_CTX_PARAMS_END(name)                           \
 334     OSSL_PARAM_END                                                             \
 335 };                                                                             \
 336 const OSSL_PARAM * name##_settable_ctx_params(ossl_unused void *provctx)       \
 337 {                                                                              \
 338     return name##_known_settable_ctx_params;                                   \
 339 }
 340
 341 int ossl_cipher_generic_initiv(PROV_CIPHER_CTX *ctx, const unsigned char *iv,
 342                                size_t ivlen);
 343
 344 size_t fillblock(unsigned char *buf, size_t *buflen, size_t blocksize,
 345                  const unsigned char **in, size_t *inlen);
 346 int trailingdata(unsigned char *buf, size_t *buflen, size_t blocksize,
 347                  const unsigned char **in, size_t *inlen);
 348