Revert of Add DumpAccessibilityEvents test framework. (patchset #7 id:120001 of https...
[chromium-blink-merge.git] / content / browser / ppapi_plugin_process_host.cc
blob608d6c9fd0378cdcd9e09619977f8d922fd8bf57
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 "content/browser/ppapi_plugin_process_host.h"
7 #include <string>
9 #include "base/base_switches.h"
10 #include "base/command_line.h"
11 #include "base/files/file_path.h"
12 #include "base/metrics/field_trial.h"
13 #include "base/strings/utf_string_conversions.h"
14 #include "content/browser/browser_child_process_host_impl.h"
15 #include "content/browser/plugin_service_impl.h"
16 #include "content/browser/renderer_host/render_message_filter.h"
17 #include "content/common/child_process_host_impl.h"
18 #include "content/common/child_process_messages.h"
19 #include "content/public/browser/content_browser_client.h"
20 #include "content/public/common/content_constants.h"
21 #include "content/public/common/content_switches.h"
22 #include "content/public/common/pepper_plugin_info.h"
23 #include "content/public/common/process_type.h"
24 #include "content/public/common/sandboxed_process_launcher_delegate.h"
25 #include "ipc/ipc_switches.h"
26 #include "net/base/network_change_notifier.h"
27 #include "ppapi/proxy/ppapi_messages.h"
28 #include "ui/base/ui_base_switches.h"
30 #if defined(OS_WIN)
31 #include "content/common/sandbox_win.h"
32 #include "sandbox/win/src/sandbox_policy.h"
33 #endif
35 namespace content {
37 // NOTE: changes to this class need to be reviewed by the security team.
38 class PpapiPluginSandboxedProcessLauncherDelegate
39 : public content::SandboxedProcessLauncherDelegate {
40 public:
41 PpapiPluginSandboxedProcessLauncherDelegate(bool is_broker,
42 const PepperPluginInfo& info,
43 ChildProcessHost* host)
45 #if defined(OS_POSIX)
46 info_(info),
47 ipc_fd_(host->TakeClientFileDescriptor()),
48 #endif // OS_POSIX
49 is_broker_(is_broker) {}
51 ~PpapiPluginSandboxedProcessLauncherDelegate() override {}
53 #if defined(OS_WIN)
54 virtual bool ShouldSandbox() override {
55 return !is_broker_;
58 virtual void PreSpawnTarget(sandbox::TargetPolicy* policy,
59 bool* success) {
60 if (is_broker_)
61 return;
62 // The Pepper process as locked-down as a renderer execpt that it can
63 // create the server side of chrome pipes.
64 sandbox::ResultCode result;
65 result = policy->AddRule(sandbox::TargetPolicy::SUBSYS_NAMED_PIPES,
66 sandbox::TargetPolicy::NAMEDPIPES_ALLOW_ANY,
67 L"\\\\.\\pipe\\chrome.*");
68 *success = (result == sandbox::SBOX_ALL_OK);
71 #elif defined(OS_POSIX)
72 bool ShouldUseZygote() override {
73 const base::CommandLine& browser_command_line =
74 *base::CommandLine::ForCurrentProcess();
75 base::CommandLine::StringType plugin_launcher = browser_command_line
76 .GetSwitchValueNative(switches::kPpapiPluginLauncher);
77 return !is_broker_ && plugin_launcher.empty() && info_.is_sandboxed;
79 base::ScopedFD TakeIpcFd() override { return ipc_fd_.Pass(); }
80 #endif // OS_WIN
82 private:
83 #if defined(OS_POSIX)
84 const PepperPluginInfo& info_;
85 base::ScopedFD ipc_fd_;
86 #endif // OS_POSIX
87 bool is_broker_;
89 DISALLOW_COPY_AND_ASSIGN(PpapiPluginSandboxedProcessLauncherDelegate);
92 class PpapiPluginProcessHost::PluginNetworkObserver
93 : public net::NetworkChangeNotifier::IPAddressObserver,
94 public net::NetworkChangeNotifier::ConnectionTypeObserver {
95 public:
96 explicit PluginNetworkObserver(PpapiPluginProcessHost* process_host)
97 : process_host_(process_host) {
98 net::NetworkChangeNotifier::AddIPAddressObserver(this);
99 net::NetworkChangeNotifier::AddConnectionTypeObserver(this);
102 ~PluginNetworkObserver() override {
103 net::NetworkChangeNotifier::RemoveConnectionTypeObserver(this);
104 net::NetworkChangeNotifier::RemoveIPAddressObserver(this);
107 // IPAddressObserver implementation.
108 void OnIPAddressChanged() override {
109 // TODO(brettw) bug 90246: This doesn't seem correct. The online/offline
110 // notification seems like it should be sufficient, but I don't see that
111 // when I unplug and replug my network cable. Sending this notification when
112 // "something" changes seems to make Flash reasonably happy, but seems
113 // wrong. We should really be able to provide the real online state in
114 // OnConnectionTypeChanged().
115 process_host_->Send(new PpapiMsg_SetNetworkState(true));
118 // ConnectionTypeObserver implementation.
119 void OnConnectionTypeChanged(
120 net::NetworkChangeNotifier::ConnectionType type) override {
121 process_host_->Send(new PpapiMsg_SetNetworkState(
122 type != net::NetworkChangeNotifier::CONNECTION_NONE));
125 private:
126 PpapiPluginProcessHost* const process_host_;
129 PpapiPluginProcessHost::~PpapiPluginProcessHost() {
130 DVLOG(1) << "PpapiPluginProcessHost" << (is_broker_ ? "[broker]" : "")
131 << "~PpapiPluginProcessHost()";
132 CancelRequests();
135 // static
136 PpapiPluginProcessHost* PpapiPluginProcessHost::CreatePluginHost(
137 const PepperPluginInfo& info,
138 const base::FilePath& profile_data_directory) {
139 PpapiPluginProcessHost* plugin_host = new PpapiPluginProcessHost(
140 info, profile_data_directory);
141 DCHECK(plugin_host);
142 if (plugin_host->Init(info))
143 return plugin_host;
145 NOTREACHED(); // Init is not expected to fail.
146 return NULL;
149 // static
150 PpapiPluginProcessHost* PpapiPluginProcessHost::CreateBrokerHost(
151 const PepperPluginInfo& info) {
152 PpapiPluginProcessHost* plugin_host =
153 new PpapiPluginProcessHost();
154 if (plugin_host->Init(info))
155 return plugin_host;
157 NOTREACHED(); // Init is not expected to fail.
158 return NULL;
161 // static
162 void PpapiPluginProcessHost::DidCreateOutOfProcessInstance(
163 int plugin_process_id,
164 int32 pp_instance,
165 const PepperRendererInstanceData& instance_data) {
166 for (PpapiPluginProcessHostIterator iter; !iter.Done(); ++iter) {
167 if (iter->process_.get() &&
168 iter->process_->GetData().id == plugin_process_id) {
169 // Found the plugin.
170 iter->host_impl_->AddInstance(pp_instance, instance_data);
171 return;
174 // We'll see this passed with a 0 process ID for the browser tag stuff that
175 // is currently in the process of being removed.
177 // TODO(brettw) When old browser tag impl is removed
178 // (PepperPluginDelegateImpl::CreateBrowserPluginModule passes a 0 plugin
179 // process ID) this should be converted to a NOTREACHED().
180 DCHECK(plugin_process_id == 0)
181 << "Renderer sent a bad plugin process host ID";
184 // static
185 void PpapiPluginProcessHost::DidDeleteOutOfProcessInstance(
186 int plugin_process_id,
187 int32 pp_instance) {
188 for (PpapiPluginProcessHostIterator iter; !iter.Done(); ++iter) {
189 if (iter->process_.get() &&
190 iter->process_->GetData().id == plugin_process_id) {
191 // Found the plugin.
192 iter->host_impl_->DeleteInstance(pp_instance);
193 return;
196 // Note: It's possible that the plugin process has already been deleted by
197 // the time this message is received. For example, it could have crashed.
198 // That's OK, we can just ignore this message.
201 // static
202 void PpapiPluginProcessHost::FindByName(
203 const base::string16& name,
204 std::vector<PpapiPluginProcessHost*>* hosts) {
205 for (PpapiPluginProcessHostIterator iter; !iter.Done(); ++iter) {
206 if (iter->process_.get() && iter->process_->GetData().name == name)
207 hosts->push_back(*iter);
211 bool PpapiPluginProcessHost::Send(IPC::Message* message) {
212 return process_->Send(message);
215 void PpapiPluginProcessHost::OpenChannelToPlugin(Client* client) {
216 if (process_->GetHost()->IsChannelOpening()) {
217 // The channel is already in the process of being opened. Put
218 // this "open channel" request into a queue of requests that will
219 // be run once the channel is open.
220 pending_requests_.push_back(client);
221 return;
224 // We already have an open channel, send a request right away to plugin.
225 RequestPluginChannel(client);
228 PpapiPluginProcessHost::PpapiPluginProcessHost(
229 const PepperPluginInfo& info,
230 const base::FilePath& profile_data_directory)
231 : profile_data_directory_(profile_data_directory),
232 is_broker_(false) {
233 uint32 base_permissions = info.permissions;
235 // We don't have to do any whitelisting for APIs in this process host, so
236 // don't bother passing a browser context or document url here.
237 if (GetContentClient()->browser()->IsPluginAllowedToUseDevChannelAPIs(
238 NULL, GURL()))
239 base_permissions |= ppapi::PERMISSION_DEV_CHANNEL;
240 permissions_ = ppapi::PpapiPermissions::GetForCommandLine(base_permissions);
242 process_.reset(new BrowserChildProcessHostImpl(
243 PROCESS_TYPE_PPAPI_PLUGIN, this));
245 host_impl_.reset(new BrowserPpapiHostImpl(this, permissions_, info.name,
246 info.path, profile_data_directory,
247 false /* in_process */,
248 false /* external_plugin */));
250 filter_ = new PepperMessageFilter();
251 process_->AddFilter(filter_.get());
252 process_->GetHost()->AddFilter(host_impl_->message_filter().get());
254 GetContentClient()->browser()->DidCreatePpapiPlugin(host_impl_.get());
256 // Only request network status updates if the plugin has dev permissions.
257 if (permissions_.HasPermission(ppapi::PERMISSION_DEV))
258 network_observer_.reset(new PluginNetworkObserver(this));
261 PpapiPluginProcessHost::PpapiPluginProcessHost()
262 : is_broker_(true) {
263 process_.reset(new BrowserChildProcessHostImpl(
264 PROCESS_TYPE_PPAPI_BROKER, this));
266 ppapi::PpapiPermissions permissions; // No permissions.
267 // The plugin name, path and profile data directory shouldn't be needed for
268 // the broker.
269 host_impl_.reset(new BrowserPpapiHostImpl(this, permissions,
270 std::string(), base::FilePath(),
271 base::FilePath(),
272 false /* in_process */,
273 false /* external_plugin */));
276 bool PpapiPluginProcessHost::Init(const PepperPluginInfo& info) {
277 plugin_path_ = info.path;
278 if (info.name.empty()) {
279 process_->SetName(plugin_path_.BaseName().LossyDisplayName());
280 } else {
281 process_->SetName(base::UTF8ToUTF16(info.name));
284 std::string channel_id = process_->GetHost()->CreateChannel();
285 if (channel_id.empty()) {
286 VLOG(1) << "Could not create pepper host channel.";
287 return false;
290 const base::CommandLine& browser_command_line =
291 *base::CommandLine::ForCurrentProcess();
292 base::CommandLine::StringType plugin_launcher =
293 browser_command_line.GetSwitchValueNative(switches::kPpapiPluginLauncher);
295 #if defined(OS_LINUX)
296 int flags = plugin_launcher.empty() ? ChildProcessHost::CHILD_ALLOW_SELF :
297 ChildProcessHost::CHILD_NORMAL;
298 #else
299 int flags = ChildProcessHost::CHILD_NORMAL;
300 #endif
301 base::FilePath exe_path = ChildProcessHost::GetChildPath(flags);
302 if (exe_path.empty()) {
303 VLOG(1) << "Pepper plugin exe path is empty.";
304 return false;
307 base::CommandLine* cmd_line = new base::CommandLine(exe_path);
308 cmd_line->AppendSwitchASCII(switches::kProcessType,
309 is_broker_ ? switches::kPpapiBrokerProcess
310 : switches::kPpapiPluginProcess);
311 cmd_line->AppendSwitchASCII(switches::kProcessChannelID, channel_id);
313 // These switches are forwarded to both plugin and broker pocesses.
314 static const char* kCommonForwardSwitches[] = {
315 switches::kVModule
317 cmd_line->CopySwitchesFrom(browser_command_line, kCommonForwardSwitches,
318 arraysize(kCommonForwardSwitches));
320 if (!is_broker_) {
321 static const char* kPluginForwardSwitches[] = {
322 switches::kDisableSeccompFilterSandbox,
323 #if defined(OS_MACOSX)
324 switches::kEnableSandboxLogging,
325 #endif
326 switches::kNoSandbox,
327 switches::kPpapiStartupDialog,
329 cmd_line->CopySwitchesFrom(browser_command_line, kPluginForwardSwitches,
330 arraysize(kPluginForwardSwitches));
332 // Copy any flash args over and introduce field trials if necessary.
333 // TODO(vtl): Stop passing flash args in the command line, or windows is
334 // going to explode.
335 std::string field_trial =
336 base::FieldTrialList::FindFullName(kFlashHwVideoDecodeFieldTrialName);
337 std::string existing_args =
338 browser_command_line.GetSwitchValueASCII(switches::kPpapiFlashArgs);
339 if (field_trial == kFlashHwVideoDecodeFieldTrialEnabledName) {
340 // Arguments passed to Flash are comma delimited.
341 if (!existing_args.empty())
342 existing_args.append(",");
343 existing_args.append("enable_hw_video_decode=1");
344 #if defined(OS_MACOSX)
345 // TODO(ihf): Remove this once Flash newer than 15.0.0.223 is released.
346 existing_args.append(",enable_hw_video_decode_mac=1");
347 #endif
349 cmd_line->AppendSwitchASCII(switches::kPpapiFlashArgs, existing_args);
352 std::string locale = GetContentClient()->browser()->GetApplicationLocale();
353 if (!locale.empty()) {
354 // Pass on the locale so the plugin will know what language we're using.
355 cmd_line->AppendSwitchASCII(switches::kLang, locale);
358 if (!plugin_launcher.empty())
359 cmd_line->PrependWrapper(plugin_launcher);
361 // On posix, never use the zygote for the broker. Also, only use the zygote if
362 // the plugin is sandboxed, and we are not using a plugin launcher - having a
363 // plugin launcher means we need to use another process instead of just
364 // forking the zygote.
365 #if defined(OS_POSIX)
366 if (!info.is_sandboxed)
367 cmd_line->AppendSwitchASCII(switches::kNoSandbox, std::string());
368 #endif // OS_POSIX
369 process_->Launch(
370 new PpapiPluginSandboxedProcessLauncherDelegate(is_broker_,
371 info,
372 process_->GetHost()),
373 cmd_line);
374 return true;
377 void PpapiPluginProcessHost::RequestPluginChannel(Client* client) {
378 base::ProcessHandle process_handle;
379 int renderer_child_id;
380 client->GetPpapiChannelInfo(&process_handle, &renderer_child_id);
382 base::ProcessId process_id = (process_handle == base::kNullProcessHandle) ?
383 0 : base::GetProcId(process_handle);
385 // We can't send any sync messages from the browser because it might lead to
386 // a hang. See the similar code in PluginProcessHost for more description.
387 PpapiMsg_CreateChannel* msg = new PpapiMsg_CreateChannel(
388 process_id, renderer_child_id, client->OffTheRecord());
389 msg->set_unblock(true);
390 if (Send(msg)) {
391 sent_requests_.push(client);
392 } else {
393 client->OnPpapiChannelOpened(IPC::ChannelHandle(), base::kNullProcessId, 0);
397 void PpapiPluginProcessHost::OnProcessLaunched() {
398 VLOG(2) << "ppapi plugin process launched.";
399 host_impl_->set_plugin_process(process_->GetProcess().Duplicate());
402 void PpapiPluginProcessHost::OnProcessCrashed(int exit_code) {
403 VLOG(1) << "ppapi plugin process crashed.";
404 PluginServiceImpl::GetInstance()->RegisterPluginCrash(plugin_path_);
407 bool PpapiPluginProcessHost::OnMessageReceived(const IPC::Message& msg) {
408 bool handled = true;
409 IPC_BEGIN_MESSAGE_MAP(PpapiPluginProcessHost, msg)
410 IPC_MESSAGE_HANDLER(PpapiHostMsg_ChannelCreated,
411 OnRendererPluginChannelCreated)
412 IPC_MESSAGE_UNHANDLED(handled = false)
413 IPC_END_MESSAGE_MAP()
414 DCHECK(handled);
415 return handled;
418 // Called when the browser <--> plugin channel has been established.
419 void PpapiPluginProcessHost::OnChannelConnected(int32 peer_pid) {
420 // This will actually load the plugin. Errors will actually not be reported
421 // back at this point. Instead, the plugin will fail to establish the
422 // connections when we request them on behalf of the renderer(s).
423 Send(new PpapiMsg_LoadPlugin(plugin_path_, permissions_));
425 // Process all pending channel requests from the renderers.
426 for (size_t i = 0; i < pending_requests_.size(); i++)
427 RequestPluginChannel(pending_requests_[i]);
428 pending_requests_.clear();
431 // Called when the browser <--> plugin channel has an error. This normally
432 // means the plugin has crashed.
433 void PpapiPluginProcessHost::OnChannelError() {
434 VLOG(1) << "PpapiPluginProcessHost" << (is_broker_ ? "[broker]" : "")
435 << "::OnChannelError()";
436 // We don't need to notify the renderers that were communicating with the
437 // plugin since they have their own channels which will go into the error
438 // state at the same time. Instead, we just need to notify any renderers
439 // that have requested a connection but have not yet received one.
440 CancelRequests();
443 void PpapiPluginProcessHost::CancelRequests() {
444 DVLOG(1) << "PpapiPluginProcessHost" << (is_broker_ ? "[broker]" : "")
445 << "CancelRequests()";
446 for (size_t i = 0; i < pending_requests_.size(); i++) {
447 pending_requests_[i]->OnPpapiChannelOpened(IPC::ChannelHandle(),
448 base::kNullProcessId, 0);
450 pending_requests_.clear();
452 while (!sent_requests_.empty()) {
453 sent_requests_.front()->OnPpapiChannelOpened(IPC::ChannelHandle(),
454 base::kNullProcessId, 0);
455 sent_requests_.pop();
459 // Called when a new plugin <--> renderer channel has been created.
460 void PpapiPluginProcessHost::OnRendererPluginChannelCreated(
461 const IPC::ChannelHandle& channel_handle) {
462 if (sent_requests_.empty())
463 return;
465 // All requests should be processed FIFO, so the next item in the
466 // sent_requests_ queue should be the one that the plugin just created.
467 Client* client = sent_requests_.front();
468 sent_requests_.pop();
470 const ChildProcessData& data = process_->GetData();
471 client->OnPpapiChannelOpened(channel_handle, base::GetProcId(data.handle),
472 data.id);
475 } // namespace content