crypto/include/internal/evp_int.h

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