secure/lib/libcrypto/man/man3/BN_bn2bin.3

   1 .\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.40)
   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 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is >0, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{\
  60 .    if \nF \{\
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{\
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "BN_BN2BIN 3"
 136 .TH BN_BN2BIN 3 "2020-03-31" "1.1.1f" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 BN_bn2binpad, BN_bn2bin, BN_bin2bn, BN_bn2lebinpad, BN_lebin2bn, BN_bn2hex, BN_bn2dec, BN_hex2bn, BN_dec2bn, BN_print, BN_print_fp, BN_bn2mpi, BN_mpi2bn \- format conversions
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/bn.h>
 147 \&
 148 \& int BN_bn2bin(const BIGNUM *a, unsigned char *to);
 149 \& int BN_bn2binpad(const BIGNUM *a, unsigned char *to, int tolen);
 150 \& BIGNUM *BN_bin2bn(const unsigned char *s, int len, BIGNUM *ret);
 151 \&
 152 \& int BN_bn2lebinpad(const BIGNUM *a, unsigned char *to, int tolen);
 153 \& BIGNUM *BN_lebin2bn(const unsigned char *s, int len, BIGNUM *ret);
 154 \&
 155 \& char *BN_bn2hex(const BIGNUM *a);
 156 \& char *BN_bn2dec(const BIGNUM *a);
 157 \& int BN_hex2bn(BIGNUM **a, const char *str);
 158 \& int BN_dec2bn(BIGNUM **a, const char *str);
 159 \&
 160 \& int BN_print(BIO *fp, const BIGNUM *a);
 161 \& int BN_print_fp(FILE *fp, const BIGNUM *a);
 162 \&
 163 \& int BN_bn2mpi(const BIGNUM *a, unsigned char *to);
 164 \& BIGNUM *BN_mpi2bn(unsigned char *s, int len, BIGNUM *ret);
 165 .Ve
 166 .SH "DESCRIPTION"
 167 .IX Header "DESCRIPTION"
 168 \&\fBBN_bn2bin()\fR converts the absolute value of \fBa\fR into big-endian form
 169 and stores it at \fBto\fR. \fBto\fR must point to BN_num_bytes(\fBa\fR) bytes of
 170 memory.
 171 .PP
 172 \&\fBBN_bn2binpad()\fR also converts the absolute value of \fBa\fR into big-endian form
 173 and stores it at \fBto\fR. \fBtolen\fR indicates the length of the output buffer
 174 \&\fBto\fR. The result is padded with zeroes if necessary. If \fBtolen\fR is less than
 175 BN_num_bytes(\fBa\fR) an error is returned.
 176 .PP
 177 \&\fBBN_bin2bn()\fR converts the positive integer in big-endian form of length
 178 \&\fBlen\fR at \fBs\fR into a \fB\s-1BIGNUM\s0\fR and places it in \fBret\fR. If \fBret\fR is
 179 \&\s-1NULL,\s0 a new \fB\s-1BIGNUM\s0\fR is created.
 180 .PP
 181 \&\fBBN_bn2lebinpad()\fR and \fBBN_lebin2bn()\fR are identical to \fBBN_bn2binpad()\fR and
 182 \&\fBBN_bin2bn()\fR except the buffer is in little-endian format.
 183 .PP
 184 \&\fBBN_bn2hex()\fR and \fBBN_bn2dec()\fR return printable strings containing the
 185 hexadecimal and decimal encoding of \fBa\fR respectively. For negative
 186 numbers, the string is prefaced with a leading '\-'. The string must be
 187 freed later using \fBOPENSSL_free()\fR.
 188 .PP
 189 \&\fBBN_hex2bn()\fR takes as many characters as possible from the string \fBstr\fR,
 190 including the leading character '\-' which means negative, to form a valid
 191 hexadecimal number representation and converts them to a \fB\s-1BIGNUM\s0\fR and
 192 stores it in **\fBa\fR. If *\fBa\fR is \s-1NULL,\s0 a new \fB\s-1BIGNUM\s0\fR is created. If
 193 \&\fBa\fR is \s-1NULL,\s0 it only computes the length of valid representation.
 194 A \*(L"negative zero\*(R" is converted to zero.
 195 \&\fBBN_dec2bn()\fR is the same using the decimal system.
 196 .PP
 197 \&\fBBN_print()\fR and \fBBN_print_fp()\fR write the hexadecimal encoding of \fBa\fR,
 198 with a leading '\-' for negative numbers, to the \fB\s-1BIO\s0\fR or \fB\s-1FILE\s0\fR
 199 \&\fBfp\fR.
 200 .PP
 201 \&\fBBN_bn2mpi()\fR and \fBBN_mpi2bn()\fR convert \fB\s-1BIGNUM\s0\fRs from and to a format
 202 that consists of the number's length in bytes represented as a 4\-byte
 203 big-endian number, and the number itself in big-endian format, where
 204 the most significant bit signals a negative number (the representation
 205 of numbers with the \s-1MSB\s0 set is prefixed with null byte).
 206 .PP
 207 \&\fBBN_bn2mpi()\fR stores the representation of \fBa\fR at \fBto\fR, where \fBto\fR
 208 must be large enough to hold the result. The size can be determined by
 209 calling BN_bn2mpi(\fBa\fR, \s-1NULL\s0).
 210 .PP
 211 \&\fBBN_mpi2bn()\fR converts the \fBlen\fR bytes long representation at \fBs\fR to
 212 a \fB\s-1BIGNUM\s0\fR and stores it at \fBret\fR, or in a newly allocated \fB\s-1BIGNUM\s0\fR
 213 if \fBret\fR is \s-1NULL.\s0
 214 .SH "RETURN VALUES"
 215 .IX Header "RETURN VALUES"
 216 \&\fBBN_bn2bin()\fR returns the length of the big-endian number placed at \fBto\fR.
 217 \&\fBBN_bin2bn()\fR returns the \fB\s-1BIGNUM\s0\fR, \s-1NULL\s0 on error.
 218 .PP
 219 \&\fBBN_bn2binpad()\fR returns the number of bytes written or \-1 if the supplied
 220 buffer is too small.
 221 .PP
 222 \&\fBBN_bn2hex()\fR and \fBBN_bn2dec()\fR return a null-terminated string, or \s-1NULL\s0
 223 on error. \fBBN_hex2bn()\fR and \fBBN_dec2bn()\fR return the number of characters
 224 used in parsing, or 0 on error, in which
 225 case no new \fB\s-1BIGNUM\s0\fR will be created.
 226 .PP
 227 \&\fBBN_print_fp()\fR and \fBBN_print()\fR return 1 on success, 0 on write errors.
 228 .PP
 229 \&\fBBN_bn2mpi()\fR returns the length of the representation. \fBBN_mpi2bn()\fR
 230 returns the \fB\s-1BIGNUM\s0\fR, and \s-1NULL\s0 on error.
 231 .PP
 232 The error codes can be obtained by \fBERR_get_error\fR\|(3).
 233 .SH "SEE ALSO"
 234 .IX Header "SEE ALSO"
 235 \&\fBERR_get_error\fR\|(3), \fBBN_zero\fR\|(3),
 236 \&\fBASN1_INTEGER_to_BN\fR\|(3),
 237 \&\fBBN_num_bytes\fR\|(3)
 238 .SH "COPYRIGHT"
 239 .IX Header "COPYRIGHT"
 240 Copyright 2000\-2018 The OpenSSL Project Authors. All Rights Reserved.
 241 .PP
 242 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 243 this file except in compliance with the License.  You can obtain a copy
 244 in the file \s-1LICENSE\s0 in the source distribution or at
 245 <https://www.openssl.org/source/license.html>.