ppapi/proxy/interface_list.cc

   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 #include "ppapi/proxy/interface_list.h"
   6
   7 #include "base/hash.h"
   8 #include "base/lazy_instance.h"
   9 #include "base/memory/singleton.h"
  10 #include "ppapi/c/dev/ppb_alarms_dev.h"
  11 #include "ppapi/c/dev/ppb_audio_input_dev.h"
  12 #include "ppapi/c/dev/ppb_buffer_dev.h"
  13 #include "ppapi/c/dev/ppb_char_set_dev.h"
  14 #include "ppapi/c/dev/ppb_crypto_dev.h"
  15 #include "ppapi/c/dev/ppb_cursor_control_dev.h"
  16 #include "ppapi/c/dev/ppb_device_ref_dev.h"
  17 #include "ppapi/c/dev/ppb_find_dev.h"
  18 #include "ppapi/c/dev/ppb_font_dev.h"
  19 #include "ppapi/c/dev/ppb_gles_chromium_texture_mapping_dev.h"
  20 #include "ppapi/c/dev/ppb_graphics_2d_dev.h"
  21 #include "ppapi/c/dev/ppb_ime_input_event_dev.h"
  22 #include "ppapi/c/dev/ppb_memory_dev.h"
  23 #include "ppapi/c/dev/ppb_opengles2ext_dev.h"
  24 #include "ppapi/c/dev/ppb_printing_dev.h"
  25 #include "ppapi/c/dev/ppb_scrollbar_dev.h"
  26 #include "ppapi/c/dev/ppb_text_input_dev.h"
  27 #include "ppapi/c/dev/ppb_trace_event_dev.h"
  28 #include "ppapi/c/dev/ppb_truetype_font_dev.h"
  29 #include "ppapi/c/dev/ppb_url_util_dev.h"
  30 #include "ppapi/c/dev/ppb_var_deprecated.h"
  31 #include "ppapi/c/dev/ppb_video_capture_dev.h"
  32 #include "ppapi/c/dev/ppb_view_dev.h"
  33 #include "ppapi/c/dev/ppb_widget_dev.h"
  34 #include "ppapi/c/dev/ppb_zoom_dev.h"
  35 #include "ppapi/c/extensions/dev/ppb_ext_socket_dev.h"
  36 #include "ppapi/c/ppb_audio.h"
  37 #include "ppapi/c/ppb_audio_buffer.h"
  38 #include "ppapi/c/ppb_audio_config.h"
  39 #include "ppapi/c/ppb_console.h"
  40 #include "ppapi/c/ppb_core.h"
  41 #include "ppapi/c/ppb_file_io.h"
  42 #include "ppapi/c/ppb_file_mapping.h"
  43 #include "ppapi/c/ppb_file_ref.h"
  44 #include "ppapi/c/ppb_file_system.h"
  45 #include "ppapi/c/ppb_fullscreen.h"
  46 #include "ppapi/c/ppb_graphics_2d.h"
  47 #include "ppapi/c/ppb_host_resolver.h"
  48 #include "ppapi/c/ppb_image_data.h"
  49 #include "ppapi/c/ppb_input_event.h"
  50 #include "ppapi/c/ppb_instance.h"
  51 #include "ppapi/c/ppb_media_stream_audio_track.h"
  52 #include "ppapi/c/ppb_media_stream_video_track.h"
  53 #include "ppapi/c/ppb_message_loop.h"
  54 #include "ppapi/c/ppb_messaging.h"
  55 #include "ppapi/c/ppb_mouse_lock.h"
  56 #include "ppapi/c/ppb_net_address.h"
  57 #include "ppapi/c/ppb_network_list.h"
  58 #include "ppapi/c/ppb_network_monitor.h"
  59 #include "ppapi/c/ppb_network_proxy.h"
  60 #include "ppapi/c/ppb_opengles2.h"
  61 #include "ppapi/c/ppb_tcp_socket.h"
  62 #include "ppapi/c/ppb_text_input_controller.h"
  63 #include "ppapi/c/ppb_udp_socket.h"
  64 #include "ppapi/c/ppb_url_loader.h"
  65 #include "ppapi/c/ppb_url_request_info.h"
  66 #include "ppapi/c/ppb_url_response_info.h"
  67 #include "ppapi/c/ppb_var.h"
  68 #include "ppapi/c/ppb_var_array.h"
  69 #include "ppapi/c/ppb_var_array_buffer.h"
  70 #include "ppapi/c/ppb_var_dictionary.h"
  71 #include "ppapi/c/ppb_video_frame.h"
  72 #include "ppapi/c/ppb_view.h"
  73 #include "ppapi/c/pp_errors.h"
  74 #include "ppapi/c/ppp_instance.h"
  75 #include "ppapi/c/private/ppb_content_decryptor_private.h"
  76 #include "ppapi/c/private/ppb_ext_crx_file_system_private.h"
  77 #include "ppapi/c/private/ppb_file_io_private.h"
  78 #include "ppapi/c/private/ppb_file_ref_private.h"
  79 #include "ppapi/c/private/ppb_flash_clipboard.h"
  80 #include "ppapi/c/private/ppb_flash_file.h"
  81 #include "ppapi/c/private/ppb_flash_font_file.h"
  82 #include "ppapi/c/private/ppb_flash_fullscreen.h"
  83 #include "ppapi/c/private/ppb_flash.h"
  84 #include "ppapi/c/private/ppb_flash_device_id.h"
  85 #include "ppapi/c/private/ppb_flash_drm.h"
  86 #include "ppapi/c/private/ppb_flash_menu.h"
  87 #include "ppapi/c/private/ppb_flash_message_loop.h"
  88 #include "ppapi/c/private/ppb_flash_print.h"
  89 #include "ppapi/c/private/ppb_host_resolver_private.h"
  90 #include "ppapi/c/private/ppb_isolated_file_system_private.h"
  91 #include "ppapi/c/private/ppb_net_address_private.h"
  92 #include "ppapi/c/private/ppb_output_protection_private.h"
  93 #include "ppapi/c/private/ppb_pdf.h"
  94 #include "ppapi/c/private/ppb_platform_verification_private.h"
  95 #include "ppapi/c/private/ppb_talk_private.h"
  96 #include "ppapi/c/private/ppb_tcp_server_socket_private.h"
  97 #include "ppapi/c/private/ppb_tcp_socket_private.h"
  98 #include "ppapi/c/private/ppb_testing_private.h"
  99 #include "ppapi/c/private/ppb_udp_socket_private.h"
 100 #include "ppapi/c/private/ppb_uma_private.h"
 101 #include "ppapi/c/private/ppb_video_destination_private.h"
 102 #include "ppapi/c/private/ppb_video_source_private.h"
 103 #include "ppapi/c/private/ppb_x509_certificate_private.h"
 104 #include "ppapi/c/private/ppp_content_decryptor_private.h"
 105 #include "ppapi/c/trusted/ppb_broker_trusted.h"
 106 #include "ppapi/c/trusted/ppb_browser_font_trusted.h"
 107 #include "ppapi/c/trusted/ppb_char_set_trusted.h"
 108 #include "ppapi/c/trusted/ppb_file_chooser_trusted.h"
 109 #include "ppapi/c/trusted/ppb_url_loader_trusted.h"
 110 #include "ppapi/proxy/interface_proxy.h"
 111 #include "ppapi/proxy/plugin_globals.h"
 112 #include "ppapi/proxy/ppapi_messages.h"
 113 #include "ppapi/proxy/ppb_audio_proxy.h"
 114 #include "ppapi/proxy/ppb_broker_proxy.h"
 115 #include "ppapi/proxy/ppb_buffer_proxy.h"
 116 #include "ppapi/proxy/ppb_core_proxy.h"
 117 #include "ppapi/proxy/ppb_flash_message_loop_proxy.h"
 118 #include "ppapi/proxy/ppb_graphics_3d_proxy.h"
 119 #include "ppapi/proxy/ppb_image_data_proxy.h"
 120 #include "ppapi/proxy/ppb_instance_proxy.h"
 121 #include "ppapi/proxy/ppb_message_loop_proxy.h"
 122 #include "ppapi/proxy/ppb_testing_proxy.h"
 123 #include "ppapi/proxy/ppb_var_deprecated_proxy.h"
 124 #include "ppapi/proxy/ppb_video_decoder_proxy.h"
 125 #include "ppapi/proxy/ppb_x509_certificate_private_proxy.h"
 126 #include "ppapi/proxy/ppp_class_proxy.h"
 127 #include "ppapi/proxy/ppp_content_decryptor_private_proxy.h"
 128 #include "ppapi/proxy/ppp_graphics_3d_proxy.h"
 129 #include "ppapi/proxy/ppp_input_event_proxy.h"
 130 #include "ppapi/proxy/ppp_instance_private_proxy.h"
 131 #include "ppapi/proxy/ppp_instance_proxy.h"
 132 #include "ppapi/proxy/ppp_messaging_proxy.h"
 133 #include "ppapi/proxy/ppp_mouse_lock_proxy.h"
 134 #include "ppapi/proxy/ppp_pdf_proxy.h"
 135 #include "ppapi/proxy/ppp_printing_proxy.h"
 136 #include "ppapi/proxy/ppp_text_input_proxy.h"
 137 #include "ppapi/proxy/ppp_video_decoder_proxy.h"
 138 #include "ppapi/proxy/resource_creation_proxy.h"
 139 #include "ppapi/shared_impl/ppb_opengles2_shared.h"
 140 #include "ppapi/shared_impl/ppb_var_shared.h"
 141 #include "ppapi/thunk/thunk.h"
 142
 143 // Helper to get the proxy name PPB_Foo_Proxy given the API name PPB_Foo.
 144 #define PROXY_CLASS_NAME(api_name) api_name##_Proxy
 145
 146 // Helper to get the interface ID PPB_Foo_Proxy::kApiID given the API
 147 // name PPB_Foo.
 148 #define PROXY_API_ID(api_name) PROXY_CLASS_NAME(api_name)::kApiID
 149
 150 // Helper to get the name of the templatized factory function.
 151 #define PROXY_FACTORY_NAME(api_name) ProxyFactory<PROXY_CLASS_NAME(api_name)>
 152
 153 // Helper to get the name of the thunk GetPPB_Foo_1_0_Thunk given the interface
 154 // struct name PPB_Foo_1_0.
 155 #define INTERFACE_THUNK_NAME(iface_struct) thunk::Get##iface_struct##_Thunk
 156
 157 namespace ppapi {
 158 namespace proxy {
 159
 160 namespace {
 161
 162 template<typename ProxyClass>
 163 InterfaceProxy* ProxyFactory(Dispatcher* dispatcher) {
 164   return new ProxyClass(dispatcher);
 165 }
 166
 167 base::LazyInstance<PpapiPermissions> g_process_global_permissions;
 168
 169 }  // namespace
 170
 171 InterfaceList::InterfaceList() {
 172   memset(id_to_factory_, 0, sizeof(id_to_factory_));
 173
 174   // Register the API factories for each of the API types. This calls AddProxy
 175   // for each InterfaceProxy type we support.
 176   #define PROXIED_API(api_name) \
 177       AddProxy(PROXY_API_ID(api_name), &PROXY_FACTORY_NAME(api_name));
 178
 179   // Register each proxied interface by calling AddPPB for each supported
 180   // interface. Set current_required_permission to the appropriate value for
 181   // the value you want expanded by this macro.
 182   #define PROXIED_IFACE(iface_str, iface_struct) \
 183       AddPPB(iface_str, \
 184              INTERFACE_THUNK_NAME(iface_struct)(), \
 185              current_required_permission);
 186
 187   {
 188     Permission current_required_permission = PERMISSION_NONE;
 189     #include "ppapi/thunk/interfaces_ppb_private_no_permissions.h"
 190     #include "ppapi/thunk/interfaces_ppb_public_stable.h"
 191   }
 192   {
 193     Permission current_required_permission = PERMISSION_DEV;
 194     #include "ppapi/thunk/interfaces_ppb_public_dev.h"
 195   }
 196   {
 197     Permission current_required_permission = PERMISSION_PRIVATE;
 198     #include "ppapi/thunk/interfaces_ppb_private.h"
 199   }
 200   {
 201 #if !defined(OS_NACL)
 202     Permission current_required_permission = PERMISSION_FLASH;
 203     #include "ppapi/thunk/interfaces_ppb_private_flash.h"
 204 #endif  // !defined(OS_NACL)
 205   }
 206   {
 207     Permission current_required_permission = PERMISSION_DEV_CHANNEL;
 208     #include "ppapi/thunk/interfaces_ppb_public_dev_channel.h"
 209   }
 210
 211   #undef PROXIED_API
 212   #undef PROXIED_IFACE
 213
 214   // Manually add some special proxies. Some of these don't have interfaces
 215   // that they support, so aren't covered by the macros above, but have proxies
 216   // for message routing. Others have different implementations between the
 217   // proxy and the impl and there's no obvious message routing.
 218   AddProxy(API_ID_RESOURCE_CREATION, &ResourceCreationProxy::Create);
 219   AddProxy(API_ID_PPP_CLASS, &PPP_Class_Proxy::Create);
 220   AddPPB(PPB_CORE_INTERFACE_1_0,
 221          PPB_Core_Proxy::GetPPB_Core_Interface(), PERMISSION_NONE);
 222   AddPPB(PPB_MESSAGELOOP_INTERFACE_1_0,
 223          PPB_MessageLoop_Proxy::GetInterface(), PERMISSION_NONE);
 224   AddPPB(PPB_OPENGLES2_INTERFACE_1_0,
 225          PPB_OpenGLES2_Shared::GetInterface(), PERMISSION_NONE);
 226   AddPPB(PPB_OPENGLES2_INSTANCEDARRAYS_INTERFACE_1_0,
 227          PPB_OpenGLES2_Shared::GetInstancedArraysInterface(), PERMISSION_NONE);
 228   AddPPB(PPB_OPENGLES2_FRAMEBUFFERBLIT_INTERFACE_1_0,
 229          PPB_OpenGLES2_Shared::GetFramebufferBlitInterface(), PERMISSION_NONE);
 230   AddPPB(PPB_OPENGLES2_FRAMEBUFFERMULTISAMPLE_INTERFACE_1_0,
 231          PPB_OpenGLES2_Shared::GetFramebufferMultisampleInterface(),
 232          PERMISSION_NONE);
 233   AddPPB(PPB_OPENGLES2_CHROMIUMENABLEFEATURE_INTERFACE_1_0,
 234          PPB_OpenGLES2_Shared::GetChromiumEnableFeatureInterface(),
 235          PERMISSION_NONE);
 236   AddPPB(PPB_OPENGLES2_CHROMIUMMAPSUB_INTERFACE_1_0,
 237          PPB_OpenGLES2_Shared::GetChromiumMapSubInterface(), PERMISSION_NONE);
 238   AddPPB(PPB_OPENGLES2_CHROMIUMMAPSUB_DEV_INTERFACE_1_0,
 239          PPB_OpenGLES2_Shared::GetChromiumMapSubInterface(), PERMISSION_NONE);
 240   AddPPB(PPB_OPENGLES2_QUERY_INTERFACE_1_0,
 241          PPB_OpenGLES2_Shared::GetQueryInterface(), PERMISSION_NONE);
 242   AddPPB(PPB_OPENGLES2_DRAWBUFFERS_DEV_INTERFACE_1_0,
 243          PPB_OpenGLES2_Shared::GetDrawBuffersInterface(),
 244          PERMISSION_DEV);
 245   AddPPB(PPB_VAR_ARRAY_BUFFER_INTERFACE_1_0,
 246          PPB_Var_Shared::GetVarArrayBufferInterface1_0(),
 247          PERMISSION_NONE);
 248   AddPPB(PPB_VAR_INTERFACE_1_2,
 249          PPB_Var_Shared::GetVarInterface1_2(), PERMISSION_NONE);
 250   AddPPB(PPB_VAR_INTERFACE_1_1,
 251          PPB_Var_Shared::GetVarInterface1_1(), PERMISSION_NONE);
 252   AddPPB(PPB_VAR_INTERFACE_1_0,
 253          PPB_Var_Shared::GetVarInterface1_0(), PERMISSION_NONE);
 254
 255 #if !defined(OS_NACL)
 256   // PPB (browser) interfaces.
 257   // Do not add more stuff here, they should be added to interface_list*.h
 258   // TODO(brettw) remove these.
 259   AddProxy(API_ID_PPB_INSTANCE_PRIVATE, &ProxyFactory<PPB_Instance_Proxy>);
 260   AddPPB(PPB_INSTANCE_PRIVATE_INTERFACE_0_1,
 261          thunk::GetPPB_Instance_Private_0_1_Thunk(),
 262          PERMISSION_PRIVATE);
 263
 264   AddProxy(API_ID_PPB_VAR_DEPRECATED, &ProxyFactory<PPB_Var_Deprecated_Proxy>);
 265   AddPPB(PPB_VAR_DEPRECATED_INTERFACE,
 266          PPB_Var_Deprecated_Proxy::GetProxyInterface(), PERMISSION_DEV);
 267
 268   // TODO(tomfinegan): Figure out where to put these once we refactor things
 269   // to load the PPP interface struct from the PPB interface.
 270   AddProxy(API_ID_PPP_CONTENT_DECRYPTOR_PRIVATE,
 271            &ProxyFactory<PPP_ContentDecryptor_Private_Proxy>);
 272   AddPPP(PPP_CONTENTDECRYPTOR_PRIVATE_INTERFACE,
 273          PPP_ContentDecryptor_Private_Proxy::GetProxyInterface());
 274 #endif
 275   AddProxy(API_ID_PPB_TESTING, &ProxyFactory<PPB_Testing_Proxy>);
 276   AddPPB(PPB_TESTING_PRIVATE_INTERFACE,
 277          PPB_Testing_Proxy::GetProxyInterface(), PERMISSION_TESTING);
 278
 279   // PPP (plugin) interfaces.
 280   // TODO(brettw) move these to interface_list*.h
 281   AddProxy(API_ID_PPP_GRAPHICS_3D, &ProxyFactory<PPP_Graphics3D_Proxy>);
 282   AddPPP(PPP_GRAPHICS_3D_INTERFACE, PPP_Graphics3D_Proxy::GetProxyInterface());
 283   AddProxy(API_ID_PPP_INPUT_EVENT, &ProxyFactory<PPP_InputEvent_Proxy>);
 284   AddPPP(PPP_INPUT_EVENT_INTERFACE, PPP_InputEvent_Proxy::GetProxyInterface());
 285   AddProxy(API_ID_PPP_INSTANCE, &ProxyFactory<PPP_Instance_Proxy>);
 286 #if !defined(OS_NACL)
 287   AddPPP(PPP_INSTANCE_INTERFACE_1_1,
 288          PPP_Instance_Proxy::GetInstanceInterface());
 289   AddProxy(API_ID_PPP_INSTANCE_PRIVATE,
 290            &ProxyFactory<PPP_Instance_Private_Proxy>);
 291   AddPPP(PPP_INSTANCE_PRIVATE_INTERFACE,
 292          PPP_Instance_Private_Proxy::GetProxyInterface());
 293 #endif
 294   AddProxy(API_ID_PPP_MESSAGING, &ProxyFactory<PPP_Messaging_Proxy>);
 295   AddPPP(PPP_MESSAGING_INTERFACE, PPP_Messaging_Proxy::GetProxyInterface());
 296   AddProxy(API_ID_PPP_MOUSE_LOCK, &ProxyFactory<PPP_MouseLock_Proxy>);
 297   AddPPP(PPP_MOUSELOCK_INTERFACE, PPP_MouseLock_Proxy::GetProxyInterface());
 298   AddProxy(API_ID_PPP_PRINTING, &ProxyFactory<PPP_Printing_Proxy>);
 299   AddPPP(PPP_PRINTING_DEV_INTERFACE, PPP_Printing_Proxy::GetProxyInterface());
 300   AddProxy(API_ID_PPP_TEXT_INPUT, &ProxyFactory<PPP_TextInput_Proxy>);
 301   AddPPP(PPP_TEXTINPUT_DEV_INTERFACE, PPP_TextInput_Proxy::GetProxyInterface());
 302   AddProxy(API_ID_PPP_PDF, &ProxyFactory<PPP_Pdf_Proxy>);
 303   AddPPP(PPP_PDF_INTERFACE, PPP_Pdf_Proxy::GetProxyInterface());
 304 #if !defined(OS_NACL)
 305   AddProxy(API_ID_PPP_VIDEO_DECODER_DEV, &ProxyFactory<PPP_VideoDecoder_Proxy>);
 306   AddPPP(PPP_VIDEODECODER_DEV_INTERFACE,
 307          PPP_VideoDecoder_Proxy::GetProxyInterface());
 308 #endif
 309 }
 310
 311 InterfaceList::~InterfaceList() {
 312 }
 313
 314 // static
 315 InterfaceList* InterfaceList::GetInstance() {
 316   return Singleton<InterfaceList>::get();
 317 }
 318
 319 // static
 320 void InterfaceList::SetProcessGlobalPermissions(
 321     const PpapiPermissions& permissions) {
 322   g_process_global_permissions.Get() = permissions;
 323 }
 324
 325 InterfaceProxy::Factory InterfaceList::GetFactoryForID(ApiID id) const {
 326   int index = static_cast<int>(id);
 327   COMPILE_ASSERT(API_ID_NONE == 0, none_must_be_zero);
 328   if (id <= 0 || id >= API_ID_COUNT)
 329     return NULL;
 330   return id_to_factory_[index];
 331 }
 332
 333 const void* InterfaceList::GetInterfaceForPPB(const std::string& name) {
 334   NameToInterfaceInfoMap::iterator found =
 335       name_to_browser_info_.find(name);
 336   if (found == name_to_browser_info_.end())
 337     return NULL;
 338
 339   if (g_process_global_permissions.Get().HasPermission(
 340           found->second.required_permission)) {
 341     // Only log interface use once per plugin.
 342     if (!found->second.interface_logged) {
 343       PluginGlobals::Get()->GetBrowserSender()->Send(
 344           new PpapiHostMsg_LogInterfaceUsage(HashInterfaceName(name)));
 345       found->second.interface_logged = true;
 346     }
 347     return found->second.iface;
 348   }
 349   return NULL;
 350 }
 351
 352 const void* InterfaceList::GetInterfaceForPPP(const std::string& name) const {
 353   NameToInterfaceInfoMap::const_iterator found =
 354       name_to_plugin_info_.find(name);
 355   if (found == name_to_plugin_info_.end())
 356     return NULL;
 357   return found->second.iface;
 358 }
 359
 360 void InterfaceList::AddProxy(ApiID id,
 361                              InterfaceProxy::Factory factory) {
 362   // For interfaces with no corresponding _Proxy objects, the macros will
 363   // generate calls to this function with API_ID_NONE. This means we
 364   // should just skip adding a factory for these functions.
 365   if (id == API_ID_NONE)
 366     return;
 367
 368   // The factory should be an exact dupe of the one we already have if it
 369   // has already been registered before.
 370   int index = static_cast<int>(id);
 371   DCHECK(!id_to_factory_[index] || id_to_factory_[index] == factory);
 372
 373   id_to_factory_[index] = factory;
 374 }
 375
 376 void InterfaceList::AddPPB(const char* name,
 377                            const void* iface,
 378                            Permission perm) {
 379   DCHECK(name_to_browser_info_.find(name) == name_to_browser_info_.end());
 380   name_to_browser_info_[name] = InterfaceInfo(iface, perm);
 381 }
 382
 383 void InterfaceList::AddPPP(const char* name,
 384                            const void* iface) {
 385   DCHECK(name_to_plugin_info_.find(name) == name_to_plugin_info_.end());
 386   name_to_plugin_info_[name] = InterfaceInfo(iface, PERMISSION_NONE);
 387 }
 388
 389 // static
 390 int InterfaceList::HashInterfaceName(const std::string& name) {
 391   uint32 data = base::Hash(name.c_str(), name.size());
 392   // Strip off the signed bit because UMA doesn't support negative values,
 393   // but takes a signed int as input.
 394   return static_cast<int>(data & 0x7fffffff);
 395 }
 396
 397 }  // namespace proxy
 398 }  // namespace ppapi