src/unix.c

   1 /*
   2  * Copyright (C) 1995-2005, Index Data ApS
   3  * See the file LICENSE for details.
   4  *
   5  * $Id: unix.c,v 1.12 2005-02-04 13:28:47 adam Exp $
   6  * UNIX socket COMSTACK. By Morten Bøgeskov.
   7  */
   8 /**
   9  * \file unix.c
  10  * \brief Implements UNIX domain socket COMSTACK
  11  */
  12
  13 #ifndef WIN32
  14
  15 #include <stdio.h>
  16 #include <string.h>
  17 #include <stdlib.h>
  18 #include <errno.h>
  19 #if HAVE_SYS_TYPES_H
  20 #include <sys/types.h>
  21 #endif
  22 #if HAVE_UNISTD_H
  23 #include <unistd.h>
  24 #endif
  25 #if HAVE_SYS_SOCKET_H
  26 #include <sys/socket.h>
  27 #endif
  28 #include <fcntl.h>
  29 #include <signal.h>
  30
  31 #include <grp.h>
  32 #if HAVE_PWD_H
  33 #include <pwd.h>
  34 #endif
  35
  36 #if HAVE_SYS_STAT_H
  37 #include <sys/stat.h>
  38 #endif
  39 #if HAVE_SYS_UN_H
  40 #include <sys/un.h>
  41 #endif
  42
  43 #include <yaz/unix.h>
  44 #include <yaz/nmem.h>
  45
  46 #ifndef YAZ_SOCKLEN_T
  47 #define YAZ_SOCKLEN_T int
  48 #endif
  49
  50 static int unix_close(COMSTACK h);
  51 static int unix_put(COMSTACK h, char *buf, int size);
  52 static int unix_get(COMSTACK h, char **buf, int *bufsize);
  53 static int unix_connect(COMSTACK h, void *address);
  54 static int unix_more(COMSTACK h);
  55 static int unix_rcvconnect(COMSTACK h);
  56 static int unix_bind(COMSTACK h, void *address, int mode);
  57 static int unix_listen(COMSTACK h, char *raddr, int *addrlen,
  58                 int (*check_ip)(void *cd, const char *a, int len, int type),
  59                 void *cd);
  60 static int unix_set_blocking(COMSTACK p, int blocking);
  61
  62 static COMSTACK unix_accept(COMSTACK h);
  63 static char *unix_addrstr(COMSTACK h);
  64 static void *unix_straddr(COMSTACK h, const char *str);
  65
  66 #ifndef SUN_LEN
  67 #define SUN_LEN(ptr) ((size_t) (((struct sockaddr_un *) 0)->sun_path) \
  68                       + strlen ((ptr)->sun_path))
  69 #endif
  70 #if 0
  71 #define TRC(x) x
  72 #else
  73 #define TRC(X)
  74 #endif
  75
  76 /* this state is used for both SSL and straight TCP/IP */
  77 typedef struct unix_state
  78 {
  79     char *altbuf; /* alternate buffer for surplus data */
  80     int altsize;  /* size as xmalloced */
  81     int altlen;   /* length of data or 0 if none */
  82
  83     int written;  /* -1 if we aren't writing */
  84     int towrite;  /* to verify against user input */
  85     int (*complete)(const unsigned char *buf, int len); /* length/comple. */
  86     struct sockaddr_un addr;  /* returned by cs_straddr */
  87     int uid;
  88     int gid;
  89     int umask;
  90     char buf[128]; /* returned by cs_addrstr */
  91 } unix_state;
  92
  93 static int unix_init (void)
  94 {
  95     return 1;
  96 }
  97
  98 /*
  99  * This function is always called through the cs_create() macro.
 100  * s >= 0: socket has already been established for us.
 101  */
 102 COMSTACK unix_type(int s, int blocking, int protocol, void *vp)
 103 {
 104     COMSTACK p;
 105     unix_state *state;
 106     int new_socket;
 107
 108     if (!unix_init ())
 109         return 0;
 110     if (s < 0)
 111     {
 112         if ((s = socket(AF_UNIX, SOCK_STREAM, 0)) < 0)
 113             return 0;
 114         new_socket = 1;
 115     }
 116     else
 117         new_socket = 0;
 118     if (!(p = (struct comstack *)xmalloc(sizeof(struct comstack))))
 119         return 0;
 120     if (!(state = (struct unix_state *)(p->cprivate =
 121                                         xmalloc(sizeof(unix_state)))))
 122         return 0;
 123
 124     if (!((p->blocking = blocking)&1))
 125     {
 126         if (fcntl(s, F_SETFL, O_NONBLOCK) < 0)
 127             return 0;
 128 #ifndef MSG_NOSIGNAL
 129         signal (SIGPIPE, SIG_IGN);
 130 #endif
 131     }
 132
 133     p->io_pending = 0;
 134     p->iofile = s;
 135     p->type = unix_type;
 136     p->protocol = (enum oid_proto) protocol;
 137
 138     p->f_connect = unix_connect;
 139     p->f_rcvconnect = unix_rcvconnect;
 140     p->f_get = unix_get;
 141     p->f_put = unix_put;
 142     p->f_close = unix_close;
 143     p->f_more = unix_more;
 144     p->f_bind = unix_bind;
 145     p->f_listen = unix_listen;
 146     p->f_accept = unix_accept;
 147     p->f_addrstr = unix_addrstr;
 148     p->f_straddr = unix_straddr;
 149     p->f_set_blocking = unix_set_blocking;
 150
 151     p->state = new_socket ? CS_ST_UNBND : CS_ST_IDLE; /* state of line */
 152     p->event = CS_NONE;
 153     p->cerrno = 0;
 154     p->stackerr = 0;
 155     p->user = 0;
 156
 157     state->altbuf = 0;
 158     state->altsize = state->altlen = 0;
 159     state->towrite = state->written = -1;
 160     if (protocol == PROTO_WAIS)
 161         state->complete = completeWAIS;
 162     else
 163         state->complete = cs_complete_auto;
 164
 165     p->timeout = COMSTACK_DEFAULT_TIMEOUT;
 166     TRC(fprintf(stderr, "Created new UNIX comstack\n"));
 167
 168     return p;
 169 }
 170
 171
 172 static int unix_strtoaddr_ex(const char *str, struct sockaddr_un *add)
 173 {
 174     char *cp;
 175     if (!unix_init ())
 176         return 0;
 177     TRC(fprintf(stderr, "unix_strtoaddress: %s\n", str ? str : "NULL"));
 178     add->sun_family = AF_UNIX;
 179     strncpy(add->sun_path, str, sizeof(add->sun_path));
 180     cp = strchr (add->sun_path, ':');
 181     if (cp)
 182         *cp = '\0';
 183     return 1;
 184 }
 185
 186 static void *unix_straddr(COMSTACK h, const char *str)
 187 {
 188     unix_state *sp = (unix_state *)h->cprivate;
 189     char * s = strdup(str);
 190     char * f = s;
 191     const char * file = NULL;
 192     char * eol;
 193
 194     sp->uid = sp->gid = sp->umask = -1;
 195
 196     if ((eol = strchr(s, ',')))
 197     {
 198         do
 199         {
 200             if ((eol = strchr(s, ',')))
 201                 *eol++ = '\0';
 202             if (sp->uid  == -1 && strncmp(s, "user=",  5) == 0)
 203             {
 204                 char * arg = s + 5;
 205                 if (strspn(arg, "0123456789") == strlen(arg))
 206                 {
 207                     sp->uid = atoi(arg);
 208                 }
 209                 else
 210                 {
 211                     struct passwd * pw = getpwnam(arg);
 212                     if(pw == NULL)
 213                     {
 214                         printf("No such user\n");
 215                         free(f);
 216                         return 0;
 217                     }
 218                     sp->uid = pw->pw_uid;
 219                 }
 220             }
 221             else if (sp->gid == -1 && strncmp(s, "group=", 6) == 0)
 222             {
 223                 char * arg = s + 6;
 224                 if (strspn(arg, "0123456789") == strlen(arg))
 225                 {
 226                     sp->gid = atoi(arg);
 227                 }
 228                 else
 229                 {
 230                     struct group * gr = getgrnam(arg);
 231                     if (gr == NULL)
 232                     {
 233                         printf("No such group\n");
 234                         free(f);
 235                         return 0;
 236                     }
 237                     sp->gid = gr->gr_gid;
 238                 }
 239             }
 240             else if (sp->umask == -1 && strncmp(s, "umask=", 6) == 0)
 241             {
 242                 char * end;
 243                 char * arg = s + 6;
 244
 245                 sp->umask = strtol(arg, &end, 8);
 246                 if (errno == EINVAL ||
 247                     *end)
 248                 {
 249                     printf("Invalid umask\n");
 250                     free(f);
 251                     return 0;
 252                 }
 253             }
 254             else if (file == NULL && strncmp(s, "file=", 5) == 0)
 255             {
 256                 char * arg = s + 5;
 257                 file = arg;
 258             }
 259             else
 260             {
 261                 printf("invalid or double argument: %s\n", s);
 262                 free(f);
 263                 return 0;
 264             }
 265         } while((s = eol));
 266     }
 267     else
 268     {
 269         file = str;
 270     }
 271     if(! file)
 272     {
 273         errno = EINVAL;
 274         return 0;
 275     }
 276
 277     TRC(fprintf(stderr, "unix_straddr: %s\n", str ? str : "NULL"));
 278
 279     if (!unix_strtoaddr_ex (file, &sp->addr))
 280     {
 281         free(f);
 282         return 0;
 283     }
 284     free(f);
 285     return &sp->addr;
 286 }
 287
 288 struct sockaddr_un *unix_strtoaddr(const char *str)
 289 {
 290     static struct sockaddr_un add;
 291
 292     TRC(fprintf(stderr, "unix_strtoaddr: %s\n", str ? str : "NULL"));
 293
 294     if (!unix_strtoaddr_ex (str, &add))
 295         return 0;
 296     return &add;
 297 }
 298
 299 static int unix_more(COMSTACK h)
 300 {
 301     unix_state *sp = (unix_state *)h->cprivate;
 302
 303     return sp->altlen && (*sp->complete)((unsigned char *) sp->altbuf,
 304                                          sp->altlen);
 305 }
 306
 307 /*
 308  * connect(2) will block (sometimes) - nothing we can do short of doing
 309  * weird things like spawning subprocesses or threading or some weird junk
 310  * like that.
 311  */
 312 static int unix_connect(COMSTACK h, void *address)
 313 {
 314     struct sockaddr_un *add = (struct sockaddr_un *)address;
 315     int r;
 316
 317     TRC(fprintf(stderr, "unix_connect\n"));
 318     h->io_pending = 0;
 319     if (h->state != CS_ST_UNBND)
 320     {
 321         h->cerrno = CSOUTSTATE;
 322         return -1;
 323     }
 324     r = connect(h->iofile, (struct sockaddr *) add, SUN_LEN(add));
 325     if (r < 0)
 326     {
 327         if (yaz_errno() == EINPROGRESS || yaz_errno() == EAGAIN)
 328         {
 329             h->event = CS_CONNECT;
 330             h->state = CS_ST_CONNECTING;
 331             h->io_pending = CS_WANT_WRITE;
 332             return 1;
 333         }
 334         h->cerrno = CSYSERR;
 335         return -1;
 336     }
 337     h->event = CS_CONNECT;
 338     h->state = CS_ST_CONNECTING;
 339
 340     return unix_rcvconnect (h);
 341 }
 342
 343 /*
 344  * nop
 345  */
 346 static int unix_rcvconnect(COMSTACK h)
 347 {
 348     TRC(fprintf(stderr, "unix_rcvconnect\n"));
 349
 350     if (h->state == CS_ST_DATAXFER)
 351         return 0;
 352     if (h->state != CS_ST_CONNECTING)
 353     {
 354         h->cerrno = CSOUTSTATE;
 355         return -1;
 356     }
 357     h->event = CS_DATA;
 358     h->state = CS_ST_DATAXFER;
 359     return 0;
 360 }
 361
 362 static int unix_bind(COMSTACK h, void *address, int mode)
 363 {
 364     unix_state *sp = (unix_state *)h->cprivate;
 365     struct sockaddr *addr = (struct sockaddr *)address;
 366     const char * path = ((struct sockaddr_un *)addr)->sun_path;
 367     struct stat stat_buf;
 368
 369     TRC (fprintf (stderr, "unix_bind\n"));
 370
 371     if(stat(path, &stat_buf) != -1) {
 372         struct sockaddr_un socket_unix;
 373         int socket_out = -1;
 374         if(! S_ISSOCK(stat_buf.st_mode)) {
 375             h->cerrno = CSYSERR;
 376             yaz_set_errno(EEXIST); /* Not a socket (File exists) */
 377             return -1;
 378         }
 379         if((socket_out = socket(AF_UNIX, SOCK_STREAM, 0)) < 0) {
 380             h->cerrno = CSYSERR;
 381             return -1;
 382         }
 383         socket_unix.sun_family = AF_UNIX;
 384         strncpy(socket_unix.sun_path, path, sizeof(socket_unix.sun_path));
 385         if(connect(socket_out, (struct sockaddr *) &socket_unix, SUN_LEN(&socket_unix)) < 0) {
 386             if(yaz_errno() == ECONNREFUSED) {
 387                 TRC (fprintf (stderr, "Socket exists but nobody is listening\n"));
 388             } else {
 389                 h->cerrno = CSYSERR;
 390                 return -1;
 391             }
 392         } else {
 393             close(socket_out);
 394             h->cerrno = CSYSERR;
 395             yaz_set_errno(EADDRINUSE);
 396             return -1;
 397         }
 398         unlink(path);
 399     }
 400
 401     if (bind(h->iofile, (struct sockaddr *) addr, SUN_LEN((struct sockaddr_un *)addr)))
 402     {
 403         h->cerrno = CSYSERR;
 404         return -1;
 405     }
 406     chown(path, sp->uid, sp->gid);
 407     chmod(path, sp->umask != -1 ? sp->umask : 0666);
 408     if (mode == CS_SERVER && listen(h->iofile, 3) < 0)
 409     {
 410         h->cerrno = CSYSERR;
 411         return -1;
 412     }
 413     h->state = CS_ST_IDLE;
 414     h->event = CS_LISTEN;
 415     return 0;
 416 }
 417
 418 static int unix_listen(COMSTACK h, char *raddr, int *addrlen,
 419                     int (*check_ip)(void *cd, const char *a, int len, int t),
 420                     void *cd)
 421 {
 422     struct sockaddr_un addr;
 423     YAZ_SOCKLEN_T len = sizeof(addr);
 424
 425     TRC(fprintf(stderr, "unix_listen pid=%d\n", getpid()));
 426     if (h->state != CS_ST_IDLE)
 427     {
 428         h->cerrno = CSOUTSTATE;
 429         return -1;
 430     }
 431     h->newfd = accept(h->iofile, (struct sockaddr*)&addr, &len);
 432     if (h->newfd < 0)
 433     {
 434         if (
 435             yaz_errno() == EWOULDBLOCK
 436 #ifdef EAGAIN
 437 #if EAGAIN != EWOULDBLOCK
 438             || yaz_errno() == EAGAIN
 439 #endif
 440 #endif
 441             )
 442             h->cerrno = CSNODATA;
 443         else
 444             h->cerrno = CSYSERR;
 445         return -1;
 446     }
 447     if (addrlen && (size_t) (*addrlen) >= sizeof(struct sockaddr_un))
 448         memcpy(raddr, &addr, *addrlen = sizeof(struct sockaddr_un));
 449     else if (addrlen)
 450         *addrlen = 0;
 451     h->state = CS_ST_INCON;
 452     return 0;
 453 }
 454
 455 static COMSTACK unix_accept(COMSTACK h)
 456 {
 457     COMSTACK cnew;
 458     unix_state *state, *st = (unix_state *)h->cprivate;
 459
 460     TRC(fprintf(stderr, "unix_accept\n"));
 461     if (h->state == CS_ST_INCON)
 462     {
 463         if (!(cnew = (COMSTACK)xmalloc(sizeof(*cnew))))
 464         {
 465             h->cerrno = CSYSERR;
 466             close(h->newfd);
 467             h->newfd = -1;
 468             return 0;
 469         }
 470         memcpy(cnew, h, sizeof(*h));
 471         cnew->iofile = h->newfd;
 472         cnew->io_pending = 0;
 473         if (!(state = (unix_state *)
 474               (cnew->cprivate = xmalloc(sizeof(unix_state)))))
 475         {
 476             h->cerrno = CSYSERR;
 477             if (h->newfd != -1)
 478             {
 479                 close(h->newfd);
 480                 h->newfd = -1;
 481             }
 482             return 0;
 483         }
 484         if (!(cnew->blocking&1) &&
 485             (fcntl(cnew->iofile, F_SETFL, O_NONBLOCK) < 0)
 486             )
 487         {
 488             h->cerrno = CSYSERR;
 489             if (h->newfd != -1)
 490             {
 491                 close(h->newfd);
 492                 h->newfd = -1;
 493             }
 494             xfree (cnew);
 495             xfree (state);
 496             return 0;
 497         }
 498         h->newfd = -1;
 499         state->altbuf = 0;
 500         state->altsize = state->altlen = 0;
 501         state->towrite = state->written = -1;
 502         state->complete = st->complete;
 503         memcpy(&state->addr, &st->addr, sizeof(state->addr));
 504         cnew->state = CS_ST_ACCEPT;
 505         cnew->event = CS_NONE;
 506         h->state = CS_ST_IDLE;
 507
 508         h = cnew;
 509     }
 510     if (h->state == CS_ST_ACCEPT)
 511     {
 512     }
 513     else
 514     {
 515         h->cerrno = CSOUTSTATE;
 516         return 0;
 517     }
 518     h->io_pending = 0;
 519     h->state = CS_ST_DATAXFER;
 520     h->event = CS_DATA;
 521     return h;
 522 }
 523
 524 #define CS_UNIX_BUFCHUNK 4096
 525
 526 /*
 527  * Return: -1 error, >1 good, len of buffer, ==1 incomplete buffer,
 528  * 0=connection closed.
 529  */
 530 static int unix_get(COMSTACK h, char **buf, int *bufsize)
 531 {
 532     unix_state *sp = (unix_state *)h->cprivate;
 533     char *tmpc;
 534     int tmpi, berlen, rest, req, tomove;
 535     int hasread = 0, res;
 536
 537     TRC(fprintf(stderr, "unix_get: bufsize=%d\n", *bufsize));
 538     if (sp->altlen) /* switch buffers */
 539     {
 540         TRC(fprintf(stderr, "  %d bytes in altbuf (0x%x)\n", sp->altlen,
 541                     (unsigned) sp->altbuf));
 542         tmpc = *buf;
 543         tmpi = *bufsize;
 544         *buf = sp->altbuf;
 545         *bufsize = sp->altsize;
 546         hasread = sp->altlen;
 547         sp->altlen = 0;
 548         sp->altbuf = tmpc;
 549         sp->altsize = tmpi;
 550     }
 551     h->io_pending = 0;
 552     while (!(berlen = (*sp->complete)((unsigned char *)*buf, hasread)))
 553     {
 554         if (!*bufsize)
 555         {
 556             if (!(*buf = (char *)xmalloc(*bufsize = CS_UNIX_BUFCHUNK)))
 557                 return -1;
 558         }
 559         else if (*bufsize - hasread < CS_UNIX_BUFCHUNK)
 560             if (!(*buf =(char *)xrealloc(*buf, *bufsize *= 2)))
 561                 return -1;
 562         res = recv(h->iofile, *buf + hasread, CS_UNIX_BUFCHUNK, 0);
 563         TRC(fprintf(stderr, "  recv res=%d, hasread=%d\n", res, hasread));
 564         if (res < 0)
 565         {
 566             if (yaz_errno() == EWOULDBLOCK
 567 #ifdef EAGAIN
 568 #if EAGAIN != EWOULDBLOCK
 569                 || yaz_errno() == EAGAIN
 570 #endif
 571 #endif
 572                 || yaz_errno() == EINPROGRESS
 573                 )
 574             {
 575                 h->io_pending = CS_WANT_READ;
 576                 break;
 577             }
 578             else if (yaz_errno() == 0)
 579                 continue;
 580             else
 581                 return -1;
 582         }
 583         else if (!res)
 584             return hasread;
 585         hasread += res;
 586     }
 587     TRC (fprintf (stderr, "  Out of read loop with hasread=%d, berlen=%d\n",
 588                   hasread, berlen));
 589     /* move surplus buffer (or everything if we didn't get a BER rec.) */
 590     if (hasread > berlen)
 591     {
 592         tomove = req = hasread - berlen;
 593         rest = tomove % CS_UNIX_BUFCHUNK;
 594         if (rest)
 595             req += CS_UNIX_BUFCHUNK - rest;
 596         if (!sp->altbuf)
 597         {
 598             if (!(sp->altbuf = (char *)xmalloc(sp->altsize = req)))
 599                 return -1;
 600         } else if (sp->altsize < req)
 601             if (!(sp->altbuf =(char *)xrealloc(sp->altbuf, sp->altsize = req)))
 602                 return -1;
 603         TRC(fprintf(stderr, "  Moving %d bytes to altbuf(0x%x)\n", tomove,
 604                     (unsigned) sp->altbuf));
 605         memcpy(sp->altbuf, *buf + berlen, sp->altlen = tomove);
 606     }
 607     if (berlen < CS_UNIX_BUFCHUNK - 1)
 608         *(*buf + berlen) = '\0';
 609     return berlen ? berlen : 1;
 610 }
 611
 612
 613
 614 /*
 615  * Returns 1, 0 or -1
 616  * In nonblocking mode, you must call again with same buffer while
 617  * return value is 1.
 618  */
 619 static int unix_put(COMSTACK h, char *buf, int size)
 620 {
 621     int res;
 622     struct unix_state *state = (struct unix_state *)h->cprivate;
 623
 624     TRC(fprintf(stderr, "unix_put: size=%d\n", size));
 625     h->io_pending = 0;
 626     h->event = CS_DATA;
 627     if (state->towrite < 0)
 628     {
 629         state->towrite = size;
 630         state->written = 0;
 631     }
 632     else if (state->towrite != size)
 633     {
 634         h->cerrno = CSWRONGBUF;
 635         return -1;
 636     }
 637     while (state->towrite > state->written)
 638     {
 639         if ((res =
 640              send(h->iofile, buf + state->written, size -
 641                   state->written,
 642 #ifdef MSG_NOSIGNAL
 643                   MSG_NOSIGNAL
 644 #else
 645                   0
 646 #endif
 647                  )) < 0)
 648         {
 649             if (
 650                 yaz_errno() == EWOULDBLOCK
 651 #ifdef EAGAIN
 652 #if EAGAIN != EWOULDBLOCK
 653                 || yaz_errno() == EAGAIN
 654 #endif
 655 #endif
 656                 )
 657             {
 658                 TRC(fprintf(stderr, "  Flow control stop\n"));
 659                 h->io_pending = CS_WANT_WRITE;
 660                 return 1;
 661             }
 662             h->cerrno = CSYSERR;
 663             return -1;
 664         }
 665         state->written += res;
 666         TRC(fprintf(stderr, "  Wrote %d, written=%d, nbytes=%d\n",
 667                     res, state->written, size));
 668     }
 669     state->towrite = state->written = -1;
 670     TRC(fprintf(stderr, "  Ok\n"));
 671     return 0;
 672 }
 673
 674 static int unix_close(COMSTACK h)
 675 {
 676     unix_state *sp = (struct unix_state *)h->cprivate;
 677
 678     TRC(fprintf(stderr, "unix_close\n"));
 679     if (h->iofile != -1)
 680     {
 681         close(h->iofile);
 682     }
 683     if (sp->altbuf)
 684         xfree(sp->altbuf);
 685     xfree(sp);
 686     xfree(h);
 687     return 0;
 688 }
 689
 690 static char *unix_addrstr(COMSTACK h)
 691 {
 692     unix_state *sp = (struct unix_state *)h->cprivate;
 693     char *buf = sp->buf;
 694     sprintf(buf, "unix:%s", sp->addr.sun_path);
 695     return buf;
 696 }
 697
 698 static int unix_set_blocking(COMSTACK p, int blocking)
 699 {
 700     unsigned long flag;
 701
 702     if (p->blocking == blocking)
 703         return 1;
 704     flag = fcntl(p->iofile, F_GETFL, 0);
 705     if(!blocking)
 706         flag = flag & ~O_NONBLOCK;
 707     else
 708         flag = flag | O_NONBLOCK;
 709     if (fcntl(p->iofile, F_SETFL, flag) < 0)
 710         return 0;
 711     p->blocking = blocking;
 712     return 1;
 713 }
 714 #endif /* WIN32 */