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 = -1
  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 = -1,
  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 = -1
  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 = -1,
  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 = -1,
  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         ProtectHome protect_home;
  77         ProtectSystem protect_system;
  78         ProtectProc protect_proc;
  79         ProcSubset proc_subset;
  80 };
  81
  82 struct BindMount {
  83         char *source;
  84         char *destination;
  85         bool read_only;
  86         bool nosuid;
  87         bool recursive;
  88         bool ignore_enoent;
  89 };
  90
  91 struct TemporaryFileSystem {
  92         char *path;
  93         char *options;
  94 };
  95
  96 struct MountImage {
  97         char *source;
  98         char *destination;
  99         LIST_HEAD(MountOptions, mount_options);
 100         bool ignore_enoent;
 101 };
 102
 103 int setup_namespace(
 104                 const char *root_directory,
 105                 const char *root_image,
 106                 const MountOptions *root_image_options,
 107                 const NamespaceInfo *ns_info,
 108                 char **read_write_paths,
 109                 char **read_only_paths,
 110                 char **inaccessible_paths,
 111                 char **empty_directories,
 112                 const BindMount *bind_mounts,
 113                 size_t n_bind_mounts,
 114                 const TemporaryFileSystem *temporary_filesystems,
 115                 size_t n_temporary_filesystems,
 116                 const MountImage *mount_images,
 117                 size_t n_mount_images,
 118                 const char *tmp_dir,
 119                 const char *var_tmp_dir,
 120                 const char *creds_path,
 121                 const char *log_namespace,
 122                 unsigned long mount_flags,
 123                 const void *root_hash,
 124                 size_t root_hash_size,
 125                 const char *root_hash_path,
 126                 const void *root_hash_sig,
 127                 size_t root_hash_sig_size,
 128                 const char *root_hash_sig_path,
 129                 const char *root_verity,
 130                 DissectImageFlags dissected_image_flags,
 131                 char **error_path);
 132
 133 #define RUN_SYSTEMD_EMPTY "/run/systemd/empty"
 134
 135 static inline void namespace_cleanup_tmpdir(char *p) {
 136         PROTECT_ERRNO;
 137         if (!streq_ptr(p, RUN_SYSTEMD_EMPTY))
 138                 (void) rmdir(p);
 139         free(p);
 140 }
 141 DEFINE_TRIVIAL_CLEANUP_FUNC(char*, namespace_cleanup_tmpdir);
 142
 143 int setup_tmp_dirs(
 144                 const char *id,
 145                 char **tmp_dir,
 146                 char **var_tmp_dir);
 147
 148 int setup_netns(const int netns_storage_socket[static 2]);
 149 int open_netns_path(const int netns_storage_socket[static 2], const char *path);
 150
 151 const char* protect_home_to_string(ProtectHome p) _const_;
 152 ProtectHome protect_home_from_string(const char *s) _pure_;
 153
 154 const char* protect_system_to_string(ProtectSystem p) _const_;
 155 ProtectSystem protect_system_from_string(const char *s) _pure_;
 156
 157 const char* protect_proc_to_string(ProtectProc i) _const_;
 158 ProtectProc protect_proc_from_string(const char *s) _pure_;
 159
 160 const char* proc_subset_to_string(ProcSubset i) _const_;
 161 ProcSubset proc_subset_from_string(const char *s) _pure_;
 162
 163 void bind_mount_free_many(BindMount *b, size_t n);
 164 int bind_mount_add(BindMount **b, size_t *n, const BindMount *item);
 165
 166 void temporary_filesystem_free_many(TemporaryFileSystem *t, size_t n);
 167 int temporary_filesystem_add(TemporaryFileSystem **t, size_t *n,
 168                              const char *path, const char *options);
 169
 170 MountImage* mount_image_free_many(MountImage *m, size_t *n);
 171 int mount_image_add(MountImage **m, size_t *n, const MountImage *item);
 172
 173 const char* namespace_type_to_string(NamespaceType t) _const_;
 174 NamespaceType namespace_type_from_string(const char *s) _pure_;
 175
 176 bool ns_type_supported(NamespaceType type);