@adguard/dnr-converter 1.0.0-alpha.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +476 -0
- package/dist/cli.cjs +58912 -0
- package/dist/constants.js +23 -0
- package/dist/declarative-rule/declarative-rule.js +15 -0
- package/dist/declarative-rule/header-info.js +12 -0
- package/dist/declarative-rule/modify-header-info.js +31 -0
- package/dist/declarative-rule/query-key-value.js +12 -0
- package/dist/declarative-rule/query-transform.js +12 -0
- package/dist/declarative-rule/redirect.js +14 -0
- package/dist/declarative-rule/rule-action.js +44 -0
- package/dist/declarative-rule/rule-condition.js +77 -0
- package/dist/declarative-rule/url-transform.js +30 -0
- package/dist/errors/conversion-errors/empty-domains-error.js +24 -0
- package/dist/errors/conversion-errors/empty-resources-error.js +24 -0
- package/dist/errors/conversion-errors/index.js +17 -0
- package/dist/errors/conversion-errors/invalid-declarative-rule-error.js +22 -0
- package/dist/errors/conversion-errors/unsupported-modifier-error.js +20 -0
- package/dist/errors/conversion-errors/unsupported-regexp-error.js +27 -0
- package/dist/errors/converter-options-errors/empty-or-negative-number-of-rules-error.js +18 -0
- package/dist/errors/converter-options-errors/index.js +15 -0
- package/dist/errors/converter-options-errors/negative-number-of-rules-error.js +18 -0
- package/dist/errors/converter-options-errors/resources-path-error.js +18 -0
- package/dist/errors/limitation-errors/index.js +17 -0
- package/dist/errors/limitation-errors/max-scanned-rules-error.js +20 -0
- package/dist/errors/limitation-errors/too-many-error.js +28 -0
- package/dist/errors/limitation-errors/too-many-regexp-rules-error.js +25 -0
- package/dist/errors/limitation-errors/too-many-rules-error.js +25 -0
- package/dist/errors/limitation-errors/too-many-unsafe-rules-error.js +25 -0
- package/dist/errors/unavailable-sources-errors/unavailable-filter-source-error.js +21 -0
- package/dist/errors/unavailable-sources-errors/unavailable-ruleset-source-error.js +21 -0
- package/dist/filter/filter.js +92 -0
- package/dist/filter-converter/filter-converter.js +385 -0
- package/dist/grouped-rules-converters/url-transform-converter.js +340 -0
- package/dist/index.js +30 -0
- package/dist/package.json.js +3 -0
- package/dist/re2-regexp/re2-validator.js +37 -0
- package/dist/re2-regexp/regex-validator-extension.js +30 -0
- package/dist/re2.wasm +0 -0
- package/dist/rule/option-names.js +65 -0
- package/dist/rule/rule-badfilter.js +81 -0
- package/dist/rule/rule-priority.js +88 -0
- package/dist/rule/rule-validator.js +455 -0
- package/dist/rule/rule.js +853 -0
- package/dist/rule/string-utils.js +49 -0
- package/dist/rule-converters/csp-converter.js +105 -0
- package/dist/rule-converters/regular-rule-converter.js +789 -0
- package/dist/rule-converters/remove-header-converter.js +97 -0
- package/dist/rule-converters/rules-converter.js +365 -0
- package/dist/rule-converters/rules-grouper.js +75 -0
- package/dist/rules-scanner/rules-scanner.js +136 -0
- package/dist/ruleset/metadata-rule.js +35 -0
- package/dist/ruleset/metadata-ruleset.js +162 -0
- package/dist/ruleset/rules-hash-map.js +71 -0
- package/dist/ruleset/ruleset-with-source-map.js +406 -0
- package/dist/ruleset/ruleset.js +54 -0
- package/dist/ruleset/source-map.js +283 -0
- package/dist/types/cli/convert-filters.d.ts +32 -0
- package/dist/types/cli/index.d.ts +7 -0
- package/dist/types/cli/utils.d.ts +19 -0
- package/dist/types/src/declarative-rule/declarative-rule.d.ts +32 -0
- package/dist/types/src/declarative-rule/header-info.d.ts +31 -0
- package/dist/types/src/declarative-rule/modify-header-info.d.ts +46 -0
- package/dist/types/src/declarative-rule/query-key-value.d.ts +24 -0
- package/dist/types/src/declarative-rule/query-transform.d.ts +21 -0
- package/dist/types/src/declarative-rule/redirect.d.ts +32 -0
- package/dist/types/src/declarative-rule/rule-action.d.ts +68 -0
- package/dist/types/src/declarative-rule/rule-condition.d.ts +262 -0
- package/dist/types/src/declarative-rule/url-transform.d.ts +69 -0
- package/dist/types/src/errors/conversion-errors/empty-domains-error.d.ts +21 -0
- package/dist/types/src/errors/conversion-errors/empty-resources-error.d.ts +21 -0
- package/dist/types/src/errors/conversion-errors/index.d.ts +27 -0
- package/dist/types/src/errors/conversion-errors/invalid-declarative-rule-error.d.ts +30 -0
- package/dist/types/src/errors/conversion-errors/unsupported-modifier-error.d.ts +20 -0
- package/dist/types/src/errors/conversion-errors/unsupported-regexp-error.d.ts +23 -0
- package/dist/types/src/errors/converter-options-errors/empty-or-negative-number-of-rules-error.d.ts +13 -0
- package/dist/types/src/errors/converter-options-errors/index.d.ts +23 -0
- package/dist/types/src/errors/converter-options-errors/negative-number-of-rules-error.d.ts +13 -0
- package/dist/types/src/errors/converter-options-errors/resources-path-error.d.ts +13 -0
- package/dist/types/src/errors/limitation-errors/index.d.ts +27 -0
- package/dist/types/src/errors/limitation-errors/max-scanned-rules-error.d.ts +18 -0
- package/dist/types/src/errors/limitation-errors/too-many-error.d.ts +33 -0
- package/dist/types/src/errors/limitation-errors/too-many-regexp-rules-error.d.ts +21 -0
- package/dist/types/src/errors/limitation-errors/too-many-rules-error.d.ts +21 -0
- package/dist/types/src/errors/limitation-errors/too-many-unsafe-rules-error.d.ts +21 -0
- package/dist/types/src/errors/unavailable-sources-errors/unavailable-filter-source-error.d.ts +19 -0
- package/dist/types/src/errors/unavailable-sources-errors/unavailable-ruleset-source-error.d.ts +19 -0
- package/dist/types/src/filter/filter.d.ts +74 -0
- package/dist/types/src/filter/types.d.ts +45 -0
- package/dist/types/src/filter-converter/conversion-result.d.ts +35 -0
- package/dist/types/src/filter-converter/filter-converter-options.d.ts +81 -0
- package/dist/types/src/filter-converter/filter-converter.d.ts +197 -0
- package/dist/types/src/index.d.ts +37 -0
- package/dist/types/src/rule/rule-types.d.ts +33 -0
- package/dist/types/src/rule/rule-validator.d.ts +185 -0
- package/dist/types/src/rule/rule.d.ts +269 -0
- package/dist/types/src/ruleset/metadata-ruleset.d.ts +128 -0
- package/dist/types/src/ruleset/rules-hash-map.d.ts +70 -0
- package/dist/types/src/ruleset/ruleset-with-source-map.d.ts +318 -0
- package/dist/types/src/ruleset/ruleset.d.ts +86 -0
- package/dist/types/src/ruleset/source-map.d.ts +45 -0
- package/dist/types/src/ruleset/types.d.ts +68 -0
- package/dist/types/src/utils/is-safe-rule.d.ts +20 -0
- package/dist/types/src/utils/ruleset-utils.d.ts +45 -0
- package/dist/types/src/version.d.ts +6 -0
- package/dist/url-transform-converter.js +338 -0
- package/dist/utils/error.js +22 -0
- package/dist/utils/is-safe-rule.js +25 -0
- package/dist/utils/lazy-loader.js +116 -0
- package/dist/utils/lazy.js +50 -0
- package/dist/utils/ruleset-utils.js +76 -0
- package/dist/utils/string.js +180 -0
- package/dist/utils/valibot.js +74 -0
- package/dist/version.js +7 -0
- package/package.json +122 -0
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @file Utility functions for comparing string arrays.
|
|
3
|
+
*/ /**
|
|
4
|
+
* Checks whether two nullable string arrays are equal (same elements in same order).
|
|
5
|
+
* Both `null` is considered equal.
|
|
6
|
+
*
|
|
7
|
+
* @param left First array or `null`.
|
|
8
|
+
* @param right Second array or `null`.
|
|
9
|
+
*
|
|
10
|
+
* @returns `true` when both are `null` or both arrays have the same elements in the same order.
|
|
11
|
+
*/ function stringArraysEqual(left, right) {
|
|
12
|
+
if (left === null && right === null) {
|
|
13
|
+
return true;
|
|
14
|
+
}
|
|
15
|
+
if (left === null || right === null) {
|
|
16
|
+
return false;
|
|
17
|
+
}
|
|
18
|
+
if (left.length !== right.length) {
|
|
19
|
+
return false;
|
|
20
|
+
}
|
|
21
|
+
for(let i = 0; i < left.length; i += 1){
|
|
22
|
+
if (left[i] !== right[i]) {
|
|
23
|
+
return false;
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
return true;
|
|
27
|
+
}
|
|
28
|
+
/**
|
|
29
|
+
* Checks whether two nullable string arrays share at least one element.
|
|
30
|
+
* `null` on either side is treated as a wildcard (no filter applied), so the
|
|
31
|
+
* function returns `true` whenever at least one side is `null`.
|
|
32
|
+
*
|
|
33
|
+
* This matches the tsurlfilter semantics used in `negatesBadfilter()`: a
|
|
34
|
+
* `$badfilter` rule without a `$domain` modifier (`null`) should cancel a
|
|
35
|
+
* target rule that has `$domain=x.com`, because the badfilter's domain list
|
|
36
|
+
* is unrestricted.
|
|
37
|
+
*
|
|
38
|
+
* @param left First array or `null`.
|
|
39
|
+
* @param right Second array or `null`.
|
|
40
|
+
*
|
|
41
|
+
* @returns `true` when either side is `null`, or at least one common element exists.
|
|
42
|
+
*/ function stringArraysHaveIntersection(left, right) {
|
|
43
|
+
if (left === null || right === null) {
|
|
44
|
+
return true;
|
|
45
|
+
}
|
|
46
|
+
return new Set(left).intersection(new Set(right)).size > 0;
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
export { stringArraysEqual, stringArraysHaveIntersection };
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
import { CSP_HEADER_NAME } from '../constants.js';
|
|
2
|
+
import { RegularRuleConverter } from './regular-rule-converter.js';
|
|
3
|
+
|
|
4
|
+
/**
|
|
5
|
+
* Describes how to convert `$csp` rules.
|
|
6
|
+
*
|
|
7
|
+
* @see {@link RegularRuleConverter} parent class.
|
|
8
|
+
*/ class CspConverter extends RegularRuleConverter {
|
|
9
|
+
/**
|
|
10
|
+
* Creates rule template for grouping similar `$csp` rules.
|
|
11
|
+
*
|
|
12
|
+
* @param rule {@link DeclarativeRule} to create template from.
|
|
13
|
+
*
|
|
14
|
+
* @returns Stringified rule template.
|
|
15
|
+
*/ static createRuleTemplate(rule) {
|
|
16
|
+
/**
|
|
17
|
+
* Deep copy to drop references to source rule.
|
|
18
|
+
*
|
|
19
|
+
* Note: `Partial` type is used because we need to delete some fields,
|
|
20
|
+
* but we cannot mark them as optional in the parent type.
|
|
21
|
+
*/ const template = JSON.parse(JSON.stringify(rule));
|
|
22
|
+
/**
|
|
23
|
+
* Remove ID field from the template as it is unique
|
|
24
|
+
* per rule and should not be used for grouping.
|
|
25
|
+
* Also remove value of the CSP header as they
|
|
26
|
+
* may differ between rules but still should be grouped together.
|
|
27
|
+
*
|
|
28
|
+
* Note: Converted `$csp` rules contain only one response headers action.
|
|
29
|
+
*/ delete template.id;
|
|
30
|
+
delete template.action?.responseHeaders?.[0].value;
|
|
31
|
+
return JSON.stringify(template);
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* Finds CSP header in the provided header info.
|
|
35
|
+
*
|
|
36
|
+
* @param modifyHeaderInfo Modify header info to check.
|
|
37
|
+
*
|
|
38
|
+
* @returns `true` if the header is CSP header, `false` otherwise.
|
|
39
|
+
*/ static isCspHeader(modifyHeaderInfo) {
|
|
40
|
+
return modifyHeaderInfo.header === CSP_HEADER_NAME;
|
|
41
|
+
}
|
|
42
|
+
/**
|
|
43
|
+
* Combines two similar `$csp` {@link DeclarativeRule}
|
|
44
|
+
* rules into one by merging their CSP header values.
|
|
45
|
+
*
|
|
46
|
+
* @param sourceRule The source rule to merge into.
|
|
47
|
+
* @param ruleToMerge The rule to merge into the source rule.
|
|
48
|
+
*
|
|
49
|
+
* @returns The combined {@link DeclarativeRule}.
|
|
50
|
+
*/ static combineRulePair(sourceRule, ruleToMerge) {
|
|
51
|
+
// Deep copy to drop references to source rule
|
|
52
|
+
const resultRule = JSON.parse(JSON.stringify(sourceRule));
|
|
53
|
+
// If the headers are empty in the rule to merge, do not take any action
|
|
54
|
+
const { responseHeaders: headersToMerge } = ruleToMerge.action;
|
|
55
|
+
if (!headersToMerge || headersToMerge.length === 0) {
|
|
56
|
+
return resultRule;
|
|
57
|
+
}
|
|
58
|
+
// Try to find CSP header in the rule to merge - if not found, do not take any action
|
|
59
|
+
let cspHeaderInfoToMerge = headersToMerge.find(CspConverter.isCspHeader);
|
|
60
|
+
if (!cspHeaderInfoToMerge) {
|
|
61
|
+
return resultRule;
|
|
62
|
+
}
|
|
63
|
+
// Deep copy to avoid reference issues
|
|
64
|
+
cspHeaderInfoToMerge = JSON.parse(JSON.stringify(cspHeaderInfoToMerge));
|
|
65
|
+
/**
|
|
66
|
+
* Check if the headers are empty in the result rule:
|
|
67
|
+
* - if `true` - try to add CSP header if it exists in the result rule;
|
|
68
|
+
* - if `false` - create new response headers array with only CSP header.
|
|
69
|
+
*/ const { responseHeaders: resultHeaders } = resultRule.action;
|
|
70
|
+
if (resultHeaders && resultHeaders.length > 0) {
|
|
71
|
+
// Try to find CSP header in the result rule - if not found, do not take any action
|
|
72
|
+
const cspHeaderIndex = resultHeaders.findIndex(CspConverter.isCspHeader);
|
|
73
|
+
if (cspHeaderIndex === -1) {
|
|
74
|
+
return resultRule;
|
|
75
|
+
}
|
|
76
|
+
/**
|
|
77
|
+
* Check if the CSP header value is already set in the result rule:
|
|
78
|
+
* - if `true` - append value from the rule to merge;
|
|
79
|
+
* - if `false` - set value from the rule to merge.
|
|
80
|
+
*/ const cspHeaderValue = resultHeaders[cspHeaderIndex].value;
|
|
81
|
+
if (cspHeaderValue) {
|
|
82
|
+
resultHeaders[cspHeaderIndex].value = `${cspHeaderValue}; ${cspHeaderInfoToMerge.value}`;
|
|
83
|
+
} else {
|
|
84
|
+
resultHeaders[cspHeaderIndex].value = cspHeaderInfoToMerge.value;
|
|
85
|
+
}
|
|
86
|
+
} else {
|
|
87
|
+
resultRule.action.responseHeaders = [
|
|
88
|
+
cspHeaderInfoToMerge
|
|
89
|
+
];
|
|
90
|
+
}
|
|
91
|
+
return resultRule;
|
|
92
|
+
}
|
|
93
|
+
/**
|
|
94
|
+
* Groups converted `$csp` rules by merging rules with identical conditions.
|
|
95
|
+
*
|
|
96
|
+
* @param converted Converted rules before grouping.
|
|
97
|
+
*
|
|
98
|
+
* @returns Converted rules after grouping.
|
|
99
|
+
*/ // eslint-disable-next-line class-methods-use-this -- template method override
|
|
100
|
+
groupConverted(converted) {
|
|
101
|
+
return RegularRuleConverter.groupConvertedRules(converted, CspConverter.createRuleTemplate, CspConverter.combineRulePair);
|
|
102
|
+
}
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
export { CspConverter };
|