src/basic/capability-util.c

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 /***
   3   Copyright 2010 Lennart Poettering
   4 ***/
   5
   6 #include <errno.h>
   7 #include <grp.h>
   8 #include <stdio.h>
   9 #include <stdlib.h>
  10 #include <sys/capability.h>
  11 #include <sys/prctl.h>
  12 #include <unistd.h>
  13
  14 #include "alloc-util.h"
  15 #include "capability-util.h"
  16 #include "fileio.h"
  17 #include "log.h"
  18 #include "macro.h"
  19 #include "parse-util.h"
  20 #include "user-util.h"
  21 #include "util.h"
  22
  23 #if 0 /// UNNEEDED by elogind
  24 int have_effective_cap(int value) {
  25         _cleanup_cap_free_ cap_t cap;
  26         cap_flag_value_t fv;
  27
  28         cap = cap_get_proc();
  29         if (!cap)
  30                 return -errno;
  31
  32         if (cap_get_flag(cap, value, CAP_EFFECTIVE, &fv) < 0)
  33                 return -errno;
  34         else
  35                 return fv == CAP_SET;
  36 }
  37 #endif // 0
  38
  39 unsigned long cap_last_cap(void) {
  40         static thread_local unsigned long saved;
  41         static thread_local bool valid = false;
  42         _cleanup_free_ char *content = NULL;
  43         unsigned long p = 0;
  44         int r;
  45
  46         if (valid)
  47                 return saved;
  48
  49         /* available since linux-3.2 */
  50         r = read_one_line_file("/proc/sys/kernel/cap_last_cap", &content);
  51         if (r >= 0) {
  52                 r = safe_atolu(content, &p);
  53                 if (r >= 0) {
  54                         saved = p;
  55                         valid = true;
  56                         return p;
  57                 }
  58         }
  59
  60         /* fall back to syscall-probing for pre linux-3.2 */
  61         p = (unsigned long) CAP_LAST_CAP;
  62
  63         if (prctl(PR_CAPBSET_READ, p) < 0) {
  64
  65                 /* Hmm, look downwards, until we find one that
  66                  * works */
  67                 for (p--; p > 0; p --)
  68                         if (prctl(PR_CAPBSET_READ, p) >= 0)
  69                                 break;
  70
  71         } else {
  72
  73                 /* Hmm, look upwards, until we find one that doesn't
  74                  * work */
  75                 for (;; p++)
  76                         if (prctl(PR_CAPBSET_READ, p+1) < 0)
  77                                 break;
  78         }
  79
  80         saved = p;
  81         valid = true;
  82
  83         return p;
  84 }
  85
  86 #if 0 /// UNNEEDED by elogind
  87 int capability_update_inherited_set(cap_t caps, uint64_t set) {
  88         unsigned long i;
  89
  90         /* Add capabilities in the set to the inherited caps. Do not apply
  91          * them yet. */
  92
  93         for (i = 0; i < cap_last_cap(); i++) {
  94
  95                 if (set & (UINT64_C(1) << i)) {
  96                         cap_value_t v;
  97
  98                         v = (cap_value_t) i;
  99
 100                         /* Make the capability inheritable. */
 101                         if (cap_set_flag(caps, CAP_INHERITABLE, 1, &v, CAP_SET) < 0)
 102                                 return -errno;
 103                 }
 104         }
 105
 106         return 0;
 107 }
 108
 109 int capability_ambient_set_apply(uint64_t set, bool also_inherit) {
 110         unsigned long i;
 111         _cleanup_cap_free_ cap_t caps = NULL;
 112
 113         /* Add the capabilities to the ambient set. */
 114
 115         if (also_inherit) {
 116                 int r;
 117                 caps = cap_get_proc();
 118                 if (!caps)
 119                         return -errno;
 120
 121                 r = capability_update_inherited_set(caps, set);
 122                 if (r < 0)
 123                         return -errno;
 124
 125                 if (cap_set_proc(caps) < 0)
 126                         return -errno;
 127         }
 128
 129         for (i = 0; i < cap_last_cap(); i++) {
 130
 131                 if (set & (UINT64_C(1) << i)) {
 132
 133                         /* Add the capability to the ambient set. */
 134                         if (prctl(PR_CAP_AMBIENT, PR_CAP_AMBIENT_RAISE, i, 0, 0) < 0)
 135                                 return -errno;
 136                 }
 137         }
 138
 139         return 0;
 140 }
 141
 142 int capability_bounding_set_drop(uint64_t keep, bool right_now) {
 143         _cleanup_cap_free_ cap_t before_cap = NULL, after_cap = NULL;
 144         cap_flag_value_t fv;
 145         unsigned long i;
 146         int r;
 147
 148         /* If we are run as PID 1 we will lack CAP_SETPCAP by default
 149          * in the effective set (yes, the kernel drops that when
 150          * executing init!), so get it back temporarily so that we can
 151          * call PR_CAPBSET_DROP. */
 152
 153         before_cap = cap_get_proc();
 154         if (!before_cap)
 155                 return -errno;
 156
 157         if (cap_get_flag(before_cap, CAP_SETPCAP, CAP_EFFECTIVE, &fv) < 0)
 158                 return -errno;
 159
 160         if (fv != CAP_SET) {
 161                 _cleanup_cap_free_ cap_t temp_cap = NULL;
 162                 static const cap_value_t v = CAP_SETPCAP;
 163
 164                 temp_cap = cap_dup(before_cap);
 165                 if (!temp_cap)
 166                         return -errno;
 167
 168                 if (cap_set_flag(temp_cap, CAP_EFFECTIVE, 1, &v, CAP_SET) < 0)
 169                         return -errno;
 170
 171                 if (cap_set_proc(temp_cap) < 0)
 172                         log_debug_errno(errno, "Can't acquire effective CAP_SETPCAP bit, ignoring: %m");
 173
 174                 /* If we didn't manage to acquire the CAP_SETPCAP bit, we continue anyway, after all this just means
 175                  * we'll fail later, when we actually intend to drop some capabilities. */
 176         }
 177
 178         after_cap = cap_dup(before_cap);
 179         if (!after_cap)
 180                 return -errno;
 181
 182         for (i = 0; i <= cap_last_cap(); i++) {
 183                 cap_value_t v;
 184
 185                 if ((keep & (UINT64_C(1) << i)))
 186                         continue;
 187
 188                 /* Drop it from the bounding set */
 189                 if (prctl(PR_CAPBSET_DROP, i) < 0) {
 190                         r = -errno;
 191
 192                         /* If dropping the capability failed, let's see if we didn't have it in the first place. If so,
 193                          * continue anyway, as dropping a capability we didn't have in the first place doesn't really
 194                          * matter anyway. */
 195                         if (prctl(PR_CAPBSET_READ, i) != 0)
 196                                 goto finish;
 197                 }
 198                 v = (cap_value_t) i;
 199
 200                 /* Also drop it from the inheritable set, so
 201                  * that anything we exec() loses the
 202                  * capability for good. */
 203                 if (cap_set_flag(after_cap, CAP_INHERITABLE, 1, &v, CAP_CLEAR) < 0) {
 204                         r = -errno;
 205                         goto finish;
 206                 }
 207
 208                 /* If we shall apply this right now drop it
 209                  * also from our own capability sets. */
 210                 if (right_now) {
 211                         if (cap_set_flag(after_cap, CAP_PERMITTED, 1, &v, CAP_CLEAR) < 0 ||
 212                             cap_set_flag(after_cap, CAP_EFFECTIVE, 1, &v, CAP_CLEAR) < 0) {
 213                                 r = -errno;
 214                                 goto finish;
 215                         }
 216                 }
 217         }
 218
 219         r = 0;
 220
 221 finish:
 222         if (cap_set_proc(after_cap) < 0) {
 223                 /* If there are no actual changes anyway then let's ignore this error. */
 224                 if (cap_compare(before_cap, after_cap) != 0)
 225                         r = -errno;
 226         }
 227
 228         return r;
 229 }
 230
 231 static int drop_from_file(const char *fn, uint64_t keep) {
 232         _cleanup_free_ char *p = NULL;
 233         uint64_t current, after;
 234         uint32_t hi, lo;
 235         int r, k;
 236
 237         r = read_one_line_file(fn, &p);
 238         if (r < 0)
 239                 return r;
 240
 241         assert_cc(sizeof(hi) == sizeof(unsigned));
 242         assert_cc(sizeof(lo) == sizeof(unsigned));
 243
 244         k = sscanf(p, "%u %u", &lo, &hi);
 245         if (k != 2)
 246                 return -EIO;
 247
 248         current = (uint64_t) lo | ((uint64_t) hi << 32ULL);
 249         after = current & keep;
 250
 251         if (current == after)
 252                 return 0;
 253
 254         lo = (unsigned) (after & 0xFFFFFFFFULL);
 255         hi = (unsigned) ((after >> 32ULL) & 0xFFFFFFFFULL);
 256
 257         return write_string_filef(fn, WRITE_STRING_FILE_CREATE, "%u %u", lo, hi);
 258 }
 259
 260 int capability_bounding_set_drop_usermode(uint64_t keep) {
 261         int r;
 262
 263         r = drop_from_file("/proc/sys/kernel/usermodehelper/inheritable", keep);
 264         if (r < 0)
 265                 return r;
 266
 267         r = drop_from_file("/proc/sys/kernel/usermodehelper/bset", keep);
 268         if (r < 0)
 269                 return r;
 270
 271         return r;
 272 }
 273
 274 int drop_privileges(uid_t uid, gid_t gid, uint64_t keep_capabilities) {
 275         _cleanup_cap_free_ cap_t d = NULL;
 276         unsigned i, j = 0;
 277         int r;
 278
 279         /* Unfortunately we cannot leave privilege dropping to PID 1
 280          * here, since we want to run as user but want to keep some
 281          * capabilities. Since file capabilities have been introduced
 282          * this cannot be done across exec() anymore, unless our
 283          * binary has the capability configured in the file system,
 284          * which we want to avoid. */
 285
 286         if (setresgid(gid, gid, gid) < 0)
 287                 return log_error_errno(errno, "Failed to change group ID: %m");
 288
 289         r = maybe_setgroups(0, NULL);
 290         if (r < 0)
 291                 return log_error_errno(r, "Failed to drop auxiliary groups list: %m");
 292
 293         /* Ensure we keep the permitted caps across the setresuid() */
 294         if (prctl(PR_SET_KEEPCAPS, 1) < 0)
 295                 return log_error_errno(errno, "Failed to enable keep capabilities flag: %m");
 296
 297         if (setresuid(uid, uid, uid) < 0)
 298                 return log_error_errno(errno, "Failed to change user ID: %m");
 299
 300         if (prctl(PR_SET_KEEPCAPS, 0) < 0)
 301                 return log_error_errno(errno, "Failed to disable keep capabilities flag: %m");
 302
 303         /* Drop all caps from the bounding set, except the ones we want */
 304         r = capability_bounding_set_drop(keep_capabilities, true);
 305         if (r < 0)
 306                 return log_error_errno(r, "Failed to drop capabilities: %m");
 307
 308         /* Now upgrade the permitted caps we still kept to effective caps */
 309         d = cap_init();
 310         if (!d)
 311                 return log_oom();
 312
 313         if (keep_capabilities) {
 314                 cap_value_t bits[u64log2(keep_capabilities) + 1];
 315
 316                 for (i = 0; i < ELEMENTSOF(bits); i++)
 317                         if (keep_capabilities & (1ULL << i))
 318                                 bits[j++] = i;
 319
 320                 /* use enough bits */
 321                 assert(i == 64 || (keep_capabilities >> i) == 0);
 322                 /* don't use too many bits */
 323                 assert(keep_capabilities & (1ULL << (i - 1)));
 324
 325                 if (cap_set_flag(d, CAP_EFFECTIVE, j, bits, CAP_SET) < 0 ||
 326                     cap_set_flag(d, CAP_PERMITTED, j, bits, CAP_SET) < 0)
 327                         return log_error_errno(errno, "Failed to enable capabilities bits: %m");
 328
 329                 if (cap_set_proc(d) < 0)
 330                         return log_error_errno(errno, "Failed to increase capabilities: %m");
 331         }
 332
 333         return 0;
 334 }
 335
 336 int drop_capability(cap_value_t cv) {
 337         _cleanup_cap_free_ cap_t tmp_cap = NULL;
 338
 339         tmp_cap = cap_get_proc();
 340         if (!tmp_cap)
 341                 return -errno;
 342
 343         if ((cap_set_flag(tmp_cap, CAP_INHERITABLE, 1, &cv, CAP_CLEAR) < 0) ||
 344             (cap_set_flag(tmp_cap, CAP_PERMITTED, 1, &cv, CAP_CLEAR) < 0) ||
 345             (cap_set_flag(tmp_cap, CAP_EFFECTIVE, 1, &cv, CAP_CLEAR) < 0))
 346                 return -errno;
 347
 348         if (cap_set_proc(tmp_cap) < 0)
 349                 return -errno;
 350
 351         return 0;
 352 }
 353
 354 bool ambient_capabilities_supported(void) {
 355         static int cache = -1;
 356
 357         if (cache >= 0)
 358                 return cache;
 359
 360         /* If PR_CAP_AMBIENT returns something valid, or an unexpected error code we assume that ambient caps are
 361          * available. */
 362
 363         cache = prctl(PR_CAP_AMBIENT, PR_CAP_AMBIENT_IS_SET, CAP_KILL, 0, 0) >= 0 ||
 364                 !IN_SET(errno, EINVAL, EOPNOTSUPP, ENOSYS);
 365
 366         return cache;
 367 }
 368 #endif // 0