BIO_ADDR.pod 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125
  1. =pod
  2. =head1 NAME
  3. BIO_ADDR, BIO_ADDR_new, BIO_ADDR_clear, BIO_ADDR_free, BIO_ADDR_rawmake,
  4. BIO_ADDR_family, BIO_ADDR_rawaddress, BIO_ADDR_rawport,
  5. BIO_ADDR_hostname_string, BIO_ADDR_service_string,
  6. BIO_ADDR_path_string - BIO_ADDR routines
  7. =head1 SYNOPSIS
  8. #include <sys/types.h>
  9. #include <openssl/bio.h>
  10. typedef union bio_addr_st BIO_ADDR;
  11. BIO_ADDR *BIO_ADDR_new(void);
  12. void BIO_ADDR_free(BIO_ADDR *);
  13. void BIO_ADDR_clear(BIO_ADDR *ap);
  14. int BIO_ADDR_rawmake(BIO_ADDR *ap, int family,
  15. const void *where, size_t wherelen, unsigned short port);
  16. int BIO_ADDR_family(const BIO_ADDR *ap);
  17. int BIO_ADDR_rawaddress(const BIO_ADDR *ap, void *p, size_t *l);
  18. unsigned short BIO_ADDR_rawport(const BIO_ADDR *ap);
  19. char *BIO_ADDR_hostname_string(const BIO_ADDR *ap, int numeric);
  20. char *BIO_ADDR_service_string(const BIO_ADDR *ap, int numeric);
  21. char *BIO_ADDR_path_string(const BIO_ADDR *ap);
  22. =head1 DESCRIPTION
  23. The B<BIO_ADDR> type is a wrapper around all types of socket
  24. addresses that OpenSSL deals with, currently transparently
  25. supporting AF_INET, AF_INET6 and AF_UNIX according to what's
  26. available on the platform at hand.
  27. BIO_ADDR_new() creates a new unfilled B<BIO_ADDR>, to be used
  28. with routines that will fill it with information, such as
  29. BIO_accept_ex().
  30. BIO_ADDR_free() frees a B<BIO_ADDR> created with BIO_ADDR_new().
  31. BIO_ADDR_clear() clears any data held within the provided B<BIO_ADDR> and sets
  32. it back to an uninitialised state.
  33. BIO_ADDR_rawmake() takes a protocol B<family>, an byte array of
  34. size B<wherelen> with an address in network byte order pointed at
  35. by B<where> and a port number in network byte order in B<port> (except
  36. for the B<AF_UNIX> protocol family, where B<port> is meaningless and
  37. therefore ignored) and populates the given B<BIO_ADDR> with them.
  38. In case this creates a B<AF_UNIX> B<BIO_ADDR>, B<wherelen> is expected
  39. to be the length of the path string (not including the terminating
  40. NUL, such as the result of a call to strlen()).
  41. Read on about the addresses in L</RAW ADDRESSES> below.
  42. BIO_ADDR_family() returns the protocol family of the given
  43. B<BIO_ADDR>. The possible non-error results are one of the
  44. constants AF_INET, AF_INET6 and AF_UNIX. It will also return AF_UNSPEC if the
  45. BIO_ADDR has not been initialised.
  46. BIO_ADDR_rawaddress() will write the raw address of the given
  47. B<BIO_ADDR> in the area pointed at by B<p> if B<p> is non-NULL,
  48. and will set B<*l> to be the amount of bytes the raw address
  49. takes up if B<l> is non-NULL.
  50. A technique to only find out the size of the address is a call
  51. with B<p> set to B<NULL>. The raw address will be in network byte
  52. order, most significant byte first.
  53. In case this is a B<AF_UNIX> B<BIO_ADDR>, B<l> gets the length of the
  54. path string (not including the terminating NUL, such as the result of
  55. a call to strlen()).
  56. Read on about the addresses in L</RAW ADDRESSES> below.
  57. BIO_ADDR_rawport() returns the raw port of the given B<BIO_ADDR>.
  58. The raw port will be in network byte order.
  59. BIO_ADDR_hostname_string() returns a character string with the
  60. hostname of the given B<BIO_ADDR>. If B<numeric> is 1, the string
  61. will contain the numerical form of the address. This only works for
  62. B<BIO_ADDR> of the protocol families AF_INET and AF_INET6. The
  63. returned string has been allocated on the heap and must be freed
  64. with OPENSSL_free().
  65. BIO_ADDR_service_string() returns a character string with the
  66. service name of the port of the given B<BIO_ADDR>. If B<numeric>
  67. is 1, the string will contain the port number. This only works
  68. for B<BIO_ADDR> of the protocol families AF_INET and AF_INET6. The
  69. returned string has been allocated on the heap and must be freed
  70. with OPENSSL_free().
  71. BIO_ADDR_path_string() returns a character string with the path
  72. of the given B<BIO_ADDR>. This only works for B<BIO_ADDR> of the
  73. protocol family AF_UNIX. The returned string has been allocated
  74. on the heap and must be freed with OPENSSL_free().
  75. =head1 RAW ADDRESSES
  76. Both BIO_ADDR_rawmake() and BIO_ADDR_rawaddress() take a pointer to a
  77. network byte order address of a specific site. Internally, those are
  78. treated as a pointer to B<struct in_addr> (for B<AF_INET>), B<struct
  79. in6_addr> (for B<AF_INET6>) or B<char *> (for B<AF_UNIX>), all
  80. depending on the protocol family the address is for.
  81. =head1 RETURN VALUES
  82. The string producing functions BIO_ADDR_hostname_string(),
  83. BIO_ADDR_service_string() and BIO_ADDR_path_string() will
  84. return B<NULL> on error and leave an error indication on the
  85. OpenSSL error stack.
  86. All other functions described here return 0 or B<NULL> when the
  87. information they should return isn't available.
  88. =head1 SEE ALSO
  89. L<BIO_connect(3)>, L<BIO_s_connect(3)>
  90. =head1 COPYRIGHT
  91. Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
  92. Licensed under the Apache License 2.0 (the "License"). You may not use
  93. this file except in compliance with the License. You can obtain a copy
  94. in the file LICENSE in the source distribution or at
  95. L<https://www.openssl.org/source/license.html>.
  96. =cut