[thirdparty/openssl.git] / crypto / evp / evp_locl.h

/*
 * Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.
 *
 * Licensed under the Apache License 2.0 (the "License").  You may not use
 * this file except in compliance with the License.  You can obtain a copy
 * in the file LICENSE in the source distribution or at
 * https://www.openssl.org/source/license.html
 */

/* EVP_MD_CTX related stuff */

#include <openssl/core_numbers.h>

#define EVP_CTRL_RET_UNSUPPORTED -1


struct evp_md_ctx_st {
    const EVP_MD *reqdigest;    /* The original requested digest */
    const EVP_MD *digest;
    ENGINE *engine;             /* functional reference if 'digest' is
                                 * ENGINE-provided */
    unsigned long flags;
    void *md_data;
    /* Public key context for sign/verify */
    EVP_PKEY_CTX *pctx;
    /* Update function: usually copied from EVP_MD */
    int (*update) (EVP_MD_CTX *ctx, const void *data, size_t count);

    /* Provider ctx */
    void *provctx;
    EVP_MD *fetched_digest;
} /* EVP_MD_CTX */ ;

struct evp_cipher_ctx_st {
    const EVP_CIPHER *cipher;
    ENGINE *engine;             /* functional reference if 'cipher' is
                                 * ENGINE-provided */
    int encrypt;                /* encrypt or decrypt */
    int buf_len;                /* number we have left */
    unsigned char oiv[EVP_MAX_IV_LENGTH]; /* original iv */
    unsigned char iv[EVP_MAX_IV_LENGTH]; /* working iv */
    unsigned char buf[EVP_MAX_BLOCK_LENGTH]; /* saved partial block */
    int num;                    /* used by cfb/ofb/ctr mode */
    /* FIXME: Should this even exist? It appears unused */
    void *app_data;             /* application stuff */
    int key_len;                /* May change for variable length cipher */
    unsigned long flags;        /* Various flags */
    void *cipher_data;          /* per EVP data */
    int final_used;
    int block_mask;
    unsigned char final[EVP_MAX_BLOCK_LENGTH]; /* possible final block */

    /* Provider ctx */
    void *provctx;
    EVP_CIPHER *fetched_cipher;
} /* EVP_CIPHER_CTX */ ;

struct evp_mac_ctx_st {
    EVP_MAC *meth;               /* Method structure */
    void *data;                  /* Individual method data */
} /* EVP_MAC_CTX */;

struct evp_kdf_ctx_st {
    EVP_KDF *meth;              /* Method structure */
    void *data;                 /* Algorithm-specific data */
} /* EVP_KDF_CTX */ ;

struct evp_keymgmt_st {
    int id;                      /* libcrypto internal */

    char *name;
    OSSL_PROVIDER *prov;
    CRYPTO_REF_COUNT refcnt;
    CRYPTO_RWLOCK *lock;

    /* Domain parameter routines */
    OSSL_OP_keymgmt_importdomparams_fn *importdomparams;
    OSSL_OP_keymgmt_gendomparams_fn *gendomparams;
    OSSL_OP_keymgmt_freedomparams_fn *freedomparams;
    OSSL_OP_keymgmt_exportdomparams_fn *exportdomparams;
    OSSL_OP_keymgmt_importdomparam_types_fn *importdomparam_types;
    OSSL_OP_keymgmt_exportdomparam_types_fn *exportdomparam_types;

    /* Key routines */
    OSSL_OP_keymgmt_importkey_fn *importkey;
    OSSL_OP_keymgmt_genkey_fn *genkey;
    OSSL_OP_keymgmt_loadkey_fn *loadkey;
    OSSL_OP_keymgmt_freekey_fn *freekey;
    OSSL_OP_keymgmt_exportkey_fn *exportkey;
    OSSL_OP_keymgmt_importkey_types_fn *importkey_types;
    OSSL_OP_keymgmt_exportkey_types_fn *exportkey_types;
} /* EVP_KEYMGMT */ ;

