Fix RSA structure
[openssl.git] / crypto / rsa / rsa_local.h
1 /*
2  * Copyright 2006-2017 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 #ifndef OSSL_CRYPTO_RSA_LOCAL_H
11 #define OSSL_CRYPTO_RSA_LOCAL_H
12
13 #include <openssl/rsa.h>
14 #include "internal/refcount.h"
15
16 #define RSA_MAX_PRIME_NUM       5
17 #define RSA_MIN_MODULUS_BITS    512
18
19 typedef struct rsa_prime_info_st {
20     BIGNUM *r;
21     BIGNUM *d;
22     BIGNUM *t;
23     /* save product of primes prior to this one */
24     BIGNUM *pp;
25     BN_MONT_CTX *m;
26 } RSA_PRIME_INFO;
27
28 DECLARE_ASN1_ITEM(RSA_PRIME_INFO)
29 DEFINE_STACK_OF(RSA_PRIME_INFO)
30
31 struct rsa_st {
32     /*
33      * #legacy
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.
37      */
38     int dummy_zero;
39
40     OPENSSL_CTX *libctx;
41     int32_t version;
42     const RSA_METHOD *meth;
43     /* functional reference if 'meth' is ENGINE-provided */
44     ENGINE *engine;
45     BIGNUM *n;
46     BIGNUM *e;
47     BIGNUM *d;
48     BIGNUM *p;
49     BIGNUM *q;
50     BIGNUM *dmp1;
51     BIGNUM *dmq1;
52     BIGNUM *iqmp;
53     /* TODO(3.0): Support PSS in FIPS_MODE */
54 #ifndef FIPS_MODE
55     /* for multi-prime RSA, defined in RFC 8017 */
56     STACK_OF(RSA_PRIME_INFO) *prime_infos;
57     /* If a PSS only key this contains the parameter restrictions */
58     RSA_PSS_PARAMS *pss;
59     /* be careful using this if the RSA structure is shared */
60     CRYPTO_EX_DATA ex_data;
61 #endif
62     CRYPTO_REF_COUNT references;
63     int flags;
64     /* Used to cache montgomery values */
65     BN_MONT_CTX *_method_mod_n;
66     BN_MONT_CTX *_method_mod_p;
67     BN_MONT_CTX *_method_mod_q;
68     /*
69      * all BIGNUM values are actually in the following data, if it is not
70      * NULL
71      */
72     char *bignum_data;
73     BN_BLINDING *blinding;
74     BN_BLINDING *mt_blinding;
75     CRYPTO_RWLOCK *lock;
76
77     int dirty_cnt;
78 };
79
80 struct rsa_meth_st {
81     char *name;
82     int (*rsa_pub_enc) (int flen, const unsigned char *from,
83                         unsigned char *to, RSA *rsa, int padding);
84     int (*rsa_pub_dec) (int flen, const unsigned char *from,
85                         unsigned char *to, RSA *rsa, int padding);
86     int (*rsa_priv_enc) (int flen, const unsigned char *from,
87                          unsigned char *to, RSA *rsa, int padding);
88     int (*rsa_priv_dec) (int flen, const unsigned char *from,
89                          unsigned char *to, RSA *rsa, int padding);
90     /* Can be null */
91     int (*rsa_mod_exp) (BIGNUM *r0, const BIGNUM *I, RSA *rsa, BN_CTX *ctx);
92     /* Can be null */
93     int (*bn_mod_exp) (BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
94                        const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
95     /* called at new */
96     int (*init) (RSA *rsa);
97     /* called at free */
98     int (*finish) (RSA *rsa);
99     /* RSA_METHOD_FLAG_* things */
100     int flags;
101     /* may be needed! */
102     char *app_data;
103     /*
104      * New sign and verify functions: some libraries don't allow arbitrary
105      * data to be signed/verified: this allows them to be used. Note: for
106      * this to work the RSA_public_decrypt() and RSA_private_encrypt() should
107      * *NOT* be used RSA_sign(), RSA_verify() should be used instead.
108      */
109     int (*rsa_sign) (int type,
110                      const unsigned char *m, unsigned int m_length,
111                      unsigned char *sigret, unsigned int *siglen,
112                      const RSA *rsa);
113     int (*rsa_verify) (int dtype, const unsigned char *m,
114                        unsigned int m_length, const unsigned char *sigbuf,
115                        unsigned int siglen, const RSA *rsa);
116     /*
117      * If this callback is NULL, the builtin software RSA key-gen will be
118      * used. This is for behavioural compatibility whilst the code gets
119      * rewired, but one day it would be nice to assume there are no such
120      * things as "builtin software" implementations.
121      */
122     int (*rsa_keygen) (RSA *rsa, int bits, BIGNUM *e, BN_GENCB *cb);
123     int (*rsa_multi_prime_keygen) (RSA *rsa, int bits, int primes,
124                                    BIGNUM *e, BN_GENCB *cb);
125 };
126
127 /* Macros to test if a pkey or ctx is for a PSS key */
128 #define pkey_is_pss(pkey) (pkey->ameth->pkey_id == EVP_PKEY_RSA_PSS)
129 #define pkey_ctx_is_pss(ctx) (ctx->pmeth->pkey_id == EVP_PKEY_RSA_PSS)
130
131 RSA_PSS_PARAMS *rsa_pss_params_create(const EVP_MD *sigmd,
132                                       const EVP_MD *mgf1md, int saltlen);
133 int rsa_pss_get_param(const RSA_PSS_PARAMS *pss, const EVP_MD **pmd,
134                       const EVP_MD **pmgf1md, int *psaltlen);
135 /* internal function to clear and free multi-prime parameters */
136 void rsa_multip_info_free_ex(RSA_PRIME_INFO *pinfo);
137 void rsa_multip_info_free(RSA_PRIME_INFO *pinfo);
138 RSA_PRIME_INFO *rsa_multip_info_new(void);
139 int rsa_multip_calc_product(RSA *rsa);
140 int rsa_multip_cap(int bits);
141
142 int rsa_sp800_56b_validate_strength(int nbits, int strength);
143 int rsa_check_pminusq_diff(BIGNUM *diff, const BIGNUM *p, const BIGNUM *q,
144                            int nbits);
145 int rsa_get_lcm(BN_CTX *ctx, const BIGNUM *p, const BIGNUM *q,
146                 BIGNUM *lcm, BIGNUM *gcd, BIGNUM *p1, BIGNUM *q1,
147                 BIGNUM *p1q1);
148
149 int rsa_check_public_exponent(const BIGNUM *e);
150 int rsa_check_private_exponent(const RSA *rsa, int nbits, BN_CTX *ctx);
151 int rsa_check_prime_factor(BIGNUM *p, BIGNUM *e, int nbits, BN_CTX *ctx);
152 int rsa_check_prime_factor_range(const BIGNUM *p, int nbits, BN_CTX *ctx);
153 int rsa_check_crt_components(const RSA *rsa, BN_CTX *ctx);
154
155 int rsa_sp800_56b_pairwise_test(RSA *rsa, BN_CTX *ctx);
156 int rsa_sp800_56b_check_public(const RSA *rsa);
157 int rsa_sp800_56b_check_private(const RSA *rsa);
158 int rsa_sp800_56b_check_keypair(const RSA *rsa, const BIGNUM *efixed,
159                                 int strength, int nbits);
160 int rsa_sp800_56b_generate_key(RSA *rsa, int nbits, const BIGNUM *efixed,
161                                BN_GENCB *cb);
162
163 int rsa_sp800_56b_derive_params_from_pq(RSA *rsa, int nbits,
164                                         const BIGNUM *e, BN_CTX *ctx);
165 int rsa_fips186_4_gen_prob_primes(RSA *rsa, BIGNUM *p1, BIGNUM *p2,
166                                   BIGNUM *Xpout, const BIGNUM *Xp,
167                                   const BIGNUM *Xp1, const BIGNUM *Xp2,
168                                   BIGNUM *q1, BIGNUM *q2, BIGNUM *Xqout,
169                                   const BIGNUM *Xq, const BIGNUM *Xq1,
170                                   const BIGNUM *Xq2, int nbits,
171                                   const BIGNUM *e, BN_CTX *ctx, BN_GENCB *cb);
172
173 #endif /* OSSL_CRYPTO_RSA_LOCAL_H */