File: origin_matcher.h

package info (click to toggle)
chromium 138.0.7204.183-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-proposed-updates
  • size: 6,080,960 kB
  • sloc: cpp: 34,937,079; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,954; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,811; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (75 lines) | stat: -rw-r--r-- 2,291 bytes parent folder | download | duplicates (6)
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
// Copyright 2020 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_JS_INJECTION_COMMON_ORIGIN_MATCHER_H_
#define COMPONENTS_JS_INJECTION_COMMON_ORIGIN_MATCHER_H_

#include <memory>
#include <string>
#include <vector>

namespace url {
class Origin;
}  // namespace url

namespace js_injection {

class OriginMatcherRule;

// An url origin matcher allows wildcard subdomain matching. It supports two
// types of rules.
//
// (1) "*"
// A single * (without quote) will match any origin.
//
// (2) SCHEME "://" [ HOSTNAME_PATTERN ][":" PORT]
//
// SCHEME is required. When matching custom schemes, HOSTNAME_PATTERN and PORT
// shouldn't present. When SCHEME is "http" or "https", HOSTNAME_PATTERN is
// required.
//
// HOSTNAME_PATTERN allows wildcard '*' to match subdomains, such as
// "*.example.com". Rules such as "x.*.y.com", "*foobar.com" are not allowed.
// Note that "*.example.com" won't match "example.com", so need another rule
// "example.com" to match it. If the HOSTNAME_PATTERN is an IP literal, it
// will be used for exact matching.
//
// PORT is optional for "http" and "https" schemes, when it is not present, for
// "http" and "https" schemes, it will match default port number (80 and 443
// correspondingly).
class OriginMatcher {
 public:
  using RuleList = std::vector<std::unique_ptr<OriginMatcherRule>>;

  OriginMatcher();
  // Allow copy and assign.
  OriginMatcher(const OriginMatcher& rhs);
  OriginMatcher(OriginMatcher&&);
  OriginMatcher& operator=(const OriginMatcher& rhs);
  OriginMatcher& operator=(OriginMatcher&&);

  ~OriginMatcher();

  void SetRules(RuleList rules);

  // Adds a rule given by the string |raw|. Returns true if the rule was
  // successfully added.
  bool AddRuleFromString(const std::string& raw);

  // Returns true if the |origin| matches any rule in this matcher.
  bool Matches(const url::Origin& origin) const;

  // Returns the current list of rules.
  const RuleList& rules() const { return rules_; }

  // Returns string representation of this origin matcher.
  std::vector<std::string> Serialize() const;

 private:
  RuleList rules_;
};

}  // namespace js_injection

#endif  // COMPONENTS_JS_INJECTION_COMMON_ORIGIN_MATCHER_H_