secure/lib/libcrypto/man/BIO_s_accept.3

   1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  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<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  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
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  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.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "BIO_S_ACCEPT 3"
 132 .TH BIO_S_ACCEPT 3 "2018-11-20" "1.1.1a" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 BIO_s_accept, BIO_set_accept_name, BIO_set_accept_port, BIO_get_accept_name, BIO_get_accept_port, BIO_new_accept, BIO_set_nbio_accept, BIO_set_accept_bios, BIO_get_peer_name, BIO_get_peer_port, BIO_get_accept_ip_family, BIO_set_accept_ip_family, BIO_set_bind_mode, BIO_get_bind_mode, BIO_do_accept \- accept BIO
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/bio.h>
 143 \&
 144 \& const BIO_METHOD *BIO_s_accept(void);
 145 \&
 146 \& long BIO_set_accept_name(BIO *b, char *name);
 147 \& char *BIO_get_accept_name(BIO *b);
 148 \&
 149 \& long BIO_set_accept_port(BIO *b, char *port);
 150 \& char *BIO_get_accept_port(BIO *b);
 151 \&
 152 \& BIO *BIO_new_accept(char *host_port);
 153 \&
 154 \& long BIO_set_nbio_accept(BIO *b, int n);
 155 \& long BIO_set_accept_bios(BIO *b, char *bio);
 156 \&
 157 \& char *BIO_get_peer_name(BIO *b);
 158 \& char *BIO_get_peer_port(BIO *b);
 159 \& long BIO_get_accept_ip_family(BIO *b);
 160 \& long BIO_set_accept_ip_family(BIO *b, long family);
 161 \&
 162 \& long BIO_set_bind_mode(BIO *b, long mode);
 163 \& long BIO_get_bind_mode(BIO *b);
 164 \&
 165 \& int BIO_do_accept(BIO *b);
 166 .Ve
 167 .SH "DESCRIPTION"
 168 .IX Header "DESCRIPTION"
 169 \&\fIBIO_s_accept()\fR returns the accept \s-1BIO\s0 method. This is a wrapper
 170 round the platform's \s-1TCP/IP\s0 socket accept routines.
 171 .PP
 172 Using accept BIOs, \s-1TCP/IP\s0 connections can be accepted and data
 173 transferred using only \s-1BIO\s0 routines. In this way any platform
 174 specific operations are hidden by the \s-1BIO\s0 abstraction.
 175 .PP
 176 Read and write operations on an accept \s-1BIO\s0 will perform I/O
 177 on the underlying connection. If no connection is established
 178 and the port (see below) is set up properly then the \s-1BIO\s0
 179 waits for an incoming connection.
 180 .PP
 181 Accept BIOs support \fIBIO_puts()\fR but not \fIBIO_gets()\fR.
 182 .PP
 183 If the close flag is set on an accept \s-1BIO\s0 then any active
 184 connection on that chain is shutdown and the socket closed when
 185 the \s-1BIO\s0 is freed.
 186 .PP
 187 Calling \fIBIO_reset()\fR on an accept \s-1BIO\s0 will close any active
 188 connection and reset the \s-1BIO\s0 into a state where it awaits another
 189 incoming connection.
 190 .PP
 191 \&\fIBIO_get_fd()\fR and \fIBIO_set_fd()\fR can be called to retrieve or set
 192 the accept socket. See \fIBIO_s_fd\fR\|(3)
 193 .PP
 194 \&\fIBIO_set_accept_name()\fR uses the string \fBname\fR to set the accept
 195 name. The name is represented as a string of the form \*(L"host:port\*(R",
 196 where \*(L"host\*(R" is the interface to use and \*(L"port\*(R" is the port.
 197 The host can be \*(L"*\*(R" or empty which is interpreted as meaning
 198 any interface.  If the host is an IPv6 address, it has to be
 199 enclosed in brackets, for example \*(L"[::1]:https\*(R".  \*(L"port\*(R" has the
 200 same syntax as the port specified in \fIBIO_set_conn_port()\fR for
 201 connect BIOs, that is it can be a numerical port string or a
 202 string to lookup using \fIgetservbyname()\fR and a string table.
 203 .PP
 204 \&\fIBIO_set_accept_port()\fR uses the string \fBport\fR to set the accept
 205 port.  \*(L"port\*(R" has the same syntax as the port specified in
 206 \&\fIBIO_set_conn_port()\fR for connect BIOs, that is it can be a numerical
 207 port string or a string to lookup using \fIgetservbyname()\fR and a string
 208 table.
 209 .PP
 210 \&\fIBIO_new_accept()\fR combines \fIBIO_new()\fR and \fIBIO_set_accept_name()\fR into
 211 a single call: that is it creates a new accept \s-1BIO\s0 with port
 212 \&\fBhost_port\fR.
 213 .PP
 214 \&\fIBIO_set_nbio_accept()\fR sets the accept socket to blocking mode
 215 (the default) if \fBn\fR is 0 or non blocking mode if \fBn\fR is 1.
 216 .PP
 217 \&\fIBIO_set_accept_bios()\fR can be used to set a chain of BIOs which
 218 will be duplicated and prepended to the chain when an incoming
 219 connection is received. This is useful if, for example, a
 220 buffering or \s-1SSL BIO\s0 is required for each connection. The
 221 chain of BIOs must not be freed after this call, they will
 222 be automatically freed when the accept \s-1BIO\s0 is freed.
 223 .PP
 224 \&\fIBIO_set_bind_mode()\fR and \fIBIO_get_bind_mode()\fR set and retrieve
 225 the current bind mode. If \fB\s-1BIO_BIND_NORMAL\s0\fR (the default) is set
 226 then another socket cannot be bound to the same port. If
 227 \&\fB\s-1BIO_BIND_REUSEADDR\s0\fR is set then other sockets can bind to the
 228 same port. If \fB\s-1BIO_BIND_REUSEADDR_IF_UNUSED\s0\fR is set then and
 229 attempt is first made to use \s-1BIO_BIN_NORMAL,\s0 if this fails
 230 and the port is not in use then a second attempt is made
 231 using \fB\s-1BIO_BIND_REUSEADDR\s0\fR.
 232 .PP
 233 \&\fIBIO_do_accept()\fR serves two functions. When it is first
 234 called, after the accept \s-1BIO\s0 has been setup, it will attempt
 235 to create the accept socket and bind an address to it. Second
 236 and subsequent calls to \fIBIO_do_accept()\fR will await an incoming
 237 connection, or request a retry in non blocking mode.
 238 .SH "NOTES"
 239 .IX Header "NOTES"
 240 When an accept \s-1BIO\s0 is at the end of a chain it will await an
 241 incoming connection before processing I/O calls. When an accept
 242 \&\s-1BIO\s0 is not at then end of a chain it passes I/O calls to the next
 243 \&\s-1BIO\s0 in the chain.
 244 .PP
 245 When a connection is established a new socket \s-1BIO\s0 is created for
 246 the connection and appended to the chain. That is the chain is now
 247 accept\->socket. This effectively means that attempting I/O on
 248 an initial accept socket will await an incoming connection then
 249 perform I/O on it.
 250 .PP
 251 If any additional BIOs have been set using \fIBIO_set_accept_bios()\fR
 252 then they are placed between the socket and the accept \s-1BIO,\s0
 253 that is the chain will be accept\->otherbios\->socket.
 254 .PP
 255 If a server wishes to process multiple connections (as is normally
 256 the case) then the accept \s-1BIO\s0 must be made available for further
 257 incoming connections. This can be done by waiting for a connection and
 258 then calling:
 259 .PP
 260 .Vb 1
 261 \& connection = BIO_pop(accept);
 262 .Ve
 263 .PP
 264 After this call \fBconnection\fR will contain a \s-1BIO\s0 for the recently
 265 established connection and \fBaccept\fR will now be a single \s-1BIO\s0
 266 again which can be used to await further incoming connections.
 267 If no further connections will be accepted the \fBaccept\fR can
 268 be freed using \fIBIO_free()\fR.
 269 .PP
 270 If only a single connection will be processed it is possible to
 271 perform I/O using the accept \s-1BIO\s0 itself. This is often undesirable
 272 however because the accept \s-1BIO\s0 will still accept additional incoming
 273 connections. This can be resolved by using \fIBIO_pop()\fR (see above)
 274 and freeing up the accept \s-1BIO\s0 after the initial connection.
 275 .PP
 276 If the underlying accept socket is non-blocking and \fIBIO_do_accept()\fR is
 277 called to await an incoming connection it is possible for
 278 \&\fIBIO_should_io_special()\fR with the reason \s-1BIO_RR_ACCEPT.\s0 If this happens
 279 then it is an indication that an accept attempt would block: the application
 280 should take appropriate action to wait until the underlying socket has
 281 accepted a connection and retry the call.
 282 .PP
 283 \&\fIBIO_set_accept_name()\fR, \fIBIO_get_accept_name()\fR, \fIBIO_set_accept_port()\fR,
 284 \&\fIBIO_get_accept_port()\fR, \fIBIO_set_nbio_accept()\fR, \fIBIO_set_accept_bios()\fR,
 285 \&\fIBIO_get_peer_name()\fR, \fIBIO_get_peer_port()\fR,
 286 \&\fIBIO_get_accept_ip_family()\fR, \fIBIO_set_accept_ip_family()\fR,
 287 \&\fIBIO_set_bind_mode()\fR, \fIBIO_get_bind_mode()\fR and \fIBIO_do_accept()\fR are macros.
 288 .SH "RETURN VALUES"
 289 .IX Header "RETURN VALUES"
 290 \&\fIBIO_do_accept()\fR,
 291 \&\fIBIO_set_accept_name()\fR, \fIBIO_set_accept_port()\fR, \fIBIO_set_nbio_accept()\fR,
 292 \&\fIBIO_set_accept_bios()\fR, \fIBIO_set_accept_ip_family()\fR, and \fIBIO_set_bind_mode()\fR
 293 return 1 for success and 0 or \-1 for failure.
 294 .PP
 295 \&\fIBIO_get_accept_name()\fR returns the accept name or \s-1NULL\s0 on error.
 296 \&\fIBIO_get_peer_name()\fR returns the peer name or \s-1NULL\s0 on error.
 297 .PP
 298 \&\fIBIO_get_accept_port()\fR returns the accept port as a string or \s-1NULL\s0 on error.
 299 \&\fIBIO_get_peer_port()\fR returns the peer port as a string or \s-1NULL\s0 on error.
 300 \&\fIBIO_get_accept_ip_family()\fR returns the \s-1IP\s0 family or \-1 on error.
 301 .PP
 302 \&\fIBIO_get_bind_mode()\fR returns the set of \fB\s-1BIO_BIND\s0\fR flags, or \-1 on failure.
 303 .PP
 304 \&\fIBIO_new_accept()\fR returns a \s-1BIO\s0 or \s-1NULL\s0 on error.
 305 .SH "EXAMPLE"
 306 .IX Header "EXAMPLE"
 307 This example accepts two connections on port 4444, sends messages
 308 down each and finally closes both down.
 309 .PP
 310 .Vb 1
 311 \& BIO *abio, *cbio, *cbio2;
 312 \&
 313 \& /* First call to BIO_accept() sets up accept BIO */
 314 \& abio = BIO_new_accept("4444");
 315 \& if (BIO_do_accept(abio) <= 0) {
 316 \&     fprintf(stderr, "Error setting up accept\en");
 317 \&     ERR_print_errors_fp(stderr);
 318 \&     exit(1);
 319 \& }
 320 \&
 321 \& /* Wait for incoming connection */
 322 \& if (BIO_do_accept(abio) <= 0) {
 323 \&     fprintf(stderr, "Error accepting connection\en");
 324 \&     ERR_print_errors_fp(stderr);
 325 \&     exit(1);
 326 \& }
 327 \& fprintf(stderr, "Connection 1 established\en");
 328 \&
 329 \& /* Retrieve BIO for connection */
 330 \& cbio = BIO_pop(abio);
 331 \& BIO_puts(cbio, "Connection 1: Sending out Data on initial connection\en");
 332 \& fprintf(stderr, "Sent out data on connection 1\en");
 333 \&
 334 \& /* Wait for another connection */
 335 \& if (BIO_do_accept(abio) <= 0) {
 336 \&     fprintf(stderr, "Error accepting connection\en");
 337 \&     ERR_print_errors_fp(stderr);
 338 \&     exit(1);
 339 \& }
 340 \& fprintf(stderr, "Connection 2 established\en");
 341 \&
 342 \& /* Close accept BIO to refuse further connections */
 343 \& cbio2 = BIO_pop(abio);
 344 \& BIO_free(abio);
 345 \& BIO_puts(cbio2, "Connection 2: Sending out Data on second\en");
 346 \& fprintf(stderr, "Sent out data on connection 2\en");
 347 \&
 348 \& BIO_puts(cbio, "Connection 1: Second connection established\en");
 349 \&
 350 \& /* Close the two established connections */
 351 \& BIO_free(cbio);
 352 \& BIO_free(cbio2);
 353 .Ve
 354 .SH "COPYRIGHT"
 355 .IX Header "COPYRIGHT"
 356 Copyright 2000\-2018 The OpenSSL Project Authors. All Rights Reserved.
 357 .PP
 358 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 359 this file except in compliance with the License.  You can obtain a copy
 360 in the file \s-1LICENSE\s0 in the source distribution or at
 361 <https://www.openssl.org/source/license.html>.