nscd/nscd.c

   1 /* Copyright (c) 1998 Free Software Foundation, Inc.
   2    This file is part of the GNU C Library.
   3    Contributed by Thorsten Kukuk <kukuk@vt.uni-paderborn.de>, 1998.
   4
   5    The GNU C Library is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU Library General Public License as
   7    published by the Free Software Foundation; either version 2 of the
   8    License, or (at your option) any later version.
   9
  10    The GNU C Library is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13    Library General Public License for more details.
  14
  15    You should have received a copy of the GNU Library General Public
  16    License along with the GNU C Library; see the file COPYING.LIB.  If not,
  17    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18    Boston, MA 02111-1307, USA. */
  19
  20 /* nscd - Name Service Cache Daemon. Caches passwd and group.  */
  21
  22 #include <argp.h>
  23 #include <errno.h>
  24 #include <error.h>
  25 #include <libintl.h>
  26 #include <locale.h>
  27 #include <pthread.h>
  28 #include <pwd.h>
  29 #include <signal.h>
  30 #include <stdio.h>
  31 #include <stdlib.h>
  32 #include <string.h>
  33 #include <syslog.h>
  34 #include <unistd.h>
  35 #include <sys/socket.h>
  36 #include <sys/un.h>
  37
  38 #include "dbg_log.h"
  39 #include "nscd.h"
  40
  41 /* Get libc version number.  */
  42 #include <version.h>
  43
  44 #define PACKAGE _libc_intl_domainname
  45
  46 /* Structure used by main() thread to keep track of the number of
  47    active threads.  Used to limit how many threads it will create
  48    and under a shutdown condition to wait till all in-progress
  49    requests have finished before "turning off the lights".  */
  50
  51 typedef struct
  52 {
  53   int             num_active;
  54   pthread_cond_t  thread_exit_cv;
  55   pthread_mutex_t mutex;
  56 } thread_info_t;
  57
  58 thread_info_t thread_info;
  59
  60 int do_shutdown = 0;
  61 int disabled_passwd = 0;
  62 int disabled_group = 0;
  63 int go_background = 1;
  64 const char *conffile = _PATH_NSCDCONF;
  65
  66 static void termination_handler (int signum);
  67 static int check_pid (const char *file);
  68 static int write_pid (const char *file);
  69 static void handle_requests (void);
  70
  71 /* Name and version of program.  */
  72 static void print_version (FILE *stream, struct argp_state *state);
  73 void (*argp_program_version_hook) (FILE *, struct argp_state *) = print_version;
  74
  75 /* Definitions of arguments for argp functions.  */
  76 static const struct argp_option options[] =
  77 {
  78   { "config-file", 'f', N_("NAME"), 0,
  79     N_("Read configuration data from NAME") },
  80   { "debug", 'd', NULL, 0,
  81     N_("Do not fork and display messages on the current tty") },
  82   { "shutdown", 'K', NULL, 0, N_("Shut the server down") },
  83   { "statistic", 'g', NULL, 0, N_("Print current configuration statistic") },
  84   { NULL, 0, NULL, 0, NULL }
  85 };
  86
  87 /* Short description of program.  */
  88 static const char doc[] = N_("Name Switch Cache Daemon.");
  89
  90 /* Prototype for option handler.  */
  91 static error_t parse_opt __P ((int key, char *arg, struct argp_state *state));
  92
  93 /* Data structure to communicate with argp functions.  */
  94 static struct argp argp =
  95 {
  96   options, parse_opt, NULL, doc,
  97 };
  98
  99 int
 100 main (int argc, char **argv)
 101 {
 102   int remaining;
 103
 104   /* Set locale via LC_ALL.  */
 105   setlocale (LC_ALL, "");
 106   /* Set the text message domain.  */
 107   textdomain (PACKAGE);
 108
 109   /* Parse and process arguments.  */
 110   argp_parse (&argp, argc, argv, 0, &remaining, NULL);
 111
 112   if (remaining != argc)
 113     {
 114       error (0, 0, gettext ("wrong number of arguments"));
 115       argp_help (&argp, stdout, ARGP_HELP_SEE, program_invocation_short_name);
 116       exit (EXIT_FAILURE);
 117     }
 118
 119   signal (SIGINT, termination_handler);
 120   signal (SIGQUIT, termination_handler);
 121   signal (SIGTERM, termination_handler);
 122   signal (SIGPIPE, SIG_IGN);
 123
 124   /* Check if we are already running. */
 125   if (check_pid (_PATH_NSCDPID))
 126     {
 127       fputs (_("already running"), stderr);
 128       exit (EXIT_FAILURE);
 129     }
 130
 131   /* Behave like a daemon.  */
 132   if (go_background)
 133     {
 134       openlog ("nscd", LOG_CONS | LOG_ODELAY, LOG_DAEMON);
 135
 136       if (daemon (0, 0) < 0)
 137         {
 138           fprintf (stderr, _("connot auto-background: %s\n"),
 139                    strerror (errno));
 140           exit (EXIT_FAILURE);
 141         }
 142       if (write_pid (_PATH_NSCDPID) < 0)
 143         dbg_log ("%s: %s", _PATH_NSCDPID, strerror (errno));
 144
 145       /* Ignore job control signals */
 146       signal (SIGTTOU, SIG_IGN);
 147       signal (SIGTTIN, SIG_IGN);
 148       signal (SIGTSTP, SIG_IGN);
 149     }
 150   /* Cleanup files created by a previous `bind' */
 151   unlink (_PATH_NSCDSOCKET);
 152
 153   nscd_parse_file (conffile);
 154
 155   /* Create first sockets */
 156   init_sockets ();
 157   /* Init databases */
 158   if ((cache_pwdinit () < 0) || (cache_grpinit () < 0))
 159     {
 160       fputs (_("Not enough memory\n"), stderr);
 161       return 1;
 162     }
 163   /* Handle incoming requests */
 164   handle_requests ();
 165
 166   return 0;
 167 }
 168
 169
 170 /* Handle program arguments.  */
 171 static error_t
 172 parse_opt (int key, char *arg, struct argp_state *state)
 173 {
 174   switch (key)
 175     {
 176     case 'd':
 177       debug_flag = 1;
 178       go_background = 0;
 179       break;
 180     case 'f':
 181       conffile = arg;
 182       break;
 183     case 'K':
 184       if (getuid () != 0)
 185         {
 186           printf (_("Only root is allowed to use this option!\n\n"));
 187           exit (EXIT_FAILURE);
 188         }
 189       {
 190         int sock = __nscd_open_socket ();
 191         request_header req;
 192         ssize_t nbytes;
 193
 194         if (sock == -1)
 195           exit (EXIT_FAILURE);
 196
 197         req.version = NSCD_VERSION;
 198         req.type = SHUTDOWN;
 199         req.key_len = 0;
 200         nbytes = write (sock, &req, sizeof (request_header));
 201         close (sock);
 202         if (nbytes != req.key_len)
 203           exit (EXIT_FAILURE);
 204         else
 205           exit (EXIT_SUCCESS);
 206       }
 207     case 'g':
 208       print_stat ();
 209       exit (EXIT_SUCCESS);
 210     default:
 211       return ARGP_ERR_UNKNOWN;
 212     }
 213   return 0;
 214 }
 215
 216 /* Print the version information.  */
 217 static void
 218 print_version (FILE *stream, struct argp_state *state)
 219 {
 220   fprintf (stream, "nscd (GNU %s) %s\n", PACKAGE, VERSION);
 221   fprintf (stream, gettext ("\
 222 Copyright (C) %s Free Software Foundation, Inc.\n\
 223 This is free software; see the source for copying conditions.  There is NO\n\
 224 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n\
 225 "), "1998");
 226   fprintf (stream, gettext ("Written by %s.\n"), "Thorsten Kukuk");
 227 }
 228
 229
 230 /* Create a socket connected to a name. */
 231 int
 232 __nscd_open_socket (void)
 233 {
 234   struct sockaddr_un addr;
 235   int sock;
 236
 237   sock = socket (PF_UNIX, SOCK_STREAM, 0);
 238   if (sock < 0)
 239     return -1;
 240
 241   addr.sun_family = AF_UNIX;
 242   strcpy (addr.sun_path, _PATH_NSCDSOCKET);
 243   if (connect (sock, (struct sockaddr *) &addr, sizeof (addr)) < 0)
 244     {
 245       close (sock);
 246       return -1;
 247     }
 248
 249   return sock;
 250 }
 251
 252 /* Cleanup.  */
 253 static void
 254 termination_handler (int signum)
 255 {
 256   close_sockets ();
 257
 258   /* Clean up the files created by `bind'.  */
 259   unlink (_PATH_NSCDSOCKET);
 260
 261   /* Clean up pid file.  */
 262   unlink (_PATH_NSCDPID);
 263
 264   exit (EXIT_SUCCESS);
 265 }
 266
 267 /* Returns 1 if the process in pid file FILE is running, 0 if not.  */
 268 static int
 269 check_pid (const char *file)
 270 {
 271   FILE *fp;
 272
 273   fp = fopen (file, "r");
 274   if (fp)
 275     {
 276       pid_t pid;
 277
 278       fscanf (fp, "%d", &pid);
 279       fclose (fp);
 280
 281       if (kill (pid, 0) == 0)
 282         return 1;
 283     }
 284
 285   return 0;
 286 }
 287
 288 /* Write the current process id to the file FILE.
 289    Returns 0 if successful, -1 if not.  */
 290 static int
 291 write_pid (const char *file)
 292 {
 293   FILE *fp;
 294
 295   fp = fopen (file, "w");
 296   if (fp == NULL)
 297     return -1;
 298
 299   fprintf (fp, "%d\n", getpid ());
 300   if (ferror (fp))
 301     return -1;
 302
 303   fclose (fp);
 304
 305   return 0;
 306 }
 307
 308 /* Type of the lookup function for netname2user.  */
 309 typedef int (*pwbyname_function) (const char *name, struct passwd *pw,
 310                                    char *buffer, size_t buflen);
 311
 312 /* Hanlde incoming requests.  */
 313 static
 314 void handle_requests (void)
 315 {
 316   request_header req;
 317   int conn; /* Handle on which connection (client) the request came from.  */
 318   int done = 0;
 319   char *key;
 320
 321   while (!done)
 322     {
 323       key = NULL;
 324       get_request (&conn, &req, &key);
 325       if (debug_flag)
 326         dbg_log (_("handle_requests: request received (Version = %d)"),
 327                  req.version);
 328       switch (req.type)
 329         {
 330         case GETPWBYNAME:
 331           {
 332             param_t *param = malloc (sizeof (param_t));
 333             pthread_t thread;
 334
 335             if (debug_flag)
 336               dbg_log ("\tGETPWBYNAME (%s)", key);
 337             param->key = key;
 338             param->conn = conn;
 339             if (disabled_passwd)
 340               pthread_create (&thread, NULL, cache_pw_disabled, (void *)param);
 341             else
 342               pthread_create (&thread, NULL, cache_getpwnam, (void *)param);
 343             pthread_detach (thread);
 344           }
 345           break;
 346         case GETPWBYUID:
 347           {
 348             param_t *param = malloc (sizeof (param_t));
 349             pthread_t thread;
 350
 351             if (debug_flag)
 352               dbg_log ("\tGETPWBYUID (%s)", key);
 353             param->key = key;
 354             param->conn = conn;
 355             if (disabled_passwd)
 356               pthread_create (&thread, NULL, cache_pw_disabled, (void *)param);
 357             else
 358               pthread_create (&thread, NULL, cache_getpwuid, (void *)param);
 359             pthread_detach (thread);
 360           }
 361           break;
 362         case GETGRBYNAME:
 363           {
 364             param_t *param = malloc (sizeof (param_t));
 365             pthread_t thread;
 366
 367             if (debug_flag)
 368               dbg_log ("\tGETGRBYNAME (%s)", key);
 369             param->key = key;
 370             param->conn = conn;
 371             if (disabled_group)
 372               pthread_create (&thread, NULL, cache_gr_disabled, (void *)param);
 373             else
 374               pthread_create (&thread, NULL, cache_getgrnam, (void *)param);
 375             pthread_detach (thread);
 376           }
 377           break;
 378         case GETGRBYGID:
 379           {
 380             param_t *param = malloc (sizeof (param_t));
 381             pthread_t thread;
 382
 383             if (debug_flag)
 384               dbg_log ("\tGETGRBYGID (%s)", key);
 385             param->key = key;
 386             param->conn = conn;
 387             if (disabled_group)
 388               pthread_create (&thread, NULL, cache_gr_disabled, (void *)param);
 389             else
 390               pthread_create (&thread, NULL, cache_getgrgid, (void *)param);
 391             pthread_detach (thread);
 392           }
 393           break;
 394         case GETHOSTBYNAME:
 395           /* Not yetimplemented.  */
 396           close_socket (conn);
 397           break;
 398         case GETHOSTBYADDR:
 399           /* Not yet implemented. */
 400           close_socket (conn);
 401           break;
 402         case SHUTDOWN:
 403           do_shutdown = 1;
 404           close_socket (0);
 405           close_socket (conn);
 406           /* Clean up the files created by `bind'.  */
 407           unlink (_PATH_NSCDSOCKET);
 408           /* Clean up pid file.  */
 409           unlink (_PATH_NSCDPID);
 410           done = 1;
 411           break;
 412         case GETSTAT:
 413           {
 414             stat_response_header resp;
 415
 416             if (debug_flag)
 417               dbg_log ("\tGETSTAT");
 418
 419             get_pw_stat (&resp);
 420             get_gr_stat (&resp);
 421             resp.debug_level = debug_flag;
 422             resp.pw_enabled = !disabled_passwd;
 423             resp.gr_enabled = !disabled_group;
 424
 425             stat_send (conn, &resp);
 426
 427             close_socket (conn);
 428           }
 429           break;
 430         default:
 431           dbg_log (_("Unknown request (%d)"), req.type);
 432           break;
 433         }
 434     }
 435 }