gecko-dev/caps/ExpandedPrincipal.h
Nika Layzell e2f6bee4ab Bug 1443925 - Part 2: Make basic manipulation of nsIPrincipal threadsafe, r=ckerschb
This patch only makes the very basics of nsIPrincipal manipulation threadsafe,
such as reference counting, and some trivial methods. The more complex methods
will be made threadsafe in following parts.

Differential Revision: https://phabricator.services.mozilla.com/D163032
2022-12-02 00:53:50 +00:00

99 lines
3.5 KiB
C++

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef ExpandedPrincipal_h
#define ExpandedPrincipal_h
#include "nsCOMPtr.h"
#include "nsJSPrincipals.h"
#include "nsProxyRelease.h"
#include "nsTArray.h"
#include "nsNetUtil.h"
#include "mozilla/BasePrincipal.h"
class nsIContentSecurityPolicy;
namespace Json {
class Value;
}
class ExpandedPrincipal : public nsIExpandedPrincipal,
public mozilla::BasePrincipal {
public:
static already_AddRefed<ExpandedPrincipal> Create(
const nsTArray<nsCOMPtr<nsIPrincipal>>& aAllowList,
const mozilla::OriginAttributes& aAttrs);
static PrincipalKind Kind() { return eExpandedPrincipal; }
NS_DECL_NSIEXPANDEDPRINCIPAL
NS_IMETHOD_(MozExternalRefCountType) AddRef() override {
return nsJSPrincipals::AddRef();
};
NS_IMETHOD_(MozExternalRefCountType) Release() override {
return nsJSPrincipals::Release();
};
NS_IMETHOD QueryInterface(REFNSIID aIID, void** aInstancePtr) override;
uint32_t GetHashValue() override;
NS_IMETHOD GetURI(nsIURI** aURI) override;
NS_IMETHOD GetDomain(nsIURI** aDomain) override;
NS_IMETHOD SetDomain(nsIURI* aDomain) override;
NS_IMETHOD GetBaseDomain(nsACString& aBaseDomain) override;
NS_IMETHOD GetAddonId(nsAString& aAddonId) override;
NS_IMETHOD IsThirdPartyURI(nsIURI* uri, bool* aRes) override;
virtual bool AddonHasPermission(const nsAtom* aPerm) override;
virtual nsresult GetScriptLocation(nsACString& aStr) override;
bool AddonAllowsLoad(nsIURI* aURI, bool aExplicit = false);
void SetCsp(nsIContentSecurityPolicy* aCSP);
// Returns the principal to inherit when this principal requests the given
// URL. See BasePrincipal::PrincipalToInherit.
nsIPrincipal* PrincipalToInherit(nsIURI* aRequestedURI = nullptr);
nsresult GetSiteIdentifier(mozilla::SiteIdentifier& aSite) override;
virtual nsresult PopulateJSONObject(Json::Value& aObject) override;
// Serializable keys are the valid enum fields the serialization supports
enum SerializableKeys : uint8_t { eSpecs = 0, eSuffix, eMax = eSuffix };
typedef mozilla::BasePrincipal::KeyValT<SerializableKeys> KeyVal;
static already_AddRefed<BasePrincipal> FromProperties(
nsTArray<ExpandedPrincipal::KeyVal>& aFields);
class Deserializer : public BasePrincipal::Deserializer {
public:
NS_IMETHOD Read(nsIObjectInputStream* aStream) override;
};
protected:
explicit ExpandedPrincipal(nsTArray<nsCOMPtr<nsIPrincipal>>&& aPrincipals,
const nsACString& aOriginNoSuffix,
const mozilla::OriginAttributes& aAttrs);
virtual ~ExpandedPrincipal();
bool SubsumesInternal(nsIPrincipal* aOther,
DocumentDomainConsideration aConsideration) override;
bool MayLoadInternal(nsIURI* aURI) override;
private:
const nsTArray<nsCOMPtr<nsIPrincipal>> mPrincipals;
nsMainThreadPtrHandle<nsIContentSecurityPolicy> mCSP
MOZ_GUARDED_BY(mozilla::sMainThreadCapability);
};
#define NS_EXPANDEDPRINCIPAL_CID \
{ \
0xe8ee88b0, 0x5571, 0x4086, { \
0xa4, 0x5b, 0x39, 0xa7, 0x16, 0x90, 0x6b, 0xdb \
} \
}
#endif // ExpandedPrincipal_h