crypto/include/internal/evp_int.h

   1 /*
   2  * Copyright 2015-2018 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the OpenSSL license (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 "internal/refcount.h"
  12
  13 struct evp_pkey_ctx_st {
  14     /* Method associated with this operation */
  15     const EVP_PKEY_METHOD *pmeth;
  16     /* Engine that implements this method or NULL if builtin */
  17     ENGINE *engine;
  18     /* Key: may be NULL */
  19     EVP_PKEY *pkey;
  20     /* Peer key for key agreement, may be NULL */
  21     EVP_PKEY *peerkey;
  22     /* Actual operation */
  23     int operation;
  24     /* Algorithm specific data */
  25     void *data;
  26     /* Application specific data */
  27     void *app_data;
  28     /* Keygen callback */
  29     EVP_PKEY_gen_cb *pkey_gencb;
  30     /* implementation specific keygen data */
  31     int *keygen_info;
  32     int keygen_info_count;
  33 } /* EVP_PKEY_CTX */ ;
  34
  35 #define EVP_PKEY_FLAG_DYNAMIC   1
  36
  37 struct evp_pkey_method_st {
  38     int pkey_id;
  39     int flags;
  40     int (*init) (EVP_PKEY_CTX *ctx);
  41     int (*copy) (EVP_PKEY_CTX *dst, EVP_PKEY_CTX *src);
  42     void (*cleanup) (EVP_PKEY_CTX *ctx);
  43     int (*paramgen_init) (EVP_PKEY_CTX *ctx);
  44     int (*paramgen) (EVP_PKEY_CTX *ctx, EVP_PKEY *pkey);
  45     int (*keygen_init) (EVP_PKEY_CTX *ctx);
  46     int (*keygen) (EVP_PKEY_CTX *ctx, EVP_PKEY *pkey);
  47     int (*sign_init) (EVP_PKEY_CTX *ctx);
  48     int (*sign) (EVP_PKEY_CTX *ctx, unsigned char *sig, size_t *siglen,
  49                  const unsigned char *tbs, size_t tbslen);
  50     int (*verify_init) (EVP_PKEY_CTX *ctx);
  51     int (*verify) (EVP_PKEY_CTX *ctx,
  52                    const unsigned char *sig, size_t siglen,
  53                    const unsigned char *tbs, size_t tbslen);
  54     int (*verify_recover_init) (EVP_PKEY_CTX *ctx);
  55     int (*verify_recover) (EVP_PKEY_CTX *ctx,
  56                            unsigned char *rout, size_t *routlen,
  57                            const unsigned char *sig, size_t siglen);
  58     int (*signctx_init) (EVP_PKEY_CTX *ctx, EVP_MD_CTX *mctx);
  59     int (*signctx) (EVP_PKEY_CTX *ctx, unsigned char *sig, size_t *siglen,
  60                     EVP_MD_CTX *mctx);
  61     int (*verifyctx_init) (EVP_PKEY_CTX *ctx, EVP_MD_CTX *mctx);
  62     int (*verifyctx) (EVP_PKEY_CTX *ctx, const unsigned char *sig, int siglen,
  63                       EVP_MD_CTX *mctx);
  64     int (*encrypt_init) (EVP_PKEY_CTX *ctx);
  65     int (*encrypt) (EVP_PKEY_CTX *ctx, unsigned char *out, size_t *outlen,
  66                     const unsigned char *in, size_t inlen);
  67     int (*decrypt_init) (EVP_PKEY_CTX *ctx);
  68     int (*decrypt) (EVP_PKEY_CTX *ctx, unsigned char *out, size_t *outlen,
  69                     const unsigned char *in, size_t inlen);
  70     int (*derive_init) (EVP_PKEY_CTX *ctx);
  71     int (*derive) (EVP_PKEY_CTX *ctx, unsigned char *key, size_t *keylen);
  72     int (*ctrl) (EVP_PKEY_CTX *ctx, int type, int p1, void *p2);
  73     int (*ctrl_str) (EVP_PKEY_CTX *ctx, const char *type, const char *value);
  74     int (*digestsign) (EVP_MD_CTX *ctx, unsigned char *sig, size_t *siglen,
  75                        const unsigned char *tbs, size_t tbslen);
  76     int (*digestverify) (EVP_MD_CTX *ctx, const unsigned char *sig,
  77                          size_t siglen, const unsigned char *tbs,
  78                          size_t tbslen);
  79     int (*check) (EVP_PKEY *pkey);
  80     int (*public_check) (EVP_PKEY *pkey);
  81     int (*param_check) (EVP_PKEY *pkey);
  82
  83     int (*digest_custom) (EVP_PKEY_CTX *ctx, EVP_MD_CTX *mctx);
  84 } /* EVP_PKEY_METHOD */ ;
  85
  86 DEFINE_STACK_OF_CONST(EVP_PKEY_METHOD)
  87
  88 void evp_pkey_set_cb_translate(BN_GENCB *cb, EVP_PKEY_CTX *ctx);
  89
  90 extern const EVP_PKEY_METHOD cmac_pkey_meth;
  91 extern const EVP_PKEY_METHOD dh_pkey_meth;
  92 extern const EVP_PKEY_METHOD dhx_pkey_meth;
  93 extern const EVP_PKEY_METHOD dsa_pkey_meth;
  94 extern const EVP_PKEY_METHOD ec_pkey_meth;
  95 extern const EVP_PKEY_METHOD sm2_pkey_meth;
  96 extern const EVP_PKEY_METHOD ecx25519_pkey_meth;
  97 extern const EVP_PKEY_METHOD ecx448_pkey_meth;
  98 extern const EVP_PKEY_METHOD ed25519_pkey_meth;
  99 extern const EVP_PKEY_METHOD ed448_pkey_meth;
 100 extern const EVP_PKEY_METHOD hmac_pkey_meth;
 101 extern const EVP_PKEY_METHOD rsa_pkey_meth;
 102 extern const EVP_PKEY_METHOD rsa_pss_pkey_meth;
 103 extern const EVP_PKEY_METHOD scrypt_pkey_meth;
 104 extern const EVP_PKEY_METHOD tls1_prf_pkey_meth;
 105 extern const EVP_PKEY_METHOD hkdf_pkey_meth;
 106 extern const EVP_PKEY_METHOD poly1305_pkey_meth;
 107 extern const EVP_PKEY_METHOD siphash_pkey_meth;
 108
 109 struct evp_md_st {
 110     int type;
 111     int pkey_type;
 112     int md_size;
 113     unsigned long flags;
 114     int (*init) (EVP_MD_CTX *ctx);
 115     int (*update) (EVP_MD_CTX *ctx, const void *data, size_t count);
 116     int (*final) (EVP_MD_CTX *ctx, unsigned char *md);
 117     int (*copy) (EVP_MD_CTX *to, const EVP_MD_CTX *from);
 118     int (*cleanup) (EVP_MD_CTX *ctx);
 119     int block_size;
 120     int ctx_size;               /* how big does the ctx->md_data need to be */
 121     /* control function */
 122     int (*md_ctrl) (EVP_MD_CTX *ctx, int cmd, int p1, void *p2);
 123 } /* EVP_MD */ ;
 124
 125 struct evp_cipher_st {
 126     int nid;
 127     int block_size;
 128     /* Default value for variable length ciphers */
 129     int key_len;
 130     int iv_len;
 131     /* Various flags */
 132     unsigned long flags;
 133     /* init key */
 134     int (*init) (EVP_CIPHER_CTX *ctx, const unsigned char *key,
 135                  const unsigned char *iv, int enc);
 136     /* encrypt/decrypt data */
 137     int (*do_cipher) (EVP_CIPHER_CTX *ctx, unsigned char *out,
 138                       const unsigned char *in, size_t inl);
 139     /* cleanup ctx */
 140     int (*cleanup) (EVP_CIPHER_CTX *);
 141     /* how big ctx->cipher_data needs to be */
 142     int ctx_size;
 143     /* Populate a ASN1_TYPE with parameters */
 144     int (*set_asn1_parameters) (EVP_CIPHER_CTX *, ASN1_TYPE *);
 145     /* Get parameters from a ASN1_TYPE */
 146     int (*get_asn1_parameters) (EVP_CIPHER_CTX *, ASN1_TYPE *);
 147     /* Miscellaneous operations */
 148     int (*ctrl) (EVP_CIPHER_CTX *, int type, int arg, void *ptr);
 149     /* Application data */
 150     void *app_data;
 151 } /* EVP_CIPHER */ ;
 152
 153 /* Macros to code block cipher wrappers */
 154
 155 /* Wrapper functions for each cipher mode */
 156
 157 #define EVP_C_DATA(kstruct, ctx) \
 158         ((kstruct *)EVP_CIPHER_CTX_get_cipher_data(ctx))
 159
 160 #define BLOCK_CIPHER_ecb_loop() \
 161         size_t i, bl; \
 162         bl = EVP_CIPHER_CTX_cipher(ctx)->block_size;    \
 163         if (inl < bl) return 1;\
 164         inl -= bl; \
 165         for (i=0; i <= inl; i+=bl)
 166
 167 #define BLOCK_CIPHER_func_ecb(cname, cprefix, kstruct, ksched) \
 168 static int cname##_ecb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
 169 {\
 170         BLOCK_CIPHER_ecb_loop() \
 171             cprefix##_ecb_encrypt(in + i, out + i, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_encrypting(ctx)); \
 172         return 1;\
 173 }
 174
 175 #define EVP_MAXCHUNK ((size_t)1<<(sizeof(long)*8-2))
 176
 177 #define BLOCK_CIPHER_func_ofb(cname, cprefix, cbits, kstruct, ksched) \
 178     static int cname##_ofb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
 179 {\
 180         while(inl>=EVP_MAXCHUNK) {\
 181             int num = EVP_CIPHER_CTX_num(ctx);\
 182             cprefix##_ofb##cbits##_encrypt(in, out, (long)EVP_MAXCHUNK, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx), &num); \
 183             EVP_CIPHER_CTX_set_num(ctx, num);\
 184             inl-=EVP_MAXCHUNK;\
 185             in +=EVP_MAXCHUNK;\
 186             out+=EVP_MAXCHUNK;\
 187         }\
 188         if (inl) {\
 189             int num = EVP_CIPHER_CTX_num(ctx);\
 190             cprefix##_ofb##cbits##_encrypt(in, out, (long)inl, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx), &num); \
 191             EVP_CIPHER_CTX_set_num(ctx, num);\
 192         }\
 193         return 1;\
 194 }
 195
 196 #define BLOCK_CIPHER_func_cbc(cname, cprefix, kstruct, ksched) \
 197 static int cname##_cbc_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
 198 {\
 199         while(inl>=EVP_MAXCHUNK) \
 200             {\
 201             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));\
 202             inl-=EVP_MAXCHUNK;\
 203             in +=EVP_MAXCHUNK;\
 204             out+=EVP_MAXCHUNK;\
 205             }\
 206         if (inl)\
 207             cprefix##_cbc_encrypt(in, out, (long)inl, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx), EVP_CIPHER_CTX_encrypting(ctx));\
 208         return 1;\
 209 }
 210
 211 #define BLOCK_CIPHER_func_cfb(cname, cprefix, cbits, kstruct, ksched)  \
 212 static int cname##_cfb##cbits##_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
 213 {\
 214     size_t chunk = EVP_MAXCHUNK;\
 215     if (cbits == 1)  chunk >>= 3;\
 216     if (inl < chunk) chunk = inl;\
 217     while (inl && inl >= chunk)\
 218     {\
 219         int num = EVP_CIPHER_CTX_num(ctx);\
 220         cprefix##_cfb##cbits##_encrypt(in, out, (long) \
 221             ((cbits == 1) \
 222                 && !EVP_CIPHER_CTX_test_flags(ctx, EVP_CIPH_FLAG_LENGTH_BITS) \
 223                 ? chunk*8 : chunk), \
 224             &EVP_C_DATA(kstruct, ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx),\
 225             &num, EVP_CIPHER_CTX_encrypting(ctx));\
 226         EVP_CIPHER_CTX_set_num(ctx, num);\
 227         inl -= chunk;\
 228         in += chunk;\
 229         out += chunk;\
 230         if (inl < chunk) chunk = inl;\
 231     }\
 232     return 1;\
 233 }
 234
 235 #define BLOCK_CIPHER_all_funcs(cname, cprefix, cbits, kstruct, ksched) \
 236         BLOCK_CIPHER_func_cbc(cname, cprefix, kstruct, ksched) \
 237         BLOCK_CIPHER_func_cfb(cname, cprefix, cbits, kstruct, ksched) \
 238         BLOCK_CIPHER_func_ecb(cname, cprefix, kstruct, ksched) \
 239         BLOCK_CIPHER_func_ofb(cname, cprefix, cbits, kstruct, ksched)
 240
 241 #define BLOCK_CIPHER_def1(cname, nmode, mode, MODE, kstruct, nid, block_size, \
 242                           key_len, iv_len, flags, init_key, cleanup, \
 243                           set_asn1, get_asn1, ctrl) \
 244 static const EVP_CIPHER cname##_##mode = { \
 245         nid##_##nmode, block_size, key_len, iv_len, \
 246         flags | EVP_CIPH_##MODE##_MODE, \
 247         init_key, \
 248         cname##_##mode##_cipher, \
 249         cleanup, \
 250         sizeof(kstruct), \
 251         set_asn1, get_asn1,\
 252         ctrl, \
 253         NULL \
 254 }; \
 255 const EVP_CIPHER *EVP_##cname##_##mode(void) { return &cname##_##mode; }
 256
 257 #define BLOCK_CIPHER_def_cbc(cname, kstruct, nid, block_size, key_len, \
 258                              iv_len, flags, init_key, cleanup, set_asn1, \
 259                              get_asn1, ctrl) \
 260 BLOCK_CIPHER_def1(cname, cbc, cbc, CBC, kstruct, nid, block_size, key_len, \
 261                   iv_len, flags, init_key, cleanup, set_asn1, get_asn1, ctrl)
 262
 263 #define BLOCK_CIPHER_def_cfb(cname, kstruct, nid, key_len, \
 264                              iv_len, cbits, flags, init_key, cleanup, \
 265                              set_asn1, get_asn1, ctrl) \
 266 BLOCK_CIPHER_def1(cname, cfb##cbits, cfb##cbits, CFB, kstruct, nid, 1, \
 267                   key_len, iv_len, flags, init_key, cleanup, set_asn1, \
 268                   get_asn1, ctrl)
 269
 270 #define BLOCK_CIPHER_def_ofb(cname, kstruct, nid, key_len, \
 271                              iv_len, cbits, flags, init_key, cleanup, \
 272                              set_asn1, get_asn1, ctrl) \
 273 BLOCK_CIPHER_def1(cname, ofb##cbits, ofb, OFB, kstruct, nid, 1, \
 274                   key_len, iv_len, flags, init_key, cleanup, set_asn1, \
 275                   get_asn1, ctrl)
 276
 277 #define BLOCK_CIPHER_def_ecb(cname, kstruct, nid, block_size, key_len, \
 278                              flags, init_key, cleanup, set_asn1, \
 279                              get_asn1, ctrl) \
 280 BLOCK_CIPHER_def1(cname, ecb, ecb, ECB, kstruct, nid, block_size, key_len, \
 281                   0, flags, init_key, cleanup, set_asn1, get_asn1, ctrl)
 282
 283 #define BLOCK_CIPHER_defs(cname, kstruct, \
 284                           nid, block_size, key_len, iv_len, cbits, flags, \
 285                           init_key, cleanup, set_asn1, get_asn1, ctrl) \
 286 BLOCK_CIPHER_def_cbc(cname, kstruct, nid, block_size, key_len, iv_len, flags, \
 287                      init_key, cleanup, set_asn1, get_asn1, ctrl) \
 288 BLOCK_CIPHER_def_cfb(cname, kstruct, nid, key_len, iv_len, cbits, \
 289                      flags, init_key, cleanup, set_asn1, get_asn1, ctrl) \
 290 BLOCK_CIPHER_def_ofb(cname, kstruct, nid, key_len, iv_len, cbits, \
 291                      flags, init_key, cleanup, set_asn1, get_asn1, ctrl) \
 292 BLOCK_CIPHER_def_ecb(cname, kstruct, nid, block_size, key_len, flags, \
 293                      init_key, cleanup, set_asn1, get_asn1, ctrl)
 294
 295 /*-
 296 #define BLOCK_CIPHER_defs(cname, kstruct, \
 297                                 nid, block_size, key_len, iv_len, flags,\
 298                                  init_key, cleanup, set_asn1, get_asn1, ctrl)\
 299 static const EVP_CIPHER cname##_cbc = {\
 300         nid##_cbc, block_size, key_len, iv_len, \
 301         flags | EVP_CIPH_CBC_MODE,\
 302         init_key,\
 303         cname##_cbc_cipher,\
 304         cleanup,\
 305         sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
 306                 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
 307         set_asn1, get_asn1,\
 308         ctrl, \
 309         NULL \
 310 };\
 311 const EVP_CIPHER *EVP_##cname##_cbc(void) { return &cname##_cbc; }\
 312 static const EVP_CIPHER cname##_cfb = {\
 313         nid##_cfb64, 1, key_len, iv_len, \
 314         flags | EVP_CIPH_CFB_MODE,\
 315         init_key,\
 316         cname##_cfb_cipher,\
 317         cleanup,\
 318         sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
 319                 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
 320         set_asn1, get_asn1,\
 321         ctrl,\
 322         NULL \
 323 };\
 324 const EVP_CIPHER *EVP_##cname##_cfb(void) { return &cname##_cfb; }\
 325 static const EVP_CIPHER cname##_ofb = {\
 326         nid##_ofb64, 1, key_len, iv_len, \
 327         flags | EVP_CIPH_OFB_MODE,\
 328         init_key,\
 329         cname##_ofb_cipher,\
 330         cleanup,\
 331         sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
 332                 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
 333         set_asn1, get_asn1,\
 334         ctrl,\
 335         NULL \
 336 };\
 337 const EVP_CIPHER *EVP_##cname##_ofb(void) { return &cname##_ofb; }\
 338 static const EVP_CIPHER cname##_ecb = {\
 339         nid##_ecb, block_size, key_len, iv_len, \
 340         flags | EVP_CIPH_ECB_MODE,\
 341         init_key,\
 342         cname##_ecb_cipher,\
 343         cleanup,\
 344         sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
 345                 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
 346         set_asn1, get_asn1,\
 347         ctrl,\
 348         NULL \
 349 };\
 350 const EVP_CIPHER *EVP_##cname##_ecb(void) { return &cname##_ecb; }
 351 */
 352
 353 #define IMPLEMENT_BLOCK_CIPHER(cname, ksched, cprefix, kstruct, nid, \
 354                                block_size, key_len, iv_len, cbits, \
 355                                flags, init_key, \
 356                                cleanup, set_asn1, get_asn1, ctrl) \
 357         BLOCK_CIPHER_all_funcs(cname, cprefix, cbits, kstruct, ksched) \
 358         BLOCK_CIPHER_defs(cname, kstruct, nid, block_size, key_len, iv_len, \
 359                           cbits, flags, init_key, cleanup, set_asn1, \
 360                           get_asn1, ctrl)
 361
 362 #define IMPLEMENT_CFBR(cipher,cprefix,kstruct,ksched,keysize,cbits,iv_len,fl) \
 363         BLOCK_CIPHER_func_cfb(cipher##_##keysize,cprefix,cbits,kstruct,ksched) \
 364         BLOCK_CIPHER_def_cfb(cipher##_##keysize,kstruct, \
 365                              NID_##cipher##_##keysize, keysize/8, iv_len, cbits, \
 366                              (fl)|EVP_CIPH_FLAG_DEFAULT_ASN1, \
 367                              cipher##_init_key, NULL, NULL, NULL, NULL)
 368
 369
 370 # ifndef OPENSSL_NO_EC
 371
 372 #define X25519_KEYLEN        32
 373 #define X448_KEYLEN          56
 374 #define ED448_KEYLEN         57
 375
 376 #define MAX_KEYLEN  ED448_KEYLEN
 377
 378 typedef struct {
 379     unsigned char pubkey[MAX_KEYLEN];
 380     unsigned char *privkey;
 381 } ECX_KEY;
 382
 383 #endif
 384
 385 /*
 386  * Type needs to be a bit field Sub-type needs to be for variations on the
 387  * method, as in, can it do arbitrary encryption....
 388  */
 389 struct evp_pkey_st {
 390     int type;
 391     int save_type;
 392     CRYPTO_REF_COUNT references;
 393     const EVP_PKEY_ASN1_METHOD *ameth;
 394     ENGINE *engine;
 395     ENGINE *pmeth_engine; /* If not NULL public key ENGINE to use */
 396     union {
 397         void *ptr;
 398 # ifndef OPENSSL_NO_RSA
 399         struct rsa_st *rsa;     /* RSA */
 400 # endif
 401 # ifndef OPENSSL_NO_DSA
 402         struct dsa_st *dsa;     /* DSA */
 403 # endif
 404 # ifndef OPENSSL_NO_DH
 405         struct dh_st *dh;       /* DH */
 406 # endif
 407 # ifndef OPENSSL_NO_EC
 408         struct ec_key_st *ec;   /* ECC */
 409         ECX_KEY *ecx;           /* X25519, X448, Ed25519, Ed448 */
 410 # endif
 411     } pkey;
 412     int save_parameters;
 413     STACK_OF(X509_ATTRIBUTE) *attributes; /* [ 0 ] */
 414     CRYPTO_RWLOCK *lock;
 415 } /* EVP_PKEY */ ;
 416
 417
 418 void openssl_add_all_ciphers_int(void);
 419 void openssl_add_all_digests_int(void);
 420 void evp_cleanup_int(void);
 421 void evp_app_cleanup_int(void);
 422
 423 /* Pulling defines out of C source files */
 424
 425 #define EVP_RC4_KEY_SIZE 16
 426 #ifndef TLS1_1_VERSION
 427 # define TLS1_1_VERSION   0x0302
 428 #endif
 429
 430 void evp_encode_ctx_set_flags(EVP_ENCODE_CTX *ctx, unsigned int flags);
 431
 432 /* EVP_ENCODE_CTX flags */
 433 /* Don't generate new lines when encoding */
 434 #define EVP_ENCODE_CTX_NO_NEWLINES          1
 435 /* Use the SRP base64 alphabet instead of the standard one */
 436 #define EVP_ENCODE_CTX_USE_SRP_ALPHABET     2