[thirdparty/openssl.git] / include / crypto / rsa.h

/*
 * Copyright 2019-2023 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
 */

#ifndef OSSL_INTERNAL_RSA_H
# define OSSL_INTERNAL_RSA_H
# pragma once

# include <openssl/core.h>
# include <openssl/rsa.h>
# include "crypto/types.h"

#define RSA_MIN_MODULUS_BITS    512

typedef struct rsa_pss_params_30_st {
    int hash_algorithm_nid;
    struct {
        int algorithm_nid;       /* Currently always NID_mgf1 */
        int hash_algorithm_nid;
    } mask_gen;
    int salt_len;
    int trailer_field;
} RSA_PSS_PARAMS_30;

RSA_PSS_PARAMS_30 *ossl_rsa_get0_pss_params_30(RSA *r);
int ossl_rsa_pss_params_30_set_defaults(RSA_PSS_PARAMS_30 *rsa_pss_params);
int ossl_rsa_pss_params_30_copy(RSA_PSS_PARAMS_30 *to,
                                const RSA_PSS_PARAMS_30 *from);
int ossl_rsa_pss_params_30_is_unrestricted(const RSA_PSS_PARAMS_30 *rsa_pss_params);
int ossl_rsa_pss_params_30_set_hashalg(RSA_PSS_PARAMS_30 *rsa_pss_params,
                                       int hashalg_nid);
int ossl_rsa_pss_params_30_set_maskgenhashalg(RSA_PSS_PARAMS_30 *rsa_pss_params,
                                              int maskgenhashalg_nid);
int ossl_rsa_pss_params_30_set_saltlen(RSA_PSS_PARAMS_30 *rsa_pss_params,
                                       int saltlen);
int ossl_rsa_pss_params_30_set_trailerfield(RSA_PSS_PARAMS_30 *rsa_pss_params,
                                            int trailerfield);
int ossl_rsa_pss_params_30_hashalg(const RSA_PSS_PARAMS_30 *rsa_pss_params);
int ossl_rsa_pss_params_30_maskgenalg(const RSA_PSS_PARAMS_30 *rsa_pss_params);
int ossl_rsa_pss_params_30_maskgenhashalg(const RSA_PSS_PARAMS_30 *rsa_pss_params);
int ossl_rsa_pss_params_30_saltlen(const RSA_PSS_PARAMS_30 *rsa_pss_params);
int ossl_rsa_pss_params_30_trailerfield(const RSA_PSS_PARAMS_30 *rsa_pss_params);

const char *ossl_rsa_mgf_nid2name(int mgf);
int ossl_rsa_oaeppss_md2nid(const EVP_MD *md);
const char *ossl_rsa_oaeppss_nid2name(int md);

RSA *ossl_rsa_new_with_ctx(OSSL_LIB_CTX *libctx);
OSSL_LIB_CTX *ossl_rsa_get0_libctx(RSA *r);
void ossl_rsa_set0_libctx(RSA *r, OSSL_LIB_CTX *libctx);

int ossl_rsa_set0_all_params(RSA *r, const STACK_OF(BIGNUM) *primes,
                             const STACK_OF(BIGNUM) *exps,
                             const STACK_OF(BIGNUM) *coeffs);
int ossl_rsa_get0_all_params(RSA *r, STACK_OF(BIGNUM_const) *primes,
                             STACK_OF(BIGNUM_const) *exps,
                             STACK_OF(BIGNUM_const) *coeffs);
int ossl_rsa_is_foreign(const RSA *rsa);
RSA *ossl_rsa_dup(const RSA *rsa, int selection);

int ossl_rsa_todata(RSA *rsa, OSSL_PARAM_BLD *bld, OSSL_PARAM params[],
                    int include_private);
int ossl_rsa_fromdata(RSA *rsa, const OSSL_PARAM params[], int include_private);
int ossl_rsa_pss_params_30_todata(const RSA_PSS_PARAMS_30 *pss,
                                  OSSL_PARAM_BLD *bld, OSSL_PARAM params[]);
int ossl_rsa_pss_params_30_fromdata(RSA_PSS_PARAMS_30 *pss_params,
                                    int *defaults_set,
                                    const OSSL_PARAM params[],
                                    OSSL_LIB_CTX *libctx);
