src/daemon.c

   1
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is guacd.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Michael Jumper.
  19  * Portions created by the Initial Developer are Copyright (C) 2010
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #include <unistd.h>
  39 #include <stdlib.h>
  40 #include <stdio.h>
  41 #include <string.h>
  42 #include <signal.h>
  43 #include <sys/types.h>
  44
  45 #include <sys/socket.h>
  46 #include <netdb.h>
  47 #include <netinet/in.h>
  48
  49 #include <errno.h>
  50 #include <syslog.h>
  51
  52 #include <guacamole/client.h>
  53 #include <guacamole/error.h>
  54
  55 #include "client.h"
  56 #include "log.h"
  57
  58 void guacd_handle_connection(int fd) {
  59
  60     guac_client* client;
  61     guac_client_plugin* plugin;
  62     guac_instruction* select;
  63     guac_instruction* connect;
  64
  65     /* Open guac_socket */
  66     guac_socket* socket = guac_socket_open(fd);
  67
  68     /* Get protocol from select instruction */
  69     select = guac_protocol_expect_instruction(
  70             socket, GUACD_USEC_TIMEOUT, "select");
  71     if (select == NULL) {
  72
  73         /* Log error */
  74         guacd_log_guac_error("Error reading \"select\"");
  75
  76         /* Free resources */
  77         guac_socket_close(socket);
  78         return;
  79     }
  80
  81     /* Validate args to select */
  82     if (select->argc != 1) {
  83
  84         /* Log error */
  85         syslog(LOG_ERR, "Bad number of arguments to \"select\" (%i)",
  86                 select->argc);
  87
  88         /* Free resources */
  89         guac_socket_close(socket);
  90         return;
  91     }
  92
  93     syslog(LOG_INFO, "Protocol \"%s\" selected", select->argv[0]);
  94
  95     /* Get plugin from protocol in select */
  96     plugin = guac_client_plugin_open(select->argv[0]);
  97     guac_instruction_free(select);
  98
  99     if (plugin == NULL) {
 100
 101         /* Log error */
 102         guacd_log_guac_error("Error loading client plugin");
 103
 104         /* Free resources */
 105         guac_socket_close(socket);
 106         return;
 107     }
 108
 109     /* Send args response */
 110     if (guac_protocol_send_args(socket, plugin->args)
 111             || guac_socket_flush(socket)) {
 112
 113         /* Log error */
 114         guacd_log_guac_error("Error sending \"args\"");
 115
 116         if (guac_client_plugin_close(plugin))
 117             guacd_log_guac_error("Error closing client plugin");
 118
 119         guac_socket_close(socket);
 120         return;
 121     }
 122
 123     /* Get args from connect instruction */
 124     connect = guac_protocol_expect_instruction(
 125             socket, GUACD_USEC_TIMEOUT, "connect");
 126     if (connect == NULL) {
 127
 128         /* Log error */
 129         guacd_log_guac_error("Error reading \"connect\"");
 130
 131         if (guac_client_plugin_close(plugin))
 132             guacd_log_guac_error("Error closing client plugin");
 133
 134         guac_socket_close(socket);
 135         return;
 136     }
 137
 138     /* Load and init client */
 139     client = guac_client_plugin_get_client(plugin, socket,
 140             connect->argc, connect->argv);
 141     guac_instruction_free(connect);
 142
 143     if (client == NULL) {
 144
 145         guacd_log_guac_error("Error instantiating client");
 146
 147         if (guac_client_plugin_close(plugin))
 148             guacd_log_guac_error("Error closing client plugin");
 149
 150         guac_socket_close(socket);
 151         return;
 152     }
 153
 154     /* Set up logging in client */
 155     client->log_info_handler  = guacd_log_info;
 156     client->log_error_handler = guacd_log_error;
 157
 158     /* Start client threads */
 159     syslog(LOG_INFO, "Starting client");
 160     if (guacd_client_start(client))
 161         syslog(LOG_ERR, "Client finished abnormally");
 162     else
 163         syslog(LOG_INFO, "Client finished normally");
 164
 165     /* Clean up */
 166     guac_client_free(client);
 167     if (guac_client_plugin_close(plugin))
 168         syslog(LOG_ERR, "Error closing client plugin");
 169
 170     /* Close socket */
 171     guac_socket_close(socket);
 172
 173     return;
 174
 175 }
 176
 177 int main(int argc, char* argv[]) {
 178
 179     /* Server */
 180     int socket_fd;
 181     struct addrinfo* addresses;
 182     struct addrinfo* current_address;
 183     char bound_address[1024];
 184     char bound_port[64];
 185     int opt_on = 1;
 186
 187     /* Client */
 188     struct sockaddr_in client_addr;
 189     socklen_t client_addr_len;
 190     int connected_socket_fd;
 191
 192     /* Arguments */
 193     char* listen_address = NULL; /* Default address of INADDR_ANY */
 194     char* listen_port = "4822";  /* Default port */
 195     char* pidfile = NULL;
 196     int opt;
 197
 198     /* General */
 199     int retval;
 200
 201     /* Daemon Process */
 202     pid_t daemon_pid;
 203
 204     /* Parse arguments */
 205     while ((opt = getopt(argc, argv, "l:b:p:")) != -1) {
 206         if (opt == 'l') {
 207             listen_port = strdup(optarg);
 208         }
 209         else if (opt == 'b') {
 210             listen_address = strdup(optarg);
 211         }
 212         else if (opt == 'p') {
 213             pidfile = strdup(optarg);
 214         }
 215         else {
 216
 217             fprintf(stderr, "USAGE: %s"
 218                     " [-l LISTENPORT]"
 219                     " [-b LISTENADDRESS]"
 220                     " [-p PIDFILE]\n", argv[0]);
 221
 222             exit(EXIT_FAILURE);
 223         }
 224     }
 225
 226     /* Get addresses for binding */
 227     if ((retval = getaddrinfo(listen_address, listen_port, NULL, &addresses))) {
 228         fprintf(stderr, "Error parsing given address or port: %s\n",
 229                 gai_strerror(retval));
 230         exit(EXIT_FAILURE);
 231     }
 232
 233     /* Get socket */
 234     socket_fd = socket(AF_INET, SOCK_STREAM, 0);
 235     if (socket_fd < 0) {
 236         fprintf(stderr, "Error opening socket: %s\n", strerror(errno));
 237         exit(EXIT_FAILURE);
 238     }
 239
 240     /* Allow socket reuse */
 241     if (setsockopt(socket_fd, SOL_SOCKET, SO_REUSEADDR, (void*) &opt_on, sizeof(opt_on))) {
 242         fprintf(stderr, "Warning: Unable to set socket options for reuse: %s\n", strerror(errno));
 243     }
 244
 245     /* Attempt binding of each address until success */
 246     current_address = addresses;
 247     while (current_address != NULL) {
 248
 249         /* Attempt to bind socket to address */
 250         if (bind(socket_fd,
 251                     current_address->ai_addr,
 252                     current_address->ai_addrlen) == 0) {
 253
 254             /* Done if successful bind */
 255             break;
 256
 257         }
 258
 259         /* Otherwise log error */
 260         else
 261             fprintf(stderr, "Error binding socket: %s\n", strerror(errno));
 262
 263         current_address = current_address->ai_next;
 264
 265     }
 266
 267     /* If unable to bind to anything, fail */
 268     if (current_address == NULL) {
 269         fprintf(stderr, "Unable to bind socket to any addresses.\n");
 270         exit(EXIT_FAILURE);
 271     }
 272
 273     /* Fork into background */
 274     daemon_pid = fork();
 275
 276     /* If error, fail */
 277     if (daemon_pid == -1) {
 278         fprintf(stderr, "Error forking daemon process: %s\n", strerror(errno));
 279         exit(EXIT_FAILURE);
 280     }
 281
 282     /* If parent, write PID file and exit */
 283     else if (daemon_pid != 0) {
 284
 285         if (pidfile != NULL) {
 286
 287             /* Attempt to open pidfile and write PID */
 288             FILE* pidf = fopen(pidfile, "w");
 289             if (pidf) {
 290                 fprintf(pidf, "%d\n", daemon_pid);
 291                 fclose(pidf);
 292             }
 293
 294             /* Warn on failure */
 295             else {
 296                 fprintf(stderr, "WARNING: Could not write PID file: %s\n", strerror(errno));
 297                 exit(EXIT_FAILURE);
 298             }
 299
 300         }
 301
 302         exit(EXIT_SUCCESS);
 303     }
 304
 305     /* Open log */
 306     openlog(NULL, LOG_PID, LOG_DAEMON);
 307
 308     /* Ignore SIGPIPE */
 309     if (signal(SIGPIPE, SIG_IGN) == SIG_ERR) {
 310         syslog(LOG_ERR, "Could not set handler for SIGPIPE to ignore. SIGPIPE may cause termination of the daemon.");
 311     }
 312
 313     /* Ignore SIGCHLD (force automatic removal of children) */
 314     if (signal(SIGCHLD, SIG_IGN) == SIG_ERR) {
 315         syslog(LOG_ERR, "Could not set handler for SIGCHLD to ignore. Child processes may pile up in the process table.");
 316     }
 317
 318     /* Log address and port */
 319     if (getnameinfo(current_address->ai_addr, current_address->ai_addrlen,
 320             bound_address, sizeof(bound_address),
 321             bound_port, sizeof(bound_port),
 322             0))
 323         syslog(LOG_WARNING, "Could not resolve name of listening host.");
 324     else
 325         syslog(LOG_INFO,
 326                 "Listening on host %s, port %s", bound_address, bound_port);
 327
 328     /* Free addresses */
 329     freeaddrinfo(addresses);
 330
 331     /* Daemon loop */
 332     for (;;) {
 333
 334         pid_t child_pid;
 335
 336         /* Listen for connections */
 337         if (listen(socket_fd, 5) < 0) {
 338             syslog(LOG_ERR, "Could not listen on socket: %s", strerror(errno));
 339             return 3;
 340         }
 341
 342         /* Accept connection */
 343         client_addr_len = sizeof(client_addr);
 344         connected_socket_fd = accept(socket_fd, (struct sockaddr*) &client_addr, &client_addr_len);
 345         if (connected_socket_fd < 0) {
 346             syslog(LOG_ERR, "Could not accept client connection: %s", strerror(errno));
 347             return 3;
 348         }
 349
 350         /*
 351          * Once connection is accepted, send child into background.
 352          *
 353          * Note that we prefer fork() over threads for connection-handling
 354          * processes as they give each connection its own memory area, and
 355          * isolate the main daemon and other connections from errors in any
 356          * particular client plugin.
 357          */
 358
 359         child_pid = fork();
 360
 361         /* If error, log */
 362         if (child_pid == -1)
 363             syslog(LOG_ERR, "Error forking child process: %s\n", strerror(errno));
 364
 365         /* If child, start client, and exit when finished */
 366         else if (child_pid == 0) {
 367             guacd_handle_connection(connected_socket_fd);
 368             close(connected_socket_fd);
 369             return 0;
 370         }
 371
 372         /* If parent, close reference to child's descriptor */
 373         else if (close(connected_socket_fd) < 0) {
 374             syslog(LOG_ERR, "Error closing daemon reference to child descriptor: %s", strerror(errno));
 375         }
 376
 377     }
 378
 379     /* Close socket */
 380     if (close(socket_fd) < 0) {
 381         syslog(LOG_ERR, "Could not close socket: %s", strerror(errno));
 382         return 3;
 383     }
 384
 385     return 0;
 386
 387 }
 388