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     /* Algorithm name and properties associated with this context */
  25     const char *algorithm;
  26     const char *propquery;
  27
  28     union {
  29         struct {
  30             EVP_KEYEXCH *exchange;
  31             void *exchprovctx;
  32         } kex;
  33
  34         struct {
  35             EVP_SIGNATURE *signature;
  36             void *sigprovctx;
  37         } sig;
  38     } op;
  39
  40     /* Legacy fields below */
  41
  42     /* Method associated with this operation */
  43     const EVP_PKEY_METHOD *pmeth;
  44     /* Engine that implements this method or NULL if builtin */
  45     ENGINE *engine;
  46     /* Key: may be NULL */
  47     EVP_PKEY *pkey;
  48     /* Peer key for key agreement, may be NULL */
  49     EVP_PKEY *peerkey;
  50     /* Algorithm specific data */
  51     void *data;
  52     /* Application specific data */
  53     void *app_data;
  54     /* Keygen callback */
  55     EVP_PKEY_gen_cb *pkey_gencb;
  56     /* implementation specific keygen data */
  57     int *keygen_info;
  58     int keygen_info_count;
  59 } /* EVP_PKEY_CTX */ ;
  60
  61 #define EVP_PKEY_FLAG_DYNAMIC   1
  62
  63 struct evp_pkey_method_st {
  64     int pkey_id;
  65     int flags;
  66     int (*init) (EVP_PKEY_CTX *ctx);
  67     int (*copy) (EVP_PKEY_CTX *dst, const EVP_PKEY_CTX *src);
  68     void (*cleanup) (EVP_PKEY_CTX *ctx);
  69     int (*paramgen_init) (EVP_PKEY_CTX *ctx);
  70     int (*paramgen) (EVP_PKEY_CTX *ctx, EVP_PKEY *pkey);
  71     int (*keygen_init) (EVP_PKEY_CTX *ctx);
  72     int (*keygen) (EVP_PKEY_CTX *ctx, EVP_PKEY *pkey);
  73     int (*sign_init) (EVP_PKEY_CTX *ctx);
  74     int (*sign) (EVP_PKEY_CTX *ctx, unsigned char *sig, size_t *siglen,
  75                  const unsigned char *tbs, size_t tbslen);
  76     int (*verify_init) (EVP_PKEY_CTX *ctx);
  77     int (*verify) (EVP_PKEY_CTX *ctx,
  78                    const unsigned char *sig, size_t siglen,
  79                    const unsigned char *tbs, size_t tbslen);
  80     int (*verify_recover_init) (EVP_PKEY_CTX *ctx);
  81     int (*verify_recover) (EVP_PKEY_CTX *ctx,
  82                            unsigned char *rout, size_t *routlen,
  83                            const unsigned char *sig, size_t siglen);
  84     int (*signctx_init) (EVP_PKEY_CTX *ctx, EVP_MD_CTX *mctx);
  85     int (*signctx) (EVP_PKEY_CTX *ctx, unsigned char *sig, size_t *siglen,
  86                     EVP_MD_CTX *mctx);
  87     int (*verifyctx_init) (EVP_PKEY_CTX *ctx, EVP_MD_CTX *mctx);
  88     int (*verifyctx) (EVP_PKEY_CTX *ctx, const unsigned char *sig, int siglen,
  89                       EVP_MD_CTX *mctx);
  90     int (*encrypt_init) (EVP_PKEY_CTX *ctx);
  91     int (*encrypt) (EVP_PKEY_CTX *ctx, unsigned char *out, size_t *outlen,
  92                     const unsigned char *in, size_t inlen);
  93     int (*decrypt_init) (EVP_PKEY_CTX *ctx);
  94     int (*decrypt) (EVP_PKEY_CTX *ctx, unsigned char *out, size_t *outlen,
  95                     const unsigned char *in, size_t inlen);
  96     int (*derive_init) (EVP_PKEY_CTX *ctx);
  97     int (*derive) (EVP_PKEY_CTX *ctx, unsigned char *key, size_t *keylen);
  98     int (*ctrl) (EVP_PKEY_CTX *ctx, int type, int p1, void *p2);
  99     int (*ctrl_str) (EVP_PKEY_CTX *ctx, const char *type, const char *value);
 100     int (*digestsign) (EVP_MD_CTX *ctx, unsigned char *sig, size_t *siglen,
 101                        const unsigned char *tbs, size_t tbslen);
 102     int (*digestverify) (EVP_MD_CTX *ctx, const unsigned char *sig,
 103                          size_t siglen, const unsigned char *tbs,
 104                          size_t tbslen);
 105     int (*check) (EVP_PKEY *pkey);
 106     int (*public_check) (EVP_PKEY *pkey);
 107     int (*param_check) (EVP_PKEY *pkey);
 108
 109     int (*digest_custom) (EVP_PKEY_CTX *ctx, EVP_MD_CTX *mctx);
 110 } /* EVP_PKEY_METHOD */ ;
 111
 112 DEFINE_STACK_OF_CONST(EVP_PKEY_METHOD)
 113
 114 void evp_pkey_set_cb_translate(BN_GENCB *cb, EVP_PKEY_CTX *ctx);
 115
 116 const EVP_PKEY_METHOD *cmac_pkey_method(void);
 117 const EVP_PKEY_METHOD *dh_pkey_method(void);
 118 const EVP_PKEY_METHOD *dhx_pkey_method(void);
 119 const EVP_PKEY_METHOD *dsa_pkey_method(void);
 120 const EVP_PKEY_METHOD *ec_pkey_method(void);
 121 const EVP_PKEY_METHOD *sm2_pkey_method(void);
 122 const EVP_PKEY_METHOD *ecx25519_pkey_method(void);
 123 const EVP_PKEY_METHOD *ecx448_pkey_method(void);
 124 const EVP_PKEY_METHOD *ed25519_pkey_method(void);
 125 const EVP_PKEY_METHOD *ed448_pkey_method(void);
 126 const EVP_PKEY_METHOD *hmac_pkey_method(void);
 127 const EVP_PKEY_METHOD *rsa_pkey_method(void);
 128 const EVP_PKEY_METHOD *rsa_pss_pkey_method(void);
 129 const EVP_PKEY_METHOD *scrypt_pkey_method(void);
 130 const EVP_PKEY_METHOD *tls1_prf_pkey_method(void);
 131 const EVP_PKEY_METHOD *hkdf_pkey_method(void);
 132 const EVP_PKEY_METHOD *poly1305_pkey_method(void);
 133 const EVP_PKEY_METHOD *siphash_pkey_method(void);
 134
 135 struct evp_mac_st {
 136     OSSL_PROVIDER *prov;
 137     int name_id;
 138
 139     CRYPTO_REF_COUNT refcnt;
 140     CRYPTO_RWLOCK *lock;
 141
 142     OSSL_OP_mac_newctx_fn *newctx;
 143     OSSL_OP_mac_dupctx_fn *dupctx;
 144     OSSL_OP_mac_freectx_fn *freectx;
 145     OSSL_OP_mac_size_fn *size;
 146     OSSL_OP_mac_init_fn *init;
 147     OSSL_OP_mac_update_fn *update;
 148     OSSL_OP_mac_final_fn *final;
 149     OSSL_OP_mac_gettable_params_fn *gettable_params;
 150     OSSL_OP_mac_gettable_ctx_params_fn *gettable_ctx_params;
 151     OSSL_OP_mac_settable_ctx_params_fn *settable_ctx_params;
 152     OSSL_OP_mac_get_params_fn *get_params;
 153     OSSL_OP_mac_get_ctx_params_fn *get_ctx_params;
 154     OSSL_OP_mac_set_ctx_params_fn *set_ctx_params;
 155 };
 156
 157 struct evp_kdf_st {
 158     OSSL_PROVIDER *prov;
 159     int name_id;
 160     CRYPTO_REF_COUNT refcnt;
 161     CRYPTO_RWLOCK *lock;
 162
 163     OSSL_OP_kdf_newctx_fn *newctx;
 164     OSSL_OP_kdf_dupctx_fn *dupctx;
 165     OSSL_OP_kdf_freectx_fn *freectx;
 166     OSSL_OP_kdf_reset_fn *reset;
 167     OSSL_OP_kdf_derive_fn *derive;
 168     OSSL_OP_kdf_gettable_params_fn *gettable_params;
 169     OSSL_OP_kdf_gettable_ctx_params_fn *gettable_ctx_params;
 170     OSSL_OP_kdf_settable_ctx_params_fn *settable_ctx_params;
 171     OSSL_OP_kdf_get_params_fn *get_params;
 172     OSSL_OP_kdf_get_ctx_params_fn *get_ctx_params;
 173     OSSL_OP_kdf_set_ctx_params_fn *set_ctx_params;
 174 };
 175
 176 struct evp_md_st {
 177     /* nid */
 178     int type;
 179
 180     /* Legacy structure members */
 181     /* TODO(3.0): Remove these */
 182     int pkey_type;
 183     int md_size;
 184     unsigned long flags;
 185     int (*init) (EVP_MD_CTX *ctx);
 186     int (*update) (EVP_MD_CTX *ctx, const void *data, size_t count);
 187     int (*final) (EVP_MD_CTX *ctx, unsigned char *md);
 188     int (*copy) (EVP_MD_CTX *to, const EVP_MD_CTX *from);
 189     int (*cleanup) (EVP_MD_CTX *ctx);
 190     int block_size;
 191     int ctx_size;               /* how big does the ctx->md_data need to be */
 192     /* control function */
 193     int (*md_ctrl) (EVP_MD_CTX *ctx, int cmd, int p1, void *p2);
 194
 195     /* New structure members */
 196     /* TODO(3.0): Remove above comment when legacy has gone */
 197     int name_id;
 198     OSSL_PROVIDER *prov;
 199     CRYPTO_REF_COUNT refcnt;
 200     CRYPTO_RWLOCK *lock;
 201     OSSL_OP_digest_newctx_fn *newctx;
 202     OSSL_OP_digest_init_fn *dinit;
 203     OSSL_OP_digest_update_fn *dupdate;
 204     OSSL_OP_digest_final_fn *dfinal;
 205     OSSL_OP_digest_digest_fn *digest;
 206     OSSL_OP_digest_freectx_fn *freectx;
 207     OSSL_OP_digest_dupctx_fn *dupctx;
 208     OSSL_OP_digest_get_params_fn *get_params;
 209     OSSL_OP_digest_set_ctx_params_fn *set_ctx_params;
 210     OSSL_OP_digest_get_ctx_params_fn *get_ctx_params;
 211     OSSL_OP_digest_gettable_params_fn *gettable_params;
 212     OSSL_OP_digest_settable_ctx_params_fn *settable_ctx_params;
 213     OSSL_OP_digest_gettable_ctx_params_fn *gettable_ctx_params;
 214
 215 } /* EVP_MD */ ;
 216
 217 struct evp_cipher_st {
 218     int nid;
 219
 220     int block_size;
 221     /* Default value for variable length ciphers */
 222     int key_len;
 223     int iv_len;
 224
 225     /* Legacy structure members */
 226     /* TODO(3.0): Remove these */
 227     /* Various flags */
 228     unsigned long flags;
 229     /* init key */
 230     int (*init) (EVP_CIPHER_CTX *ctx, const unsigned char *key,
 231                  const unsigned char *iv, int enc);
 232     /* encrypt/decrypt data */
 233     int (*do_cipher) (EVP_CIPHER_CTX *ctx, unsigned char *out,
 234                       const unsigned char *in, size_t inl);
 235     /* cleanup ctx */
 236     int (*cleanup) (EVP_CIPHER_CTX *);
 237     /* how big ctx->cipher_data needs to be */
 238     int ctx_size;
 239     /* Populate a ASN1_TYPE with parameters */
 240     int (*set_asn1_parameters) (EVP_CIPHER_CTX *, ASN1_TYPE *);
 241     /* Get parameters from a ASN1_TYPE */
 242     int (*get_asn1_parameters) (EVP_CIPHER_CTX *, ASN1_TYPE *);
 243     /* Miscellaneous operations */
 244     int (*ctrl) (EVP_CIPHER_CTX *, int type, int arg, void *ptr);
 245     /* Application data */
 246     void *app_data;
 247
 248     /* New structure members */
 249     /* TODO(3.0): Remove above comment when legacy has gone */
 250     int name_id;
 251     OSSL_PROVIDER *prov;
 252     CRYPTO_REF_COUNT refcnt;
 253     CRYPTO_RWLOCK *lock;
 254     OSSL_OP_cipher_newctx_fn *newctx;
 255     OSSL_OP_cipher_encrypt_init_fn *einit;
 256     OSSL_OP_cipher_decrypt_init_fn *dinit;
 257     OSSL_OP_cipher_update_fn *cupdate;
 258     OSSL_OP_cipher_final_fn *cfinal;
 259     OSSL_OP_cipher_cipher_fn *ccipher;
 260     OSSL_OP_cipher_freectx_fn *freectx;
 261     OSSL_OP_cipher_dupctx_fn *dupctx;
 262     OSSL_OP_cipher_get_params_fn *get_params;
 263     OSSL_OP_cipher_get_ctx_params_fn *get_ctx_params;
 264     OSSL_OP_cipher_set_ctx_params_fn *set_ctx_params;
 265     OSSL_OP_cipher_gettable_params_fn *gettable_params;
 266     OSSL_OP_cipher_gettable_ctx_params_fn *gettable_ctx_params;
 267     OSSL_OP_cipher_settable_ctx_params_fn *settable_ctx_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 ED25519_KEYLEN       32
 492 #define ED448_KEYLEN         57
 493
 494 #define MAX_KEYLEN  ED448_KEYLEN
 495
 496 typedef struct {
 497     unsigned char pubkey[MAX_KEYLEN];
 498     unsigned char *privkey;
 499 } ECX_KEY;
 500
 501 #endif
 502
 503 /*
 504  * Type needs to be a bit field Sub-type needs to be for variations on the
 505  * method, as in, can it do arbitrary encryption....
 506  */
 507 struct evp_pkey_st {
 508     /* == Legacy attributes == */
 509     int type;
 510     int save_type;
 511     const EVP_PKEY_ASN1_METHOD *ameth;
 512     ENGINE *engine;
 513     ENGINE *pmeth_engine; /* If not NULL public key ENGINE to use */
 514     union {
 515         void *ptr;
 516 # ifndef OPENSSL_NO_RSA
 517         struct rsa_st *rsa;     /* RSA */
 518 # endif
 519 # ifndef OPENSSL_NO_DSA
 520         struct dsa_st *dsa;     /* DSA */
 521 # endif
 522 # ifndef OPENSSL_NO_DH
 523         struct dh_st *dh;       /* DH */
 524 # endif
 525 # ifndef OPENSSL_NO_EC
 526         struct ec_key_st *ec;   /* ECC */
 527         ECX_KEY *ecx;           /* X25519, X448, Ed25519, Ed448 */
 528 # endif
 529     } pkey;
 530
 531     /* == Common attributes == */
 532     CRYPTO_REF_COUNT references;
 533     CRYPTO_RWLOCK *lock;
 534     STACK_OF(X509_ATTRIBUTE) *attributes; /* [ 0 ] */
 535     int save_parameters;
 536
 537     /* == Provider attributes == */
 538     /*
 539      * To support transparent export/import between providers that
 540      * support the methods for it, and still not having to do the
 541      * export/import every time a key or domain params are used, we
 542      * maintain a cache of imported key / domain params, indexed by
 543      * provider address.  pkeys[0] is *always* the "original" data.
 544      */
 545     struct {
 546         EVP_KEYMGMT *keymgmt;
 547         void *provdata;
 548         /* 0 = provdata is a key, 1 = provdata is domain params */
 549         int domainparams;
 550     } pkeys[10];
 551     /*
 552      * If there is a legacy key assigned to this structure, we keep
 553      * a copy of that key's dirty count.
 554      */
 555     size_t dirty_cnt_copy;
 556 } /* EVP_PKEY */ ;
 557
 558 #define EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx) \
 559     ((ctx)->operation == EVP_PKEY_OP_SIGN \
 560      || (ctx)->operation == EVP_PKEY_OP_SIGNCTX \
 561      || (ctx)->operation == EVP_PKEY_OP_VERIFY \
 562      || (ctx)->operation == EVP_PKEY_OP_VERIFYCTX \
 563      || (ctx)->operation == EVP_PKEY_OP_VERIFYRECOVER)
 564
 565 #define EVP_PKEY_CTX_IS_DERIVE_OP(ctx) \
 566     ((ctx)->operation == EVP_PKEY_OP_DERIVE)
 567
 568 void openssl_add_all_ciphers_int(void);
 569 void openssl_add_all_digests_int(void);
 570 void evp_cleanup_int(void);
 571 void evp_app_cleanup_int(void);
 572
 573 /* KEYMGMT helper functions */
 574 void *evp_keymgmt_export_to_provider(EVP_PKEY *pk, EVP_KEYMGMT *keymgmt,
 575                                      int domainparams);
 576 void evp_keymgmt_clear_pkey_cache(EVP_PKEY *pk);
 577
 578 /* KEYMGMT provider interface functions */
 579 void *evp_keymgmt_importdomparams(const EVP_KEYMGMT *keymgmt,
 580                                   const OSSL_PARAM params[]);
 581 void *evp_keymgmt_gendomparams(const EVP_KEYMGMT *keymgmt,
 582                             const OSSL_PARAM params[]);
 583 void evp_keymgmt_freedomparams(const EVP_KEYMGMT *keymgmt,
 584                                void *provdomparams);
 585 int evp_keymgmt_exportdomparams(const EVP_KEYMGMT *keymgmt,
 586                                 void *provdomparams, OSSL_PARAM params[]);
 587 const OSSL_PARAM *
 588 evp_keymgmt_importdomparam_types(const EVP_KEYMGMT *keymgmt);
 589 const OSSL_PARAM *
 590 evp_keymgmt_exportdomparam_types(const EVP_KEYMGMT *keymgmt);
 591
 592 void *evp_keymgmt_importkey(const EVP_KEYMGMT *keymgmt,
 593                             const OSSL_PARAM params[]);
 594 void *evp_keymgmt_genkey(const EVP_KEYMGMT *keymgmt, void *domparams,
 595                          const OSSL_PARAM params[]);
 596 void *evp_keymgmt_loadkey(const EVP_KEYMGMT *keymgmt,
 597                           void *id, size_t idlen);
 598 void evp_keymgmt_freekey(const EVP_KEYMGMT *keymgmt, void *provkey);
 599 int evp_keymgmt_exportkey(const EVP_KEYMGMT *keymgmt,
 600                                void *provkey, OSSL_PARAM params[]);
 601 const OSSL_PARAM *evp_keymgmt_importkey_types(const EVP_KEYMGMT *keymgmt);
 602 const OSSL_PARAM *evp_keymgmt_exportkey_types(const EVP_KEYMGMT *keymgmt);
 603
 604 /* Pulling defines out of C source files */
 605
 606 #define EVP_RC4_KEY_SIZE 16
 607 #ifndef TLS1_1_VERSION
 608 # define TLS1_1_VERSION   0x0302
 609 #endif
 610
 611 void evp_encode_ctx_set_flags(EVP_ENCODE_CTX *ctx, unsigned int flags);
 612
 613 /* EVP_ENCODE_CTX flags */
 614 /* Don't generate new lines when encoding */
 615 #define EVP_ENCODE_CTX_NO_NEWLINES          1
 616 /* Use the SRP base64 alphabet instead of the standard one */
 617 #define EVP_ENCODE_CTX_USE_SRP_ALPHABET     2