crypto/include/internal/evp_int.h

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