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 <tevent.h>
  25 #include "process_model.h"
  26 #include "lib/messaging/irpc.h"
  27 #include "cluster/cluster.h"
  28 #include "param/param.h"
  29 #include "../lib/tsocket/tsocket.h"
  30
  31 /* the range of ports to try for dcerpc over tcp endpoints */
  32 #define SERVER_TCP_LOW_PORT  1024
  33 #define SERVER_TCP_HIGH_PORT 1300
  34
  35 /* size of listen() backlog in smbd */
  36 #define SERVER_LISTEN_BACKLOG 10
  37
  38
  39 /*
  40   private structure for a single listening stream socket
  41 */
  42 struct stream_socket {
  43         const struct stream_server_ops *ops;
  44         struct loadparm_context *lp_ctx;
  45         struct tevent_context *event_ctx;
  46         const struct model_ops *model_ops;
  47         struct socket_context *sock;
  48         void *private_data;
  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 tevent_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         DEBUG(3,("Terminating connection - '%s'\n", 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                 tevent_fd_set_flags(srv_conn->event.fde, 0);
  74                 return;
  75         }
  76
  77         talloc_free(srv_conn->event.fde);
  78         srv_conn->event.fde = NULL;
  79         model_ops->terminate(event_ctx, srv_conn->lp_ctx, reason);
  80         talloc_free(srv_conn);
  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++;
  89         if (flags & TEVENT_FD_WRITE) {
  90                 conn->ops->send_handler(conn, flags);
  91         } else if (flags & TEVENT_FD_READ) {
  92                 conn->ops->recv_handler(conn, flags);
  93         }
  94         conn->processing--;
  95
  96         if (conn->terminate) {
  97                 stream_terminate_connection(conn, conn->terminate);
  98         }
  99 }
 100
 101 void stream_io_handler_fde(struct tevent_context *ev, struct tevent_fd *fde,
 102                                   uint16_t flags, void *private_data)
 103 {
 104         struct stream_connection *conn = talloc_get_type(private_data,
 105                                                          struct stream_connection);
 106         stream_io_handler(conn, flags);
 107 }
 108
 109 void stream_io_handler_callback(void *private_data, uint16_t flags)
 110 {
 111         struct stream_connection *conn = talloc_get_type(private_data,
 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 tevent_context *ev,
 122                                      struct loadparm_context *lp_ctx,
 123                                      const struct model_ops *model_ops,
 124                                      const struct stream_server_ops *stream_ops,
 125                                      struct messaging_context *msg_ctx,
 126                                      void *private_data,
 127                                      struct stream_connection **_srv_conn)
 128 {
 129         struct stream_connection *srv_conn;
 130
 131         srv_conn = talloc_zero(ev, struct stream_connection);
 132         NT_STATUS_HAVE_NO_MEMORY(srv_conn);
 133
 134         srv_conn->private_data  = private_data;
 135         srv_conn->model_ops     = model_ops;
 136         srv_conn->socket        = NULL;
 137         srv_conn->server_id     = cluster_id(0, 0);
 138         srv_conn->ops           = stream_ops;
 139         srv_conn->msg_ctx       = msg_ctx;
 140         srv_conn->event.ctx     = ev;
 141         srv_conn->lp_ctx        = lp_ctx;
 142         srv_conn->event.fde     = NULL;
 143
 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 tevent_context *ev,
 153                                   struct loadparm_context *lp_ctx,
 154                                   struct socket_context *sock,
 155                                   struct server_id server_id, void *private_data)
 156 {
 157         struct stream_socket *stream_socket = talloc_get_type(private_data, struct stream_socket);
 158         struct stream_connection *srv_conn;
 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_data  = stream_socket->private_data;
 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->lp_ctx        = lp_ctx;
 175
 176         if (!socket_check_access(sock, "smbd", lpcfg_hostsallow(NULL, lpcfg_default_service(lp_ctx)), lpcfg_hostsdeny(NULL, lpcfg_default_service(lp_ctx)))) {
 177                 stream_terminate_connection(srv_conn, "denied by access rules");
 178                 return;
 179         }
 180
 181         srv_conn->event.fde     = tevent_add_fd(ev, srv_conn, socket_get_fd(sock),
 182                                                 0, stream_io_handler_fde, srv_conn);
 183         if (!srv_conn->event.fde) {
 184                 stream_terminate_connection(srv_conn, "tevent_add_fd() failed");
 185                 return;
 186         }
 187
 188         /* setup to receive internal messages on this connection */
 189         srv_conn->msg_ctx = messaging_init(srv_conn,
 190                                            lpcfg_messaging_path(srv_conn, lp_ctx),
 191                                            srv_conn->server_id, ev);
 192         if (!srv_conn->msg_ctx) {
 193                 stream_terminate_connection(srv_conn, "messaging_init() failed");
 194                 return;
 195         }
 196
 197         srv_conn->remote_address = socket_get_remote_addr(srv_conn->socket, srv_conn);
 198         if (!srv_conn->remote_address) {
 199                 stream_terminate_connection(srv_conn, "socket_get_remote_addr() failed");
 200                 return;
 201         }
 202
 203         srv_conn->local_address = socket_get_local_addr(srv_conn->socket, srv_conn);
 204         if (!srv_conn->local_address) {
 205                 stream_terminate_connection(srv_conn, "socket_get_local_addr() failed");
 206                 return;
 207         }
 208
 209         {
 210                 TALLOC_CTX *tmp_ctx;
 211                 const char *title;
 212
 213                 tmp_ctx = talloc_new(srv_conn);
 214
 215                 title = talloc_asprintf(tmp_ctx, "conn[%s] c[%s] s[%s] server_id[%s]",
 216                                         stream_socket->ops->name,
 217                                         tsocket_address_string(srv_conn->remote_address, tmp_ctx),
 218                                         tsocket_address_string(srv_conn->local_address, tmp_ctx),
 219                                         cluster_id_string(tmp_ctx, server_id));
 220                 if (title) {
 221                         stream_connection_set_title(srv_conn, title);
 222                 }
 223                 talloc_free(tmp_ctx);
 224         }
 225
 226         /* we're now ready to start receiving events on this stream */
 227         TEVENT_FD_READABLE(srv_conn->event.fde);
 228
 229         /* call the server specific accept code */
 230         stream_socket->ops->accept_connection(srv_conn);
 231 }
 232
 233
 234 /*
 235   called when someone opens a connection to one of our listening ports
 236 */
 237 static void stream_accept_handler(struct tevent_context *ev, struct tevent_fd *fde,
 238                                   uint16_t flags, void *private_data)
 239 {
 240         struct stream_socket *stream_socket = talloc_get_type(private_data, struct stream_socket);
 241
 242         /* ask the process model to create us a process for this new
 243            connection.  When done, it calls stream_new_connection()
 244            with the newly created socket */
 245         stream_socket->model_ops->accept_connection(ev, stream_socket->lp_ctx,
 246                                                     stream_socket->sock,
 247                                                     stream_new_connection, stream_socket);
 248 }
 249
 250 /*
 251   setup a listen stream socket
 252   if you pass *port == 0, then a port > 1024 is used
 253
 254   FIXME: This function is TCP/IP specific - uses an int rather than
 255          a string for the port. Should leave allocating a port nr
 256          to the socket implementation - JRV20070903
 257  */
 258 NTSTATUS stream_setup_socket(struct tevent_context *event_context,
 259                              struct loadparm_context *lp_ctx,
 260                              const struct model_ops *model_ops,
 261                              const struct stream_server_ops *stream_ops,
 262                              const char *family,
 263                              const char *sock_addr,
 264                              uint16_t *port,
 265                              const char *socket_options,
 266                              void *private_data)
 267 {
 268         NTSTATUS status;
 269         struct stream_socket *stream_socket;
 270         struct socket_address *socket_address;
 271         struct tevent_fd *fde;
 272         int i;
 273
 274         stream_socket = talloc_zero(event_context, struct stream_socket);
 275         NT_STATUS_HAVE_NO_MEMORY(stream_socket);
 276
 277         status = socket_create(family, SOCKET_TYPE_STREAM, &stream_socket->sock, 0);
 278         NT_STATUS_NOT_OK_RETURN(status);
 279
 280         talloc_steal(stream_socket, stream_socket->sock);
 281
 282         stream_socket->lp_ctx = talloc_reference(stream_socket, lp_ctx);
 283
 284         /* ready to listen */
 285         status = socket_set_option(stream_socket->sock, "SO_KEEPALIVE", NULL);
 286         NT_STATUS_NOT_OK_RETURN(status);
 287
 288         if (socket_options != NULL) {
 289                 status = socket_set_option(stream_socket->sock, socket_options, NULL);
 290                 NT_STATUS_NOT_OK_RETURN(status);
 291         }
 292
 293         /* TODO: set socket ACL's (host allow etc) here when they're
 294          * implemented */
 295
 296         /* Some sockets don't have a port, or are just described from
 297          * the string.  We are indicating this by having port == NULL */
 298         if (!port) {
 299                 socket_address = socket_address_from_strings(stream_socket,
 300                                                              stream_socket->sock->backend_name,
 301                                                              sock_addr, 0);
 302                 NT_STATUS_HAVE_NO_MEMORY(socket_address);
 303                 status = socket_listen(stream_socket->sock, socket_address, SERVER_LISTEN_BACKLOG, 0);
 304                 talloc_free(socket_address);
 305
 306         } else if (*port == 0) {
 307                 for (i=SERVER_TCP_LOW_PORT;i<= SERVER_TCP_HIGH_PORT;i++) {
 308                         socket_address = socket_address_from_strings(stream_socket,
 309                                                                      stream_socket->sock->backend_name,
 310                                                                      sock_addr, i);
 311                         NT_STATUS_HAVE_NO_MEMORY(socket_address);
 312                         status = socket_listen(stream_socket->sock, socket_address,
 313                                                SERVER_LISTEN_BACKLOG, 0);
 314                         talloc_free(socket_address);
 315                         if (NT_STATUS_IS_OK(status)) {
 316                                 *port = i;
 317                                 break;
 318                         }
 319                 }
 320         } else {
 321                 socket_address = socket_address_from_strings(stream_socket,
 322                                                              stream_socket->sock->backend_name,
 323                                                              sock_addr, *port);
 324                 NT_STATUS_HAVE_NO_MEMORY(socket_address);
 325                 status = socket_listen(stream_socket->sock, socket_address, SERVER_LISTEN_BACKLOG, 0);
 326                 talloc_free(socket_address);
 327         }
 328
 329         if (!NT_STATUS_IS_OK(status)) {
 330                 DEBUG(0,("Failed to listen on %s:%u - %s\n",
 331                          sock_addr, port ? (unsigned int)(*port) : 0,
 332                          nt_errstr(status)));
 333                 talloc_free(stream_socket);
 334                 return status;
 335         }
 336
 337         /* Add the FD from the newly created socket into the event
 338          * subsystem.  it will call the accept handler whenever we get
 339          * new connections */
 340
 341         fde = tevent_add_fd(event_context, stream_socket->sock,
 342                             socket_get_fd(stream_socket->sock),
 343                             TEVENT_FD_READ,
 344                             stream_accept_handler, stream_socket);
 345         if (!fde) {
 346                 DEBUG(0,("Failed to setup fd event\n"));
 347                 talloc_free(stream_socket);
 348                 return NT_STATUS_NO_MEMORY;
 349         }
 350
 351         /* we let events system to the close on the socket. This avoids
 352          * nasty interactions with waiting for talloc to close the socket. */
 353         tevent_fd_set_close_fn(fde, socket_tevent_fd_close_fn);
 354         socket_set_flags(stream_socket->sock, SOCKET_FLAG_NOCLOSE);
 355
 356         stream_socket->private_data     = talloc_reference(stream_socket, private_data);
 357         stream_socket->ops              = stream_ops;
 358         stream_socket->event_ctx        = event_context;
 359         stream_socket->model_ops        = model_ops;
 360
 361         return NT_STATUS_OK;
 362 }
 363
 364 /*
 365   setup a connection title
 366 */
 367 void stream_connection_set_title(struct stream_connection *conn, const char *title)
 368 {
 369         conn->model_ops->set_title(conn->event.ctx, title);
 370 }