2 Unix SMB/CIFS implementation.
4 helper functions for stream based servers
6 Copyright (C) Andrew Tridgell 2003-2005
7 Copyright (C) Stefan (metze) Metzmacher 2004
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.
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.
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/>.
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"
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
37 /* size of listen() backlog in smbd */
38 #define SERVER_LISTEN_BACKLOG 10
42 private structure for a single listening stream socket
44 struct stream_socket {
45 const struct stream_server_ops *ops;
46 struct loadparm_context *lp_ctx;
47 struct event_context *event_ctx;
48 const struct model_ops *model_ops;
49 struct socket_context *sock;
55 close the socket and shutdown a stream_connection
57 void stream_terminate_connection(struct stream_connection *srv_conn, const char *reason)
59 struct event_context *event_ctx = srv_conn->event.ctx;
60 const struct model_ops *model_ops = srv_conn->model_ops;
62 if (!reason) reason = "unknown reason";
64 srv_conn->terminate = reason;
66 if (srv_conn->processing) {
68 * if we're currently inside the stream_io_handler(),
69 * defer the termination to the end of stream_io_hendler()
71 * and we don't want to read or write to the connection...
73 event_set_fd_flags(srv_conn->event.fde, 0);
77 talloc_free(srv_conn->event.fde);
78 srv_conn->event.fde = NULL;
79 talloc_free(srv_conn);
80 model_ops->terminate(event_ctx, reason);
84 the select loop has indicated that a stream is ready for IO
86 static void stream_io_handler(struct stream_connection *conn, uint16_t flags)
88 conn->processing = true;
89 if (flags & EVENT_FD_WRITE) {
90 conn->ops->send_handler(conn, flags);
91 } else if (flags & EVENT_FD_READ) {
92 conn->ops->recv_handler(conn, flags);
94 conn->processing = false;
96 if (conn->terminate) {
97 stream_terminate_connection(conn, conn->terminate);
101 static void stream_io_handler_fde(struct event_context *ev, struct fd_event *fde,
102 uint16_t flags, void *private)
104 struct stream_connection *conn = talloc_get_type(private,
105 struct stream_connection);
106 stream_io_handler(conn, flags);
109 void stream_io_handler_callback(void *private, uint16_t flags)
111 struct stream_connection *conn = talloc_get_type(private,
112 struct stream_connection);
113 stream_io_handler(conn, flags);
117 this creates a stream_connection from an already existing connection,
118 used for protocols, where a client connection needs to switched into
121 NTSTATUS stream_new_connection_merge(struct event_context *ev,
122 const struct model_ops *model_ops,
123 struct socket_context *sock,
124 const struct stream_server_ops *stream_ops,
125 struct messaging_context *msg_ctx,
127 struct stream_connection **_srv_conn)
129 struct stream_connection *srv_conn;
131 srv_conn = talloc_zero(ev, struct stream_connection);
132 NT_STATUS_HAVE_NO_MEMORY(srv_conn);
134 talloc_steal(srv_conn, sock);
136 srv_conn->private = private_data;
137 srv_conn->model_ops = model_ops;
138 srv_conn->socket = sock;
139 srv_conn->server_id = cluster_id(0, 0);
140 srv_conn->ops = stream_ops;
141 srv_conn->msg_ctx = msg_ctx;
142 srv_conn->event.ctx = ev;
143 srv_conn->event.fde = event_add_fd(ev, srv_conn, socket_get_fd(sock),
145 stream_io_handler_fde, srv_conn);
146 *_srv_conn = srv_conn;
151 called when a new socket connection has been established. This is called in the process
152 context of the new process (if appropriate)
154 static void stream_new_connection(struct event_context *ev,
155 struct loadparm_context *lp_ctx,
156 struct socket_context *sock,
157 struct server_id server_id, void *private)
159 struct stream_socket *stream_socket = talloc_get_type(private, struct stream_socket);
160 struct stream_connection *srv_conn;
161 struct socket_address *c, *s;
163 srv_conn = talloc_zero(ev, struct stream_connection);
165 DEBUG(0,("talloc(mem_ctx, struct stream_connection) failed\n"));
169 talloc_steal(srv_conn, sock);
171 srv_conn->private = stream_socket->private;
172 srv_conn->model_ops = stream_socket->model_ops;
173 srv_conn->socket = sock;
174 srv_conn->server_id = server_id;
175 srv_conn->ops = stream_socket->ops;
176 srv_conn->event.ctx = ev;
177 srv_conn->lp_ctx = lp_ctx;
178 srv_conn->event.fde = event_add_fd(ev, srv_conn, socket_get_fd(sock),
179 0, stream_io_handler_fde, srv_conn);
181 if (!socket_check_access(sock, "smbd", lp_hostsallow(NULL, lp_default_service(lp_ctx)), lp_hostsdeny(NULL, lp_default_service(lp_ctx)))) {
182 stream_terminate_connection(srv_conn, "denied by access rules");
186 /* setup to receive internal messages on this connection */
187 srv_conn->msg_ctx = messaging_init(srv_conn,
188 lp_messaging_path(srv_conn, lp_ctx),
190 lp_iconv_convenience(lp_ctx),
192 if (!srv_conn->msg_ctx) {
193 stream_terminate_connection(srv_conn, "messaging_init() failed");
197 c = socket_get_peer_addr(sock, ev);
198 s = socket_get_my_addr(sock, ev);
201 title = talloc_asprintf(s, "conn[%s] c[%s:%u] s[%s:%u] server_id[%s]",
202 stream_socket->ops->name,
203 c->addr, c->port, s->addr, s->port,
204 cluster_id_string(s, server_id));
206 stream_connection_set_title(srv_conn, title);
212 /* we're now ready to start receiving events on this stream */
213 EVENT_FD_READABLE(srv_conn->event.fde);
215 /* call the server specific accept code */
216 stream_socket->ops->accept_connection(srv_conn);
221 called when someone opens a connection to one of our listening ports
223 static void stream_accept_handler(struct event_context *ev, struct fd_event *fde,
224 uint16_t flags, void *private)
226 struct stream_socket *stream_socket = talloc_get_type(private, struct stream_socket);
228 /* ask the process model to create us a process for this new
229 connection. When done, it calls stream_new_connection()
230 with the newly created socket */
231 stream_socket->model_ops->accept_connection(ev, stream_socket->lp_ctx,
233 stream_new_connection, stream_socket);
237 setup a listen stream socket
238 if you pass *port == 0, then a port > 1024 is used
240 FIXME: This function is TCP/IP specific - uses an int rather than
241 a string for the port. Should leave allocating a port nr
242 to the socket implementation - JRV20070903
244 NTSTATUS stream_setup_socket(struct event_context *event_context,
245 struct loadparm_context *lp_ctx,
246 const struct model_ops *model_ops,
247 const struct stream_server_ops *stream_ops,
249 const char *sock_addr,
251 const char *socket_options,
255 struct stream_socket *stream_socket;
256 struct socket_address *socket_address;
259 stream_socket = talloc_zero(event_context, struct stream_socket);
260 NT_STATUS_HAVE_NO_MEMORY(stream_socket);
262 status = socket_create(family, SOCKET_TYPE_STREAM, &stream_socket->sock, 0);
263 NT_STATUS_NOT_OK_RETURN(status);
265 talloc_steal(stream_socket, stream_socket->sock);
267 stream_socket->lp_ctx = talloc_reference(stream_socket, lp_ctx);
269 /* ready to listen */
270 status = socket_set_option(stream_socket->sock, "SO_KEEPALIVE", NULL);
271 NT_STATUS_NOT_OK_RETURN(status);
273 if (socket_options != NULL) {
274 status = socket_set_option(stream_socket->sock, socket_options, NULL);
275 NT_STATUS_NOT_OK_RETURN(status);
278 /* TODO: set socket ACL's (host allow etc) here when they're
281 /* Some sockets don't have a port, or are just described from
282 * the string. We are indicating this by having port == NULL */
284 socket_address = socket_address_from_strings(stream_socket,
285 stream_socket->sock->backend_name,
287 NT_STATUS_HAVE_NO_MEMORY(socket_address);
288 status = socket_listen(stream_socket->sock, socket_address, SERVER_LISTEN_BACKLOG, 0);
289 talloc_free(socket_address);
291 } else if (*port == 0) {
292 for (i=SERVER_TCP_LOW_PORT;i<= SERVER_TCP_HIGH_PORT;i++) {
293 socket_address = socket_address_from_strings(stream_socket,
294 stream_socket->sock->backend_name,
296 NT_STATUS_HAVE_NO_MEMORY(socket_address);
297 status = socket_listen(stream_socket->sock, socket_address,
298 SERVER_LISTEN_BACKLOG, 0);
299 talloc_free(socket_address);
300 if (NT_STATUS_IS_OK(status)) {
306 socket_address = socket_address_from_strings(stream_socket,
307 stream_socket->sock->backend_name,
309 NT_STATUS_HAVE_NO_MEMORY(socket_address);
310 status = socket_listen(stream_socket->sock, socket_address, SERVER_LISTEN_BACKLOG, 0);
311 talloc_free(socket_address);
314 if (!NT_STATUS_IS_OK(status)) {
315 DEBUG(0,("Failed to listen on %s:%u - %s\n",
316 sock_addr, *port, nt_errstr(status)));
317 talloc_free(stream_socket);
321 /* By specifying EVENT_FD_AUTOCLOSE below, we indicate that we
322 * will close the socket using the events system. This avoids
323 * nasty interactions with waiting for talloc to close the socket. */
325 socket_set_flags(stream_socket->sock, SOCKET_FLAG_NOCLOSE);
327 /* Add the FD from the newly created socket into the event
328 * subsystem. it will call the accept handler whenever we get
331 event_add_fd(event_context, stream_socket->sock,
332 socket_get_fd(stream_socket->sock),
333 EVENT_FD_READ|EVENT_FD_AUTOCLOSE,
334 stream_accept_handler, stream_socket);
336 stream_socket->private = talloc_reference(stream_socket, private);
337 stream_socket->ops = stream_ops;
338 stream_socket->event_ctx = event_context;
339 stream_socket->model_ops = model_ops;
345 setup a connection title
347 void stream_connection_set_title(struct stream_connection *conn, const char *title)
349 conn->model_ops->set_title(conn->event.ctx, title);