struct keymgmt_data_st {
    OPENSSL_CTX *ctx;
    const char *properties;
};

struct evp_keyexch_st {
    char *name;
    OSSL_PROVIDER *prov;
    CRYPTO_REF_COUNT refcnt;
    CRYPTO_RWLOCK *lock;

    EVP_KEYMGMT *keymgmt;

    OSSL_OP_keyexch_newctx_fn *newctx;
    OSSL_OP_keyexch_init_fn *init;
    OSSL_OP_keyexch_set_peer_fn *set_peer;
    OSSL_OP_keyexch_derive_fn *derive;
    OSSL_OP_keyexch_freectx_fn *freectx;
    OSSL_OP_keyexch_dupctx_fn *dupctx;
    OSSL_OP_keyexch_set_params_fn *set_params;
} /* EVP_KEYEXCH */;

struct evp_signature_st {
    char *name;
    OSSL_PROVIDER *prov;
    CRYPTO_REF_COUNT refcnt;
    CRYPTO_RWLOCK *lock;

    EVP_KEYMGMT *keymgmt;

    OSSL_OP_signature_newctx_fn *newctx;
    OSSL_OP_signature_sign_init_fn *sign_init;
    OSSL_OP_signature_sign_fn *sign;
    OSSL_OP_signature_freectx_fn *freectx;
    OSSL_OP_signature_dupctx_fn *dupctx;
    OSSL_OP_signature_set_params_fn *set_params;
} /* EVP_SIGNATURE */;

int PKCS5_v2_PBKDF2_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass,
                             int passlen, ASN1_TYPE *param,
                             const EVP_CIPHER *c, const EVP_MD *md,
                             int en_de);

struct evp_Encode_Ctx_st {
    /* number saved in a partial encode/decode */
    int num;
    /*
     * The length is either the output line length (in input bytes) or the
     * shortest input line length that is ok.  Once decoding begins, the
     * length is adjusted up each time a longer line is decoded
     */
    int length;
    /* data to encode */
    unsigned char enc_data[80];
    /* number read on current line */
    int line_num;
    unsigned int flags;
};

typedef struct evp_pbe_st EVP_PBE_CTL;
DEFINE_STACK_OF(EVP_PBE_CTL)

int is_partially_overlapping(const void *ptr1, const void *ptr2, int len);

#include <openssl/ossl_typ.h>
#include <openssl/core.h>

void *evp_generic_fetch(OPENSSL_CTX *ctx, int operation_id,
                        const char *algorithm, const char *properties,
                        void *(*new_method)(const char *name,
                                            const OSSL_DISPATCH *fns,
                                            OSSL_PROVIDER *prov,
                                            void *method_data),
                        void *method_data,
                        int (*up_ref_method)(void *),
                        void (*free_method)(void *));
void evp_generic_do_all(OPENSSL_CTX *libctx, int operation_id,
                        void (*user_fn)(void *method, void *arg),
                        void *user_arg,
                        void *(*new_method)(const char *name,
                                            const OSSL_DISPATCH *fns,
                                            OSSL_PROVIDER *prov,
                                            void *method_data),
                        void *method_data,
                        void (*free_method)(void *));

/* Internal structure constructors for fetched methods */
EVP_MD *evp_md_new(void);
EVP_CIPHER *evp_cipher_new(void);

/* Helper functions to avoid duplicating code */

/*
 * These methods implement different ways to pass a params array to the
 * provider.  They will return one of these values:
 *
 * -2 if the method doesn't come from a provider
 *    (evp_do_param will return this to the called)
 * -1 if the provider doesn't offer the desired function
 *    (evp_do_param will raise an error and return 0)
 * or the return value from the desired function
 *    (evp_do_param will return it to the caller)
 */
