src/core/namespace.h

   1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
   2 #pragma once
   3
   4 /***
   5   Copyright © 2016 Djalal Harouni
   6 ***/
   7
   8 typedef struct NamespaceInfo NamespaceInfo;
   9 typedef struct BindMount BindMount;
  10 typedef struct TemporaryFileSystem TemporaryFileSystem;
  11 typedef struct MountImage MountImage;
  12
  13 #include <stdbool.h>
  14
  15 #include "dissect-image.h"
  16 #include "fs-util.h"
  17 #include "macro.h"
  18 #include "string-util.h"
  19
  20 typedef enum ProtectHome {
  21         PROTECT_HOME_NO,
  22         PROTECT_HOME_YES,
  23         PROTECT_HOME_READ_ONLY,
  24         PROTECT_HOME_TMPFS,
  25         _PROTECT_HOME_MAX,
  26         _PROTECT_HOME_INVALID = -EINVAL,
  27 } ProtectHome;
  28
  29 typedef enum NamespaceType {
  30         NAMESPACE_MOUNT,
  31         NAMESPACE_CGROUP,
  32         NAMESPACE_UTS,
  33         NAMESPACE_IPC,
  34         NAMESPACE_USER,
  35         NAMESPACE_PID,
  36         NAMESPACE_NET,
  37         _NAMESPACE_TYPE_MAX,
  38         _NAMESPACE_TYPE_INVALID = -EINVAL,
  39 } NamespaceType;
  40
  41 typedef enum ProtectSystem {
  42         PROTECT_SYSTEM_NO,
  43         PROTECT_SYSTEM_YES,
  44         PROTECT_SYSTEM_FULL,
  45         PROTECT_SYSTEM_STRICT,
  46         _PROTECT_SYSTEM_MAX,
  47         _PROTECT_SYSTEM_INVALID = -EINVAL,
  48 } ProtectSystem;
  49
  50 typedef enum ProtectProc {
  51         PROTECT_PROC_DEFAULT,
  52         PROTECT_PROC_NOACCESS,   /* hidepid=noaccess */
  53         PROTECT_PROC_INVISIBLE,  /* hidepid=invisible */
  54         PROTECT_PROC_PTRACEABLE, /* hidepid=ptraceable */
  55         _PROTECT_PROC_MAX,
  56         _PROTECT_PROC_INVALID = -EINVAL,
  57 } ProtectProc;
  58
  59 typedef enum ProcSubset {
  60         PROC_SUBSET_ALL,
  61         PROC_SUBSET_PID, /* subset=pid */
  62         _PROC_SUBSET_MAX,
  63         _PROC_SUBSET_INVALID = -EINVAL,
  64 } ProcSubset;
  65
  66 struct NamespaceInfo {
  67         bool ignore_protect_paths;
  68         bool private_dev;
  69         bool private_mounts;
  70         bool protect_control_groups;
  71         bool protect_kernel_tunables;
  72         bool protect_kernel_modules;
  73         bool protect_kernel_logs;
  74         bool mount_apivfs;
  75         bool protect_hostname;
  76         bool private_ipc;
  77         ProtectHome protect_home;
  78         ProtectSystem protect_system;
  79         ProtectProc protect_proc;
  80         ProcSubset proc_subset;
  81 };
  82
  83 struct BindMount {
  84         char *source;
  85         char *destination;
  86         bool read_only;
  87         bool nosuid;
  88         bool recursive;
  89         bool ignore_enoent;
  90 };
  91
  92 struct TemporaryFileSystem {
  93         char *path;
  94         char *options;
  95 };
  96
  97 typedef enum MountImageType {
  98         MOUNT_IMAGE_DISCRETE,
  99         MOUNT_IMAGE_EXTENSION,
 100         _MOUNT_IMAGE_TYPE_MAX,
 101         _MOUNT_IMAGE_TYPE_INVALID = -EINVAL,
 102 } MountImageType;
 103
 104 struct MountImage {
 105         char *source;
 106         char *destination; /* Unused if MountImageType == MOUNT_IMAGE_EXTENSION */
 107         LIST_HEAD(MountOptions, mount_options);
 108         bool ignore_enoent;
 109         MountImageType type;
 110 };
 111
 112 int setup_namespace(
 113                 const char *root_directory,
 114                 const char *root_image,
 115                 const MountOptions *root_image_options,
 116                 const NamespaceInfo *ns_info,
 117                 char **read_write_paths,
 118                 char **read_only_paths,
 119                 char **inaccessible_paths,
 120                 char **exec_paths,
 121                 char **no_exec_paths,
 122                 char **empty_directories,
 123                 const BindMount *bind_mounts,
 124                 size_t n_bind_mounts,
 125                 const TemporaryFileSystem *temporary_filesystems,
 126                 size_t n_temporary_filesystems,
 127                 const MountImage *mount_images,
 128                 size_t n_mount_images,
 129                 const char *tmp_dir,
 130                 const char *var_tmp_dir,
 131                 const char *creds_path,
 132                 const char *log_namespace,
 133                 unsigned long mount_flags,
 134                 const void *root_hash,
 135                 size_t root_hash_size,
 136                 const char *root_hash_path,
 137                 const void *root_hash_sig,
 138                 size_t root_hash_sig_size,
 139                 const char *root_hash_sig_path,
 140                 const char *root_verity,
 141                 const MountImage *extension_images,
 142                 size_t n_extension_images,
 143                 const char *propagate_dir,
 144                 const char *incoming_dir,
 145                 const char *notify_socket,
 146                 char **error_path);
 147
 148 #define RUN_SYSTEMD_EMPTY "/run/systemd/empty"
 149
 150 static inline char* namespace_cleanup_tmpdir(char *p) {
 151         PROTECT_ERRNO;
 152         if (!streq_ptr(p, RUN_SYSTEMD_EMPTY))
 153                 (void) rmdir(p);
 154         return mfree(p);
 155 }
 156 DEFINE_TRIVIAL_CLEANUP_FUNC(char*, namespace_cleanup_tmpdir);
 157
 158 int setup_tmp_dirs(
 159                 const char *id,
 160                 char **tmp_dir,
 161                 char **var_tmp_dir);
 162
 163 int setup_shareable_ns(const int ns_storage_socket[static 2], unsigned long nsflag);
 164 int open_shareable_ns_path(const int netns_storage_socket[static 2], const char *path, unsigned long nsflag);
 165
 166 const char* protect_home_to_string(ProtectHome p) _const_;
 167 ProtectHome protect_home_from_string(const char *s) _pure_;
 168
 169 const char* protect_system_to_string(ProtectSystem p) _const_;
 170 ProtectSystem protect_system_from_string(const char *s) _pure_;
 171
 172 const char* protect_proc_to_string(ProtectProc i) _const_;
 173 ProtectProc protect_proc_from_string(const char *s) _pure_;
 174
 175 const char* proc_subset_to_string(ProcSubset i) _const_;
 176 ProcSubset proc_subset_from_string(const char *s) _pure_;
 177
 178 void bind_mount_free_many(BindMount *b, size_t n);
 179 int bind_mount_add(BindMount **b, size_t *n, const BindMount *item);
 180
 181 void temporary_filesystem_free_many(TemporaryFileSystem *t, size_t n);
 182 int temporary_filesystem_add(TemporaryFileSystem **t, size_t *n,
 183                              const char *path, const char *options);
 184
 185 MountImage* mount_image_free_many(MountImage *m, size_t *n);
 186 int mount_image_add(MountImage **m, size_t *n, const MountImage *item);
 187
 188 const char* namespace_type_to_string(NamespaceType t) _const_;
 189 NamespaceType namespace_type_from_string(const char *s) _pure_;
 190
 191 bool ns_type_supported(NamespaceType type);