307 lines
11 KiB
Groff
307 lines
11 KiB
Groff
.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.28)
|
|
.\"
|
|
.\" Standard preamble:
|
|
.\" ========================================================================
|
|
.de Sp \" Vertical space (when we can't use .PP)
|
|
.if t .sp .5v
|
|
.if n .sp
|
|
..
|
|
.de Vb \" Begin verbatim text
|
|
.ft CW
|
|
.nf
|
|
.ne \\$1
|
|
..
|
|
.de Ve \" End verbatim text
|
|
.ft R
|
|
.fi
|
|
..
|
|
.\" Set up some character translations and predefined strings. \*(-- will
|
|
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
|
|
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
|
|
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
|
|
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
|
|
.\" nothing in troff, for use with C<>.
|
|
.tr \(*W-
|
|
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
|
|
.ie n \{\
|
|
. ds -- \(*W-
|
|
. ds PI pi
|
|
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
|
|
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
|
|
. ds L" ""
|
|
. ds R" ""
|
|
. ds C` ""
|
|
. ds C' ""
|
|
'br\}
|
|
.el\{\
|
|
. ds -- \|\(em\|
|
|
. ds PI \(*p
|
|
. ds L" ``
|
|
. ds R" ''
|
|
'br\}
|
|
.\"
|
|
.\" Escape single quotes in literal strings from groff's Unicode transform.
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\"
|
|
.\" If the F register is turned on, we'll generate index entries on stderr for
|
|
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
|
|
.\" entries marked with X<> in POD. Of course, you'll have to process the
|
|
.\" output yourself in some meaningful fashion.
|
|
.ie \nF \{\
|
|
. de IX
|
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
|
..
|
|
. nr % 0
|
|
. rr F
|
|
.\}
|
|
.el \{\
|
|
. de IX
|
|
..
|
|
.\}
|
|
.\"
|
|
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
|
|
.\" Fear. Run. Save yourself. No user-serviceable parts.
|
|
. \" fudge factors for nroff and troff
|
|
.if n \{\
|
|
. ds #H 0
|
|
. ds #V .8m
|
|
. ds #F .3m
|
|
. ds #[ \f1
|
|
. ds #] \fP
|
|
.\}
|
|
.if t \{\
|
|
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
|
|
. ds #V .6m
|
|
. ds #F 0
|
|
. ds #[ \&
|
|
. ds #] \&
|
|
.\}
|
|
. \" simple accents for nroff and troff
|
|
.if n \{\
|
|
. ds ' \&
|
|
. ds ` \&
|
|
. ds ^ \&
|
|
. ds , \&
|
|
. ds ~ ~
|
|
. ds /
|
|
.\}
|
|
.if t \{\
|
|
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
|
|
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
|
|
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
|
|
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
|
|
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
|
|
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
|
|
.\}
|
|
. \" troff and (daisy-wheel) nroff accents
|
|
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
|
|
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
|
|
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
|
|
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
|
|
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
|
|
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
|
|
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
|
|
.ds ae a\h'-(\w'a'u*4/10)'e
|
|
.ds Ae A\h'-(\w'A'u*4/10)'E
|
|
. \" corrections for vroff
|
|
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
|
|
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
|
|
. \" for low resolution devices (crt and lpr)
|
|
.if \n(.H>23 .if \n(.V>19 \
|
|
\{\
|
|
. ds : e
|
|
. ds 8 ss
|
|
. ds o a
|
|
. ds d- d\h'-1'\(ga
|
|
. ds D- D\h'-1'\(hy
|
|
. ds th \o'bp'
|
|
. ds Th \o'LP'
|
|
. ds ae ae
|
|
. ds Ae AE
|
|
.\}
|
|
.rm #[ #] #H #V #F C
|
|
.\" ========================================================================
|
|
.\"
|
|
.IX Title "bn 3"
|
|
.TH bn 3 "2014-10-15" "1.0.1j" "OpenSSL"
|
|
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
|
|
.\" way too many mistakes in technical documents.
|
|
.if n .ad l
|
|
.nh
|
|
.SH "NAME"
|
|
bn \- multiprecision integer arithmetics
|
|
.SH "SYNOPSIS"
|
|
.IX Header "SYNOPSIS"
|
|
.Vb 1
|
|
\& #include <openssl/bn.h>
|
|
\&
|
|
\& BIGNUM *BN_new(void);
|
|
\& void BN_free(BIGNUM *a);
|
|
\& void BN_init(BIGNUM *);
|
|
\& void BN_clear(BIGNUM *a);
|
|
\& void BN_clear_free(BIGNUM *a);
|
|
\&
|
|
\& BN_CTX *BN_CTX_new(void);
|
|
\& void BN_CTX_init(BN_CTX *c);
|
|
\& void BN_CTX_free(BN_CTX *c);
|
|
\&
|
|
\& BIGNUM *BN_copy(BIGNUM *a, const BIGNUM *b);
|
|
\& BIGNUM *BN_dup(const BIGNUM *a);
|
|
\&
|
|
\& BIGNUM *BN_swap(BIGNUM *a, BIGNUM *b);
|
|
\&
|
|
\& int BN_num_bytes(const BIGNUM *a);
|
|
\& int BN_num_bits(const BIGNUM *a);
|
|
\& int BN_num_bits_word(BN_ULONG w);
|
|
\&
|
|
\& void BN_set_negative(BIGNUM *a, int n);
|
|
\& int BN_is_negative(const BIGNUM *a);
|
|
\&
|
|
\& int BN_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
|
|
\& int BN_sub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
|
|
\& int BN_mul(BIGNUM *r, BIGNUM *a, BIGNUM *b, BN_CTX *ctx);
|
|
\& int BN_sqr(BIGNUM *r, BIGNUM *a, BN_CTX *ctx);
|
|
\& int BN_div(BIGNUM *dv, BIGNUM *rem, const BIGNUM *a, const BIGNUM *d,
|
|
\& BN_CTX *ctx);
|
|
\& int BN_mod(BIGNUM *rem, const BIGNUM *a, const BIGNUM *m, BN_CTX *ctx);
|
|
\& int BN_nnmod(BIGNUM *rem, const BIGNUM *a, const BIGNUM *m, BN_CTX *ctx);
|
|
\& int BN_mod_add(BIGNUM *ret, BIGNUM *a, BIGNUM *b, const BIGNUM *m,
|
|
\& BN_CTX *ctx);
|
|
\& int BN_mod_sub(BIGNUM *ret, BIGNUM *a, BIGNUM *b, const BIGNUM *m,
|
|
\& BN_CTX *ctx);
|
|
\& int BN_mod_mul(BIGNUM *ret, BIGNUM *a, BIGNUM *b, const BIGNUM *m,
|
|
\& BN_CTX *ctx);
|
|
\& int BN_mod_sqr(BIGNUM *ret, BIGNUM *a, const BIGNUM *m, BN_CTX *ctx);
|
|
\& int BN_exp(BIGNUM *r, BIGNUM *a, BIGNUM *p, BN_CTX *ctx);
|
|
\& int BN_mod_exp(BIGNUM *r, BIGNUM *a, const BIGNUM *p,
|
|
\& const BIGNUM *m, BN_CTX *ctx);
|
|
\& int BN_gcd(BIGNUM *r, BIGNUM *a, BIGNUM *b, BN_CTX *ctx);
|
|
\&
|
|
\& int BN_add_word(BIGNUM *a, BN_ULONG w);
|
|
\& int BN_sub_word(BIGNUM *a, BN_ULONG w);
|
|
\& int BN_mul_word(BIGNUM *a, BN_ULONG w);
|
|
\& BN_ULONG BN_div_word(BIGNUM *a, BN_ULONG w);
|
|
\& BN_ULONG BN_mod_word(const BIGNUM *a, BN_ULONG w);
|
|
\&
|
|
\& int BN_cmp(BIGNUM *a, BIGNUM *b);
|
|
\& int BN_ucmp(BIGNUM *a, BIGNUM *b);
|
|
\& int BN_is_zero(BIGNUM *a);
|
|
\& int BN_is_one(BIGNUM *a);
|
|
\& int BN_is_word(BIGNUM *a, BN_ULONG w);
|
|
\& int BN_is_odd(BIGNUM *a);
|
|
\&
|
|
\& int BN_zero(BIGNUM *a);
|
|
\& int BN_one(BIGNUM *a);
|
|
\& const BIGNUM *BN_value_one(void);
|
|
\& int BN_set_word(BIGNUM *a, unsigned long w);
|
|
\& unsigned long BN_get_word(BIGNUM *a);
|
|
\&
|
|
\& int BN_rand(BIGNUM *rnd, int bits, int top, int bottom);
|
|
\& int BN_pseudo_rand(BIGNUM *rnd, int bits, int top, int bottom);
|
|
\& int BN_rand_range(BIGNUM *rnd, BIGNUM *range);
|
|
\& int BN_pseudo_rand_range(BIGNUM *rnd, BIGNUM *range);
|
|
\&
|
|
\& BIGNUM *BN_generate_prime(BIGNUM *ret, int bits,int safe, BIGNUM *add,
|
|
\& BIGNUM *rem, void (*callback)(int, int, void *), void *cb_arg);
|
|
\& int BN_is_prime(const BIGNUM *p, int nchecks,
|
|
\& void (*callback)(int, int, void *), BN_CTX *ctx, void *cb_arg);
|
|
\&
|
|
\& int BN_set_bit(BIGNUM *a, int n);
|
|
\& int BN_clear_bit(BIGNUM *a, int n);
|
|
\& int BN_is_bit_set(const BIGNUM *a, int n);
|
|
\& int BN_mask_bits(BIGNUM *a, int n);
|
|
\& int BN_lshift(BIGNUM *r, const BIGNUM *a, int n);
|
|
\& int BN_lshift1(BIGNUM *r, BIGNUM *a);
|
|
\& int BN_rshift(BIGNUM *r, BIGNUM *a, int n);
|
|
\& int BN_rshift1(BIGNUM *r, BIGNUM *a);
|
|
\&
|
|
\& int BN_bn2bin(const BIGNUM *a, unsigned char *to);
|
|
\& BIGNUM *BN_bin2bn(const unsigned char *s, int len, BIGNUM *ret);
|
|
\& 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_print(BIO *fp, const BIGNUM *a);
|
|
\& int BN_print_fp(FILE *fp, const BIGNUM *a);
|
|
\& int BN_bn2mpi(const BIGNUM *a, unsigned char *to);
|
|
\& BIGNUM *BN_mpi2bn(unsigned char *s, int len, BIGNUM *ret);
|
|
\&
|
|
\& BIGNUM *BN_mod_inverse(BIGNUM *r, BIGNUM *a, const BIGNUM *n,
|
|
\& BN_CTX *ctx);
|
|
\&
|
|
\& BN_RECP_CTX *BN_RECP_CTX_new(void);
|
|
\& void BN_RECP_CTX_init(BN_RECP_CTX *recp);
|
|
\& void BN_RECP_CTX_free(BN_RECP_CTX *recp);
|
|
\& int BN_RECP_CTX_set(BN_RECP_CTX *recp, const BIGNUM *m, BN_CTX *ctx);
|
|
\& int BN_mod_mul_reciprocal(BIGNUM *r, BIGNUM *a, BIGNUM *b,
|
|
\& BN_RECP_CTX *recp, BN_CTX *ctx);
|
|
\&
|
|
\& BN_MONT_CTX *BN_MONT_CTX_new(void);
|
|
\& void BN_MONT_CTX_init(BN_MONT_CTX *ctx);
|
|
\& void BN_MONT_CTX_free(BN_MONT_CTX *mont);
|
|
\& int BN_MONT_CTX_set(BN_MONT_CTX *mont, const BIGNUM *m, BN_CTX *ctx);
|
|
\& BN_MONT_CTX *BN_MONT_CTX_copy(BN_MONT_CTX *to, BN_MONT_CTX *from);
|
|
\& int BN_mod_mul_montgomery(BIGNUM *r, BIGNUM *a, BIGNUM *b,
|
|
\& BN_MONT_CTX *mont, BN_CTX *ctx);
|
|
\& int BN_from_montgomery(BIGNUM *r, BIGNUM *a, BN_MONT_CTX *mont,
|
|
\& BN_CTX *ctx);
|
|
\& int BN_to_montgomery(BIGNUM *r, BIGNUM *a, BN_MONT_CTX *mont,
|
|
\& BN_CTX *ctx);
|
|
\&
|
|
\& 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 *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 *ctx);
|
|
\& int BN_BLINDING_invert_ex(BIGNUM *n,const BIGNUM *r,BN_BLINDING *b,
|
|
\& BN_CTX *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);
|
|
.Ve
|
|
.SH "DESCRIPTION"
|
|
.IX Header "DESCRIPTION"
|
|
This library performs arithmetic operations on integers of arbitrary
|
|
size. It was written for use in public key cryptography, such as \s-1RSA\s0
|
|
and Diffie-Hellman.
|
|
.PP
|
|
It uses dynamic memory allocation for storing its data structures.
|
|
That means that there is no limit on the size of the numbers
|
|
manipulated by these functions, but return values must always be
|
|
checked in case a memory allocation error has occurred.
|
|
.PP
|
|
The basic object in this library is a \fB\s-1BIGNUM\s0\fR. It is used to hold a
|
|
single large integer. This type should be considered opaque and fields
|
|
should not be modified or accessed directly.
|
|
.PP
|
|
The creation of \fB\s-1BIGNUM\s0\fR objects is described in \fIBN_new\fR\|(3);
|
|
\&\fIBN_add\fR\|(3) describes most of the arithmetic operations.
|
|
Comparison is described in \fIBN_cmp\fR\|(3); \fIBN_zero\fR\|(3)
|
|
describes certain assignments, \fIBN_rand\fR\|(3) the generation of
|
|
random numbers, \fIBN_generate_prime\fR\|(3) deals with prime
|
|
numbers and \fIBN_set_bit\fR\|(3) with bit operations. The conversion
|
|
of \fB\s-1BIGNUM\s0\fRs to external formats is described in \fIBN_bn2bin\fR\|(3).
|
|
.SH "SEE ALSO"
|
|
.IX Header "SEE ALSO"
|
|
\&\fIbn_internal\fR\|(3),
|
|
\&\fIdh\fR\|(3), \fIerr\fR\|(3), \fIrand\fR\|(3), \fIrsa\fR\|(3),
|
|
\&\fIBN_new\fR\|(3), \fIBN_CTX_new\fR\|(3),
|
|
\&\fIBN_copy\fR\|(3), \fIBN_swap\fR\|(3), \fIBN_num_bytes\fR\|(3),
|
|
\&\fIBN_add\fR\|(3), \fIBN_add_word\fR\|(3),
|
|
\&\fIBN_cmp\fR\|(3), \fIBN_zero\fR\|(3), \fIBN_rand\fR\|(3),
|
|
\&\fIBN_generate_prime\fR\|(3), \fIBN_set_bit\fR\|(3),
|
|
\&\fIBN_bn2bin\fR\|(3), \fIBN_mod_inverse\fR\|(3),
|
|
\&\fIBN_mod_mul_reciprocal\fR\|(3),
|
|
\&\fIBN_mod_mul_montgomery\fR\|(3),
|
|
\&\fIBN_BLINDING_new\fR\|(3)
|