doc/crypto/BIO_s_accept.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 BIO_s_accept, BIO_set_accept_name, BIO_get_name, BIO_set_accept_port,
   6 BIO_get_accept_port, BIO_new_accept, BIO_set_nbio_accept, BIO_set_accept_bios,
   7 BIO_set_bind_mode, BIO_get_bind_mode, BIO_do_accept - accept BIO
   8
   9 =head1 SYNOPSIS
  10
  11  #include <openssl/bio.h>
  12
  13  const BIO_METHOD *BIO_s_accept(void);
  14
  15  long BIO_set_accept_name(BIO *b, char *name);
  16  char *BIO_get_accept_name(BIO *b);
  17
  18  long BIO_set_accept_port(BIO *b, char *name);
  19  char *BIO_get_accept_port(BIO *b);
  20
  21  BIO *BIO_new_accept(char *host_port);
  22
  23  long BIO_set_nbio_accept(BIO *b, int n);
  24  long BIO_set_accept_bios(BIO *b, char *bio);
  25
  26  long BIO_set_bind_mode(BIO *b, long mode);
  27  long BIO_get_bind_mode(BIO *b);
  28
  29  int BIO_do_accept(BIO *b);
  30
  31 =head1 DESCRIPTION
  32
  33 BIO_s_accept() returns the accept BIO method. This is a wrapper
  34 round the platform's TCP/IP socket accept routines.
  35
  36 Using accept BIOs, TCP/IP connections can be accepted and data
  37 transferred using only BIO routines. In this way any platform
  38 specific operations are hidden by the BIO abstraction.
  39
  40 Read and write operations on an accept BIO will perform I/O
  41 on the underlying connection. If no connection is established
  42 and the port (see below) is set up properly then the BIO
  43 waits for an incoming connection.
  44
  45 Accept BIOs support BIO_puts() but not BIO_gets().
  46
  47 If the close flag is set on an accept BIO then any active
  48 connection on that chain is shutdown and the socket closed when
  49 the BIO is freed.
  50
  51 Calling BIO_reset() on an accept BIO will close any active
  52 connection and reset the BIO into a state where it awaits another
  53 incoming connection.
  54
  55 BIO_get_fd() and BIO_set_fd() can be called to retrieve or set
  56 the accept socket. See L<BIO_s_fd(3)>
  57
  58 BIO_set_accept_name() uses the string B<name> to set the accept
  59 name. The name is represented as a string of the form "host:port",
  60 where "host" is the interface to use and "port" is the port.
  61 The host can be "*" or empty which is interpreted as meaning
  62 any interface.  If the host is an IPv6 address, it has to be
  63 enclosed in brackets, for example "[::1]:https".  "port" has the
  64 same syntax as the port specified in BIO_set_conn_name() for
  65 connect BIOs, that is it can be a numerical port string or a
  66 string to lookup using getservbyname() and a string table.
  67
  68 BIO_new_accept() combines BIO_new() and BIO_set_accept_name() into
  69 a single call: that is it creates a new accept BIO with port
  70 B<host_port>.
  71
  72 BIO_set_nbio_accept() sets the accept socket to blocking mode
  73 (the default) if B<n> is 0 or non blocking mode if B<n> is 1.
  74
  75 BIO_set_accept_bios() can be used to set a chain of BIOs which
  76 will be duplicated and prepended to the chain when an incoming
  77 connection is received. This is useful if, for example, a
  78 buffering or SSL BIO is required for each connection. The
  79 chain of BIOs must not be freed after this call, they will
  80 be automatically freed when the accept BIO is freed.
  81
  82 BIO_set_bind_mode() and BIO_get_bind_mode() set and retrieve
  83 the current bind mode. If B<BIO_BIND_NORMAL> (the default) is set
  84 then another socket cannot be bound to the same port. If
  85 B<BIO_BIND_REUSEADDR> is set then other sockets can bind to the
  86 same port. If B<BIO_BIND_REUSEADDR_IF_UNUSED> is set then and
  87 attempt is first made to use BIO_BIN_NORMAL, if this fails
  88 and the port is not in use then a second attempt is made
  89 using B<BIO_BIND_REUSEADDR>.
  90
  91 BIO_do_accept() serves two functions. When it is first
  92 called, after the accept BIO has been setup, it will attempt
  93 to create the accept socket and bind an address to it. Second
  94 and subsequent calls to BIO_do_accept() will await an incoming
  95 connection, or request a retry in non blocking mode.
  96
  97 =head1 NOTES
  98
  99 When an accept BIO is at the end of a chain it will await an
 100 incoming connection before processing I/O calls. When an accept
 101 BIO is not at then end of a chain it passes I/O calls to the next
 102 BIO in the chain.
 103
 104 When a connection is established a new socket BIO is created for
 105 the connection and appended to the chain. That is the chain is now
 106 accept->socket. This effectively means that attempting I/O on
 107 an initial accept socket will await an incoming connection then
 108 perform I/O on it.
 109
 110 If any additional BIOs have been set using BIO_set_accept_bios()
 111 then they are placed between the socket and the accept BIO,
 112 that is the chain will be accept->otherbios->socket.
 113
 114 If a server wishes to process multiple connections (as is normally
 115 the case) then the accept BIO must be made available for further
 116 incoming connections. This can be done by waiting for a connection and
 117 then calling:
 118
 119  connection = BIO_pop(accept);
 120
 121 After this call B<connection> will contain a BIO for the recently
 122 established connection and B<accept> will now be a single BIO
 123 again which can be used to await further incoming connections.
 124 If no further connections will be accepted the B<accept> can
 125 be freed using BIO_free().
 126
 127 If only a single connection will be processed it is possible to
 128 perform I/O using the accept BIO itself. This is often undesirable
 129 however because the accept BIO will still accept additional incoming
 130 connections. This can be resolved by using BIO_pop() (see above)
 131 and freeing up the accept BIO after the initial connection.
 132
 133 If the underlying accept socket is non-blocking and BIO_do_accept() is
 134 called to await an incoming connection it is possible for
 135 BIO_should_io_special() with the reason BIO_RR_ACCEPT. If this happens
 136 then it is an indication that an accept attempt would block: the application
 137 should take appropriate action to wait until the underlying socket has
 138 accepted a connection and retry the call.
 139
 140 BIO_set_accept_name(), BIO_get_accept_name(), BIO_set_accept_port(),
 141 BIO_get_accept_port(), BIO_set_nbio_accept(), BIO_set_accept_bios(),
 142 BIO_set_bind_mode(), BIO_get_bind_mode() and BIO_do_accept() are macros.
 143
 144 =head1 RETURN VALUES
 145
 146 BIO_do_accept(),
 147 BIO_set_accept_name(), BIO_set_accept_port(), BIO_set_nbio_accept(),
 148 BIO_set_accept_bios(), and BIO_set_bind_mode(), return 1 for success and 0 or
 149 -1 for failure.
 150
 151 BIO_set_accept_name() and BIO_get_accept_port() returns the port name or NULL
 152 on error.
 153
 154 BIO_get_bind_mode() returns the set of B<BIO_BIND> flags, or -1 on failure.
 155
 156 BIO_new_accept() returns a BIO or NULL on error.
 157
 158 =head1 EXAMPLE
 159
 160 This example accepts two connections on port 4444, sends messages
 161 down each and finally closes both down.
 162
 163  BIO *abio, *cbio, *cbio2;
 164
 165  /* First call to BIO_accept() sets up accept BIO */
 166  abio = BIO_new_accept("4444");
 167  if (BIO_do_accept(abio) <= 0) {
 168      fprintf(stderr, "Error setting up accept\n");
 169      ERR_print_errors_fp(stderr);
 170      exit(1);
 171  }
 172
 173  /* Wait for incoming connection */
 174  if (BIO_do_accept(abio) <= 0) {
 175      fprintf(stderr, "Error accepting connection\n");
 176      ERR_print_errors_fp(stderr);
 177      exit(1);
 178  }
 179  fprintf(stderr, "Connection 1 established\n");
 180
 181  /* Retrieve BIO for connection */
 182  cbio = BIO_pop(abio);
 183  BIO_puts(cbio, "Connection 1: Sending out Data on initial connection\n");
 184  fprintf(stderr, "Sent out data on connection 1\n");
 185
 186  /* Wait for another connection */
 187  if (BIO_do_accept(abio) <= 0) {
 188      fprintf(stderr, "Error accepting connection\n");
 189      ERR_print_errors_fp(stderr);
 190      exit(1);
 191  }
 192  fprintf(stderr, "Connection 2 established\n");
 193
 194  /* Close accept BIO to refuse further connections */
 195  cbio2 = BIO_pop(abio);
 196  BIO_free(abio);
 197  BIO_puts(cbio2, "Connection 2: Sending out Data on second\n");
 198  fprintf(stderr, "Sent out data on connection 2\n");
 199
 200  BIO_puts(cbio, "Connection 1: Second connection established\n");
 201
 202  /* Close the two established connections */
 203  BIO_free(cbio);
 204  BIO_free(cbio2);
 205
 206 =head1 COPYRIGHT
 207
 208 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
 209
 210 Licensed under the OpenSSL license (the "License").  You may not use
 211 this file except in compliance with the License.  You can obtain a copy
 212 in the file LICENSE in the source distribution or at
 213 L<https://www.openssl.org/source/license.html>.
 214
 215 =cut