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 2 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, write to the Free Software
  21    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  22 */
  23
  24 #include "includes.h"
  25 #include "process_model.h"
  26 #include "lib/events/events.h"
  27 #include "lib/socket/socket.h"
  28 #include "smbd/service_stream.h"
  29
  30 /* the range of ports to try for dcerpc over tcp endpoints */
  31 #define SERVER_TCP_LOW_PORT  1024
  32 #define SERVER_TCP_HIGH_PORT 1300
  33
  34 /* size of listen() backlog in smbd */
  35 #define SERVER_LISTEN_BACKLOG 10
  36
  37
  38 /*
  39   private structure for a single listening stream socket
  40 */
  41 struct stream_socket {
  42         const struct stream_server_ops *ops;
  43         struct event_context *event_ctx;
  44         const struct model_ops *model_ops;
  45         struct socket_context *sock;
  46         void *private;
  47 };
  48
  49
  50 /*
  51   close the socket and shutdown a stream_connection
  52 */
  53 void stream_terminate_connection(struct stream_connection *srv_conn, const char *reason)
  54 {
  55         struct event_context *event_ctx = srv_conn->event.ctx;
  56         const struct model_ops *model_ops = srv_conn->model_ops;
  57         talloc_free(srv_conn);
  58         model_ops->terminate(event_ctx, reason);
  59 }
  60
  61 /*
  62   the select loop has indicated that a stream is ready for IO
  63 */
  64 static void stream_io_handler(struct event_context *ev, struct fd_event *fde,
  65                               uint16_t flags, void *private)
  66 {
  67         struct stream_connection *conn = talloc_get_type(private,
  68                                                          struct stream_connection);
  69         if (flags & EVENT_FD_WRITE) {
  70                 conn->ops->send_handler(conn, flags);
  71                 return;
  72         }
  73
  74         if (flags & EVENT_FD_READ) {
  75                 conn->ops->recv_handler(conn, flags);
  76         }
  77 }
  78
  79
  80 /*
  81   called when a new socket connection has been established. This is called in the process
  82   context of the new process (if appropriate)
  83 */
  84 static void stream_new_connection(struct event_context *ev,
  85                                   struct socket_context *sock,
  86                                   uint32_t server_id, void *private)
  87 {
  88         struct stream_socket *stream_socket = talloc_get_type(private, struct stream_socket);
  89         struct stream_connection *srv_conn;
  90
  91         srv_conn = talloc_zero(ev, struct stream_connection);
  92         if (!srv_conn) {
  93                 DEBUG(0,("talloc(mem_ctx, struct stream_connection) failed\n"));
  94                 return;
  95         }
  96
  97         talloc_steal(srv_conn, sock);
  98
  99         srv_conn->private       = stream_socket->private;
 100         srv_conn->model_ops     = stream_socket->model_ops;
 101         srv_conn->socket        = sock;
 102         srv_conn->server_id     = server_id;
 103         srv_conn->ops           = stream_socket->ops;
 104         srv_conn->event.ctx     = ev;
 105         srv_conn->event.fde     = event_add_fd(ev, srv_conn, socket_get_fd(sock),
 106                                                EVENT_FD_READ,
 107                                                stream_io_handler, srv_conn);
 108
 109         if (!socket_check_access(sock, "smbd", lp_hostsallow(-1), lp_hostsdeny(-1))) {
 110                 stream_terminate_connection(srv_conn, "denied by access rules");
 111                 return;
 112         }
 113
 114         /* setup to receive internal messages on this connection */
 115         srv_conn->msg_ctx = messaging_init(srv_conn, srv_conn->server_id, ev);
 116         if (!srv_conn->msg_ctx) {
 117                 stream_terminate_connection(srv_conn, "messaging_init() failed");
 118                 return;
 119         }
 120
 121         /* call the server specific accept code */
 122         stream_socket->ops->accept_connection(srv_conn);
 123 }
 124
 125
 126 /*
 127   called when someone opens a connection to one of our listening ports
 128 */
 129 static void stream_accept_handler(struct event_context *ev, struct fd_event *fde,
 130                                   uint16_t flags, void *private)
 131 {
 132         struct stream_socket *stream_socket = talloc_get_type(private, struct stream_socket);
 133
 134         /* ask the process model to create us a process for this new
 135            connection.  When done, it calls stream_new_connection()
 136            with the newly created socket */
 137         stream_socket->model_ops->accept_connection(ev, stream_socket->sock,
 138                                                     stream_new_connection, stream_socket);
 139 }
 140
 141
 142
 143 /*
 144   setup a listen stream socket
 145   if you pass *port == 0, then a port > 1024 is used
 146  */
 147 NTSTATUS stream_setup_socket(struct event_context *event_context,
 148                              const struct model_ops *model_ops,
 149                              const struct stream_server_ops *stream_ops,
 150                              const char *family,
 151                              const char *sock_addr,
 152                              uint16_t *port,
 153                              void *private)
 154 {
 155         NTSTATUS status;
 156         struct stream_socket *stream_socket;
 157         int i;
 158
 159         stream_socket = talloc_zero(event_context, struct stream_socket);
 160         NT_STATUS_HAVE_NO_MEMORY(stream_socket);
 161
 162         status = socket_create(family, SOCKET_TYPE_STREAM, &stream_socket->sock, 0);
 163         NT_STATUS_NOT_OK_RETURN(status);
 164
 165         talloc_steal(stream_socket, stream_socket->sock);
 166
 167         /* ready to listen */
 168         status = socket_set_option(stream_socket->sock, "SO_KEEPALIVE", NULL);
 169         NT_STATUS_NOT_OK_RETURN(status);
 170
 171         status = socket_set_option(stream_socket->sock, lp_socket_options(), NULL);
 172         NT_STATUS_NOT_OK_RETURN(status);
 173
 174         /* TODO: set socket ACL's here when they're implemented */
 175
 176         if (*port == 0) {
 177                 for (i=SERVER_TCP_LOW_PORT;i<= SERVER_TCP_HIGH_PORT;i++) {
 178                         status = socket_listen(stream_socket->sock, sock_addr, i,
 179                                                SERVER_LISTEN_BACKLOG, 0);
 180                         if (NT_STATUS_IS_OK(status)) {
 181                                 *port = i;
 182                                 break;
 183                         }
 184                 }
 185         } else {
 186                 status = socket_listen(stream_socket->sock, sock_addr, *port, SERVER_LISTEN_BACKLOG, 0);
 187         }
 188
 189         if (!NT_STATUS_IS_OK(status)) {
 190                 DEBUG(0,("Failed to listen on %s:%u - %s\n",
 191                         sock_addr, *port, nt_errstr(status)));
 192                 talloc_free(stream_socket);
 193                 return status;
 194         }
 195
 196         event_add_fd(event_context, stream_socket->sock,
 197                      socket_get_fd(stream_socket->sock),
 198                      EVENT_FD_READ, stream_accept_handler, stream_socket);
 199
 200         stream_socket->private          = talloc_reference(stream_socket, private);
 201         stream_socket->ops              = stream_ops;
 202         stream_socket->event_ctx        = event_context;
 203         stream_socket->model_ops        = model_ops;
 204
 205         return NT_STATUS_OK;
 206 }