2 * Copyright 2006-2017 The OpenSSL Project Authors. All Rights Reserved.
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
10 #ifndef OSSL_CRYPTO_RSA_LOCAL_H
11 #define OSSL_CRYPTO_RSA_LOCAL_H
13 #include <openssl/rsa.h>
14 #include "internal/refcount.h"
16 #define RSA_MAX_PRIME_NUM 5
17 #define RSA_MIN_MODULUS_BITS 512
19 typedef struct rsa_prime_info_st {
23 /* save product of primes prior to this one */
28 DECLARE_ASN1_ITEM(RSA_PRIME_INFO)
29 DEFINE_STACK_OF(RSA_PRIME_INFO)
34 * The first field is used to pickup errors where this is passed
35 * instead of an EVP_PKEY. It is always zero.
36 * THIS MUST REMAIN THE FIRST FIELD.
42 const RSA_METHOD *meth;
43 /* functional reference if 'meth' is ENGINE-provided */
53 /* If a PSS only key this contains the parameter restrictions */
56 /* for multi-prime RSA, defined in RFC 8017 */
57 STACK_OF(RSA_PRIME_INFO) *prime_infos;
58 /* Be careful using this if the RSA structure is shared */
59 CRYPTO_EX_DATA ex_data;
61 CRYPTO_REF_COUNT references;
63 /* Used to cache montgomery values */
64 BN_MONT_CTX *_method_mod_n;
65 BN_MONT_CTX *_method_mod_p;
66 BN_MONT_CTX *_method_mod_q;
68 * all BIGNUM values are actually in the following data, if it is not
72 BN_BLINDING *blinding;
73 BN_BLINDING *mt_blinding;
81 int (*rsa_pub_enc) (int flen, const unsigned char *from,
82 unsigned char *to, RSA *rsa, int padding);
83 int (*rsa_pub_dec) (int flen, const unsigned char *from,
84 unsigned char *to, RSA *rsa, int padding);
85 int (*rsa_priv_enc) (int flen, const unsigned char *from,
86 unsigned char *to, RSA *rsa, int padding);
87 int (*rsa_priv_dec) (int flen, const unsigned char *from,
88 unsigned char *to, RSA *rsa, int padding);
90 int (*rsa_mod_exp) (BIGNUM *r0, const BIGNUM *I, RSA *rsa, BN_CTX *ctx);
92 int (*bn_mod_exp) (BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
93 const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
95 int (*init) (RSA *rsa);
97 int (*finish) (RSA *rsa);
98 /* RSA_METHOD_FLAG_* things */
103 * New sign and verify functions: some libraries don't allow arbitrary
104 * data to be signed/verified: this allows them to be used. Note: for
105 * this to work the RSA_public_decrypt() and RSA_private_encrypt() should
106 * *NOT* be used RSA_sign(), RSA_verify() should be used instead.
108 int (*rsa_sign) (int type,
109 const unsigned char *m, unsigned int m_length,
110 unsigned char *sigret, unsigned int *siglen,
112 int (*rsa_verify) (int dtype, const unsigned char *m,
113 unsigned int m_length, const unsigned char *sigbuf,
114 unsigned int siglen, const RSA *rsa);
116 * If this callback is NULL, the builtin software RSA key-gen will be
117 * used. This is for behavioural compatibility whilst the code gets
118 * rewired, but one day it would be nice to assume there are no such
119 * things as "builtin software" implementations.
121 int (*rsa_keygen) (RSA *rsa, int bits, BIGNUM *e, BN_GENCB *cb);
122 int (*rsa_multi_prime_keygen) (RSA *rsa, int bits, int primes,
123 BIGNUM *e, BN_GENCB *cb);
126 /* Macros to test if a pkey or ctx is for a PSS key */
127 #define pkey_is_pss(pkey) (pkey->ameth->pkey_id == EVP_PKEY_RSA_PSS)
128 #define pkey_ctx_is_pss(ctx) (ctx->pmeth->pkey_id == EVP_PKEY_RSA_PSS)
130 RSA_PSS_PARAMS *rsa_pss_params_create(const EVP_MD *sigmd,
131 const EVP_MD *mgf1md, int saltlen);
132 int rsa_pss_get_param(const RSA_PSS_PARAMS *pss, const EVP_MD **pmd,
133 const EVP_MD **pmgf1md, int *psaltlen);
134 /* internal function to clear and free multi-prime parameters */
135 void rsa_multip_info_free_ex(RSA_PRIME_INFO *pinfo);
136 void rsa_multip_info_free(RSA_PRIME_INFO *pinfo);
137 RSA_PRIME_INFO *rsa_multip_info_new(void);
138 int rsa_multip_calc_product(RSA *rsa);
139 int rsa_multip_cap(int bits);
141 int rsa_sp800_56b_validate_strength(int nbits, int strength);
142 int rsa_check_pminusq_diff(BIGNUM *diff, const BIGNUM *p, const BIGNUM *q,
144 int rsa_get_lcm(BN_CTX *ctx, const BIGNUM *p, const BIGNUM *q,
145 BIGNUM *lcm, BIGNUM *gcd, BIGNUM *p1, BIGNUM *q1,
148 int rsa_check_public_exponent(const BIGNUM *e);
149 int rsa_check_private_exponent(const RSA *rsa, int nbits, BN_CTX *ctx);
150 int rsa_check_prime_factor(BIGNUM *p, BIGNUM *e, int nbits, BN_CTX *ctx);
151 int rsa_check_prime_factor_range(const BIGNUM *p, int nbits, BN_CTX *ctx);
152 int rsa_check_crt_components(const RSA *rsa, BN_CTX *ctx);
154 int rsa_sp800_56b_pairwise_test(RSA *rsa, BN_CTX *ctx);
155 int rsa_sp800_56b_check_public(const RSA *rsa);
156 int rsa_sp800_56b_check_private(const RSA *rsa);
157 int rsa_sp800_56b_check_keypair(const RSA *rsa, const BIGNUM *efixed,
158 int strength, int nbits);
159 int rsa_sp800_56b_generate_key(RSA *rsa, int nbits, const BIGNUM *efixed,
162 int rsa_sp800_56b_derive_params_from_pq(RSA *rsa, int nbits,
163 const BIGNUM *e, BN_CTX *ctx);
164 int rsa_fips186_4_gen_prob_primes(RSA *rsa, BIGNUM *p1, BIGNUM *p2,
165 BIGNUM *Xpout, const BIGNUM *Xp,
166 const BIGNUM *Xp1, const BIGNUM *Xp2,
167 BIGNUM *q1, BIGNUM *q2, BIGNUM *Xqout,
168 const BIGNUM *Xq, const BIGNUM *Xq1,
169 const BIGNUM *Xq2, int nbits,
170 const BIGNUM *e, BN_CTX *ctx, BN_GENCB *cb);
172 #endif /* OSSL_CRYPTO_RSA_LOCAL_H */