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