2 * This file is part of secnet.
3 * See README for full list of copyright holders.
5 * secnet is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 3 of the License, or
8 * (at your option) any later version.
10 * secnet is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * version 3 along with secnet; if not, see
17 * https://www.gnu.org/licenses/gpl.html.
28 #include <sys/socket.h>
29 #include <arpa/inet.h>
38 /* apple's poll() does not work on char devs */
42 /* XXX should be from autoconf */
43 static const char *configfile
="/etc/secnet/secnet.conf";
44 static const char *sites_key
="sites";
45 bool_t just_check_config
=False
;
46 static char *userid
=NULL
;
49 bool_t background
=True
;
50 static char *pidfile
=NULL
;
51 bool_t require_root_privileges
=False
;
52 cstring_t require_root_privileges_explanation
=NULL
;
54 static pid_t secnet_pid
;
56 /* Structures dealing with poll() call */
57 struct poll_interest
{
58 beforepoll_fn
*before
; /* 0 if deregistered and waiting to be deleted */
63 LIST_ENTRY(poll_interest
) entry
;
65 static LIST_HEAD(, poll_interest
) reg
= LIST_HEAD_INITIALIZER(®
);
67 static bool_t
interest_isregistered(const struct poll_interest
*i
)
72 static bool_t finished
=False
;
74 /* Parse the command line options */
75 static void parse_options(int argc
, char **argv
)
81 static struct option long_options
[] = {
82 {"verbose", 0, 0, 'v'},
83 {"nowarnings", 0, 0, 'w'},
86 {"nodetach", 0, 0, 'n'},
87 {"managed", 0, 0, 'm'},
88 {"silent", 0, 0, 'f'},
91 {"config", 1, 0, 'c'},
92 {"just-check-config", 0, 0, 'j'},
93 {"sites-key", 1, 0, 's'},
97 c
=getopt_long(argc
, argv
, "vwdnjc:ft:s:m",
98 long_options
, &option_index
);
105 printf("Usage: secnet [OPTION]...\n\n"
106 " -f, --silent, --quiet suppress error messages\n"
107 " -w, --nowarnings suppress warnings\n"
108 " -v, --verbose output extra diagnostics\n"
109 " -c, --config=filename specify a configuration file\n"
110 " -j, --just-check-config stop after reading "
111 "configuration file\n"
112 " -s, --sites-key=name configuration key that "
113 "specifies active sites\n"
114 " -n, --nodetach do not run in background\n"
115 " -m, --managed running under a supervisor\n"
116 " -d, --debug output debug messages\n"
117 " --help display this help and exit\n"
118 " --version output version information "
126 printf("%s\n",version
);
131 message_level
|=M_DEBUG_CONFIG
|M_DEBUG_PHASE
|M_DEBUG
;
134 message_level
|=M_INFO
|M_NOTICE
|M_WARNING
|M_ERR
|M_SECURITY
|
139 message_level
&=(~M_WARNING
);
143 message_level
=M_FATAL
;
151 secnet_is_daemon
=True
;
156 configfile
=safe_strdup(optarg
,"config_filename");
158 fatal("secnet: no config filename specified");
162 just_check_config
=True
;
167 sites_key
=safe_strdup(optarg
,"sites-key");
169 fatal("secnet: no sites key specified");
177 Message(M_ERR
,"secnet: Unknown getopt code %c\n",c
);
181 if (argc
-optind
!= 0) {
182 Message(M_ERR
,"secnet: You gave extra command line parameters, "
183 "which were ignored.\n");
187 static void setup(dict_t
*config
)
196 l
=dict_lookup(config
,"system");
198 if (!l
|| list_elem(l
,0)->type
!=t_dict
) {
199 fatal("configuration does not include a \"system\" dictionary");
201 system
=list_elem(l
,0)->data
.dict
;
202 loc
=list_elem(l
,0)->loc
;
204 /* Arrange systemwide log facility */
205 l
=dict_lookup(system
,"log");
207 fatal("configuration does not include a system/log facility");
209 system_log
=init_log(l
);
211 /* Who are we supposed to run as? */
212 userid
=dict_read_string(system
,"userid",False
,"system",loc
);
214 if (!(pw
=getpwnam(userid
)))
215 fatal("userid \"%s\" not found",userid
);
221 pidfile
=dict_read_string(system
,"pidfile",False
,"system",loc
);
223 /* Check whether we need root privileges */
224 if (require_root_privileges
&& uid
!=0) {
225 fatal("the configured feature \"%s\" requires "
226 "that secnet retain root privileges while running.",
227 require_root_privileges_explanation
);
230 /* Go along site list, starting sites */
231 l
=dict_lookup(config
,sites_key
);
233 Message(M_WARNING
,"secnet: configuration key \"%s\" is missing; no "
234 "remote sites are defined\n",sites_key
);
237 while ((site
=list_elem(l
, i
++))) {
239 if (site
->type
!=t_closure
) {
240 cfgfatal(site
->loc
,"system","non-closure in site list");
242 if (site
->data
.closure
->type
!=CL_SITE
) {
243 cfgfatal(site
->loc
,"system","non-site closure in site list");
245 s
=site
->data
.closure
->interface
;
246 s
->control(s
->st
,True
);
251 struct poll_interest
*register_for_poll(void *st
, beforepoll_fn
*before
,
252 afterpoll_fn
*after
, cstring_t desc
)
254 struct poll_interest
*i
;
262 LIST_INSERT_HEAD(®
, i
, entry
);
266 void deregister_for_poll(struct poll_interest
*i
)
268 /* We cannot simply throw this away because we're reentrantly
269 * inside the main loop, which needs to remember which range of
270 * fds corresponds to this now-obsolete interest */
274 static void system_phase_hook(void *sst
, uint32_t newphase
)
276 if (newphase
==PHASE_SHUTDOWN
&& pidfile
) {
277 /* Try to unlink the pidfile; don't care if it fails */
283 static int fakepoll(struct pollfd
*fds
, int nfds
, int timeout
) {
284 fd_set infds
[1], outfds
[1];
285 int maxfd
= -1, i
, rc
;
286 struct timeval tvtimeout
;
289 for(i
= 0; i
< nfds
; ++i
) {
290 if(fds
[i
].events
& POLLIN
)
291 FD_SET(fds
[i
].fd
, infds
);
292 if(fds
[i
].events
& POLLOUT
)
293 FD_SET(fds
[i
].fd
, outfds
);
294 if(fds
[i
].fd
> maxfd
)
298 tvtimeout
.tv_sec
= timeout
/ 1000;
299 tvtimeout
.tv_usec
= 1000 * (timeout
% 1000);
301 rc
= select(maxfd
+ 1, infds
, outfds
, NULL
,
302 timeout
== -1 ? NULL
: &tvtimeout
);
304 for(i
= 0; i
< nfds
; ++i
) {
306 if(FD_ISSET(fds
[i
].fd
, infds
))
308 if(FD_ISSET(fds
[i
].fd
, outfds
))
310 fds
[i
].revents
= revents
;
317 struct timeval tv_now_global
;
320 static void run(void)
322 struct poll_interest
*i
, *itmp
;
325 struct pollfd
*fds
=0;
326 int allocdfds
=0, shortfall
=0;
328 Message(M_NOTICE
,"%s [%d]: starting\n",version
,secnet_pid
);
331 if (gettimeofday(&tv_now_global
, NULL
)!=0) {
332 fatal_perror("main loop: gettimeofday");
334 now_global
=((uint64_t)tv_now_global
.tv_sec
*(uint64_t)1000)+
335 ((uint64_t)tv_now_global
.tv_usec
/(uint64_t)1000);
337 LIST_FOREACH(i
, ®
, entry
) {
339 if (interest_isregistered(i
)) {
340 for (check
=0; check
<i
->nfds
; check
++) {
341 if(fds
[idx
+check
].revents
& POLLNVAL
) {
342 fatal("run: poll (%s#%d) set POLLNVAL", i
->desc
, check
);
345 i
->after(i
->state
, fds
+idx
, i
->nfds
);
351 allocdfds
+= shortfall
;
352 REALLOC_ARY(fds
,allocdfds
);
357 LIST_FOREACH_SAFE(i
, ®
, entry
, itmp
) {
358 int remain
=allocdfds
-idx
;
360 if (interest_isregistered(i
)) {
361 rv
=i
->before(i
->state
, fds
+idx
, &nfds
, &timeout
);
364 fatal("run: beforepoll_fn (%s) returns %d",i
->desc
,rv
);
365 assert(nfds
< INT_MAX
/4 - shortfall
);
366 shortfall
+= nfds
-remain
;
374 fatal("run: beforepoll_fn (%s) set timeout to %d",
377 if (!interest_isregistered(i
)) {
378 /* check this here, rather than earlier, so that we
379 handle the case where i->before() calls deregister */
380 LIST_REMOVE(i
, entry
);
390 rv
=fakepoll(fds
, idx
, timeout
);
392 rv
=poll(fds
, idx
, timeout
);
396 fatal_perror("run: poll");
404 bool_t
will_droppriv(void)
406 assert(current_phase
>= PHASE_SETUP
);
410 /* Surrender privileges, if necessary */
411 static void droppriv(void)
415 fatal_perror("can't set gid to %ld",(long)gid
);
416 if (initgroups(userid
, gid
) < 0)
417 fatal_perror("initgroups");
418 if (setuid(uid
)!=0) {
419 fatal_perror("can't set uid to \"%s\"",userid
);
421 assert(getuid() == uid
);
422 assert(geteuid() == uid
);
423 assert(getgid() == gid
);
424 assert(getegid() == gid
);
428 /* Become a daemon, if necessary */
429 static void become_daemon(void)
435 add_hook(PHASE_SHUTDOWN
,system_phase_hook
,NULL
);
437 /* We only want to become a daemon if we are not one
439 if (background
&& !secnet_is_daemon
) {
442 /* Parent process - just exit */
445 /* Child process - all done, just carry on */
446 secnet_is_daemon
=True
;
448 fatal_perror("setsid");
451 fatal_perror("cannot fork");
455 if (secnet_is_daemon
) {
456 /* stderr etc are redirected to the system/log facility */
457 pipe_cloexec(errfds
);
458 if (dup2(errfds
[1],0) < 0
459 || dup2(errfds
[1],1) < 0
460 || dup2(errfds
[1],2) < 0)
461 fatal_perror("can't dup2 pipe");
462 if (close(errfds
[1]) < 0)
463 fatal_perror("can't close redundant pipe endpoint");
464 log_from_fd(errfds
[0],"stderr",system_log
);
468 /* Now we can write the pidfile */
470 pf
=fopen(pidfile
,"w");
472 fatal_perror("cannot open pidfile \"%s\"",pidfile
);
474 if (fprintf(pf
,"%ld\n",(long)secnet_pid
) < 0
476 fatal_perror("cannot write to pidfile \"%s\"",pidfile
);
480 static signal_notify_fn finish
,ignore_hup
;
481 static void finish(void *st
, int signum
)
484 Message(M_NOTICE
,"%s [%d]: received %s\n",version
,secnet_pid
,(string_t
)st
);
486 static void ignore_hup(void *st
, int signum
)
488 Message(M_INFO
,"%s [%d]: received SIGHUP\n",version
,secnet_pid
);
492 int main(int argc
, char **argv
)
498 enter_phase(PHASE_GETOPTS
);
499 parse_options(argc
,argv
);
501 enter_phase(PHASE_READCONFIG
);
502 config
=read_conffile(configfile
);
504 enter_phase(PHASE_SETUP
);
507 if (just_check_config
) {
508 Message(M_INFO
,"configuration file check complete\n");
512 enter_phase(PHASE_DAEMONIZE
);
515 enter_phase(PHASE_GETRESOURCES
);
516 /* Appropriate phase hooks will have been run */
518 enter_phase(PHASE_DROPPRIV
);
521 start_signal_handling();
522 request_signal_notification(SIGTERM
,finish
,safe_strdup("SIGTERM","run"));
523 if (!background
) request_signal_notification(SIGINT
,finish
,
524 safe_strdup("SIGINT","run"));
525 request_signal_notification(SIGHUP
,ignore_hup
,NULL
);
526 enter_phase(PHASE_RUN
);
529 enter_phase(PHASE_SHUTDOWN
);
530 Message(M_NOTICE
,"%s [%d]: finished\n",version
,secnet_pid
);