2
0

BIO_ADDRINFO.pod 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114
  1. =pod
  2. =head1 NAME
  3. BIO_lookup_type,
  4. BIO_ADDRINFO, BIO_ADDRINFO_next, BIO_ADDRINFO_free,
  5. BIO_ADDRINFO_family, BIO_ADDRINFO_socktype, BIO_ADDRINFO_protocol,
  6. BIO_ADDRINFO_address,
  7. BIO_lookup_ex,
  8. BIO_lookup
  9. - BIO_ADDRINFO type and routines
  10. =head1 SYNOPSIS
  11. #include <sys/types.h>
  12. #include <openssl/bio.h>
  13. typedef union bio_addrinfo_st BIO_ADDRINFO;
  14. enum BIO_lookup_type {
  15. BIO_LOOKUP_CLIENT, BIO_LOOKUP_SERVER
  16. };
  17. int BIO_lookup_ex(const char *host, const char *service, int lookup_type,
  18. int family, int socktype, int protocol, BIO_ADDRINFO **res);
  19. int BIO_lookup(const char *node, const char *service,
  20. enum BIO_lookup_type lookup_type,
  21. int family, int socktype, BIO_ADDRINFO **res);
  22. const BIO_ADDRINFO *BIO_ADDRINFO_next(const BIO_ADDRINFO *bai);
  23. int BIO_ADDRINFO_family(const BIO_ADDRINFO *bai);
  24. int BIO_ADDRINFO_socktype(const BIO_ADDRINFO *bai);
  25. int BIO_ADDRINFO_protocol(const BIO_ADDRINFO *bai);
  26. const BIO_ADDR *BIO_ADDRINFO_address(const BIO_ADDRINFO *bai);
  27. void BIO_ADDRINFO_free(BIO_ADDRINFO *bai);
  28. =head1 DESCRIPTION
  29. The B<BIO_ADDRINFO> type is a wrapper for address information
  30. types provided on your platform.
  31. B<BIO_ADDRINFO> normally forms a chain of several that can be
  32. picked at one by one.
  33. BIO_lookup_ex() looks up a specified B<host> and B<service>, and
  34. uses B<lookup_type> to determine what the default address should
  35. be if B<host> is B<NULL>. B<family>, B<socktype> and B<protocol> are used to
  36. determine what protocol family, socket type and protocol should be used for
  37. the lookup. B<family> can be any of AF_INET, AF_INET6, AF_UNIX and
  38. AF_UNSPEC. B<socktype> can be SOCK_STREAM, SOCK_DGRAM or 0. Specifying 0
  39. indicates that any type can be used. B<protocol> specifies a protocol such as
  40. IPPROTO_TCP, IPPROTO_UDP or IPPORTO_SCTP. If set to 0 than any protocol can be
  41. used. B<res> points at a pointer to hold the start of a B<BIO_ADDRINFO>
  42. chain.
  43. For the family B<AF_UNIX>, BIO_lookup_ex() will ignore the B<service>
  44. parameter and expects the B<node> parameter to hold the path to the
  45. socket file.
  46. BIO_lookup() does the same as BIO_lookup_ex() but does not provide the ability
  47. to select based on the protocol (any protocol may be returned).
  48. BIO_ADDRINFO_family() returns the family of the given
  49. B<BIO_ADDRINFO>. The result will be one of the constants
  50. AF_INET, AF_INET6 and AF_UNIX.
  51. BIO_ADDRINFO_socktype() returns the socket type of the given
  52. B<BIO_ADDRINFO>. The result will be one of the constants
  53. SOCK_STREAM and SOCK_DGRAM.
  54. BIO_ADDRINFO_protocol() returns the protocol id of the given
  55. B<BIO_ADDRINFO>. The result will be one of the constants
  56. IPPROTO_TCP and IPPROTO_UDP.
  57. BIO_ADDRINFO_address() returns the underlying B<BIO_ADDR>
  58. of the given B<BIO_ADDRINFO>.
  59. BIO_ADDRINFO_next() returns the next B<BIO_ADDRINFO> in the chain
  60. from the given one.
  61. BIO_ADDRINFO_free() frees the chain of B<BIO_ADDRINFO> starting
  62. with the given one.
  63. =head1 RETURN VALUES
  64. BIO_lookup_ex() and BIO_lookup() return 1 on success and 0 when an error
  65. occurred, and will leave an error indication on the OpenSSL error stack in that
  66. case.
  67. All other functions described here return 0 or B<NULL> when the
  68. information they should return isn't available.
  69. =head1 NOTES
  70. The BIO_lookup_ex() implementation uses the platform provided getaddrinfo()
  71. function. On Linux it is known that specifying 0 for the protocol will not
  72. return any SCTP based addresses when calling getaddrinfo(). Therefore if an SCTP
  73. address is required then the B<protocol> parameter to BIO_lookup_ex() should be
  74. explicitly set to IPPROTO_SCTP. The same may be true on other platforms.
  75. =head1 HISTORY
  76. The BIO_lookup_ex() function was added in OpenSSL 1.1.1.
  77. =head1 COPYRIGHT
  78. Copyright 2016-2017 The OpenSSL Project Authors. All Rights Reserved.
  79. Licensed under the OpenSSL license (the "License"). You may not use
  80. this file except in compliance with the License. You can obtain a copy
  81. in the file LICENSE in the source distribution or at
  82. L<https://www.openssl.org/source/license.html>.
  83. =cut