Add support for setting keybits and public exponent value for pkey RSA keygen.
[openssl.git] / crypto / bn / bn.h
index cbe3153e9e14f59680b46df40ef7c745b16fe718..0a9aa78d8bc3da41a4f822bcf4042e25488626bd 100644 (file)
@@ -90,21 +90,15 @@ extern "C" {
  * BN_DEBUG - turn on various debugging alterations to the bignum code
  * BN_DEBUG_RAND - uses random poisoning of unused words to trip up
  * mismanagement of bignum internals. You must also define BN_DEBUG.
- * BN_STRICT - disables anything (not already caught by BN_DEBUG) that uses the
- * old ambiguity over zero representation. At some point, this behaviour should
- * become standard.
  */
 /* #define BN_DEBUG */
 /* #define BN_DEBUG_RAND */
-/* #define BN_STRICT */
-
-#ifdef OPENSSL_SYS_VMS
-#undef BN_LLONG /* experimental, so far... */
-#endif
 
+#ifndef OPENSSL_SMALL_FOOTPRINT
 #define BN_MUL_COMBA
 #define BN_SQR_COMBA
 #define BN_RECURSION
+#endif
 
 /* This next option uses the C libraries (2 word)/(1 word) function.
  * If it is not defined, I use my C version (which is slower).
@@ -145,6 +139,8 @@ extern "C" {
 #define BN_DEC_FMT1    "%lu"
 #define BN_DEC_FMT2    "%019lu"
 #define BN_DEC_NUM     19
+#define BN_HEX_FMT1    "%lX"
+#define BN_HEX_FMT2    "%016lX"
 #endif
 
 /* This is where the long long data type is 64 bits, but long is 32.
@@ -170,93 +166,62 @@ extern "C" {
 #define BN_DEC_FMT1    "%llu"
 #define BN_DEC_FMT2    "%019llu"
 #define BN_DEC_NUM     19
+#define BN_HEX_FMT1    "%llX"
+#define BN_HEX_FMT2    "%016llX"
 #endif
 
 #ifdef THIRTY_TWO_BIT
-#if defined(OPENSSL_SYS_WIN32) && !defined(__GNUC__)
-#define BN_ULLONG      unsigned _int64
-#else
-#define BN_ULLONG      unsigned long long
+#ifdef BN_LLONG
+# if defined(_WIN32) && !defined(__GNUC__)
+#  define BN_ULLONG    unsigned __int64
+#  define BN_MASK      (0xffffffffffffffffI64)
+# else
+#  define BN_ULLONG    unsigned long long
+#  define BN_MASK      (0xffffffffffffffffLL)
+# endif
 #endif
-#define BN_ULONG       unsigned long
-#define BN_LONG                long
+#define BN_ULONG       unsigned int
+#define BN_LONG                int
 #define BN_BITS                64
 #define BN_BYTES       4
 #define BN_BITS2       32
 #define BN_BITS4       16
-#ifdef OPENSSL_SYS_WIN32
-/* VC++ doesn't like the LL suffix */
-#define BN_MASK                (0xffffffffffffffffL)
-#else
-#define BN_MASK                (0xffffffffffffffffLL)
-#endif
 #define BN_MASK2       (0xffffffffL)
 #define BN_MASK2l      (0xffff)
 #define BN_MASK2h1     (0xffff8000L)
 #define BN_MASK2h      (0xffff0000L)
 #define BN_TBIT                (0x80000000L)
 #define BN_DEC_CONV    (1000000000L)
-#define BN_DEC_FMT1    "%lu"
-#define BN_DEC_FMT2    "%09lu"
-#define BN_DEC_NUM     9
-#endif
-
-#ifdef SIXTEEN_BIT
-#ifndef BN_DIV2W
-#define BN_DIV2W
-#endif
-#define BN_ULLONG      unsigned long
-#define BN_ULONG       unsigned short
-#define BN_LONG                short
-#define BN_BITS                32
-#define BN_BYTES       2
-#define BN_BITS2       16
-#define BN_BITS4       8
-#define BN_MASK                (0xffffffff)
-#define BN_MASK2       (0xffff)
-#define BN_MASK2l      (0xff)
-#define BN_MASK2h1     (0xff80)
-#define BN_MASK2h      (0xff00)
-#define BN_TBIT                (0x8000)
-#define BN_DEC_CONV    (100000)
 #define BN_DEC_FMT1    "%u"
-#define BN_DEC_FMT2    "%05u"
-#define BN_DEC_NUM     5
-#endif
-
-#ifdef EIGHT_BIT
-#ifndef BN_DIV2W
-#define BN_DIV2W
-#endif
-#define BN_ULLONG      unsigned short
-#define BN_ULONG       unsigned char
-#define BN_LONG                char
-#define BN_BITS                16
-#define BN_BYTES       1
-#define BN_BITS2       8
-#define BN_BITS4       4
-#define BN_MASK                (0xffff)
-#define BN_MASK2       (0xff)
-#define BN_MASK2l      (0xf)
-#define BN_MASK2h1     (0xf8)
-#define BN_MASK2h      (0xf0)
-#define BN_TBIT                (0x80)
-#define BN_DEC_CONV    (100)
-#define BN_DEC_FMT1    "%u"
-#define BN_DEC_FMT2    "%02u"
-#define BN_DEC_NUM     2
+#define BN_DEC_FMT2    "%09u"
+#define BN_DEC_NUM     9
+#define BN_HEX_FMT1    "%X"
+#define BN_HEX_FMT2    "%08X"
 #endif
 
 #define BN_DEFAULT_BITS        1280
 
 #define BN_FLG_MALLOCED                0x01
 #define BN_FLG_STATIC_DATA     0x02
+#define BN_FLG_EXP_CONSTTIME   0x04 /* avoid leaking exponent information through timings
+                                     * (BN_mod_exp_mont() will call BN_mod_exp_mont_consttime) */
 #ifndef OPENSSL_NO_DEPRECATED
 #define BN_FLG_FREE            0x8000  /* used for debuging */
 #endif
 #define BN_set_flags(b,n)      ((b)->flags|=(n))
 #define BN_get_flags(b,n)      ((b)->flags&(n))
 
+/* get a clone of a BIGNUM with changed flags, for *temporary* use only
+ * (the two BIGNUMs cannot not be used in parallel!) */
+#define BN_with_flags(dest,b,n)  ((dest)->d=(b)->d, \
+                                  (dest)->top=(b)->top, \
+                                  (dest)->dmax=(b)->dmax, \
+                                  (dest)->neg=(b)->neg, \
+                                  (dest)->flags=(((dest)->flags & BN_FLG_MALLOCED) \
+                                                 |  ((b)->flags & ~BN_FLG_MALLOCED) \
+                                                 |  BN_FLG_STATIC_DATA \
+                                                 |  (n)))
+
 /* Already declared in ossl_typ.h */
 #if 0
 typedef struct bignum_st BIGNUM;
