crypto/evp/evp_local.h

   1 /*
   2  * Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the Apache License 2.0 (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 /* EVP_MD_CTX related stuff */
  11
  12 #include <openssl/core_numbers.h>
  13
  14 #define EVP_CTRL_RET_UNSUPPORTED -1
  15
  16
  17 struct evp_md_ctx_st {
  18     const EVP_MD *reqdigest;    /* The original requested digest */
  19     const EVP_MD *digest;
  20     ENGINE *engine;             /* functional reference if 'digest' is
  21                                  * ENGINE-provided */
  22     unsigned long flags;
  23     void *md_data;
  24     /* Public key context for sign/verify */
  25     EVP_PKEY_CTX *pctx;
  26     /* Update function: usually copied from EVP_MD */
  27     int (*update) (EVP_MD_CTX *ctx, const void *data, size_t count);
  28
  29     /* Provider ctx */
  30     void *provctx;
  31     EVP_MD *fetched_digest;
  32 } /* EVP_MD_CTX */ ;
  33
  34 struct evp_cipher_ctx_st {
  35     const EVP_CIPHER *cipher;
  36     ENGINE *engine;             /* functional reference if 'cipher' is
  37                                  * ENGINE-provided */
  38     int encrypt;                /* encrypt or decrypt */
  39     int buf_len;                /* number we have left */
  40     unsigned char oiv[EVP_MAX_IV_LENGTH]; /* original iv */
  41     unsigned char iv[EVP_MAX_IV_LENGTH]; /* working iv */
  42     unsigned char buf[EVP_MAX_BLOCK_LENGTH]; /* saved partial block */
  43     int num;                    /* used by cfb/ofb/ctr mode */
  44     /* FIXME: Should this even exist? It appears unused */
  45     void *app_data;             /* application stuff */
  46     int key_len;                /* May change for variable length cipher */
  47     unsigned long flags;        /* Various flags */
  48     void *cipher_data;          /* per EVP data */
  49     int final_used;
  50     int block_mask;
  51     unsigned char final[EVP_MAX_BLOCK_LENGTH]; /* possible final block */
  52
  53     /* Provider ctx */
  54     void *provctx;
  55     EVP_CIPHER *fetched_cipher;
  56 } /* EVP_CIPHER_CTX */ ;
  57
  58 struct evp_mac_ctx_st {
  59     EVP_MAC *meth;               /* Method structure */
  60     void *data;                  /* Individual method data */
  61 } /* EVP_MAC_CTX */;
  62
  63 struct evp_kdf_ctx_st {
  64     EVP_KDF *meth;              /* Method structure */
  65     void *data;                 /* Algorithm-specific data */
  66 } /* EVP_KDF_CTX */ ;
  67
  68 struct evp_keymgmt_st {
  69     int id;                      /* libcrypto internal */
  70
  71     int name_id;
  72     OSSL_PROVIDER *prov;
  73     CRYPTO_REF_COUNT refcnt;
  74     CRYPTO_RWLOCK *lock;
  75
  76     /* Constructor(s), destructor, information */
  77     OSSL_OP_keymgmt_new_fn *new;
  78     OSSL_OP_keymgmt_free_fn *free;
  79     OSSL_OP_keymgmt_get_params_fn *get_params;
  80     OSSL_OP_keymgmt_gettable_params_fn *gettable_params;
  81     OSSL_OP_keymgmt_set_params_fn *set_params;
  82     OSSL_OP_keymgmt_settable_params_fn *settable_params;
  83
  84     /* Key object checking */
  85     OSSL_OP_keymgmt_query_operation_name_fn *query_operation_name;
  86     OSSL_OP_keymgmt_has_fn *has;
  87     OSSL_OP_keymgmt_validate_fn *validate;
  88     OSSL_OP_keymgmt_match_fn *match;
  89
  90     /* Import and export routines */
  91     OSSL_OP_keymgmt_import_fn *import;
  92     OSSL_OP_keymgmt_import_types_fn *import_types;
  93     OSSL_OP_keymgmt_export_fn *export;
  94     OSSL_OP_keymgmt_export_types_fn *export_types;
  95     OSSL_OP_keymgmt_copy_fn *copy;
  96 } /* EVP_KEYMGMT */ ;
  97
  98 struct evp_keyexch_st {
  99     int name_id;
 100     OSSL_PROVIDER *prov;
 101     CRYPTO_REF_COUNT refcnt;
 102     CRYPTO_RWLOCK *lock;
 103
 104     OSSL_OP_keyexch_newctx_fn *newctx;
 105     OSSL_OP_keyexch_init_fn *init;
 106     OSSL_OP_keyexch_set_peer_fn *set_peer;
 107     OSSL_OP_keyexch_derive_fn *derive;
 108     OSSL_OP_keyexch_freectx_fn *freectx;
 109     OSSL_OP_keyexch_dupctx_fn *dupctx;
 110     OSSL_OP_keyexch_set_ctx_params_fn *set_ctx_params;
 111     OSSL_OP_keyexch_settable_ctx_params_fn *settable_ctx_params;
 112     OSSL_OP_keyexch_get_ctx_params_fn *get_ctx_params;
 113     OSSL_OP_keyexch_gettable_ctx_params_fn *gettable_ctx_params;
 114 } /* EVP_KEYEXCH */;
 115
 116 struct evp_signature_st {
 117     int name_id;
 118     OSSL_PROVIDER *prov;
 119     CRYPTO_REF_COUNT refcnt;
 120     CRYPTO_RWLOCK *lock;
 121
 122     OSSL_OP_signature_newctx_fn *newctx;
 123     OSSL_OP_signature_sign_init_fn *sign_init;
 124     OSSL_OP_signature_sign_fn *sign;
 125     OSSL_OP_signature_verify_init_fn *verify_init;
 126     OSSL_OP_signature_verify_fn *verify;
 127     OSSL_OP_signature_verify_recover_init_fn *verify_recover_init;
 128     OSSL_OP_signature_verify_recover_fn *verify_recover;
 129     OSSL_OP_signature_digest_sign_init_fn *digest_sign_init;
 130     OSSL_OP_signature_digest_sign_update_fn *digest_sign_update;
 131     OSSL_OP_signature_digest_sign_final_fn *digest_sign_final;
 132     OSSL_OP_signature_digest_sign_fn *digest_sign;
 133     OSSL_OP_signature_digest_verify_init_fn *digest_verify_init;
 134     OSSL_OP_signature_digest_verify_update_fn *digest_verify_update;
 135     OSSL_OP_signature_digest_verify_final_fn *digest_verify_final;
 136     OSSL_OP_signature_digest_verify_fn *digest_verify;
 137     OSSL_OP_signature_freectx_fn *freectx;
 138     OSSL_OP_signature_dupctx_fn *dupctx;
 139     OSSL_OP_signature_get_ctx_params_fn *get_ctx_params;
 140     OSSL_OP_signature_gettable_ctx_params_fn *gettable_ctx_params;
 141     OSSL_OP_signature_set_ctx_params_fn *set_ctx_params;
 142     OSSL_OP_signature_settable_ctx_params_fn *settable_ctx_params;
 143     OSSL_OP_signature_get_ctx_md_params_fn *get_ctx_md_params;
 144     OSSL_OP_signature_gettable_ctx_md_params_fn *gettable_ctx_md_params;
 145     OSSL_OP_signature_set_ctx_md_params_fn *set_ctx_md_params;
 146     OSSL_OP_signature_settable_ctx_md_params_fn *settable_ctx_md_params;
 147 } /* EVP_SIGNATURE */;
 148
 149 struct evp_asym_cipher_st {
 150     int name_id;
 151     OSSL_PROVIDER *prov;
 152     CRYPTO_REF_COUNT refcnt;
 153     CRYPTO_RWLOCK *lock;
 154
 155     OSSL_OP_asym_cipher_newctx_fn *newctx;
 156     OSSL_OP_asym_cipher_encrypt_init_fn *encrypt_init;
 157     OSSL_OP_asym_cipher_encrypt_fn *encrypt;
 158     OSSL_OP_asym_cipher_decrypt_init_fn *decrypt_init;
 159     OSSL_OP_asym_cipher_decrypt_fn *decrypt;
 160     OSSL_OP_asym_cipher_freectx_fn *freectx;
 161     OSSL_OP_asym_cipher_dupctx_fn *dupctx;
 162     OSSL_OP_asym_cipher_get_ctx_params_fn *get_ctx_params;
 163     OSSL_OP_asym_cipher_gettable_ctx_params_fn *gettable_ctx_params;
 164     OSSL_OP_asym_cipher_set_ctx_params_fn *set_ctx_params;
 165     OSSL_OP_asym_cipher_settable_ctx_params_fn *settable_ctx_params;
 166 } /* EVP_ASYM_CIPHER */;
 167
 168 int PKCS5_v2_PBKDF2_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass,
 169                              int passlen, ASN1_TYPE *param,
 170                              const EVP_CIPHER *c, const EVP_MD *md,
 171                              int en_de);
 172
 173 struct evp_Encode_Ctx_st {
 174     /* number saved in a partial encode/decode */
 175     int num;
 176     /*
 177      * The length is either the output line length (in input bytes) or the
 178      * shortest input line length that is ok.  Once decoding begins, the
 179      * length is adjusted up each time a longer line is decoded
 180      */
 181     int length;
 182     /* data to encode */
 183     unsigned char enc_data[80];
 184     /* number read on current line */
 185     int line_num;
 186     unsigned int flags;
 187 };
 188
 189 typedef struct evp_pbe_st EVP_PBE_CTL;
 190 DEFINE_STACK_OF(EVP_PBE_CTL)
 191
 192 int is_partially_overlapping(const void *ptr1, const void *ptr2, int len);
 193
 194 #include <openssl/types.h>
 195 #include <openssl/core.h>
 196
 197 void *evp_generic_fetch(OPENSSL_CTX *ctx, int operation_id,
 198                         const char *name, const char *properties,
 199                         void *(*new_method)(int name_id,
 200                                             const OSSL_DISPATCH *fns,
 201                                             OSSL_PROVIDER *prov),
 202                         int (*up_ref_method)(void *),
 203                         void (*free_method)(void *));
 204 void *evp_generic_fetch_by_number(OPENSSL_CTX *ctx, int operation_id,
 205                                   int name_id, const char *properties,
 206                                   void *(*new_method)(int name_id,
 207                                                       const OSSL_DISPATCH *fns,
 208                                                       OSSL_PROVIDER *prov),
 209                                   int (*up_ref_method)(void *),
 210                                   void (*free_method)(void *));
 211 void evp_generic_do_all(OPENSSL_CTX *libctx, int operation_id,
 212                         void (*user_fn)(void *method, void *arg),
 213                         void *user_arg,
 214                         void *(*new_method)(int name_id,
 215                                             const OSSL_DISPATCH *fns,
 216                                             OSSL_PROVIDER *prov),
 217                         void (*free_method)(void *));
 218
 219 /* Internal fetchers for method types that are to be combined with others */
 220 EVP_KEYMGMT *evp_keymgmt_fetch_by_number(OPENSSL_CTX *ctx, int name_id,
 221                                          const char *properties);
 222
 223 /* Internal structure constructors for fetched methods */
 224 EVP_MD *evp_md_new(void);
 225 EVP_CIPHER *evp_cipher_new(void);
 226
 227 /* Helper functions to avoid duplicating code */
 228
 229 /*
 230  * These methods implement different ways to pass a params array to the
 231  * provider.  They will return one of these values:
 232  *
 233  * -2 if the method doesn't come from a provider
 234  *    (evp_do_param will return this to the called)
 235  * -1 if the provider doesn't offer the desired function
 236  *    (evp_do_param will raise an error and return 0)
 237  * or the return value from the desired function
 238  *    (evp_do_param will return it to the caller)
 239  */
 240 int evp_do_ciph_getparams(const EVP_CIPHER *ciph, OSSL_PARAM params[]);
 241 int evp_do_ciph_ctx_getparams(const EVP_CIPHER *ciph, void *provctx,
 242                               OSSL_PARAM params[]);
 243 int evp_do_ciph_ctx_setparams(const EVP_CIPHER *ciph, void *provctx,
 244                               OSSL_PARAM params[]);
 245 int evp_do_md_getparams(const EVP_MD *md, OSSL_PARAM params[]);
 246 int evp_do_md_ctx_getparams(const EVP_MD *md, void *provctx,
 247                             OSSL_PARAM params[]);
 248 int evp_do_md_ctx_setparams(const EVP_MD *md, void *provctx,
 249                             OSSL_PARAM params[]);
 250
 251 OSSL_PARAM *evp_pkey_to_param(EVP_PKEY *pkey, size_t *sz);
 252
 253 #define M_check_autoarg(ctx, arg, arglen, err) \
 254     if (ctx->pmeth->flags & EVP_PKEY_FLAG_AUTOARGLEN) {           \
 255         size_t pksize = (size_t)EVP_PKEY_size(ctx->pkey);         \
 256                                                                   \
 257         if (pksize == 0) {                                        \
 258             ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_KEY); /*ckerr_ignore*/ \
 259             return 0;                                             \
 260         }                                                         \
 261         if (arg == NULL) {                                        \
 262             *arglen = pksize;                                     \
 263             return 1;                                             \
 264         }                                                         \
 265         if (*arglen < pksize) {                                   \
 266             ERR_raise(ERR_LIB_EVP, EVP_R_BUFFER_TOO_SMALL); /*ckerr_ignore*/ \
 267             return 0;                                             \
 268         }                                                         \
 269     }
 270
 271 void evp_pkey_ctx_free_old_ops(EVP_PKEY_CTX *ctx);
 272
 273 /* OSSL_PROVIDER * is only used to get the library context */
 274 const char *evp_first_name(const OSSL_PROVIDER *prov, int name_id);
 275 int evp_is_a(OSSL_PROVIDER *prov, int number,
 276              const char *legacy_name, const char *name);
 277 void evp_names_do_all(OSSL_PROVIDER *prov, int number,
 278                       void (*fn)(const char *name, void *data),
 279                       void *data);
 280 int evp_cipher_cache_constants(EVP_CIPHER *cipher);