chiark / gitweb /
Internal code review complete.
[userv.git] / daemon.h
1 /*
2  * userv - daemon.h
3  * definitions used in the daemon's source code
4  *
5  * Copyright (C)1996-1997 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 #ifndef DAEMON_H
23 #define DAEMON_H
24
25 #include <sys/types.h>
26
27 #define RESET_CONFIGURATION " \n\
28   cd ~/                       \n\
29   reject                      \n\
30   no-set-environment          \n\
31   suppress-args               \n\
32   allow-fd 0 read             \n\
33   allow-fd 1-2 write          \n\
34   reject-fd 3-                \n\
35   disconnect-hup              \n\
36 "
37
38 #ifndef SYSTEMCONFIGDIR
39 # ifdef DEBUG
40 #  define SYSTEMCONFIGDIR             "slash-etc"
41 # else
42 #  define SYSTEMCONFIGDIR             "/etc"
43 # endif
44 #endif
45
46 #ifndef DEFAULTPATH_USER
47 # define DEFAULTPATH_USER "/usr/local/bin:/bin:/usr/bin"
48 #endif
49
50 #ifndef DEFAULTPATH_ROOT
51 # define DEFAULTPATH_ROOT "/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin"
52 #endif
53   
54 #ifndef SETENVIRONMENT
55 # define SETENVIRONMENT "environment"
56 #endif
57
58 #define USERRCFILE                  "rc"
59 #define SYSTEMUSERVCONFIGDIR        "userv"
60 #define SHELLLIST                   "shells"
61 #define SYSTEMRCFILEDEFAULT         "system.default"
62 #define SYSTEMRCFILEOVERRIDE        "system.override"
63 #define NONEINCLUDELOOKUP           ":none"
64 #define DEFAULTINCLUDELOOKUP        ":default"
65 #define EMPTYINCLUDELOOKUP          ":empty"
66
67 #define USERCONFIGDIRBASE           SYSTEMUSERVCONFIGDIR
68 #define USERCONFIGDIR               "." USERCONFIGDIRBASE
69 #define USERUSERVCONFIGPATH         "~/" USERCONFIGDIR
70 #define USERRCFILEPATH              USERUSERVCONFIGPATH "/" USERRCFILE
71 #define SYSTEMUSERVCONFIGPATH       SYSTEMCONFIGDIR "/" SYSTEMUSERVCONFIGDIR
72 #define SYSTEMRCFILEDEFAULTPATH     SYSTEMUSERVCONFIGPATH "/" SYSTEMRCFILEDEFAULT
73 #define SYSTEMRCFILEOVERRIDEPATH    SYSTEMUSERVCONFIGPATH "/" SYSTEMRCFILEOVERRIDE
74 #define SHELLLISTPATH               SYSTEMCONFIGDIR "/" SHELLLIST
75 #define SETENVIRONMENTPATH          SYSTEMCONFIGDIR "/" SETENVIRONMENT
76
77 #define USERVD_LOGIDENT "uservd"
78 #define USERVD_LOGFACILITY LOG_DAEMON
79 #define DEFUSERLOGFACILITY LOG_DAEMON
80 #define DEFUSERLOGLEVEL LOG_ERR
81
82 #define TOPLEVEL_CONFIGURATION "                   \n\
83   reset                                            \n\
84   user-rcfile " USERRCFILEPATH "                   \n\
85   errors-to-stderr                                 \n\
86   _include-sysconfig " SYSTEMRCFILEDEFAULTPATH "   \n\
87   if grep service-user-shell " SHELLLISTPATH "     \n\
88     errors-push                                    \n\
89       catch-quit                                   \n\
90         _include-user-rcfile                       \n\
91       hctac                                        \n\
92     srorre                                         \n\
93   fi                                               \n\
94   _include-sysconfig " SYSTEMRCFILEOVERRIDEPATH "  \n\
95   quit                                             \n\
96 "
97
98 #define TOPLEVEL_OVERRIDDEN_CONFIGURATION "        \n\
99   reset                                            \n\
100   errors-to-stderr                                 \n\
101   _include-client-config                           \n\
102   quit                                             \n\
103 "
104
105 #define MAX_INCLUDE_NEST 40
106 #define MAX_ERRMSG_LEN (MAX_ERRMSG_STRING-1024)
107 #define ERRMSG_RESERVE_ERRNO 128
108
109 int parse_string(const char *string, const char *descrip, int isinternal);
110 void parseerrprint(const char *fmt, ...) PRINTFFORMAT(1,2);
111 void ensurelogopen(int wantfacility);
112 void ensurefdarray(int fd);
113 const char *printtoken(int token);
114 void senderrmsgstderr(const char *errmsg);
115 void disconnect(int exitstatus) NONRETURNING;
116
117 void always_dumpparameter(const char *parm, char **values);
118 void always_dumpexecsettings(void);
119
120 void debug_dumprequest(pid_t mypid);
121 void debug_dumpexecsettings(void);
122 void debug_dumpparameter(const char *parm, char **values);
123 pid_t nondebug_fork(void);
124 const char *nondebug_serviceuserdir(const char *ifnondebug);
125
126 typedef void builtinserviceexec_fnt(const char *const *args);
127 builtinserviceexec_fnt NONRETURNING bisexec_environment, bisexec_parameter;
128 builtinserviceexec_fnt NONRETURNING bisexec_version;
129 builtinserviceexec_fnt NONRETURNING bisexec_toplevel, bisexec_override, bisexec_reset;
130 builtinserviceexec_fnt NONRETURNING bisexec_execute;
131
132 void execservice(const int synchsocket[], int clientfd) NONRETURNING;
133 void servicerequest(int sfd) NONRETURNING;
134 int synchread(int fd, int ch);
135 const char *defaultpath(void);
136
137 struct fdstate {
138   int iswrite; /* 0 or 1; -1 if not open */
139   int realfd, holdfd; /* -1 if not open */
140   int wantstate;
141   /* tokv_word_requirefd, tokv_word_allowfd, tokv_nullfd, tokv_word_rejectfd
142    * (all of which have tokt_wantfdstate set) */
143   int wantrw; /* tokv_word_read, tokv_word_write, 0 for either/both */
144 };
145
146 struct keyvaluepair { char *key, *value; };
147
148 extern struct request_msg request_mbuf;
149 extern struct keyvaluepair *defvararray;
150 extern struct fdstate *fdarray; /* indexed by nominal fd */
151 extern int fdarraysize, fdarrayused;
152 extern int restfdwantstate, restfdwantrw;
153 extern int service_ngids;
154 extern char **argarray;
155 extern char *serviceuser, *service, *logname, *cwd;
156 extern char *overridedata, *userrcfile;
157 extern char *serviceuser_dir, *serviceuser_shell, *callinguser_shell;
158 extern gid_t *calling_gids, *service_gids;
159 extern uid_t serviceuser_uid;
160 extern const char **calling_groups, **service_groups;
161 extern char *execpath, **execargs;
162 extern int execute; /* One of the execution modes tokt_execmode */
163 extern int setenvironment, suppressargs, disconnecthup;
164 extern builtinserviceexec_fnt *execbuiltin;
165 extern int syslogopenfacility;
166
167 #endif