@@ -278,16 +243,6 @@ struct bignum_st
        int flags;
        };
 
-struct bn_blinding_st
-       {
-       int init;
-       BIGNUM *A;
-       BIGNUM *Ai;
-       BIGNUM *mod; /* just a reference */
-       unsigned long thread_id; /* added in OpenSSL 0.9.6j and 0.9.7b;
-                                 * used only by crypto/rsa/rsa_eay.c, rsa_lib.c */
-       };
-
 /* Used for montgomery multiplication */
 struct bn_mont_ctx_st
        {
@@ -296,7 +251,7 @@ struct bn_mont_ctx_st
        BIGNUM N;      /* The modulus */
        BIGNUM Ni;     /* R*(1/R mod N) - N*Ni = 1
                        * (Ni is only stored for bignum algorithm) */
-       BN_ULONG n0;   /* least significant word of Ni */
+       BN_ULONG n0[2];/* least significant word(s) of Ni */
        int flags;
        };
 
@@ -366,11 +321,7 @@ int BN_GENCB_call(BN_GENCB *cb, int a, int b);
 /* Note that BN_abs_is_word didn't work reliably for w == 0 until 0.9.8 */
 #define BN_abs_is_word(a,w) ((((a)->top == 1) && ((a)->d[0] == (BN_ULONG)(w))) || \
                                (((w) == 0) && ((a)->top == 0)))
