1 .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
4 .\" ========================================================================
5 .de Sh \" Subsection heading
13 .de Sp \" Vertical space (when we can't use .PP)
17 .de Vb \" Begin verbatim text
22 .de Ve \" End verbatim text
26 .\" Set up some character translations and predefined strings. \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
29 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
30 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
31 .\" nothing in troff, for use with C<>.
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
37 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
51 .\" Escape single quotes in literal strings from groff's Unicode transform.
55 .\" If the F register is turned on, we'll generate index entries on stderr for
56 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
57 .\" entries marked with X<> in POD. Of course, you'll have to process the
58 .\" output yourself in some meaningful fashion.
61 . tm Index:\\$1\t\\n%\t"\\$2"
71 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
72 .\" Fear. Run. Save yourself. No user-serviceable parts.
73 . \" fudge factors for nroff and troff
82 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
88 . \" simple accents for nroff and troff
98 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
99 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
100 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
101 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
102 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
103 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
105 . \" troff and (daisy-wheel) nroff accents
106 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
107 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
108 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
109 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
110 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
111 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
112 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
113 .ds ae a\h'-(\w'a'u*4/10)'e
114 .ds Ae A\h'-(\w'A'u*4/10)'E
115 . \" corrections for vroff
116 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
117 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
118 . \" for low resolution devices (crt and lpr)
119 .if \n(.H>23 .if \n(.V>19 \
132 .\" ========================================================================
134 .IX Title "BN_bn2bin 3"
135 .TH BN_bn2bin 3 "2009-04-11" "0.9.8k" "OpenSSL"
136 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
137 .\" way too many mistakes in technical documents.
141 BN_bn2bin, BN_bin2bn, BN_bn2hex, BN_bn2dec, BN_hex2bn, BN_dec2bn,
142 BN_print, BN_print_fp, BN_bn2mpi, BN_mpi2bn \- format conversions
144 .IX Header "SYNOPSIS"
146 \& #include <openssl/bn.h>
148 \& int BN_bn2bin(const BIGNUM *a, unsigned char *to);
149 \& BIGNUM *BN_bin2bn(const unsigned char *s, int len, BIGNUM *ret);
151 \& char *BN_bn2hex(const BIGNUM *a);
152 \& char *BN_bn2dec(const BIGNUM *a);
153 \& int BN_hex2bn(BIGNUM **a, const char *str);
154 \& int BN_dec2bn(BIGNUM **a, const char *str);
156 \& int BN_print(BIO *fp, const BIGNUM *a);
157 \& int BN_print_fp(FILE *fp, const BIGNUM *a);
159 \& int BN_bn2mpi(const BIGNUM *a, unsigned char *to);
160 \& BIGNUM *BN_mpi2bn(unsigned char *s, int len, BIGNUM *ret);
163 .IX Header "DESCRIPTION"
164 \&\fIBN_bn2bin()\fR converts the absolute value of \fBa\fR into big-endian form
165 and stores it at \fBto\fR. \fBto\fR must point to BN_num_bytes(\fBa\fR) bytes of
168 \&\fIBN_bin2bn()\fR converts the positive integer in big-endian form of length
169 \&\fBlen\fR at \fBs\fR into a \fB\s-1BIGNUM\s0\fR and places it in \fBret\fR. If \fBret\fR is
170 \&\s-1NULL\s0, a new \fB\s-1BIGNUM\s0\fR is created.
172 \&\fIBN_bn2hex()\fR and \fIBN_bn2dec()\fR return printable strings containing the
173 hexadecimal and decimal encoding of \fBa\fR respectively. For negative
174 numbers, the string is prefaced with a leading '\-'. The string must be
175 freed later using \fIOPENSSL_free()\fR.
177 \&\fIBN_hex2bn()\fR converts the string \fBstr\fR containing a hexadecimal number
178 to a \fB\s-1BIGNUM\s0\fR and stores it in **\fBbn\fR. If *\fBbn\fR is \s-1NULL\s0, a new
179 \&\fB\s-1BIGNUM\s0\fR is created. If \fBbn\fR is \s-1NULL\s0, it only computes the number's
180 length in hexadecimal digits. If the string starts with '\-', the
181 number is negative. \fIBN_dec2bn()\fR is the same using the decimal system.
183 \&\fIBN_print()\fR and \fIBN_print_fp()\fR write the hexadecimal encoding of \fBa\fR,
184 with a leading '\-' for negative numbers, to the \fB\s-1BIO\s0\fR or \fB\s-1FILE\s0\fR
187 \&\fIBN_bn2mpi()\fR and \fIBN_mpi2bn()\fR convert \fB\s-1BIGNUM\s0\fRs from and to a format
188 that consists of the number's length in bytes represented as a 4\-byte
189 big-endian number, and the number itself in big-endian format, where
190 the most significant bit signals a negative number (the representation
191 of numbers with the \s-1MSB\s0 set is prefixed with null byte).
193 \&\fIBN_bn2mpi()\fR stores the representation of \fBa\fR at \fBto\fR, where \fBto\fR
194 must be large enough to hold the result. The size can be determined by
195 calling BN_bn2mpi(\fBa\fR, \s-1NULL\s0).
197 \&\fIBN_mpi2bn()\fR converts the \fBlen\fR bytes long representation at \fBs\fR to
198 a \fB\s-1BIGNUM\s0\fR and stores it at \fBret\fR, or in a newly allocated \fB\s-1BIGNUM\s0\fR
199 if \fBret\fR is \s-1NULL\s0.
201 .IX Header "RETURN VALUES"
202 \&\fIBN_bn2bin()\fR returns the length of the big-endian number placed at \fBto\fR.
203 \&\fIBN_bin2bn()\fR returns the \fB\s-1BIGNUM\s0\fR, \s-1NULL\s0 on error.
205 \&\fIBN_bn2hex()\fR and \fIBN_bn2dec()\fR return a null-terminated string, or \s-1NULL\s0
206 on error. \fIBN_hex2bn()\fR and \fIBN_dec2bn()\fR return the number's length in
207 hexadecimal or decimal digits, and 0 on error.
209 \&\fIBN_print_fp()\fR and \fIBN_print()\fR return 1 on success, 0 on write errors.
211 \&\fIBN_bn2mpi()\fR returns the length of the representation. \fIBN_mpi2bn()\fR
212 returns the \fB\s-1BIGNUM\s0\fR, and \s-1NULL\s0 on error.
214 The error codes can be obtained by \fIERR_get_error\fR\|(3).
216 .IX Header "SEE ALSO"
217 \&\fIbn\fR\|(3), \fIERR_get_error\fR\|(3), \fIBN_zero\fR\|(3),
218 \&\fIASN1_INTEGER_to_BN\fR\|(3),
219 \&\fIBN_num_bytes\fR\|(3)
222 \&\fIBN_bn2bin()\fR, \fIBN_bin2bn()\fR, \fIBN_print_fp()\fR and \fIBN_print()\fR are available
223 in all versions of SSLeay and OpenSSL.
225 \&\fIBN_bn2hex()\fR, \fIBN_bn2dec()\fR, \fIBN_hex2bn()\fR, \fIBN_dec2bn()\fR, \fIBN_bn2mpi()\fR and
226 \&\fIBN_mpi2bn()\fR were added in SSLeay 0.9.0.