caps/ContentPrincipal.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_ContentPrincipal_h
   7 #define mozilla_ContentPrincipal_h
   8
   9 #include "nsCOMPtr.h"
  10 #include "nsJSPrincipals.h"
  11 #include "nsTArray.h"
  12 #include "nsNetUtil.h"
  13 #include "nsScriptSecurityManager.h"
  14 #include "mozilla/BasePrincipal.h"
  15 #include "mozilla/Mutex.h"
  16 #include "mozilla/extensions/WebExtensionPolicy.h"
  17
  18 namespace Json {
  19 class Value;
  20 }
  21
  22 namespace mozilla {
  23
  24 class ContentPrincipal final : public BasePrincipal {
  25  public:
  26   NS_IMETHOD QueryInterface(REFNSIID aIID, void** aInstancePtr) override;
  27   uint32_t GetHashValue() override;
  28   NS_IMETHOD GetURI(nsIURI** aURI) override;
  29   NS_IMETHOD GetDomain(nsIURI** aDomain) override;
  30   NS_IMETHOD SetDomain(nsIURI* aDomain) override;
  31   NS_IMETHOD GetBaseDomain(nsACString& aBaseDomain) override;
  32   NS_IMETHOD GetAddonId(nsAString& aAddonId) override;
  33   NS_IMETHOD GetSiteOriginNoSuffix(nsACString& aSiteOrigin) override;
  34   bool IsContentPrincipal() const override { return true; }
  35
  36   ContentPrincipal(nsIURI* aURI, const OriginAttributes& aOriginAttributes,
  37                    const nsACString& aOriginNoSuffix, nsIURI* aInitialDomain);
  38   ContentPrincipal(ContentPrincipal* aOther,
  39                    const OriginAttributes& aOriginAttributes);
  40
  41   static PrincipalKind Kind() { return eContentPrincipal; }
  42
  43   virtual nsresult GetScriptLocation(nsACString& aStr) override;
  44
  45   nsresult GetSiteIdentifier(SiteIdentifier& aSite) override;
  46
  47   static nsresult GenerateOriginNoSuffixFromURI(nsIURI* aURI,
  48                                                 nsACString& aOrigin);
  49
  50   RefPtr<extensions::WebExtensionPolicyCore> AddonPolicyCore();
  51
  52   virtual nsresult PopulateJSONObject(Json::Value& aObject) override;
  53   // Serializable keys are the valid enum fields the serialization supports
  54   enum SerializableKeys : uint8_t {
  55     eURI = 0,
  56     eDomain,
  57     eSuffix,
  58     eMax = eSuffix
  59   };
  60   typedef mozilla::BasePrincipal::KeyValT<SerializableKeys> KeyVal;
  61
  62   static already_AddRefed<BasePrincipal> FromProperties(
  63       nsTArray<ContentPrincipal::KeyVal>& aFields);
  64
  65   class Deserializer : public BasePrincipal::Deserializer {
  66    public:
  67     NS_IMETHOD Read(nsIObjectInputStream* aStream) override;
  68   };
  69
  70  protected:
  71   virtual ~ContentPrincipal();
  72
  73   bool SubsumesInternal(nsIPrincipal* aOther,
  74                         DocumentDomainConsideration aConsideration) override;
  75   bool MayLoadInternal(nsIURI* aURI) override;
  76
  77  private:
  78   const nsCOMPtr<nsIURI> mURI;
  79   mozilla::Mutex mMutex{"ContentPrincipal::mMutex"};
  80   nsCOMPtr<nsIURI> mDomain MOZ_GUARDED_BY(mMutex);
  81   Maybe<RefPtr<extensions::WebExtensionPolicyCore>> mAddon
  82       MOZ_GUARDED_BY(mMutex);
  83 };
  84
  85 }  // namespace mozilla
  86
  87 #define NS_PRINCIPAL_CID                             \
  88   {                                                  \
  89     0x653e0e4d, 0x3ee4, 0x45fa, {                    \
  90       0xb2, 0x72, 0x97, 0xc2, 0x0b, 0xc0, 0x1e, 0xb8 \
  91     }                                                \
  92   }
  93
  94 #endif  // mozilla_ContentPrincipal_h