s4:lib/tevent: rename structs
[gd/samba-autobuild/.git] / source4 / smbd / service_stream.c
1 /* 
2    Unix SMB/CIFS implementation.
3
4    helper functions for stream based servers
5
6    Copyright (C) Andrew Tridgell 2003-2005
7    Copyright (C) Stefan (metze) Metzmacher      2004
8    
9    This program is free software; you can redistribute it and/or modify
10    it under the terms of the GNU General Public License as published by
11    the Free Software Foundation; either version 3 of the License, or
12    (at your option) any later version.
13    
14    This program is distributed in the hope that it will be useful,
15    but WITHOUT ANY WARRANTY; without even the implied warranty of
16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17    GNU General Public License for more details.
18    
19    You should have received a copy of the GNU General Public License
20    along with this program.  If not, see <http://www.gnu.org/licenses/>.
21 */
22
23 #include "includes.h"
24 #include "process_model.h"
25 #include "lib/events/events.h"
26 #include "lib/socket/socket.h"
27 #include "smbd/service.h"
28 #include "smbd/service_stream.h"
29 #include "lib/messaging/irpc.h"
30 #include "cluster/cluster.h"
31 #include "param/param.h"
32
33 /* the range of ports to try for dcerpc over tcp endpoints */
34 #define SERVER_TCP_LOW_PORT  1024
35 #define SERVER_TCP_HIGH_PORT 1300
36
37 /* size of listen() backlog in smbd */
38 #define SERVER_LISTEN_BACKLOG 10
39
40
41 /*
42   private structure for a single listening stream socket
43 */
44 struct stream_socket {
45         const struct stream_server_ops *ops;
46         struct loadparm_context *lp_ctx;
47         struct tevent_context *event_ctx;
48         const struct model_ops *model_ops;
49         struct socket_context *sock;
50         void *private;
51 };
52
53
54 /*
55   close the socket and shutdown a stream_connection
56 */
57 void stream_terminate_connection(struct stream_connection *srv_conn, const char *reason)
58 {
59         struct tevent_context *event_ctx = srv_conn->event.ctx;
60         const struct model_ops *model_ops = srv_conn->model_ops;
61
62         if (!reason) reason = "unknown reason";
63
64         DEBUG(3,("Terminating connection - '%s'\n", reason));
65
66         srv_conn->terminate = reason;
67
68         if (srv_conn->processing) {
69                 /* 
70                  * if we're currently inside the stream_io_handler(),
71                  * defer the termination to the end of stream_io_hendler()
72                  *
73                  * and we don't want to read or write to the connection...
74                  */
75                 event_set_fd_flags(srv_conn->event.fde, 0);
76                 return;
77         }
78
79         talloc_free(srv_conn->event.fde);
80         srv_conn->event.fde = NULL;
81         model_ops->terminate(event_ctx, srv_conn->lp_ctx, reason);
82         talloc_free(srv_conn);
83 }
84
85 /**
86   the select loop has indicated that a stream is ready for IO
87 */
88 static void stream_io_handler(struct stream_connection *conn, uint16_t flags)
89 {
90         conn->processing++;
91         if (flags & EVENT_FD_WRITE) {
92                 conn->ops->send_handler(conn, flags);
93         } else if (flags & EVENT_FD_READ) {
94                 conn->ops->recv_handler(conn, flags);
95         }
96         conn->processing--;
97
98         if (conn->terminate) {
99                 stream_terminate_connection(conn, conn->terminate);
100         }
101 }
102
103 static void stream_io_handler_fde(struct tevent_context *ev, struct tevent_fd *fde, 
104                                   uint16_t flags, void *private)
105 {
106         struct stream_connection *conn = talloc_get_type(private, 
107                                                          struct stream_connection);
108         stream_io_handler(conn, flags);
109 }
110
111 void stream_io_handler_callback(void *private, uint16_t flags) 
112 {
113         struct stream_connection *conn = talloc_get_type(private, 
114                                                          struct stream_connection);
115         stream_io_handler(conn, flags);
116 }
117
118 /*
119   this creates a stream_connection from an already existing connection,
120   used for protocols, where a client connection needs to switched into
121   a server connection
122 */
123 NTSTATUS stream_new_connection_merge(struct tevent_context *ev,
124                                      struct loadparm_context *lp_ctx,
125                                      const struct model_ops *model_ops,
126                                      struct socket_context *sock,
127                                      const struct stream_server_ops *stream_ops,
128                                      struct messaging_context *msg_ctx,
129                                      void *private_data,
130                                      struct stream_connection **_srv_conn)
131 {
132         struct stream_connection *srv_conn;
133
134         srv_conn = talloc_zero(ev, struct stream_connection);
135         NT_STATUS_HAVE_NO_MEMORY(srv_conn);
136
137         talloc_steal(srv_conn, sock);
138
139         srv_conn->private       = private_data;
140         srv_conn->model_ops     = model_ops;
141         srv_conn->socket        = sock;
142         srv_conn->server_id     = cluster_id(0, 0);
143         srv_conn->ops           = stream_ops;
144         srv_conn->msg_ctx       = msg_ctx;
145         srv_conn->event.ctx     = ev;
146         srv_conn->lp_ctx        = lp_ctx;
147         srv_conn->event.fde     = event_add_fd(ev, srv_conn, socket_get_fd(sock),
148                                                EVENT_FD_READ, 
149                                                stream_io_handler_fde, srv_conn);
150         *_srv_conn = srv_conn;
151         return NT_STATUS_OK;
152 }
153
154 /*
155   called when a new socket connection has been established. This is called in the process
156   context of the new process (if appropriate)
157 */
158 static void stream_new_connection(struct tevent_context *ev,
159                                   struct loadparm_context *lp_ctx,
160                                   struct socket_context *sock, 
161                                   struct server_id server_id, void *private)
162 {
163         struct stream_socket *stream_socket = talloc_get_type(private, struct stream_socket);
164         struct stream_connection *srv_conn;
165         struct socket_address *c, *s;
166
167         srv_conn = talloc_zero(ev, struct stream_connection);
168         if (!srv_conn) {
169                 DEBUG(0,("talloc(mem_ctx, struct stream_connection) failed\n"));
170                 return;
171         }
172
173         talloc_steal(srv_conn, sock);
174
175         srv_conn->private       = stream_socket->private;
176         srv_conn->model_ops     = stream_socket->model_ops;
177         srv_conn->socket        = sock;
178         srv_conn->server_id     = server_id;
179         srv_conn->ops           = stream_socket->ops;
180         srv_conn->event.ctx     = ev;
181         srv_conn->lp_ctx        = lp_ctx;
182         srv_conn->event.fde     = event_add_fd(ev, srv_conn, socket_get_fd(sock),
183                                                0, stream_io_handler_fde, srv_conn);
184
185         if (!socket_check_access(sock, "smbd", lp_hostsallow(NULL, lp_default_service(lp_ctx)), lp_hostsdeny(NULL, lp_default_service(lp_ctx)))) {
186                 stream_terminate_connection(srv_conn, "denied by access rules");
187                 return;
188         }
189
190         /* setup to receive internal messages on this connection */
191         srv_conn->msg_ctx = messaging_init(srv_conn, 
192                                            lp_messaging_path(srv_conn, lp_ctx),
193                                            srv_conn->server_id, 
194                                            lp_iconv_convenience(lp_ctx),
195                                            ev);
196         if (!srv_conn->msg_ctx) {
197                 stream_terminate_connection(srv_conn, "messaging_init() failed");
198                 return;
199         }
200
201         c = socket_get_peer_addr(sock, ev);
202         s = socket_get_my_addr(sock, ev);
203         if (s && c) {
204                 const char *title;
205                 title = talloc_asprintf(s, "conn[%s] c[%s:%u] s[%s:%u] server_id[%s]",
206                                         stream_socket->ops->name, 
207                                         c->addr, c->port, s->addr, s->port,
208                                         cluster_id_string(s, server_id));
209                 if (title) {
210                         stream_connection_set_title(srv_conn, title);
211                 }
212         }
213         talloc_free(c);
214         talloc_free(s);
215
216         /* we're now ready to start receiving events on this stream */
217         EVENT_FD_READABLE(srv_conn->event.fde);
218
219         /* call the server specific accept code */
220         stream_socket->ops->accept_connection(srv_conn);
221 }
222
223
224 /*
225   called when someone opens a connection to one of our listening ports
226 */
227 static void stream_accept_handler(struct tevent_context *ev, struct tevent_fd *fde, 
228                                   uint16_t flags, void *private)
229 {
230         struct stream_socket *stream_socket = talloc_get_type(private, struct stream_socket);
231
232         /* ask the process model to create us a process for this new
233            connection.  When done, it calls stream_new_connection()
234            with the newly created socket */
235         stream_socket->model_ops->accept_connection(ev, stream_socket->lp_ctx, 
236                                                     stream_socket->sock, 
237                                                     stream_new_connection, stream_socket);
238 }
239
240 /*
241   setup a listen stream socket
242   if you pass *port == 0, then a port > 1024 is used
243
244   FIXME: This function is TCP/IP specific - uses an int rather than 
245          a string for the port. Should leave allocating a port nr 
246          to the socket implementation - JRV20070903
247  */
248 NTSTATUS stream_setup_socket(struct tevent_context *event_context,
249                              struct loadparm_context *lp_ctx,
250                              const struct model_ops *model_ops,
251                              const struct stream_server_ops *stream_ops,
252                              const char *family,
253                              const char *sock_addr,
254                              uint16_t *port,
255                              const char *socket_options,
256                              void *private)
257 {
258         NTSTATUS status;
259         struct stream_socket *stream_socket;
260         struct socket_address *socket_address;
261         int i;
262
263         stream_socket = talloc_zero(event_context, struct stream_socket);
264         NT_STATUS_HAVE_NO_MEMORY(stream_socket);
265
266         status = socket_create(family, SOCKET_TYPE_STREAM, &stream_socket->sock, 0);
267         NT_STATUS_NOT_OK_RETURN(status);
268
269         talloc_steal(stream_socket, stream_socket->sock);
270
271         stream_socket->lp_ctx = talloc_reference(stream_socket, lp_ctx);
272
273         /* ready to listen */
274         status = socket_set_option(stream_socket->sock, "SO_KEEPALIVE", NULL);
275         NT_STATUS_NOT_OK_RETURN(status);
276
277         if (socket_options != NULL) {
278                 status = socket_set_option(stream_socket->sock, socket_options, NULL);
279                 NT_STATUS_NOT_OK_RETURN(status);
280         }
281
282         /* TODO: set socket ACL's (host allow etc) here when they're
283          * implemented */
284
285         /* Some sockets don't have a port, or are just described from
286          * the string.  We are indicating this by having port == NULL */
287         if (!port) {
288                 socket_address = socket_address_from_strings(stream_socket, 
289                                                              stream_socket->sock->backend_name,
290                                                              sock_addr, 0);
291                 NT_STATUS_HAVE_NO_MEMORY(socket_address);
292                 status = socket_listen(stream_socket->sock, socket_address, SERVER_LISTEN_BACKLOG, 0);
293                 talloc_free(socket_address);
294
295         } else if (*port == 0) {
296                 for (i=SERVER_TCP_LOW_PORT;i<= SERVER_TCP_HIGH_PORT;i++) {
297                         socket_address = socket_address_from_strings(stream_socket, 
298                                                                      stream_socket->sock->backend_name,
299                                                                      sock_addr, i);
300                         NT_STATUS_HAVE_NO_MEMORY(socket_address);
301                         status = socket_listen(stream_socket->sock, socket_address, 
302                                                SERVER_LISTEN_BACKLOG, 0);
303                         talloc_free(socket_address);
304                         if (NT_STATUS_IS_OK(status)) {
305                                 *port = i;
306                                 break;
307                         }
308                 }
309         } else {
310                 socket_address = socket_address_from_strings(stream_socket, 
311                                                              stream_socket->sock->backend_name,
312                                                              sock_addr, *port);
313                 NT_STATUS_HAVE_NO_MEMORY(socket_address);
314                 status = socket_listen(stream_socket->sock, socket_address, SERVER_LISTEN_BACKLOG, 0);
315                 talloc_free(socket_address);
316         }
317
318         if (!NT_STATUS_IS_OK(status)) {
319                 DEBUG(0,("Failed to listen on %s:%u - %s\n",
320                         sock_addr, *port, nt_errstr(status)));
321                 talloc_free(stream_socket);
322                 return status;
323         }
324
325         /* By specifying EVENT_FD_AUTOCLOSE below, we indicate that we
326          * will close the socket using the events system.  This avoids
327          * nasty interactions with waiting for talloc to close the socket. */
328
329         socket_set_flags(stream_socket->sock, SOCKET_FLAG_NOCLOSE);
330
331         /* Add the FD from the newly created socket into the event
332          * subsystem.  it will call the accept handler whenever we get
333          * new connections */
334
335         event_add_fd(event_context, stream_socket->sock, 
336                      socket_get_fd(stream_socket->sock), 
337                      EVENT_FD_READ|EVENT_FD_AUTOCLOSE, 
338                      stream_accept_handler, stream_socket);
339
340         stream_socket->private          = talloc_reference(stream_socket, private);
341         stream_socket->ops              = stream_ops;
342         stream_socket->event_ctx        = event_context;
343         stream_socket->model_ops        = model_ops;
344
345         return NT_STATUS_OK;
346 }
347
348 /*
349   setup a connection title 
350 */
351 void stream_connection_set_title(struct stream_connection *conn, const char *title)
352 {
353         conn->model_ops->set_title(conn->event.ctx, title);
354 }