doc/crypto/bn.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 bn - Multiprecision integer arithmetics
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/bn.h>
  10
  11  #define BN_prime_checks(b)
  12  #define BN_num_bytes(a)
  13  #define BN_is_word(a,w)
  14  #define BN_is_zero(a)
  15  #define BN_is_one(a)
  16  #define BN_is_odd(a)
  17  #define BN_one(a)
  18  #define BN_zero(a)
  19
  20  #define bn_expand(n,b)
  21  #define bn_wexpand(n,b)
  22
  23  #define bn_fix_top(a)
  24
  25  BIGNUM *BN_value_one(void);
  26  char * BN_options(void);
  27  BN_CTX *BN_CTX_new(void);
  28  void   BN_CTX_init(BN_CTX *c);
  29  void   BN_CTX_free(BN_CTX *c);
  30  int     BN_rand(BIGNUM *rnd, int bits, int top,int bottom);
  31  int    BN_num_bits(const BIGNUM *a);
  32  int    BN_num_bits_word(BN_ULONG);
  33  BIGNUM *BN_new(void);
  34  void   BN_init(BIGNUM *);
  35  void   BN_clear_free(BIGNUM *a);
  36  BIGNUM *BN_copy(BIGNUM *a, const BIGNUM *b);
  37  BIGNUM *BN_bin2bn(const unsigned char *s,int len,BIGNUM *ret);
  38  int    BN_bn2bin(const BIGNUM *a, unsigned char *to);
  39  BIGNUM *BN_mpi2bn(unsigned char *s,int len,BIGNUM *ret);
  40  int    BN_bn2mpi(const BIGNUM *a, unsigned char *to);
  41  int    BN_sub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
  42  int    BN_usub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
  43  int    BN_uadd(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
  44  int    BN_add(BIGNUM *r, BIGNUM *a, BIGNUM *b);
  45  int    BN_mod(BIGNUM *rem, const BIGNUM *m, const BIGNUM *d, BN_CTX *ctx);
  46  int    BN_div(BIGNUM *dv, BIGNUM *rem, const BIGNUM *m, const BIGNUM *d,
  47                BN_CTX *ctx);
  48  int    BN_mul(BIGNUM *r, BIGNUM *a, BIGNUM *b,BN_CTX *ctx);
  49  int    BN_sqr(BIGNUM *r, BIGNUM *a,BN_CTX *ctx);
  50  BN_ULONG BN_mod_word(BIGNUM *a, BN_ULONG w);
  51  BN_ULONG BN_div_word(BIGNUM *a, BN_ULONG w);
  52  int    BN_mul_word(BIGNUM *a, BN_ULONG w);
  53  int    BN_add_word(BIGNUM *a, BN_ULONG w);
  54  int    BN_sub_word(BIGNUM *a, BN_ULONG w);
  55  int    BN_set_word(BIGNUM *a, BN_ULONG w);
  56  BN_ULONG BN_get_word(BIGNUM *a);
  57  int    BN_cmp(const BIGNUM *a, const BIGNUM *b);
  58  void   BN_free(BIGNUM *a);
  59  int    BN_is_bit_set(const BIGNUM *a, int n);
  60  int    BN_lshift(BIGNUM *r, const BIGNUM *a, int n);
  61  int    BN_lshift1(BIGNUM *r, BIGNUM *a);
  62  int    BN_exp(BIGNUM *r, BIGNUM *a, BIGNUM *p,BN_CTX *ctx);
  63  int    BN_mod_exp(BIGNUM *r, BIGNUM *a, const BIGNUM *p,
  64                    const BIGNUM *m,BN_CTX *ctx);
  65  int    BN_mod_exp_mont(BIGNUM *r, BIGNUM *a, const BIGNUM *p,
  66                         const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
  67  int    BN_mod_exp2_mont(BIGNUM *r, BIGNUM *a1, BIGNUM *p1,BIGNUM *a2,
  68                 BIGNUM *p2,BIGNUM *m,BN_CTX *ctx,BN_MONT_CTX *m_ctx);
  69  int    BN_mod_exp_simple(BIGNUM *r, BIGNUM *a, BIGNUM *p,
  70         BIGNUM *m,BN_CTX *ctx);
  71  int    BN_mask_bits(BIGNUM *a,int n);
  72  int    BN_mod_mul(BIGNUM *ret, BIGNUM *a, BIGNUM *b, const BIGNUM *m, BN_CTX *ctx);
  73  int    BN_print_fp(FILE *fp, BIGNUM *a);
  74  int    BN_print(BIO *fp, const BIGNUM *a);
  75  int    BN_reciprocal(BIGNUM *r, BIGNUM *m, int len, BN_CTX *ctx);
  76  int    BN_rshift(BIGNUM *r, BIGNUM *a, int n);
  77  int    BN_rshift1(BIGNUM *r, BIGNUM *a);
  78  void   BN_clear(BIGNUM *a);
  79  BIGNUM *bn_expand2(BIGNUM *b, int bits);
  80  BIGNUM *BN_dup(const BIGNUM *a);
  81  int    BN_ucmp(const BIGNUM *a, const BIGNUM *b);
  82  int    BN_set_bit(BIGNUM *a, int n);
  83  int    BN_clear_bit(BIGNUM *a, int n);
  84  char * BN_bn2hex(const BIGNUM *a);
  85  char * BN_bn2dec(const BIGNUM *a);
  86  int    BN_hex2bn(BIGNUM **a, const char *str);
  87  int    BN_dec2bn(BIGNUM **a, const char *str);
  88  int    BN_gcd(BIGNUM *r,BIGNUM *in_a,BIGNUM *in_b,BN_CTX *ctx);
  89  BIGNUM *BN_mod_inverse(BIGNUM *ret,BIGNUM *a, const BIGNUM *n,BN_CTX *ctx);
  90  BIGNUM *BN_generate_prime(BIGNUM *ret,int bits,int safe,BIGNUM *add,
  91                 BIGNUM *rem,void (*callback)(int,int,void *),void *cb_arg);
  92  int    BN_is_prime(BIGNUM *p,int nchecks,void (*callback)(int,int,void *),
  93                 BN_CTX *ctx,void *cb_arg);
  94  void   ERR_load_BN_strings(void );
  95
  96  BN_ULONG bn_mul_add_words(BN_ULONG *rp, BN_ULONG *ap, int num, BN_ULONG w);
  97  BN_ULONG bn_mul_words(BN_ULONG *rp, BN_ULONG *ap, int num, BN_ULONG w);
  98  void     bn_sqr_words(BN_ULONG *rp, BN_ULONG *ap, int num);
  99  BN_ULONG bn_div_words(BN_ULONG h, BN_ULONG l, BN_ULONG d);
 100  BN_ULONG bn_add_words(BN_ULONG *rp, BN_ULONG *ap, BN_ULONG *bp,int num);
 101  BN_ULONG bn_sub_words(BN_ULONG *rp, BN_ULONG *ap, BN_ULONG *bp,int num);
 102
 103  BN_MONT_CTX *BN_MONT_CTX_new(void );
 104  void BN_MONT_CTX_init(BN_MONT_CTX *ctx);
 105  int BN_mod_mul_montgomery(BIGNUM *r,BIGNUM *a,BIGNUM *b,BN_MONT_CTX *mont,
 106                           BN_CTX *ctx);
 107  int BN_from_montgomery(BIGNUM *r,BIGNUM *a,BN_MONT_CTX *mont,BN_CTX *ctx);
 108  void BN_MONT_CTX_free(BN_MONT_CTX *mont);
 109  int BN_MONT_CTX_set(BN_MONT_CTX *mont,const BIGNUM *modulus,BN_CTX *ctx);
 110  BN_MONT_CTX *BN_MONT_CTX_copy(BN_MONT_CTX *to,BN_MONT_CTX *from);
 111
 112  BN_BLINDING *BN_BLINDING_new(BIGNUM *A,BIGNUM *Ai,BIGNUM *mod);
 113  void BN_BLINDING_free(BN_BLINDING *b);
 114  int BN_BLINDING_update(BN_BLINDING *b,BN_CTX *ctx);
 115  int BN_BLINDING_convert(BIGNUM *n, BN_BLINDING *r, BN_CTX *ctx);
 116  int BN_BLINDING_invert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx);
 117
 118  void BN_set_params(int mul,int high,int low,int mont);
 119  int BN_get_params(int which);
 120
 121  void   BN_RECP_CTX_init(BN_RECP_CTX *recp);
 122  BN_RECP_CTX *BN_RECP_CTX_new(void);
 123  void   BN_RECP_CTX_free(BN_RECP_CTX *recp);
 124  int    BN_RECP_CTX_set(BN_RECP_CTX *recp,const BIGNUM *rdiv,BN_CTX *ctx);
 125  int    BN_mod_mul_reciprocal(BIGNUM *r, BIGNUM *x, BIGNUM *y,
 126                 BN_RECP_CTX *recp,BN_CTX *ctx);
 127  int    BN_mod_exp_recp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
 128                         const BIGNUM *m, BN_CTX *ctx);
 129  int    BN_div_recp(BIGNUM *dv, BIGNUM *rem, BIGNUM *m,
 130                 BN_RECP_CTX *recp, BN_CTX *ctx);
 131
 132 =head1 DESCRIPTION
 133
 134 =head1 SEE ALSO
 135
 136 err(3), rand(3)
 137
 138 =cut