-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Expand file tree
/
Copy pathContentFilter.cpp
More file actions
486 lines (406 loc) · 16.7 KB
/
ContentFilter.cpp
File metadata and controls
486 lines (406 loc) · 16.7 KB
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
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
/*
* Copyright (C) 2013-2026 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
#include "config.h"
#include "ContentFilter.h"
#if ENABLE(CONTENT_FILTERING)
#include "CachedRawResource.h"
#include "ContentFilterClient.h"
#include "ContentFilterUnblockHandler.h"
#include "DocumentLoader.h"
#include "FrameLoadRequest.h"
#include "FrameLoader.h"
#include "LocalFrame.h"
#include "LocalFrameLoaderClient.h"
#include "Logging.h"
#include "NetworkExtensionContentFilter.h"
#include "ParentalControlsContentFilter.h"
#include "ScriptController.h"
#include "SharedBuffer.h"
#include <array>
#include <wtf/NeverDestroyed.h>
#include <wtf/Ref.h>
#include <wtf/SetForScope.h>
#include <wtf/Vector.h>
#if HAVE(WEBCONTENTRESTRICTIONS)
#include "ParentalControlsURLFilter.h"
#endif
#if !LOG_DISABLED
#include <wtf/text/CString.h>
#endif
namespace WebCore {
Vector<ContentFilter::Type>& ContentFilter::types()
{
static NeverDestroyed<Vector<ContentFilter::Type>> types {
Vector<ContentFilter::Type>::from(
#if HAVE(PARENTAL_CONTROLS)
type<ParentalControlsContentFilter>(),
#endif
type<NetworkExtensionContentFilter>()
)
};
return types;
}
RefPtr<ContentFilter> ContentFilter::create(ContentFilterClient& client)
{
PlatformContentFilter::FilterParameters params {
#if HAVE(WEBCONTENTRESTRICTIONS)
#if HAVE(WEBCONTENTRESTRICTIONS_PATH_SPI)
client.webContentRestrictionsConfigurationPath(),
#endif
client.mainDocumentURL(),
#endif
};
auto filters = types().map([params](auto& type) {
return type.create(params);
});
if (filters.isEmpty())
return nullptr;
return adoptRef(*new ContentFilter(WTF::move(filters), client));
}
ContentFilter::ContentFilter(Container&& contentFilters, ContentFilterClient& client)
: m_contentFilters(WTF::move(contentFilters))
, m_client(client)
{
LOG(ContentFiltering, "Creating ContentFilter with %zu platform content filter(s).\n", m_contentFilters.size());
ASSERT(!m_contentFilters.isEmpty());
}
ContentFilter::~ContentFilter()
{
LOG(ContentFiltering, "Destroying ContentFilter.\n");
}
bool ContentFilter::continueAfterWillSendRequest(ResourceRequest& request, const ResourceResponse& redirectResponse)
{
RefPtr protectedClient = m_client.get();
if (!protectedClient)
return false;
LOG(ContentFiltering, "ContentFilter received request for <%{sensitive}s> with redirect response from <%{sensitive}s>.\n", request.url().string().utf8().data(), redirectResponse.url().string().utf8().data());
#if !LOG_DISABLED
ResourceRequest originalRequest { request };
#endif
ASSERT(m_state == State::Stopped || m_state == State::Filtering);
forEachContentFilterUntilBlocked([&request, &redirectResponse](PlatformContentFilter& contentFilter) {
contentFilter.willSendRequest(request, redirectResponse);
});
if (m_state == State::Blocked)
request = ResourceRequest();
#if !LOG_DISABLED
if (request != originalRequest)
LOG(ContentFiltering, "ContentFilter changed request url to <%{sensitive}s>.\n", originalRequest.url().string().ascii().data());
#endif
return !request.isNull();
}
ContentFilter::ContentFilterCallbackAggregator::~ContentFilterCallbackAggregator()
{
ASSERT(RunLoop::isMain());
ASSERT(m_callback);
if (m_isBlocked) {
if (RefPtr contentFilter = m_contentFilter)
contentFilter->didDecide(State::Blocked);
m_callback(ResourceRequest());
return;
}
if (RefPtr contentFilter = m_contentFilter; contentFilter && m_numberOfFiltersAllowed == contentFilter->m_contentFilters.size())
contentFilter->didDecide(State::Allowed);
m_contentFilter = nullptr;
m_callback(WTF::move(m_request));
}
void ContentFilter::ContentFilterCallbackAggregator::didReceivePlatformContentFilterDecision(PlatformContentFilter& platformContentFilter, String&& urlString)
{
ASSERT(RunLoop::isMain());
if (platformContentFilter.isAllowed())
++m_numberOfFiltersAllowed;
if (platformContentFilter.didBlockData() && !m_isBlocked) {
m_isBlocked = true;
RefPtr contentFilter = m_contentFilter;
contentFilter->m_blockingContentFilter = platformContentFilter;
return;
}
URL url { urlString };
if (url.isValid())
m_request.setURL(WTF::move(url));
}
ContentFilter::ContentFilterCallbackAggregator::ContentFilterCallbackAggregator(ContentFilter& contentFilter, const ResourceRequest& request, CompletionHandler<void(ResourceRequest&&)>&& callback)
: m_contentFilter(contentFilter)
, m_request(request)
, m_callback(WTF::move(callback))
{
ASSERT(RunLoop::isMain());
}
void ContentFilter::continueAfterWillSendRequest(ResourceRequest&& request, const ResourceResponse& redirectResponse, CompletionHandler<void(ResourceRequest&&)>&& completionHandler)
{
ASSERT(RunLoop::isMain());
LOG(ContentFiltering, "ContentFilter received request for <%{sensitive}s> with redirect response from %s" SENSITIVE_LOG_STRING, request.url().string().utf8().data(), redirectResponse.url().string().utf8().data());
ASSERT(m_state == State::Stopped || m_state == State::Filtering);
Ref contentFilterCallbackAggregator = ContentFilterCallbackAggregator::create(*this, request, WTF::move(completionHandler));
for (Ref platformContentFilter : m_contentFilters) {
CompletionHandler<void(String&&)> completion = [contentFilterCallbackAggregator, platformContentFilter] (String&& urlString) mutable {
ASSERT(RunLoop::isMain());
contentFilterCallbackAggregator->didReceivePlatformContentFilterDecision(platformContentFilter, WTF::move(urlString));
};
ASSERT(platformContentFilter->needsMoreData());
platformContentFilter->willSendRequest(ResourceRequest { request }, redirectResponse, WTF::move(completion));
}
}
void ContentFilter::startFilteringMainResource(const URL& url)
{
if (m_state != State::Stopped)
return;
LOG(ContentFiltering, "ContentFilter will start filtering main resource at <%{sensitive}s>.\n", url.string().ascii().data());
m_state = State::Filtering;
ASSERT(m_mainResourceURL.isEmpty());
m_mainResourceURL = url;
}
void ContentFilter::startFilteringMainResource(CachedRawResource& resource)
{
if (m_state != State::Stopped)
return;
LOG(ContentFiltering, "ContentFilter will start filtering main resource at <%{sensitive}s>.\n", resource.url().string().ascii().data());
m_state = State::Filtering;
ASSERT(!m_mainResource);
m_mainResource = resource;
}
void ContentFilter::stopFilteringMainResource()
{
if (m_state != State::Blocked)
m_state = State::Stopped;
m_mainResourceURL = URL();
}
bool ContentFilter::continueAfterResponseReceived(const ResourceResponse& response)
{
RefPtr protectedClient = m_client.get();
if (!protectedClient)
return false;
if (m_state == State::Filtering) {
LOG(ContentFiltering, "ContentFilter received response from <%{sensitive}s>.\n", response.url().string().ascii().data());
forEachContentFilterUntilBlocked([&response](PlatformContentFilter& contentFilter) {
contentFilter.responseReceived(response);
});
}
m_responseReceived = true;
return m_state != State::Blocked;
}
bool ContentFilter::continueAfterDataReceived(const SharedBuffer& data, FromDocumentLoader fromDocumentLoader)
{
RefPtr protectedClient = m_client.get();
if (!protectedClient)
return false;
if (m_state == State::Filtering) {
LOG(ContentFiltering, "ContentFilter received %zu bytes of data from <%{sensitive}s>.\n", data.size(), url().string().ascii().data());
forEachContentFilterUntilBlocked([data = Ref { data }](auto& contentFilter) {
contentFilter.addData(data);
});
if (fromDocumentLoader == FromDocumentLoader::Yes) {
if (m_state == State::Allowed) {
ASSERT(m_mainResource->dataBufferingPolicy() == DataBufferingPolicy::BufferData);
if (RefPtr buffer = m_mainResource->resourceBuffer())
deliverResourceData(buffer->makeContiguous());
}
} else {
if (m_state == State::Allowed) {
deliverStoredResourceData();
deliverResourceData(data);
} else
m_buffers.append(ResourceDataItem { RefPtr { &data } });
}
return false;
}
return m_state != State::Blocked;
}
bool ContentFilter::continueAfterNotifyFinished(const URL& resourceURL)
{
RefPtr protectedClient = m_client.get();
if (!protectedClient)
return false;
ASSERT_UNUSED(resourceURL, resourceURL == m_mainResourceURL);
if (m_state == State::Filtering) {
LOG(ContentFiltering, "ContentFilter will finish filtering main resource at <%{sensitive}s>.\n", url().string().ascii().data());
forEachContentFilterUntilBlocked([](PlatformContentFilter& contentFilter) {
contentFilter.finishedAddingData();
});
if (m_state != State::Blocked) {
m_state = State::Allowed;
deliverStoredResourceData();
}
if (m_state == State::Stopped)
return false;
}
return m_state != State::Blocked;
}
bool ContentFilter::continueAfterNotifyFinished(CachedResource& resource)
{
RefPtr protectedClient = m_client.get();
if (!protectedClient)
return true;
ASSERT_UNUSED(resource, &resource == m_mainResource);
if (m_mainResource->errorOccurred())
return true;
if (m_state == State::Filtering) {
LOG(ContentFiltering, "ContentFilter will finish filtering main resource at <%{sensitive}s>.\n", url().string().ascii().data());
forEachContentFilterUntilBlocked([](PlatformContentFilter& contentFilter) {
contentFilter.finishedAddingData();
});
if (m_state != State::Blocked) {
m_state = State::Allowed;
if (RefPtr buffer = m_mainResource->resourceBuffer()) {
ASSERT(m_mainResource->dataBufferingPolicy() == DataBufferingPolicy::BufferData);
deliverResourceData(buffer->makeContiguous());
}
}
if (m_state == State::Stopped)
return false;
}
return m_state != State::Blocked;
}
template <typename Function>
void ContentFilter::forEachContentFilterUntilBlocked(Function&& getData)
{
unsigned allowedCount = 0;
for (Ref contentFilter : m_contentFilters) {
if (contentFilter->needsMoreData())
getData(contentFilter.get());
// Still need more data for decision.
if (contentFilter->needsMoreData())
continue;
if (!contentFilter->didBlockData()) {
++allowedCount;
continue;
}
ASSERT(!m_blockingContentFilter.get());
m_blockingContentFilter = contentFilter.get();
didDecide(State::Blocked);
return;
}
if (m_contentFilters.size() == allowedCount)
didDecide(State::Allowed);
}
void ContentFilter::didDecide(State state)
{
ASSERT(m_state != State::Allowed);
ASSERT(m_state != State::Blocked);
ASSERT(state == State::Allowed || state == State::Blocked);
#if !LOG_DISABLED
LOG(ContentFiltering, "ContentFilter decided load should be %s for main resource at <%{sensitive}s>.\n", state == State::Allowed ? "allowed" : "blocked", url().string().ascii().data());
#endif // !LOG_DISABLED
m_state = state;
if (m_state != State::Blocked)
return;
RefPtr client = m_client.get();
if (!client)
return;
RefPtr blockingContentFilter = m_blockingContentFilter.get();
ASSERT(blockingContentFilter);
m_blockedError = client->contentFilterDidBlock(blockingContentFilter->unblockHandler(), blockingContentFilter->unblockRequestDeniedScript());
client->cancelMainResourceLoadForContentFilter(m_blockedError);
}
void ContentFilter::deliverResourceData(const SharedBuffer& buffer)
{
ASSERT(m_state == State::Allowed);
if (RefPtr protectedClient = m_client.get())
protectedClient->dataReceivedThroughContentFilter(buffer);
}
URL ContentFilter::url()
{
if (RefPtr mainResource = m_mainResource)
return mainResource->url();
return m_mainResourceURL;
}
const URL& ContentFilter::blockedPageURL()
{
static NeverDestroyed blockedPageURL = [] () -> URL {
RetainPtr webCoreBundle = CFBundleGetBundleWithIdentifier(CFSTR("com.apple.WebCore"));
return adoptCF(CFBundleCopyResourceURL(webCoreBundle.get(), CFSTR("ContentFilterBlockedPage"), CFSTR("html"), nullptr)).get();
}();
return blockedPageURL;
}
bool ContentFilter::continueAfterSubstituteDataRequest(const DocumentLoader& activeLoader, const SubstituteData& substituteData)
{
if (RefPtr contentFilter = activeLoader.contentFilter()) {
if (contentFilter->m_state == State::Blocked && !contentFilter->m_isLoadingBlockedPage)
return contentFilter->m_blockedError.failingURL() != substituteData.failingURL();
}
if (activeLoader.request().url() == blockedPageURL()) {
ASSERT(activeLoader.substituteData().isValid());
return activeLoader.substituteData().failingURL() != substituteData.failingURL();
}
return true;
}
bool ContentFilter::willHandleProvisionalLoadFailure(const ResourceError& error) const
{
if (m_state != State::Blocked)
return false;
if (m_blockedError.errorCode() != error.errorCode() || m_blockedError.domain() != error.domain())
return false;
ASSERT(m_blockedError.failingURL() == error.failingURL());
return true;
}
void ContentFilter::handleProvisionalLoadFailure(const ResourceError& error)
{
ASSERT(willHandleProvisionalLoadFailure(error));
RefPtr blockingContentFilter = m_blockingContentFilter.get();
ASSERT(blockingContentFilter);
RefPtr replacementData { blockingContentFilter->replacementData() };
ResourceResponse response { URL(), "text/html"_s, static_cast<long long>(replacementData->size()), "UTF-8"_s };
SubstituteData substituteData { WTF::move(replacementData), URL { error.failingURL() }, WTF::move(response), SubstituteData::SessionHistoryVisibility::Hidden };
SetForScope loadingBlockedPage { m_isLoadingBlockedPage, true };
if (RefPtr protectedClient = m_client.get())
protectedClient->handleProvisionalLoadFailureFromContentFilter(blockedPageURL(), WTF::move(substituteData));
}
void ContentFilter::deliverStoredResourceData()
{
for (auto& buffer : m_buffers)
deliverResourceData(Ref { *buffer.buffer });
m_buffers.clear();
}
#if HAVE(AUDIT_TOKEN)
void ContentFilter::setHostProcessAuditToken(const std::optional<audit_token_t>& token)
{
for (auto& contentFilter : m_contentFilters)
contentFilter->setHostProcessAuditToken(token);
}
#endif
#if HAVE(WEBCONTENTRESTRICTIONS)
bool ContentFilter::isWebContentRestrictionsUnblockURL(const URL& url)
{
#if PLATFORM(MAC)
// FIXME: Remove this when rdar://145714903 is fixed.
if (url.host() == "127.0.0.1"_s && url.path() == "/webcontentfilter.override.local"_s)
return true;
#endif
if (!url.protocolIs(ContentFilter::urlScheme()))
return false;
#if HAVE(WEBCONTENTRESTRICTIONS_ASK_TO)
static constexpr std::array validHosts { "unblock"_s, "present"_s, "ask"_s };
#else
static constexpr std::array validHosts { "unblock"_s };
#endif
for (const auto& host : validHosts) {
if (equalIgnoringASCIICase(url.host(), host))
return true;
}
return false;
}
#endif
} // namespace WebCore
#endif // ENABLE(CONTENT_FILTERING)