blob: 0ec61789bb6c4befbe6e7b5ec20917466f52e6a5 [file] [log] [blame]
Elly Fong-Jonesd9a16cd2012-11-12 16:09:49 -05001// Copyright (c) 2012 The Chromium OS 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
Alex Vakulenko262be3f2014-07-30 15:25:50 -07005#ifndef DEBUGD_SRC_SANDBOXED_PROCESS_H_
6#define DEBUGD_SRC_SANDBOXED_PROCESS_H_
Ben Chana0011d82014-05-13 00:19:29 -07007
8#include <string>
Ricky Liang1ef73e52016-05-24 16:32:34 +08009#include <vector>
Elly Fong-Jonesd9a16cd2012-11-12 16:09:49 -050010
Alex Vakulenkoe7696532015-10-16 16:27:29 -070011#include <brillo/process.h>
Elly Fong-Jonesd9a16cd2012-11-12 16:09:49 -050012
13namespace debugd {
14
Alex Vakulenkoe7696532015-10-16 16:27:29 -070015class SandboxedProcess : public brillo::ProcessImpl {
Elly Fong-Jonesd9a16cd2012-11-12 16:09:49 -050016 public:
17 SandboxedProcess();
Eric Carusoa6f1adb2017-05-24 14:19:46 -070018 ~SandboxedProcess() override = default;
Ben Chan297c3c22013-07-17 17:34:12 -070019
20 // Get the full path of a helper executable located at the |relative_path|
21 // relative to the debugd helpers directory. Return false if the full path
22 // is too long.
23 static bool GetHelperPath(const std::string& relative_path,
24 std::string* full_path);
Elly Fong-Jonesd9a16cd2012-11-12 16:09:49 -050025
26 virtual bool Init();
27
Jorge Lucangeli Obesc99a12a2014-09-17 16:43:40 -070028 // Disable the default sandboxing for this process.
Elly Fong-Jonesd9a16cd2012-11-12 16:09:49 -050029 virtual void DisableSandbox();
30
Jorge Lucangeli Obesc99a12a2014-09-17 16:43:40 -070031 // Change the default sandboxing for this process.
Elly Fong-Jonesd9a16cd2012-11-12 16:09:49 -050032 virtual void SandboxAs(const std::string& user, const std::string& group);
33
David Valleau09f46642017-12-19 17:55:14 -080034 // Allow the sandbox to inherit supplementary groups from the uid.
35 virtual void InheritUsergroups();
36
Edward Hillad7de4e2017-07-05 14:45:17 -060037 // Set the capabilities mask for this process. Requires that the process is
38 // not running as root.
39 void SetCapabilities(uint64_t capabilities_mask) override;
40
Justin Carlson73310fb2016-10-11 16:13:26 -070041 // Set a file to be used as the seccomp bpf file for this process. See
42 // minijail0 -S for details of what can be in this file.
43 virtual void SetSeccompFilterPolicyFile(const std::string& path);
44
Jorge Lucangeli Obesc99a12a2014-09-17 16:43:40 -070045 // Allow this process to access the root mount namespace.
46 virtual void AllowAccessRootMountNamespace();
47
Jorge Lucangeli Obes389a9ee2015-05-14 17:37:01 -070048 // Kill the sandboxed process' process group.
49 virtual bool KillProcessGroup();
50
Ben Chanaf125862017-02-08 23:11:18 -080051 static const char kDefaultUser[];
52 static const char kDefaultGroup[];
Elly Fong-Jones215b5622013-03-20 14:32:18 -040053
Elly Fong-Jonesd9a16cd2012-11-12 16:09:49 -050054 private:
55 bool sandboxing_;
Jorge Lucangeli Obesc99a12a2014-09-17 16:43:40 -070056 bool access_root_mount_ns_;
Edward Hillad7de4e2017-07-05 14:45:17 -060057 bool set_capabilities_;
David Valleau09f46642017-12-19 17:55:14 -080058 bool inherit_usergroups_;
Elly Fong-Jonesd9a16cd2012-11-12 16:09:49 -050059 std::string user_;
60 std::string group_;
Justin Carlson73310fb2016-10-11 16:13:26 -070061 std::string seccomp_filter_policy_file_;
Edward Hillad7de4e2017-07-05 14:45:17 -060062 uint64_t capabilities_mask_;
Elly Fong-Jonesd9a16cd2012-11-12 16:09:49 -050063};
64
Ben Chana0011d82014-05-13 00:19:29 -070065} // namespace debugd
Elly Fong-Jonesd9a16cd2012-11-12 16:09:49 -050066
Alex Vakulenko262be3f2014-07-30 15:25:50 -070067#endif // DEBUGD_SRC_SANDBOXED_PROCESS_H_