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