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
  32 /* the range of ports to try for dcerpc over tcp endpoints */
  33 #define SERVER_TCP_LOW_PORT  1024
  34 #define SERVER_TCP_HIGH_PORT 1300
  35
  36 /* size of listen() backlog in smbd */
  37 #define SERVER_LISTEN_BACKLOG 10
  38
  39
  40 /*
  41   private structure for a single listening stream socket
  42 */
  43 struct stream_socket {
  44         const struct stream_server_ops *ops;
  45         struct event_context *event_ctx;
  46         const struct model_ops *model_ops;
  47         struct socket_context *sock;
  48         void *private;
  49 };
  50
  51
  52 /*
  53   close the socket and shutdown a stream_connection
  54 */
  55 void stream_terminate_connection(struct stream_connection *srv_conn, const char *reason)
  56 {
  57         struct event_context *event_ctx = srv_conn->event.ctx;
  58         const struct model_ops *model_ops = srv_conn->model_ops;
  59
  60         if (!reason) reason = "unknown reason";
  61
  62         srv_conn->terminate = reason;
  63
  64         if (srv_conn->processing) {
  65                 /*
  66                  * if we're currently inside the stream_io_handler(),
  67                  * defer the termination to the end of stream_io_hendler()
  68                  *
  69                  * and we don't want to read or write to the connection...
  70                  */
  71                 event_set_fd_flags(srv_conn->event.fde, 0);
  72                 return;
  73         }
  74
  75         talloc_free(srv_conn->event.fde);
  76         srv_conn->event.fde = NULL;
  77         talloc_free(srv_conn);
  78         model_ops->terminate(event_ctx, reason);
  79 }
  80
  81 /*
  82   the select loop has indicated that a stream is ready for IO
  83 */
  84 static void stream_io_handler(struct stream_connection *conn, uint16_t flags)
  85 {
  86         conn->processing = True;
  87         if (flags & EVENT_FD_WRITE) {
  88                 conn->ops->send_handler(conn, flags);
  89         } else if (flags & EVENT_FD_READ) {
  90                 conn->ops->recv_handler(conn, flags);
  91         }
  92         conn->processing = False;
  93
  94         if (conn->terminate) {
  95                 stream_terminate_connection(conn, conn->terminate);
  96         }
  97 }
  98
  99 static void stream_io_handler_fde(struct event_context *ev, struct fd_event *fde,
 100                                   uint16_t flags, void *private)
 101 {
 102         struct stream_connection *conn = talloc_get_type(private,
 103                                                          struct stream_connection);
 104         stream_io_handler(conn, flags);
 105 }
 106
 107 void stream_io_handler_callback(void *private, uint16_t flags)
 108 {
 109         struct stream_connection *conn = talloc_get_type(private,
 110                                                          struct stream_connection);
 111         stream_io_handler(conn, flags);
 112 }
 113
 114 /*
 115   this creates a stream_connection from an already existing connection,
 116   used for protocols, where a client connection needs to switched into
 117   a server connection
 118 */
 119 NTSTATUS stream_new_connection_merge(struct event_context *ev,
 120                                      const struct model_ops *model_ops,
 121                                      struct socket_context *sock,
 122                                      const struct stream_server_ops *stream_ops,
 123                                      struct messaging_context *msg_ctx,
 124                                      void *private_data,
 125                                      struct stream_connection **_srv_conn)
 126 {
 127         struct stream_connection *srv_conn;
 128
 129         srv_conn = talloc_zero(ev, struct stream_connection);
 130         NT_STATUS_HAVE_NO_MEMORY(srv_conn);
 131
 132         talloc_steal(srv_conn, sock);
 133
 134         srv_conn->private       = private_data;
 135         srv_conn->model_ops     = model_ops;
 136         srv_conn->socket        = sock;
 137         srv_conn->server_id     = cluster_id(0);
 138         srv_conn->ops           = stream_ops;
 139         srv_conn->msg_ctx       = msg_ctx;
 140         srv_conn->event.ctx     = ev;
 141         srv_conn->event.fde     = event_add_fd(ev, srv_conn, socket_get_fd(sock),
 142                                                EVENT_FD_READ,
 143                                                stream_io_handler_fde, srv_conn);
 144         *_srv_conn = srv_conn;
 145         return NT_STATUS_OK;
 146 }
 147
 148 /*
 149   called when a new socket connection has been established. This is called in the process
 150   context of the new process (if appropriate)
 151 */
 152 static void stream_new_connection(struct event_context *ev,
 153                                   struct socket_context *sock,
 154                                   struct server_id server_id, void *private)
 155 {
 156         struct stream_socket *stream_socket = talloc_get_type(private, struct stream_socket);
 157         struct stream_connection *srv_conn;
 158         struct socket_address *c, *s;
 159
 160         srv_conn = talloc_zero(ev, struct stream_connection);
 161         if (!srv_conn) {
 162                 DEBUG(0,("talloc(mem_ctx, struct stream_connection) failed\n"));
 163                 return;
 164         }
 165
 166         talloc_steal(srv_conn, sock);
 167
 168         srv_conn->private       = stream_socket->private;
 169         srv_conn->model_ops     = stream_socket->model_ops;
 170         srv_conn->socket        = sock;
 171         srv_conn->server_id     = server_id;
 172         srv_conn->ops           = stream_socket->ops;
 173         srv_conn->event.ctx     = ev;
 174         srv_conn->event.fde     = event_add_fd(ev, srv_conn, socket_get_fd(sock),
 175                                                0, stream_io_handler_fde, srv_conn);
 176
 177         if (!socket_check_access(sock, "smbd", lp_hostsallow(-1), lp_hostsdeny(-1))) {
 178                 stream_terminate_connection(srv_conn, "denied by access rules");
 179                 return;
 180         }
 181
 182         /* setup to receive internal messages on this connection */
 183         srv_conn->msg_ctx = messaging_init(srv_conn, srv_conn->server_id, ev);
 184         if (!srv_conn->msg_ctx) {
 185                 stream_terminate_connection(srv_conn, "messaging_init() failed");
 186                 return;
 187         }
 188
 189         c = socket_get_peer_addr(sock, ev);
 190         s = socket_get_my_addr(sock, ev);
 191         if (s && c) {
 192                 const char *title;
 193                 title = talloc_asprintf(s, "conn[%s] c[%s:%u] s[%s:%u] server_id[%s]",
 194                                         stream_socket->ops->name,
 195                                         c->addr, c->port, s->addr, s->port,
 196                                         cluster_id_string(s, server_id));
 197                 if (title) {
 198                         stream_connection_set_title(srv_conn, title);
 199                 }
 200         }
 201         talloc_free(c);
 202         talloc_free(s);
 203
 204         /* we're now ready to start receiving events on this stream */
 205         EVENT_FD_READABLE(srv_conn->event.fde);
 206
 207         /* call the server specific accept code */
 208         stream_socket->ops->accept_connection(srv_conn);
 209 }
 210
 211
 212 /*
 213   called when someone opens a connection to one of our listening ports
 214 */
 215 static void stream_accept_handler(struct event_context *ev, struct fd_event *fde,
 216                                   uint16_t flags, void *private)
 217 {
 218         struct stream_socket *stream_socket = talloc_get_type(private, struct stream_socket);
 219
 220         /* ask the process model to create us a process for this new
 221            connection.  When done, it calls stream_new_connection()
 222            with the newly created socket */
 223         stream_socket->model_ops->accept_connection(ev, stream_socket->sock,
 224                                                     stream_new_connection, stream_socket);
 225 }
 226
 227 /*
 228   setup a listen stream socket
 229   if you pass *port == 0, then a port > 1024 is used
 230
 231   FIXME: This function is TCP/IP specific - uses an int rather than
 232          a string for the port. Should leave allocating a port nr
 233          to the socket implementation - JRV20070903
 234  */
 235 NTSTATUS stream_setup_socket(struct event_context *event_context,
 236                              const struct model_ops *model_ops,
 237                              const struct stream_server_ops *stream_ops,
 238                              const char *family,
 239                              const char *sock_addr,
 240                              uint16_t *port,
 241                              void *private)
 242 {
 243         NTSTATUS status;
 244         struct stream_socket *stream_socket;
 245         struct socket_address *socket_address;
 246         int i;
 247
 248         stream_socket = talloc_zero(event_context, struct stream_socket);
 249         NT_STATUS_HAVE_NO_MEMORY(stream_socket);
 250
 251         status = socket_create(family, SOCKET_TYPE_STREAM, &stream_socket->sock, 0);
 252         NT_STATUS_NOT_OK_RETURN(status);
 253
 254         talloc_steal(stream_socket, stream_socket->sock);
 255
 256         /* ready to listen */
 257         status = socket_set_option(stream_socket->sock, "SO_KEEPALIVE", NULL);
 258         NT_STATUS_NOT_OK_RETURN(status);
 259
 260         status = socket_set_option(stream_socket->sock, lp_socket_options(), NULL);
 261         NT_STATUS_NOT_OK_RETURN(status);
 262
 263         /* TODO: set socket ACL's here when they're implemented */
 264
 265         if (*port == 0) {
 266                 for (i=SERVER_TCP_LOW_PORT;i<= SERVER_TCP_HIGH_PORT;i++) {
 267                         socket_address = socket_address_from_strings(stream_socket,
 268                                                                      stream_socket->sock->backend_name,
 269                                                                      sock_addr, i);
 270                         NT_STATUS_HAVE_NO_MEMORY(socket_address);
 271                         status = socket_listen(stream_socket->sock, socket_address,
 272                                                SERVER_LISTEN_BACKLOG, 0);
 273                         talloc_free(socket_address);
 274                         if (NT_STATUS_IS_OK(status)) {
 275                                 *port = i;
 276                                 break;
 277                         }
 278                 }
 279         } else {
 280                 socket_address = socket_address_from_strings(stream_socket,
 281                                                              stream_socket->sock->backend_name,
 282                                                              sock_addr, *port);
 283                 NT_STATUS_HAVE_NO_MEMORY(socket_address);
 284                 status = socket_listen(stream_socket->sock, socket_address, SERVER_LISTEN_BACKLOG, 0);
 285                 talloc_free(socket_address);
 286         }
 287
 288         if (!NT_STATUS_IS_OK(status)) {
 289                 DEBUG(0,("Failed to listen on %s:%u - %s\n",
 290                         sock_addr, *port, nt_errstr(status)));
 291                 talloc_free(stream_socket);
 292                 return status;
 293         }
 294
 295         /* we will close the socket using the events system */
 296         socket_set_flags(stream_socket->sock, SOCKET_FLAG_NOCLOSE);
 297
 298         event_add_fd(event_context, stream_socket->sock,
 299                      socket_get_fd(stream_socket->sock),
 300                      EVENT_FD_READ|EVENT_FD_AUTOCLOSE,
 301                      stream_accept_handler, stream_socket);
 302
 303         stream_socket->private          = talloc_reference(stream_socket, private);
 304         stream_socket->ops              = stream_ops;
 305         stream_socket->event_ctx        = event_context;
 306         stream_socket->model_ops        = model_ops;
 307
 308         return NT_STATUS_OK;
 309 }
 310
 311 /*
 312   setup a connection title
 313 */
 314 void stream_connection_set_title(struct stream_connection *conn, const char *title)
 315 {
 316         conn->model_ops->set_title(conn->event.ctx, title);
 317 }