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 event_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 event_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         srv_conn->terminate = reason;
  65
  66         if (srv_conn->processing) {
  67                 /*
  68                  * if we're currently inside the stream_io_handler(),
  69                  * defer the termination to the end of stream_io_hendler()
  70                  *
  71                  * and we don't want to read or write to the connection...
  72                  */
  73                 event_set_fd_flags(srv_conn->event.fde, 0);
  74                 return;
  75         }
  76
  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);
  81 }
  82
  83 /**
  84   the select loop has indicated that a stream is ready for IO
  85 */
  86 static void stream_io_handler(struct stream_connection *conn, uint16_t flags)
  87 {
  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);
  93         }
  94         conn->processing = false;
  95
  96         if (conn->terminate) {
  97                 stream_terminate_connection(conn, conn->terminate);
  98         }
  99 }
 100
 101 static void stream_io_handler_fde(struct event_context *ev, struct fd_event *fde,
 102                                   uint16_t flags, void *private)
 103 {
 104         struct stream_connection *conn = talloc_get_type(private,
 105                                                          struct stream_connection);
 106         stream_io_handler(conn, flags);
 107 }
 108
 109 void stream_io_handler_callback(void *private, uint16_t flags)
 110 {
 111         struct stream_connection *conn = talloc_get_type(private,
 112                                                          struct stream_connection);
 113         stream_io_handler(conn, flags);
 114 }
 115
 116 /*
 117   this creates a stream_connection from an already existing connection,
 118   used for protocols, where a client connection needs to switched into
 119   a server connection
 120 */
 121 NTSTATUS stream_new_connection_merge(struct event_context *ev,
 122                                      struct loadparm_context *lp_ctx,
 123                                      const struct model_ops *model_ops,
 124                                      struct socket_context *sock,
 125                                      const struct stream_server_ops *stream_ops,
 126                                      struct messaging_context *msg_ctx,
 127                                      void *private_data,
 128                                      struct stream_connection **_srv_conn)
 129 {
 130         struct stream_connection *srv_conn;
 131
 132         srv_conn = talloc_zero(ev, struct stream_connection);
 133         NT_STATUS_HAVE_NO_MEMORY(srv_conn);
 134
 135         talloc_steal(srv_conn, sock);
 136
 137         srv_conn->private       = private_data;
 138         srv_conn->model_ops     = model_ops;
 139         srv_conn->socket        = sock;
 140         srv_conn->server_id     = cluster_id(0, 0);
 141         srv_conn->ops           = stream_ops;
 142         srv_conn->msg_ctx       = msg_ctx;
 143         srv_conn->event.ctx     = ev;
 144         srv_conn->lp_ctx        = lp_ctx;
 145         srv_conn->event.fde     = event_add_fd(ev, srv_conn, socket_get_fd(sock),
 146                                                EVENT_FD_READ,
 147                                                stream_io_handler_fde, srv_conn);
 148         *_srv_conn = srv_conn;
 149         return NT_STATUS_OK;
 150 }
 151
 152 /*
 153   called when a new socket connection has been established. This is called in the process
 154   context of the new process (if appropriate)
 155 */
 156 static void stream_new_connection(struct event_context *ev,
 157                                   struct loadparm_context *lp_ctx,
 158                                   struct socket_context *sock,
 159                                   struct server_id server_id, void *private)
 160 {
 161         struct stream_socket *stream_socket = talloc_get_type(private, struct stream_socket);
 162         struct stream_connection *srv_conn;
 163         struct socket_address *c, *s;
 164
 165         srv_conn = talloc_zero(ev, struct stream_connection);
 166         if (!srv_conn) {
 167                 DEBUG(0,("talloc(mem_ctx, struct stream_connection) failed\n"));
 168                 return;
 169         }
 170
 171         talloc_steal(srv_conn, sock);
 172
 173         srv_conn->private       = stream_socket->private;
 174         srv_conn->model_ops     = stream_socket->model_ops;
 175         srv_conn->socket        = sock;
 176         srv_conn->server_id     = server_id;
 177         srv_conn->ops           = stream_socket->ops;
 178         srv_conn->event.ctx     = ev;
 179         srv_conn->lp_ctx        = lp_ctx;
 180         srv_conn->event.fde     = event_add_fd(ev, srv_conn, socket_get_fd(sock),
 181                                                0, stream_io_handler_fde, srv_conn);
 182
 183         if (!socket_check_access(sock, "smbd", lp_hostsallow(NULL, lp_default_service(lp_ctx)), lp_hostsdeny(NULL, lp_default_service(lp_ctx)))) {
 184                 stream_terminate_connection(srv_conn, "denied by access rules");
 185                 return;
 186         }
 187
 188         /* setup to receive internal messages on this connection */
 189         srv_conn->msg_ctx = messaging_init(srv_conn,
 190                                            lp_messaging_path(srv_conn, lp_ctx),
 191                                            srv_conn->server_id,
 192                                            lp_iconv_convenience(lp_ctx),
 193                                            ev);
 194         if (!srv_conn->msg_ctx) {
 195                 stream_terminate_connection(srv_conn, "messaging_init() failed");
 196                 return;
 197         }
 198
 199         c = socket_get_peer_addr(sock, ev);
 200         s = socket_get_my_addr(sock, ev);
 201         if (s && c) {
 202                 const char *title;
 203                 title = talloc_asprintf(s, "conn[%s] c[%s:%u] s[%s:%u] server_id[%s]",
 204                                         stream_socket->ops->name,
 205                                         c->addr, c->port, s->addr, s->port,
 206                                         cluster_id_string(s, server_id));
 207                 if (title) {
 208                         stream_connection_set_title(srv_conn, title);
 209                 }
 210         }
 211         talloc_free(c);
 212         talloc_free(s);
 213
 214         /* we're now ready to start receiving events on this stream */
 215         EVENT_FD_READABLE(srv_conn->event.fde);
 216
 217         /* call the server specific accept code */
 218         stream_socket->ops->accept_connection(srv_conn);
 219 }
 220
 221
 222 /*
 223   called when someone opens a connection to one of our listening ports
 224 */
 225 static void stream_accept_handler(struct event_context *ev, struct fd_event *fde,
 226                                   uint16_t flags, void *private)
 227 {
 228         struct stream_socket *stream_socket = talloc_get_type(private, struct stream_socket);
 229
 230         /* ask the process model to create us a process for this new
 231            connection.  When done, it calls stream_new_connection()
 232            with the newly created socket */
 233         stream_socket->model_ops->accept_connection(ev, stream_socket->lp_ctx,
 234                                                     stream_socket->sock,
 235                                                     stream_new_connection, stream_socket);
 236 }
 237
 238 /*
 239   setup a listen stream socket
 240   if you pass *port == 0, then a port > 1024 is used
 241
 242   FIXME: This function is TCP/IP specific - uses an int rather than
 243          a string for the port. Should leave allocating a port nr
 244          to the socket implementation - JRV20070903
 245  */
 246 NTSTATUS stream_setup_socket(struct event_context *event_context,
 247                              struct loadparm_context *lp_ctx,
 248                              const struct model_ops *model_ops,
 249                              const struct stream_server_ops *stream_ops,
 250                              const char *family,
 251                              const char *sock_addr,
 252                              uint16_t *port,
 253                              const char *socket_options,
 254                              void *private)
 255 {
 256         NTSTATUS status;
 257         struct stream_socket *stream_socket;
 258         struct socket_address *socket_address;
 259         int i;
 260
 261         stream_socket = talloc_zero(event_context, struct stream_socket);
 262         NT_STATUS_HAVE_NO_MEMORY(stream_socket);
 263
 264         status = socket_create(family, SOCKET_TYPE_STREAM, &stream_socket->sock, 0);
 265         NT_STATUS_NOT_OK_RETURN(status);
 266
 267         talloc_steal(stream_socket, stream_socket->sock);
 268
 269         stream_socket->lp_ctx = talloc_reference(stream_socket, lp_ctx);
 270
 271         /* ready to listen */
 272         status = socket_set_option(stream_socket->sock, "SO_KEEPALIVE", NULL);
 273         NT_STATUS_NOT_OK_RETURN(status);
 274
 275         if (socket_options != NULL) {
 276                 status = socket_set_option(stream_socket->sock, socket_options, NULL);
 277                 NT_STATUS_NOT_OK_RETURN(status);
 278         }
 279
 280         /* TODO: set socket ACL's (host allow etc) here when they're
 281          * implemented */
 282
 283         /* Some sockets don't have a port, or are just described from
 284          * the string.  We are indicating this by having port == NULL */
 285         if (!port) {
 286                 socket_address = socket_address_from_strings(stream_socket,
 287                                                              stream_socket->sock->backend_name,
 288                                                              sock_addr, 0);
 289                 NT_STATUS_HAVE_NO_MEMORY(socket_address);
 290                 status = socket_listen(stream_socket->sock, socket_address, SERVER_LISTEN_BACKLOG, 0);
 291                 talloc_free(socket_address);
 292
 293         } else if (*port == 0) {
 294                 for (i=SERVER_TCP_LOW_PORT;i<= SERVER_TCP_HIGH_PORT;i++) {
 295                         socket_address = socket_address_from_strings(stream_socket,
 296                                                                      stream_socket->sock->backend_name,
 297                                                                      sock_addr, i);
 298                         NT_STATUS_HAVE_NO_MEMORY(socket_address);
 299                         status = socket_listen(stream_socket->sock, socket_address,
 300                                                SERVER_LISTEN_BACKLOG, 0);
 301                         talloc_free(socket_address);
 302                         if (NT_STATUS_IS_OK(status)) {
 303                                 *port = i;
 304                                 break;
 305                         }
 306                 }
 307         } else {
 308                 socket_address = socket_address_from_strings(stream_socket,
 309                                                              stream_socket->sock->backend_name,
 310                                                              sock_addr, *port);
 311                 NT_STATUS_HAVE_NO_MEMORY(socket_address);
 312                 status = socket_listen(stream_socket->sock, socket_address, SERVER_LISTEN_BACKLOG, 0);
 313                 talloc_free(socket_address);
 314         }
 315
 316         if (!NT_STATUS_IS_OK(status)) {
 317                 DEBUG(0,("Failed to listen on %s:%u - %s\n",
 318                         sock_addr, *port, nt_errstr(status)));
 319                 talloc_free(stream_socket);
 320                 return status;
 321         }
 322
 323         /* By specifying EVENT_FD_AUTOCLOSE below, we indicate that we
 324          * will close the socket using the events system.  This avoids
 325          * nasty interactions with waiting for talloc to close the socket. */
 326
 327         socket_set_flags(stream_socket->sock, SOCKET_FLAG_NOCLOSE);
 328
 329         /* Add the FD from the newly created socket into the event
 330          * subsystem.  it will call the accept handler whenever we get
 331          * new connections */
 332
 333         event_add_fd(event_context, stream_socket->sock,
 334                      socket_get_fd(stream_socket->sock),
 335                      EVENT_FD_READ|EVENT_FD_AUTOCLOSE,
 336                      stream_accept_handler, stream_socket);
 337
 338         stream_socket->private          = talloc_reference(stream_socket, private);
 339         stream_socket->ops              = stream_ops;
 340         stream_socket->event_ctx        = event_context;
 341         stream_socket->model_ops        = model_ops;
 342
 343         return NT_STATUS_OK;
 344 }
 345
 346 /*
 347   setup a connection title
 348 */
 349 void stream_connection_set_title(struct stream_connection *conn, const char *title)
 350 {
 351         conn->model_ops->set_title(conn->event.ctx, title);
 352 }