include/crypto/evp.h

   1 /*
   2  * Copyright 2015-2018 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/evp.h>
  11 #include <openssl/core_numbers.h>
  12 #include "internal/refcount.h"
  13
  14 /*
  15  * Don't free up md_ctx->pctx in EVP_MD_CTX_reset, use the reserved flag
  16  * values in evp.h
  17  */
  18 #define EVP_MD_CTX_FLAG_KEEP_PKEY_CTX   0x0400
  19
  20 struct evp_pkey_ctx_st {
  21     /* Actual operation */
  22     int operation;
  23
  24     union {
  25         struct {
  26             EVP_KEYEXCH *exchange;
  27             void *exchprovctx;
  28         } kex;
  29
  30         struct {
  31             EVP_SIGNATURE *signature;
  32             void *sigprovctx;
  33         } sig;
  34     } op;
  35
  36     /* Legacy fields below */
  37
  38     /* Method associated with this operation */
  39     const EVP_PKEY_METHOD *pmeth;
  40     /* Engine that implements this method or NULL if builtin */
  41     ENGINE *engine;
  42     /* Key: may be NULL */
  43     EVP_PKEY *pkey;
  44     /* Peer key for key agreement, may be NULL */
  45     EVP_PKEY *peerkey;
  46     /* Algorithm specific data */
  47     void *data;
  48     /* Application specific data */
  49     void *app_data;
  50     /* Keygen callback */
  51     EVP_PKEY_gen_cb *pkey_gencb;
  52     /* implementation specific keygen data */
  53     int *keygen_info;
  54     int keygen_info_count;
  55 } /* EVP_PKEY_CTX */ ;
  56
  57 #define EVP_PKEY_FLAG_DYNAMIC   1
  58
  59 struct evp_pkey_method_st {
  60     int pkey_id;
  61     int flags;
  62     int (*init) (EVP_PKEY_CTX *ctx);
  63     int (*copy) (EVP_PKEY_CTX *dst, const EVP_PKEY_CTX *src);
  64     void (*cleanup) (EVP_PKEY_CTX *ctx);
  65     int (*paramgen_init) (EVP_PKEY_CTX *ctx);
  66     int (*paramgen) (EVP_PKEY_CTX *ctx, EVP_PKEY *pkey);
  67     int (*keygen_init) (EVP_PKEY_CTX *ctx);
  68     int (*keygen) (EVP_PKEY_CTX *ctx, EVP_PKEY *pkey);
  69     int (*sign_init) (EVP_PKEY_CTX *ctx);
  70     int (*sign) (EVP_PKEY_CTX *ctx, unsigned char *sig, size_t *siglen,
  71                  const unsigned char *tbs, size_t tbslen);
  72     int (*verify_init) (EVP_PKEY_CTX *ctx);
  73     int (*verify) (EVP_PKEY_CTX *ctx,
  74                    const unsigned char *sig, size_t siglen,
  75                    const unsigned char *tbs, size_t tbslen);
  76     int (*verify_recover_init) (EVP_PKEY_CTX *ctx);
  77     int (*verify_recover) (EVP_PKEY_CTX *ctx,
  78                            unsigned char *rout, size_t *routlen,
  79                            const unsigned char *sig, size_t siglen);
  80     int (*signctx_init) (EVP_PKEY_CTX *ctx, EVP_MD_CTX *mctx);
  81     int (*signctx) (EVP_PKEY_CTX *ctx, unsigned char *sig, size_t *siglen,
  82                     EVP_MD_CTX *mctx);
  83     int (*verifyctx_init) (EVP_PKEY_CTX *ctx, EVP_MD_CTX *mctx);
  84     int (*verifyctx) (EVP_PKEY_CTX *ctx, const unsigned char *sig, int siglen,
  85                       EVP_MD_CTX *mctx);
  86     int (*encrypt_init) (EVP_PKEY_CTX *ctx);
  87     int (*encrypt) (EVP_PKEY_CTX *ctx, unsigned char *out, size_t *outlen,
  88                     const unsigned char *in, size_t inlen);
  89     int (*decrypt_init) (EVP_PKEY_CTX *ctx);
  90     int (*decrypt) (EVP_PKEY_CTX *ctx, unsigned char *out, size_t *outlen,
  91                     const unsigned char *in, size_t inlen);
  92     int (*derive_init) (EVP_PKEY_CTX *ctx);
  93     int (*derive) (EVP_PKEY_CTX *ctx, unsigned char *key, size_t *keylen);
  94     int (*ctrl) (EVP_PKEY_CTX *ctx, int type, int p1, void *p2);
  95     int (*ctrl_str) (EVP_PKEY_CTX *ctx, const char *type, const char *value);
  96     int (*digestsign) (EVP_MD_CTX *ctx, unsigned char *sig, size_t *siglen,
  97                        const unsigned char *tbs, size_t tbslen);
  98     int (*digestverify) (EVP_MD_CTX *ctx, const unsigned char *sig,
  99                          size_t siglen, const unsigned char *tbs,
 100                          size_t tbslen);
 101     int (*check) (EVP_PKEY *pkey);
 102     int (*public_check) (EVP_PKEY *pkey);
 103     int (*param_check) (EVP_PKEY *pkey);
 104
 105     int (*digest_custom) (EVP_PKEY_CTX *ctx, EVP_MD_CTX *mctx);
 106 } /* EVP_PKEY_METHOD */ ;
 107
 108 DEFINE_STACK_OF_CONST(EVP_PKEY_METHOD)
 109
 110 void evp_pkey_set_cb_translate(BN_GENCB *cb, EVP_PKEY_CTX *ctx);
 111
 112 const EVP_PKEY_METHOD *cmac_pkey_method(void);
 113 const EVP_PKEY_METHOD *dh_pkey_method(void);
 114 const EVP_PKEY_METHOD *dhx_pkey_method(void);
 115 const EVP_PKEY_METHOD *dsa_pkey_method(void);
 116 const EVP_PKEY_METHOD *ec_pkey_method(void);
 117 const EVP_PKEY_METHOD *sm2_pkey_method(void);
 118 const EVP_PKEY_METHOD *ecx25519_pkey_method(void);
 119 const EVP_PKEY_METHOD *ecx448_pkey_method(void);
 120 const EVP_PKEY_METHOD *ed25519_pkey_method(void);
 121 const EVP_PKEY_METHOD *ed448_pkey_method(void);
 122 const EVP_PKEY_METHOD *hmac_pkey_method(void);
 123 const EVP_PKEY_METHOD *rsa_pkey_method(void);
 124 const EVP_PKEY_METHOD *rsa_pss_pkey_method(void);
 125 const EVP_PKEY_METHOD *scrypt_pkey_method(void);
 126 const EVP_PKEY_METHOD *tls1_prf_pkey_method(void);
 127 const EVP_PKEY_METHOD *hkdf_pkey_method(void);
 128 const EVP_PKEY_METHOD *poly1305_pkey_method(void);
 129 const EVP_PKEY_METHOD *siphash_pkey_method(void);
 130
 131 struct evp_mac_st {
 132     OSSL_PROVIDER *prov;
 133     int name_id;
 134
 135     CRYPTO_REF_COUNT refcnt;
 136     CRYPTO_RWLOCK *lock;
 137
 138     OSSL_OP_mac_newctx_fn *newctx;
 139     OSSL_OP_mac_dupctx_fn *dupctx;
 140     OSSL_OP_mac_freectx_fn *freectx;
 141     OSSL_OP_mac_size_fn *size;
 142     OSSL_OP_mac_init_fn *init;
 143     OSSL_OP_mac_update_fn *update;
 144     OSSL_OP_mac_final_fn *final;
 145     OSSL_OP_mac_gettable_params_fn *gettable_params;
 146     OSSL_OP_mac_gettable_ctx_params_fn *gettable_ctx_params;
 147     OSSL_OP_mac_settable_ctx_params_fn *settable_ctx_params;
 148     OSSL_OP_mac_get_params_fn *get_params;
 149     OSSL_OP_mac_get_ctx_params_fn *get_ctx_params;
 150     OSSL_OP_mac_set_ctx_params_fn *set_ctx_params;
 151 };
 152
 153 struct evp_kdf_st {
 154     OSSL_PROVIDER *prov;
 155     int name_id;
 156     CRYPTO_REF_COUNT refcnt;
 157     CRYPTO_RWLOCK *lock;
 158
 159     OSSL_OP_kdf_newctx_fn *newctx;
 160     OSSL_OP_kdf_dupctx_fn *dupctx;
 161     OSSL_OP_kdf_freectx_fn *freectx;
 162     OSSL_OP_kdf_reset_fn *reset;
 163     OSSL_OP_kdf_derive_fn *derive;
 164     OSSL_OP_kdf_gettable_params_fn *gettable_params;
 165     OSSL_OP_kdf_gettable_ctx_params_fn *gettable_ctx_params;
 166     OSSL_OP_kdf_settable_ctx_params_fn *settable_ctx_params;
 167     OSSL_OP_kdf_get_params_fn *get_params;
 168     OSSL_OP_kdf_get_ctx_params_fn *get_ctx_params;
 169     OSSL_OP_kdf_set_ctx_params_fn *set_ctx_params;
 170 };
 171
 172 struct evp_md_st {
 173     /* nid */
 174     int type;
 175
 176     /* Legacy structure members */
 177     /* TODO(3.0): Remove these */
 178     int pkey_type;
 179     int md_size;
 180     unsigned long flags;
 181     int (*init) (EVP_MD_CTX *ctx);
 182     int (*update) (EVP_MD_CTX *ctx, const void *data, size_t count);
 183     int (*final) (EVP_MD_CTX *ctx, unsigned char *md);
 184     int (*copy) (EVP_MD_CTX *to, const EVP_MD_CTX *from);
 185     int (*cleanup) (EVP_MD_CTX *ctx);
 186     int block_size;
 187     int ctx_size;               /* how big does the ctx->md_data need to be */
 188     /* control function */
 189     int (*md_ctrl) (EVP_MD_CTX *ctx, int cmd, int p1, void *p2);
 190
 191     /* New structure members */
 192     /* TODO(3.0): Remove above comment when legacy has gone */
 193     int name_id;
 194     OSSL_PROVIDER *prov;
 195     CRYPTO_REF_COUNT refcnt;
 196     CRYPTO_RWLOCK *lock;
 197     OSSL_OP_digest_newctx_fn *newctx;
 198     OSSL_OP_digest_init_fn *dinit;
 199     OSSL_OP_digest_update_fn *dupdate;
 200     OSSL_OP_digest_final_fn *dfinal;
 201     OSSL_OP_digest_digest_fn *digest;
 202     OSSL_OP_digest_freectx_fn *freectx;
 203     OSSL_OP_digest_dupctx_fn *dupctx;
 204     OSSL_OP_digest_get_params_fn *get_params;
 205     OSSL_OP_digest_set_ctx_params_fn *set_ctx_params;
 206     OSSL_OP_digest_get_ctx_params_fn *get_ctx_params;
 207     OSSL_OP_digest_gettable_params_fn *gettable_params;
 208     OSSL_OP_digest_settable_ctx_params_fn *settable_ctx_params;
 209     OSSL_OP_digest_gettable_ctx_params_fn *gettable_ctx_params;
 210
 211 } /* EVP_MD */ ;
 212
 213 struct evp_cipher_st {
 214     int nid;
 215
 216     int block_size;
 217     /* Default value for variable length ciphers */
 218     int key_len;
 219     int iv_len;
 220
 221     /* Legacy structure members */
 222     /* TODO(3.0): Remove these */
 223     /* Various flags */
 224     unsigned long flags;
 225     /* init key */
 226     int (*init) (EVP_CIPHER_CTX *ctx, const unsigned char *key,
 227                  const unsigned char *iv, int enc);
 228     /* encrypt/decrypt data */
 229     int (*do_cipher) (EVP_CIPHER_CTX *ctx, unsigned char *out,
 230                       const unsigned char *in, size_t inl);
 231     /* cleanup ctx */
 232     int (*cleanup) (EVP_CIPHER_CTX *);
 233     /* how big ctx->cipher_data needs to be */
 234     int ctx_size;
 235     /* Populate a ASN1_TYPE with parameters */
 236     int (*set_asn1_parameters) (EVP_CIPHER_CTX *, ASN1_TYPE *);
 237     /* Get parameters from a ASN1_TYPE */
 238     int (*get_asn1_parameters) (EVP_CIPHER_CTX *, ASN1_TYPE *);
 239     /* Miscellaneous operations */
 240     int (*ctrl) (EVP_CIPHER_CTX *, int type, int arg, void *ptr);
 241     /* Application data */
 242     void *app_data;
 243
 244     /* New structure members */
 245     /* TODO(3.0): Remove above comment when legacy has gone */
 246     int name_id;
 247     OSSL_PROVIDER *prov;
 248     CRYPTO_REF_COUNT refcnt;
 249     CRYPTO_RWLOCK *lock;
 250     OSSL_OP_cipher_newctx_fn *newctx;
 251     OSSL_OP_cipher_encrypt_init_fn *einit;
 252     OSSL_OP_cipher_decrypt_init_fn *dinit;
 253     OSSL_OP_cipher_update_fn *cupdate;
 254     OSSL_OP_cipher_final_fn *cfinal;
 255     OSSL_OP_cipher_cipher_fn *ccipher;
 256     OSSL_OP_cipher_freectx_fn *freectx;
 257     OSSL_OP_cipher_dupctx_fn *dupctx;
 258     OSSL_OP_cipher_get_params_fn *get_params;
 259     OSSL_OP_cipher_get_ctx_params_fn *get_ctx_params;
 260     OSSL_OP_cipher_set_ctx_params_fn *set_ctx_params;
 261     OSSL_OP_cipher_gettable_params_fn *gettable_params;
 262     OSSL_OP_cipher_gettable_ctx_params_fn *gettable_ctx_params;
 263     OSSL_OP_cipher_settable_ctx_params_fn *settable_ctx_params;
 264 } /* EVP_CIPHER */ ;
 265
 266 /* Macros to code block cipher wrappers */
 267
 268 /* Wrapper functions for each cipher mode */
 269
 270 #define EVP_C_DATA(kstruct, ctx) \
 271         ((kstruct *)EVP_CIPHER_CTX_get_cipher_data(ctx))
 272
 273 #define BLOCK_CIPHER_ecb_loop() \
 274         size_t i, bl; \
 275         bl = EVP_CIPHER_CTX_cipher(ctx)->block_size;    \
 276         if (inl < bl) return 1;\
 277         inl -= bl; \
 278         for (i=0; i <= inl; i+=bl)
 279
 280 #define BLOCK_CIPHER_func_ecb(cname, cprefix, kstruct, ksched) \
 281 static int cname##_ecb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
 282 {\
 283         BLOCK_CIPHER_ecb_loop() \
 284             cprefix##_ecb_encrypt(in + i, out + i, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_encrypting(ctx)); \
 285         return 1;\
 286 }
 287
 288 #define EVP_MAXCHUNK ((size_t)1<<(sizeof(long)*8-2))
 289
 290 #define BLOCK_CIPHER_func_ofb(cname, cprefix, cbits, kstruct, ksched) \
 291     static int cname##_ofb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
 292 {\
 293         while(inl>=EVP_MAXCHUNK) {\
 294             int num = EVP_CIPHER_CTX_num(ctx);\
 295             cprefix##_ofb##cbits##_encrypt(in, out, (long)EVP_MAXCHUNK, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx), &num); \
 296             EVP_CIPHER_CTX_set_num(ctx, num);\
 297             inl-=EVP_MAXCHUNK;\
 298             in +=EVP_MAXCHUNK;\
 299             out+=EVP_MAXCHUNK;\
 300         }\
 301         if (inl) {\
 302             int num = EVP_CIPHER_CTX_num(ctx);\
 303             cprefix##_ofb##cbits##_encrypt(in, out, (long)inl, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx), &num); \
 304             EVP_CIPHER_CTX_set_num(ctx, num);\
 305         }\
 306         return 1;\
 307 }
 308
 309 #define BLOCK_CIPHER_func_cbc(cname, cprefix, kstruct, ksched) \
 310 static int cname##_cbc_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
 311 {\
 312         while(inl>=EVP_MAXCHUNK) \
 313             {\
 314             cprefix##_cbc_encrypt(in, out, (long)EVP_MAXCHUNK, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx), EVP_CIPHER_CTX_encrypting(ctx));\
 315             inl-=EVP_MAXCHUNK;\
 316             in +=EVP_MAXCHUNK;\
 317             out+=EVP_MAXCHUNK;\
 318             }\
 319         if (inl)\
 320             cprefix##_cbc_encrypt(in, out, (long)inl, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx), EVP_CIPHER_CTX_encrypting(ctx));\
 321         return 1;\
 322 }
 323
 324 #define BLOCK_CIPHER_func_cfb(cname, cprefix, cbits, kstruct, ksched)  \
 325 static int cname##_cfb##cbits##_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
 326 {\
 327     size_t chunk = EVP_MAXCHUNK;\
 328     if (cbits == 1)  chunk >>= 3;\
 329     if (inl < chunk) chunk = inl;\
 330     while (inl && inl >= chunk)\
 331     {\
 332         int num = EVP_CIPHER_CTX_num(ctx);\
 333         cprefix##_cfb##cbits##_encrypt(in, out, (long) \
 334             ((cbits == 1) \
 335                 && !EVP_CIPHER_CTX_test_flags(ctx, EVP_CIPH_FLAG_LENGTH_BITS) \
 336                 ? chunk*8 : chunk), \
 337             &EVP_C_DATA(kstruct, ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx),\
 338             &num, EVP_CIPHER_CTX_encrypting(ctx));\
 339         EVP_CIPHER_CTX_set_num(ctx, num);\
 340         inl -= chunk;\
 341         in += chunk;\
 342         out += chunk;\
 343         if (inl < chunk) chunk = inl;\
 344     }\
 345     return 1;\
 346 }
 347
 348 #define BLOCK_CIPHER_all_funcs(cname, cprefix, cbits, kstruct, ksched) \
 349         BLOCK_CIPHER_func_cbc(cname, cprefix, kstruct, ksched) \
 350         BLOCK_CIPHER_func_cfb(cname, cprefix, cbits, kstruct, ksched) \
 351         BLOCK_CIPHER_func_ecb(cname, cprefix, kstruct, ksched) \
 352         BLOCK_CIPHER_func_ofb(cname, cprefix, cbits, kstruct, ksched)
 353
 354 #define BLOCK_CIPHER_def1(cname, nmode, mode, MODE, kstruct, nid, block_size, \
 355                           key_len, iv_len, flags, init_key, cleanup, \
 356                           set_asn1, get_asn1, ctrl) \
 357 static const EVP_CIPHER cname##_##mode = { \
 358         nid##_##nmode, block_size, key_len, iv_len, \
 359         flags | EVP_CIPH_##MODE##_MODE, \
 360         init_key, \
 361         cname##_##mode##_cipher, \
 362         cleanup, \
 363         sizeof(kstruct), \
 364         set_asn1, get_asn1,\
 365         ctrl, \
 366         NULL \
 367 }; \
 368 const EVP_CIPHER *EVP_##cname##_##mode(void) { return &cname##_##mode; }
 369
 370 #define BLOCK_CIPHER_def_cbc(cname, kstruct, nid, block_size, key_len, \
 371                              iv_len, flags, init_key, cleanup, set_asn1, \
 372                              get_asn1, ctrl) \
 373 BLOCK_CIPHER_def1(cname, cbc, cbc, CBC, kstruct, nid, block_size, key_len, \
 374                   iv_len, flags, init_key, cleanup, set_asn1, get_asn1, ctrl)
 375
 376 #define BLOCK_CIPHER_def_cfb(cname, kstruct, nid, key_len, \
 377                              iv_len, cbits, flags, init_key, cleanup, \
 378                              set_asn1, get_asn1, ctrl) \
 379 BLOCK_CIPHER_def1(cname, cfb##cbits, cfb##cbits, CFB, kstruct, nid, 1, \
 380                   key_len, iv_len, flags, init_key, cleanup, set_asn1, \
 381                   get_asn1, ctrl)
 382
 383 #define BLOCK_CIPHER_def_ofb(cname, kstruct, nid, key_len, \
 384                              iv_len, cbits, flags, init_key, cleanup, \
 385                              set_asn1, get_asn1, ctrl) \
 386 BLOCK_CIPHER_def1(cname, ofb##cbits, ofb, OFB, kstruct, nid, 1, \
 387                   key_len, iv_len, flags, init_key, cleanup, set_asn1, \
 388                   get_asn1, ctrl)
 389
 390 #define BLOCK_CIPHER_def_ecb(cname, kstruct, nid, block_size, key_len, \
 391                              flags, init_key, cleanup, set_asn1, \
 392                              get_asn1, ctrl) \
 393 BLOCK_CIPHER_def1(cname, ecb, ecb, ECB, kstruct, nid, block_size, key_len, \
 394                   0, flags, init_key, cleanup, set_asn1, get_asn1, ctrl)
 395
 396 #define BLOCK_CIPHER_defs(cname, kstruct, \
 397                           nid, block_size, key_len, iv_len, cbits, flags, \
 398                           init_key, cleanup, set_asn1, get_asn1, ctrl) \
 399 BLOCK_CIPHER_def_cbc(cname, kstruct, nid, block_size, key_len, iv_len, flags, \
 400                      init_key, cleanup, set_asn1, get_asn1, ctrl) \
 401 BLOCK_CIPHER_def_cfb(cname, kstruct, nid, key_len, iv_len, cbits, \
 402                      flags, init_key, cleanup, set_asn1, get_asn1, ctrl) \
 403 BLOCK_CIPHER_def_ofb(cname, kstruct, nid, key_len, iv_len, cbits, \
 404                      flags, init_key, cleanup, set_asn1, get_asn1, ctrl) \
 405 BLOCK_CIPHER_def_ecb(cname, kstruct, nid, block_size, key_len, flags, \
 406                      init_key, cleanup, set_asn1, get_asn1, ctrl)
 407
 408 /*-
 409 #define BLOCK_CIPHER_defs(cname, kstruct, \
 410                                 nid, block_size, key_len, iv_len, flags,\
 411                                  init_key, cleanup, set_asn1, get_asn1, ctrl)\
 412 static const EVP_CIPHER cname##_cbc = {\
 413         nid##_cbc, block_size, key_len, iv_len, \
 414         flags | EVP_CIPH_CBC_MODE,\
 415         init_key,\
 416         cname##_cbc_cipher,\
 417         cleanup,\
 418         sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
 419                 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
 420         set_asn1, get_asn1,\
 421         ctrl, \
 422         NULL \
 423 };\
 424 const EVP_CIPHER *EVP_##cname##_cbc(void) { return &cname##_cbc; }\
 425 static const EVP_CIPHER cname##_cfb = {\
 426         nid##_cfb64, 1, key_len, iv_len, \
 427         flags | EVP_CIPH_CFB_MODE,\
 428         init_key,\
 429         cname##_cfb_cipher,\
 430         cleanup,\
 431         sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
 432                 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
 433         set_asn1, get_asn1,\
 434         ctrl,\
 435         NULL \
 436 };\
 437 const EVP_CIPHER *EVP_##cname##_cfb(void) { return &cname##_cfb; }\
 438 static const EVP_CIPHER cname##_ofb = {\
 439         nid##_ofb64, 1, key_len, iv_len, \
 440         flags | EVP_CIPH_OFB_MODE,\
 441         init_key,\
 442         cname##_ofb_cipher,\
 443         cleanup,\
 444         sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
 445                 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
 446         set_asn1, get_asn1,\
 447         ctrl,\
 448         NULL \
 449 };\
 450 const EVP_CIPHER *EVP_##cname##_ofb(void) { return &cname##_ofb; }\
 451 static const EVP_CIPHER cname##_ecb = {\
 452         nid##_ecb, block_size, key_len, iv_len, \
 453         flags | EVP_CIPH_ECB_MODE,\
 454         init_key,\
 455         cname##_ecb_cipher,\
 456         cleanup,\
 457         sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
 458                 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
 459         set_asn1, get_asn1,\
 460         ctrl,\
 461         NULL \
 462 };\
 463 const EVP_CIPHER *EVP_##cname##_ecb(void) { return &cname##_ecb; }
 464 */
 465
 466 #define IMPLEMENT_BLOCK_CIPHER(cname, ksched, cprefix, kstruct, nid, \
 467                                block_size, key_len, iv_len, cbits, \
 468                                flags, init_key, \
 469                                cleanup, set_asn1, get_asn1, ctrl) \
 470         BLOCK_CIPHER_all_funcs(cname, cprefix, cbits, kstruct, ksched) \
 471         BLOCK_CIPHER_defs(cname, kstruct, nid, block_size, key_len, iv_len, \
 472                           cbits, flags, init_key, cleanup, set_asn1, \
 473                           get_asn1, ctrl)
 474
 475 #define IMPLEMENT_CFBR(cipher,cprefix,kstruct,ksched,keysize,cbits,iv_len,fl) \
 476         BLOCK_CIPHER_func_cfb(cipher##_##keysize,cprefix,cbits,kstruct,ksched) \
 477         BLOCK_CIPHER_def_cfb(cipher##_##keysize,kstruct, \
 478                              NID_##cipher##_##keysize, keysize/8, iv_len, cbits, \
 479                              (fl)|EVP_CIPH_FLAG_DEFAULT_ASN1, \
 480                              cipher##_init_key, NULL, NULL, NULL, NULL)
 481
 482
 483 # ifndef OPENSSL_NO_EC
 484
 485 #define X25519_KEYLEN        32
 486 #define X448_KEYLEN          56
 487 #define ED25519_KEYLEN       32
 488 #define ED448_KEYLEN         57
 489
 490 #define MAX_KEYLEN  ED448_KEYLEN
 491
 492 typedef struct {
 493     unsigned char pubkey[MAX_KEYLEN];
 494     unsigned char *privkey;
 495 } ECX_KEY;
 496
 497 #endif
 498
 499 /*
 500  * Type needs to be a bit field Sub-type needs to be for variations on the
 501  * method, as in, can it do arbitrary encryption....
 502  */
 503 struct evp_pkey_st {
 504     /* == Legacy attributes == */
 505     int type;
 506     int save_type;
 507     const EVP_PKEY_ASN1_METHOD *ameth;
 508     ENGINE *engine;
 509     ENGINE *pmeth_engine; /* If not NULL public key ENGINE to use */
 510     union {
 511         void *ptr;
 512 # ifndef OPENSSL_NO_RSA
 513         struct rsa_st *rsa;     /* RSA */
 514 # endif
 515 # ifndef OPENSSL_NO_DSA
 516         struct dsa_st *dsa;     /* DSA */
 517 # endif
 518 # ifndef OPENSSL_NO_DH
 519         struct dh_st *dh;       /* DH */
 520 # endif
 521 # ifndef OPENSSL_NO_EC
 522         struct ec_key_st *ec;   /* ECC */
 523         ECX_KEY *ecx;           /* X25519, X448, Ed25519, Ed448 */
 524 # endif
 525     } pkey;
 526
 527     /* == Common attributes == */
 528     CRYPTO_REF_COUNT references;
 529     CRYPTO_RWLOCK *lock;
 530     STACK_OF(X509_ATTRIBUTE) *attributes; /* [ 0 ] */
 531     int save_parameters;
 532
 533     /* == Provider attributes == */
 534     /*
 535      * To support transparent export/import between providers that
 536      * support the methods for it, and still not having to do the
 537      * export/import every time a key is used, we maintain a cache
 538      * of imported key, indexed by provider address.
 539      * pkeys[0] is *always* the "original" key.
 540      */
 541     struct {
 542         EVP_KEYMGMT *keymgmt;
 543         void *provkey;
 544     } pkeys[10];
 545     /*
 546      * If there is a legacy key assigned to this structure, we keep
 547      * a copy of that key's dirty count.
 548      */
 549     size_t dirty_cnt_copy;
 550 } /* EVP_PKEY */ ;
 551
 552 #define EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx) \
 553     ((ctx)->operation == EVP_PKEY_OP_SIGN \
 554      || (ctx)->operation == EVP_PKEY_OP_SIGNCTX \
 555      || (ctx)->operation == EVP_PKEY_OP_VERIFY \
 556      || (ctx)->operation == EVP_PKEY_OP_VERIFYCTX \
 557      || (ctx)->operation == EVP_PKEY_OP_VERIFYRECOVER)
 558
 559 #define EVP_PKEY_CTX_IS_DERIVE_OP(ctx) \
 560     ((ctx)->operation == EVP_PKEY_OP_DERIVE)
 561
 562 void openssl_add_all_ciphers_int(void);
 563 void openssl_add_all_digests_int(void);
 564 void evp_cleanup_int(void);
 565 void evp_app_cleanup_int(void);
 566
 567 /* KEYMGMT helper functions */
 568 void *evp_keymgmt_export_to_provider(EVP_PKEY *pk, EVP_KEYMGMT *keymgmt);
 569 void evp_keymgmt_clear_pkey_cache(EVP_PKEY *pk);
 570
 571 /* KEYMGMT provider interface functions */
 572 void *evp_keymgmt_importdomparams(const EVP_KEYMGMT *keymgmt,
 573                                   const OSSL_PARAM params[]);
 574 void *evp_keymgmt_gendomparams(const EVP_KEYMGMT *keymgmt,
 575                             const OSSL_PARAM params[]);
 576 void evp_keymgmt_freedomparams(const EVP_KEYMGMT *keymgmt,
 577                                void *provdomparams);
 578 int evp_keymgmt_exportdomparams(const EVP_KEYMGMT *keymgmt,
 579                                 void *provdomparams, OSSL_PARAM params[]);
 580 const OSSL_PARAM *
 581 evp_keymgmt_importdomparam_types(const EVP_KEYMGMT *keymgmt);
 582 const OSSL_PARAM *
 583 evp_keymgmt_exportdomparam_types(const EVP_KEYMGMT *keymgmt);
 584
 585 void *evp_keymgmt_importkey(const EVP_KEYMGMT *keymgmt,
 586                             const OSSL_PARAM params[]);
 587 void *evp_keymgmt_genkey(const EVP_KEYMGMT *keymgmt, void *domparams,
 588                          const OSSL_PARAM params[]);
 589 void *evp_keymgmt_loadkey(const EVP_KEYMGMT *keymgmt,
 590                           void *id, size_t idlen);
 591 void evp_keymgmt_freekey(const EVP_KEYMGMT *keymgmt, void *provkey);
 592 int evp_keymgmt_exportkey(const EVP_KEYMGMT *keymgmt,
 593                                void *provkey, OSSL_PARAM params[]);
 594 const OSSL_PARAM *evp_keymgmt_importkey_types(const EVP_KEYMGMT *keymgmt);
 595 const OSSL_PARAM *evp_keymgmt_exportkey_types(const EVP_KEYMGMT *keymgmt);
 596
 597 /* Pulling defines out of C source files */
 598
 599 #define EVP_RC4_KEY_SIZE 16
 600 #ifndef TLS1_1_VERSION
 601 # define TLS1_1_VERSION   0x0302
 602 #endif
 603
 604 void evp_encode_ctx_set_flags(EVP_ENCODE_CTX *ctx, unsigned int flags);
 605
 606 /* EVP_ENCODE_CTX flags */
 607 /* Don't generate new lines when encoding */
 608 #define EVP_ENCODE_CTX_NO_NEWLINES          1
 609 /* Use the SRP base64 alphabet instead of the standard one */
 610 #define EVP_ENCODE_CTX_USE_SRP_ALPHABET     2