int ossl_rsa_set0_pss_params(RSA *r, RSA_PSS_PARAMS *pss);
int ossl_rsa_pss_get_param_unverified(const RSA_PSS_PARAMS *pss,
                                      const EVP_MD **pmd, const EVP_MD **pmgf1md,
                                      int *psaltlen, int *ptrailerField);
RSA_PSS_PARAMS *ossl_rsa_pss_decode(const X509_ALGOR *alg);
int ossl_rsa_param_decode(RSA *rsa, const X509_ALGOR *alg);
RSA *ossl_rsa_key_from_pkcs8(const PKCS8_PRIV_KEY_INFO *p8inf,
                             OSSL_LIB_CTX *libctx, const char *propq);

int ossl_rsa_padding_check_PKCS1_type_2(OSSL_LIB_CTX *ctx,
                                        unsigned char *to, int tlen,
                                        const unsigned char *from, int flen,
                                        int num, unsigned char *kdk);
int ossl_rsa_padding_check_PKCS1_type_2_TLS(OSSL_LIB_CTX *ctx, unsigned char *to,
                                            size_t tlen,
                                            const unsigned char *from,
                                            size_t flen, int client_version,
                                            int alt_version);
int ossl_rsa_padding_add_PKCS1_OAEP_mgf1_ex(OSSL_LIB_CTX *libctx,
                                            unsigned char *to, int tlen,
                                            const unsigned char *from, int flen,
                                            const unsigned char *param,
                                            int plen, const EVP_MD *md,
                                            const EVP_MD *mgf1md);

int ossl_rsa_validate_public(const RSA *key);
int ossl_rsa_validate_private(const RSA *key);
int ossl_rsa_validate_pairwise(const RSA *key);

int ossl_rsa_verify(int dtype, const unsigned char *m,
                    unsigned int m_len, unsigned char *rm,
                    size_t *prm_len, const unsigned char *sigbuf,
                    size_t siglen, RSA *rsa);

const unsigned char *ossl_rsa_digestinfo_encoding(int md_nid, size_t *len);

extern const char *ossl_rsa_mp_factor_names[];
extern const char *ossl_rsa_mp_exp_names[];
extern const char *ossl_rsa_mp_coeff_names[];

ASN1_STRING *ossl_rsa_ctx_to_pss_string(EVP_PKEY_CTX *pkctx);
int ossl_rsa_pss_to_ctx(EVP_MD_CTX *ctx, EVP_PKEY_CTX *pkctx,
                        const X509_ALGOR *sigalg, EVP_PKEY *pkey);

# if defined(FIPS_MODULE) && !defined(OPENSSL_NO_ACVP_TESTS)
int ossl_rsa_acvp_test_gen_params_new(OSSL_PARAM **dst, const OSSL_PARAM src[]);
void ossl_rsa_acvp_test_gen_params_free(OSSL_PARAM *dst);

int ossl_rsa_acvp_test_set_params(RSA *r, const OSSL_PARAM params[]);
int ossl_rsa_acvp_test_get_params(RSA *r, OSSL_PARAM params[]);
typedef struct rsa_acvp_test_st RSA_ACVP_TEST;
void ossl_rsa_acvp_test_free(RSA_ACVP_TEST *t);
# else
# define RSA_ACVP_TEST void
# endif

RSA *evp_pkey_get1_RSA_PSS(EVP_PKEY *pkey);
#endif
Commit	Line	Data
c3a4fa4c	1	/*
da1c088f	2	* Copyright 2019-2023 The OpenSSL Project Authors. All Rights Reserved.
c3a4fa4c RL	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	#ifndef OSSL_INTERNAL_RSA_H
	11	# define OSSL_INTERNAL_RSA_H
80ce21fe	12	# pragma once
c3a4fa4c	13
4f2271d5 SL	14	# include <openssl/core.h>
4f2271d5 SL	15	# include <openssl/rsa.h>
d7e498ac	16	# include "crypto/types.h"
c3a4fa4c	17
c6b09ea0 MC	18	#define RSA_MIN_MODULUS_BITS 512
c6b09ea0 MC	19
15671090 RL	20	typedef struct rsa_pss_params_30_st {
	21	int hash_algorithm_nid;
	22	struct {
	23	int algorithm_nid; /* Currently always NID_mgf1 */
	24	int hash_algorithm_nid;
	25	} mask_gen;
