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