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