-#ifdef BN_STRICT
 #define BN_is_zero(a)       ((a)->top == 0)
-#else
-#define BN_is_zero(a)       BN_abs_is_word(a,0)
-#endif
 #define BN_is_one(a)        (BN_abs_is_word((a),1) && !(a)->neg)
 #define BN_is_word(a,w)     (BN_abs_is_word((a),(w)) && (!(w) || !(a)->neg))
 #define BN_is_odd(a)       (((a)->top > 0) && ((a)->d[0] & 1))
@@ -387,14 +338,6 @@ int BN_GENCB_call(BN_GENCB *cb, int a, int b);
 #else
 #define BN_zero(a)     (BN_set_word((a),0))
 #endif
-/* BN_set_sign(BIGNUM *, int) sets the sign of a BIGNUM
- * (0 for a non-negative value, 1 for negative) */
-#define BN_set_sign(a,b) ((a)->neg = (b))
-/* BN_get_sign(BIGNUM *) returns the sign of the BIGNUM */
-#define BN_get_sign(a)   ((a)->neg)
-
-/*#define BN_ascii2bn(a)       BN_hex2bn(a) */
-/*#define BN_bn2ascii(a)       BN_bn2hex(a) */
 
 const BIGNUM *BN_value_one(void);
 char * BN_options(void);
@@ -416,8 +359,6 @@ BIGNUM *BN_new(void);
 void   BN_init(BIGNUM *);
 void   BN_clear_free(BIGNUM *a);
 BIGNUM *BN_copy(BIGNUM *a, const BIGNUM *b);
-/* BN_ncopy(): like BN_copy() but copies at most the first n BN_ULONGs */
-BIGNUM *BN_ncopy(BIGNUM *a, const BIGNUM *b, size_t n);
 void   BN_swap(BIGNUM *a, BIGNUM *b);
 BIGNUM *BN_bin2bn(const unsigned char *s,int len,BIGNUM *ret);
 int    BN_bn2bin(const BIGNUM *a, unsigned char *to);
@@ -429,6 +370,16 @@ int        BN_uadd(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
 int    BN_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
 int    BN_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx);
 int    BN_sqr(BIGNUM *r, const BIGNUM *a,BN_CTX *ctx);
+/** BN_set_negative sets sign of a BIGNUM
+ * \param  b  pointer to the BIGNUM object
+ * \param  n  0 if the BIGNUM b should be positive and a value != 0 otherwise 
+ */
+void   BN_set_negative(BIGNUM *b, int n);
+/** BN_is_negative returns 1 if the BIGNUM is negative
+ * \param  a  pointer to the BIGNUM object
+ * \return 1 if a < 0 and 0 otherwise
+ */
+#define BN_is_negative(a) ((a)->neg != 0)
 
 int    BN_div(BIGNUM *dv, BIGNUM *rem, const BIGNUM *m, const BIGNUM *d,
        BN_CTX *ctx);
