js/xpconnect/src/BackstagePass.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef BackstagePass_h__
   8 #define BackstagePass_h__
   9
  10 #include "js/loader/ModuleLoaderBase.h"
  11 #include "mozilla/BasePrincipal.h"
  12 #include "mozilla/SchedulerGroup.h"
  13 #include "mozilla/StorageAccess.h"
  14 #include "nsISupports.h"
  15 #include "nsWeakReference.h"
  16 #include "nsIGlobalObject.h"
  17 #include "nsIScriptObjectPrincipal.h"
  18 #include "nsIXPCScriptable.h"
  19
  20 #include "js/HeapAPI.h"
  21
  22 class XPCWrappedNative;
  23
  24 class BackstagePass final : public nsIGlobalObject,
  25                             public nsIScriptObjectPrincipal,
  26                             public nsIXPCScriptable,
  27                             public nsIClassInfo,
  28                             public nsSupportsWeakReference {
  29  public:
  30   BackstagePass();
  31
  32   NS_DECL_ISUPPORTS
  33   NS_DECL_NSIXPCSCRIPTABLE
  34   NS_DECL_NSICLASSINFO
  35
  36   using ModuleLoaderBase = JS::loader::ModuleLoaderBase;
  37
  38   nsIPrincipal* GetPrincipal() override { return mPrincipal; }
  39
  40   nsIPrincipal* GetEffectiveCookiePrincipal() override { return mPrincipal; }
  41
  42   nsIPrincipal* GetEffectiveStoragePrincipal() override { return mPrincipal; }
  43
  44   nsIPrincipal* PartitionedPrincipal() override { return mPrincipal; }
  45
  46   mozilla::OriginTrials Trials() const override { return {}; }
  47
  48   JSObject* GetGlobalJSObject() override;
  49   JSObject* GetGlobalJSObjectPreserveColor() const override;
  50
  51   ModuleLoaderBase* GetModuleLoader(JSContext* aCx) override {
  52     return mModuleLoader;
  53   }
  54
  55   mozilla::StorageAccess GetStorageAccess() final {
  56     MOZ_ASSERT(NS_IsMainThread());
  57     return mozilla::StorageAccess::eAllow;
  58   }
  59
  60   mozilla::Result<mozilla::ipc::PrincipalInfo, nsresult> GetStorageKey()
  61       override;
  62
  63   void ForgetGlobalObject() { mWrapper = nullptr; }
  64
  65   void SetGlobalObject(JSObject* global);
  66
  67   void InitModuleLoader(ModuleLoaderBase* aModuleLoader) {
  68     MOZ_ASSERT(!mModuleLoader);
  69     mModuleLoader = aModuleLoader;
  70   }
  71
  72   nsISerialEventTarget* SerialEventTarget() const final {
  73     return mozilla::GetMainThreadSerialEventTarget();
  74   }
  75   nsresult Dispatch(already_AddRefed<nsIRunnable>&& aRunnable) const final {
  76     return mozilla::SchedulerGroup::Dispatch(std::move(aRunnable));
  77   }
  78
  79   bool ShouldResistFingerprinting(RFPTarget aTarget) const override {
  80     // BackstagePass is always the System Principal
  81     MOZ_RELEASE_ASSERT(mPrincipal->IsSystemPrincipal());
  82     return false;
  83   }
  84
  85  private:
  86   virtual ~BackstagePass() = default;
  87
  88   nsCOMPtr<nsIPrincipal> mPrincipal;
  89   XPCWrappedNative* mWrapper;
  90
  91   RefPtr<JS::loader::ModuleLoaderBase> mModuleLoader;
  92 };
  93
  94 #endif  // BackstagePass_h__