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