doc/man3/OPENSSL_hexchar2int.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 OPENSSL_hexchar2int,
   6 OPENSSL_hexstr2buf_ex, OPENSSL_hexstr2buf,
   7 OPENSSL_buf2hexstr_ex, OPENSSL_buf2hexstr
   8 - Hex encoding and decoding functions
   9
  10 =head1 SYNOPSIS
  11
  12  #include <openssl/crypto.h>
  13
  14  int OPENSSL_hexchar2int(unsigned char c);
  15  int OPENSSL_hexstr2buf_ex(unsigned char *buf, size_t buf_n, long *buflen,
  16                            const char *str, const char sep);
  17  unsigned char *OPENSSL_hexstr2buf(const char *str, long *len);
  18  int OPENSSL_buf2hexstr_ex(char *str, size_t str_n, size_t *strlen,
  19                            const unsigned char *buf, long buflen, const char sep);
  20  char *OPENSSL_buf2hexstr(const unsigned char *buf, long buflen);
  21
  22 =head1 DESCRIPTION
  23
  24 OPENSSL_hexchar2int() converts a hexadecimal character to its numeric
  25 equivalent.
  26
  27 OPENSSL_hexstr2buf_ex() decodes the hex string B<str> and places the
  28 resulting string of bytes in the given I<buf>.
  29 The character I<sep> is the separator between the bytes, setting this to '\0'
  30 means that there is no separator.
  31 I<buf_n> gives the size of the buffer.
  32 If I<buflen> is not NULL, it is filled in with the result length.
  33 To find out how large the result will be, call this function with NULL
  34 for I<buf>.
  35 Colons between two-character hex "bytes" are accepted and ignored.
  36 An odd number of hex digits is an error.
  37
  38 OPENSSL_hexstr2buf() does the same thing as OPENSSL_hexstr2buf_ex(),
  39 but allocates the space for the result, and returns the result. It uses a
  40 default separator of ':'.
  41 The memory is allocated by calling OPENSSL_malloc() and should be
  42 released by calling OPENSSL_free().
  43
  44 OPENSSL_buf2hexstr_ex() encodes the contents of the given I<buf> with
  45 length I<buflen> and places the resulting hexadecimal character string
  46 in the given I<str>.
  47 The character I<sep> is the separator between the bytes, setting this to '\0'
  48 means that there is no separator.
  49 I<str_n> gives the size of the of the string buffer.
  50 If I<strlen> is not NULL, it is filled in with the result length.
  51 To find out how large the result will be, call this function with NULL
  52 for I<str>.
  53
  54 OPENSSL_buf2hexstr() does the same thing as OPENSSL_buf2hexstr_ex(),
  55 but allocates the space for the result, and returns the result. It uses a
  56 default separator of ':'.
  57 The memory is allocated by calling OPENSSL_malloc() and should be
  58 released by calling OPENSSL_free().
  59
  60 =head1 RETURN VALUES
  61
  62 OPENSSL_hexchar2int returns the value of a decoded hex character,
  63 or -1 on error.
  64
  65 OPENSSL_buf2hexstr() and OPENSSL_hexstr2buf()
  66 return a pointer to allocated memory, or NULL on error.
  67
  68 OPENSSL_buf2hexstr_ex() and OPENSSL_hexstr2buf_ex() return 1 on
  69 success, or 0 on error.
  70
  71 =head1 COPYRIGHT
  72
  73 Copyright 2016-2019 The OpenSSL Project Authors. All Rights Reserved.
  74
  75 Licensed under the Apache License 2.0 (the "License").  You may not use
  76 this file except in compliance with the License.  You can obtain a copy
  77 in the file LICENSE in the source distribution or at
  78 L<https://www.openssl.org/source/license.html>.
  79
  80 =cut