xref: /freebsd/usr.sbin/jail/jailp.h (revision 15c433351f54e7cd5bec8d36c8e89e6a7fa55b26)
1 /*-
2  * Copyright (c) 2011 James Gritton.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD$
27  */
28 
29 #include <sys/param.h>
30 #include <sys/types.h>
31 #include <sys/jail.h>
32 #include <sys/queue.h>
33 #include <sys/time.h>
34 
35 #include <jail.h>
36 
37 #define CONF_FILE	"/etc/jail.conf"
38 
39 #define DEP_FROM	0
40 #define DEP_TO		1
41 
42 #define DF_SEEN		0x01	/* Dependency has been followed */
43 #define DF_LIGHT	0x02	/* Implied dependency on jail existence only */
44 #define DF_NOFAIL	0x04	/* Don't propagate failed jails */
45 
46 #define PF_VAR		0x01	/* This is a variable, not a true parameter */
47 #define PF_APPEND	0x02	/* Append to existing parameter list */
48 #define PF_BAD		0x04	/* Unable to resolve parameter value */
49 #define PF_INTERNAL	0x08	/* Internal parameter, not passed to kernel */
50 #define PF_BOOL		0x10	/* Boolean parameter */
51 #define PF_INT		0x20	/* Integer parameter */
52 #define PF_CONV		0x40	/* Parameter duplicated in converted form */
53 #define PF_REV		0x80	/* Run commands in reverse order on stopping */
54 #define	PF_IMMUTABLE	0x100	/* Immutable parameter */
55 
56 #define JF_START	0x0001	/* -c */
57 #define JF_SET		0x0002	/* -m */
58 #define JF_STOP		0x0004	/* -r */
59 #define JF_DEPEND	0x0008	/* Operation required by dependency */
60 #define JF_WILD		0x0010	/* Not specified on the command line */
61 #define JF_FAILED	0x0020	/* Operation failed */
62 #define JF_PARAMS	0x0040	/* Parameters checked and imported */
63 #define JF_RDTUN	0x0080	/* Create-only parameter check has been done */
64 #define JF_PERSIST	0x0100	/* Jail is temporarily persistent */
65 #define JF_TIMEOUT	0x0200	/* A command (or process kill) timed out */
66 #define JF_SLEEPQ	0x0400	/* Waiting on a command and/or timeout */
67 
68 #define JF_OP_MASK		(JF_START | JF_SET | JF_STOP)
69 #define JF_RESTART		(JF_START | JF_STOP)
70 #define JF_START_SET		(JF_START | JF_SET)
71 #define JF_SET_RESTART		(JF_SET | JF_STOP)
72 #define JF_START_SET_RESTART	(JF_START | JF_SET | JF_STOP)
73 #define JF_DO_STOP(js)		(((js) & (JF_SET | JF_STOP)) == JF_STOP)
74 
75 enum intparam {
76 	IP__NULL = 0,		/* Null command */
77 	IP_ALLOW_DYING,		/* Allow making changes to a dying jail */
78 	IP_COMMAND,		/* Command run inside jail at creation */
79 	IP_DEPEND,		/* Jail starts after (stops before) another */
80 	IP_EXEC_CLEAN,		/* Run commands in a clean environment */
81 	IP_EXEC_CONSOLELOG,	/* Redirect optput for commands run in jail */
82 	IP_EXEC_FIB,		/* Run jailed commands with this FIB */
83 	IP_EXEC_JAIL_USER,	/* Run jailed commands as this user */
84 	IP_EXEC_POSTSTART,	/* Commands run outside jail after creating */
85 	IP_EXEC_POSTSTOP,	/* Commands run outside jail after removing */
86 	IP_EXEC_PRESTART,	/* Commands run outside jail before creating */
87 	IP_EXEC_PRESTOP,	/* Commands run outside jail before removing */
88 	IP_EXEC_START,		/* Commands run inside jail on creation */
89 	IP_EXEC_STOP,		/* Commands run inside jail on removal */
90 	IP_EXEC_SYSTEM_JAIL_USER,/* Get jail_user from system passwd file */
91 	IP_EXEC_SYSTEM_USER,	/* Run non-jailed commands as this user */
92 	IP_EXEC_TIMEOUT,	/* Time to wait for a command to complete */
93 #if defined(INET) || defined(INET6)
94 	IP_INTERFACE,		/* Add IP addresses to this interface */
95 	IP_IP_HOSTNAME,		/* Get jail IP address(es) from hostname */
96 #endif
97 	IP_MOUNT,		/* Mount points in fstab(5) form */
98 	IP_MOUNT_DEVFS,		/* Mount /dev under prison root */
99 	IP_MOUNT_FDESCFS,	/* Mount /dev/fd under prison root */
100 	IP_MOUNT_PROCFS,	/* Mount /proc under prison root */
101 	IP_MOUNT_FSTAB,		/* A standard fstab(5) file */
102 	IP_STOP_TIMEOUT,	/* Time to wait after sending SIGTERM */
103 	IP_VNET_INTERFACE,	/* Assign interface(s) to vnet jail */
104 #ifdef INET
105 	IP__IP4_IFADDR,		/* Copy of ip4.addr with interface/netmask */
106 #endif
107 #ifdef INET6
108 	IP__IP6_IFADDR,		/* Copy of ip6.addr with interface/prefixlen */
109 #endif
110 	IP__MOUNT_FROM_FSTAB,	/* Line from mount.fstab file */
111 	IP__OP,			/* Placeholder for requested operation */
112 	KP_ALLOW_CHFLAGS,
113 	KP_ALLOW_MOUNT,
114 	KP_ALLOW_RAW_SOCKETS,
115 	KP_ALLOW_SET_HOSTNAME,
116 	KP_ALLOW_SOCKET_AF,
117 	KP_ALLOW_SYSVIPC,
118 	KP_DEVFS_RULESET,
119 	KP_ENFORCE_STATFS,
120 	KP_HOST_HOSTNAME,
121 #ifdef INET
122 	KP_IP4_ADDR,
123 #endif
124 #ifdef INET6
125 	KP_IP6_ADDR,
126 #endif
127 	KP_JID,
128 	KP_NAME,
129 	KP_PATH,
130 	KP_PERSIST,
131 	KP_SECURELEVEL,
132 	KP_VNET,
133 	IP_NPARAM
134 };
135 
136 STAILQ_HEAD(cfvars, cfvar);
137 
138 struct cfvar {
139 	STAILQ_ENTRY(cfvar)	tq;
140 	char			*name;
141 	size_t			pos;
142 };
143 
144 TAILQ_HEAD(cfstrings, cfstring);
145 
146 struct cfstring {
147 	TAILQ_ENTRY(cfstring)	tq;
148 	char			*s;
149 	size_t			len;
150 	struct cfvars		vars;
151 };
152 
153 TAILQ_HEAD(cfparams, cfparam);
154 
155 struct cfparam {
156 	TAILQ_ENTRY(cfparam)	tq;
157 	char			*name;
158 	struct cfstrings	val;
159 	unsigned		flags;
160 	int			gen;
161 };
162 
163 TAILQ_HEAD(cfjails, cfjail);
164 STAILQ_HEAD(cfdepends, cfdepend);
165 
166 struct cfjail {
167 	TAILQ_ENTRY(cfjail)	tq;
168 	char			*name;
169 	char			*comline;
170 	struct cfparams		params;
171 	struct cfdepends	dep[2];
172 	struct cfjails		*queue;
173 	struct cfparam		*intparams[IP_NPARAM];
174 	struct cfstring		*comstring;
175 	struct jailparam	*jp;
176 	struct timespec		timeout;
177 	const enum intparam	*comparam;
178 	unsigned		flags;
179 	int			jid;
180 	int			seq;
181 	int			pstatus;
182 	int			ndeps;
183 	int			njp;
184 	int			nprocs;
185 };
186 
187 struct cfdepend {
188 	STAILQ_ENTRY(cfdepend)	tq[2];
189 	struct cfjail		*j[2];
190 	unsigned		flags;
191 };
192 
193 extern void *emalloc(size_t);
194 extern void *erealloc(void *, size_t);
195 extern char *estrdup(const char *);
196 extern int create_jail(struct cfjail *j);
197 extern void failed(struct cfjail *j);
198 extern void jail_note(const struct cfjail *j, const char *fmt, ...);
199 extern void jail_warnx(const struct cfjail *j, const char *fmt, ...);
200 
201 extern int next_command(struct cfjail *j);
202 extern int finish_command(struct cfjail *j);
203 extern struct cfjail *next_proc(int nonblock);
204 
205 extern void load_config(void);
206 extern struct cfjail *add_jail(void);
207 extern void add_param(struct cfjail *j, const struct cfparam *p,
208     enum intparam ipnum, const char *value);
209 extern int bool_param(const struct cfparam *p);
210 extern int int_param(const struct cfparam *p, int *ip);
211 extern const char *string_param(const struct cfparam *p);
212 extern int check_intparams(struct cfjail *j);
213 extern int import_params(struct cfjail *j);
214 extern int equalopts(const char *opt1, const char *opt2);
215 extern int wild_jail_name(const char *wname);
216 extern int wild_jail_match(const char *jname, const char *wname);
217 
218 extern void dep_setup(int docf);
219 extern int dep_check(struct cfjail *j);
220 extern void dep_done(struct cfjail *j, unsigned flags);
221 extern void dep_reset(struct cfjail *j);
222 extern struct cfjail *next_jail(void);
223 extern int start_state(const char *target, int docf, unsigned state,
224     int running);
225 extern void requeue(struct cfjail *j, struct cfjails *queue);
226 
227 extern void yyerror(const char *);
228 extern int yylex(void);
229 
230 extern struct cfjails cfjails;
231 extern struct cfjails ready;
232 extern struct cfjails depend;
233 extern const char *cfname;
234 extern int iflag;
235 extern int note_remove;
236 extern int paralimit;
237 extern int verbose;
238