Add the ability to set PKCS#3 DH padding in providers
[openssl.git] / crypto / evp / evp_locl.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 struct evp_md_ctx_st {
15     const EVP_MD *reqdigest;    /* The original requested digest */
16     const EVP_MD *digest;
17     ENGINE *engine;             /* functional reference if 'digest' is
18                                  * ENGINE-provided */
19     unsigned long flags;
20     void *md_data;
21     /* Public key context for sign/verify */
22     EVP_PKEY_CTX *pctx;
23     /* Update function: usually copied from EVP_MD */
24     int (*update) (EVP_MD_CTX *ctx, const void *data, size_t count);
25
26     /* Provider ctx */
27     void *provctx;
28     EVP_MD *fetched_digest;
29 } /* EVP_MD_CTX */ ;
30
31 struct evp_cipher_ctx_st {
32     const EVP_CIPHER *cipher;
33     ENGINE *engine;             /* functional reference if 'cipher' is
34                                  * ENGINE-provided */
35     int encrypt;                /* encrypt or decrypt */
36     int buf_len;                /* number we have left */
37     unsigned char oiv[EVP_MAX_IV_LENGTH]; /* original iv */
38     unsigned char iv[EVP_MAX_IV_LENGTH]; /* working iv */
39     unsigned char buf[EVP_MAX_BLOCK_LENGTH]; /* saved partial block */
40     int num;                    /* used by cfb/ofb/ctr mode */
41     /* FIXME: Should this even exist? It appears unused */
42     void *app_data;             /* application stuff */
43     int key_len;                /* May change for variable length cipher */
44     unsigned long flags;        /* Various flags */
45     void *cipher_data;          /* per EVP data */
46     int final_used;
47     int block_mask;
48     unsigned char final[EVP_MAX_BLOCK_LENGTH]; /* possible final block */
49
50     /* Provider ctx */
51     void *provctx;
52     EVP_CIPHER *fetched_cipher;
53 } /* EVP_CIPHER_CTX */ ;
54
55 struct evp_mac_ctx_st {
56     const EVP_MAC *meth;         /* Method structure */
57     void *data;                  /* Individual method data */
58 } /* EVP_MAC_CTX */;
59
60 struct evp_kdf_ctx_st {
61     const EVP_KDF *meth;         /* Method structure */
62     EVP_KDF_IMPL *impl;          /* Algorithm-specific data */
63 } /* EVP_KDF_CTX */ ;
64
65 struct evp_keyexch_st {
66     OSSL_PROVIDER *prov;
67     CRYPTO_REF_COUNT refcnt;
68     CRYPTO_RWLOCK *lock;
69
70     OSSL_OP_keyexch_newctx_fn *newctx;
71     OSSL_OP_keyexch_init_fn *init;
72     OSSL_OP_keyexch_set_peer_fn *set_peer;
73     OSSL_OP_keyexch_derive_fn *derive;
74     OSSL_OP_keyexch_freectx_fn *freectx;
75     OSSL_OP_keyexch_dupctx_fn *dupctx;
76     OSSL_OP_keyexch_set_params_fn *set_params;
77 } /* EVP_KEYEXCH */;
78
79
80 int PKCS5_v2_PBKDF2_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass,
81                              int passlen, ASN1_TYPE *param,
82                              const EVP_CIPHER *c, const EVP_MD *md,
83                              int en_de);
84
85 struct evp_Encode_Ctx_st {
86     /* number saved in a partial encode/decode */
87     int num;
88     /*
89      * The length is either the output line length (in input bytes) or the
90      * shortest input line length that is ok.  Once decoding begins, the
91      * length is adjusted up each time a longer line is decoded
92      */
93     int length;
94     /* data to encode */
95     unsigned char enc_data[80];
96     /* number read on current line */
97     int line_num;
98     unsigned int flags;
99 };
100
101 typedef struct evp_pbe_st EVP_PBE_CTL;
102 DEFINE_STACK_OF(EVP_PBE_CTL)
103
104 int is_partially_overlapping(const void *ptr1, const void *ptr2, int len);
105
106 #include <openssl/ossl_typ.h>
107 #include <openssl/core.h>
108
109 void *evp_generic_fetch(OPENSSL_CTX *ctx, int operation_id,
110                         const char *algorithm, const char *properties,
111                         void *(*new_method)(const OSSL_DISPATCH *fns,
112                                             OSSL_PROVIDER *prov),
113                         int (*up_ref_method)(void *),
114                         void (*free_method)(void *));
115
116 /* Helper functions to avoid duplicating code */
117
118 /*
119  * These methods implement different ways to pass a params array to the
120  * provider.  They will return one of these values:
121  *
122  * -2 if the method doesn't come from a provider
123  *    (evp_do_param will return this to the called)
124  * -1 if the provider doesn't offer the desired function
125  *    (evp_do_param will raise an error and return 0)
126  * or the return value from the desired function
127  *    (evp_do_param will return it to the caller)
128  */
129 int evp_do_ciph_getparams(const EVP_CIPHER *ciph, OSSL_PARAM params[]);
130 int evp_do_ciph_ctx_getparams(const EVP_CIPHER *ciph, void *provctx,
131                               OSSL_PARAM params[]);
132 int evp_do_ciph_ctx_setparams(const EVP_CIPHER *ciph, void *provctx,
133                               OSSL_PARAM params[]);
134
135 OSSL_PARAM *evp_pkey_to_param(EVP_PKEY *pkey, size_t *sz);
136
137 #define M_check_autoarg(ctx, arg, arglen, err) \
138     if (ctx->pmeth->flags & EVP_PKEY_FLAG_AUTOARGLEN) {           \
139         size_t pksize = (size_t)EVP_PKEY_size(ctx->pkey);         \
140                                                                   \
141         if (pksize == 0) {                                        \
142             EVPerr(err, EVP_R_INVALID_KEY); /*ckerr_ignore*/      \
143             return 0;                                             \
144         }                                                         \
145         if (arg == NULL) {                                        \
146             *arglen = pksize;                                     \
147             return 1;                                             \
148         }                                                         \
149         if (*arglen < pksize) {                                   \
150             EVPerr(err, EVP_R_BUFFER_TOO_SMALL); /*ckerr_ignore*/ \
151             return 0;                                             \
152         }                                                         \
153     }