jailp.h revision 214783
1/*-
2 * Copyright (c) 2010 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: projects/jailconf/usr.sbin/jail/jailp.h 214783 2010-11-04 17:01:21Z jamie $
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
54#define JF_START	0x0001	/* -c */
55#define JF_SET		0x0002	/* -m */
56#define JF_STOP		0x0004	/* -r */
57#define JF_DEPEND	0x0008	/* Operation required by dependency */
58#define JF_WILD		0x0010	/* Not specified on the command line */
59#define JF_FAILED	0x0020	/* Operation failed */
60#define JF_PARAMS	0x0040	/* Parameters checked and imported */
61#define JF_RDTUN	0x0080	/* Create-only parameter check has been done */
62#define JF_IFUP		0x0100	/* IP addresses have been configured */
63#define JF_MOUNTED	0x0200	/* Filesystems have been mounted */
64#define JF_PERSIST	0x0400	/* Jail is temporarily persistent */
65#define JF_TIMEOUT	0x0800	/* A command (or process kill) timed out */
66#define JF_RUNQ		0x1000	/* Jail was in the run qeueue */
67#define JF_BACKGROUND	0x2000	/* Command was run in the background */
68
69#define JF_OP_MASK		(JF_START | JF_SET | JF_STOP)
70#define JF_RESTART		(JF_START | JF_STOP)
71#define JF_START_SET		(JF_START | JF_SET)
72#define JF_SET_RESTART		(JF_SET | JF_STOP)
73#define JF_START_SET_RESTART	(JF_START | JF_SET | JF_STOP)
74#define JF_DO_STOP(js)		(((js) & (JF_SET | JF_STOP)) == JF_STOP)
75
76enum intparam {
77	IP_ALLOW_DYING = 1,	/* 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	IP_INTERFACE,		/* Add IP addresses to this interface */
94	IP_IP_HOSTNAME,		/* Get jail IP address(es) from hostname */
95	IP_MOUNT,		/* Mount points in fstab(5) form */
96	IP_MOUNT_DEVFS,		/* Mount /dev under prison root */
97	IP_MOUNT_DEVFS_RULESET,	/* Ruleset for the devfs mount */
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	IP__IP4_IFADDR,		/* Copy of ip4.addr with interface/netmask */
102#ifdef INET6
103	IP__IP6_IFADDR,		/* Copy of ip6.addr with interface/prefixlen */
104#endif
105	IP__MOUNT_FROM_FSTAB,	/* Line from mount.fstab file */
106	KP_ALLOW_CHFLAGS,
107	KP_ALLOW_MOUNT,
108	KP_ALLOW_RAW_SOCKETS,
109	KP_ALLOW_SET_HOSTNAME,
110	KP_ALLOW_SOCKET_AF,
111	KP_ALLOW_SYSVIPC,
112	KP_ENFORCE_STATFS,
113	KP_HOST_HOSTNAME,
114	KP_IP4_ADDR,
115#ifdef INET6
116	KP_IP6_ADDR,
117#endif
118	KP_JID,
119	KP_NAME,
120	KP_PATH,
121	KP_PERSIST,
122	KP_SECURELEVEL,
123	KP_VNET,
124	IP_NPARAM
125};
126
127STAILQ_HEAD(cfvars, cfvar);
128
129struct cfvar {
130	STAILQ_ENTRY(cfvar)	tq;
131	char			*name;
132	size_t			pos;
133};
134
135STAILQ_HEAD(cfstrings, cfstring);
136
137struct cfstring {
138	STAILQ_ENTRY(cfstring)	tq;
139	char			*s;
140	size_t			len;
141	struct cfvars		vars;
142};
143
144TAILQ_HEAD(cfparams, cfparam);
145
146struct cfparam {
147	TAILQ_ENTRY(cfparam)	tq;
148	char			*name;
149	struct cfstrings	val;
150	unsigned		flags;
151	int			gen;
152};
153
154TAILQ_HEAD(cfjails, cfjail);
155STAILQ_HEAD(cfdepends, cfdepend);
156
157struct cfjail {
158	TAILQ_ENTRY(cfjail)	tq;
159	char			*name;
160	char			*comline;
161	struct cfparams		params;
162	struct cfdepends	dep[2];
163	struct cfjails		*queue;
164	struct cfparam		*intparams[IP_NPARAM];
165	struct cfstring		*comstring;
166	struct jailparam	*jp;
167	struct timespec		timeout;
168	enum intparam		comparam;
169	unsigned		flags;
170	int			jid;
171	int			seq;
172	int			pstatus;
173	int			ndeps;
174	int			njp;
175	int			nprocs;
176};
177
178struct cfdepend {
179	STAILQ_ENTRY(cfdepend)	tq[2];
180	struct cfjail		*j[2];
181	unsigned		flags;
182};
183
184extern void *emalloc(size_t);
185extern void *erealloc(void *, size_t);
186extern char *estrdup(const char *);
187extern void failed(struct cfjail *j);
188extern void jail_note(const struct cfjail *j, const char *fmt, ...);
189extern void jail_warnx(const struct cfjail *j, const char *fmt, ...);
190
191extern int run_command(struct cfjail *j, int *plimit, enum intparam comparam);
192extern int finish_command(struct cfjail *j, int *plimit);
193extern struct cfjail *next_proc(int nonblock);
194extern int term_procs(struct cfjail *j);
195
196extern void load_config(void);
197extern struct cfjail *add_jail(void);
198extern void add_param(struct cfjail *j, const struct cfparam *p,
199    enum intparam ipnum, const char *value);
200extern int bool_param(const struct cfparam *p);
201extern int int_param(const struct cfparam *p, int *ip);
202extern const char *string_param(const struct cfparam *p);
203extern int check_intparams(struct cfjail *j);
204extern int import_params(struct cfjail *j);
205extern int equalopts(const char *opt1, const char *opt2);
206extern int wild_jail_name(const char *wname);
207extern int wild_jail_match(const char *jname, const char *wname);
208
209extern void dep_setup(int docf);
210extern int dep_check(struct cfjail *j);
211extern void dep_done(struct cfjail *j, unsigned flags);
212extern void dep_reset(struct cfjail *j);
213extern struct cfjail *next_jail(void);
214extern int start_state(const char *target, unsigned state, int running);
215extern void requeue(struct cfjail *j, struct cfjails *queue);
216
217extern void yyerror(const char *);
218extern int yylex(void);
219extern int yyparse(void);
220
221extern struct cfjails cfjails;
222extern struct cfjails ready;
223extern struct cfjails waiting;
224extern const char *cfname;
225extern int verbose;
226