6ce6ad39 RL	26	int salt_len;
6ce6ad39 RL	27	int trailer_field;
15671090 RL	28	} RSA_PSS_PARAMS_30;
15671090 RL	29
23b2fc0b P	30	RSA_PSS_PARAMS_30 ossl_rsa_get0_pss_params_30(RSA r);
	31	int ossl_rsa_pss_params_30_set_defaults(RSA_PSS_PARAMS_30 *rsa_pss_params);
	32	int ossl_rsa_pss_params_30_copy(RSA_PSS_PARAMS_30 *to,
	33	const RSA_PSS_PARAMS_30 *from);
	34	int ossl_rsa_pss_params_30_is_unrestricted(const RSA_PSS_PARAMS_30 *rsa_pss_params);
	35	int ossl_rsa_pss_params_30_set_hashalg(RSA_PSS_PARAMS_30 *rsa_pss_params,
	36	int hashalg_nid);
23b2fc0b P	37	int ossl_rsa_pss_params_30_set_maskgenhashalg(RSA_PSS_PARAMS_30 *rsa_pss_params,
	38	int maskgenhashalg_nid);
	39	int ossl_rsa_pss_params_30_set_saltlen(RSA_PSS_PARAMS_30 *rsa_pss_params,
	40	int saltlen);
	41	int ossl_rsa_pss_params_30_set_trailerfield(RSA_PSS_PARAMS_30 *rsa_pss_params,
	42	int trailerfield);
	43	int ossl_rsa_pss_params_30_hashalg(const RSA_PSS_PARAMS_30 *rsa_pss_params);
	44	int ossl_rsa_pss_params_30_maskgenalg(const RSA_PSS_PARAMS_30 *rsa_pss_params);
	45	int ossl_rsa_pss_params_30_maskgenhashalg(const RSA_PSS_PARAMS_30 *rsa_pss_params);
	46	int ossl_rsa_pss_params_30_saltlen(const RSA_PSS_PARAMS_30 *rsa_pss_params);
	47	int ossl_rsa_pss_params_30_trailerfield(const RSA_PSS_PARAMS_30 *rsa_pss_params);
	48
	49	const char *ossl_rsa_mgf_nid2name(int mgf);
	50	int ossl_rsa_oaeppss_md2nid(const EVP_MD *md);
	51	const char *ossl_rsa_oaeppss_nid2name(int md);
	52
b4250010 DMSP	53	RSA ossl_rsa_new_with_ctx(OSSL_LIB_CTX libctx);
b4250010 DMSP	54	OSSL_LIB_CTX ossl_rsa_get0_libctx(RSA r);
6963979f	55	void ossl_rsa_set0_libctx(RSA r, OSSL_LIB_CTX libctx);
23b2fc0b P	56
	57	int ossl_rsa_set0_all_params(RSA r, const STACK_OF(BIGNUM) primes,
	58	const STACK_OF(BIGNUM) *exps,
	59	const STACK_OF(BIGNUM) *coeffs);
	60	int ossl_rsa_get0_all_params(RSA r, STACK_OF(BIGNUM_const) primes,
	61	STACK_OF(BIGNUM_const) *exps,
	62	STACK_OF(BIGNUM_const) *coeffs);
b247113c	63	int ossl_rsa_is_foreign(const RSA *rsa);
b4f447c0	64	RSA ossl_rsa_dup(const RSA rsa, int selection);
23b2fc0b	65
944f822a	66	int ossl_rsa_todata(RSA rsa, OSSL_PARAM_BLD bld, OSSL_PARAM params[],
	67	int include_private);
	68	int ossl_rsa_fromdata(RSA *rsa, const OSSL_PARAM params[], int include_private);
