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 #ifndef FIPS_MODE
  54     /* be careful using this if the RSA structure is shared */
  55     CRYPTO_EX_DATA ex_data;
  56 #endif
  57     CRYPTO_REF_COUNT references;
  58     int flags;
  59     /* Used to cache montgomery values */
  60     BN_MONT_CTX *_method_mod_n;
  61     BN_MONT_CTX *_method_mod_p;
  62     BN_MONT_CTX *_method_mod_q;
  63     /*
  64      * all BIGNUM values are actually in the following data, if it is not
  65      * NULL
  66      */
  67     char *bignum_data;
  68     BN_BLINDING *blinding;
  69     BN_BLINDING *mt_blinding;
  70     CRYPTO_RWLOCK *lock;
  71
  72     int dirty_cnt;
  73 };
  74
  75 struct rsa_meth_st {
  76     char *name;
  77     int (*rsa_pub_enc) (int flen, const unsigned char *from,
  78                         unsigned char *to, RSA *rsa, int padding);
  79     int (*rsa_pub_dec) (int flen, const unsigned char *from,
  80                         unsigned char *to, RSA *rsa, int padding);
  81     int (*rsa_priv_enc) (int flen, const unsigned char *from,
  82                          unsigned char *to, RSA *rsa, int padding);
  83     int (*rsa_priv_dec) (int flen, const unsigned char *from,
  84                          unsigned char *to, RSA *rsa, int padding);
  85     /* Can be null */
  86     int (*rsa_mod_exp) (BIGNUM *r0, const BIGNUM *I, RSA *rsa, BN_CTX *ctx);
  87     /* Can be null */
  88     int (*bn_mod_exp) (BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
  89                        const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
  90     /* called at new */
  91     int (*init) (RSA *rsa);
  92     /* called at free */
  93     int (*finish) (RSA *rsa);
  94     /* RSA_METHOD_FLAG_* things */
  95     int flags;
  96     /* may be needed! */
  97     char *app_data;
  98     /*
  99      * New sign and verify functions: some libraries don't allow arbitrary
 100      * data to be signed/verified: this allows them to be used. Note: for
 101      * this to work the RSA_public_decrypt() and RSA_private_encrypt() should
 102      * *NOT* be used RSA_sign(), RSA_verify() should be used instead.
 103      */
 104     int (*rsa_sign) (int type,
 105                      const unsigned char *m, unsigned int m_length,
 106                      unsigned char *sigret, unsigned int *siglen,
 107                      const RSA *rsa);
 108     int (*rsa_verify) (int dtype, const unsigned char *m,
 109                        unsigned int m_length, const unsigned char *sigbuf,
 110                        unsigned int siglen, const RSA *rsa);
 111     /*
 112      * If this callback is NULL, the builtin software RSA key-gen will be
 113      * used. This is for behavioural compatibility whilst the code gets
 114      * rewired, but one day it would be nice to assume there are no such
 115      * things as "builtin software" implementations.
 116      */
 117     int (*rsa_keygen) (RSA *rsa, int bits, BIGNUM *e, BN_GENCB *cb);
 118     int (*rsa_multi_prime_keygen) (RSA *rsa, int bits, int primes,
 119                                    BIGNUM *e, BN_GENCB *cb);
 120 };
 121
 122 extern int int_rsa_verify(int dtype, const unsigned char *m,
 123                           unsigned int m_len, unsigned char *rm,
 124                           size_t *prm_len, const unsigned char *sigbuf,
 125                           size_t siglen, RSA *rsa);
 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)
 129
 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);
 140
 141 uint16_t rsa_compute_security_bits(int n);
 142
 143 int rsa_sp800_56b_validate_strength(int nbits, int strength);
 144 int rsa_check_pminusq_diff(BIGNUM *diff, const BIGNUM *p, const BIGNUM *q,
 145                            int nbits);
 146 int rsa_get_lcm(BN_CTX *ctx, const BIGNUM *p, const BIGNUM *q,
 147                 BIGNUM *lcm, BIGNUM *gcd, BIGNUM *p1, BIGNUM *q1,
 148                 BIGNUM *p1q1);
 149
 150 int rsa_check_public_exponent(const BIGNUM *e);
 151 int rsa_check_private_exponent(const RSA *rsa, int nbits, BN_CTX *ctx);
 152 int rsa_check_prime_factor(BIGNUM *p, BIGNUM *e, int nbits, BN_CTX *ctx);
 153 int rsa_check_prime_factor_range(const BIGNUM *p, int nbits, BN_CTX *ctx);
 154 int rsa_check_crt_components(const RSA *rsa, BN_CTX *ctx);
 155
 156 int rsa_sp800_56b_pairwise_test(RSA *rsa, BN_CTX *ctx);
 157 int rsa_sp800_56b_check_public(const RSA *rsa);
 158 int rsa_sp800_56b_check_private(const RSA *rsa);
 159 int rsa_sp800_56b_check_keypair(const RSA *rsa, const BIGNUM *efixed,
 160                                 int strength, int nbits);
 161 int rsa_sp800_56b_generate_key(RSA *rsa, int nbits, const BIGNUM *efixed,
 162                                BN_GENCB *cb);
 163
 164 int rsa_sp800_56b_derive_params_from_pq(RSA *rsa, int nbits,
 165                                         const BIGNUM *e, BN_CTX *ctx);
 166 int rsa_fips186_4_gen_prob_primes(RSA *rsa, BIGNUM *p1, BIGNUM *p2,
 167                                   BIGNUM *Xpout, const BIGNUM *Xp,
 168                                   const BIGNUM *Xp1, const BIGNUM *Xp2,
 169                                   BIGNUM *q1, BIGNUM *q2, BIGNUM *Xqout,
 170                                   const BIGNUM *Xq, const BIGNUM *Xq1,
 171                                   const BIGNUM *Xq2, int nbits,
 172                                   const BIGNUM *e, BN_CTX *ctx, BN_GENCB *cb);
 173
 174 #endif /* OSSL_CRYPTO_RSA_LOCAL_H */