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