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             guacd_client_log_info, guacd_client_log_error);
 142
 143     guac_instruction_free(connect);
 144
 145     if (client == NULL) {
 146
 147         guacd_log_guac_error("Error instantiating client");
 148
 149         if (guac_client_plugin_close(plugin))
 150             guacd_log_guac_error("Error closing client plugin");
 151
 152         guac_socket_close(socket);
 153         return;
 154     }
 155
 156     /* Start client threads */
 157     syslog(LOG_INFO, "Starting client");
 158     if (guacd_client_start(client))
 159         syslog(LOG_ERR, "Client finished abnormally");
 160     else
 161         syslog(LOG_INFO, "Client finished normally");
 162
 163     /* Clean up */
 164     guac_client_free(client);
 165     if (guac_client_plugin_close(plugin))
 166         syslog(LOG_ERR, "Error closing client plugin");
 167
 168     /* Close socket */
 169     guac_socket_close(socket);
 170
 171     return;
 172
 173 }
 174
 175 int main(int argc, char* argv[]) {
 176
 177     /* Server */
 178     int socket_fd;
 179     struct addrinfo* addresses;
 180     struct addrinfo* current_address;
 181     char bound_address[1024];
 182     char bound_port[64];
 183     int opt_on = 1;
 184
 185     struct addrinfo hints = {
 186         .ai_family   = AF_UNSPEC,
 187         .ai_socktype = SOCK_STREAM,
 188         .ai_protocol = IPPROTO_TCP
 189     };
 190
 191     /* Client */
 192     struct sockaddr_in client_addr;
 193     socklen_t client_addr_len;
 194     int connected_socket_fd;
 195
 196     /* Arguments */
 197     char* listen_address = NULL; /* Default address of INADDR_ANY */
 198     char* listen_port = "4822";  /* Default port */
 199     char* pidfile = NULL;
 200     int opt;
 201
 202     /* General */
 203     int retval;
 204
 205     /* Daemon Process */
 206     pid_t daemon_pid;
 207
 208     /* Parse arguments */
 209     while ((opt = getopt(argc, argv, "l:b:p:")) != -1) {
 210         if (opt == 'l') {
 211             listen_port = strdup(optarg);
 212         }
 213         else if (opt == 'b') {
 214             listen_address = strdup(optarg);
 215         }
 216         else if (opt == 'p') {
 217             pidfile = strdup(optarg);
 218         }
 219         else {
 220
 221             fprintf(stderr, "USAGE: %s"
 222                     " [-l LISTENPORT]"
 223                     " [-b LISTENADDRESS]"
 224                     " [-p PIDFILE]\n", argv[0]);
 225
 226             exit(EXIT_FAILURE);
 227         }
 228     }
 229
 230     /* Get addresses for binding */
 231     if ((retval = getaddrinfo(listen_address, listen_port, &hints, &addresses))) {
 232         fprintf(stderr, "Error parsing given address or port: %s\n",
 233                 gai_strerror(retval));
 234         exit(EXIT_FAILURE);
 235     }
 236
 237     /* Get socket */
 238     socket_fd = socket(AF_INET, SOCK_STREAM, 0);
 239     if (socket_fd < 0) {
 240         fprintf(stderr, "Error opening socket: %s\n", strerror(errno));
 241         exit(EXIT_FAILURE);
 242     }
 243
 244     /* Allow socket reuse */
 245     if (setsockopt(socket_fd, SOL_SOCKET, SO_REUSEADDR, (void*) &opt_on, sizeof(opt_on))) {
 246         fprintf(stderr, "Warning: Unable to set socket options for reuse: %s\n", strerror(errno));
 247     }
 248
 249     /* Attempt binding of each address until success */
 250     current_address = addresses;
 251     while (current_address != NULL) {
 252
 253         int retval;
 254
 255         /* Resolve hostname */
 256         if ((retval = getnameinfo(current_address->ai_addr,
 257                 current_address->ai_addrlen,
 258                 bound_address, sizeof(bound_address),
 259                 bound_port, sizeof(bound_port),
 260                 NI_NUMERICHOST | NI_NUMERICSERV)))
 261             fprintf(stderr, "Unable to resolve host: %s\n",
 262                     gai_strerror(retval));
 263
 264         /* Attempt to bind socket to address */
 265         if (bind(socket_fd,
 266                     current_address->ai_addr,
 267                     current_address->ai_addrlen) == 0) {
 268
 269             fprintf(stderr, "Successfully bound socket to "
 270                     "host %s, port %s\n", bound_address, bound_port);
 271
 272             /* Done if successful bind */
 273             break;
 274
 275         }
 276
 277         /* Otherwise log error */
 278         else
 279             fprintf(stderr, "Error binding socket to "
 280                     "host %s, port %s: %s\n",
 281                     bound_address, bound_port, strerror(errno));
 282
 283         current_address = current_address->ai_next;
 284
 285     }
 286
 287     /* If unable to bind to anything, fail */
 288     if (current_address == NULL) {
 289         fprintf(stderr, "Unable to bind socket to any addresses.\n");
 290         exit(EXIT_FAILURE);
 291     }
 292
 293     /* Fork into background */
 294     daemon_pid = fork();
 295
 296     /* If error, fail */
 297     if (daemon_pid == -1) {
 298         fprintf(stderr, "Error forking daemon process: %s\n", strerror(errno));
 299         exit(EXIT_FAILURE);
 300     }
 301
 302     /* If parent, write PID file and exit */
 303     else if (daemon_pid != 0) {
 304
 305         if (pidfile != NULL) {
 306
 307             /* Attempt to open pidfile and write PID */
 308             FILE* pidf = fopen(pidfile, "w");
 309             if (pidf) {
 310                 fprintf(pidf, "%d\n", daemon_pid);
 311                 fclose(pidf);
 312             }
 313
 314             /* Warn on failure */
 315             else {
 316                 fprintf(stderr, "WARNING: Could not write PID file: %s\n", strerror(errno));
 317                 exit(EXIT_FAILURE);
 318             }
 319
 320         }
 321
 322         exit(EXIT_SUCCESS);
 323     }
 324
 325     /* Open log */
 326     openlog(NULL, LOG_PID, LOG_DAEMON);
 327
 328     /* Ignore SIGPIPE */
 329     if (signal(SIGPIPE, SIG_IGN) == SIG_ERR) {
 330         syslog(LOG_ERR, "Could not set handler for SIGPIPE to ignore. SIGPIPE may cause termination of the daemon.");
 331     }
 332
 333     /* Ignore SIGCHLD (force automatic removal of children) */
 334     if (signal(SIGCHLD, SIG_IGN) == SIG_ERR) {
 335         syslog(LOG_ERR, "Could not set handler for SIGCHLD to ignore. Child processes may pile up in the process table.");
 336     }
 337
 338     /* Log listening status */
 339     syslog(LOG_INFO,
 340             "Listening on host %s, port %s", bound_address, bound_port);
 341
 342     /* Free addresses */
 343     freeaddrinfo(addresses);
 344
 345     /* Daemon loop */
 346     for (;;) {
 347
 348         pid_t child_pid;
 349
 350         /* Listen for connections */
 351         if (listen(socket_fd, 5) < 0) {
 352             syslog(LOG_ERR, "Could not listen on socket: %s", strerror(errno));
 353             return 3;
 354         }
 355
 356         /* Accept connection */
 357         client_addr_len = sizeof(client_addr);
 358         connected_socket_fd = accept(socket_fd, (struct sockaddr*) &client_addr, &client_addr_len);
 359         if (connected_socket_fd < 0) {
 360             syslog(LOG_ERR, "Could not accept client connection: %s", strerror(errno));
 361             return 3;
 362         }
 363
 364         /*
 365          * Once connection is accepted, send child into background.
 366          *
 367          * Note that we prefer fork() over threads for connection-handling
 368          * processes as they give each connection its own memory area, and
 369          * isolate the main daemon and other connections from errors in any
 370          * particular client plugin.
 371          */
 372
 373         child_pid = fork();
 374
 375         /* If error, log */
 376         if (child_pid == -1)
 377             syslog(LOG_ERR, "Error forking child process: %s\n", strerror(errno));
 378
 379         /* If child, start client, and exit when finished */
 380         else if (child_pid == 0) {
 381             guacd_handle_connection(connected_socket_fd);
 382             close(connected_socket_fd);
 383             return 0;
 384         }
 385
 386         /* If parent, close reference to child's descriptor */
 387         else if (close(connected_socket_fd) < 0) {
 388             syslog(LOG_ERR, "Error closing daemon reference to child descriptor: %s", strerror(errno));
 389         }
 390
 391     }
 392
 393     /* Close socket */
 394     if (close(socket_fd) < 0) {
 395         syslog(LOG_ERR, "Could not close socket: %s", strerror(errno));
 396         return 3;
 397     }
 398
 399     return 0;
 400
 401 }
 402