Start new session for nscd, drop privilegs to configured user if requested
[kopensolaris-gnu/glibc.git] / nscd / nscd.c
1 /* Copyright (c) 1998, 1999, 2000 Free Software Foundation, Inc.
2    This file is part of the GNU C Library.
3    Contributed by Thorsten Kukuk <kukuk@suse.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, group, and hosts.  */
21
22 #include <argp.h>
23 #include <assert.h>
24 #include <errno.h>
25 #include <error.h>
26 #include <libintl.h>
27 #include <locale.h>
28 #include <pthread.h>
29 #include <pwd.h>
30 #include <signal.h>
31 #include <stdio.h>
32 #include <stdlib.h>
33 #include <string.h>
34 #include <syslog.h>
35 #include <unistd.h>
36 #include <sys/socket.h>
37 #include <sys/un.h>
38
39 #include "dbg_log.h"
40 #include "nscd.h"
41
42 /* Get libc version number.  */
43 #include <version.h>
44
45 #define PACKAGE _libc_intl_domainname
46
47 /* Structure used by main() thread to keep track of the number of
48    active threads.  Used to limit how many threads it will create
49    and under a shutdown condition to wait till all in-progress
50    requests have finished before "turning off the lights".  */
51
52 typedef struct
53 {
54   int             num_active;
55   pthread_cond_t  thread_exit_cv;
56   pthread_mutex_t mutex;
57 } thread_info_t;
58
59 thread_info_t thread_info;
60
61 int do_shutdown;
62 int disabled_passwd;
63 int disabled_group;
64 int go_background = 1;
65 const char *server_user;
66
67 int secure[lastdb];
68 int secure_in_use;
69 static const char *conffile = _PATH_NSCDCONF;
70
71 static int check_pid (const char *file);
72 static int write_pid (const char *file);
73 static void drop_privileges (void);
74
75 /* Name and version of program.  */
76 static void print_version (FILE *stream, struct argp_state *state);
77 void (*argp_program_version_hook) (FILE *, struct argp_state *) = print_version;
78
79 /* Definitions of arguments for argp functions.  */
80 static const struct argp_option options[] =
81 {
82   { "config-file", 'f', N_("NAME"), 0,
83     N_("Read configuration data from NAME") },
84   { "debug", 'd', NULL, 0,
85     N_("Do not fork and display messages on the current tty") },
86   { "nthreads", 't', N_("NUMBER"), 0, N_("Start NUMBER threads") },
87   { "shutdown", 'K', NULL, 0, N_("Shut the server down") },
88   { "statistic", 'g', NULL, 0, N_("Print current configuration statistic") },
89   { "invalidate", 'i', N_("TABLE"), 0,
90     N_("Invalidate the specified cache") },
91   { "secure", 'S', N_("TABLE,yes"), 0, N_("Use separate cache for each user")},
92   { NULL, 0, NULL, 0, NULL }
93 };
94
95 /* Short description of program.  */
96 static const char doc[] = N_("Name Service Cache Daemon.");
97
98 /* Prototype for option handler.  */
99 static error_t parse_opt (int key, char *arg, struct argp_state *state);
100
101 /* Data structure to communicate with argp functions.  */
102 static struct argp argp =
103 {
104   options, parse_opt, NULL, doc,
105 };
106
107 int
108 main (int argc, char **argv)
109 {
110   int remaining;
111
112   /* Set locale via LC_ALL.  */
113   setlocale (LC_ALL, "");
114   /* Set the text message domain.  */
115   textdomain (PACKAGE);
116
117   /* Parse and process arguments.  */
118   argp_parse (&argp, argc, argv, 0, &remaining, NULL);
119
120   if (remaining != argc)
121     {
122       error (0, 0, gettext ("wrong number of arguments"));
123       argp_help (&argp, stdout, ARGP_HELP_SEE, program_invocation_short_name);
124       exit (EXIT_FAILURE);
125     }
126
127   /* Check if we are already running. */
128   if (check_pid (_PATH_NSCDPID))
129     error (EXIT_FAILURE, 0, _("already running"));
130
131   /* Behave like a daemon.  */
132   if (go_background)
133     {
134       int i;
135
136       if (fork ())
137         exit (0);
138
139       for (i = 0; i < getdtablesize (); i++)
140         close (i);
141
142       if (fork ())
143         exit (0);
144
145       setsid ();
146
147       chdir ("/");
148
149       openlog ("nscd", LOG_CONS | LOG_ODELAY, LOG_DAEMON);
150
151       if (write_pid (_PATH_NSCDPID) < 0)
152         dbg_log ("%s: %s", _PATH_NSCDPID, strerror (errno));
153
154       /* Ignore job control signals.  */
155       signal (SIGTTOU, SIG_IGN);
156       signal (SIGTTIN, SIG_IGN);
157       signal (SIGTSTP, SIG_IGN);
158     }
159
160   signal (SIGINT, termination_handler);
161   signal (SIGQUIT, termination_handler);
162   signal (SIGTERM, termination_handler);
163   signal (SIGPIPE, SIG_IGN);
164
165   /* Cleanup files created by a previous `bind'.  */
166   unlink (_PATH_NSCDSOCKET);
167
168   /* Init databases.  */
169   nscd_init (conffile);
170
171   /* Change to unprivileged UID if specifed in config file */
172   if(server_user && !secure_in_use)
173     drop_privileges ();
174
175   /* Handle incoming requests */
176   start_threads ();
177
178   return 0;
179 }
180
181
182 /* Handle program arguments.  */
183 static error_t
184 parse_opt (int key, char *arg, struct argp_state *state)
185 {
186   switch (key)
187     {
188     case 'd':
189       ++debug_level;
190       go_background = 0;
191       break;
192
193     case 'f':
194       conffile = arg;
195       break;
196
197     case 'K':
198       if (getuid () != 0)
199         error (EXIT_FAILURE, 0, _("Only root is allowed to use this option!"));
200       {
201         int sock = nscd_open_socket ();
202         request_header req;
203         ssize_t nbytes;
204
205         if (sock == -1)
206           exit (EXIT_FAILURE);
207
208         req.version = NSCD_VERSION;
209         req.type = SHUTDOWN;
210         req.key_len = 0;
211         nbytes = TEMP_FAILURE_RETRY (write (sock, &req,
212                                             sizeof (request_header)));
213         close (sock);
214         exit (nbytes != sizeof (request_header) ? EXIT_FAILURE : EXIT_SUCCESS);
215       }
216
217     case 'g':
218       if (getuid () != 0)
219         error (EXIT_FAILURE, 0, _("Only root is allowed to use this option!"));
220       receive_print_stats ();
221       /* Does not return.  */
222
223     case 'i':
224       if (getuid () != 0)
225         error (EXIT_FAILURE, 0, _("Only root is allowed to use this option!"));
226       else
227         {
228           int sock = nscd_open_socket ();
229           request_header req;
230           ssize_t nbytes;
231
232           if (sock == -1)
233             exit (EXIT_FAILURE);
234
235           if (strcmp (arg, "passwd") == 0)
236             req.key_len = sizeof "passwd";
237           else if (strcmp (arg, "group") == 0)
238             req.key_len = sizeof "group";
239           else if (strcmp (arg, "hosts") == 0)
240             req.key_len = sizeof "hosts";
241           else
242             return ARGP_ERR_UNKNOWN;
243
244           req.version = NSCD_VERSION;
245           req.type = INVALIDATE;
246           nbytes = TEMP_FAILURE_RETRY (write (sock, &req,
247                                               sizeof (request_header)));
248           if (nbytes != sizeof (request_header))
249             {
250               close (sock);
251               exit (EXIT_FAILURE);
252             }
253
254           nbytes = TEMP_FAILURE_RETRY (write (sock, (void *)arg, req.key_len));
255
256           close (sock);
257
258           exit (nbytes != req.key_len ? EXIT_FAILURE : EXIT_SUCCESS);
259         }
260
261     case 't':
262       nthreads = atol (arg);
263       break;
264
265     case 'S':
266       if (strcmp (arg, "passwd,yes") == 0)
267         secure_in_use = secure[pwddb] = 1;
268       else if (strcmp (arg, "group,yes") == 0)
269         secure_in_use = secure[grpdb] = 1;
270       else if (strcmp (arg, "hosts,yes") == 0)
271         secure_in_use = secure[hstdb] = 1;
272       break;
273
274     default:
275       return ARGP_ERR_UNKNOWN;
276     }
277
278   return 0;
279 }
280
281 /* Print the version information.  */
282 static void
283 print_version (FILE *stream, struct argp_state *state)
284 {
285   fprintf (stream, "nscd (GNU %s) %s\n", PACKAGE, VERSION);
286   fprintf (stream, gettext ("\
287 Copyright (C) %s Free Software Foundation, Inc.\n\
288 This is free software; see the source for copying conditions.  There is NO\n\
289 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n\
290 "), "1999");
291   fprintf (stream, gettext ("Written by %s.\n"),
292            "Thorsten Kukuk and Ulrich Drepper");
293 }
294
295
296 /* Create a socket connected to a name.  */
297 int
298 nscd_open_socket (void)
299 {
300   struct sockaddr_un addr;
301   int sock;
302
303   sock = socket (PF_UNIX, SOCK_STREAM, 0);
304   if (sock < 0)
305     return -1;
306
307   addr.sun_family = AF_UNIX;
308   assert (sizeof (addr.sun_path) >= sizeof (_PATH_NSCDSOCKET));
309   strcpy (addr.sun_path, _PATH_NSCDSOCKET);
310   if (connect (sock, (struct sockaddr *) &addr, sizeof (addr)) < 0)
311     {
312       close (sock);
313       return -1;
314     }
315
316   return sock;
317 }
318
319 /* Cleanup.  */
320 void
321 termination_handler (int signum)
322 {
323   close_sockets ();
324
325   /* Clean up the file created by `bind'.  */
326   unlink (_PATH_NSCDSOCKET);
327
328   /* Clean up pid file.  */
329   unlink (_PATH_NSCDPID);
330
331   exit (EXIT_SUCCESS);
332 }
333
334 /* Returns 1 if the process in pid file FILE is running, 0 if not.  */
335 static int
336 check_pid (const char *file)
337 {
338   FILE *fp;
339
340   fp = fopen (file, "r");
341   if (fp)
342     {
343       pid_t pid;
344       int n;
345
346       n = fscanf (fp, "%d", &pid);
347       fclose (fp);
348
349       if (n != 1 || kill (pid, 0) == 0)
350         return 1;
351     }
352
353   return 0;
354 }
355
356 /* Write the current process id to the file FILE.
357    Returns 0 if successful, -1 if not.  */
358 static int
359 write_pid (const char *file)
360 {
361   FILE *fp;
362
363   fp = fopen (file, "w");
364   if (fp == NULL)
365     return -1;
366
367   fprintf (fp, "%d\n", getpid ());
368   if (fflush (fp) || ferror (fp))
369     return -1;
370
371   fclose (fp);
372
373   return 0;
374 }
375
376 /* Look up the uid and gid associated with the user we are supposed to run
377    the server as, and then call setgid(), setgroups(), and setuid().
378    Otherwise, abort- we should not run as root if the configuration file
379    specifically tells us not to. */
380
381 static void
382 drop_privileges (void)
383 {
384   int buflen = 256;
385   char *buffer = alloca (buflen);
386   struct passwd resultbuf;
387   struct passwd *pwd;
388
389   while (__getpwnam_r (server_user, &resultbuf, buffer, buflen, &pwd) != 0
390          && errno == ERANGE)
391     {
392       errno = 0;
393       buflen += 256;
394       buffer = alloca (buflen);
395     }
396
397   if(!pwd)
398     {
399       dbg_log (_("Failed to look up user '%s' to run server as"),
400                server_user);
401       exit(1);
402     }
403
404   setgroups (0, NULL);
405   setgid (pwd->pw_gid);
406   setuid (pwd->pw_uid);
407 }