toolkit/components/extensions/ExtensionPolicyService.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2; -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #ifndef mozilla_ExtensionPolicyService_h
   7 #define mozilla_ExtensionPolicyService_h
   8
   9 #include "mozilla/MemoryReporting.h"
  10 #include "mozilla/extensions/WebExtensionPolicy.h"
  11 #include "mozIExtensionProcessScript.h"
  12 #include "nsCOMPtr.h"
  13 #include "nsCycleCollectionParticipant.h"
  14 #include "nsHashKeys.h"
  15 #include "nsIAddonPolicyService.h"
  16 #include "nsAtom.h"
  17 #include "nsIMemoryReporter.h"
  18 #include "nsIObserver.h"
  19 #include "nsIObserverService.h"
  20 #include "nsISupports.h"
  21 #include "nsPointerHashKeys.h"
  22 #include "nsRefPtrHashtable.h"
  23 #include "nsTHashSet.h"
  24
  25 class nsIChannel;
  26 class nsIObserverService;
  27
  28 class nsIPIDOMWindowInner;
  29 class nsIPIDOMWindowOuter;
  30
  31 namespace mozilla {
  32 namespace dom {
  33 class Promise;
  34 }  // namespace dom
  35 namespace extensions {
  36 class DocInfo;
  37 class DocumentObserver;
  38 class WebExtensionContentScript;
  39 }  // namespace extensions
  40
  41 using extensions::DocInfo;
  42 using extensions::WebExtensionPolicy;
  43
  44 class ExtensionPolicyService final : public nsIAddonPolicyService,
  45                                      public nsIObserver,
  46                                      public nsIMemoryReporter {
  47  public:
  48   NS_DECL_CYCLE_COLLECTION_CLASS_AMBIGUOUS(ExtensionPolicyService,
  49                                            nsIAddonPolicyService)
  50   NS_DECL_CYCLE_COLLECTING_ISUPPORTS
  51   NS_DECL_NSIADDONPOLICYSERVICE
  52   NS_DECL_NSIOBSERVER
  53   NS_DECL_NSIMEMORYREPORTER
  54
  55   static mozIExtensionProcessScript& ProcessScript();
  56
  57   static ExtensionPolicyService& GetSingleton();
  58
  59   // Heper for fetching an AtomSet of restricted domains as configured by the
  60   // extensions.webextensions.restrictedDomains pref. Safe to call from any
  61   // thread.
  62   static RefPtr<extensions::AtomSet> RestrictedDomains();
  63
  64   static already_AddRefed<ExtensionPolicyService> GetInstance() {
  65     return do_AddRef(&GetSingleton());
  66   }
  67
  68   // Unlike the other methods on the ExtensionPolicyService, this method is
  69   // threadsafe, and can look up a WebExtensionPolicyCore by hostname on any
  70   // thread.
  71   static RefPtr<extensions::WebExtensionPolicyCore> GetCoreByHost(
  72       const nsACString& aHost);
  73
  74   WebExtensionPolicy* GetByID(const nsAtom* aAddonId) {
  75     return mExtensions.GetWeak(aAddonId);
  76   }
  77
  78   WebExtensionPolicy* GetByID(const nsAString& aAddonId) {
  79     RefPtr<nsAtom> atom = NS_AtomizeMainThread(aAddonId);
  80     return GetByID(atom);
  81   }
  82
  83   WebExtensionPolicy* GetByURL(const extensions::URLInfo& aURL);
  84
  85   WebExtensionPolicy* GetByHost(const nsACString& aHost) const;
  86
  87   void GetAll(nsTArray<RefPtr<WebExtensionPolicy>>& aResult);
  88
  89   bool RegisterExtension(WebExtensionPolicy& aPolicy);
  90   bool UnregisterExtension(WebExtensionPolicy& aPolicy);
  91
  92   bool RegisterObserver(extensions::DocumentObserver& aPolicy);
  93   bool UnregisterObserver(extensions::DocumentObserver& aPolicy);
  94
  95   bool UseRemoteExtensions() const;
  96   bool IsExtensionProcess() const;
  97
  98   nsresult InjectContentScripts(WebExtensionPolicy* aExtension);
  99
 100  protected:
 101   virtual ~ExtensionPolicyService();
 102
 103  private:
 104   ExtensionPolicyService();
 105
 106   void RegisterObservers();
 107   void UnregisterObservers();
 108
 109   void CheckRequest(nsIChannel* aChannel);
 110   void CheckDocument(dom::Document* aDocument);
 111
 112   void CheckContentScripts(const DocInfo& aDocInfo, bool aIsPreload);
 113
 114   already_AddRefed<dom::Promise> ExecuteContentScript(
 115       nsPIDOMWindowInner* aWindow,
 116       extensions::WebExtensionContentScript& aScript);
 117
 118   RefPtr<dom::Promise> ExecuteContentScripts(
 119       JSContext* aCx, nsPIDOMWindowInner* aWindow,
 120       const nsTArray<RefPtr<extensions::WebExtensionContentScript>>& aScripts);
 121
 122   void UpdateRestrictedDomains();
 123
 124   nsRefPtrHashtable<nsPtrHashKey<const nsAtom>, WebExtensionPolicy> mExtensions;
 125
 126   nsRefPtrHashtable<nsPtrHashKey<const extensions::DocumentObserver>,
 127                     extensions::DocumentObserver>
 128       mObservers;
 129
 130   nsCOMPtr<nsIObserverService> mObs;
 131
 132   nsString mDefaultCSP;
 133   nsString mDefaultCSPV3;
 134 };
 135
 136 }  // namespace mozilla
 137
 138 #endif  // mozilla_ExtensionPolicyService_h