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.
5 #include "sandbox/win/src/broker_services.h"
9 #include "base/logging.h"
10 #include "base/memory/scoped_ptr.h"
11 #include "base/threading/platform_thread.h"
12 #include "base/win/scoped_handle.h"
13 #include "base/win/scoped_process_information.h"
14 #include "base/win/startup_information.h"
15 #include "base/win/windows_version.h"
16 #include "sandbox/win/src/app_container.h"
17 #include "sandbox/win/src/process_mitigations.h"
18 #include "sandbox/win/src/sandbox_policy_base.h"
19 #include "sandbox/win/src/sandbox.h"
20 #include "sandbox/win/src/target_process.h"
21 #include "sandbox/win/src/win2k_threadpool.h"
22 #include "sandbox/win/src/win_utils.h"
26 // Utility function to associate a completion port to a job object.
27 bool AssociateCompletionPort(HANDLE job
, HANDLE port
, void* key
) {
28 JOBOBJECT_ASSOCIATE_COMPLETION_PORT job_acp
= { key
, port
};
29 return ::SetInformationJobObject(job
,
30 JobObjectAssociateCompletionPortInformation
,
31 &job_acp
, sizeof(job_acp
))? true : false;
34 // Utility function to do the cleanup necessary when something goes wrong
35 // while in SpawnTarget and we must terminate the target process.
36 sandbox::ResultCode
SpawnCleanup(sandbox::TargetProcess
* target
, DWORD error
) {
38 error
= ::GetLastError();
42 ::SetLastError(error
);
43 return sandbox::SBOX_ERROR_GENERIC
;
46 // the different commands that you can send to the worker thread that
47 // executes TargetEventsThread().
50 THREAD_CTRL_REMOVE_PEER
,
55 // Helper structure that allows the Broker to associate a job notification
56 // with a job object and with a policy.
59 sandbox::PolicyBase
* policy
;
60 JobTracker(HANDLE cjob
, sandbox::PolicyBase
* cpolicy
)
61 : job(cjob
), policy(cpolicy
) {
65 // Helper structure that allows the broker to track peer processes
68 base::win::ScopedHandle process
;
71 PeerTracker(DWORD process_id
, HANDLE broker_job_port
)
72 : wait_object(NULL
), id(process_id
), job_port(broker_job_port
) {
76 void DeregisterPeerTracker(PeerTracker
* peer
) {
77 // Deregistration shouldn't fail, but we leak rather than crash if it does.
78 if (::UnregisterWaitEx(peer
->wait_object
, INVALID_HANDLE_VALUE
)) {
85 // Utility function to determine whether a token for the specified policy can
87 bool IsTokenCacheable(const sandbox::PolicyBase
* policy
) {
88 const sandbox::AppContainerAttributes
* app_container
=
89 policy
->GetAppContainer();
91 // We cannot cache tokens with an app container or lowbox.
92 if (app_container
|| policy
->GetLowBoxSid())
98 // Utility function to pack token values into a key for the cache map.
99 uint32_t GenerateTokenCacheKey(const sandbox::PolicyBase
* policy
) {
100 const size_t kTokenShift
= 3;
103 DCHECK(IsTokenCacheable(policy
));
105 // Make sure our token values aren't too large to pack into the key.
106 static_assert(sandbox::USER_LAST
<= (1 << kTokenShift
),
107 "TokenLevel too large");
108 static_assert(sandbox::INTEGRITY_LEVEL_LAST
<= (1 << kTokenShift
),
109 "IntegrityLevel too large");
110 static_assert(sizeof(key
) < (kTokenShift
* 3),
111 "Token key type too small");
113 // The key is the enum values shifted to avoid overlap and OR'd together.
114 key
= policy
->GetInitialTokenLevel();
116 key
|= policy
->GetLockdownTokenLevel();
118 key
|= policy
->GetIntegrityLevel();
127 BrokerServicesBase::BrokerServicesBase()
128 : thread_pool_(NULL
), job_port_(NULL
), no_targets_(NULL
),
132 // The broker uses a dedicated worker thread that services the job completion
133 // port to perform policy notifications and associated cleanup tasks.
134 ResultCode
BrokerServicesBase::Init() {
135 if ((NULL
!= job_port_
) || (NULL
!= thread_pool_
))
136 return SBOX_ERROR_UNEXPECTED_CALL
;
138 ::InitializeCriticalSection(&lock_
);
140 job_port_
= ::CreateIoCompletionPort(INVALID_HANDLE_VALUE
, NULL
, 0, 0);
141 if (NULL
== job_port_
)
142 return SBOX_ERROR_GENERIC
;
144 no_targets_
= ::CreateEventW(NULL
, TRUE
, FALSE
, NULL
);
146 job_thread_
= ::CreateThread(NULL
, 0, // Default security and stack.
147 TargetEventsThread
, this, NULL
, NULL
);
148 if (NULL
== job_thread_
)
149 return SBOX_ERROR_GENERIC
;
154 // The destructor should only be called when the Broker process is terminating.
155 // Since BrokerServicesBase is a singleton, this is called from the CRT
156 // termination handlers, if this code lives on a DLL it is called during
157 // DLL_PROCESS_DETACH in other words, holding the loader lock, so we cannot
158 // wait for threads here.
159 BrokerServicesBase::~BrokerServicesBase() {
160 // If there is no port Init() was never called successfully.
164 // Closing the port causes, that no more Job notifications are delivered to
165 // the worker thread and also causes the thread to exit. This is what we
166 // want to do since we are going to close all outstanding Jobs and notifying
167 // the policy objects ourselves.
168 ::PostQueuedCompletionStatus(job_port_
, 0, THREAD_CTRL_QUIT
, FALSE
);
169 ::CloseHandle(job_port_
);
171 if (WAIT_TIMEOUT
== ::WaitForSingleObject(job_thread_
, 1000)) {
172 // Cannot clean broker services.
177 JobTrackerList::iterator it
;
178 for (it
= tracker_list_
.begin(); it
!= tracker_list_
.end(); ++it
) {
179 JobTracker
* tracker
= (*it
);
180 FreeResources(tracker
);
183 ::CloseHandle(job_thread_
);
185 ::CloseHandle(no_targets_
);
187 // Cancel the wait events and delete remaining peer trackers.
188 for (PeerTrackerMap::iterator it
= peer_map_
.begin();
189 it
!= peer_map_
.end(); ++it
) {
190 DeregisterPeerTracker(it
->second
);
193 // If job_port_ isn't NULL, assumes that the lock has been initialized.
195 ::DeleteCriticalSection(&lock_
);
197 // Close any token in the cache.
198 for (TokenCacheMap::iterator it
= token_cache_
.begin();
199 it
!= token_cache_
.end(); ++it
) {
200 ::CloseHandle(it
->second
.first
);
201 ::CloseHandle(it
->second
.second
);
205 TargetPolicy
* BrokerServicesBase::CreatePolicy() {
206 // If you change the type of the object being created here you must also
207 // change the downcast to it in SpawnTarget().
208 return new PolicyBase
;
211 void BrokerServicesBase::FreeResources(JobTracker
* tracker
) {
212 if (NULL
!= tracker
->policy
) {
213 BOOL res
= ::TerminateJobObject(tracker
->job
, SBOX_ALL_OK
);
215 // Closing the job causes the target process to be destroyed so this
216 // needs to happen before calling OnJobEmpty().
217 res
= ::CloseHandle(tracker
->job
);
219 // In OnJobEmpty() we don't actually use the job handle directly.
220 tracker
->policy
->OnJobEmpty(tracker
->job
);
221 tracker
->policy
->Release();
222 tracker
->policy
= NULL
;
226 // The worker thread stays in a loop waiting for asynchronous notifications
227 // from the job objects. Right now we only care about knowing when the last
228 // process on a job terminates, but in general this is the place to tell
229 // the policy about events.
230 DWORD WINAPI
BrokerServicesBase::TargetEventsThread(PVOID param
) {
234 base::PlatformThread::SetName("BrokerEvent");
236 BrokerServicesBase
* broker
= reinterpret_cast<BrokerServicesBase
*>(param
);
237 HANDLE port
= broker
->job_port_
;
238 HANDLE no_targets
= broker
->no_targets_
;
240 int target_counter
= 0;
241 ::ResetEvent(no_targets
);
246 LPOVERLAPPED ovl
= NULL
;
248 if (!::GetQueuedCompletionStatus(port
, &events
, &key
, &ovl
, INFINITE
))
249 // this call fails if the port has been closed before we have a
250 // chance to service the last packet which is 'exit' anyway so
251 // this is not an error.
254 if (key
> THREAD_CTRL_LAST
) {
255 // The notification comes from a job object. There are nine notifications
256 // that jobs can send and some of them depend on the job attributes set.
257 JobTracker
* tracker
= reinterpret_cast<JobTracker
*>(key
);
260 case JOB_OBJECT_MSG_ACTIVE_PROCESS_ZERO
: {
261 // The job object has signaled that the last process associated
262 // with it has terminated. Assuming there is no way for a process
263 // to appear out of thin air in this job, it safe to assume that
264 // we can tell the policy to destroy the target object, and for
265 // us to release our reference to the policy object.
266 FreeResources(tracker
);
270 case JOB_OBJECT_MSG_NEW_PROCESS
: {
272 if (1 == target_counter
) {
273 ::ResetEvent(no_targets
);
278 case JOB_OBJECT_MSG_EXIT_PROCESS
:
279 case JOB_OBJECT_MSG_ABNORMAL_EXIT_PROCESS
: {
281 AutoLock
lock(&broker
->lock_
);
282 broker
->child_process_ids_
.erase(reinterpret_cast<DWORD
>(ovl
));
285 if (0 == target_counter
)
286 ::SetEvent(no_targets
);
288 DCHECK(target_counter
>= 0);
292 case JOB_OBJECT_MSG_ACTIVE_PROCESS_LIMIT
: {
296 case JOB_OBJECT_MSG_PROCESS_MEMORY_LIMIT
: {
297 BOOL res
= ::TerminateJobObject(tracker
->job
,
298 SBOX_FATAL_MEMORY_EXCEEDED
);
308 } else if (THREAD_CTRL_REMOVE_PEER
== key
) {
309 // Remove a process from our list of peers.
310 AutoLock
lock(&broker
->lock_
);
311 PeerTrackerMap::iterator it
=
312 broker
->peer_map_
.find(reinterpret_cast<DWORD
>(ovl
));
313 DeregisterPeerTracker(it
->second
);
314 broker
->peer_map_
.erase(it
);
315 } else if (THREAD_CTRL_QUIT
== key
) {
316 // The broker object is being destroyed so the thread needs to exit.
319 // We have not implemented more commands.
328 // SpawnTarget does all the interesting sandbox setup and creates the target
329 // process inside the sandbox.
330 ResultCode
BrokerServicesBase::SpawnTarget(const wchar_t* exe_path
,
331 const wchar_t* command_line
,
332 TargetPolicy
* policy
,
333 PROCESS_INFORMATION
* target_info
) {
335 return SBOX_ERROR_BAD_PARAMS
;
338 return SBOX_ERROR_BAD_PARAMS
;
340 // Even though the resources touched by SpawnTarget can be accessed in
341 // multiple threads, the method itself cannot be called from more than
342 // 1 thread. This is to protect the global variables used while setting up
343 // the child process.
344 static DWORD thread_id
= ::GetCurrentThreadId();
345 DCHECK(thread_id
== ::GetCurrentThreadId());
347 AutoLock
lock(&lock_
);
349 // This downcast is safe as long as we control CreatePolicy()
350 PolicyBase
* policy_base
= static_cast<PolicyBase
*>(policy
);
352 if (policy_base
->GetAppContainer() && policy_base
->GetLowBoxSid())
353 return SBOX_ERROR_BAD_PARAMS
;
355 // Construct the tokens and the job object that we are going to associate
356 // with the soon to be created target process.
357 HANDLE initial_token_temp
;
358 HANDLE lockdown_token_temp
;
359 ResultCode result
= SBOX_ALL_OK
;
361 if (IsTokenCacheable(policy_base
)) {
362 // Create the master tokens only once and save them in a cache. That way
363 // can just duplicate them to avoid hammering LSASS on every sandboxed
365 uint32_t token_key
= GenerateTokenCacheKey(policy_base
);
366 TokenCacheMap::iterator it
= token_cache_
.find(token_key
);
367 if (it
!= token_cache_
.end()) {
368 initial_token_temp
= it
->second
.first
;
369 lockdown_token_temp
= it
->second
.second
;
372 policy_base
->MakeTokens(&initial_token_temp
, &lockdown_token_temp
);
373 if (SBOX_ALL_OK
!= result
)
375 token_cache_
[token_key
] =
376 std::pair
<HANDLE
, HANDLE
>(initial_token_temp
, lockdown_token_temp
);
379 if (!::DuplicateToken(initial_token_temp
, SecurityImpersonation
,
380 &initial_token_temp
)) {
381 return SBOX_ERROR_GENERIC
;
384 if (!::DuplicateTokenEx(lockdown_token_temp
, TOKEN_ALL_ACCESS
, 0,
385 SecurityIdentification
, TokenPrimary
,
386 &lockdown_token_temp
)) {
387 return SBOX_ERROR_GENERIC
;
390 result
= policy_base
->MakeTokens(&initial_token_temp
, &lockdown_token_temp
);
391 if (SBOX_ALL_OK
!= result
)
395 base::win::ScopedHandle
initial_token(initial_token_temp
);
396 base::win::ScopedHandle
lockdown_token(lockdown_token_temp
);
399 result
= policy_base
->MakeJobObject(&job_temp
);
400 if (SBOX_ALL_OK
!= result
)
403 base::win::ScopedHandle
job(job_temp
);
405 // Initialize the startup information from the policy.
406 base::win::StartupInformation startup_info
;
407 base::string16 desktop
= policy_base
->GetAlternateDesktop();
408 if (!desktop
.empty()) {
409 startup_info
.startup_info()->lpDesktop
=
410 const_cast<wchar_t*>(desktop
.c_str());
413 bool inherit_handles
= false;
414 if (base::win::GetVersion() >= base::win::VERSION_VISTA
) {
415 int attribute_count
= 0;
416 const AppContainerAttributes
* app_container
=
417 policy_base
->GetAppContainer();
422 size_t mitigations_size
;
423 ConvertProcessMitigationsToPolicy(policy
->GetProcessMitigations(),
424 &mitigations
, &mitigations_size
);
428 HANDLE stdout_handle
= policy_base
->GetStdoutHandle();
429 HANDLE stderr_handle
= policy_base
->GetStderrHandle();
430 HANDLE inherit_handle_list
[2];
431 int inherit_handle_count
= 0;
432 if (stdout_handle
!= INVALID_HANDLE_VALUE
)
433 inherit_handle_list
[inherit_handle_count
++] = stdout_handle
;
434 // Handles in the list must be unique.
435 if (stderr_handle
!= stdout_handle
&& stderr_handle
!= INVALID_HANDLE_VALUE
)
436 inherit_handle_list
[inherit_handle_count
++] = stderr_handle
;
437 if (inherit_handle_count
)
440 if (!startup_info
.InitializeProcThreadAttributeList(attribute_count
))
441 return SBOX_ERROR_PROC_THREAD_ATTRIBUTES
;
444 result
= app_container
->ShareForStartup(&startup_info
);
445 if (SBOX_ALL_OK
!= result
)
450 if (!startup_info
.UpdateProcThreadAttribute(
451 PROC_THREAD_ATTRIBUTE_MITIGATION_POLICY
, &mitigations
,
453 return SBOX_ERROR_PROC_THREAD_ATTRIBUTES
;
457 if (inherit_handle_count
) {
458 if (!startup_info
.UpdateProcThreadAttribute(
459 PROC_THREAD_ATTRIBUTE_HANDLE_LIST
,
461 sizeof(inherit_handle_list
[0]) * inherit_handle_count
)) {
462 return SBOX_ERROR_PROC_THREAD_ATTRIBUTES
;
464 startup_info
.startup_info()->dwFlags
|= STARTF_USESTDHANDLES
;
465 startup_info
.startup_info()->hStdInput
= INVALID_HANDLE_VALUE
;
466 startup_info
.startup_info()->hStdOutput
= stdout_handle
;
467 startup_info
.startup_info()->hStdError
= stderr_handle
;
468 // Allowing inheritance of handles is only secure now that we
469 // have limited which handles will be inherited.
470 inherit_handles
= true;
474 // Construct the thread pool here in case it is expensive.
475 // The thread pool is shared by all the targets
476 if (NULL
== thread_pool_
)
477 thread_pool_
= new Win2kThreadPool();
479 // Create the TargetProces object and spawn the target suspended. Note that
480 // Brokerservices does not own the target object. It is owned by the Policy.
481 base::win::ScopedProcessInformation process_info
;
482 TargetProcess
* target
= new TargetProcess(initial_token
.Take(),
483 lockdown_token
.Take(),
487 DWORD win_result
= target
->Create(exe_path
, command_line
, inherit_handles
,
488 policy_base
->GetLowBoxSid() ? true : false,
489 startup_info
, &process_info
);
490 if (ERROR_SUCCESS
!= win_result
)
491 return SpawnCleanup(target
, win_result
);
493 // Now the policy is the owner of the target.
494 if (!policy_base
->AddTarget(target
)) {
495 return SpawnCleanup(target
, 0);
498 // We are going to keep a pointer to the policy because we'll call it when
499 // the job object generates notifications using the completion port.
500 policy_base
->AddRef();
502 scoped_ptr
<JobTracker
> tracker(new JobTracker(job
.Take(), policy_base
));
503 if (!AssociateCompletionPort(tracker
->job
, job_port_
, tracker
.get()))
504 return SpawnCleanup(target
, 0);
505 // Save the tracker because in cleanup we might need to force closing
507 tracker_list_
.push_back(tracker
.release());
508 child_process_ids_
.insert(process_info
.process_id());
510 // We have to signal the event once here because the completion port will
511 // never get a message that this target is being terminated thus we should
512 // not block WaitForAllTargets until we have at least one target with job.
513 if (child_process_ids_
.empty())
514 ::SetEvent(no_targets_
);
515 // We can not track the life time of such processes and it is responsibility
516 // of the host application to make sure that spawned targets without jobs
517 // are terminated when the main application don't need them anymore.
520 *target_info
= process_info
.Take();
525 ResultCode
BrokerServicesBase::WaitForAllTargets() {
526 ::WaitForSingleObject(no_targets_
, INFINITE
);
530 bool BrokerServicesBase::IsActiveTarget(DWORD process_id
) {
531 AutoLock
lock(&lock_
);
532 return child_process_ids_
.find(process_id
) != child_process_ids_
.end() ||
533 peer_map_
.find(process_id
) != peer_map_
.end();
536 VOID CALLBACK
BrokerServicesBase::RemovePeer(PVOID parameter
, BOOLEAN timeout
) {
537 PeerTracker
* peer
= reinterpret_cast<PeerTracker
*>(parameter
);
538 // Don't check the return code because we this may fail (safely) at shutdown.
539 ::PostQueuedCompletionStatus(peer
->job_port
, 0, THREAD_CTRL_REMOVE_PEER
,
540 reinterpret_cast<LPOVERLAPPED
>(peer
->id
));
543 ResultCode
BrokerServicesBase::AddTargetPeer(HANDLE peer_process
) {
544 scoped_ptr
<PeerTracker
> peer(new PeerTracker(::GetProcessId(peer_process
),
547 return SBOX_ERROR_GENERIC
;
549 HANDLE process_handle
;
550 if (!::DuplicateHandle(::GetCurrentProcess(), peer_process
,
551 ::GetCurrentProcess(), &process_handle
,
552 SYNCHRONIZE
, FALSE
, 0)) {
553 return SBOX_ERROR_GENERIC
;
555 peer
->process
.Set(process_handle
);
557 AutoLock
lock(&lock_
);
558 if (!peer_map_
.insert(std::make_pair(peer
->id
, peer
.get())).second
)
559 return SBOX_ERROR_BAD_PARAMS
;
561 if (!::RegisterWaitForSingleObject(
562 &peer
->wait_object
, peer
->process
.Get(), RemovePeer
, peer
.get(),
563 INFINITE
, WT_EXECUTEONLYONCE
| WT_EXECUTEINWAITTHREAD
)) {
564 peer_map_
.erase(peer
->id
);
565 return SBOX_ERROR_GENERIC
;
568 // Release the pointer since it will be cleaned up by the callback.
573 ResultCode
BrokerServicesBase::InstallAppContainer(const wchar_t* sid
,
574 const wchar_t* name
) {
575 if (base::win::OSInfo::GetInstance()->version() < base::win::VERSION_WIN8
)
576 return SBOX_ERROR_UNSUPPORTED
;
578 base::string16 old_name
= LookupAppContainer(sid
);
579 if (old_name
.empty())
580 return CreateAppContainer(sid
, name
);
582 if (old_name
!= name
)
583 return SBOX_ERROR_INVALID_APP_CONTAINER
;
588 ResultCode
BrokerServicesBase::UninstallAppContainer(const wchar_t* sid
) {
589 if (base::win::OSInfo::GetInstance()->version() < base::win::VERSION_WIN8
)
590 return SBOX_ERROR_UNSUPPORTED
;
592 base::string16 name
= LookupAppContainer(sid
);
594 return SBOX_ERROR_INVALID_APP_CONTAINER
;
596 return DeleteAppContainer(sid
);
599 } // namespace sandbox