summaryrefslogtreecommitdiffstats
path: root/toolkit/components/antitracking/PartitioningExceptionList.cpp
blob: 91cc40133c710c1798e33faec0e495c1739b97b6 (plain)
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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
/* -*- 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/. */

#include "PartitioningExceptionList.h"

#include "AntiTrackingLog.h"
#include "nsContentUtils.h"
#include "nsServiceManagerUtils.h"

#include "mozilla/ClearOnShutdown.h"
#include "mozilla/StaticPtr.h"

namespace mozilla {

namespace {

static constexpr std::array<nsLiteralCString, 2> kSupportedSchemes = {
    {"https://"_ns, "http://"_ns}};

StaticRefPtr<PartitioningExceptionList> gPartitioningExceptionList;

}  // namespace

NS_IMPL_ISUPPORTS(PartitioningExceptionList,
                  nsIPartitioningExceptionListObserver)

bool PartitioningExceptionList::Check(const nsACString& aFirstPartyOrigin,
                                      const nsACString& aThirdPartyOrigin) {
  if (!StaticPrefs::privacy_antitracking_enableWebcompat()) {
    LOG(("Partition exception list disabled via pref"));
    return false;
  }

  if (aFirstPartyOrigin.IsEmpty() || aFirstPartyOrigin == "null" ||
      aThirdPartyOrigin.IsEmpty() || aThirdPartyOrigin == "null") {
    return false;
  }

  LOG(("Check partitioning exception list for url %s and %s",
       PromiseFlatCString(aFirstPartyOrigin).get(),
       PromiseFlatCString(aThirdPartyOrigin).get()));

  for (PartitionExceptionListEntry& entry : GetOrCreate()->mExceptionList) {
    if (OriginMatchesPattern(aFirstPartyOrigin, entry.mFirstParty) &&
        OriginMatchesPattern(aThirdPartyOrigin, entry.mThirdParty)) {
      LOG(("Found partitioning exception list entry for %s and %s",
           PromiseFlatCString(aFirstPartyOrigin).get(),
           PromiseFlatCString(aThirdPartyOrigin).get()));

      return true;
    }
  }

  return false;
}

PartitioningExceptionList* PartitioningExceptionList::GetOrCreate() {
  if (!gPartitioningExceptionList) {
    gPartitioningExceptionList = new PartitioningExceptionList();
    gPartitioningExceptionList->Init();

    RunOnShutdown([&] {
      gPartitioningExceptionList->Shutdown();
      gPartitioningExceptionList = nullptr;
    });
  }

  return gPartitioningExceptionList;
}

nsresult PartitioningExceptionList::Init() {
  mService =
      do_GetService("@mozilla.org/partitioning/exception-list-service;1");
  if (NS_WARN_IF(!mService)) {
    return NS_ERROR_FAILURE;
  }

  mService->RegisterAndRunExceptionListObserver(this);
  return NS_OK;
}

void PartitioningExceptionList::Shutdown() {
  if (mService) {
    mService->UnregisterExceptionListObserver(this);
    mService = nullptr;
  }

  mExceptionList.Clear();
}

NS_IMETHODIMP
PartitioningExceptionList::OnExceptionListUpdate(const nsACString& aList) {
  mExceptionList.Clear();

  nsresult rv;
  for (const nsACString& item : aList.Split(';')) {
    auto origins = item.Split(',');
    auto originsIt = origins.begin();

    if (originsIt == origins.end()) {
      LOG(("Ignoring empty exception entry"));
      continue;
    }

    PartitionExceptionListEntry entry;

    rv = GetExceptionListPattern(*originsIt, entry.mFirstParty);
    if (NS_WARN_IF(NS_FAILED(rv))) {
      continue;
    }

    ++originsIt;

    if (originsIt == origins.end()) {
      LOG(("Ignoring incomplete exception entry"));
      continue;
    }

    rv = GetExceptionListPattern(*originsIt, entry.mThirdParty);
    if (NS_WARN_IF(NS_FAILED(rv))) {
      continue;
    }

    if (entry.mFirstParty.mSuffix == "*" && entry.mThirdParty.mSuffix == "*") {
      LOG(("Ignoring *,* exception entry"));
      continue;
    }

    LOG(("onExceptionListUpdate: %s%s - %s%s", entry.mFirstParty.mScheme.get(),
         entry.mFirstParty.mSuffix.get(), entry.mThirdParty.mScheme.get(),
         entry.mThirdParty.mSuffix.get()));

    mExceptionList.AppendElement(entry);
  }

  return NS_OK;
}

nsresult PartitioningExceptionList::GetSchemeFromOrigin(
    const nsACString& aOrigin, nsACString& aScheme,
    nsACString& aOriginNoScheme) {
  NS_ENSURE_FALSE(aOrigin.IsEmpty(), NS_ERROR_INVALID_ARG);

  for (const auto& scheme : kSupportedSchemes) {
    if (aOrigin.Length() <= scheme.Length() ||
        !StringBeginsWith(aOrigin, scheme)) {
      continue;
    }
    aScheme = Substring(aOrigin, 0, scheme.Length());
    aOriginNoScheme = Substring(aOrigin, scheme.Length());
    return NS_OK;
  }

  return NS_ERROR_FAILURE;
}

bool PartitioningExceptionList::OriginMatchesPattern(
    const nsACString& aOrigin, const PartitionExceptionListPattern& aPattern) {
  if (NS_WARN_IF(aOrigin.IsEmpty())) {
    return false;
  }

  if (aPattern.mSuffix == "*") {
    return true;
  }

  nsAutoCString scheme, originNoScheme;
  nsresult rv = GetSchemeFromOrigin(aOrigin, scheme, originNoScheme);
  NS_ENSURE_SUCCESS(rv, false);

  // Always strict match scheme.
  if (scheme != aPattern.mScheme) {
    return false;
  }

  if (!aPattern.mIsWildCard) {
    // aPattern is not a wildcard, match strict.
    return originNoScheme == aPattern.mSuffix;
  }

  // For wildcard patterns, check if origin suffix matches pattern suffix.
  return StringEndsWith(originNoScheme, aPattern.mSuffix);
}

// Parses a string with an origin or an origin-pattern into a
// PartitionExceptionListPattern.
nsresult PartitioningExceptionList::GetExceptionListPattern(
    const nsACString& aOriginPattern, PartitionExceptionListPattern& aPattern) {
  NS_ENSURE_FALSE(aOriginPattern.IsEmpty(), NS_ERROR_INVALID_ARG);

  if (aOriginPattern == "*") {
    aPattern.mIsWildCard = true;
    aPattern.mSuffix = "*";

    return NS_OK;
  }

  nsAutoCString originPatternNoScheme;
  nsresult rv = GetSchemeFromOrigin(aOriginPattern, aPattern.mScheme,
                                    originPatternNoScheme);
  NS_ENSURE_SUCCESS(rv, rv);

  if (StringBeginsWith(originPatternNoScheme, "*"_ns)) {
    NS_ENSURE_TRUE(originPatternNoScheme.Length() > 2, NS_ERROR_INVALID_ARG);

    aPattern.mIsWildCard = true;
    aPattern.mSuffix = Substring(originPatternNoScheme, 1);

    return NS_OK;
  }

  aPattern.mIsWildCard = false;
  aPattern.mSuffix = originPatternNoScheme;

  return NS_OK;
}

}  // namespace mozilla