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