src/sandbox/linux/seccomp-bpf/errorcode.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef SANDBOX_LINUX_SECCOMP_BPF_ERRORCODE_H__
   6 #define SANDBOX_LINUX_SECCOMP_BPF_ERRORCODE_H__
   7
   8 #include "sandbox/linux/seccomp-bpf/trap.h"
   9 #include "sandbox/sandbox_export.h"
  10
  11 namespace sandbox {
  12 namespace bpf_dsl {
  13 class PolicyCompiler;
  14 }
  15
  16 // This class holds all the possible values that can be returned by a sandbox
  17 // policy.
  18 // We can either wrap a symbolic ErrorCode (i.e. ERR_XXX enum values), an
  19 // errno value (in the range 0..4095), a pointer to a TrapFnc callback
  20 // handling a SECCOMP_RET_TRAP trap, or a complex constraint.
  21 // All of the commonly used values are stored in the "err_" field. So, code
  22 // that is using the ErrorCode class typically operates on a single 32bit
  23 // field.
  24 class SANDBOX_EXPORT ErrorCode {
  25  public:
  26   enum {
  27     // Allow this system call. The value of ERR_ALLOWED is pretty much
  28     // completely arbitrary. But we want to pick it so that is is unlikely
  29     // to be passed in accidentally, when the user intended to return an
  30     // "errno" (see below) value instead.
  31     ERR_ALLOWED = 0x04000000,
  32
  33     // If the progress is being ptraced with PTRACE_O_TRACESECCOMP, then the
  34     // tracer will be notified of a PTRACE_EVENT_SECCOMP and allowed to change
  35     // or skip the system call.  The lower 16 bits of err will be available to
  36     // the tracer via PTRACE_GETEVENTMSG.
  37     ERR_TRACE   = 0x08000000,
  38
  39     // Deny the system call with a particular "errno" value.
  40     // N.B.: It is also possible to return "0" here. That would normally
  41     //       indicate success, but it won't actually run the system call.
  42     //       This is very different from return ERR_ALLOWED.
  43     ERR_MIN_ERRNO = 0,
  44 #if defined(__mips__)
  45     // MIPS only supports errno up to 1133
  46     ERR_MAX_ERRNO = 1133,
  47 #else
  48     // TODO(markus): Android only supports errno up to 255
  49     // (crbug.com/181647).
  50     ERR_MAX_ERRNO = 4095,
  51 #endif
  52   };
  53
  54   // While BPF filter programs always operate on 32bit quantities, the kernel
  55   // always sees system call arguments as 64bit values. This statement is true
  56   // no matter whether the host system is natively operating in 32bit or 64bit.
  57   // The BPF compiler hides the fact that BPF instructions cannot directly
  58   // access 64bit quantities. But policies are still advised to specify whether
  59   // a system call expects a 32bit or a 64bit quantity.
  60   enum ArgType {
  61     // When passed as an argument to SandboxBPF::Cond(), TP_32BIT requests that
  62     // the conditional test should operate on the 32bit part of the system call
  63     // argument.
  64     // On 64bit architectures, this verifies that user space did not pass
  65     // a 64bit value as an argument to the system call. If it did, that will be
  66     // interpreted as an attempt at breaking the sandbox and results in the
  67     // program getting terminated.
  68     // In other words, only perform a 32bit test, if you are sure this
  69     // particular system call would never legitimately take a 64bit
  70     // argument.
  71     // Implementation detail: TP_32BIT does two things. 1) it restricts the
  72     // conditional test to operating on the LSB only, and 2) it adds code to
  73     // the BPF filter program verifying that the MSB  the kernel received from
  74     // user space is either 0, or 0xFFFFFFFF; the latter is acceptable, iff bit
  75     // 31 was set in the system call argument. It deals with 32bit arguments
  76     // having been sign extended.
  77     TP_32BIT,
  78
  79     // When passed as an argument to SandboxBPF::Cond(), TP_64BIT requests that
  80     // the conditional test should operate on the full 64bit argument. It is
  81     // generally harmless to perform a 64bit test on 32bit systems, as the
  82     // kernel will always see the top 32 bits of all arguments as zero'd out.
  83     // This approach has the desirable property that for tests of pointer
  84     // values, we can always use TP_64BIT no matter the host architecture.
  85     // But of course, that also means, it is possible to write conditional
  86     // policies that turn into no-ops on 32bit systems; this is by design.
  87     TP_64BIT,
  88   };
  89
  90   // Deprecated.
  91   enum Operation {
  92     // Test whether the system call argument is equal to the operand.
  93     OP_EQUAL,
  94
  95     // Tests a system call argument against a bit mask.
  96     // The "ALL_BITS" variant performs this test: "arg & mask == mask"
  97     // This implies that a mask of zero always results in a passing test.
  98     // The "ANY_BITS" variant performs this test: "arg & mask != 0"
  99     // This implies that a mask of zero always results in a failing test.
 100     OP_HAS_ALL_BITS,
 101     OP_HAS_ANY_BITS,
 102   };
 103
 104   enum ErrorType {
 105     ET_INVALID,
 106     ET_SIMPLE,
 107     ET_TRAP,
 108     ET_COND,
 109   };
 110
 111   // We allow the default constructor, as it makes the ErrorCode class
 112   // much easier to use. But if we ever encounter an invalid ErrorCode
 113   // when compiling a BPF filter, we deliberately generate an invalid
 114   // program that will get flagged both by our Verifier class and by
 115   // the Linux kernel.
 116   ErrorCode();
 117   explicit ErrorCode(int err);
 118
 119   // For all practical purposes, ErrorCodes are treated as if they were
 120   // structs. The copy constructor and assignment operator are trivial and
 121   // we do not need to explicitly specify them.
 122   // Most notably, it is in fact perfectly OK to directly copy the passed_ and
 123   // failed_ field. They only ever get set by our private constructor, and the
 124   // callers handle life-cycle management for these objects.
 125
 126   // Destructor
 127   ~ErrorCode() {}
 128
 129   bool Equals(const ErrorCode& err) const;
 130   bool LessThan(const ErrorCode& err) const;
 131
 132   uint32_t err() const { return err_; }
 133   ErrorType error_type() const { return error_type_; }
 134
 135   bool safe() const { return safe_; }
 136
 137   uint64_t mask() const { return mask_; }
 138   uint64_t value() const { return value_; }
 139   int argno() const { return argno_; }
 140   ArgType width() const { return width_; }
 141   const ErrorCode* passed() const { return passed_; }
 142   const ErrorCode* failed() const { return failed_; }
 143
 144   struct LessThan {
 145     bool operator()(const ErrorCode& a, const ErrorCode& b) const {
 146       return a.LessThan(b);
 147     }
 148   };
 149
 150  private:
 151   friend bpf_dsl::PolicyCompiler;
 152   friend class CodeGen;
 153   friend class SandboxBPF;
 154   friend class Trap;
 155
 156   // If we are wrapping a callback, we must assign a unique id. This id is
 157   // how the kernel tells us which one of our different SECCOMP_RET_TRAP
 158   // cases has been triggered.
 159   ErrorCode(uint16_t trap_id, Trap::TrapFnc fnc, const void* aux, bool safe);
 160
 161   // Some system calls require inspection of arguments. This constructor
 162   // allows us to specify additional constraints.
 163   ErrorCode(int argno,
 164             ArgType width,
 165             uint64_t mask,
 166             uint64_t value,
 167             const ErrorCode* passed,
 168             const ErrorCode* failed);
 169
 170   ErrorType error_type_;
 171
 172   union {
 173     // Fields needed for SECCOMP_RET_TRAP callbacks
 174     struct {
 175       Trap::TrapFnc fnc_;  // Callback function and arg, if trap was
 176       void* aux_;          //   triggered by the kernel's BPF filter.
 177       bool safe_;          // Keep sandbox active while calling fnc_()
 178     };
 179
 180     // Fields needed when inspecting additional arguments.
 181     struct {
 182       uint64_t mask_;            // Mask that we are comparing under.
 183       uint64_t value_;           // Value that we are comparing with.
 184       int argno_;                // Syscall arg number that we are inspecting.
 185       ArgType width_;            // Whether we are looking at a 32/64bit value.
 186       const ErrorCode* passed_;  // Value to be returned if comparison passed,
 187       const ErrorCode* failed_;  //   or if it failed.
 188     };
 189   };
 190
 191   // 32bit field used for all possible types of ErrorCode values. This is
 192   // the value that uniquely identifies any ErrorCode and it (typically) can
 193   // be emitted directly into a BPF filter program.
 194   uint32_t err_;
 195 };
 196
 197 }  // namespace sandbox
 198
 199 #endif  // SANDBOX_LINUX_SECCOMP_BPF_ERRORCODE_H__