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 #define PRISON_STATE_INVALID    0
  92 #define PRISON_STATE_ALIVE      1
  93 #define PRISON_STATE_DYING      2
  94
  95 /*
  96  * Flags for jail_set and jail_get.
  97  */
  98 #define JAIL_CREATE     0x01    /* Create jail if it doesn't exist */
  99 #define JAIL_UPDATE     0x02    /* Update parameters of existing jail */
 100 #define JAIL_ATTACH     0x04    /* Attach to jail upon creation */
 101 #define JAIL_DYING      0x08    /* Allow getting a dying jail */
 102 #define JAIL_SET_MASK   0x0f
 103 #define JAIL_GET_MASK   0x08
 104
 105 #define JAIL_SYS_DISABLE        0
 106 #define JAIL_SYS_NEW            1
 107 #define JAIL_SYS_INHERIT        2
 108
 109 #ifndef _KERNEL
 110
 111 struct iovec;
 112
 113 __BEGIN_DECLS
 114 int jail(struct jail *);
 115 int jail_set(struct iovec *, unsigned int, int);
 116 int jail_get(struct iovec *, unsigned int, int);
 117 int jail_attach(int);
 118 int jail_remove(int);
 119 __END_DECLS
 120
 121 #else /* _KERNEL */
 122
 123 #include <sys/queue.h>
 124 #include <sys/sysctl.h>
 125 #include <sys/lock.h>
 126 #include <sys/mutex.h>
 127 #include <sys/_task.h>
 128
 129 #define JAIL_MAX        999999
 130
 131 #ifdef MALLOC_DECLARE
 132 MALLOC_DECLARE(M_PRISON);
 133 #endif
 134 #endif /* _KERNEL */
 135
 136 #if defined(_KERNEL) || defined(_WANT_PRISON)
 137
 138 #include <sys/osd.h>
 139
 140 #define HOSTUUIDLEN     64
 141 #define OSRELEASELEN    32
 142
 143 struct racct;
 144 struct prison_racct;
 145
 146 /*
 147  * This structure describes a prison.  It is pointed to by all struct
 148  * ucreds's of the inmates.  pr_ref keeps track of them and is used to
 149  * delete the struture when the last inmate is dead.
 150  *
 151  * Lock key:
 152  *   (a) allprison_lock
 153  *   (p) locked by pr_mtx
 154  *   (c) set only during creation before the structure is shared, no mutex
 155  *       required to read
 156  */
 157 struct prison {
 158         TAILQ_ENTRY(prison) pr_list;                    /* (a) all prisons */
 159         int              pr_id;                         /* (c) prison id */
 160         int              pr_ref;                        /* (p) refcount */
 161         int              pr_uref;                       /* (p) user (alive) refcount */
 162         unsigned         pr_flags;                      /* (p) PR_* flags */
 163         LIST_HEAD(, prison) pr_children;                /* (a) list of child jails */
 164         LIST_ENTRY(prison) pr_sibling;                  /* (a) next in parent's list */
 165         struct prison   *pr_parent;                     /* (c) containing jail */
 166         struct mtx       pr_mtx;
 167         struct task      pr_task;                       /* (c) destroy task */
 168         struct osd       pr_osd;                        /* (p) additional data */
 169         struct cpuset   *pr_cpuset;                     /* (p) cpuset */
 170         struct vnet     *pr_vnet;                       /* (c) network stack */
 171         struct vnode    *pr_root;                       /* (c) vnode to rdir */
 172         int              pr_ip4s;                       /* (p) number of v4 IPs */
 173         int              pr_ip6s;                       /* (p) number of v6 IPs */
 174         struct in_addr  *pr_ip4;                        /* (p) v4 IPs of jail */
 175         struct in6_addr *pr_ip6;                        /* (p) v6 IPs of jail */
 176         struct prison_racct *pr_prison_racct;           /* (c) racct jail proxy */
 177         void            *pr_sparep[3];
 178         int              pr_childcount;                 /* (a) number of child jails */
 179         int              pr_childmax;                   /* (p) maximum child jails */
 180         unsigned         pr_allow;                      /* (p) PR_ALLOW_* flags */
 181         int              pr_securelevel;                /* (p) securelevel */
 182         int              pr_enforce_statfs;             /* (p) statfs permission */
 183         int              pr_devfs_rsnum;                /* (p) devfs ruleset */
 184         int              pr_spare[3];
 185         int              pr_osreldate;                  /* (c) kern.osreldate value */
 186         unsigned long    pr_hostid;                     /* (p) jail hostid */
 187         char             pr_name[MAXHOSTNAMELEN];       /* (p) admin jail name */
 188         char             pr_path[MAXPATHLEN];           /* (c) chroot path */
 189         char             pr_hostname[MAXHOSTNAMELEN];   /* (p) jail hostname */
 190         char             pr_domainname[MAXHOSTNAMELEN]; /* (p) jail domainname */
 191         char             pr_hostuuid[HOSTUUIDLEN];      /* (p) jail hostuuid */
 192         char             pr_osrelease[OSRELEASELEN];    /* (c) kern.osrelease value */
 193 };
 194
 195 struct prison_racct {
 196         LIST_ENTRY(prison_racct) prr_next;
 197         char            prr_name[MAXHOSTNAMELEN];
 198         u_int           prr_refcount;
 199         struct racct    *prr_racct;
 200 };
 201 #endif /* _KERNEL || _WANT_PRISON */
 202
 203 #ifdef _KERNEL
 204 /* Flag bits set via options */
 205 #define PR_PERSIST      0x00000001      /* Can exist without processes */
 206 #define PR_HOST         0x00000002      /* Virtualize hostname et al */
 207 #define PR_IP4_USER     0x00000004      /* Restrict IPv4 addresses */
 208 #define PR_IP6_USER     0x00000008      /* Restrict IPv6 addresses */
 209 #define PR_VNET         0x00000010      /* Virtual network stack */
 210 #define PR_IP4_SADDRSEL 0x00000080      /* Do IPv4 src addr sel. or use the */
 211                                         /* primary jail address. */
 212 #define PR_IP6_SADDRSEL 0x00000100      /* Do IPv6 src addr sel. or use the */
 213                                         /* primary jail address. */
 214
 215 /* Internal flag bits */
 216 #define PR_IP4          0x02000000      /* IPv4 restricted or disabled */
 217                                         /* by this jail or an ancestor */
 218 #define PR_IP6          0x04000000      /* IPv6 restricted or disabled */
 219                                         /* by this jail or an ancestor */
 220
 221 /*
 222  * Flags for pr_allow
 223  * Bits not noted here may be used for dynamic allow.mount.xxxfs.
 224  */
 225 #define PR_ALLOW_SET_HOSTNAME           0x00000001
 226 #define PR_ALLOW_SYSVIPC                0x00000002
 227 #define PR_ALLOW_RAW_SOCKETS            0x00000004
 228 #define PR_ALLOW_CHFLAGS                0x00000008
 229 #define PR_ALLOW_MOUNT                  0x00000010
 230 #define PR_ALLOW_QUOTAS                 0x00000020
 231 #define PR_ALLOW_SOCKET_AF              0x00000040
 232 #define PR_ALLOW_MLOCK                  0x00000080
 233 #define PR_ALLOW_READ_MSGBUF            0x00000100
 234 #define PR_ALLOW_UNPRIV_DEBUG           0x00000200
 235 #define PR_ALLOW_SUSER                  0x00000400
 236 #define PR_ALLOW_RESERVED_PORTS         0x00008000
 237 #define PR_ALLOW_KMEM_ACCESS            0x00010000      /* reserved, not used yet */
 238 #define PR_ALLOW_ALL_STATIC             0x000187ff
 239
 240 /*
 241  * PR_ALLOW_DIFFERENCES determines which flags are able to be
 242  * different between the parent and child jail upon creation.
 243  */
 244 #define PR_ALLOW_DIFFERENCES            (PR_ALLOW_UNPRIV_DEBUG)
 245
 246 /*
 247  * OSD methods
 248  */
 249 #define PR_METHOD_CREATE        0
 250 #define PR_METHOD_GET           1
 251 #define PR_METHOD_SET           2
 252 #define PR_METHOD_CHECK         3
 253 #define PR_METHOD_ATTACH        4
 254 #define PR_METHOD_REMOVE        5
 255 #define PR_MAXMETHOD            6
 256
 257 /*
 258  * Lock/unlock a prison.
 259  * XXX These exist not so much for general convenience, but to be useable in
 260  *     the FOREACH_PRISON_DESCENDANT_LOCKED macro which can't handle them in
 261  *     non-function form as currently defined.
 262  */
 263 static __inline void
 264 prison_lock(struct prison *pr)
 265 {
 266
 267         mtx_lock(&pr->pr_mtx);
 268 }
 269
 270 static __inline void
 271 prison_unlock(struct prison *pr)
 272 {
 273
 274         mtx_unlock(&pr->pr_mtx);
 275 }
 276
 277 /* Traverse a prison's immediate children. */
 278 #define FOREACH_PRISON_CHILD(ppr, cpr)                                  \
 279         LIST_FOREACH(cpr, &(ppr)->pr_children, pr_sibling)
 280
 281 /*
 282  * Preorder traversal of all of a prison's descendants.
 283  * This ugly loop allows the macro to be followed by a single block
 284  * as expected in a looping primitive.
 285  */
 286 #define FOREACH_PRISON_DESCENDANT(ppr, cpr, descend)                    \
 287         for ((cpr) = (ppr), (descend) = 1;                              \
 288             ((cpr) = (((descend) && !LIST_EMPTY(&(cpr)->pr_children))   \
 289               ? LIST_FIRST(&(cpr)->pr_children)                         \
 290               : ((cpr) == (ppr)                                         \
 291                  ? NULL                                                 \
 292                  : (((descend) = LIST_NEXT(cpr, pr_sibling) != NULL)    \
 293                     ? LIST_NEXT(cpr, pr_sibling)                        \
 294                     : (cpr)->pr_parent))));)                            \
 295                 if (!(descend))                                         \
 296                         ;                                               \
 297                 else
 298
 299 /*
 300  * As above, but lock descendants on the way down and unlock on the way up.
 301  */
 302 #define FOREACH_PRISON_DESCENDANT_LOCKED(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                  : ((prison_unlock(cpr),                                \
 309                     (descend) = LIST_NEXT(cpr, pr_sibling) != NULL)     \
 310                     ? LIST_NEXT(cpr, pr_sibling)                        \
 311                     : (cpr)->pr_parent))));)                            \
 312                 if ((descend) ? (prison_lock(cpr), 0) : 1)              \
 313                         ;                                               \
 314                 else
 315
 316 /*
 317  * As above, but also keep track of the level descended to.
 318  */
 319 #define FOREACH_PRISON_DESCENDANT_LOCKED_LEVEL(ppr, cpr, descend, level)\
 320         for ((cpr) = (ppr), (descend) = 1, (level) = 0;                 \
 321             ((cpr) = (((descend) && !LIST_EMPTY(&(cpr)->pr_children))   \
 322               ? (level++, LIST_FIRST(&(cpr)->pr_children))              \
 323               : ((cpr) == (ppr)                                         \
 324                  ? NULL                                                 \
 325                  : ((prison_unlock(cpr),                                \
 326                     (descend) = LIST_NEXT(cpr, pr_sibling) != NULL)     \
 327                     ? LIST_NEXT(cpr, pr_sibling)                        \
 328                     : (level--, (cpr)->pr_parent)))));)                 \
 329                 if ((descend) ? (prison_lock(cpr), 0) : 1)              \
 330                         ;                                               \
 331                 else
 332
 333 /*
 334  * Attributes of the physical system, and the root of the jail tree.
 335  */
 336 extern struct   prison prison0;
 337
 338 TAILQ_HEAD(prisonlist, prison);
 339 extern struct   prisonlist allprison;
 340 extern struct   sx allprison_lock;
 341
 342 /*
 343  * Sysctls to describe jail parameters.
 344  */
 345 SYSCTL_DECL(_security_jail_param);
 346
 347 #define SYSCTL_JAIL_PARAM(module, param, type, fmt, descr)              \
 348     SYSCTL_PROC(_security_jail_param ## module, OID_AUTO, param,        \
 349         (type) | CTLFLAG_MPSAFE, NULL, 0, sysctl_jail_param, fmt, descr)
 350 #define SYSCTL_JAIL_PARAM_STRING(module, param, access, len, descr)     \
 351     SYSCTL_PROC(_security_jail_param ## module, OID_AUTO, param,        \
 352         CTLTYPE_STRING | CTLFLAG_MPSAFE | (access), NULL, len,          \
 353         sysctl_jail_param, "A", descr)
 354 #define SYSCTL_JAIL_PARAM_STRUCT(module, param, access, len, fmt, descr)\
 355     SYSCTL_PROC(_security_jail_param ## module, OID_AUTO, param,        \
 356         CTLTYPE_STRUCT | CTLFLAG_MPSAFE | (access), NULL, len,          \
 357         sysctl_jail_param, fmt, descr)
 358 #define SYSCTL_JAIL_PARAM_NODE(module, descr)                           \
 359     SYSCTL_NODE(_security_jail_param, OID_AUTO, module, CTLFLAG_MPSAFE, \
 360         0, descr)
 361 #define SYSCTL_JAIL_PARAM_SUBNODE(parent, module, descr)                \
 362     SYSCTL_NODE(_security_jail_param_##parent, OID_AUTO, module,        \
 363         CTLFLAG_MPSAFE, 0, descr)
 364 #define SYSCTL_JAIL_PARAM_SYS_NODE(module, access, descr)               \
 365     SYSCTL_JAIL_PARAM_NODE(module, descr);                              \
 366     SYSCTL_JAIL_PARAM(_##module, , CTLTYPE_INT | (access), "E,jailsys", \
 367         descr)
 368
 369 /*
 370  * Kernel support functions for jail().
 371  */
 372 struct ucred;
 373 struct mount;
 374 struct sockaddr;
 375 struct statfs;
 376 struct vfsconf;
 377
 378 /*
 379  * Return 1 if the passed credential is in a jail, otherwise 0.
 380  */
 381 #define jailed(cred)    (cred->cr_prison != &prison0)
 382
 383 int jailed_without_vnet(struct ucred *);
 384 void getcredhostname(struct ucred *, char *, size_t);
 385 void getcreddomainname(struct ucred *, char *, size_t);
 386 void getcredhostuuid(struct ucred *, char *, size_t);
 387 void getcredhostid(struct ucred *, unsigned long *);
 388 void getjailname(struct ucred *cred, char *name, size_t len);
 389 void prison0_init(void);
 390 int prison_allow(struct ucred *, unsigned);
 391 int prison_check(struct ucred *cred1, struct ucred *cred2);
 392 int prison_owns_vnet(struct ucred *);
 393 int prison_canseemount(struct ucred *cred, struct mount *mp);
 394 void prison_enforce_statfs(struct ucred *cred, struct mount *mp,
 395     struct statfs *sp);
 396 struct prison *prison_find(int prid);
 397 struct prison *prison_find_child(struct prison *, int);
 398 struct prison *prison_find_name(struct prison *, const char *);
 399 int prison_flag(struct ucred *, unsigned);
 400 void prison_free(struct prison *pr);
 401 void prison_free_locked(struct prison *pr);
 402 void prison_hold(struct prison *pr);
 403 void prison_hold_locked(struct prison *pr);
 404 void prison_proc_hold(struct prison *);
 405 void prison_proc_free(struct prison *);
 406 int prison_ischild(struct prison *, struct prison *);
 407 int prison_equal_ip4(struct prison *, struct prison *);
 408 int prison_get_ip4(struct ucred *cred, struct in_addr *ia);
 409 int prison_local_ip4(struct ucred *cred, struct in_addr *ia);
 410 int prison_remote_ip4(struct ucred *cred, struct in_addr *ia);
 411 int prison_check_ip4(const struct ucred *, const struct in_addr *);
 412 int prison_check_ip4_locked(const struct prison *, const struct in_addr *);
 413 int prison_saddrsel_ip4(struct ucred *, struct in_addr *);
 414 int prison_restrict_ip4(struct prison *, struct in_addr *);
 415 int prison_qcmp_v4(const void *, const void *);
 416 #ifdef INET6
 417 int prison_equal_ip6(struct prison *, struct prison *);
 418 int prison_get_ip6(struct ucred *, struct in6_addr *);
 419 int prison_local_ip6(struct ucred *, struct in6_addr *, int);
 420 int prison_remote_ip6(struct ucred *, struct in6_addr *);
 421 int prison_check_ip6(const struct ucred *, const struct in6_addr *);
 422 int prison_check_ip6_locked(const struct prison *, const struct in6_addr *);
 423 int prison_saddrsel_ip6(struct ucred *, struct in6_addr *);
 424 int prison_restrict_ip6(struct prison *, struct in6_addr *);
 425 int prison_qcmp_v6(const void *, const void *);
 426 #endif
 427 int prison_check_af(struct ucred *cred, int af);
 428 int prison_if(struct ucred *cred, const struct sockaddr *sa);
 429 char *prison_name(struct prison *, struct prison *);
 430 int prison_priv_check(struct ucred *cred, int priv);
 431 int sysctl_jail_param(SYSCTL_HANDLER_ARGS);
 432 unsigned prison_add_allow(const char *prefix, const char *name,
 433     const char *prefix_descr, const char *descr);
 434 void prison_add_vfs(struct vfsconf *vfsp);
 435 void prison_racct_foreach(void (*callback)(struct racct *racct,
 436     void *arg2, void *arg3), void (*pre)(void), void (*post)(void),
 437     void *arg2, void *arg3);
 438 struct prison_racct *prison_racct_find(const char *name);
 439 void prison_racct_hold(struct prison_racct *prr);
 440 void prison_racct_free(struct prison_racct *prr);
 441
 442 #endif /* _KERNEL */
 443 #endif /* !_SYS_JAIL_H_ */