sys/sys/jail.h

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