@@ -465,6 +416,8 @@ int BN_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
        const BIGNUM *m,BN_CTX *ctx);
 int    BN_mod_exp_mont(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
        const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
+int BN_mod_exp_mont_consttime(BIGNUM *rr, const BIGNUM *a, const BIGNUM *p,
+       const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *in_mont);
 int    BN_mod_exp_mont_word(BIGNUM *r, BN_ULONG a, const BIGNUM *p,
        const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
 int    BN_mod_exp2_mont(BIGNUM *r, const BIGNUM *a1, const BIGNUM *p1,
@@ -494,6 +447,7 @@ char *      BN_bn2hex(const BIGNUM *a);
 char * BN_bn2dec(const BIGNUM *a);
 int    BN_hex2bn(BIGNUM **a, const char *str);
 int    BN_dec2bn(BIGNUM **a, const char *str);
+int    BN_asc2bn(BIGNUM **a, const char *str);
 int    BN_gcd(BIGNUM *r,const BIGNUM *a,const BIGNUM *b,BN_CTX *ctx);
 int    BN_kronecker(const BIGNUM *a,const BIGNUM *b,BN_CTX *ctx); /* returns -2 for error */
 BIGNUM *BN_mod_inverse(BIGNUM *ret,
@@ -532,12 +486,29 @@ int BN_from_montgomery(BIGNUM *r,const BIGNUM *a,
 void BN_MONT_CTX_free(BN_MONT_CTX *mont);
 int BN_MONT_CTX_set(BN_MONT_CTX *mont,const BIGNUM *mod,BN_CTX *ctx);
 BN_MONT_CTX *BN_MONT_CTX_copy(BN_MONT_CTX *to,BN_MONT_CTX *from);
+BN_MONT_CTX *BN_MONT_CTX_set_locked(BN_MONT_CTX **pmont, int lock,
+                                       const BIGNUM *mod, BN_CTX *ctx);
 
-BN_BLINDING *BN_BLINDING_new(BIGNUM *A,BIGNUM *Ai,BIGNUM *mod);
+/* BN_BLINDING flags */
+#define        BN_BLINDING_NO_UPDATE   0x00000001
+#define        BN_BLINDING_NO_RECREATE 0x00000002
+
+BN_BLINDING *BN_BLINDING_new(const BIGNUM *A, const BIGNUM *Ai, BIGNUM *mod);
 void BN_BLINDING_free(BN_BLINDING *b);
 int BN_BLINDING_update(BN_BLINDING *b,BN_CTX *ctx);
-int BN_BLINDING_convert(BIGNUM *n, BN_BLINDING *r, BN_CTX *ctx);
+int BN_BLINDING_convert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx);
 int BN_BLINDING_invert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx);
+int BN_BLINDING_convert_ex(BIGNUM *n, BIGNUM *r, BN_BLINDING *b, BN_CTX *);
+int BN_BLINDING_invert_ex(BIGNUM *n, const BIGNUM *r, BN_BLINDING *b, BN_CTX *);
+unsigned long BN_BLINDING_get_thread_id(const BN_BLINDING *);
+void BN_BLINDING_set_thread_id(BN_BLINDING *, unsigned long);
+unsigned long BN_BLINDING_get_flags(const BN_BLINDING *);
+void BN_BLINDING_set_flags(BN_BLINDING *, unsigned long);
+BN_BLINDING *BN_BLINDING_create_param(BN_BLINDING *b,
+       const BIGNUM *e, BIGNUM *m, BN_CTX *ctx,
+       int (*bn_mod_exp)(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
+                         const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx),
+       BN_MONT_CTX *m_ctx);
 
 #ifndef OPENSSL_NO_DEPRECATED
 void BN_set_params(int mul,int high,int low,int mont);
@@ -693,9 +664,11 @@ int RAND_pseudo_bytes(unsigned char *buf,int num);
 #define bn_check_top(a) \
        do { \
                const BIGNUM *_bnum2 = (a); \
-               assert((_bnum2->top == 0) || \
+               if (_bnum2 != NULL) { \
+                       assert((_bnum2->top == 0) || \
                                (_bnum2->d[_bnum2->top - 1] != 0)); \
-               bn_pollute(_bnum2); \
+                       bn_pollute(_bnum2); \
+               } \
        } while(0)
 
 #define bn_fix_top(a)          bn_check_top(a)
@@ -726,6 +699,18 @@ BN_ULONG bn_div_words(BN_ULONG h, BN_ULONG l, BN_ULONG d);
 BN_ULONG bn_add_words(BN_ULONG *rp, const BN_ULONG *ap, const BN_ULONG *bp,int num);
 BN_ULONG bn_sub_words(BN_ULONG *rp, const BN_ULONG *ap, const BN_ULONG *bp,int num);
 
+/* Primes from RFC 2409 */
+BIGNUM *get_rfc2409_prime_768(BIGNUM *bn);
+BIGNUM *get_rfc2409_prime_1024(BIGNUM *bn);
+
+/* Primes from RFC 3526 */
+BIGNUM *get_rfc3526_prime_1536(BIGNUM *bn);
+BIGNUM *get_rfc3526_prime_2048(BIGNUM *bn);
+BIGNUM *get_rfc3526_prime_3072(BIGNUM *bn);
+BIGNUM *get_rfc3526_prime_4096(BIGNUM *bn);
+BIGNUM *get_rfc3526_prime_6144(BIGNUM *bn);
+BIGNUM *get_rfc3526_prime_8192(BIGNUM *bn);
+
 int BN_bntest_rand(BIGNUM *rnd, int bits, int top,int bottom);
 
 /* BEGIN ERROR CODES */
@@ -737,27 +722,35 @@ void ERR_load_BN_strings(void);
 /* Error codes for the BN functions. */
 
 /* Function codes. */
-#define BN_F_BN_BLINDING_CONVERT                        100
-#define BN_F_BN_BLINDING_INVERT                                 101
+#define BN_F_BNRAND                                     127
+#define BN_F_BN_BLINDING_CONVERT_EX                     100
+#define BN_F_BN_BLINDING_CREATE_PARAM                   128
+#define BN_F_BN_BLINDING_INVERT_EX                      101
 #define BN_F_BN_BLINDING_NEW                            102
 #define BN_F_BN_BLINDING_UPDATE                                 103
 #define BN_F_BN_BN2DEC                                  104
 #define BN_F_BN_BN2HEX                                  105
 #define BN_F_BN_CTX_GET                                         116
 #define BN_F_BN_CTX_NEW                                         106
+#define BN_F_BN_CTX_START                               129
 #define BN_F_BN_DIV                                     107
+#define BN_F_BN_DIV_RECP                                130
+#define BN_F_BN_EXP                                     123
 #define BN_F_BN_EXPAND2                                         108
 #define BN_F_BN_EXPAND_INTERNAL                                 120
-#define BN_F_BN_GF2M_MOD                                126
-#define BN_F_BN_GF2M_MOD_DIV                            123
-#define BN_F_BN_GF2M_MOD_EXP                            127
-#define BN_F_BN_GF2M_MOD_MUL                            124
-#define BN_F_BN_GF2M_MOD_SOLVE_QUAD                     128
-#define BN_F_BN_GF2M_MOD_SOLVE_QUAD_ARR                         129
-#define BN_F_BN_GF2M_MOD_SQR                            125
+#define BN_F_BN_GF2M_MOD                                131
+#define BN_F_BN_GF2M_MOD_EXP                            132
+#define BN_F_BN_GF2M_MOD_MUL                            133
+#define BN_F_BN_GF2M_MOD_SOLVE_QUAD                     134
+#define BN_F_BN_GF2M_MOD_SOLVE_QUAD_ARR                         135
+#define BN_F_BN_GF2M_MOD_SQR                            136
+#define BN_F_BN_GF2M_MOD_SQRT                           137
 #define BN_F_BN_MOD_EXP2_MONT                           118
 #define BN_F_BN_MOD_EXP_MONT                            109
+#define BN_F_BN_MOD_EXP_MONT_CONSTTIME                  124
 #define BN_F_BN_MOD_EXP_MONT_WORD                       117
+#define BN_F_BN_MOD_EXP_RECP                            125
+#define BN_F_BN_MOD_EXP_SIMPLE                          126
 #define BN_F_BN_MOD_INVERSE                             110
 #define BN_F_BN_MOD_LSHIFT_QUICK                        119
 #define BN_F_BN_MOD_MUL_RECIPROCAL                      111
@@ -780,9 +773,9 @@ void ERR_load_BN_strings(void);
 #define BN_R_INVALID_LENGTH                             106
 #define BN_R_INVALID_RANGE                              115
 #define BN_R_NOT_A_SQUARE                               111
-#define BN_R_NOT_IMPLEMENTED                            116
 #define BN_R_NOT_INITIALIZED                            107
 #define BN_R_NO_INVERSE                                         108
+#define BN_R_NO_SOLUTION                                116
 #define BN_R_P_IS_NOT_PRIME                             112
 #define BN_R_TOO_MANY_ITERATIONS                        113
 #define BN_R_TOO_MANY_TEMPORARY_VARIABLES               109