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