int evp_do_ciph_getparams(const EVP_CIPHER *ciph, OSSL_PARAM params[]);
int evp_do_ciph_ctx_getparams(const EVP_CIPHER *ciph, void *provctx,
                              OSSL_PARAM params[]);
int evp_do_ciph_ctx_setparams(const EVP_CIPHER *ciph, void *provctx,
                              OSSL_PARAM params[]);
int evp_do_md_getparams(const EVP_MD *md, OSSL_PARAM params[]);
int evp_do_md_ctx_getparams(const EVP_MD *md, void *provctx,
                            OSSL_PARAM params[]);
int evp_do_md_ctx_setparams(const EVP_MD *md, void *provctx,
                            OSSL_PARAM params[]);

OSSL_PARAM *evp_pkey_to_param(EVP_PKEY *pkey, size_t *sz);

#define M_check_autoarg(ctx, arg, arglen, err) \
    if (ctx->pmeth->flags & EVP_PKEY_FLAG_AUTOARGLEN) {           \
        size_t pksize = (size_t)EVP_PKEY_size(ctx->pkey);         \
                                                                  \
        if (pksize == 0) {                                        \
            EVPerr(err, EVP_R_INVALID_KEY); /*ckerr_ignore*/      \
            return 0;                                             \
        }                                                         \
        if (arg == NULL) {                                        \
            *arglen = pksize;                                     \
            return 1;                                             \
        }                                                         \
        if (*arglen < pksize) {                                   \
            EVPerr(err, EVP_R_BUFFER_TOO_SMALL); /*ckerr_ignore*/ \
            return 0;                                             \
        }                                                         \
    }
Commit	Line	Data
0f113f3e	1	/*
c13d2ab4	2	* Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.
5da2f69f	3	*
4a8b0c55	4	* Licensed under the Apache License 2.0 (the "License"). You may not use
aa6bb135 RS	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
5da2f69f DSH	8	*/
5da2f69f DSH	9
7638370c RL	10	/* EVP_MD_CTX related stuff */
7638370c RL	11
ff64702b MC	12	#include <openssl/core_numbers.h>
ff64702b MC	13
e870791a SL	14	#define EVP_CTRL_RET_UNSUPPORTED -1
	15
	16
7638370c	17	struct evp_md_ctx_st {
b7c913c8	18	const EVP_MD reqdigest; / The original requested digest */
7638370c RL	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);
8c8cf0d9 MC	28
	29	/* Provider ctx */
	30	void *provctx;
	31	EVP_MD *fetched_digest;
7638370c RL	32	} /* EVP_MD_CTX */ ;
7638370c RL	33
8baf9968 RL	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 */
df05f2ce MC	52
	53	/* Provider ctx */
	54	void *provctx;
	55	EVP_CIPHER *fetched_cipher;
8baf9968 RL	56	} /* EVP_CIPHER_CTX */ ;
8baf9968 RL	57
567db2c1	58	struct evp_mac_ctx_st {
e74bd290	59	EVP_MAC meth; / Method structure */
567db2c1 RL	60	void data; / Individual method data */
	61	} /* EVP_MAC_CTX */;
	62
