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 struct evp_pkey_ctx_st {
  11     /* Method associated with this operation */
  12     const EVP_PKEY_METHOD *pmeth;
  13     /* Engine that implements this method or NULL if builtin */
  14     ENGINE *engine;
  15     /* Key: may be NULL */
  16     EVP_PKEY *pkey;
  17     /* Peer key for key agreement, may be NULL */
  18     EVP_PKEY *peerkey;
  19     /* Actual operation */
  20     int operation;
  21     /* Algorithm specific data */
  22     void *data;
  23     /* Application specific data */
  24     void *app_data;
  25     /* Keygen callback */
  26     EVP_PKEY_gen_cb *pkey_gencb;
  27     /* implementation specific keygen data */
  28     int *keygen_info;
  29     int keygen_info_count;
  30 } /* EVP_PKEY_CTX */ ;
  31
  32 #define EVP_PKEY_FLAG_DYNAMIC   1
  33
  34 struct evp_pkey_method_st {
  35     int pkey_id;
  36     int flags;
  37     int (*init) (EVP_PKEY_CTX *ctx);
  38     int (*copy) (EVP_PKEY_CTX *dst, EVP_PKEY_CTX *src);
  39     void (*cleanup) (EVP_PKEY_CTX *ctx);
  40     int (*paramgen_init) (EVP_PKEY_CTX *ctx);
  41     int (*paramgen) (EVP_PKEY_CTX *ctx, EVP_PKEY *pkey);
  42     int (*keygen_init) (EVP_PKEY_CTX *ctx);
  43     int (*keygen) (EVP_PKEY_CTX *ctx, EVP_PKEY *pkey);
  44     int (*sign_init) (EVP_PKEY_CTX *ctx);
  45     int (*sign) (EVP_PKEY_CTX *ctx, unsigned char *sig, size_t *siglen,
  46                  const unsigned char *tbs, size_t tbslen);
  47     int (*verify_init) (EVP_PKEY_CTX *ctx);
  48     int (*verify) (EVP_PKEY_CTX *ctx,
  49                    const unsigned char *sig, size_t siglen,
  50                    const unsigned char *tbs, size_t tbslen);
  51     int (*verify_recover_init) (EVP_PKEY_CTX *ctx);
  52     int (*verify_recover) (EVP_PKEY_CTX *ctx,
  53                            unsigned char *rout, size_t *routlen,
  54                            const unsigned char *sig, size_t siglen);
  55     int (*signctx_init) (EVP_PKEY_CTX *ctx, EVP_MD_CTX *mctx);
  56     int (*signctx) (EVP_PKEY_CTX *ctx, unsigned char *sig, size_t *siglen,
  57                     EVP_MD_CTX *mctx);
  58     int (*verifyctx_init) (EVP_PKEY_CTX *ctx, EVP_MD_CTX *mctx);
  59     int (*verifyctx) (EVP_PKEY_CTX *ctx, const unsigned char *sig, int siglen,
  60                       EVP_MD_CTX *mctx);
  61     int (*encrypt_init) (EVP_PKEY_CTX *ctx);
  62     int (*encrypt) (EVP_PKEY_CTX *ctx, unsigned char *out, size_t *outlen,
  63                     const unsigned char *in, size_t inlen);
  64     int (*decrypt_init) (EVP_PKEY_CTX *ctx);
  65     int (*decrypt) (EVP_PKEY_CTX *ctx, unsigned char *out, size_t *outlen,
  66                     const unsigned char *in, size_t inlen);
  67     int (*derive_init) (EVP_PKEY_CTX *ctx);
  68     int (*derive) (EVP_PKEY_CTX *ctx, unsigned char *key, size_t *keylen);
  69     int (*ctrl) (EVP_PKEY_CTX *ctx, int type, int p1, void *p2);
  70     int (*ctrl_str) (EVP_PKEY_CTX *ctx, const char *type, const char *value);
  71 } /* EVP_PKEY_METHOD */ ;
  72
  73 DEFINE_STACK_OF_CONST(EVP_PKEY_METHOD)
  74
  75 void evp_pkey_set_cb_translate(BN_GENCB *cb, EVP_PKEY_CTX *ctx);
  76
  77 extern const EVP_PKEY_METHOD cmac_pkey_meth;
  78 extern const EVP_PKEY_METHOD dh_pkey_meth;
  79 extern const EVP_PKEY_METHOD dhx_pkey_meth;
  80 extern const EVP_PKEY_METHOD dsa_pkey_meth;
  81 extern const EVP_PKEY_METHOD ec_pkey_meth;
  82 extern const EVP_PKEY_METHOD hmac_pkey_meth;
  83 extern const EVP_PKEY_METHOD rsa_pkey_meth;
  84 extern const EVP_PKEY_METHOD tls1_prf_pkey_meth;
  85 extern const EVP_PKEY_METHOD hkdf_pkey_meth;
  86
  87 struct evp_md_st {
  88     int type;
  89     int pkey_type;
  90     int md_size;
  91     unsigned long flags;
  92     int (*init) (EVP_MD_CTX *ctx);
  93     int (*update) (EVP_MD_CTX *ctx, const void *data, size_t count);
  94     int (*final) (EVP_MD_CTX *ctx, unsigned char *md);
  95     int (*copy) (EVP_MD_CTX *to, const EVP_MD_CTX *from);
  96     int (*cleanup) (EVP_MD_CTX *ctx);
  97     int block_size;
  98     int ctx_size;               /* how big does the ctx->md_data need to be */
  99     /* control function */
 100     int (*md_ctrl) (EVP_MD_CTX *ctx, int cmd, int p1, void *p2);
 101 } /* EVP_MD */ ;
 102
 103 struct evp_cipher_st {
 104     int nid;
 105     int block_size;
 106     /* Default value for variable length ciphers */
 107     int key_len;
 108     int iv_len;
 109     /* Various flags */
 110     unsigned long flags;
 111     /* init key */
 112     int (*init) (EVP_CIPHER_CTX *ctx, const unsigned char *key,
 113                  const unsigned char *iv, int enc);
 114     /* encrypt/decrypt data */
 115     int (*do_cipher) (EVP_CIPHER_CTX *ctx, unsigned char *out,
 116                       const unsigned char *in, size_t inl);
 117     /* cleanup ctx */
 118     int (*cleanup) (EVP_CIPHER_CTX *);
 119     /* how big ctx->cipher_data needs to be */
 120     int ctx_size;
 121     /* Populate a ASN1_TYPE with parameters */
 122     int (*set_asn1_parameters) (EVP_CIPHER_CTX *, ASN1_TYPE *);
 123     /* Get parameters from a ASN1_TYPE */
 124     int (*get_asn1_parameters) (EVP_CIPHER_CTX *, ASN1_TYPE *);
 125     /* Miscellaneous operations */
 126     int (*ctrl) (EVP_CIPHER_CTX *, int type, int arg, void *ptr);
 127     /* Application data */
 128     void *app_data;
 129 } /* EVP_CIPHER */ ;
 130
 131 /* Macros to code block cipher wrappers */
 132
 133 /* Wrapper functions for each cipher mode */
 134
 135 #define EVP_C_DATA(kstruct, ctx) \
 136         ((kstruct *)EVP_CIPHER_CTX_get_cipher_data(ctx))
 137
 138 #define BLOCK_CIPHER_ecb_loop() \
 139         size_t i, bl; \
 140         bl = EVP_CIPHER_CTX_cipher(ctx)->block_size;    \
 141         if(inl < bl) return 1;\
 142         inl -= bl; \
 143         for(i=0; i <= inl; i+=bl)
 144
 145 #define BLOCK_CIPHER_func_ecb(cname, cprefix, kstruct, ksched) \
 146 static int cname##_ecb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
 147 {\
 148         BLOCK_CIPHER_ecb_loop() \
 149             cprefix##_ecb_encrypt(in + i, out + i, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_encrypting(ctx)); \
 150         return 1;\
 151 }
 152
 153 #define EVP_MAXCHUNK ((size_t)1<<(sizeof(long)*8-2))
 154
 155 #define BLOCK_CIPHER_func_ofb(cname, cprefix, cbits, kstruct, ksched) \
 156     static int cname##_ofb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
 157 {\
 158         while(inl>=EVP_MAXCHUNK) {\
 159             int num = EVP_CIPHER_CTX_num(ctx);\
 160             cprefix##_ofb##cbits##_encrypt(in, out, (long)EVP_MAXCHUNK, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx), &num); \
 161             EVP_CIPHER_CTX_set_num(ctx, num);\
 162             inl-=EVP_MAXCHUNK;\
 163             in +=EVP_MAXCHUNK;\
 164             out+=EVP_MAXCHUNK;\
 165         }\
 166         if (inl) {\
 167             int num = EVP_CIPHER_CTX_num(ctx);\
 168             cprefix##_ofb##cbits##_encrypt(in, out, (long)inl, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx), &num); \
 169             EVP_CIPHER_CTX_set_num(ctx, num);\
 170         }\
 171         return 1;\
 172 }
 173
 174 #define BLOCK_CIPHER_func_cbc(cname, cprefix, kstruct, ksched) \
 175 static int cname##_cbc_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
 176 {\
 177         while(inl>=EVP_MAXCHUNK) \
 178             {\
 179             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));\
 180             inl-=EVP_MAXCHUNK;\
 181             in +=EVP_MAXCHUNK;\
 182             out+=EVP_MAXCHUNK;\
 183             }\
 184         if (inl)\
 185             cprefix##_cbc_encrypt(in, out, (long)inl, &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx), EVP_CIPHER_CTX_encrypting(ctx));\
 186         return 1;\
 187 }
 188
 189 #define BLOCK_CIPHER_func_cfb(cname, cprefix, cbits, kstruct, ksched)  \
 190 static int cname##_cfb##cbits##_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, const unsigned char *in, size_t inl) \
 191 {\
 192         size_t chunk=EVP_MAXCHUNK;\
 193         if (cbits==1)  chunk>>=3;\
 194         if (inl<chunk) chunk=inl;\
 195         while(inl && inl>=chunk)\
 196             {\
 197             int num = EVP_CIPHER_CTX_num(ctx);\
 198             cprefix##_cfb##cbits##_encrypt(in, out, (long)((cbits==1) && !EVP_CIPHER_CTX_test_flags(ctx, EVP_CIPH_FLAG_LENGTH_BITS) ?inl*8:inl), &EVP_C_DATA(kstruct,ctx)->ksched, EVP_CIPHER_CTX_iv_noconst(ctx), &num, EVP_CIPHER_CTX_encrypting(ctx)); \
 199             EVP_CIPHER_CTX_set_num(ctx, num);\
 200             inl-=chunk;\
 201             in +=chunk;\
 202             out+=chunk;\
 203             if(inl<chunk) chunk=inl;\
 204             }\
 205         return 1;\
 206 }
 207
 208 #define BLOCK_CIPHER_all_funcs(cname, cprefix, cbits, kstruct, ksched) \
 209         BLOCK_CIPHER_func_cbc(cname, cprefix, kstruct, ksched) \
 210         BLOCK_CIPHER_func_cfb(cname, cprefix, cbits, kstruct, ksched) \
 211         BLOCK_CIPHER_func_ecb(cname, cprefix, kstruct, ksched) \
 212         BLOCK_CIPHER_func_ofb(cname, cprefix, cbits, kstruct, ksched)
 213
 214 #define BLOCK_CIPHER_def1(cname, nmode, mode, MODE, kstruct, nid, block_size, \
 215                           key_len, iv_len, flags, init_key, cleanup, \
 216                           set_asn1, get_asn1, ctrl) \
 217 static const EVP_CIPHER cname##_##mode = { \
 218         nid##_##nmode, block_size, key_len, iv_len, \
 219         flags | EVP_CIPH_##MODE##_MODE, \
 220         init_key, \
 221         cname##_##mode##_cipher, \
 222         cleanup, \
 223         sizeof(kstruct), \
 224         set_asn1, get_asn1,\
 225         ctrl, \
 226         NULL \
 227 }; \
 228 const EVP_CIPHER *EVP_##cname##_##mode(void) { return &cname##_##mode; }
 229
 230 #define BLOCK_CIPHER_def_cbc(cname, kstruct, nid, block_size, key_len, \
 231                              iv_len, flags, init_key, cleanup, set_asn1, \
 232                              get_asn1, ctrl) \
 233 BLOCK_CIPHER_def1(cname, cbc, cbc, CBC, kstruct, nid, block_size, key_len, \
 234                   iv_len, flags, init_key, cleanup, set_asn1, get_asn1, ctrl)
 235
 236 #define BLOCK_CIPHER_def_cfb(cname, kstruct, nid, key_len, \
 237                              iv_len, cbits, flags, init_key, cleanup, \
 238                              set_asn1, get_asn1, ctrl) \
 239 BLOCK_CIPHER_def1(cname, cfb##cbits, cfb##cbits, CFB, kstruct, nid, 1, \
 240                   key_len, iv_len, flags, init_key, cleanup, set_asn1, \
 241                   get_asn1, ctrl)
 242
 243 #define BLOCK_CIPHER_def_ofb(cname, kstruct, nid, key_len, \
 244                              iv_len, cbits, flags, init_key, cleanup, \
 245                              set_asn1, get_asn1, ctrl) \
 246 BLOCK_CIPHER_def1(cname, ofb##cbits, ofb, OFB, kstruct, nid, 1, \
 247                   key_len, iv_len, flags, init_key, cleanup, set_asn1, \
 248                   get_asn1, ctrl)
 249
 250 #define BLOCK_CIPHER_def_ecb(cname, kstruct, nid, block_size, key_len, \
 251                              flags, init_key, cleanup, set_asn1, \
 252                              get_asn1, ctrl) \
 253 BLOCK_CIPHER_def1(cname, ecb, ecb, ECB, kstruct, nid, block_size, key_len, \
 254                   0, flags, init_key, cleanup, set_asn1, get_asn1, ctrl)
 255
 256 #define BLOCK_CIPHER_defs(cname, kstruct, \
 257                           nid, block_size, key_len, iv_len, cbits, flags, \
 258                           init_key, cleanup, set_asn1, get_asn1, ctrl) \
 259 BLOCK_CIPHER_def_cbc(cname, kstruct, nid, block_size, key_len, iv_len, flags, \
 260                      init_key, cleanup, set_asn1, get_asn1, ctrl) \
 261 BLOCK_CIPHER_def_cfb(cname, kstruct, nid, key_len, iv_len, cbits, \
 262                      flags, init_key, cleanup, set_asn1, get_asn1, ctrl) \
 263 BLOCK_CIPHER_def_ofb(cname, kstruct, nid, key_len, iv_len, cbits, \
 264                      flags, init_key, cleanup, set_asn1, get_asn1, ctrl) \
 265 BLOCK_CIPHER_def_ecb(cname, kstruct, nid, block_size, key_len, flags, \
 266                      init_key, cleanup, set_asn1, get_asn1, ctrl)
 267
 268 /*-
 269 #define BLOCK_CIPHER_defs(cname, kstruct, \
 270                                 nid, block_size, key_len, iv_len, flags,\
 271                                  init_key, cleanup, set_asn1, get_asn1, ctrl)\
 272 static const EVP_CIPHER cname##_cbc = {\
 273         nid##_cbc, block_size, key_len, iv_len, \
 274         flags | EVP_CIPH_CBC_MODE,\
 275         init_key,\
 276         cname##_cbc_cipher,\
 277         cleanup,\
 278         sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
 279                 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
 280         set_asn1, get_asn1,\
 281         ctrl, \
 282         NULL \
 283 };\
 284 const EVP_CIPHER *EVP_##cname##_cbc(void) { return &cname##_cbc; }\
 285 static const EVP_CIPHER cname##_cfb = {\
 286         nid##_cfb64, 1, key_len, iv_len, \
 287         flags | EVP_CIPH_CFB_MODE,\
 288         init_key,\
 289         cname##_cfb_cipher,\
 290         cleanup,\
 291         sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
 292                 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
 293         set_asn1, get_asn1,\
 294         ctrl,\
 295         NULL \
 296 };\
 297 const EVP_CIPHER *EVP_##cname##_cfb(void) { return &cname##_cfb; }\
 298 static const EVP_CIPHER cname##_ofb = {\
 299         nid##_ofb64, 1, key_len, iv_len, \
 300         flags | EVP_CIPH_OFB_MODE,\
 301         init_key,\
 302         cname##_ofb_cipher,\
 303         cleanup,\
 304         sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
 305                 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
 306         set_asn1, get_asn1,\
 307         ctrl,\
 308         NULL \
 309 };\
 310 const EVP_CIPHER *EVP_##cname##_ofb(void) { return &cname##_ofb; }\
 311 static const EVP_CIPHER cname##_ecb = {\
 312         nid##_ecb, block_size, key_len, iv_len, \
 313         flags | EVP_CIPH_ECB_MODE,\
 314         init_key,\
 315         cname##_ecb_cipher,\
 316         cleanup,\
 317         sizeof(EVP_CIPHER_CTX)-sizeof((((EVP_CIPHER_CTX *)NULL)->c))+\
 318                 sizeof((((EVP_CIPHER_CTX *)NULL)->c.kstruct)),\
 319         set_asn1, get_asn1,\
 320         ctrl,\
 321         NULL \
 322 };\
 323 const EVP_CIPHER *EVP_##cname##_ecb(void) { return &cname##_ecb; }
 324 */
 325
 326 #define IMPLEMENT_BLOCK_CIPHER(cname, ksched, cprefix, kstruct, nid, \
 327                                block_size, key_len, iv_len, cbits, \
 328                                flags, init_key, \
 329                                cleanup, set_asn1, get_asn1, ctrl) \
 330         BLOCK_CIPHER_all_funcs(cname, cprefix, cbits, kstruct, ksched) \
 331         BLOCK_CIPHER_defs(cname, kstruct, nid, block_size, key_len, iv_len, \
 332                           cbits, flags, init_key, cleanup, set_asn1, \
 333                           get_asn1, ctrl)
 334
 335 #define IMPLEMENT_CFBR(cipher,cprefix,kstruct,ksched,keysize,cbits,iv_len,fl) \
 336         BLOCK_CIPHER_func_cfb(cipher##_##keysize,cprefix,cbits,kstruct,ksched) \
 337         BLOCK_CIPHER_def_cfb(cipher##_##keysize,kstruct, \
 338                              NID_##cipher##_##keysize, keysize/8, iv_len, cbits, \
 339                              (fl)|EVP_CIPH_FLAG_DEFAULT_ASN1, \
 340                              cipher##_init_key, NULL, NULL, NULL, NULL)
 341
 342
 343 /*
 344  * Type needs to be a bit field Sub-type needs to be for variations on the
 345  * method, as in, can it do arbitrary encryption....
 346  */
 347 struct evp_pkey_st {
 348     int type;
 349     int save_type;
 350     int references;
 351     const EVP_PKEY_ASN1_METHOD *ameth;
 352     ENGINE *engine;
 353     union {
 354         char *ptr;
 355 # ifndef OPENSSL_NO_RSA
 356         struct rsa_st *rsa;     /* RSA */
 357 # endif
 358 # ifndef OPENSSL_NO_DSA
 359         struct dsa_st *dsa;     /* DSA */
 360 # endif
 361 # ifndef OPENSSL_NO_DH
 362         struct dh_st *dh;       /* DH */
 363 # endif
 364 # ifndef OPENSSL_NO_EC
 365         struct ec_key_st *ec;   /* ECC */
 366 # endif
 367     } pkey;
 368     int save_parameters;
 369     STACK_OF(X509_ATTRIBUTE) *attributes; /* [ 0 ] */
 370     CRYPTO_RWLOCK *lock;
 371 } /* EVP_PKEY */ ;
 372
 373
 374 void openssl_add_all_ciphers_int(void);
 375 void openssl_add_all_digests_int(void);
 376 void evp_cleanup_int(void);