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