chiark / gitweb /
spec.sgml: Update for update copyright notices
[userv.git] / overlord.c
1 /*
2  * userv - overlord.c
3  * daemon main program, collects request and forks handlers
4  *
5  * Copyright (C)1996-1997,1999 Ian Jackson
6  *
7  * This is free software; you can redistribute it and/or modify it
8  * under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with userv; if not, write to the Free Software
19  * Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
20  */
21
22 #include <unistd.h>
23 #include <signal.h>
24 #include <syslog.h>
25 #include <errno.h>
26 #include <string.h>
27 #include <stdio.h>
28 #include <stdlib.h>
29 #include <assert.h>
30 #include <fnmatch.h>
31 #include <sys/wait.h>
32 #include <sys/types.h>
33 #include <sys/stat.h>
34 #include <sys/socket.h>
35 #include <fcntl.h>
36 #include <time.h>
37 #include <dirent.h>
38 #include <sys/un.h>
39
40 #include "config.h"
41 #include "common.h"
42 #include "daemon.h"
43
44 pid_t overlordpid;
45
46 static pid_t checkpid= -1, detachpid= -1;
47 static sig_atomic_t needcheck= 1; /* 2 means we half-expect the server to be down */
48
49 static void checkstalepipes(void) {
50   /* There is an unimportant race here.  If there is a stale pipe but
51    * another pair of processes with the same pids is about to create a
52    * new one we can check that the pipe is stale before they recreate
53    * it but then only remove it afterwards; then we remove the pipe
54    * they're actually using causing that invocation to fail with
55    * ENOENT on the pipe.  However, this can only happen if things are
56    * already shafted, because we check for stale pipes at startup
57    * before any children have been started, and then only when a child
58    * dies unhelpfully - and we actually have to have some stale pipes
59    * for the race to exist.
60    */
61   DIR *dir;
62   struct dirent *de;
63   struct stat stab;
64   time_t now;
65   unsigned long timediff;
66   int r;
67   
68   if (time(&now) == -1) { syslog(LOG_ERR,"get current time: %m"); return; }
69   dir= opendir(".");
70   if (!dir) { syslog(LOG_ERR,"open directory " VARDIR ": %m"); return; }
71   while ((errno=0, de= readdir(dir))) {
72     if (fnmatch(PIPEPATTERN,de->d_name,FNM_PATHNAME|FNM_PERIOD)) continue;
73     r= lstat(de->d_name,&stab); if (r && errno==ENOENT) continue;
74     if (r) { syslog(LOG_ERR,"could not stat `" VARDIR "/%s': %m",de->d_name); continue; }
75     timediff= (unsigned long)now - (unsigned long)stab.st_ctime;
76     if (timediff >= (~0UL>>1) || timediff < 3600) continue;
77     if (unlink(de->d_name) && errno!=ENOENT)
78       syslog(LOG_ERR,"could not remove stale pipe `%s': %m",de->d_name);
79   }
80   if (errno) syslog(LOG_ERR,"read directory " VARDIR ": %m");
81   if (closedir(dir)) syslog(LOG_ERR,"close directory " VARDIR ": %m");
82 }
83
84 static void sighandler_chld(int x) {
85   pid_t r;
86   int status, es;
87
88   es= errno;
89   for (;;) {
90     r= waitpid((pid_t)-1,&status,WNOHANG);
91     if (!r || (r==-1 && errno==ECHILD)) break;
92     if (r==-1) { syslog(LOG_ERR,"wait in sigchild handler gave error: %m"); break; }
93     if (r==detachpid) {
94       if (WIFEXITED(status) && WEXITSTATUS(status)==4) _exit(4);
95       fprintf(stderr,"uservd: detaching child failed with unexpected code %d\n",status);
96       exit(6);
97     }
98     if (r==checkpid) {
99       if (WIFEXITED(status)) {
100         if (!WEXITSTATUS(status)) {
101           syslog(LOG_WARNING,"no longer the uservd - exiting");
102           _exit(2);
103         } else if (WEXITSTATUS(status)!=1) {
104           syslog(LOG_ERR,"check pid %ld exited with status %d",
105                  (long)checkpid,WEXITSTATUS(status));
106         }
107       } else if (WIFSIGNALED(status)) {
108         if (WTERMSIG(status) == SIGALRM && !WCOREDUMP(status)) {
109           syslog(LOG_WARNING,"check timed out; no longer the uservd - exiting");
110           _exit(2);
111         } else {
112           syslog(LOG_ERR,"check pid %ld %s due to signal %s",
113                  (long)checkpid,
114                  WCOREDUMP(status) ? "dumped core" : "died",
115                  strsignal(WTERMSIG(status)));
116         }
117       } else {
118         syslog(LOG_ERR,"check pid %ld died due to unknown reason, code %d",
119                (long)checkpid,status);
120       }
121       checkpid= -1;
122       alarm(USERVD_MYSELF_CHECK);
123     } else {
124       if (WIFSIGNALED(status)) {
125         syslog(LOG_ERR,"call pid %ld %s due to signal %s",
126                (long)r,
127                WCOREDUMP(status) ? "dumped core" : "died",
128                strsignal(WTERMSIG(status)));
129       } else if (!WIFEXITED(status)) {
130         syslog(LOG_ERR,"call pid %ld died due to unknown reason, code %d",
131                (long)r,status);
132       } else if (WEXITSTATUS(status)==10) {
133         needcheck= 2;
134       } else if (WEXITSTATUS(status)>12) {
135         if (WEXITSTATUS(status)>24)
136           syslog(LOG_ERR,"call pid %ld exited with status %d >24",
137                  (long)r,WEXITSTATUS(status));
138         checkstalepipes();
139         needcheck= 1;
140       }
141     }
142   }
143   errno= es;
144   return;
145 }
146
147 static void sighandler_usr1(int x) {
148   _exit(0);
149 }
150
151 static void sighandler_alrm(int x) {
152   needcheck= 1;
153 }
154
155 static void sighandler_termint(int sig) {
156   syslog(LOG_NOTICE,"terminating due to signal %s",strsignal(sig));
157   _exit(1);
158 }
159
160 static void blocksignals(int how) {
161   int r;
162   sigset_t set;
163
164   sigemptyset(&set);
165   sigaddset(&set,SIGCHLD);
166   sigaddset(&set,SIGALRM);
167   sigaddset(&set,SIGTERM);
168   sigaddset(&set,SIGINT);
169   r= sigprocmask(how,&set,0); assert(!r);
170 }
171
172 static void NONRETURNING docheck(int needwanted) {
173 #ifndef DEBUG
174   /* This subprocess exits with status 0 if the parent should die,
175    * 1 if it should not, and something else if it fails horribly.
176    */
177   int sfd, r, remain;
178   unsigned char *p;
179   struct opening_msg opening_mbuf;
180   struct request_msg request_mbuf;
181   unsigned long endmagic;
182   struct sigaction sig;
183   struct sockaddr_un ssockname;
184
185   openlog(USERVDCHECK_LOGIDENT,LOG_NDELAY|LOG_PID,USERVD_LOGFACILITY);
186
187   sigemptyset(&sig.sa_mask);
188   sig.sa_flags= 0;
189   sig.sa_handler= SIG_IGN;
190   if (sigaction(SIGPIPE,&sig,0)) { syslog(LOG_ERR,"ignore sigpipe"); exit(1); }
191
192   sig.sa_handler= SIG_DFL;
193   if (sigaction(SIGALRM,&sig,0)) { syslog(LOG_ERR,"default sigalarm"); exit(1); }
194
195   sfd= socket(AF_UNIX,SOCK_STREAM,0);
196   if (!sfd) { syslog(LOG_ERR,"ignore sigpipe"); exit(1); }
197
198   assert(sizeof(ssockname.sun_path) > sizeof(RENDEZVOUS));
199   ssockname.sun_family= AF_UNIX;
200   strcpy(ssockname.sun_path,RENDEZVOUS);
201
202   r= connect(sfd,(struct sockaddr*)&ssockname,sizeof(ssockname));
203   if (r) {
204     if (errno == ECONNREFUSED || errno == ENOENT) {
205       if (needwanted != 2)
206         syslog(LOG_WARNING,"real uservd daemon is not running: %m");
207       exit(0);
208     }
209     syslog(LOG_ERR,"unable to connect to uservd daemon: %m"); exit(1);
210   }
211
212   alarm(USERVD_MYSELF_TIMEOUT);
213   remain= sizeof(opening_mbuf); p= (unsigned char*)&opening_mbuf;
214   while (remain) {
215     r= read(sfd,p,remain);
216     if (r<0) { syslog(LOG_ERR,"read from server: %m"); exit(1); }
217     if (r==0) { syslog(LOG_ERR,"unexpected EOF from server"); exit(1); }
218     remain-= r; p+= r;
219   }
220   if (opening_mbuf.magic != OPENING_MAGIC) {
221     syslog(LOG_WARNING,"magic number mismatch");
222     exit(0);
223   }
224   if (memcmp(opening_mbuf.protocolchecksumversion,protocolchecksumversion,PCSUMSIZE)) {
225     syslog(LOG_WARNING,"protocol checksum mismatch");
226     exit(0);
227   }
228   if (opening_mbuf.overlordpid != overlordpid) {
229     syslog(LOG_WARNING,"overlord pid mismatch");
230     exit(0);
231   }
232   memset(&request_mbuf,0,sizeof(request_mbuf));
233   request_mbuf.magic= REQUEST_MAGIC;
234   request_mbuf.clientpid= -1;
235   request_mbuf.serviceuserlen= 0;
236   request_mbuf.servicelen= 0;
237   request_mbuf.loginnamelen= 0;
238   request_mbuf.spoofed= 0;
239   request_mbuf.cwdlen= 0;
240   request_mbuf.overridelen= -1;
241   request_mbuf.callinguid= -1;
242   request_mbuf.ngids= 0;
243   request_mbuf.nreadfds= 0;
244   request_mbuf.nwritefds= 0;
245   request_mbuf.nargs= 0;
246   request_mbuf.nvars= 0;
247   r= write(sfd,&request_mbuf,sizeof(request_mbuf));
248   if (r==sizeof(request_mbuf)) {
249     endmagic= REQUEST_END_MAGIC;
250     write(sfd,&endmagic,sizeof(endmagic));
251   }
252   syslog(LOG_NOTICE,"uservd[%ld] is running",(long)overlordpid);
253 #endif
254   exit(1);
255 }
256
257 static void NONRETURNING startupsyscallerr(const char *what) {
258   fprintf(stderr,
259           "uservd: system call failed during startup:\n"
260           "uservd: %s: %s\n",
261           what,strerror(errno));
262   exit(4);
263 }
264
265 int main(int argc, char *const *argv) {
266   int mfd, sfd, nfd, e, r, becomedaemon;
267   socklen_t csocklen;
268   struct sigaction sigact;
269   struct sockaddr_un ssockname, csockname;
270   pid_t child, parentpid, sid;
271
272 #ifdef NDEBUG
273   abort(); /* Do not disable assertions in this security-critical code ! */
274 #endif
275
276   becomedaemon= 0;
277   
278   if (argv[1] && !strcmp(argv[1],"-daemon")) {
279     becomedaemon= 1;
280     argv++; argc--;
281   }
282   if (argc>1) { fputs("usage: uservd [-daemon]\n",stderr); exit(3); }
283
284   openlog(USERVD_LOGIDENT,LOG_NDELAY|LOG_PID,USERVD_LOGFACILITY);
285
286   if (chdir(VARDIR)) startupsyscallerr("cannot change to " VARDIR);
287   checkstalepipes();
288
289   overlordpid= parentpid= getpid();
290   if (parentpid==-1) startupsyscallerr("cannot getpid");
291
292   mfd= socket(AF_UNIX,SOCK_STREAM,0);
293   if (mfd<0) startupsyscallerr("cannot create master socket");
294
295   assert(sizeof(ssockname.sun_path) > sizeof(RENDEZVOUS));
296   ssockname.sun_family= AF_UNIX;
297   strcpy(ssockname.sun_path,RENDEZVOUS);
298   unlink(RENDEZVOUS);
299   r= bind(mfd,(struct sockaddr*)&ssockname,sizeof(ssockname));
300   if (r) startupsyscallerr("cannot bind master socket");
301   if (listen(mfd,5)) startupsyscallerr("cannot listen on master socket");
302
303   sigemptyset(&sigact.sa_mask);
304   sigaddset(&sigact.sa_mask,SIGCHLD);
305   sigaddset(&sigact.sa_mask,SIGALRM);
306   sigact.sa_flags= SA_NOCLDSTOP;
307
308   sigact.sa_handler= sighandler_chld;
309   if (sigaction(SIGCHLD,&sigact,0)) startupsyscallerr("cannot setup sigchld handler");
310
311   sigact.sa_handler= sighandler_alrm;
312   if (sigaction(SIGALRM,&sigact,0)) startupsyscallerr("cannot setup sigalrm handler");
313
314   if (becomedaemon) {
315     sigact.sa_handler= sighandler_usr1;
316     if (sigaction(SIGUSR1,&sigact,0)) startupsyscallerr("cannot setup sigusr1 handler");
317     
318     detachpid= fork(); if (detachpid==-1) startupsyscallerr("cannot fork to detach");
319     if (detachpid) {
320       pause();
321       fputs("uservd: pause unexpectedly returned during detach\n",stderr);
322       exit(4);
323     }
324     sigact.sa_handler= SIG_DFL;
325     if (sigaction(SIGUSR1,&sigact,0)) startupsyscallerr("cannot restore sigusr1");
326   }
327
328   sigact.sa_handler= sighandler_termint;
329   if (sigaction(SIGTERM,&sigact,0)) startupsyscallerr("cannot setup sigterm handler");
330   if (sigaction(SIGINT,&sigact,0)) startupsyscallerr("cannot setup sigint handler");
331
332   if (becomedaemon) {
333     nfd= open("/dev/null",O_RDWR);
334     if (nfd<0) startupsyscallerr("cannot open /dev/null");
335     sid= setsid(); if (sid == -1) startupsyscallerr("cannot create new session");
336     overlordpid= getpid();
337     if (overlordpid == -1) startupsyscallerr("getpid after detach");
338     if (dup2(nfd,0)<0 || dup2(nfd,1)<0)
339       startupsyscallerr("cannot dup /dev/null for stdin/out");
340     r= kill(parentpid,SIGUSR1); if (r) startupsyscallerr("send SIGUSR1 to detach");
341     r= dup2(nfd,2);
342     if (r<0) { syslog(LOG_CRIT,"cannot dup /dev/null for stderr: %m"); exit(5); }
343     close(nfd);
344   }
345
346   syslog(LOG_NOTICE,"started");
347
348   for (;;) {
349     if (needcheck) {
350       while (checkpid==-1) {
351         checkpid= fork();
352         if (checkpid!=-1) {
353           if (!checkpid) docheck(needcheck);
354           break;
355         } else if (errno==EAGAIN) {
356           syslog(LOG_ERR,"fork for check - will wait and retry: %m");
357           alarm(USERVD_CHECKFORK_RETRY);
358           break;
359         } else if (errno!=EINTR) {
360           syslog(LOG_CRIT,"fork for check: %m"); exit(5);
361         }
362       }
363       needcheck= 0;
364     }
365     csocklen= sizeof(csockname);
366     blocksignals(SIG_UNBLOCK);
367     sfd= accept(mfd,(struct sockaddr*)&csockname,&csocklen);
368     e= errno;
369     blocksignals(SIG_BLOCK);
370     if (sfd<0) {
371       errno= e;
372       if (errno == EINTR) continue;
373       if (errno == ENOMEM || errno == EPROTO || errno == EAGAIN) {
374         syslog(LOG_ERR,"unable to accept connection: %m");
375         continue;
376       } else {
377         syslog(LOG_CRIT,"unable to accept new connections: %m");
378         exit(5);
379       }
380     }
381     child= nondebug_fork();
382     if (child == (pid_t)-1) {
383       syslog(LOG_ERR,"unable to fork server: %m");
384       close(sfd);
385       continue;
386     }
387     if (!child) {
388       close(mfd);
389       closelog();
390       blocksignals(SIG_UNBLOCK);
391       servicerequest(sfd);
392     }
393     close(sfd);
394   }
395 }