Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(298)

Side by Side Diff: sandbox/src/sandbox.h

Issue 10689170: Move the Windows sandbox to sandbox/win (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: Rebase on top of tree (properly this time) Created 8 years, 5 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
« no previous file with comments | « sandbox/src/restricted_token_utils.cc ('k') | sandbox/src/sandbox.cc » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
(Empty)
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 // Sandbox is a sandbox library for windows processes. Use when you want a
6 // 'privileged' process and a 'locked down process' to interact with.
7 // The privileged process is called the broker and it is started by external
8 // means (such as the user starting it). The 'sandboxed' process is called the
9 // target and it is started by the broker. There can be many target processes
10 // started by a single broker process. This library provides facilities
11 // for both the broker and the target.
12 //
13 // The design rationale and relevant documents can be found at http://go/sbox.
14 //
15 // Note: this header does not include the SandboxFactory definitions because
16 // there are cases where the Sandbox library is linked against the main .exe
17 // while its API needs to be used in a DLL.
18
19 #ifndef SANDBOX_SRC_SANDBOX_H__
20 #define SANDBOX_SRC_SANDBOX_H__
21
22 #include <windows.h>
23
24 #include "base/basictypes.h"
25 #include "sandbox/src/sandbox_policy.h"
26 #include "sandbox/src/sandbox_types.h"
27
28 // sandbox: Google User-Land Application Sandbox
29 namespace sandbox {
30
31 class BrokerServices;
32 class ProcessState;
33 class TargetPolicy;
34 class TargetServices;
35
36 // BrokerServices exposes all the broker API.
37 // The basic use is to start the target(s) and wait for them to end.
38 //
39 // This API is intended to be called in the following order
40 // (error checking omitted):
41 // BrokerServices* broker = SandboxFactory::GetBrokerServices();
42 // broker->Init();
43 // PROCESS_INFORMATION target;
44 // broker->SpawnTarget(target_exe_path, target_args, &target);
45 // ::ResumeThread(target->hThread);
46 // // -- later you can call:
47 // broker->WaitForAllTargets(option);
48 //
49 class BrokerServices {
50 public:
51 // Initializes the broker. Must be called before any other on this class.
52 // returns ALL_OK if successful. All other return values imply failure.
53 // If the return is ERROR_GENERIC, you can call ::GetLastError() to get
54 // more information.
55 virtual ResultCode Init() = 0;
56
57 // Returns the interface pointer to a new, empty policy object. Use this
58 // interface to specify the sandbox policy for new processes created by
59 // SpawnTarget()
60 virtual TargetPolicy* CreatePolicy() = 0;
61
62 // Creates a new target (child process) in a suspended state.
63 // Parameters:
64 // exe_path: This is the full path to the target binary. This parameter
65 // can be null and in this case the exe path must be the first argument
66 // of the command_line.
67 // command_line: The arguments to be passed as command line to the new
68 // process. This can be null if the exe_path parameter is not null.
69 // policy: This is the pointer to the policy object for the sandbox to
70 // be created.
71 // target: returns the resulting target process information such as process
72 // handle and PID just as if CreateProcess() had been called. The caller is
73 // responsible for closing the handles returned in this structure.
74 // Returns:
75 // ALL_OK if successful. All other return values imply failure.
76 virtual ResultCode SpawnTarget(const wchar_t* exe_path,
77 const wchar_t* command_line,
78 TargetPolicy* policy,
79 PROCESS_INFORMATION* target) = 0;
80
81 // This call blocks (waits) for all the targets to terminate.
82 // Returns:
83 // ALL_OK if successful. All other return values imply failure.
84 // If the return is ERROR_GENERIC, you can call ::GetLastError() to get
85 // more information.
86 virtual ResultCode WaitForAllTargets() = 0;
87
88 // Adds an unsandboxed process as a peer for policy decisions (e.g.
89 // HANDLES_DUP_ANY policy).
90 // Returns:
91 // ALL_OK if successful. All other return values imply failure.
92 // If the return is ERROR_GENERIC, you can call ::GetLastError() to get
93 // more information.
94 virtual ResultCode AddTargetPeer(HANDLE peer_process) = 0;
95 };
96
97 // TargetServices models the current process from the perspective
98 // of a target process. To obtain a pointer to it use
99 // Sandbox::GetTargetServices(). Note that this call returns a non-null
100 // pointer only if this process is in fact a target. A process is a target
101 // only if the process was spawned by a call to BrokerServices::SpawnTarget().
102 //
103 // This API allows the target to gain access to resources with a high
104 // privilege token and then when it is ready to perform dangerous activities
105 // (such as download content from the web) it can lower its token and
106 // enter into locked-down (sandbox) mode.
107 // The typical usage is as follows:
108 //
109 // TargetServices* target_services = Sandbox::GetTargetServices();
110 // if (NULL != target_services) {
111 // // We are the target.
112 // target_services->Init();
113 // // Do work that requires high privileges here.
114 // // ....
115 // // When ready to enter lock-down mode call LowerToken:
116 // target_services->LowerToken();
117 // }
118 //
119 // For more information see the BrokerServices API documentation.
120 class TargetServices {
121 public:
122 // Initializes the target. Must call this function before any other.
123 // returns ALL_OK if successful. All other return values imply failure.
124 // If the return is ERROR_GENERIC, you can call ::GetLastError() to get
125 // more information.
126 virtual ResultCode Init() = 0;
127
128 // Discards the impersonation token and uses the lower token, call before
129 // processing any untrusted data or running third-party code. If this call
130 // fails the current process could be terminated immediately.
131 virtual void LowerToken() = 0;
132
133 // Returns the ProcessState object. Through that object it's possible to have
134 // information about the current state of the process, such as whether
135 // LowerToken has been called or not.
136 virtual ProcessState* GetState() = 0;
137
138 // Requests the broker to duplicate the supplied handle into the target
139 // process. The target process must be an active sandbox child process
140 // and the source process must have a corresponding policy allowing
141 // handle duplication for this object type.
142 // Returns:
143 // ALL_OK if successful. All other return values imply failure.
144 // If the return is ERROR_GENERIC, you can call ::GetLastError() to get
145 // more information.
146 virtual ResultCode DuplicateHandle(HANDLE source_handle,
147 DWORD target_process_id,
148 HANDLE* target_handle,
149 DWORD desired_access,
150 DWORD options) = 0;
151 };
152
153 } // namespace sandbox
154
155
156 #endif // SANDBOX_SRC_SANDBOX_H__
OLDNEW
« no previous file with comments | « sandbox/src/restricted_token_utils.cc ('k') | sandbox/src/sandbox.cc » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698