sys/sys/jail.h

   1 /*-
   2  * Copyright (c) 1999 Poul-Henning Kamp.
   3  * Copyright (c) 2009 James Gritton.
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25  * SUCH DAMAGE.
  26  *
  27  * $FreeBSD$
  28  */
  29
  30 #ifndef _SYS_JAIL_H_
  31 #define _SYS_JAIL_H_
  32
  33 #ifdef _KERNEL
  34 struct jail_v0 {
  35         u_int32_t       version;
  36         char            *path;
  37         char            *hostname;
  38         u_int32_t       ip_number;
  39 };
  40 #endif
  41
  42 struct jail {
  43         uint32_t        version;
  44         char            *path;
  45         char            *hostname;
  46         char            *jailname;
  47         uint32_t        ip4s;
  48         uint32_t        ip6s;
  49         struct in_addr  *ip4;
  50         struct in6_addr *ip6;
  51 };
  52 #define JAIL_API_VERSION        2
  53
  54 /*
  55  * For all xprison structs, always keep the pr_version an int and
  56  * the first variable so userspace can easily distinguish them.
  57  */
  58 #ifndef _KERNEL
  59 struct xprison_v1 {
  60         int              pr_version;
  61         int              pr_id;
  62         char             pr_path[MAXPATHLEN];
  63         char             pr_host[MAXHOSTNAMELEN];
  64         u_int32_t        pr_ip;
  65 };
  66 #endif
  67
  68 struct xprison {
  69         int              pr_version;
  70         int              pr_id;
  71         int              pr_state;
  72         cpusetid_t       pr_cpusetid;
  73         char             pr_path[MAXPATHLEN];
  74         char             pr_host[MAXHOSTNAMELEN];
  75         char             pr_name[MAXHOSTNAMELEN];
  76         uint32_t         pr_ip4s;
  77         uint32_t         pr_ip6s;
  78 #if 0
  79         /*
  80          * sizeof(xprison) will be malloced + size needed for all
  81          * IPv4 and IPv6 addesses. Offsets are based numbers of addresses.
  82          */
  83         struct in_addr   pr_ip4[];
  84         struct in6_addr  pr_ip6[];
  85 #endif
  86 };
  87 #define XPRISON_VERSION         3
  88
  89 #define PRISON_STATE_INVALID    0
  90 #define PRISON_STATE_ALIVE      1
  91 #define PRISON_STATE_DYING      2
  92
  93 /*
  94  * Flags for jail_set and jail_get.
  95  */
  96 #define JAIL_CREATE     0x01    /* Create jail if it doesn't exist */
  97 #define JAIL_UPDATE     0x02    /* Update parameters of existing jail */
  98 #define JAIL_ATTACH     0x04    /* Attach to jail upon creation */
  99 #define JAIL_DYING      0x08    /* Allow getting a dying jail */
 100 #define JAIL_SET_MASK   0x0f
 101 #define JAIL_GET_MASK   0x08
 102
 103 #define JAIL_SYS_DISABLE        0
 104 #define JAIL_SYS_NEW            1
 105 #define JAIL_SYS_INHERIT        2
 106
 107 #ifndef _KERNEL
 108
 109 struct iovec;
 110
 111 int jail(struct jail *);
 112 int jail_set(struct iovec *, unsigned int, int);
 113 int jail_get(struct iovec *, unsigned int, int);
 114 int jail_attach(int);
 115 int jail_remove(int);
 116
 117 #else /* _KERNEL */
 118
 119 #include <sys/queue.h>
 120 #include <sys/sysctl.h>
 121 #include <sys/lock.h>
 122 #include <sys/mutex.h>
 123 #include <sys/_task.h>
 124
 125 #define JAIL_MAX        999999
 126
 127 #ifdef MALLOC_DECLARE
 128 MALLOC_DECLARE(M_PRISON);
 129 #endif
 130 #endif /* _KERNEL */
 131
 132 #if defined(_KERNEL) || defined(_WANT_PRISON)
 133
 134 #include <sys/osd.h>
 135
 136 #define HOSTUUIDLEN     64
 137 #define OSRELEASELEN    32
 138
 139 struct racct;
 140 struct prison_racct;
 141
 142 /*
 143  * This structure describes a prison.  It is pointed to by all struct
 144  * ucreds's of the inmates.  pr_ref keeps track of them and is used to
 145  * delete the struture when the last inmate is dead.
 146  *
 147  * Lock key:
 148  *   (a) allprison_lock
 149  *   (p) locked by pr_mtx
 150  *   (c) set only during creation before the structure is shared, no mutex
 151  *       required to read
 152  *   (d) set only during destruction of jail, no mutex needed
 153  */
 154 struct prison {
 155         TAILQ_ENTRY(prison) pr_list;                    /* (a) all prisons */
 156         int              pr_id;                         /* (c) prison id */
 157         int              pr_ref;                        /* (p) refcount */
 158         int              pr_uref;                       /* (p) user (alive) refcount */
 159         unsigned         pr_flags;                      /* (p) PR_* flags */
 160         LIST_HEAD(, prison) pr_children;                /* (a) list of child jails */
 161         LIST_ENTRY(prison) pr_sibling;                  /* (a) next in parent's list */
 162         struct prison   *pr_parent;                     /* (c) containing jail */
 163         struct mtx       pr_mtx;
 164         struct task      pr_task;                       /* (d) destroy task */
 165         struct osd       pr_osd;                        /* (p) additional data */
 166         struct cpuset   *pr_cpuset;                     /* (p) cpuset */
 167         struct vnet     *pr_vnet;                       /* (c) network stack */
 168         struct vnode    *pr_root;                       /* (c) vnode to rdir */
 169         int              pr_ip4s;                       /* (p) number of v4 IPs */
 170         int              pr_ip6s;                       /* (p) number of v6 IPs */
 171         struct in_addr  *pr_ip4;                        /* (p) v4 IPs of jail */
 172         struct in6_addr *pr_ip6;                        /* (p) v6 IPs of jail */
 173         struct prison_racct *pr_prison_racct;           /* (c) racct jail proxy */
 174         void            *pr_sparep[3];
 175         int              pr_childcount;                 /* (a) number of child jails */
 176         int              pr_childmax;                   /* (p) maximum child jails */
 177         unsigned         pr_allow;                      /* (p) PR_ALLOW_* flags */
 178         int              pr_securelevel;                /* (p) securelevel */
 179         int              pr_enforce_statfs;             /* (p) statfs permission */
 180         int              pr_devfs_rsnum;                /* (p) devfs ruleset */
 181         int              pr_spare[3];
 182         int              pr_osreldate;                  /* (c) kern.osreldate value */
 183         unsigned long    pr_hostid;                     /* (p) jail hostid */
 184         char             pr_name[MAXHOSTNAMELEN];       /* (p) admin jail name */
 185         char             pr_path[MAXPATHLEN];           /* (c) chroot path */
 186         char             pr_hostname[MAXHOSTNAMELEN];   /* (p) jail hostname */
 187         char             pr_domainname[MAXHOSTNAMELEN]; /* (p) jail domainname */
 188         char             pr_hostuuid[HOSTUUIDLEN];      /* (p) jail hostuuid */
 189         char             pr_osrelease[OSRELEASELEN];    /* (c) kern.osrelease value */
 190 };
 191
 192 struct prison_racct {
 193         LIST_ENTRY(prison_racct) prr_next;
 194         char            prr_name[MAXHOSTNAMELEN];
 195         u_int           prr_refcount;
 196         struct racct    *prr_racct;
 197 };
 198 #endif /* _KERNEL || _WANT_PRISON */
 199
 200 #ifdef _KERNEL
 201 /* Flag bits set via options */
 202 #define PR_PERSIST      0x00000001      /* Can exist without processes */
 203 #define PR_HOST         0x00000002      /* Virtualize hostname et al */
 204 #define PR_IP4_USER     0x00000004      /* Restrict IPv4 addresses */
 205 #define PR_IP6_USER     0x00000008      /* Restrict IPv6 addresses */
 206 #define PR_VNET         0x00000010      /* Virtual network stack */
 207 #define PR_IP4_SADDRSEL 0x00000080      /* Do IPv4 src addr sel. or use the */
 208                                         /* primary jail address. */
 209 #define PR_IP6_SADDRSEL 0x00000100      /* Do IPv6 src addr sel. or use the */
 210                                         /* primary jail address. */
 211
 212 /* Internal flag bits */
 213 #define PR_REMOVE       0x01000000      /* In process of being removed */
 214 #define PR_IP4          0x02000000      /* IPv4 restricted or disabled */
 215                                         /* by this jail or an ancestor */
 216 #define PR_IP6          0x04000000      /* IPv6 restricted or disabled */
 217                                         /* by this jail or an ancestor */
 218
 219 /* Flags for pr_allow */
 220 #define PR_ALLOW_SET_HOSTNAME           0x0001
 221 #define PR_ALLOW_SYSVIPC                0x0002
 222 #define PR_ALLOW_RAW_SOCKETS            0x0004
 223 #define PR_ALLOW_CHFLAGS                0x0008
 224 #define PR_ALLOW_MOUNT                  0x0010
 225 #define PR_ALLOW_QUOTAS                 0x0020
 226 #define PR_ALLOW_SOCKET_AF              0x0040
 227 #define PR_ALLOW_MOUNT_DEVFS            0x0080
 228 #define PR_ALLOW_MOUNT_NULLFS           0x0100
 229 #define PR_ALLOW_MOUNT_ZFS              0x0200
 230 #define PR_ALLOW_MOUNT_PROCFS           0x0400
 231 #define PR_ALLOW_MOUNT_TMPFS            0x0800
 232 #define PR_ALLOW_MOUNT_FDESCFS          0x1000
 233 #define PR_ALLOW_ALL                    0x1fff
 234
 235 /*
 236  * OSD methods
 237  */
 238 #define PR_METHOD_CREATE        0
 239 #define PR_METHOD_GET           1
 240 #define PR_METHOD_SET           2
 241 #define PR_METHOD_CHECK         3
 242 #define PR_METHOD_ATTACH        4
 243 #define PR_MAXMETHOD            5
 244
 245 /*
 246  * Lock/unlock a prison.
 247  * XXX These exist not so much for general convenience, but to be useable in
 248  *     the FOREACH_PRISON_DESCENDANT_LOCKED macro which can't handle them in
 249  *     non-function form as currently defined.
 250  */
 251 static __inline void
 252 prison_lock(struct prison *pr)
 253 {
 254
 255         mtx_lock(&pr->pr_mtx);
 256 }
 257
 258 static __inline void
 259 prison_unlock(struct prison *pr)
 260 {
 261
 262         mtx_unlock(&pr->pr_mtx);
 263 }
 264
 265 /* Traverse a prison's immediate children. */
 266 #define FOREACH_PRISON_CHILD(ppr, cpr)                                  \
 267         LIST_FOREACH(cpr, &(ppr)->pr_children, pr_sibling)
 268
 269 /*
 270  * Preorder traversal of all of a prison's descendants.
 271  * This ugly loop allows the macro to be followed by a single block
 272  * as expected in a looping primitive.
 273  */
 274 #define FOREACH_PRISON_DESCENDANT(ppr, cpr, descend)                    \
 275         for ((cpr) = (ppr), (descend) = 1;                              \
 276             ((cpr) = (((descend) && !LIST_EMPTY(&(cpr)->pr_children))   \
 277               ? LIST_FIRST(&(cpr)->pr_children)                         \
 278               : ((cpr) == (ppr)                                         \
 279                  ? NULL                                                 \
 280                  : (((descend) = LIST_NEXT(cpr, pr_sibling) != NULL)    \
 281                     ? LIST_NEXT(cpr, pr_sibling)                        \
 282                     : (cpr)->pr_parent))));)                            \
 283                 if (!(descend))                                         \
 284                         ;                                               \
 285                 else
 286
 287 /*
 288  * As above, but lock descendants on the way down and unlock on the way up.
 289  */
 290 #define FOREACH_PRISON_DESCENDANT_LOCKED(ppr, cpr, descend)             \
 291         for ((cpr) = (ppr), (descend) = 1;                              \
 292             ((cpr) = (((descend) && !LIST_EMPTY(&(cpr)->pr_children))   \
 293               ? LIST_FIRST(&(cpr)->pr_children)                         \
 294               : ((cpr) == (ppr)                                         \
 295                  ? NULL                                                 \
 296                  : ((prison_unlock(cpr),                                \
 297                     (descend) = LIST_NEXT(cpr, pr_sibling) != NULL)     \
 298                     ? LIST_NEXT(cpr, pr_sibling)                        \
 299                     : (cpr)->pr_parent))));)                            \
 300                 if ((descend) ? (prison_lock(cpr), 0) : 1)              \
 301                         ;                                               \
 302                 else
 303
 304 /*
 305  * As above, but also keep track of the level descended to.
 306  */
 307 #define FOREACH_PRISON_DESCENDANT_LOCKED_LEVEL(ppr, cpr, descend, level)\
 308         for ((cpr) = (ppr), (descend) = 1, (level) = 0;                 \
 309             ((cpr) = (((descend) && !LIST_EMPTY(&(cpr)->pr_children))   \
 310               ? (level++, LIST_FIRST(&(cpr)->pr_children))              \
 311               : ((cpr) == (ppr)                                         \
 312                  ? NULL                                                 \
 313                  : ((prison_unlock(cpr),                                \
 314                     (descend) = LIST_NEXT(cpr, pr_sibling) != NULL)     \
 315                     ? LIST_NEXT(cpr, pr_sibling)                        \
 316                     : (level--, (cpr)->pr_parent)))));)                 \
 317                 if ((descend) ? (prison_lock(cpr), 0) : 1)              \
 318                         ;                                               \
 319                 else
 320
 321 /*
 322  * Attributes of the physical system, and the root of the jail tree.
 323  */
 324 extern struct   prison prison0;
 325
 326 TAILQ_HEAD(prisonlist, prison);
 327 extern struct   prisonlist allprison;
 328 extern struct   sx allprison_lock;
 329
 330 /*
 331  * Sysctls to describe jail parameters.
 332  */
 333 SYSCTL_DECL(_security_jail_param);
 334
 335 #define SYSCTL_JAIL_PARAM(module, param, type, fmt, descr)              \
 336     SYSCTL_PROC(_security_jail_param ## module, OID_AUTO, param,        \
 337         (type) | CTLFLAG_MPSAFE, NULL, 0, sysctl_jail_param, fmt, descr)
 338 #define SYSCTL_JAIL_PARAM_STRING(module, param, access, len, descr)     \
 339     SYSCTL_PROC(_security_jail_param ## module, OID_AUTO, param,        \
 340         CTLTYPE_STRING | CTLFLAG_MPSAFE | (access), NULL, len,          \
 341         sysctl_jail_param, "A", descr)
 342 #define SYSCTL_JAIL_PARAM_STRUCT(module, param, access, len, fmt, descr)\
 343     SYSCTL_PROC(_security_jail_param ## module, OID_AUTO, param,        \
 344         CTLTYPE_STRUCT | CTLFLAG_MPSAFE | (access), NULL, len,          \
 345         sysctl_jail_param, fmt, descr)
 346 #define SYSCTL_JAIL_PARAM_NODE(module, descr)                           \
 347     SYSCTL_NODE(_security_jail_param, OID_AUTO, module, 0, 0, descr)
 348 #define SYSCTL_JAIL_PARAM_SUBNODE(parent, module, descr)                \
 349     SYSCTL_NODE(_security_jail_param_##parent, OID_AUTO, module, 0, 0, descr)
 350 #define SYSCTL_JAIL_PARAM_SYS_NODE(module, access, descr)               \
 351     SYSCTL_JAIL_PARAM_NODE(module, descr);                              \
 352     SYSCTL_JAIL_PARAM(_##module, , CTLTYPE_INT | (access), "E,jailsys", \
 353         descr)
 354
 355 /*
 356  * Kernel support functions for jail().
 357  */
 358 struct ucred;
 359 struct mount;
 360 struct sockaddr;
 361 struct statfs;
 362 int jailed(struct ucred *cred);
 363 int jailed_without_vnet(struct ucred *);
 364 void getcredhostname(struct ucred *, char *, size_t);
 365 void getcreddomainname(struct ucred *, char *, size_t);
 366 void getcredhostuuid(struct ucred *, char *, size_t);
 367 void getcredhostid(struct ucred *, unsigned long *);
 368 void prison0_init(void);
 369 int prison_allow(struct ucred *, unsigned);
 370 int prison_check(struct ucred *cred1, struct ucred *cred2);
 371 int prison_owns_vnet(struct ucred *);
 372 int prison_canseemount(struct ucred *cred, struct mount *mp);
 373 void prison_enforce_statfs(struct ucred *cred, struct mount *mp,
 374     struct statfs *sp);
 375 struct prison *prison_find(int prid);
 376 struct prison *prison_find_child(struct prison *, int);
 377 struct prison *prison_find_name(struct prison *, const char *);
 378 int prison_flag(struct ucred *, unsigned);
 379 void prison_free(struct prison *pr);
 380 void prison_free_locked(struct prison *pr);
 381 void prison_hold(struct prison *pr);
 382 void prison_hold_locked(struct prison *pr);
 383 void prison_proc_hold(struct prison *);
 384 void prison_proc_free(struct prison *);
 385 int prison_ischild(struct prison *, struct prison *);
 386 int prison_equal_ip4(struct prison *, struct prison *);
 387 int prison_get_ip4(struct ucred *cred, struct in_addr *ia);
 388 int prison_local_ip4(struct ucred *cred, struct in_addr *ia);
 389 int prison_remote_ip4(struct ucred *cred, struct in_addr *ia);
 390 int prison_check_ip4(const struct ucred *, const struct in_addr *);
 391 int prison_saddrsel_ip4(struct ucred *, struct in_addr *);
 392 #ifdef INET6
 393 int prison_equal_ip6(struct prison *, struct prison *);
 394 int prison_get_ip6(struct ucred *, struct in6_addr *);
 395 int prison_local_ip6(struct ucred *, struct in6_addr *, int);
 396 int prison_remote_ip6(struct ucred *, struct in6_addr *);
 397 int prison_check_ip6(struct ucred *, struct in6_addr *);
 398 int prison_saddrsel_ip6(struct ucred *, struct in6_addr *);
 399 #endif
 400 int prison_check_af(struct ucred *cred, int af);
 401 int prison_if(struct ucred *cred, struct sockaddr *sa);
 402 char *prison_name(struct prison *, struct prison *);
 403 int prison_priv_check(struct ucred *cred, int priv);
 404 int sysctl_jail_param(SYSCTL_HANDLER_ARGS);
 405 void prison_racct_foreach(void (*callback)(struct racct *racct,
 406     void *arg2, void *arg3), void *arg2, void *arg3);
 407 struct prison_racct *prison_racct_find(const char *name);
 408 void prison_racct_hold(struct prison_racct *prr);
 409 void prison_racct_free(struct prison_racct *prr);
 410
 411 #endif /* _KERNEL */
 412 #endif /* !_SYS_JAIL_H_ */