5a285add	63	struct evp_kdf_ctx_st {
fb9e6dd6 P	64	EVP_KDF meth; / Method structure */
fb9e6dd6 P	65	void data; / Algorithm-specific data */
5a285add DM	66	} /* EVP_KDF_CTX */ ;
5a285add DM	67
a94a3e0d RL	68	struct evp_keymgmt_st {
	69	int id; /* libcrypto internal */
	70
6b9e3724	71	char *name;
a94a3e0d RL	72	OSSL_PROVIDER *prov;
	73	CRYPTO_REF_COUNT refcnt;
	74	CRYPTO_RWLOCK *lock;
	75
	76	/* Domain parameter routines */
	77	OSSL_OP_keymgmt_importdomparams_fn *importdomparams;
	78	OSSL_OP_keymgmt_gendomparams_fn *gendomparams;
	79	OSSL_OP_keymgmt_freedomparams_fn *freedomparams;
	80	OSSL_OP_keymgmt_exportdomparams_fn *exportdomparams;
	81	OSSL_OP_keymgmt_importdomparam_types_fn *importdomparam_types;
	82	OSSL_OP_keymgmt_exportdomparam_types_fn *exportdomparam_types;
	83
	84	/* Key routines */
	85	OSSL_OP_keymgmt_importkey_fn *importkey;
	86	OSSL_OP_keymgmt_genkey_fn *genkey;
	87	OSSL_OP_keymgmt_loadkey_fn *loadkey;
	88	OSSL_OP_keymgmt_freekey_fn *freekey;
	89	OSSL_OP_keymgmt_exportkey_fn *exportkey;
	90	OSSL_OP_keymgmt_importkey_types_fn *importkey_types;
	91	OSSL_OP_keymgmt_exportkey_types_fn *exportkey_types;
	92	} /* EVP_KEYMGMT */ ;
	93
dfcb5d29 MC	94	struct keymgmt_data_st {
	95	OPENSSL_CTX *ctx;
	96	const char *properties;
	97	};
	98
ff64702b	99	struct evp_keyexch_st {
6b9e3724	100	char *name;
ff64702b MC	101	OSSL_PROVIDER *prov;
	102	CRYPTO_REF_COUNT refcnt;
	103	CRYPTO_RWLOCK *lock;
	104
8b84b075 RL	105	EVP_KEYMGMT *keymgmt;
8b84b075 RL	106
ff64702b MC	107	OSSL_OP_keyexch_newctx_fn *newctx;
	108	OSSL_OP_keyexch_init_fn *init;
	109	OSSL_OP_keyexch_set_peer_fn *set_peer;
	110	OSSL_OP_keyexch_derive_fn *derive;
	111	OSSL_OP_keyexch_freectx_fn *freectx;
	112	OSSL_OP_keyexch_dupctx_fn *dupctx;
35aca9ec	113	OSSL_OP_keyexch_set_params_fn *set_params;
ff64702b MC	114	} /* EVP_KEYEXCH */;
ff64702b MC	115
dfcb5d29 MC	116	struct evp_signature_st {
	117	char *name;
	118	OSSL_PROVIDER *prov;
	119	CRYPTO_REF_COUNT refcnt;
	120	CRYPTO_RWLOCK *lock;
	121
	122	EVP_KEYMGMT *keymgmt;
	123
	124	OSSL_OP_signature_newctx_fn *newctx;
	125	OSSL_OP_signature_sign_init_fn *sign_init;
	126	OSSL_OP_signature_sign_fn *sign;
	127	OSSL_OP_signature_freectx_fn *freectx;
	128	OSSL_OP_signature_dupctx_fn *dupctx;
	129	OSSL_OP_signature_set_params_fn *set_params;
	130	} /* EVP_SIGNATURE */;
	131
0f113f3e MC	132	int PKCS5_v2_PBKDF2_keyivgen(EVP_CIPHER_CTX ctx, const char pass,
	133	int passlen, ASN1_TYPE *param,
	134	const EVP_CIPHER c, const EVP_MD md,
	135	int en_de);
a0be4fd1 RL	136
	137	struct evp_Encode_Ctx_st {
	138	/* number saved in a partial encode/decode */
	139	int num;
	140	/*
	141	* The length is either the output line length (in input bytes) or the
	142	* shortest input line length that is ok. Once decoding begins, the
	143	* length is adjusted up each time a longer line is decoded
	144	*/
	145	int length;
	146	/* data to encode */
	147	unsigned char enc_data[80];
	148	/* number read on current line */
	149	int line_num;
c0804614	150	unsigned int flags;
a0be4fd1	151	};
4a1f3f27 DSH	152
	153	typedef struct evp_pbe_st EVP_PBE_CTL;
	154	DEFINE_STACK_OF(EVP_PBE_CTL)
