1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
9 .de Vb \" Begin verbatim text
14 .de Ve \" End verbatim text
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<>.
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
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
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
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.
54 .\" Avoid warning from groff about undefined register 'F'.
58 .if \n(.g .if rF .nr rF 1
59 .if (\n(rF:(\n(.g==0)) \{\
62 . tm Index:\\$1\t\\n%\t"\\$2"
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
83 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
89 . \" simple accents for nroff and troff
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'
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 \
133 .\" ========================================================================
135 .IX Title "BIO_ADDRINFO 3"
136 .TH BIO_ADDRINFO 3 "2020-09-22" "1.1.1h" "OpenSSL"
137 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
138 .\" way too many mistakes in technical documents.
142 BIO_lookup_type, BIO_ADDRINFO, BIO_ADDRINFO_next, BIO_ADDRINFO_free, BIO_ADDRINFO_family, BIO_ADDRINFO_socktype, BIO_ADDRINFO_protocol, BIO_ADDRINFO_address, BIO_lookup_ex, BIO_lookup \&\- BIO_ADDRINFO type and routines
144 .IX Header "SYNOPSIS"
146 \& #include <sys/types.h>
147 \& #include <openssl/bio.h>
149 \& typedef union bio_addrinfo_st BIO_ADDRINFO;
151 \& enum BIO_lookup_type {
152 \& BIO_LOOKUP_CLIENT, BIO_LOOKUP_SERVER
155 \& int BIO_lookup_ex(const char *host, const char *service, int lookup_type,
156 \& int family, int socktype, int protocol, BIO_ADDRINFO **res);
157 \& int BIO_lookup(const char *node, const char *service,
158 \& enum BIO_lookup_type lookup_type,
159 \& int family, int socktype, BIO_ADDRINFO **res);
161 \& const BIO_ADDRINFO *BIO_ADDRINFO_next(const BIO_ADDRINFO *bai);
162 \& int BIO_ADDRINFO_family(const BIO_ADDRINFO *bai);
163 \& int BIO_ADDRINFO_socktype(const BIO_ADDRINFO *bai);
164 \& int BIO_ADDRINFO_protocol(const BIO_ADDRINFO *bai);
165 \& const BIO_ADDR *BIO_ADDRINFO_address(const BIO_ADDRINFO *bai);
166 \& void BIO_ADDRINFO_free(BIO_ADDRINFO *bai);
169 .IX Header "DESCRIPTION"
170 The \fB\s-1BIO_ADDRINFO\s0\fR type is a wrapper for address information
171 types provided on your platform.
173 \&\fB\s-1BIO_ADDRINFO\s0\fR normally forms a chain of several that can be
174 picked at one by one.
176 \&\fBBIO_lookup_ex()\fR looks up a specified \fBhost\fR and \fBservice\fR, and
177 uses \fBlookup_type\fR to determine what the default address should
178 be if \fBhost\fR is \fB\s-1NULL\s0\fR. \fBfamily\fR, \fBsocktype\fR and \fBprotocol\fR are used to
179 determine what protocol family, socket type and protocol should be used for
180 the lookup. \fBfamily\fR can be any of \s-1AF_INET, AF_INET6, AF_UNIX\s0 and
181 \&\s-1AF_UNSPEC.\s0 \fBsocktype\fR can be \s-1SOCK_STREAM, SOCK_DGRAM\s0 or 0. Specifying 0
182 indicates that any type can be used. \fBprotocol\fR specifies a protocol such as
183 \&\s-1IPPROTO_TCP, IPPROTO_UDP\s0 or \s-1IPPORTO_SCTP.\s0 If set to 0 than any protocol can be
184 used. \fBres\fR points at a pointer to hold the start of a \fB\s-1BIO_ADDRINFO\s0\fR
187 For the family \fB\s-1AF_UNIX\s0\fR, \fBBIO_lookup_ex()\fR will ignore the \fBservice\fR
188 parameter and expects the \fBnode\fR parameter to hold the path to the
191 \&\fBBIO_lookup()\fR does the same as \fBBIO_lookup_ex()\fR but does not provide the ability
192 to select based on the protocol (any protocol may be returned).
194 \&\fBBIO_ADDRINFO_family()\fR returns the family of the given
195 \&\fB\s-1BIO_ADDRINFO\s0\fR. The result will be one of the constants
196 \&\s-1AF_INET, AF_INET6\s0 and \s-1AF_UNIX.\s0
198 \&\fBBIO_ADDRINFO_socktype()\fR returns the socket type of the given
199 \&\fB\s-1BIO_ADDRINFO\s0\fR. The result will be one of the constants
200 \&\s-1SOCK_STREAM\s0 and \s-1SOCK_DGRAM.\s0
202 \&\fBBIO_ADDRINFO_protocol()\fR returns the protocol id of the given
203 \&\fB\s-1BIO_ADDRINFO\s0\fR. The result will be one of the constants
204 \&\s-1IPPROTO_TCP\s0 and \s-1IPPROTO_UDP.\s0
206 \&\fBBIO_ADDRINFO_address()\fR returns the underlying \fB\s-1BIO_ADDR\s0\fR
207 of the given \fB\s-1BIO_ADDRINFO\s0\fR.
209 \&\fBBIO_ADDRINFO_next()\fR returns the next \fB\s-1BIO_ADDRINFO\s0\fR in the chain
212 \&\fBBIO_ADDRINFO_free()\fR frees the chain of \fB\s-1BIO_ADDRINFO\s0\fR starting
215 .IX Header "RETURN VALUES"
216 \&\fBBIO_lookup_ex()\fR and \fBBIO_lookup()\fR return 1 on success and 0 when an error
217 occurred, and will leave an error indication on the OpenSSL error stack in that
220 All other functions described here return 0 or \fB\s-1NULL\s0\fR when the
221 information they should return isn't available.
224 The \fBBIO_lookup_ex()\fR implementation uses the platform provided \fBgetaddrinfo()\fR
225 function. On Linux it is known that specifying 0 for the protocol will not
226 return any \s-1SCTP\s0 based addresses when calling \fBgetaddrinfo()\fR. Therefore, if an \s-1SCTP\s0
227 address is required then the \fBprotocol\fR parameter to \fBBIO_lookup_ex()\fR should be
228 explicitly set to \s-1IPPROTO_SCTP.\s0 The same may be true on other platforms.
231 The \fBBIO_lookup_ex()\fR function was added in OpenSSL 1.1.1.
233 .IX Header "COPYRIGHT"
234 Copyright 2016\-2020 The OpenSSL Project Authors. All Rights Reserved.
236 Licensed under the OpenSSL license (the \*(L"License\*(R"). You may not use
237 this file except in compliance with the License. You can obtain a copy
238 in the file \s-1LICENSE\s0 in the source distribution or at
239 <https://www.openssl.org/source/license.html>.