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