doc/man3/BN_bn2bin.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 BN_bn2binpad, BN_signed_bn2bin, BN_bn2bin, BN_bin2bn, BN_signed_bin2bn,
   6 BN_bn2lebinpad, BN_signed_bn2lebin, BN_lebin2bn, BN_signed_lebin2bn,
   7 BN_bn2nativepad, BN_signed_bn2native, BN_native2bn, BN_signed_native2bn,
   8 BN_bn2hex, BN_bn2dec, BN_hex2bn, BN_dec2bn,
   9 BN_print, BN_print_fp, BN_bn2mpi, BN_mpi2bn - format conversions
  10
  11 =head1 SYNOPSIS
  12
  13  #include <openssl/bn.h>
  14
  15  int BN_bn2bin(const BIGNUM *a, unsigned char *to);
  16  int BN_bn2binpad(const BIGNUM *a, unsigned char *to, int tolen);
  17  int BN_signed_bn2bin(const BIGNUM *a, unsigned char *to, int tolen);
  18  BIGNUM *BN_bin2bn(const unsigned char *s, int len, BIGNUM *ret);
  19  BIGNUM *BN_signed_bin2bn(const unsigned char *s, int len, BIGNUM *ret);
  20
  21  int BN_bn2lebinpad(const BIGNUM *a, unsigned char *to, int tolen);
  22  int BN_signed_bn2lebin(const BIGNUM *a, unsigned char *to, int tolen);
  23  BIGNUM *BN_lebin2bn(const unsigned char *s, int len, BIGNUM *ret);
  24  BIGNUM *BN_signed_lebin2bn(const unsigned char *s, int len, BIGNUM *ret);
  25
  26  int BN_bn2nativepad(const BIGNUM *a, unsigned char *to, int tolen);
  27  int BN_signed_bn2native(const BIGNUM *a, unsigned char *to, int tolen);
  28  BIGNUM *BN_native2bn(const unsigned char *s, int len, BIGNUM *ret);
  29  BIGNUM *BN_signed_native2bn(const unsigned char *s, int len, BIGNUM *ret);
  30
  31  char *BN_bn2hex(const BIGNUM *a);
  32  char *BN_bn2dec(const BIGNUM *a);
  33  int BN_hex2bn(BIGNUM **a, const char *str);
  34  int BN_dec2bn(BIGNUM **a, const char *str);
  35
  36  int BN_print(BIO *fp, const BIGNUM *a);
  37  int BN_print_fp(FILE *fp, const BIGNUM *a);
  38
  39  int BN_bn2mpi(const BIGNUM *a, unsigned char *to);
  40  BIGNUM *BN_mpi2bn(unsigned char *s, int len, BIGNUM *ret);
  41
  42 =head1 DESCRIPTION
  43
  44 BN_bn2bin() converts the absolute value of B<a> into big-endian form
  45 and stores it at B<to>. B<to> must point to BN_num_bytes(B<a>) bytes of
  46 memory.
  47
  48 BN_bn2binpad() also converts the absolute value of B<a> into big-endian form
  49 and stores it at B<to>. B<tolen> indicates the length of the output buffer
  50 B<to>. The result is padded with zeros if necessary. If B<tolen> is less than
  51 BN_num_bytes(B<a>) an error is returned.
  52
  53 BN_signed_bn2bin() converts the value of B<a> into big-endian signed 2's
  54 complements form and stores it at B<to>. B<tolen> indicates the length of
  55 the output buffer B<to>. The result is signed extended (padded with 0x00
  56 for positive numbers or with 0xff for negative numbers) if necessary.
  57 If B<tolen> is smaller than the necessary size (which may be
  58 C<<BN_num_bytes(B<a>) + 1>>), an error is returned.
  59
  60 BN_bin2bn() converts the positive integer in big-endian form of length
  61 B<len> at B<s> into a B<BIGNUM> and places it in B<ret>. If B<ret> is
  62 NULL, a new B<BIGNUM> is created.
  63
  64 BN_signed_bin2bn() converts the integer in big-endian signed 2's complement
  65 form of length B<len> at B<s> into a B<BIGNUM> and places it in B<ret>. If
  66 B<ret> is NULL, a new B<BIGNUM> is created.
  67
  68 BN_bn2lebinpad(), BN_signed_bn2lebin() and BN_lebin2bn() are identical to
  69 BN_bn2binpad(), BN_signed_bn2bin() and BN_bin2bn() except the buffer is in
  70 little-endian format.
  71
  72 BN_bn2nativepad(), BN_signed_bn2native() and BN_native2bn() are identical
  73 to BN_bn2binpad(), BN_signed_bn2bin() and BN_bin2bn() except the buffer is
  74 in native format, i.e. most significant byte first on big-endian platforms,
  75 and least significant byte first on little-endian platforms.
  76
  77 BN_bn2hex() and BN_bn2dec() return printable strings containing the
  78 hexadecimal and decimal encoding of B<a> respectively. For negative
  79 numbers, the string is prefaced with a leading '-'. The string must be
  80 freed later using OPENSSL_free().
  81
  82 BN_hex2bn() takes as many characters as possible from the string B<str>,
  83 including the leading character '-' which means negative, to form a valid
  84 hexadecimal number representation and converts them to a B<BIGNUM> and
  85 stores it in **B<a>. If *B<a> is NULL, a new B<BIGNUM> is created. If
  86 B<a> is NULL, it only computes the length of valid representation.
  87 A "negative zero" is converted to zero.
  88 BN_dec2bn() is the same using the decimal system.
  89
  90 BN_print() and BN_print_fp() write the hexadecimal encoding of B<a>,
  91 with a leading '-' for negative numbers, to the B<BIO> or B<FILE>
  92 B<fp>.
  93
  94 BN_bn2mpi() and BN_mpi2bn() convert B<BIGNUM>s from and to a format
  95 that consists of the number's length in bytes represented as a 4-byte
  96 big-endian number, and the number itself in big-endian format, where
  97 the most significant bit signals a negative number (the representation
  98 of numbers with the MSB set is prefixed with null byte).
  99
 100 BN_bn2mpi() stores the representation of B<a> at B<to>, where B<to>
 101 must be large enough to hold the result. The size can be determined by
 102 calling BN_bn2mpi(B<a>, NULL).
 103
 104 BN_mpi2bn() converts the B<len> bytes long representation at B<s> to
 105 a B<BIGNUM> and stores it at B<ret>, or in a newly allocated B<BIGNUM>
 106 if B<ret> is NULL.
 107
 108 =head1 RETURN VALUES
 109
 110 BN_bn2bin() returns the length of the big-endian number placed at B<to>.
 111 BN_bin2bn() returns the B<BIGNUM>, NULL on error.
 112
 113 BN_bn2binpad(), BN_signed_bn2bin(), BN_bn2lebinpad(), BN_signed_bn2lebin(),
 114 BN_bn2nativepad(), and_signed BN_bn2native() return the number of bytes
 115 written or -1 if the supplied buffer is too small.
 116
 117 BN_bn2hex() and BN_bn2dec() return a NUL-terminated string, or NULL
 118 on error. BN_hex2bn() and BN_dec2bn() return the number of characters
 119 used in parsing, or 0 on error, in which
 120 case no new B<BIGNUM> will be created.
 121
 122 BN_print_fp() and BN_print() return 1 on success, 0 on write errors.
 123
 124 BN_bn2mpi() returns the length of the representation. BN_mpi2bn()
 125 returns the B<BIGNUM>, and NULL on error.
 126
 127 The error codes can be obtained by L<ERR_get_error(3)>.
 128
 129 =head1 SEE ALSO
 130
 131 L<ERR_get_error(3)>, L<BN_zero(3)>,
 132 L<ASN1_INTEGER_to_BN(3)>,
 133 L<BN_num_bytes(3)>
 134
 135 =head1 COPYRIGHT
 136
 137 Copyright 2000-2022 The OpenSSL Project Authors. All Rights Reserved.
 138
 139 Licensed under the Apache License 2.0 (the "License").  You may not use
 140 this file except in compliance with the License.  You can obtain a copy
 141 in the file LICENSE in the source distribution or at
 142 L<https://www.openssl.org/source/license.html>.
 143
 144 =cut