fcgi_util.c

   1 /*
   2  * $Id: fcgi_util.c,v 1.9 2000/04/27 02:27:35 robs Exp $
   3  */
   4
   5 #include "fcgi.h"
   6
   7 /*******************************************************************************
   8  * Compute printable MD5 hash. Pool p is used for scratch as well as for
   9  * allocating the hash - use temp storage, and dup it if you need to keep it.
  10  */
  11 char *
  12 fcgi_util_socket_hash_filename(pool *p, const char *path,
  13         const char *user, const char *group)
  14 {
  15     char *buf = ap_pstrcat(p, path, user, group, NULL);
  16
  17     /* Canonicalize the path (remove "//", ".", "..") */
  18     ap_getparents(buf);
  19
  20     return ap_md5(p, (unsigned char *)buf);
  21 }
  22
  23 /*******************************************************************************
  24  * Return absolute path to file in either "regular" FCGI socket directory or
  25  * the dynamic directory.  Result is allocated in pool p.
  26  */
  27 const char *
  28 fcgi_util_socket_make_path_absolute(pool * const p,
  29         const char *const file, const int dynamic)
  30 {
  31     return (const char *)ap_pstrcat(p,
  32 #ifdef WIN32
  33         (dynamic ? fcgi_dynamic_dir : fcgi_socket_dir), file, NULL);
  34 #else
  35         (dynamic ? fcgi_dynamic_dir : fcgi_socket_dir), "/", file, NULL);
  36 #endif
  37 }
  38
  39 /*******************************************************************************
  40  * Allocate a new string from pool p with the name of a Unix/Domain socket's
  41  * lock file (used by dynamic only).
  42  */
  43 const char *
  44 fcgi_util_socket_get_lock_filename(pool *p, const char *socket_path)
  45 {
  46     return ap_pstrcat(p, socket_path, ".lock", NULL);
  47 }
  48
  49 #ifndef WIN32
  50 /*******************************************************************************
  51  * Build a Domain Socket Address structure, and calculate its size.
  52  * The error message is allocated from the pool p.  If you don't want the
  53  * struct sockaddr_un also allocated from p, pass it preallocated (!=NULL).
  54  */
  55 const char *
  56 fcgi_util_socket_make_domain_addr(pool *p, struct sockaddr_un **socket_addr,
  57         int *socket_addr_len, const char *socket_path)
  58 {
  59     int socket_pathLen = strlen(socket_path);
  60
  61     if (socket_pathLen >= sizeof((*socket_addr)->sun_path)) {
  62         return ap_pstrcat(p, "path \"", socket_path,
  63                        "\" is too long for a Domain socket", NULL);
  64     }
  65
  66     if (*socket_addr == NULL)
  67         *socket_addr = ap_pcalloc(p, sizeof(struct sockaddr_un));
  68     else
  69         memset(*socket_addr, 0, sizeof(struct sockaddr_un));
  70
  71     (*socket_addr)->sun_family = AF_UNIX;
  72     strcpy((*socket_addr)->sun_path, socket_path);
  73
  74     *socket_addr_len = SUN_LEN(*socket_addr);
  75     return NULL;
  76 }
  77 #endif
  78
  79 /*******************************************************************************
  80  * Convert a hostname or IP address string to an in_addr struct.
  81  */
  82 static int
  83 convert_string_to_in_addr(const char * const hostname, struct in_addr * const addr)
  84 {
  85     struct hostent *hp;
  86     int count;
  87
  88     addr->s_addr = inet_addr((char *)hostname);
  89
  90     if (addr->s_addr == INADDR_NONE) {
  91         if ((hp = gethostbyname((char *)hostname)) == NULL)
  92             return -1;
  93
  94         memcpy((char *) addr, hp->h_addr, hp->h_length);
  95         count = 0;
  96         while (hp->h_addr_list[count] != 0)
  97             count++;
  98
  99         return count;
 100     }
 101     return 1;
 102 }
 103
 104
 105 /*******************************************************************************
 106  * Build an Inet Socket Address structure, and calculate its size.
 107  * The error message is allocated from the pool p. If you don't want the
 108  * struct sockaddr_in also allocated from p, pass it preallocated (!=NULL).
 109  */
 110 const char *
 111 fcgi_util_socket_make_inet_addr(pool *p, struct sockaddr_in **socket_addr,
 112         int *socket_addr_len, const char *host, unsigned short port)
 113 {
 114     if (*socket_addr == NULL)
 115         *socket_addr = ap_pcalloc(p, sizeof(struct sockaddr_in));
 116     else
 117         memset(*socket_addr, 0, sizeof(struct sockaddr_in));
 118
 119     (*socket_addr)->sin_family = AF_INET;
 120     (*socket_addr)->sin_port = htons(port);
 121
 122     /* Get an in_addr represention of the host */
 123     if (host != NULL) {
 124         if (convert_string_to_in_addr(host, &(*socket_addr)->sin_addr) != 1) {
 125             return ap_pstrcat(p, "failed to resolve \"", host,
 126                            "\" to exactly one IP address", NULL);
 127         }
 128     } else {
 129       (*socket_addr)->sin_addr.s_addr = htonl(INADDR_ANY);
 130     }
 131
 132     *socket_addr_len = sizeof(struct sockaddr_in);
 133     return NULL;
 134 }
 135
 136 /*******************************************************************************
 137  * Determine if a process with uid/gid can access a file with mode permissions.
 138  */
 139 const char *
 140 fcgi_util_check_access(pool *tp,
 141         const char * const path, const struct stat *statBuf,
 142         const int mode, const uid_t uid, const gid_t gid)
 143 {
 144     if (statBuf == NULL) {
 145         static struct stat staticStatBuf;
 146
 147         if (stat(path, &staticStatBuf) < 0)
 148             return ap_psprintf(tp, "stat() failed: %s", strerror(errno));
 149         statBuf = &staticStatBuf;
 150     }
 151
 152 #ifndef WIN32
 153     /* If the uid owns the file, check the owner bits */
 154     if (uid == statBuf->st_uid) {
 155         if (mode & R_OK && !(statBuf->st_mode & S_IRUSR))
 156             return "read not allowed by owner";
 157         if (mode & W_OK && !(statBuf->st_mode & S_IWUSR))
 158             return "write not allowed by owner";
 159         if (mode & X_OK && !(statBuf->st_mode & S_IXUSR))
 160             return "execute not allowed by owner";
 161         return NULL;
 162     }
 163 #else
 164     if (mode & _S_IREAD && !(statBuf->st_mode & _S_IREAD))
 165         return "read not allowed";
 166     if (mode & _S_IWRITE && !(statBuf->st_mode & _S_IWRITE))
 167         return "write not allowed";
 168     if (mode & _S_IEXEC && !(statBuf->st_mode & _S_IEXEC))
 169         return "execute not allowed";
 170 #endif
 171
 172 #if  !defined(__EMX__) && !defined(WIN32)
 173     /* If the gid is same as the file's group, check the group bits */
 174     if (gid == statBuf->st_gid) {
 175         if (mode & R_OK && !(statBuf->st_mode & S_IRGRP))
 176             return "read not allowed by group";
 177         if (mode & W_OK && !(statBuf->st_mode & S_IWGRP))
 178             return "write not allowed by group";
 179         if (mode & X_OK && !(statBuf->st_mode & S_IXGRP))
 180             return "execute not allowed by group";
 181         return NULL;
 182     }
 183
 184     /* Get the user membership for the file's group.  If the
 185      * uid is a member, check the group bits. */
 186     {
 187         const struct group * const gr = getgrgid(statBuf->st_gid);
 188         const struct passwd * const pw = getpwuid(uid);
 189
 190         if (gr != NULL && pw != NULL) {
 191             char **user = gr->gr_mem;
 192             for ( ; *user != NULL; user++) {
 193                 if (strcmp(*user, pw->pw_name) == 0) {
 194                     if (mode & R_OK && !(statBuf->st_mode & S_IRGRP))
 195                         return "read not allowed by group";
 196                     if (mode & W_OK && !(statBuf->st_mode & S_IWGRP))
 197                         return "write not allowed by group";
 198                     if (mode & X_OK && !(statBuf->st_mode & S_IXGRP))
 199                         return "execute not allowed by group";
 200                     return NULL;
 201                 }
 202             }
 203         }
 204     }
 205
 206     /* That just leaves the other bits.. */
 207     if (mode & R_OK && !(statBuf->st_mode & S_IROTH))
 208         return "read not allowed";
 209     if (mode & W_OK && !(statBuf->st_mode & S_IWOTH))
 210         return "write not allowed";
 211     if (mode & X_OK && !(statBuf->st_mode & S_IXOTH))
 212         return "execute not allowed";
 213 #endif
 214
 215     return NULL;
 216 }
 217
 218
 219 /*******************************************************************************
 220  * Find a FastCGI server with a matching fs_path, and if fcgi_suexec is
 221  * enabled with matching uid and gid.
 222  */
 223 fcgi_server *
 224 fcgi_util_fs_get_by_id(const char *ePath, uid_t uid, gid_t gid)
 225 {
 226     char path[FCGI_MAXPATH];
 227     fcgi_server *s;
 228
 229     /* @@@ This should now be done in the loop below */
 230     ap_cpystrn(path, ePath, FCGI_MAXPATH);
 231     ap_no2slash(path);
 232
 233     for (s = fcgi_servers; s != NULL; s = s->next) {
 234         int i;
 235         const char *fs_path = s->fs_path;
 236         for (i = 0; fs_path[i] && path[i]; ++i) {
 237             if (fs_path[i] != path[i]) {
 238                 break;
 239             }
 240         }
 241         if (fs_path[i]) {
 242             continue;
 243         }
 244         if (path[i] == '\0' || path[i] == '/') {
 245         if (fcgi_suexec == NULL || (uid == s->uid && gid == s->gid))
 246             return s;
 247         }
 248     }
 249     return NULL;
 250 }
 251
 252 /*******************************************************************************
 253  * Find a FastCGI server with a matching fs_path, and if fcgi_suexec is
 254  * enabled with matching user and group.
 255  */
 256 fcgi_server *
 257 fcgi_util_fs_get(const char *ePath, const char *user, const char *group)
 258 {
 259     char path[FCGI_MAXPATH];
 260     fcgi_server *s;
 261
 262     ap_cpystrn(path, ePath, FCGI_MAXPATH);
 263     ap_no2slash(path);
 264
 265     for (s = fcgi_servers; s != NULL; s = s->next) {
 266         if (strcmp(s->fs_path, path) == 0) {
 267             if (fcgi_suexec == NULL)
 268                 return s;
 269
 270             if (strcmp(user, s->user) == 0
 271                 && (user[0] == '~' || strcmp(group, s->group) == 0))
 272             {
 273                 return s;
 274             }
 275         }
 276     }
 277     return NULL;
 278 }
 279
 280 const char *
 281 fcgi_util_fs_is_path_ok(pool * const p, const char * const fs_path,
 282         struct stat *finfo, const uid_t uid, const gid_t gid)
 283 {
 284     const char *err;
 285
 286     if (finfo == NULL) {
 287         finfo = (struct stat *)ap_palloc(p, sizeof(struct stat));
 288         if (stat(fs_path, finfo) < 0)
 289             return ap_psprintf(p, "stat() failed: %s", strerror(errno));
 290     }
 291
 292     /* No Parse Header scripts aren't allowed.
 293      * @@@ Well... we really could quite easily */
 294     if (strncmp(strrchr(fs_path, '/'), "/nph-", 5) == 0)
 295         return ap_psprintf(p, "NPH scripts cannot be run as FastCGI");
 296
 297     if (finfo->st_mode == 0)
 298         return ap_psprintf(p, "script not found or unable to stat()");
 299
 300     if (S_ISDIR(finfo->st_mode))
 301         return ap_psprintf(p, "script is a directory!");
 302
 303     if (fcgi_suexec != NULL) {
 304 #ifndef WIN32
 305         err = fcgi_util_check_access(p, fs_path, finfo, X_OK, uid, gid);
 306         if (err) {
 307             return ap_psprintf(p,
 308                 "access for fcgi_suexec (uid %ld, gid %ld) not allowed: %s",
 309                 (long)uid, (long)gid, err);
 310         }
 311 #endif
 312     }
 313     else {
 314 #ifdef WIN32
 315         err = fcgi_util_check_access(p, fs_path, finfo, _S_IEXEC, fcgi_user_id, fcgi_group_id);
 316 #else
 317         err = fcgi_util_check_access(p, fs_path, finfo, X_OK, fcgi_user_id, fcgi_group_id);
 318 #endif
 319         if (err) {
 320             return ap_psprintf(p,
 321                 "access for server (uid %ld, gid %ld) not allowed: %s",
 322                 (long)fcgi_user_id, (long)fcgi_group_id, err);
 323         }
 324     }
 325
 326     return NULL;
 327 }
 328
 329
 330 \f
 331 /*******************************************************************************
 332  * Allocate a new FastCGI server record from pool p with default values.
 333  */
 334 fcgi_server *
 335 fcgi_util_fs_new(pool *p)
 336 {
 337     fcgi_server *s = (fcgi_server *) ap_pcalloc(p, sizeof(fcgi_server));
 338
 339     /* Initialize anything who's init state is not zeroizzzzed */
 340     s->listenQueueDepth = FCGI_DEFAULT_LISTEN_Q;
 341     s->appConnectTimeout = FCGI_DEFAULT_APP_CONN_TIMEOUT;
 342     s->idle_timeout = FCGI_DEFAULT_IDLE_TIMEOUT;
 343     s->initStartDelay = DEFAULT_INIT_START_DELAY;
 344     s->restartDelay = FCGI_DEFAULT_RESTART_DELAY;
 345     s->restartOnExit = FALSE;
 346     s->directive = APP_CLASS_UNKNOWN;
 347     s->processPriority = FCGI_DEFAULT_PRIORITY;
 348 #ifdef WIN32
 349     s->listenFd = (int)INVALID_HANDLE_VALUE;
 350 #else
 351     s->listenFd = -2;
 352 #endif
 353     s->envp = &fcgi_empty_env;
 354
 355     return s;
 356 }
 357
 358 /*******************************************************************************
 359  * Add the server to the linked list of FastCGI servers.
 360  */
 361 void
 362 fcgi_util_fs_add(fcgi_server *s)
 363 {
 364     s->next = fcgi_servers;
 365     fcgi_servers = s;
 366 }
 367
 368 /*******************************************************************************
 369  * Configure uid, gid, user, group, username for suexec.
 370  */
 371 const char *
 372 fcgi_util_fs_set_uid_n_gid(pool *p, fcgi_server *s, uid_t uid, gid_t gid)
 373 {
 374 #ifndef WIN32
 375     struct passwd *pw;
 376     struct group  *gr;
 377 #endif
 378
 379     if (fcgi_suexec == NULL)
 380         return NULL;
 381
 382 #ifndef WIN32
 383     s->uid = uid;
 384     pw = getpwuid(uid);
 385     if (pw == NULL) {
 386         return ap_psprintf(p,
 387             "getpwuid() couldn't determine the username for uid '%ld', "
 388             "you probably need to modify the User directive: %s",
 389             (long)uid, strerror(errno));
 390     }
 391     s->user = ap_pstrdup(p, pw->pw_name);
 392     s->username = s->user;
 393
 394     s->gid = gid;
 395     gr = getgrgid(gid);
 396     if (gr == NULL) {
 397         return ap_psprintf(p,
 398             "getgrgid() couldn't determine the group name for gid '%ld', "
 399             "you probably need to modify the Group directive: %s",
 400             (long)gid, strerror(errno));
 401     }
 402     s->group = ap_pstrdup(p, gr->gr_name);
 403 #endif
 404     return NULL;
 405 }
 406
 407 /*******************************************************************************
 408  * Allocate an array of ServerProcess records.
 409  */
 410 ServerProcess *
 411 fcgi_util_fs_create_procs(pool *p, int num)
 412 {
 413     int i;
 414     ServerProcess *proc = (ServerProcess *)ap_pcalloc(p, sizeof(ServerProcess) * num);
 415
 416     for (i = 0; i < num; i++) {
 417 #ifdef WIN32
 418         proc[i].pid = (HANDLE) 0;
 419 #else
 420         proc[i].pid = 0;
 421 #endif
 422         proc[i].state = STATE_READY;
 423     }
 424     return proc;
 425 }
 426
 427 /*
 428  *----------------------------------------------------------------------
 429  *
 430  * fcgi_util_lock_fd
 431  *
 432  *      Provide file locking via fcntl(2) function call.  This
 433  *      code has been borrowed from Stevens "Advanced Unix
 434  *      Programming", page 370.
 435  *
 436  * Inputs:
 437  *      File descriptor to be locked, offsets within the file.
 438  *
 439  * Results:
 440  *      0 on successful locking, -1 otherwise
 441  *
 442  * Side effects:
 443  *      File pointed to by file descriptor is locked or unlocked.
 444  *      Provided macros allow for both blocking and non-blocking
 445  *      behavior.
 446  *
 447  *----------------------------------------------------------------------
 448  */
 449
 450 int
 451 fcgi_util_lock_fd(int fd, int cmd, int type, off_t offset, int whence, off_t len)
 452 {
 453     int res = 0;
 454 #ifndef WIN32
 455     struct flock lock;
 456
 457     lock.l_type = type;       /* F_RDLCK, F_WRLCK, F_UNLCK */
 458     lock.l_start = offset;    /* byte offset, relative to whence */
 459     lock.l_whence = whence;   /* SEEK_SET, SEET_CUR, SEEK_END */
 460     lock.l_len = len;         /* # of bytes, (0 indicates to EOF) */
 461
 462     /* Don't be fooled into thinking we've set a lock when we've
 463        merely caught a signal.  */
 464
 465     /* This is OK only if there is a hard_timeout() in effect! */
 466     while ((res = fcntl(fd, cmd, &lock)) == -1 && errno == EINTR);
 467 #endif
 468     return res;
 469 }
 470
 471 int fcgi_util_gettimeofday(struct timeval *Time) {
 472 #ifdef WIN32
 473     DWORD clock;
 474     time_t t;
 475
 476     clock = GetTickCount();
 477
 478
 479     t = time(NULL);
 480
 481     Time->tv_sec = t; //clock / 1000;
 482     Time->tv_usec = (clock - Time->tv_sec) * 1000;
 483
 484     if (Time->tv_sec == (time_t)-1)
 485         return -1;
 486     else
 487         return 0;
 488 #else
 489     return gettimeofday(Time, NULL);
 490 #endif
 491 }
 492
 493 #ifdef WIN32
 494
 495 FcgiRWLock * fcgi_rdwr_create() {
 496     FcgiRWLock *newlock = NULL;
 497
 498     newlock = (FcgiRWLock *) malloc(sizeof(FcgiRWLock));
 499
 500     if (newlock == NULL)
 501         return NULL;
 502
 503     newlock->read_event = CreateEvent(NULL, TRUE, FALSE, NULL);
 504     newlock->lock_mutex = CreateEvent(NULL, FALSE, TRUE, NULL);
 505     newlock->write_event = CreateMutex(NULL, FALSE, NULL);
 506     newlock->counter = -1;
 507
 508     return newlock;
 509 }
 510
 511 void fcgi_rdwr_destory(FcgiRWLock *lock) {
 512     CloseHandle(lock->read_event);
 513     CloseHandle(lock->lock_mutex);
 514     CloseHandle(lock->write_event);
 515
 516     free(lock);
 517     lock = NULL;
 518 }
 519
 520
 521 int fcgi_rdwr_lock(FcgiRWLock *lock, int type) {
 522
 523     if (lock == NULL)
 524         return -1;
 525
 526     if (type == WRITER) {
 527         WaitForSingleObject(lock->write_event,INFINITE);
 528         WaitForSingleObject(lock->lock_mutex, INFINITE);
 529     }
 530     else {
 531         if (InterlockedIncrement(&lock->counter) == 0) {
 532             WaitForSingleObject(lock->lock_mutex, INFINITE);
 533             SetEvent(lock->read_event);
 534         }
 535
 536         WaitForSingleObject(lock->read_event,INFINITE);
 537     }
 538
 539     return 0;
 540 }
 541
 542 int fcgi_rdwr_try_lock(FcgiRWLock *lock, int type) {
 543     DWORD dwret;
 544
 545     if (lock == NULL)
 546         return -1;
 547
 548     if (type == WRITER) {
 549         dwret = WaitForSingleObject(lock->write_event, 0);
 550         if (dwret == WAIT_TIMEOUT)
 551             return -1;
 552
 553         dwret = WaitForSingleObject(lock->lock_mutex, 0);
 554         if (dwret == WAIT_TIMEOUT)
 555             return -1;
 556     }
 557     else {
 558         if (InterlockedIncrement(&lock->counter) == 0) {
 559             dwret = WaitForSingleObject(lock->lock_mutex, 0);
 560             if (dwret == WAIT_TIMEOUT)
 561                 return -1;
 562
 563             SetEvent(lock->read_event);
 564         }
 565
 566         dwret = WaitForSingleObject(lock->read_event, 0);
 567         if (dwret == WAIT_TIMEOUT)
 568             return -1;
 569     }
 570
 571     return 0;
 572 }
 573
 574 int fcgi_rdwr_unlock(FcgiRWLock *lock, int type) {
 575
 576     if (type == WRITER) {
 577         SetEvent(lock->lock_mutex);
 578         ReleaseMutex(lock->write_event);
 579     }
 580     else {
 581         if (InterlockedDecrement(&lock->counter) < 0) {
 582             ResetEvent(lock->read_event);
 583             SetEvent(lock->lock_mutex);
 584         }
 585     }
 586
 587     return 0;
 588 }
 589 #endif