usr.sbin/iscsid/iscsid.c

   1 /*-
   2  * Copyright (c) 2012 The FreeBSD Foundation
   3  * All rights reserved.
   4  *
   5  * This software was developed by Edward Tomasz Napierala under sponsorship
   6  * from the FreeBSD Foundation.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  *
  29  * $FreeBSD$
  30  */
  31
  32 #include <sys/types.h>
  33 #include <sys/time.h>
  34 #include <sys/ioctl.h>
  35 #include <sys/param.h>
  36 #include <sys/linker.h>
  37 #include <sys/socket.h>
  38 #include <sys/capability.h>
  39 #include <sys/wait.h>
  40 #include <assert.h>
  41 #include <errno.h>
  42 #include <fcntl.h>
  43 #include <netdb.h>
  44 #include <signal.h>
  45 #include <stdbool.h>
  46 #include <stdint.h>
  47 #include <stdio.h>
  48 #include <stdlib.h>
  49 #include <string.h>
  50 #include <unistd.h>
  51
  52 #include <libutil.h>
  53
  54 #include "iscsid.h"
  55
  56 static volatile bool sigalrm_received = false;
  57
  58 static int nchildren = 0;
  59
  60 static void
  61 usage(void)
  62 {
  63
  64         fprintf(stderr, "usage: iscsid [-P pidfile][-d][-m maxproc][-t timeout]\n");
  65         exit(1);
  66 }
  67
  68 char *
  69 checked_strdup(const char *s)
  70 {
  71         char *c;
  72
  73         c = strdup(s);
  74         if (c == NULL)
  75                 log_err(1, "strdup");
  76         return (c);
  77 }
  78
  79 static void
  80 resolve_addr(const struct connection *conn, const char *address,
  81     struct addrinfo **ai, bool initiator_side)
  82 {
  83         struct addrinfo hints;
  84         char *arg, *addr, *ch;
  85         const char *port;
  86         int error, colons = 0;
  87
  88         arg = checked_strdup(address);
  89
  90         if (arg[0] == '\0') {
  91                 fail(conn, "empty address");
  92                 log_errx(1, "empty address");
  93         }
  94         if (arg[0] == '[') {
  95                 /*
  96                  * IPv6 address in square brackets, perhaps with port.
  97                  */
  98                 arg++;
  99                 addr = strsep(&arg, "]");
 100                 if (arg == NULL) {
 101                         fail(conn, "malformed address");
 102                         log_errx(1, "malformed address %s", address);
 103                 }
 104                 if (arg[0] == '\0') {
 105                         port = NULL;
 106                 } else if (arg[0] == ':') {
 107                         port = arg + 1;
 108                 } else {
 109                         fail(conn, "malformed address");
 110                         log_errx(1, "malformed address %s", address);
 111                 }
 112         } else {
 113                 /*
 114                  * Either IPv6 address without brackets - and without
 115                  * a port - or IPv4 address.  Just count the colons.
 116                  */
 117                 for (ch = arg; *ch != '\0'; ch++) {
 118                         if (*ch == ':')
 119                                 colons++;
 120                 }
 121                 if (colons > 1) {
 122                         addr = arg;
 123                         port = NULL;
 124                 } else {
 125                         addr = strsep(&arg, ":");
 126                         if (arg == NULL)
 127                                 port = NULL;
 128                         else
 129                                 port = arg;
 130                 }
 131         }
 132
 133         if (port == NULL && !initiator_side)
 134                 port = "3260";
 135
 136         memset(&hints, 0, sizeof(hints));
 137         hints.ai_family = PF_UNSPEC;
 138         hints.ai_socktype = SOCK_STREAM;
 139         hints.ai_flags = AI_ADDRCONFIG | AI_NUMERICSERV;
 140         if (initiator_side)
 141                 hints.ai_flags |= AI_PASSIVE;
 142
 143         error = getaddrinfo(addr, port, &hints, ai);
 144         if (error != 0) {
 145                 fail(conn, gai_strerror(error));
 146                 log_errx(1, "getaddrinfo for %s failed: %s",
 147                     address, gai_strerror(error));
 148         }
 149 }
 150
 151 static struct connection *
 152 connection_new(unsigned int session_id, const uint8_t isid[8], uint16_t tsih,
 153     const struct iscsi_session_conf *conf, int iscsi_fd)
 154 {
 155         struct connection *conn;
 156         struct addrinfo *from_ai, *to_ai;
 157         const char *from_addr, *to_addr;
 158 #ifdef ICL_KERNEL_PROXY
 159         struct iscsi_daemon_connect idc;
 160 #endif
 161         int error;
 162
 163         conn = calloc(1, sizeof(*conn));
 164         if (conn == NULL)
 165                 log_err(1, "calloc");
 166
 167         /*
 168          * Default values, from RFC 3720, section 12.
 169          */
 170         conn->conn_header_digest = CONN_DIGEST_NONE;
 171         conn->conn_data_digest = CONN_DIGEST_NONE;
 172         conn->conn_initial_r2t = true;
 173         conn->conn_immediate_data = true;
 174         conn->conn_max_data_segment_length = 8192;
 175         conn->conn_max_burst_length = 262144;
 176         conn->conn_first_burst_length = 65536;
 177
 178         conn->conn_session_id = session_id;
 179         memcpy(&conn->conn_isid, isid, sizeof(conn->conn_isid));
 180         conn->conn_tsih = tsih;
 181         conn->conn_iscsi_fd = iscsi_fd;
 182
 183         /*
 184          * XXX: Should we sanitize this somehow?
 185          */
 186         memcpy(&conn->conn_conf, conf, sizeof(conn->conn_conf));
 187
 188         from_addr = conn->conn_conf.isc_initiator_addr;
 189         to_addr = conn->conn_conf.isc_target_addr;
 190
 191         if (from_addr[0] != '\0')
 192                 resolve_addr(conn, from_addr, &from_ai, true);
 193         else
 194                 from_ai = NULL;
 195
 196         resolve_addr(conn, to_addr, &to_ai, false);
 197
 198 #ifdef ICL_KERNEL_PROXY
 199         if (conn->conn_conf.isc_iser) {
 200                 memset(&idc, 0, sizeof(idc));
 201                 idc.idc_session_id = conn->conn_session_id;
 202                 if (conn->conn_conf.isc_iser)
 203                         idc.idc_iser = 1;
 204                 idc.idc_domain = to_ai->ai_family;
 205                 idc.idc_socktype = to_ai->ai_socktype;
 206                 idc.idc_protocol = to_ai->ai_protocol;
 207                 if (from_ai != NULL) {
 208                         idc.idc_from_addr = from_ai->ai_addr;
 209                         idc.idc_from_addrlen = from_ai->ai_addrlen;
 210                 }
 211                 idc.idc_to_addr = to_ai->ai_addr;
 212                 idc.idc_to_addrlen = to_ai->ai_addrlen;
 213
 214                 log_debugx("connecting to %s using ICL kernel proxy", to_addr);
 215                 error = ioctl(iscsi_fd, ISCSIDCONNECT, &idc);
 216                 if (error != 0) {
 217                         fail(conn, strerror(errno));
 218                         log_err(1, "failed to connect to %s "
 219                             "using ICL kernel proxy: ISCSIDCONNECT", to_addr);
 220                 }
 221
 222                 return (conn);
 223         }
 224 #endif /* ICL_KERNEL_PROXY */
 225
 226         if (conn->conn_conf.isc_iser) {
 227                 fail(conn, "iSER not supported");
 228                 log_errx(1, "iscsid(8) compiled without ICL_KERNEL_PROXY "
 229                     "does not support iSER");
 230         }
 231
 232         conn->conn_socket = socket(to_ai->ai_family, to_ai->ai_socktype,
 233             to_ai->ai_protocol);
 234         if (conn->conn_socket < 0) {
 235                 fail(conn, strerror(errno));
 236                 log_err(1, "failed to create socket for %s", from_addr);
 237         }
 238         if (from_ai != NULL) {
 239                 error = bind(conn->conn_socket, from_ai->ai_addr,
 240                     from_ai->ai_addrlen);
 241                 if (error != 0) {
 242                         fail(conn, strerror(errno));
 243                         log_err(1, "failed to bind to %s", from_addr);
 244                 }
 245         }
 246         log_debugx("connecting to %s", to_addr);
 247         error = connect(conn->conn_socket, to_ai->ai_addr, to_ai->ai_addrlen);
 248         if (error != 0) {
 249                 fail(conn, strerror(errno));
 250                 log_err(1, "failed to connect to %s", to_addr);
 251         }
 252
 253         return (conn);
 254 }
 255
 256 static void
 257 handoff(struct connection *conn)
 258 {
 259         struct iscsi_daemon_handoff idh;
 260         int error;
 261
 262         log_debugx("handing off connection to the kernel");
 263
 264         memset(&idh, 0, sizeof(idh));
 265         idh.idh_session_id = conn->conn_session_id;
 266         idh.idh_socket = conn->conn_socket;
 267         strlcpy(idh.idh_target_alias, conn->conn_target_alias,
 268             sizeof(idh.idh_target_alias));
 269         idh.idh_tsih = conn->conn_tsih;
 270         idh.idh_statsn = conn->conn_statsn;
 271         idh.idh_header_digest = conn->conn_header_digest;
 272         idh.idh_data_digest = conn->conn_data_digest;
 273         idh.idh_initial_r2t = conn->conn_initial_r2t;
 274         idh.idh_immediate_data = conn->conn_immediate_data;
 275         idh.idh_max_data_segment_length = conn->conn_max_data_segment_length;
 276         idh.idh_max_burst_length = conn->conn_max_burst_length;
 277         idh.idh_first_burst_length = conn->conn_first_burst_length;
 278
 279         error = ioctl(conn->conn_iscsi_fd, ISCSIDHANDOFF, &idh);
 280         if (error != 0)
 281                 log_err(1, "ISCSIDHANDOFF");
 282 }
 283
 284 void
 285 fail(const struct connection *conn, const char *reason)
 286 {
 287         struct iscsi_daemon_fail idf;
 288         int error;
 289
 290         memset(&idf, 0, sizeof(idf));
 291         idf.idf_session_id = conn->conn_session_id;
 292         strlcpy(idf.idf_reason, reason, sizeof(idf.idf_reason));
 293
 294         error = ioctl(conn->conn_iscsi_fd, ISCSIDFAIL, &idf);
 295         if (error != 0)
 296                 log_err(1, "ISCSIDFAIL");
 297 }
 298
 299 /*
 300  * XXX: I CANT INTO LATIN
 301  */
 302 static void
 303 capsicate(struct connection *conn)
 304 {
 305         int error;
 306         cap_rights_t rights;
 307 #ifdef ICL_KERNEL_PROXY
 308         const unsigned long cmds[] = { ISCSIDCONNECT, ISCSIDSEND, ISCSIDRECEIVE,
 309             ISCSIDHANDOFF, ISCSIDFAIL, ISCSISADD, ISCSISREMOVE, ISCSISMODIFY };
 310 #else
 311         const unsigned long cmds[] = { ISCSIDHANDOFF, ISCSIDFAIL, ISCSISADD,
 312             ISCSISREMOVE, ISCSISMODIFY };
 313 #endif
 314
 315         cap_rights_init(&rights, CAP_IOCTL);
 316         error = cap_rights_limit(conn->conn_iscsi_fd, &rights);
 317         if (error != 0 && errno != ENOSYS)
 318                 log_err(1, "cap_rights_limit");
 319
 320         error = cap_ioctls_limit(conn->conn_iscsi_fd, cmds,
 321             sizeof(cmds) / sizeof(cmds[0]));
 322         if (error != 0 && errno != ENOSYS)
 323                 log_err(1, "cap_ioctls_limit");
 324
 325         error = cap_enter();
 326         if (error != 0 && errno != ENOSYS)
 327                 log_err(1, "cap_enter");
 328
 329         if (cap_sandboxed())
 330                 log_debugx("Capsicum capability mode enabled");
 331         else
 332                 log_warnx("Capsicum capability mode not supported");
 333 }
 334
 335 bool
 336 timed_out(void)
 337 {
 338
 339         return (sigalrm_received);
 340 }
 341
 342 static void
 343 sigalrm_handler(int dummy __unused)
 344 {
 345         /*
 346          * It would be easiest to just log an error and exit.  We can't
 347          * do this, though, because log_errx() is not signal safe, since
 348          * it calls syslog(3).  Instead, set a flag checked by pdu_send()
 349          * and pdu_receive(), to call log_errx() there.  Should they fail
 350          * to notice, we'll exit here one second later.
 351          */
 352         if (sigalrm_received) {
 353                 /*
 354                  * Oh well.  Just give up and quit.
 355                  */
 356                 _exit(2);
 357         }
 358
 359         sigalrm_received = true;
 360 }
 361
 362 static void
 363 set_timeout(int timeout)
 364 {
 365         struct sigaction sa;
 366         struct itimerval itv;
 367         int error;
 368
 369         if (timeout <= 0) {
 370                 log_debugx("session timeout disabled");
 371                 return;
 372         }
 373
 374         bzero(&sa, sizeof(sa));
 375         sa.sa_handler = sigalrm_handler;
 376         sigfillset(&sa.sa_mask);
 377         error = sigaction(SIGALRM, &sa, NULL);
 378         if (error != 0)
 379                 log_err(1, "sigaction");
 380
 381         /*
 382          * First SIGALRM will arive after conf_timeout seconds.
 383          * If we do nothing, another one will arrive a second later.
 384          */
 385         bzero(&itv, sizeof(itv));
 386         itv.it_interval.tv_sec = 1;
 387         itv.it_value.tv_sec = timeout;
 388
 389         log_debugx("setting session timeout to %d seconds",
 390             timeout);
 391         error = setitimer(ITIMER_REAL, &itv, NULL);
 392         if (error != 0)
 393                 log_err(1, "setitimer");
 394 }
 395
 396 static void
 397 sigchld_handler(int dummy __unused)
 398 {
 399
 400         /*
 401          * The only purpose of this handler is to make SIGCHLD
 402          * interrupt the ISCSIDWAIT ioctl(2), so we can call
 403          * wait_for_children().
 404          */
 405 }
 406
 407 static void
 408 register_sigchld(void)
 409 {
 410         struct sigaction sa;
 411         int error;
 412
 413         bzero(&sa, sizeof(sa));
 414         sa.sa_handler = sigchld_handler;
 415         sigfillset(&sa.sa_mask);
 416         error = sigaction(SIGCHLD, &sa, NULL);
 417         if (error != 0)
 418                 log_err(1, "sigaction");
 419
 420 }
 421
 422 static void
 423 handle_request(int iscsi_fd, const struct iscsi_daemon_request *request, int timeout)
 424 {
 425         struct connection *conn;
 426
 427         log_set_peer_addr(request->idr_conf.isc_target_addr);
 428         if (request->idr_conf.isc_target[0] != '\0') {
 429                 log_set_peer_name(request->idr_conf.isc_target);
 430                 setproctitle("%s (%s)", request->idr_conf.isc_target_addr, request->idr_conf.isc_target);
 431         } else {
 432                 setproctitle("%s", request->idr_conf.isc_target_addr);
 433         }
 434
 435         conn = connection_new(request->idr_session_id, request->idr_isid,
 436             request->idr_tsih, &request->idr_conf, iscsi_fd);
 437         set_timeout(timeout);
 438         capsicate(conn);
 439         login(conn);
 440         if (conn->conn_conf.isc_discovery != 0)
 441                 discovery(conn);
 442         else
 443                 handoff(conn);
 444
 445         log_debugx("nothing more to do; exiting");
 446         exit (0);
 447 }
 448
 449 static int
 450 wait_for_children(bool block)
 451 {
 452         pid_t pid;
 453         int status;
 454         int num = 0;
 455
 456         for (;;) {
 457                 /*
 458                  * If "block" is true, wait for at least one process.
 459                  */
 460                 if (block && num == 0)
 461                         pid = wait4(-1, &status, 0, NULL);
 462                 else
 463                         pid = wait4(-1, &status, WNOHANG, NULL);
 464                 if (pid <= 0)
 465                         break;
 466                 if (WIFSIGNALED(status)) {
 467                         log_warnx("child process %d terminated with signal %d",
 468                             pid, WTERMSIG(status));
 469                 } else if (WEXITSTATUS(status) != 0) {
 470                         log_warnx("child process %d terminated with exit status %d",
 471                             pid, WEXITSTATUS(status));
 472                 } else {
 473                         log_debugx("child process %d terminated gracefully", pid);
 474                 }
 475                 num++;
 476         }
 477
 478         return (num);
 479 }
 480
 481 int
 482 main(int argc, char **argv)
 483 {
 484         int ch, debug = 0, error, iscsi_fd, maxproc = 30, retval, saved_errno,
 485             timeout = 60;
 486         bool dont_daemonize = false;
 487         struct pidfh *pidfh;
 488         pid_t pid, otherpid;
 489         const char *pidfile_path = DEFAULT_PIDFILE;
 490         struct iscsi_daemon_request request;
 491
 492         while ((ch = getopt(argc, argv, "P:dl:m:t:")) != -1) {
 493                 switch (ch) {
 494                 case 'P':
 495                         pidfile_path = optarg;
 496                         break;
 497                 case 'd':
 498                         dont_daemonize = true;
 499                         debug++;
 500                         break;
 501                 case 'l':
 502                         debug = atoi(optarg);
 503                         break;
 504                 case 'm':
 505                         maxproc = atoi(optarg);
 506                         break;
 507                 case 't':
 508                         timeout = atoi(optarg);
 509                         break;
 510                 case '?':
 511                 default:
 512                         usage();
 513                 }
 514         }
 515         argc -= optind;
 516         if (argc != 0)
 517                 usage();
 518
 519         log_init(debug);
 520
 521         pidfh = pidfile_open(pidfile_path, 0600, &otherpid);
 522         if (pidfh == NULL) {
 523                 if (errno == EEXIST)
 524                         log_errx(1, "daemon already running, pid: %jd.",
 525                             (intmax_t)otherpid);
 526                 log_err(1, "cannot open or create pidfile \"%s\"",
 527                     pidfile_path);
 528         }
 529
 530         iscsi_fd = open(ISCSI_PATH, O_RDWR);
 531         if (iscsi_fd < 0 && errno == ENOENT) {
 532                 saved_errno = errno;
 533                 retval = kldload("iscsi");
 534                 if (retval != -1)
 535                         iscsi_fd = open(ISCSI_PATH, O_RDWR);
 536                 else
 537                         errno = saved_errno;
 538         }
 539         if (iscsi_fd < 0)
 540                 log_err(1, "failed to open %s", ISCSI_PATH);
 541
 542         if (dont_daemonize == false) {
 543                 if (daemon(0, 0) == -1) {
 544                         log_warn("cannot daemonize");
 545                         pidfile_remove(pidfh);
 546                         exit(1);
 547                 }
 548         }
 549
 550         pidfile_write(pidfh);
 551
 552         register_sigchld();
 553
 554         for (;;) {
 555                 log_debugx("waiting for request from the kernel");
 556
 557                 memset(&request, 0, sizeof(request));
 558                 error = ioctl(iscsi_fd, ISCSIDWAIT, &request);
 559                 if (error != 0) {
 560                         if (errno == EINTR) {
 561                                 nchildren -= wait_for_children(false);
 562                                 assert(nchildren >= 0);
 563                                 continue;
 564                         }
 565
 566                         log_err(1, "ISCSIDWAIT");
 567                 }
 568
 569                 if (dont_daemonize) {
 570                         log_debugx("not forking due to -d flag; "
 571                             "will exit after servicing a single request");
 572                 } else {
 573                         nchildren -= wait_for_children(false);
 574                         assert(nchildren >= 0);
 575
 576                         while (maxproc > 0 && nchildren >= maxproc) {
 577                                 log_debugx("maxproc limit of %d child processes hit; "
 578                                     "waiting for child process to exit", maxproc);
 579                                 nchildren -= wait_for_children(true);
 580                                 assert(nchildren >= 0);
 581                         }
 582                         log_debugx("incoming connection; forking child process #%d",
 583                             nchildren);
 584                         nchildren++;
 585
 586                         pid = fork();
 587                         if (pid < 0)
 588                                 log_err(1, "fork");
 589                         if (pid > 0)
 590                                 continue;
 591                 }
 592
 593                 pidfile_close(pidfh);
 594                 handle_request(iscsi_fd, &request, timeout);
 595         }
 596
 597         return (0);
 598 }