secure/lib/libcrypto/man/BN_bn2bin.3

   1 .\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 'br\}
  42 .\"
  43 .\" Escape single quotes in literal strings from groff's Unicode transform.
  44 .ie \n(.g .ds Aq \(aq
  45 .el       .ds Aq '
  46 .\"
  47 .\" If the F register is turned on, we'll generate index entries on stderr for
  48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  50 .\" output yourself in some meaningful fashion.
  51 .ie \nF \{\
  52 .    de IX
  53 .    tm Index:\\$1\t\\n%\t"\\$2"
  54 ..
  55 .    nr % 0
  56 .    rr F
  57 .\}
  58 .el \{\
  59 .    de IX
  60 ..
  61 .\}
  62 .\"
  63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  65 .    \" fudge factors for nroff and troff
  66 .if n \{\
  67 .    ds #H 0
  68 .    ds #V .8m
  69 .    ds #F .3m
  70 .    ds #[ \f1
  71 .    ds #] \fP
  72 .\}
  73 .if t \{\
  74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  75 .    ds #V .6m
  76 .    ds #F 0
  77 .    ds #[ \&
  78 .    ds #] \&
  79 .\}
  80 .    \" simple accents for nroff and troff
  81 .if n \{\
  82 .    ds ' \&
  83 .    ds ` \&
  84 .    ds ^ \&
  85 .    ds , \&
  86 .    ds ~ ~
  87 .    ds /
  88 .\}
  89 .if t \{\
  90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
  95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
  96 .\}
  97 .    \" troff and (daisy-wheel) nroff accents
  98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
  99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 105 .ds ae a\h'-(\w'a'u*4/10)'e
 106 .ds Ae A\h'-(\w'A'u*4/10)'E
 107 .    \" corrections for vroff
 108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 110 .    \" for low resolution devices (crt and lpr)
 111 .if \n(.H>23 .if \n(.V>19 \
 112 \{\
 113 .    ds : e
 114 .    ds 8 ss
 115 .    ds o a
 116 .    ds d- d\h'-1'\(ga
 117 .    ds D- D\h'-1'\(hy
 118 .    ds th \o'bp'
 119 .    ds Th \o'LP'
 120 .    ds ae ae
 121 .    ds Ae AE
 122 .\}
 123 .rm #[ #] #H #V #F C
 124 .\" ========================================================================
 125 .\"
 126 .IX Title "BN_bn2bin 3"
 127 .TH BN_bn2bin 3 "2011-02-08" "1.0.0d" "OpenSSL"
 128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 129 .\" way too many mistakes in technical documents.
 130 .if n .ad l
 131 .nh
 132 .SH "NAME"
 133 BN_bn2bin, BN_bin2bn, BN_bn2hex, BN_bn2dec, BN_hex2bn, BN_dec2bn,
 134 BN_print, BN_print_fp, BN_bn2mpi, BN_mpi2bn \- format conversions
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 .Vb 1
 138 \& #include <openssl/bn.h>
 139 \&
 140 \& int BN_bn2bin(const BIGNUM *a, unsigned char *to);
 141 \& BIGNUM *BN_bin2bn(const unsigned char *s, int len, BIGNUM *ret);
 142 \&
 143 \& char *BN_bn2hex(const BIGNUM *a);
 144 \& char *BN_bn2dec(const BIGNUM *a);
 145 \& int BN_hex2bn(BIGNUM **a, const char *str);
 146 \& int BN_dec2bn(BIGNUM **a, const char *str);
 147 \&
 148 \& int BN_print(BIO *fp, const BIGNUM *a);
 149 \& int BN_print_fp(FILE *fp, const BIGNUM *a);
 150 \&
 151 \& int BN_bn2mpi(const BIGNUM *a, unsigned char *to);
 152 \& BIGNUM *BN_mpi2bn(unsigned char *s, int len, BIGNUM *ret);
 153 .Ve
 154 .SH "DESCRIPTION"
 155 .IX Header "DESCRIPTION"
 156 \&\fIBN_bn2bin()\fR converts the absolute value of \fBa\fR into big-endian form
 157 and stores it at \fBto\fR. \fBto\fR must point to BN_num_bytes(\fBa\fR) bytes of
 158 memory.
 159 .PP
 160 \&\fIBN_bin2bn()\fR converts the positive integer in big-endian form of length
 161 \&\fBlen\fR at \fBs\fR into a \fB\s-1BIGNUM\s0\fR and places it in \fBret\fR. If \fBret\fR is
 162 \&\s-1NULL\s0, a new \fB\s-1BIGNUM\s0\fR is created.
 163 .PP
 164 \&\fIBN_bn2hex()\fR and \fIBN_bn2dec()\fR return printable strings containing the
 165 hexadecimal and decimal encoding of \fBa\fR respectively. For negative
 166 numbers, the string is prefaced with a leading '\-'. The string must be
 167 freed later using \fIOPENSSL_free()\fR.
 168 .PP
 169 \&\fIBN_hex2bn()\fR converts the string \fBstr\fR containing a hexadecimal number
 170 to a \fB\s-1BIGNUM\s0\fR and stores it in **\fBbn\fR. If *\fBbn\fR is \s-1NULL\s0, a new
 171 \&\fB\s-1BIGNUM\s0\fR is created. If \fBbn\fR is \s-1NULL\s0, it only computes the number's
 172 length in hexadecimal digits. If the string starts with '\-', the
 173 number is negative. \fIBN_dec2bn()\fR is the same using the decimal system.
 174 .PP
 175 \&\fIBN_print()\fR and \fIBN_print_fp()\fR write the hexadecimal encoding of \fBa\fR,
 176 with a leading '\-' for negative numbers, to the \fB\s-1BIO\s0\fR or \fB\s-1FILE\s0\fR
 177 \&\fBfp\fR.
 178 .PP
 179 \&\fIBN_bn2mpi()\fR and \fIBN_mpi2bn()\fR convert \fB\s-1BIGNUM\s0\fRs from and to a format
 180 that consists of the number's length in bytes represented as a 4\-byte
 181 big-endian number, and the number itself in big-endian format, where
 182 the most significant bit signals a negative number (the representation
 183 of numbers with the \s-1MSB\s0 set is prefixed with null byte).
 184 .PP
 185 \&\fIBN_bn2mpi()\fR stores the representation of \fBa\fR at \fBto\fR, where \fBto\fR
 186 must be large enough to hold the result. The size can be determined by
 187 calling BN_bn2mpi(\fBa\fR, \s-1NULL\s0).
 188 .PP
 189 \&\fIBN_mpi2bn()\fR converts the \fBlen\fR bytes long representation at \fBs\fR to
 190 a \fB\s-1BIGNUM\s0\fR and stores it at \fBret\fR, or in a newly allocated \fB\s-1BIGNUM\s0\fR
 191 if \fBret\fR is \s-1NULL\s0.
 192 .SH "RETURN VALUES"
 193 .IX Header "RETURN VALUES"
 194 \&\fIBN_bn2bin()\fR returns the length of the big-endian number placed at \fBto\fR.
 195 \&\fIBN_bin2bn()\fR returns the \fB\s-1BIGNUM\s0\fR, \s-1NULL\s0 on error.
 196 .PP
 197 \&\fIBN_bn2hex()\fR and \fIBN_bn2dec()\fR return a null-terminated string, or \s-1NULL\s0
 198 on error. \fIBN_hex2bn()\fR and \fIBN_dec2bn()\fR return the number's length in
 199 hexadecimal or decimal digits, and 0 on error.
 200 .PP
 201 \&\fIBN_print_fp()\fR and \fIBN_print()\fR return 1 on success, 0 on write errors.
 202 .PP
 203 \&\fIBN_bn2mpi()\fR returns the length of the representation. \fIBN_mpi2bn()\fR
 204 returns the \fB\s-1BIGNUM\s0\fR, and \s-1NULL\s0 on error.
 205 .PP
 206 The error codes can be obtained by \fIERR_get_error\fR\|(3).
 207 .SH "SEE ALSO"
 208 .IX Header "SEE ALSO"
 209 \&\fIbn\fR\|(3), \fIERR_get_error\fR\|(3), \fIBN_zero\fR\|(3),
 210 \&\fIASN1_INTEGER_to_BN\fR\|(3),
 211 \&\fIBN_num_bytes\fR\|(3)
 212 .SH "HISTORY"
 213 .IX Header "HISTORY"
 214 \&\fIBN_bn2bin()\fR, \fIBN_bin2bn()\fR, \fIBN_print_fp()\fR and \fIBN_print()\fR are available
 215 in all versions of SSLeay and OpenSSL.
 216 .PP
 217 \&\fIBN_bn2hex()\fR, \fIBN_bn2dec()\fR, \fIBN_hex2bn()\fR, \fIBN_dec2bn()\fR, \fIBN_bn2mpi()\fR and
 218 \&\fIBN_mpi2bn()\fR were added in SSLeay 0.9.0.