23b2fc0b P	69	int ossl_rsa_pss_params_30_todata(const RSA_PSS_PARAMS_30 *pss,
	70	OSSL_PARAM_BLD *bld, OSSL_PARAM params[]);
	71	int ossl_rsa_pss_params_30_fromdata(RSA_PSS_PARAMS_30 *pss_params,
bbde8566	72	int *defaults_set,
23b2fc0b	73	const OSSL_PARAM params[],
b4250010	74	OSSL_LIB_CTX *libctx);
cf333799 RL	75	int ossl_rsa_set0_pss_params(RSA r, RSA_PSS_PARAMS pss);
	76	int ossl_rsa_pss_get_param_unverified(const RSA_PSS_PARAMS *pss,
	77	const EVP_MD pmd, const EVP_MD pmgf1md,
	78	int psaltlen, int ptrailerField);
	79	RSA_PSS_PARAMS ossl_rsa_pss_decode(const X509_ALGOR alg);
	80	int ossl_rsa_param_decode(RSA rsa, const X509_ALGOR alg);
	81	RSA ossl_rsa_key_from_pkcs8(const PKCS8_PRIV_KEY_INFO p8inf,
	82	OSSL_LIB_CTX libctx, const char propq);
23b2fc0b	83
7fc67e0a HK	84	int ossl_rsa_padding_check_PKCS1_type_2(OSSL_LIB_CTX *ctx,
	85	unsigned char *to, int tlen,
	86	const unsigned char *from, int flen,
	87	int num, unsigned char *kdk);
b4250010	88	int ossl_rsa_padding_check_PKCS1_type_2_TLS(OSSL_LIB_CTX ctx, unsigned char to,
23b2fc0b P	89	size_t tlen,
	90	const unsigned char *from,
	91	size_t flen, int client_version,
	92	int alt_version);
b4250010	93	int ossl_rsa_padding_add_PKCS1_OAEP_mgf1_ex(OSSL_LIB_CTX *libctx,
23b2fc0b P	94	unsigned char *to, int tlen,
	95	const unsigned char *from, int flen,
	96	const unsigned char *param,
	97	int plen, const EVP_MD *md,
	98	const EVP_MD *mgf1md);
	99
	100	int ossl_rsa_validate_public(const RSA *key);
	101	int ossl_rsa_validate_private(const RSA *key);
	102	int ossl_rsa_validate_pairwise(const RSA *key);
12603de6	103
4158b0dc SL	104	int ossl_rsa_verify(int dtype, const unsigned char *m,
	105	unsigned int m_len, unsigned char *rm,
	106	size_t prm_len, const unsigned char sigbuf,
	107	size_t siglen, RSA *rsa);
6f4b7663	108
23b2fc0b	109	const unsigned char ossl_rsa_digestinfo_encoding(int md_nid, size_t len);
6f4b7663	110
23b2fc0b P	111	extern const char *ossl_rsa_mp_factor_names[];
	112	extern const char *ossl_rsa_mp_exp_names[];
	113	extern const char *ossl_rsa_mp_coeff_names[];
96ebe52e	114
9ab7fe48 MC	115	ASN1_STRING ossl_rsa_ctx_to_pss_string(EVP_PKEY_CTX pkctx);
	116	int ossl_rsa_pss_to_ctx(EVP_MD_CTX ctx, EVP_PKEY_CTX pkctx,
	117	const X509_ALGOR sigalg, EVP_PKEY pkey);
	118
4f2271d5	119	# if defined(FIPS_MODULE) && !defined(OPENSSL_NO_ACVP_TESTS)
4158b0dc SL	120	int ossl_rsa_acvp_test_gen_params_new(OSSL_PARAM **dst, const OSSL_PARAM src[]);
4158b0dc SL	121	void ossl_rsa_acvp_test_gen_params_free(OSSL_PARAM *dst);
4f2271d5	122
4158b0dc SL	123	int ossl_rsa_acvp_test_set_params(RSA *r, const OSSL_PARAM params[]);
4158b0dc SL	124	int ossl_rsa_acvp_test_get_params(RSA *r, OSSL_PARAM params[]);
4f2271d5	125	typedef struct rsa_acvp_test_st RSA_ACVP_TEST;
4158b0dc	126	void ossl_rsa_acvp_test_free(RSA_ACVP_TEST *t);
4f2271d5 SL	127	# else
	128	# define RSA_ACVP_TEST void
	129	# endif
	130
cf333799	131	RSA evp_pkey_get1_RSA_PSS(EVP_PKEY pkey);
c3a4fa4c	132	#endif