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