mirror of
https://github.com/classilla/tenfourfox.git
synced 2024-08-14 10:29:31 +00:00
269 lines
9.3 KiB
C++
269 lines
9.3 KiB
C++
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
|
|
/* 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 mozilla_BasePrincipal_h
|
|
#define mozilla_BasePrincipal_h
|
|
|
|
#include "nsIPrincipal.h"
|
|
#include "nsIScriptSecurityManager.h"
|
|
#include "nsJSPrincipals.h"
|
|
|
|
#include "mozilla/dom/ChromeUtilsBinding.h"
|
|
|
|
class nsIContentSecurityPolicy;
|
|
class nsIObjectOutputStream;
|
|
class nsIObjectInputStream;
|
|
class nsIURI;
|
|
|
|
class nsExpandedPrincipal;
|
|
|
|
namespace mozilla {
|
|
|
|
// Base OriginAttributes class. This has several subclass flavors, and is not
|
|
// directly constructable itself.
|
|
class OriginAttributes : public dom::OriginAttributesDictionary
|
|
{
|
|
public:
|
|
bool operator==(const OriginAttributes& aOther) const
|
|
{
|
|
return mAppId == aOther.mAppId &&
|
|
mInBrowser == aOther.mInBrowser &&
|
|
mAddonId == aOther.mAddonId &&
|
|
mUserContextId == aOther.mUserContextId &&
|
|
mSignedPkg == aOther.mSignedPkg;
|
|
}
|
|
bool operator!=(const OriginAttributes& aOther) const
|
|
{
|
|
return !(*this == aOther);
|
|
}
|
|
|
|
// Serializes/Deserializes non-default values into the suffix format, i.e.
|
|
// |!key1=value1&key2=value2|. If there are no non-default attributes, this
|
|
// returns an empty string.
|
|
void CreateSuffix(nsACString& aStr) const;
|
|
bool PopulateFromSuffix(const nsACString& aStr);
|
|
|
|
// Populates the attributes from a string like
|
|
// |uri!key1=value1&key2=value2| and returns the uri without the suffix.
|
|
bool PopulateFromOrigin(const nsACString& aOrigin,
|
|
nsACString& aOriginNoSuffix);
|
|
|
|
protected:
|
|
OriginAttributes() {}
|
|
explicit OriginAttributes(const OriginAttributesDictionary& aOther)
|
|
: OriginAttributesDictionary(aOther) {}
|
|
};
|
|
|
|
class PrincipalOriginAttributes;
|
|
class DocShellOriginAttributes;
|
|
class NeckoOriginAttributes;
|
|
|
|
// Various classes in Gecko contain OriginAttributes members, and those
|
|
// OriginAttributes get propagated to other classes according to certain rules.
|
|
// For example, the OriginAttributes on the docshell affect the OriginAttributes
|
|
// for the principal of a document loaded inside it, whose OriginAttributes in
|
|
// turn affect those of network loads and child docshells. To codify and
|
|
// centralize these rules, we introduce separate subclasses for the different
|
|
// flavors, and a variety of InheritFrom* methods to implement the transfer
|
|
// behavior.
|
|
|
|
// For OriginAttributes stored on principals.
|
|
class PrincipalOriginAttributes : public OriginAttributes
|
|
{
|
|
public:
|
|
PrincipalOriginAttributes() {}
|
|
PrincipalOriginAttributes(uint32_t aAppId, bool aInBrowser)
|
|
{
|
|
mAppId = aAppId;
|
|
mInBrowser = aInBrowser;
|
|
}
|
|
|
|
// Inheriting OriginAttributes from docshell to document when user navigates.
|
|
//
|
|
// @param aAttrs Origin Attributes of the docshell.
|
|
// @param aURI The URI of the document.
|
|
void InheritFromDocShellToDoc(const DocShellOriginAttributes& aAttrs,
|
|
const nsIURI* aURI);
|
|
|
|
// Inherit OriginAttributes from Necko.
|
|
void InheritFromNecko(const NeckoOriginAttributes& aAttrs);
|
|
};
|
|
|
|
// For OriginAttributes stored on docshells / loadcontexts / browsing contexts.
|
|
class DocShellOriginAttributes : public OriginAttributes
|
|
{
|
|
public:
|
|
DocShellOriginAttributes() {}
|
|
DocShellOriginAttributes(uint32_t aAppId, bool aInBrowser)
|
|
{
|
|
mAppId = aAppId;
|
|
mInBrowser = aInBrowser;
|
|
}
|
|
|
|
// Inheriting OriginAttributes from document to child docshell when an
|
|
// <iframe> is created.
|
|
//
|
|
// @param aAttrs Origin Attributes of the document.
|
|
void
|
|
InheritFromDocToChildDocShell(const PrincipalOriginAttributes& aAttrs);
|
|
};
|
|
|
|
// For OriginAttributes stored on Necko.
|
|
class NeckoOriginAttributes : public OriginAttributes
|
|
{
|
|
public:
|
|
NeckoOriginAttributes() {}
|
|
NeckoOriginAttributes(uint32_t aAppId, bool aInBrowser)
|
|
{
|
|
mAppId = aAppId;
|
|
mInBrowser = aInBrowser;
|
|
}
|
|
|
|
// Inheriting OriginAttributes from document to necko when a network request
|
|
// is made.
|
|
void InheritFromDocToNecko(const PrincipalOriginAttributes& aAttrs);
|
|
|
|
void InheritFromDocShellToNecko(const DocShellOriginAttributes& aAttrs);
|
|
};
|
|
|
|
// For operating on OriginAttributes not associated with any data structure.
|
|
class GenericOriginAttributes : public OriginAttributes
|
|
{
|
|
public:
|
|
GenericOriginAttributes() {}
|
|
explicit GenericOriginAttributes(const OriginAttributesDictionary& aOther)
|
|
: OriginAttributes(aOther) {}
|
|
};
|
|
|
|
class OriginAttributesPattern : public dom::OriginAttributesPatternDictionary
|
|
{
|
|
public:
|
|
// To convert a JSON string to an OriginAttributesPattern, do the following:
|
|
//
|
|
// OriginAttributesPattern pattern;
|
|
// if (!pattern.Init(aJSONString)) {
|
|
// ... // handle failure.
|
|
// }
|
|
OriginAttributesPattern() {}
|
|
|
|
explicit OriginAttributesPattern(const OriginAttributesPatternDictionary& aOther)
|
|
: OriginAttributesPatternDictionary(aOther) {}
|
|
|
|
// Performs a match of |aAttrs| against this pattern.
|
|
bool Matches(const OriginAttributes& aAttrs) const
|
|
{
|
|
if (mAppId.WasPassed() && mAppId.Value() != aAttrs.mAppId) {
|
|
return false;
|
|
}
|
|
|
|
if (mInBrowser.WasPassed() && mInBrowser.Value() != aAttrs.mInBrowser) {
|
|
return false;
|
|
}
|
|
|
|
if (mAddonId.WasPassed() && mAddonId.Value() != aAttrs.mAddonId) {
|
|
return false;
|
|
}
|
|
|
|
if (mUserContextId.WasPassed() && mUserContextId.Value() != aAttrs.mUserContextId) {
|
|
return false;
|
|
}
|
|
|
|
if (mSignedPkg.WasPassed() && mSignedPkg.Value() != aAttrs.mSignedPkg) {
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
};
|
|
|
|
/*
|
|
* Base class from which all nsIPrincipal implementations inherit. Use this for
|
|
* default implementations and other commonalities between principal
|
|
* implementations.
|
|
*
|
|
* We should merge nsJSPrincipals into this class at some point.
|
|
*/
|
|
class BasePrincipal : public nsJSPrincipals
|
|
{
|
|
public:
|
|
BasePrincipal();
|
|
|
|
enum DocumentDomainConsideration { DontConsiderDocumentDomain, ConsiderDocumentDomain};
|
|
bool Subsumes(nsIPrincipal* aOther, DocumentDomainConsideration aConsideration);
|
|
|
|
NS_IMETHOD GetOrigin(nsACString& aOrigin) final;
|
|
NS_IMETHOD GetOriginNoSuffix(nsACString& aOrigin) final;
|
|
NS_IMETHOD Equals(nsIPrincipal* other, bool* _retval) final;
|
|
NS_IMETHOD EqualsConsideringDomain(nsIPrincipal* other, bool* _retval) final;
|
|
NS_IMETHOD Subsumes(nsIPrincipal* other, bool* _retval) final;
|
|
NS_IMETHOD SubsumesConsideringDomain(nsIPrincipal* other, bool* _retval) final;
|
|
NS_IMETHOD CheckMayLoad(nsIURI* uri, bool report, bool allowIfInheritsPrincipal) final;
|
|
NS_IMETHOD GetCsp(nsIContentSecurityPolicy** aCsp) override;
|
|
NS_IMETHOD SetCsp(nsIContentSecurityPolicy* aCsp) override;
|
|
NS_IMETHOD GetPreloadCsp(nsIContentSecurityPolicy** aPreloadCSP) override;
|
|
NS_IMETHOD SetPreloadCsp(nsIContentSecurityPolicy* aPreloadCSP) override;
|
|
NS_IMETHOD GetCspJSON(nsAString& outCSPinJSON) override;
|
|
NS_IMETHOD GetIsNullPrincipal(bool* aResult) override;
|
|
NS_IMETHOD GetIsCodebasePrincipal(bool* aResult) override;
|
|
NS_IMETHOD GetIsExpandedPrincipal(bool* aResult) override;
|
|
NS_IMETHOD GetIsSystemPrincipal(bool* aResult) override;
|
|
NS_IMETHOD GetJarPrefix(nsACString& aJarPrefix) final;
|
|
NS_IMETHOD GetOriginAttributes(JSContext* aCx, JS::MutableHandle<JS::Value> aVal) final;
|
|
NS_IMETHOD GetOriginSuffix(nsACString& aOriginSuffix) final;
|
|
NS_IMETHOD GetAppStatus(uint16_t* aAppStatus) final;
|
|
NS_IMETHOD GetAppId(uint32_t* aAppStatus) final;
|
|
NS_IMETHOD GetIsInBrowserElement(bool* aIsInBrowserElement) final;
|
|
NS_IMETHOD GetUnknownAppId(bool* aUnknownAppId) final;
|
|
NS_IMETHOD GetUserContextId(uint32_t* aUserContextId) final;
|
|
|
|
virtual bool IsOnCSSUnprefixingWhitelist() override { return false; }
|
|
|
|
virtual bool IsCodebasePrincipal() const { return false; };
|
|
|
|
static BasePrincipal* Cast(nsIPrincipal* aPrin) { return static_cast<BasePrincipal*>(aPrin); }
|
|
static already_AddRefed<BasePrincipal>
|
|
CreateCodebasePrincipal(nsIURI* aURI, const PrincipalOriginAttributes& aAttrs);
|
|
static already_AddRefed<BasePrincipal> CreateCodebasePrincipal(const nsACString& aOrigin);
|
|
|
|
const PrincipalOriginAttributes& OriginAttributesRef() { return mOriginAttributes; }
|
|
uint32_t AppId() const { return mOriginAttributes.mAppId; }
|
|
uint32_t UserContextId() const { return mOriginAttributes.mUserContextId; }
|
|
bool IsInBrowserElement() const { return mOriginAttributes.mInBrowser; }
|
|
|
|
enum PrincipalKind {
|
|
eNullPrincipal,
|
|
eCodebasePrincipal,
|
|
eExpandedPrincipal,
|
|
eSystemPrincipal
|
|
};
|
|
|
|
virtual PrincipalKind Kind() = 0;
|
|
|
|
protected:
|
|
virtual ~BasePrincipal();
|
|
|
|
virtual nsresult GetOriginInternal(nsACString& aOrigin) = 0;
|
|
virtual bool SubsumesInternal(nsIPrincipal* aOther, DocumentDomainConsideration aConsider) = 0;
|
|
|
|
// Internal, side-effect-free check to determine whether the concrete
|
|
// principal would allow the load ignoring any common behavior implemented in
|
|
// BasePrincipal::CheckMayLoad.
|
|
virtual bool MayLoadInternal(nsIURI* aURI) = 0;
|
|
friend class ::nsExpandedPrincipal;
|
|
|
|
// Helper to check whether this principal is associated with an addon that
|
|
// allows unprivileged code to load aURI.
|
|
bool AddonAllowsLoad(nsIURI* aURI);
|
|
|
|
nsCOMPtr<nsIContentSecurityPolicy> mCSP;
|
|
nsCOMPtr<nsIContentSecurityPolicy> mPreloadCSP;
|
|
PrincipalOriginAttributes mOriginAttributes;
|
|
};
|
|
|
|
} // namespace mozilla
|
|
|
|
#endif /* mozilla_BasePrincipal_h */
|