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
|
// Copyright 2019 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef EXTENSIONS_BROWSER_API_DECLARATIVE_NET_REQUEST_RULESET_MATCHER_BASE_H_
#define EXTENSIONS_BROWSER_API_DECLARATIVE_NET_REQUEST_RULESET_MATCHER_BASE_H_
#include <map>
#include <optional>
#include <vector>
#include "content/public/browser/global_routing_id.h"
#include "extensions/browser/api/declarative_net_request/constants.h"
#include "extensions/browser/api/declarative_net_request/flat/extension_ruleset_generated.h"
#include "extensions/browser/api/declarative_net_request/request_action.h"
#include "extensions/common/api/declarative_net_request/constants.h"
#include "extensions/common/extension_id.h"
class GURL;
namespace content {
class NavigationHandle;
class RenderFrameHost;
} // namespace content
namespace extensions::declarative_net_request {
struct RequestParams;
// An abstract class for rule matchers. Overridden by different kinds of
// matchers, e.g. filter lists and regex.
class RulesetMatcherBase {
public:
RulesetMatcherBase(const ExtensionId& extension_id, RulesetID ruleset_id);
RulesetMatcherBase(const RulesetMatcherBase&) = delete;
RulesetMatcherBase& operator=(const RulesetMatcherBase&) = delete;
virtual ~RulesetMatcherBase();
// Returns the ruleset's highest priority matching RequestAction for the
// given ruleset matching `stage`, or std::nullopt if the ruleset has no
// matching rule. Also takes into account any matching allowAllRequests rules
// for the ancestor frames.
std::optional<RequestAction> GetAction(const RequestParams& params,
RulesetMatchingStage stage) const;
// Returns a vector of RequestAction for all matching modifyHeaders rules
// with priority greater than `min_priority` if specified.
virtual std::vector<RequestAction> GetModifyHeadersActions(
const RequestParams& params,
RulesetMatchingStage stage,
std::optional<uint64_t> min_priority) const = 0;
// Returns whether this modifies "extraHeaders".
virtual bool IsExtraHeadersMatcher() const = 0;
// Returns the number of rules in this matcher.
virtual size_t GetRulesCount() const = 0;
// Returns the number of rules to be matched in the onBeforeRequest phase in
// this matcher.
virtual size_t GetBeforeRequestRulesCount() const = 0;
// Returns the number of rules to be matched in the onHeadersReceived phase in
// this matcher.
virtual size_t GetHeadersReceivedRulesCount() const = 0;
// Returns the extension ID with which this matcher is associated.
const ExtensionId& extension_id() const { return extension_id_; }
// The ruleset ID of the matcher.
RulesetID ruleset_id() const { return ruleset_id_; }
void OnRenderFrameCreated(content::RenderFrameHost* host);
void OnRenderFrameDeleted(content::RenderFrameHost* host);
void OnDidFinishNavigation(content::NavigationHandle* navigation_handle);
// Returns the tracked highest priority matching allowsAllRequests action, if
// any, for `host`.
std::optional<RequestAction> GetAllowlistedFrameActionForTesting(
content::RenderFrameHost* host) const;
protected:
using ExtensionMetadataList =
::flatbuffers::Vector<flatbuffers::Offset<flat::UrlRuleMetadata>>;
// Helper to create a RequestAction of type `BLOCK` or `COLLAPSE`.
RequestAction CreateBlockOrCollapseRequestAction(
const RequestParams& params,
const url_pattern_index::flat::UrlRule& rule) const;
// Helper to create a RequestAction of type `ALLOW`.
RequestAction CreateAllowAction(
const RequestParams& params,
const url_pattern_index::flat::UrlRule& rule) const;
// Helper to create a RequestAction of type `ALLOW_ALL_REQUESTS`.
RequestAction CreateAllowAllRequestsAction(
const RequestParams& params,
const url_pattern_index::flat::UrlRule& rule) const;
// Helper to create a RequestAction of type `REDIRECT` with the request
// upgraded. Returns std::nullopt if the request is not upgradeable.
std::optional<RequestAction> CreateUpgradeAction(
const RequestParams& params,
const url_pattern_index::flat::UrlRule& rule) const;
// Helpers to create a RequestAction of type `REDIRECT` with the appropriate
// redirect url. Can return std::nullopt if the redirect url is ill-formed or
// same as the current request url.
std::optional<RequestAction> CreateRedirectActionFromMetadata(
const RequestParams& params,
const url_pattern_index::flat::UrlRule& rule,
const ExtensionMetadataList& metadata_list) const;
std::optional<RequestAction> CreateRedirectAction(
const RequestParams& params,
const url_pattern_index::flat::UrlRule& rule,
GURL redirect_url) const;
// Helper to create a list of RequestActions of type `MODIFY_HEADERS` with the
// appropriate list of headers for each action.
std::vector<RequestAction> GetModifyHeadersActionsFromMetadata(
const RequestParams& params,
const std::vector<const url_pattern_index::flat::UrlRule*>& rules,
const ExtensionMetadataList& metadata_list) const;
private:
// Returns the ruleset's highest priority matching allowAllRequests action or
// std::nullopt if there is no corresponding matching rule. Only takes into
// account the request `params` passed in. This doesn't take any account any
// matching allowAllRequests rules for ancestor frames.
virtual std::optional<RequestAction> GetAllowAllRequestsAction(
const RequestParams& params,
RulesetMatchingStage stage) const = 0;
// Returns the ruleset's highest priority matching RequestAction for the
// specified ruleset matching `stage`, or std::nullopt if the ruleset has no
// matching rule. This doesn't take any account any matching allowAllRequests
// rules for ancestor frames.
virtual std::optional<RequestAction> GetActionIgnoringAncestors(
const RequestParams& params,
RulesetMatchingStage stage) const = 0;
RequestAction CreateRequestAction(
RequestAction::Type type,
const url_pattern_index::flat::UrlRule& rule) const;
// Returns the matching RequestAction from `allowlisted_frames_` or
// std::nullopt if none is found.
std::optional<RequestAction> GetAllowlistedFrameAction(
content::GlobalRenderFrameHostId frame_id) const;
const ExtensionId extension_id_;
const RulesetID ruleset_id_;
// Stores the IDs for the RenderFrameHosts which are allow-listed due to an
// allowAllRequests action and the corresponding highest priority
// RequestAction.
std::map<content::GlobalRenderFrameHostId, const RequestAction>
allowlisted_frames_;
};
} // namespace extensions::declarative_net_request
#endif // EXTENSIONS_BROWSER_API_DECLARATIVE_NET_REQUEST_RULESET_MATCHER_BASE_H_
|
