chrome/renderer/content_settings_observer.h

   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 #ifndef CHROME_RENDERER_CONTENT_SETTINGS_OBSERVER_H_
   6 #define CHROME_RENDERER_CONTENT_SETTINGS_OBSERVER_H_
   7
   8 #include <map>
   9 #include <set>
  10
  11 #include "chrome/common/content_settings.h"
  12 #include "content/public/renderer/render_frame_observer.h"
  13 #include "content/public/renderer/render_frame_observer_tracker.h"
  14 #include "extensions/common/permissions/api_permission.h"
  15 #include "third_party/WebKit/public/web/WebPermissionClient.h"
  16
  17 class GURL;
  18
  19 namespace blink {
  20 class WebFrame;
  21 class WebSecurityOrigin;
  22 class WebURL;
  23 }
  24
  25 namespace extensions {
  26 class Dispatcher;
  27 class Extension;
  28 }
  29
  30 // Handles blocking content per content settings for each RenderFrame.
  31 class ContentSettingsObserver
  32     : public content::RenderFrameObserver,
  33       public content::RenderFrameObserverTracker<ContentSettingsObserver>,
  34       public blink::WebPermissionClient {
  35  public:
  36   ContentSettingsObserver(content::RenderFrame* render_frame,
  37                           extensions::Dispatcher* extension_dispatcher);
  38   virtual ~ContentSettingsObserver();
  39
  40   // Sets the content setting rules which back |AllowImage()|, |AllowScript()|,
  41   // and |AllowScriptFromSource()|. |content_setting_rules| must outlive this
  42   // |ContentSettingsObserver|.
  43   void SetContentSettingRules(
  44       const RendererContentSettingRules* content_setting_rules);
  45
  46   bool IsPluginTemporarilyAllowed(const std::string& identifier);
  47
  48   // Sends an IPC notification that the specified content type was blocked.
  49   void DidBlockContentType(ContentSettingsType settings_type);
  50
  51   // blink::WebPermissionClient implementation.
  52   virtual bool allowDatabase(blink::WebFrame* frame,
  53                              const blink::WebString& name,
  54                              const blink::WebString& display_name,
  55                              unsigned long estimated_size);
  56   virtual bool allowFileSystem(blink::WebFrame* frame);
  57   virtual bool allowImage(blink::WebFrame* frame,
  58                           bool enabled_per_settings,
  59                           const blink::WebURL& image_url);
  60   virtual bool allowIndexedDB(blink::WebFrame* frame,
  61                               const blink::WebString& name,
  62                               const blink::WebSecurityOrigin& origin);
  63   virtual bool allowPlugins(blink::WebFrame* frame,
  64                             bool enabled_per_settings);
  65   virtual bool allowScript(blink::WebFrame* frame,
  66                            bool enabled_per_settings);
  67   virtual bool allowScriptFromSource(blink::WebFrame* frame,
  68                                      bool enabled_per_settings,
  69                                      const blink::WebURL& script_url);
  70   virtual bool allowStorage(blink::WebFrame* frame, bool local);
  71   virtual bool allowReadFromClipboard(blink::WebFrame* frame,
  72                                       bool default_value);
  73   virtual bool allowWriteToClipboard(blink::WebFrame* frame,
  74                                      bool default_value);
  75   virtual bool allowWebComponents(blink::WebFrame* frame, bool);
  76   virtual bool allowMutationEvents(blink::WebFrame* frame,
  77                                    bool default_value);
  78   virtual bool allowPushState(blink::WebFrame* frame);
  79   virtual void didNotAllowPlugins(blink::WebFrame* frame);
  80   virtual void didNotAllowScript(blink::WebFrame* frame);
  81   virtual bool allowDisplayingInsecureContent(
  82       blink::WebFrame* frame,
  83       bool allowed_per_settings,
  84       const blink::WebSecurityOrigin& context,
  85       const blink::WebURL& url);
  86   virtual bool allowRunningInsecureContent(
  87       blink::WebFrame* frame,
  88       bool allowed_per_settings,
  89       const blink::WebSecurityOrigin& context,
  90       const blink::WebURL& url);
  91
  92   // This is used for cases when the NPAPI plugins malfunction if used.
  93   bool AreNPAPIPluginsBlocked() const;
  94
  95  private:
  96   FRIEND_TEST_ALL_PREFIXES(ContentSettingsObserverTest, WhitelistedSchemes);
  97   FRIEND_TEST_ALL_PREFIXES(ChromeRenderViewTest,
  98                            ContentSettingsInterstitialPages);
  99   FRIEND_TEST_ALL_PREFIXES(ChromeRenderViewTest, PluginsTemporarilyAllowed);
 100
 101   // RenderFrameObserver implementation.
 102   virtual bool OnMessageReceived(const IPC::Message& message) OVERRIDE;
 103   virtual void DidCommitProvisionalLoad(bool is_new_navigation) OVERRIDE;
 104
 105   // Message handlers.
 106   void OnLoadBlockedPlugins(const std::string& identifier);
 107   void OnSetAsInterstitial();
 108   void OnNPAPINotSupported();
 109   void OnSetAllowDisplayingInsecureContent(bool allow);
 110   void OnSetAllowRunningInsecureContent(bool allow);
 111   void OnReloadFrame();
 112
 113   // Resets the |content_blocked_| array.
 114   void ClearBlockedContentSettings();
 115
 116   // If |origin| corresponds to an installed extension, returns that extension.
 117   // Otherwise returns NULL.
 118   const extensions::Extension* GetExtension(
 119       const blink::WebSecurityOrigin& origin) const;
 120
 121   // Helpers.
 122   // True if |frame| contains content that is white-listed for content settings.
 123   static bool IsWhitelistedForContentSettings(blink::WebFrame* frame);
 124   static bool IsWhitelistedForContentSettings(
 125       const blink::WebSecurityOrigin& origin,
 126       const GURL& document_url);
 127
 128   // Owned by ChromeContentRendererClient and outlive us.
 129   extensions::Dispatcher* extension_dispatcher_;
 130
 131   // Insecure content may be permitted for the duration of this render view.
 132   bool allow_displaying_insecure_content_;
 133   bool allow_running_insecure_content_;
 134
 135   // A pointer to content setting rules stored by the renderer. Normally, the
 136   // |RendererContentSettingRules| object is owned by
 137   // |ChromeRenderProcessObserver|. In the tests it is owned by the caller of
 138   // |SetContentSettingRules|.
 139   const RendererContentSettingRules* content_setting_rules_;
 140
 141   // Stores if images, scripts, and plugins have actually been blocked.
 142   bool content_blocked_[CONTENT_SETTINGS_NUM_TYPES];
 143
 144   // Caches the result of AllowStorage.
 145   typedef std::pair<GURL, bool> StoragePermissionsKey;
 146   std::map<StoragePermissionsKey, bool> cached_storage_permissions_;
 147
 148   // Caches the result of |AllowScript|.
 149   std::map<blink::WebFrame*, bool> cached_script_permissions_;
 150
 151   std::set<std::string> temporarily_allowed_plugins_;
 152   bool is_interstitial_page_;
 153   bool npapi_plugins_blocked_;
 154
 155   DISALLOW_COPY_AND_ASSIGN(ContentSettingsObserver);
 156 };
 157
 158 #endif  // CHROME_RENDERER_CONTENT_SETTINGS_OBSERVER_H_