xref: /freebsd/usr.sbin/jail/jailp.h (revision ddd5b8e9b4d8957fce018c520657cdfa4ecffad3)
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 propigate 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 
55 #define JF_START	0x0001	/* -c */
56 #define JF_SET		0x0002	/* -m */
57 #define JF_STOP		0x0004	/* -r */
58 #define JF_DEPEND	0x0008	/* Operation required by dependency */
59 #define JF_WILD		0x0010	/* Not specified on the command line */
60 #define JF_FAILED	0x0020	/* Operation failed */
61 #define JF_PARAMS	0x0040	/* Parameters checked and imported */
62 #define JF_RDTUN	0x0080	/* Create-only parameter check has been done */
63 #define JF_PERSIST	0x0100	/* Jail is temporarily persistent */
64 #define JF_TIMEOUT	0x0200	/* A command (or process kill) timed out */
65 #define JF_SLEEPQ	0x0400	/* Waiting on a command and/or timeout */
66 
67 #define JF_OP_MASK		(JF_START | JF_SET | JF_STOP)
68 #define JF_RESTART		(JF_START | JF_STOP)
69 #define JF_START_SET		(JF_START | JF_SET)
70 #define JF_SET_RESTART		(JF_SET | JF_STOP)
71 #define JF_START_SET_RESTART	(JF_START | JF_SET | JF_STOP)
72 #define JF_DO_STOP(js)		(((js) & (JF_SET | JF_STOP)) == JF_STOP)
73 
74 enum intparam {
75 	IP__NULL = 0,		/* Null command */
76 	IP_ALLOW_DYING,		/* Allow making changes to a dying jail */
77 	IP_COMMAND,		/* Command run inside jail at creation */
78 	IP_DEPEND,		/* Jail starts after (stops before) another */
79 	IP_EXEC_CLEAN,		/* Run commands in a clean environment */
80 	IP_EXEC_CONSOLELOG,	/* Redirect optput for commands run in jail */
81 	IP_EXEC_FIB,		/* Run jailed commands with this FIB */
82 	IP_EXEC_JAIL_USER,	/* Run jailed commands as this user */
83 	IP_EXEC_POSTSTART,	/* Commands run outside jail after creating */
84 	IP_EXEC_POSTSTOP,	/* Commands run outside jail after removing */
85 	IP_EXEC_PRESTART,	/* Commands run outside jail before creating */
86 	IP_EXEC_PRESTOP,	/* Commands run outside jail before removing */
87 	IP_EXEC_START,		/* Commands run inside jail on creation */
88 	IP_EXEC_STOP,		/* Commands run inside jail on removal */
89 	IP_EXEC_SYSTEM_JAIL_USER,/* Get jail_user from system passwd file */
90 	IP_EXEC_SYSTEM_USER,	/* Run non-jailed commands as this user */
91 	IP_EXEC_TIMEOUT,	/* Time to wait for a command to complete */
92 #if defined(INET) || defined(INET6)
93 	IP_INTERFACE,		/* Add IP addresses to this interface */
94 	IP_IP_HOSTNAME,		/* Get jail IP address(es) from hostname */
95 #endif
96 	IP_MOUNT,		/* Mount points in fstab(5) form */
97 	IP_MOUNT_DEVFS,		/* Mount /dev under prison root */
98 	IP_MOUNT_FSTAB,		/* A standard fstab(5) file */
99 	IP_STOP_TIMEOUT,	/* Time to wait after sending SIGTERM */
100 	IP_VNET_INTERFACE,	/* Assign interface(s) to vnet jail */
101 #ifdef INET
102 	IP__IP4_IFADDR,		/* Copy of ip4.addr with interface/netmask */
103 #endif
104 #ifdef INET6
105 	IP__IP6_IFADDR,		/* Copy of ip6.addr with interface/prefixlen */
106 #endif
107 	IP__MOUNT_FROM_FSTAB,	/* Line from mount.fstab file */
108 	IP__OP,			/* Placeholder for requested operation */
109 	KP_ALLOW_CHFLAGS,
110 	KP_ALLOW_MOUNT,
111 	KP_ALLOW_RAW_SOCKETS,
112 	KP_ALLOW_SET_HOSTNAME,
113 	KP_ALLOW_SOCKET_AF,
114 	KP_ALLOW_SYSVIPC,
115 	KP_DEVFS_RULESET,
116 	KP_ENFORCE_STATFS,
117 	KP_HOST_HOSTNAME,
118 #ifdef INET
119 	KP_IP4_ADDR,
120 #endif
121 #ifdef INET6
122 	KP_IP6_ADDR,
123 #endif
124 	KP_JID,
125 	KP_NAME,
126 	KP_PATH,
127 	KP_PERSIST,
128 	KP_SECURELEVEL,
129 	KP_VNET,
130 	IP_NPARAM
131 };
132 
133 STAILQ_HEAD(cfvars, cfvar);
134 
135 struct cfvar {
136 	STAILQ_ENTRY(cfvar)	tq;
137 	char			*name;
138 	size_t			pos;
139 };
140 
141 TAILQ_HEAD(cfstrings, cfstring);
142 
143 struct cfstring {
144 	TAILQ_ENTRY(cfstring)	tq;
145 	char			*s;
146 	size_t			len;
147 	struct cfvars		vars;
148 };
149 
150 TAILQ_HEAD(cfparams, cfparam);
151 
152 struct cfparam {
153 	TAILQ_ENTRY(cfparam)	tq;
154 	char			*name;
155 	struct cfstrings	val;
156 	unsigned		flags;
157 	int			gen;
158 };
159 
160 TAILQ_HEAD(cfjails, cfjail);
161 STAILQ_HEAD(cfdepends, cfdepend);
162 
163 struct cfjail {
164 	TAILQ_ENTRY(cfjail)	tq;
165 	char			*name;
166 	char			*comline;
167 	struct cfparams		params;
168 	struct cfdepends	dep[2];
169 	struct cfjails		*queue;
170 	struct cfparam		*intparams[IP_NPARAM];
171 	struct cfstring		*comstring;
172 	struct jailparam	*jp;
173 	struct timespec		timeout;
174 	const enum intparam	*comparam;
175 	unsigned		flags;
176 	int			jid;
177 	int			seq;
178 	int			pstatus;
179 	int			ndeps;
180 	int			njp;
181 	int			nprocs;
182 };
183 
184 struct cfdepend {
185 	STAILQ_ENTRY(cfdepend)	tq[2];
186 	struct cfjail		*j[2];
187 	unsigned		flags;
188 };
189 
190 extern void *emalloc(size_t);
191 extern void *erealloc(void *, size_t);
192 extern char *estrdup(const char *);
193 extern int create_jail(struct cfjail *j);
194 extern void failed(struct cfjail *j);
195 extern void jail_note(const struct cfjail *j, const char *fmt, ...);
196 extern void jail_warnx(const struct cfjail *j, const char *fmt, ...);
197 
198 extern int next_command(struct cfjail *j);
199 extern int finish_command(struct cfjail *j);
200 extern struct cfjail *next_proc(int nonblock);
201 
202 extern void load_config(void);
203 extern struct cfjail *add_jail(void);
204 extern void add_param(struct cfjail *j, const struct cfparam *p,
205     enum intparam ipnum, const char *value);
206 extern int bool_param(const struct cfparam *p);
207 extern int int_param(const struct cfparam *p, int *ip);
208 extern const char *string_param(const struct cfparam *p);
209 extern int check_intparams(struct cfjail *j);
210 extern int import_params(struct cfjail *j);
211 extern int equalopts(const char *opt1, const char *opt2);
212 extern int wild_jail_name(const char *wname);
213 extern int wild_jail_match(const char *jname, const char *wname);
214 
215 extern void dep_setup(int docf);
216 extern int dep_check(struct cfjail *j);
217 extern void dep_done(struct cfjail *j, unsigned flags);
218 extern void dep_reset(struct cfjail *j);
219 extern struct cfjail *next_jail(void);
220 extern int start_state(const char *target, int docf, unsigned state,
221     int running);
222 extern void requeue(struct cfjail *j, struct cfjails *queue);
223 
224 extern void yyerror(const char *);
225 extern int yylex(void);
226 
227 extern struct cfjails cfjails;
228 extern struct cfjails ready;
229 extern struct cfjails depend;
230 extern const char *cfname;
231 extern int iflag;
232 extern int note_remove;
233 extern int paralimit;
234 extern int verbose;
235