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 pad : 1;    /* Whether padding should be used or not */
  51     unsigned int enc : 1;    /* Set to 1 for encrypt, or 0 otherwise */
  52     unsigned int iv_set : 1; /* Set when the iv is copied to the iv/oiv buffers */
  53
  54     unsigned int tlsversion; /* If TLS padding is in use the TLS version number */
  55     unsigned char *tlsmac;   /* tls MAC extracted from the last record */
  56     int alloced;             /*
  57                               * Whether the tlsmac data has been allocated or
  58                               * points into the user buffer.
  59                               */
  60     size_t tlsmacsize;       /* Size of the TLS MAC */
  61     size_t removetlspad;     /*
  62                               * Length of the fixed size data to remove when
  63                               * removing TLS padding (equals mac size plus
  64                               * IV size if applicable)
  65                               */
  66
  67     /*
  68      * num contains the number of bytes of |iv| which are valid for modes that
  69      * manage partial blocks themselves.
  70      */
  71     unsigned int num;
  72     uint64_t flags;
  73
  74     /* The original value of the iv */
  75     unsigned char oiv[GENERIC_BLOCK_SIZE];
  76     /* Buffer of partial blocks processed via update calls */
  77     unsigned char buf[GENERIC_BLOCK_SIZE];
  78     unsigned char iv[GENERIC_BLOCK_SIZE];
  79     const PROV_CIPHER_HW *hw; /* hardware specific functions */
  80     const void *ks; /* Pointer to algorithm specific key data */
  81     OPENSSL_CTX *libctx;
  82 };
  83
  84 struct prov_cipher_hw_st {
  85     int (*init)(PROV_CIPHER_CTX *dat, const uint8_t *key, size_t keylen);
  86     PROV_CIPHER_HW_FN *cipher;
  87     void (*copyctx)(PROV_CIPHER_CTX *dst, const PROV_CIPHER_CTX *src);
  88 };
  89
  90 OSSL_FUNC_cipher_encrypt_init_fn cipher_generic_einit;
  91 OSSL_FUNC_cipher_decrypt_init_fn cipher_generic_dinit;
  92 OSSL_FUNC_cipher_update_fn cipher_generic_block_update;
  93 OSSL_FUNC_cipher_final_fn cipher_generic_block_final;
  94 OSSL_FUNC_cipher_update_fn cipher_generic_stream_update;
  95 OSSL_FUNC_cipher_final_fn cipher_generic_stream_final;
  96 OSSL_FUNC_cipher_cipher_fn cipher_generic_cipher;
  97 OSSL_FUNC_cipher_get_ctx_params_fn cipher_generic_get_ctx_params;
  98 OSSL_FUNC_cipher_set_ctx_params_fn cipher_generic_set_ctx_params;
  99 OSSL_FUNC_cipher_gettable_params_fn     cipher_generic_gettable_params;
 100 OSSL_FUNC_cipher_gettable_ctx_params_fn cipher_generic_gettable_ctx_params;
 101 OSSL_FUNC_cipher_settable_ctx_params_fn cipher_generic_settable_ctx_params;
 102 OSSL_FUNC_cipher_set_ctx_params_fn cipher_var_keylen_set_ctx_params;
 103 OSSL_FUNC_cipher_settable_ctx_params_fn cipher_var_keylen_settable_ctx_params;
 104 OSSL_FUNC_cipher_gettable_ctx_params_fn cipher_aead_gettable_ctx_params;
 105 OSSL_FUNC_cipher_settable_ctx_params_fn cipher_aead_settable_ctx_params;
 106 int cipher_generic_get_params(OSSL_PARAM params[], unsigned int md,
 107                               unsigned long flags,
 108                               size_t kbits, size_t blkbits, size_t ivbits);
 109 void cipher_generic_initkey(void *vctx, size_t kbits, size_t blkbits,
 110                             size_t ivbits, unsigned int mode, uint64_t flags,
 111                             const PROV_CIPHER_HW *hw, void *provctx);
 112
 113 #define IMPLEMENT_generic_cipher_func(alg, UCALG, lcmode, UCMODE, flags, kbits,\
 114                                       blkbits, ivbits, typ)                    \
 115 const OSSL_DISPATCH alg##kbits##lcmode##_functions[] = {                       \
 116     { OSSL_FUNC_CIPHER_NEWCTX,                                                 \
 117       (void (*)(void)) alg##_##kbits##_##lcmode##_newctx },                    \
 118     { OSSL_FUNC_CIPHER_FREECTX, (void (*)(void)) alg##_freectx },              \
 119     { OSSL_FUNC_CIPHER_DUPCTX, (void (*)(void)) alg##_dupctx },                \
 120     { OSSL_FUNC_CIPHER_ENCRYPT_INIT, (void (*)(void))cipher_generic_einit },   \
 121     { OSSL_FUNC_CIPHER_DECRYPT_INIT, (void (*)(void))cipher_generic_dinit },   \
 122     { OSSL_FUNC_CIPHER_UPDATE, (void (*)(void))cipher_generic_##typ##_update },\
 123     { OSSL_FUNC_CIPHER_FINAL, (void (*)(void))cipher_generic_##typ##_final },  \
 124     { OSSL_FUNC_CIPHER_CIPHER, (void (*)(void))cipher_generic_cipher },        \
 125     { OSSL_FUNC_CIPHER_GET_PARAMS,                                             \
 126       (void (*)(void)) alg##_##kbits##_##lcmode##_get_params },                \
 127     { OSSL_FUNC_CIPHER_GET_CTX_PARAMS,                                         \
 128       (void (*)(void))cipher_generic_get_ctx_params },                         \
 129     { OSSL_FUNC_CIPHER_SET_CTX_PARAMS,                                         \
 130       (void (*)(void))cipher_generic_set_ctx_params },                         \
 131     { OSSL_FUNC_CIPHER_GETTABLE_PARAMS,                                        \
 132       (void (*)(void))cipher_generic_gettable_params },                        \
 133     { OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS,                                    \
 134       (void (*)(void))cipher_generic_gettable_ctx_params },                    \
 135     { OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS,                                    \
 136      (void (*)(void))cipher_generic_settable_ctx_params },                     \
 137     { 0, NULL }                                                                \
 138 };
 139
 140 #define IMPLEMENT_var_keylen_cipher_func(alg, UCALG, lcmode, UCMODE, flags,    \
 141                                          kbits, blkbits, ivbits, typ)          \
 142 const OSSL_DISPATCH alg##kbits##lcmode##_functions[] = {                       \
 143     { OSSL_FUNC_CIPHER_NEWCTX,                                                 \
 144       (void (*)(void)) alg##_##kbits##_##lcmode##_newctx },                    \
 145     { OSSL_FUNC_CIPHER_FREECTX, (void (*)(void)) alg##_freectx },              \
 146     { OSSL_FUNC_CIPHER_DUPCTX, (void (*)(void)) alg##_dupctx },                \
 147     { OSSL_FUNC_CIPHER_ENCRYPT_INIT, (void (*)(void))cipher_generic_einit },   \
 148     { OSSL_FUNC_CIPHER_DECRYPT_INIT, (void (*)(void))cipher_generic_dinit },   \
 149     { OSSL_FUNC_CIPHER_UPDATE, (void (*)(void))cipher_generic_##typ##_update },\
 150     { OSSL_FUNC_CIPHER_FINAL, (void (*)(void))cipher_generic_##typ##_final },  \
 151     { OSSL_FUNC_CIPHER_CIPHER, (void (*)(void))cipher_generic_cipher },        \
 152     { OSSL_FUNC_CIPHER_GET_PARAMS,                                             \
 153       (void (*)(void)) alg##_##kbits##_##lcmode##_get_params },                \
 154     { OSSL_FUNC_CIPHER_GET_CTX_PARAMS,                                         \
 155       (void (*)(void))cipher_generic_get_ctx_params },                         \
 156     { OSSL_FUNC_CIPHER_SET_CTX_PARAMS,                                         \
 157       (void (*)(void))cipher_var_keylen_set_ctx_params },                      \
 158     { OSSL_FUNC_CIPHER_GETTABLE_PARAMS,                                        \
 159       (void (*)(void))cipher_generic_gettable_params },                        \
 160     { OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS,                                    \
 161       (void (*)(void))cipher_generic_gettable_ctx_params },                    \
 162     { OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS,                                    \
 163      (void (*)(void))cipher_var_keylen_settable_ctx_params },                  \
 164     { 0, NULL }                                                                \
 165 };
 166
 167
 168 #define IMPLEMENT_generic_cipher_genfn(alg, UCALG, lcmode, UCMODE, flags,      \
 169                                        kbits, blkbits, ivbits, typ)            \
 170 static OSSL_FUNC_cipher_get_params_fn alg##_##kbits##_##lcmode##_get_params;     \
 171 static int alg##_##kbits##_##lcmode##_get_params(OSSL_PARAM params[])          \
 172 {                                                                              \
 173     return cipher_generic_get_params(params, EVP_CIPH_##UCMODE##_MODE, flags,  \
 174                                      kbits, blkbits, ivbits);                  \
 175 }                                                                              \
 176 static OSSL_FUNC_cipher_newctx_fn alg##_##kbits##_##lcmode##_newctx;             \
 177 static void * alg##_##kbits##_##lcmode##_newctx(void *provctx)                 \
 178 {                                                                              \
 179      PROV_##UCALG##_CTX *ctx = OPENSSL_zalloc(sizeof(*ctx));                   \
 180      if (ctx != NULL) {                                                        \
 181          cipher_generic_initkey(ctx, kbits, blkbits, ivbits,                   \
 182                                 EVP_CIPH_##UCMODE##_MODE, flags,               \
 183                                 PROV_CIPHER_HW_##alg##_##lcmode(kbits),        \
 184                                 provctx);                                      \
 185      }                                                                         \
 186      return ctx;                                                               \
 187 }                                                                              \
 188
 189 #define IMPLEMENT_generic_cipher(alg, UCALG, lcmode, UCMODE, flags, kbits,     \
 190                                  blkbits, ivbits, typ)                         \
 191 IMPLEMENT_generic_cipher_genfn(alg, UCALG, lcmode, UCMODE, flags, kbits,       \
 192                                blkbits, ivbits, typ)                           \
 193 IMPLEMENT_generic_cipher_func(alg, UCALG, lcmode, UCMODE, flags, kbits,        \
 194                               blkbits, ivbits, typ)
 195
 196 #define IMPLEMENT_var_keylen_cipher(alg, UCALG, lcmode, UCMODE, flags, kbits,  \
 197                                     blkbits, ivbits, typ)                      \
 198 IMPLEMENT_generic_cipher_genfn(alg, UCALG, lcmode, UCMODE, flags, kbits,       \
 199                                blkbits, ivbits, typ)                           \
 200 IMPLEMENT_var_keylen_cipher_func(alg, UCALG, lcmode, UCMODE, flags, kbits,     \
 201                                  blkbits, ivbits, typ)
 202
 203 PROV_CIPHER_HW_FN cipher_hw_generic_cbc;
 204 PROV_CIPHER_HW_FN cipher_hw_generic_ecb;
 205 PROV_CIPHER_HW_FN cipher_hw_generic_ofb128;
 206 PROV_CIPHER_HW_FN cipher_hw_generic_cfb128;
 207 PROV_CIPHER_HW_FN cipher_hw_generic_cfb8;
 208 PROV_CIPHER_HW_FN cipher_hw_generic_cfb1;
 209 PROV_CIPHER_HW_FN cipher_hw_generic_ctr;
 210 PROV_CIPHER_HW_FN cipher_hw_chunked_cbc;
 211 PROV_CIPHER_HW_FN cipher_hw_chunked_cfb8;
 212 PROV_CIPHER_HW_FN cipher_hw_chunked_cfb128;
 213 PROV_CIPHER_HW_FN cipher_hw_chunked_ofb128;
 214 #define cipher_hw_chunked_ecb  cipher_hw_generic_ecb
 215 #define cipher_hw_chunked_ctr  cipher_hw_generic_ctr
 216 #define cipher_hw_chunked_cfb1 cipher_hw_generic_cfb1
 217
 218 #define IMPLEMENT_CIPHER_HW_OFB(MODE, NAME, CTX_NAME, KEY_NAME, FUNC_PREFIX)   \
 219 static int cipher_hw_##NAME##_##MODE##_cipher(PROV_CIPHER_CTX *ctx,            \
 220                                          unsigned char *out,                   \
 221                                          const unsigned char *in, size_t len)  \
 222 {                                                                              \
 223     int num = ctx->num;                                                        \
 224     KEY_NAME *key = &(((CTX_NAME *)ctx)->ks.ks);                               \
 225                                                                                \
 226     while (len >= MAXCHUNK) {                                                  \
 227         FUNC_PREFIX##_encrypt(in, out, MAXCHUNK, key, ctx->iv, &num);          \
 228         len -= MAXCHUNK;                                                       \
 229         in += MAXCHUNK;                                                        \
 230         out += MAXCHUNK;                                                       \
 231     }                                                                          \
 232     if (len > 0) {                                                             \
 233         FUNC_PREFIX##_encrypt(in, out, (long)len, key, ctx->iv, &num);         \
 234     }                                                                          \
 235     ctx->num = num;                                                            \
 236     return 1;                                                                  \
 237 }
 238
 239 #define IMPLEMENT_CIPHER_HW_ECB(MODE, NAME, CTX_NAME, KEY_NAME, FUNC_PREFIX)   \
 240 static int cipher_hw_##NAME##_##MODE##_cipher(PROV_CIPHER_CTX *ctx,            \
 241                                          unsigned char *out,                   \
 242                                          const unsigned char *in, size_t len)  \
 243 {                                                                              \
 244     size_t i, bl = ctx->blocksize;                                             \
 245     KEY_NAME *key = &(((CTX_NAME *)ctx)->ks.ks);                               \
 246                                                                                \
 247     if (len < bl)                                                              \
 248         return 1;                                                              \
 249     for (i = 0, len -= bl; i <= len; i += bl)                                  \
 250         FUNC_PREFIX##_encrypt(in + i, out + i, key, ctx->enc);                 \
 251     return 1;                                                                  \
 252 }
 253
 254 #define IMPLEMENT_CIPHER_HW_CBC(MODE, NAME, CTX_NAME, KEY_NAME, FUNC_PREFIX)   \
 255 static int cipher_hw_##NAME##_##MODE##_cipher(PROV_CIPHER_CTX *ctx,            \
 256                                          unsigned char *out,                   \
 257                                          const unsigned char *in, size_t len)  \
 258 {                                                                              \
 259     KEY_NAME *key = &(((CTX_NAME *)ctx)->ks.ks);                               \
 260                                                                                \
 261     while (len >= MAXCHUNK) {                                                  \
 262         FUNC_PREFIX##_encrypt(in, out, MAXCHUNK, key, ctx->iv, ctx->enc);      \
 263         len -= MAXCHUNK;                                                       \
 264         in += MAXCHUNK;                                                        \
 265         out += MAXCHUNK;                                                       \
 266     }                                                                          \
 267     if (len > 0)                                                               \
 268         FUNC_PREFIX##_encrypt(in, out, (long)len, key, ctx->iv, ctx->enc);     \
 269     return 1;                                                                  \
 270 }
 271
 272 #define IMPLEMENT_CIPHER_HW_CFB(MODE, NAME, CTX_NAME, KEY_NAME, FUNC_PREFIX)   \
 273 static int cipher_hw_##NAME##_##MODE##_cipher(PROV_CIPHER_CTX *ctx,            \
 274                                          unsigned char *out,                   \
 275                                          const unsigned char *in, size_t len)  \
 276 {                                                                              \
 277     size_t chunk = MAXCHUNK;                                                   \
 278     KEY_NAME *key = &(((CTX_NAME *)ctx)->ks.ks);                               \
 279     int num = ctx->num;                                                        \
 280                                                                                \
 281     if (len < chunk)                                                           \
 282         chunk = len;                                                           \
 283     while (len > 0 && len >= chunk) {                                          \
 284         FUNC_PREFIX##_encrypt(in, out, (long)chunk, key, ctx->iv, &num,        \
 285                               ctx->enc);                                       \
 286         len -= chunk;                                                          \
 287         in += chunk;                                                           \
 288         out += chunk;                                                          \
 289         if (len < chunk)                                                       \
 290             chunk = len;                                                       \
 291     }                                                                          \
 292     ctx->num = num;                                                            \
 293     return 1;                                                                  \
 294 }
 295
 296 #define IMPLEMENT_CIPHER_HW_COPYCTX(name, CTX_TYPE)                            \
 297 static void name(PROV_CIPHER_CTX *dst, const PROV_CIPHER_CTX *src)             \
 298 {                                                                              \
 299     CTX_TYPE *sctx = (CTX_TYPE *)src;                                          \
 300     CTX_TYPE *dctx = (CTX_TYPE *)dst;                                          \
 301                                                                                \
 302     *dctx = *sctx;                                                             \
 303     dst->ks = &dctx->ks.ks;                                                    \
 304 }
 305
 306 #define CIPHER_DEFAULT_GETTABLE_CTX_PARAMS_START(name)                         \
 307 static const OSSL_PARAM name##_known_gettable_ctx_params[] = {                 \
 308     OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN, NULL),                         \
 309     OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_IVLEN, NULL),                          \
 310     OSSL_PARAM_uint(OSSL_CIPHER_PARAM_PADDING, NULL),                          \
 311     OSSL_PARAM_uint(OSSL_CIPHER_PARAM_NUM, NULL),                              \
 312     OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_IV, NULL, 0),
 313
 314 #define CIPHER_DEFAULT_GETTABLE_CTX_PARAMS_END(name)                           \
 315     OSSL_PARAM_END                                                             \
 316 };                                                                             \
 317 const OSSL_PARAM * name##_gettable_ctx_params(void)                            \
 318 {                                                                              \
 319     return name##_known_gettable_ctx_params;                                   \
 320 }
 321
 322 #define CIPHER_DEFAULT_SETTABLE_CTX_PARAMS_START(name)                         \
 323 static const OSSL_PARAM name##_known_settable_ctx_params[] = {                 \
 324     OSSL_PARAM_uint(OSSL_CIPHER_PARAM_PADDING, NULL),                          \
 325     OSSL_PARAM_uint(OSSL_CIPHER_PARAM_NUM, NULL),
 326 #define CIPHER_DEFAULT_SETTABLE_CTX_PARAMS_END(name)                           \
 327     OSSL_PARAM_END                                                             \
 328 };                                                                             \
 329 const OSSL_PARAM * name##_settable_ctx_params(void)                            \
 330 {                                                                              \
 331     return name##_known_settable_ctx_params;                                   \
 332 }
 333
 334 int cipher_generic_initiv(PROV_CIPHER_CTX *ctx, const unsigned char *iv,
 335                           size_t ivlen);
 336
 337 size_t fillblock(unsigned char *buf, size_t *buflen, size_t blocksize,
 338                  const unsigned char **in, size_t *inlen);
 339 int trailingdata(unsigned char *buf, size_t *buflen, size_t blocksize,
 340                  const unsigned char **in, size_t *inlen);
 341