1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152
|
/* -*- 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_dom_ReportingHeader_h
#define mozilla_dom_ReportingHeader_h
#include "mozilla/TimeStamp.h"
#include "nsClassHashtable.h"
#include "nsIObserver.h"
#include "nsITimer.h"
#include "nsTObserverArray.h"
class nsIHttpChannel;
class nsIPrincipal;
class nsIURI;
namespace mozilla {
class OriginAttributesPattern;
namespace ipc {
class PrincipalInfo;
}
namespace dom {
class ReportingHeader final : public nsIObserver,
public nsITimerCallback,
public nsINamed {
public:
NS_DECL_ISUPPORTS
NS_DECL_NSIOBSERVER
NS_DECL_NSITIMERCALLBACK
NS_DECL_NSINAMED
static void Initialize();
// Exposed structs for gtests
struct Endpoint {
nsCOMPtr<nsIURI> mUrl;
nsCString mEndpointName;
uint32_t mPriority;
uint32_t mWeight;
uint32_t mFailures;
};
struct Group {
nsString mName;
bool mIncludeSubdomains;
int32_t mTTL;
TimeStamp mCreationTime;
nsTObserverArray<Endpoint> mEndpoints;
};
struct Client {
nsTObserverArray<Group> mGroups;
};
// Parses the Reporting-Endpoints of a given header according to the algorithm
// in https://www.w3.org/TR/reporting-1/#header
static UniquePtr<Client> ParseReportingEndpointsHeader(
const nsACString& aHeaderValue, nsIURI* aURI);
// [Deprecated] Parses the contents of a given header according to the
// algorithm in https://www.w3.org/TR/2018/WD-reporting-1-20180925/#header
static UniquePtr<Client> ParseReportToHeader(nsIHttpChannel* aChannel,
nsIURI* aURI,
const nsACString& aHeaderValue);
static void GetEndpointForReport(
const nsAString& aGroupName,
const mozilla::ipc::PrincipalInfo& aPrincipalInfo,
nsACString& aEndpointURI);
static void GetEndpointForReport(const nsAString& aGroupName,
nsIPrincipal* aPrincipal,
nsACString& aEndpointURI);
static void RemoveEndpoint(const nsAString& aGroupName,
const nsACString& aEndpointURL,
const mozilla::ipc::PrincipalInfo& aPrincipalInfo);
// ChromeOnly-WebIDL methods
static bool HasReportingHeaderForOrigin(const nsACString& aOrigin);
private:
ReportingHeader();
~ReportingHeader();
static void Shutdown();
// Checks if a channel contains a Report-To header and parses its value.
void ReportingFromChannel(nsIHttpChannel* aChannel);
// This method checks if the protocol handler of the URI has the
// URI_IS_POTENTIALLY_TRUSTWORTHY flag.
static bool IsSecureURI(nsIURI* aURI);
void RemoveOriginsFromHost(const nsAString& aHost);
void RemoveOriginsFromOriginAttributesPattern(
const OriginAttributesPattern& aPattern);
void RemoveOrigins();
void RemoveOriginsForTTL();
void MaybeCreateCleanupTimer();
void MaybeCancelCleanupTimer();
static void LogToConsoleInvalidJSON(nsIHttpChannel* aChannel, nsIURI* aURI);
static void LogToConsoleDuplicateGroup(nsIHttpChannel* aChannel, nsIURI* aURI,
const nsAString& aName);
static void LogToConsoleInvalidNameItem(nsIHttpChannel* aChannel,
nsIURI* aURI);
static void LogToConsoleIncompleteItem(nsIHttpChannel* aChannel, nsIURI* aURI,
const nsAString& aName);
static void LogToConsoleIncompleteEndpoint(nsIHttpChannel* aChannel,
nsIURI* aURI,
const nsAString& aName);
static void LogToConsoleInvalidURLEndpoint(nsIHttpChannel* aChannel,
nsIURI* aURI,
const nsAString& aName,
const nsAString& aURL);
static void LogToConsoleInternal(nsIHttpChannel* aChannel, nsIURI* aURI,
const char* aMsg,
const nsTArray<nsString>& aParams);
static void GetEndpointForReportInternal(const ReportingHeader::Group& aGrup,
nsACString& aEndpointURI);
nsClassHashtable<nsCStringHashKey, Client> mOrigins;
nsCOMPtr<nsITimer> mCleanupTimer;
};
} // namespace dom
} // namespace mozilla
#endif // mozilla_dom_ReportingHeader_h
|