7141ba31 MC	155
7141ba31 MC	156	int is_partially_overlapping(const void ptr1, const void ptr2, int len);
c13d2ab4 RL	157
	158	#include <openssl/ossl_typ.h>
	159	#include <openssl/core.h>
	160
	161	void evp_generic_fetch(OPENSSL_CTX ctx, int operation_id,
	162	const char algorithm, const char properties,
6b9e3724 RL	163	void (new_method)(const char *name,
6b9e3724 RL	164	const OSSL_DISPATCH *fns,
3ca9d210 RL	165	OSSL_PROVIDER *prov,
	166	void *method_data),
	167	void *method_data,
7c95390e	168	int (up_ref_method)(void ),
0211740f	169	void (free_method)(void ));
3d96a51c RL	170	void evp_generic_do_all(OPENSSL_CTX *libctx, int operation_id,
	171	void (user_fn)(void method, void *arg),
	172	void *user_arg,
	173	void (new_method)(const char *name,
	174	const OSSL_DISPATCH *fns,
3ca9d210 RL	175	OSSL_PROVIDER *prov,
	176	void *method_data),
	177	void *method_data,
3d96a51c	178	void (free_method)(void ));
13273237	179
3fd70262 RL	180	/* Internal structure constructors for fetched methods */
3fd70262 RL	181	EVP_MD *evp_md_new(void);
550f974a	182	EVP_CIPHER *evp_cipher_new(void);
3fd70262	183
13273237 RL	184	/* Helper functions to avoid duplicating code */
	185
	186	/*
459b15d4	187	* These methods implement different ways to pass a params array to the
13273237 RL	188	* provider. They will return one of these values:
	189	*
	190	* -2 if the method doesn't come from a provider
	191	* (evp_do_param will return this to the called)
	192	* -1 if the provider doesn't offer the desired function
	193	* (evp_do_param will raise an error and return 0)
	194	* or the return value from the desired function
	195	* (evp_do_param will return it to the caller)
	196	*/
459b15d4 SL	197	int evp_do_ciph_getparams(const EVP_CIPHER *ciph, OSSL_PARAM params[]);
459b15d4 SL	198	int evp_do_ciph_ctx_getparams(const EVP_CIPHER ciph, void provctx,
13273237	199	OSSL_PARAM params[]);
459b15d4	200	int evp_do_ciph_ctx_setparams(const EVP_CIPHER ciph, void provctx,
13273237	201	OSSL_PARAM params[]);
6a3b7c68 RL	202	int evp_do_md_getparams(const EVP_MD *md, OSSL_PARAM params[]);
	203	int evp_do_md_ctx_getparams(const EVP_MD md, void provctx,
	204	OSSL_PARAM params[]);
	205	int evp_do_md_ctx_setparams(const EVP_MD md, void provctx,
	206	OSSL_PARAM params[]);
ff64702b MC	207
	208	OSSL_PARAM evp_pkey_to_param(EVP_PKEY pkey, size_t *sz);
	209
	210	#define M_check_autoarg(ctx, arg, arglen, err) \
	211	if (ctx->pmeth->flags & EVP_PKEY_FLAG_AUTOARGLEN) { \
	212	size_t pksize = (size_t)EVP_PKEY_size(ctx->pkey); \
	213	\
	214	if (pksize == 0) { \
	215	EVPerr(err, EVP_R_INVALID_KEY); /ckerr_ignore/ \
	216	return 0; \
	217	} \
	218	if (arg == NULL) { \
	219	*arglen = pksize; \
	220	return 1; \
	221	} \
	222	if (*arglen < pksize) { \
	223	EVPerr(err, EVP_R_BUFFER_TOO_SMALL); /ckerr_ignore/ \
	224	return 0; \
	225	} \
	226	}