Commit manual pages after running 'man-update' and add new manual pages.
[dragonfly.git] / secure / lib / libcrypto / man / BN_bn2bin.3
CommitLineData
74dab6c2
JR
1.rn '' }`
2''' $RCSfile$$Revision$$Date$
3'''
4''' $Log$
5'''
6.de Sh
984263bc
MD
7.br
8.if t .Sp
9.ne 5
10.PP
11\fB\\$1\fR
12.PP
13..
74dab6c2 14.de Sp
984263bc
MD
15.if t .sp .5v
16.if n .sp
17..
74dab6c2 18.de Ip
984263bc
MD
19.br
20.ie \\n(.$>=3 .ne \\$3
21.el .ne 3
22.IP "\\$1" \\$2
23..
74dab6c2 24.de Vb
984263bc
MD
25.ft CW
26.nf
27.ne \\$1
28..
74dab6c2 29.de Ve
984263bc
MD
30.ft R
31
32.fi
33..
74dab6c2
JR
34'''
35'''
36''' Set up \*(-- to give an unbreakable dash;
37''' string Tr holds user defined translation string.
38''' Bell System Logo is used as a dummy character.
39'''
984263bc 40.tr \(*W-|\(bv\*(Tr
984263bc 41.ie n \{\
74dab6c2
JR
42.ds -- \(*W-
43.ds PI pi
44.if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
45.if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
46.ds L" ""
47.ds R" ""
48''' \*(M", \*(S", \*(N" and \*(T" are the equivalent of
49''' \*(L" and \*(R", except that they are used on ".xx" lines,
50''' such as .IP and .SH, which do another additional levels of
51''' double-quote interpretation
52.ds M" """
53.ds S" """
54.ds N" """""
55.ds T" """""
56.ds L' '
57.ds R' '
58.ds M' '
59.ds S' '
60.ds N' '
61.ds T' '
984263bc
MD
62'br\}
63.el\{\
74dab6c2
JR
64.ds -- \(em\|
65.tr \*(Tr
66.ds L" ``
67.ds R" ''
68.ds M" ``
69.ds S" ''
70.ds N" ``
71.ds T" ''
72.ds L' `
73.ds R' '
74.ds M' `
75.ds S' '
76.ds N' `
77.ds T' '
78.ds PI \(*p
984263bc 79'br\}
74dab6c2
JR
80.\" If the F register is turned on, we'll generate
81.\" index entries out stderr for the following things:
82.\" TH Title
83.\" SH Header
84.\" Sh Subsection
85.\" Ip Item
86.\" X<> Xref (embedded
87.\" Of course, you have to process the output yourself
88.\" in some meaninful fashion.
89.if \nF \{
90.de IX
91.tm Index:\\$1\t\\n%\t"\\$2"
984263bc 92..
74dab6c2
JR
93.nr % 0
94.rr F
984263bc 95.\}
74dab6c2
JR
96.TH BN_bn2bin 3 "0.9.7d" "2/Sep/2004" "OpenSSL"
97.UC
98.if n .hy 0
984263bc 99.if n .na
74dab6c2
JR
100.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
101.de CQ \" put $1 in typewriter font
102.ft CW
103'if n "\c
104'if t \\&\\$1\c
105'if n \\&\\$1\c
106'if n \&"
107\\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7
108'.ft R
109..
110.\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2
111. \" AM - accent mark definitions
984263bc 112.bd B 3
74dab6c2 113. \" fudge factors for nroff and troff
984263bc 114.if n \{\
74dab6c2
JR
115. ds #H 0
116. ds #V .8m
117. ds #F .3m
118. ds #[ \f1
119. ds #] \fP
984263bc
MD
120.\}
121.if t \{\
74dab6c2
JR
122. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
123. ds #V .6m
124. ds #F 0
125. ds #[ \&
126. ds #] \&
984263bc 127.\}
74dab6c2 128. \" simple accents for nroff and troff
984263bc 129.if n \{\
74dab6c2
JR
130. ds ' \&
131. ds ` \&
132. ds ^ \&
133. ds , \&
134. ds ~ ~
135. ds ? ?
136. ds ! !
137. ds /
138. ds q
984263bc
MD
139.\}
140.if t \{\
74dab6c2
JR
141. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
142. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
143. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
144. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
145. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
146. ds ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10'
147. ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m'
148. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
149. ds q o\h'-\w'o'u*8/10'\s-4\v'.4m'\z\(*i\v'-.4m'\s+4\h'\w'o'u*8/10'
984263bc 150.\}
74dab6c2 151. \" troff and (daisy-wheel) nroff accents
984263bc
MD
152.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
153.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
74dab6c2
JR
154.ds v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#]
155.ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u'
156.ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u'
157.ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#]
984263bc
MD
158.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
159.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
160.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
161.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
162.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
163.ds ae a\h'-(\w'a'u*4/10)'e
164.ds Ae A\h'-(\w'A'u*4/10)'E
74dab6c2
JR
165.ds oe o\h'-(\w'o'u*4/10)'e
166.ds Oe O\h'-(\w'O'u*4/10)'E
167. \" corrections for vroff
984263bc
MD
168.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
169.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
74dab6c2 170. \" for low resolution devices (crt and lpr)
984263bc
MD
171.if \n(.H>23 .if \n(.V>19 \
172\{\
74dab6c2
JR
173. ds : e
174. ds 8 ss
175. ds v \h'-1'\o'\(aa\(ga'
176. ds _ \h'-1'^
177. ds . \h'-1'.
178. ds 3 3
179. ds o a
180. ds d- d\h'-1'\(ga
181. ds D- D\h'-1'\(hy
182. ds th \o'bp'
183. ds Th \o'LP'
184. ds ae ae
185. ds Ae AE
186. ds oe oe
187. ds Oe OE
984263bc
MD
188.\}
189.rm #[ #] #H #V #F C
984263bc
MD
190.SH "NAME"
191BN_bn2bin, BN_bin2bn, BN_bn2hex, BN_bn2dec, BN_hex2bn, BN_dec2bn,
192BN_print, BN_print_fp, BN_bn2mpi, BN_mpi2bn \- format conversions
193.SH "SYNOPSIS"
74dab6c2 194.PP
984263bc
MD
195.Vb 1
196\& #include <openssl/bn.h>
197.Ve
198.Vb 2
199\& int BN_bn2bin(const BIGNUM *a, unsigned char *to);
200\& BIGNUM *BN_bin2bn(const unsigned char *s, int len, BIGNUM *ret);
201.Ve
202.Vb 4
203\& char *BN_bn2hex(const BIGNUM *a);
204\& char *BN_bn2dec(const BIGNUM *a);
205\& int BN_hex2bn(BIGNUM **a, const char *str);
206\& int BN_dec2bn(BIGNUM **a, const char *str);
207.Ve
208.Vb 2
209\& int BN_print(BIO *fp, const BIGNUM *a);
210\& int BN_print_fp(FILE *fp, const BIGNUM *a);
211.Ve
212.Vb 2
213\& int BN_bn2mpi(const BIGNUM *a, unsigned char *to);
214\& BIGNUM *BN_mpi2bn(unsigned char *s, int len, BIGNUM *ret);
215.Ve
216.SH "DESCRIPTION"
74dab6c2
JR
217\fIBN_bn2bin()\fR converts the absolute value of \fBa\fR into big-endian form
218and stores it at \fBto\fR. \fBto\fR must point to \fIBN_num_bytes\fR\|(\fBa\fR) bytes of
984263bc
MD
219memory.
220.PP
74dab6c2
JR
221\fIBN_bin2bn()\fR converts the positive integer in big-endian form of length
222\fBlen\fR at \fBs\fR into a \fBBIGNUM\fR and places it in \fBret\fR. If \fBret\fR is
223NULL, a new \fBBIGNUM\fR is created.
984263bc 224.PP
74dab6c2 225\fIBN_bn2hex()\fR and \fIBN_bn2dec()\fR return printable strings containing the
984263bc 226hexadecimal and decimal encoding of \fBa\fR respectively. For negative
74dab6c2 227numbers, the string is prefaced with a leading \*(L'\-\*(R'. The string must be
984263bc
MD
228freed later using \fIOPENSSL_free()\fR.
229.PP
74dab6c2
JR
230\fIBN_hex2bn()\fR converts the string \fBstr\fR containing a hexadecimal number
231to a \fBBIGNUM\fR and stores it in **\fBbn\fR. If *\fBbn\fR is NULL, a new
232\fBBIGNUM\fR is created. If \fBbn\fR is NULL, it only computes the number's
233length in hexadecimal digits. If the string starts with \*(L'\-\*(R', the
984263bc
MD
234number is negative. \fIBN_dec2bn()\fR is the same using the decimal system.
235.PP
74dab6c2
JR
236\fIBN_print()\fR and \fIBN_print_fp()\fR write the hexadecimal encoding of \fBa\fR,
237with a leading \*(L'\-\*(R' for negative numbers, to the \fBBIO\fR or \fBFILE\fR
238\fBfp\fR.
984263bc 239.PP
74dab6c2
JR
240\fIBN_bn2mpi()\fR and \fIBN_mpi2bn()\fR convert \fBBIGNUM\fRs from and to a format
241that consists of the number's length in bytes represented as a 4-byte
984263bc
MD
242big-endian number, and the number itself in big-endian format, where
243the most significant bit signals a negative number (the representation
74dab6c2 244of numbers with the MSB set is prefixed with null byte).
984263bc 245.PP
74dab6c2 246\fIBN_bn2mpi()\fR stores the representation of \fBa\fR at \fBto\fR, where \fBto\fR
984263bc 247must be large enough to hold the result. The size can be determined by
74dab6c2 248calling \fIBN_bn2mpi\fR\|(\fBa\fR, NULL).
984263bc 249.PP
74dab6c2
JR
250\fIBN_mpi2bn()\fR converts the \fBlen\fR bytes long representation at \fBs\fR to
251a \fBBIGNUM\fR and stores it at \fBret\fR, or in a newly allocated \fBBIGNUM\fR
252if \fBret\fR is NULL.
984263bc 253.SH "RETURN VALUES"
74dab6c2
JR
254\fIBN_bn2bin()\fR returns the length of the big-endian number placed at \fBto\fR.
255\fIBN_bin2bn()\fR returns the \fBBIGNUM\fR, NULL on error.
984263bc 256.PP
74dab6c2 257\fIBN_bn2hex()\fR and \fIBN_bn2dec()\fR return a null-terminated string, or NULL
984263bc
MD
258on error. \fIBN_hex2bn()\fR and \fIBN_dec2bn()\fR return the number's length in
259hexadecimal or decimal digits, and 0 on error.
260.PP
74dab6c2 261\fIBN_print_fp()\fR and \fIBN_print()\fR return 1 on success, 0 on write errors.
984263bc 262.PP
74dab6c2
JR
263\fIBN_bn2mpi()\fR returns the length of the representation. \fIBN_mpi2bn()\fR
264returns the \fBBIGNUM\fR, and NULL on error.
984263bc
MD
265.PP
266The error codes can be obtained by ERR_get_error(3).
267.SH "SEE ALSO"
984263bc
MD
268bn(3), ERR_get_error(3), BN_zero(3),
269ASN1_INTEGER_to_BN(3),
270BN_num_bytes(3)
271.SH "HISTORY"
74dab6c2 272\fIBN_bn2bin()\fR, \fIBN_bin2bn()\fR, \fIBN_print_fp()\fR and \fIBN_print()\fR are available
984263bc
MD
273in all versions of SSLeay and OpenSSL.
274.PP
74dab6c2
JR
275\fIBN_bn2hex()\fR, \fIBN_bn2dec()\fR, \fIBN_hex2bn()\fR, \fIBN_dec2bn()\fR, \fIBN_bn2mpi()\fR and
276\fIBN_mpi2bn()\fR were added in SSLeay 0.9.0.
277
278.rn }` ''
279.IX Title "BN_bn2bin 3"
280.IX Name "BN_bn2bin, BN_bin2bn, BN_bn2hex, BN_bn2dec, BN_hex2bn, BN_dec2bn,
281BN_print, BN_print_fp, BN_bn2mpi, BN_mpi2bn - format conversions"
282
283.IX Header "NAME"
284
285.IX Header "SYNOPSIS"
286
287.IX Header "DESCRIPTION"
288
289.IX Header "RETURN VALUES"
290
291.IX Header "SEE ALSO"
292
293.IX Header "HISTORY"
294