Skip to content

Add support for regular expressions in $app modifier #714

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/general/ad-filtering/create-own-filters.md
Original file line number Diff line number Diff line change
Expand Up @@ -435,10 +435,20 @@ If you want the rule not to be applied to certain apps, start the app name with
- `||baddomain.com^$app=~org.example.app` — a rule to block requests that match the specified mask and are sent from any app except for the `org.example.app`.
- `||baddomain.com^$app=~org.example.app1|~org.example.app2` — same as above, but now two apps are excluded: `org.example.app1` and `org.example.app2`.

You can use regular expressions in the `$app` modifier by enclosing them in forward slashes `/.../`. This allows for more flexible matching — for example, targeting a group of apps from the same publisher or matching complex patterns.

- `||baddomain.com^$app=/org\.example\.[a-z0-9_]+/` — applies to all apps whose package name starts with `org.example` (e.g. `org.example.app1`, `org.example.utility`, etc.).
- `||baddomain.com^$app=/^org\.example\.app$|^org\.example\.[ab].*/` — applies to `org.example.app` and to any app whose package starts with `org.example.a` or `org.example.b`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

$ and , should be escaped in modifiers, since unescaped $ means modifiers start, and , is modifiers separator.


The `$app` modifier supports combining plain app names, negated app names, and regular expressions in the same rule.

- `||baddomain.com^$app=org.example.app|~org.example.excluded|/org\.example\.[a-z]+/` — applies to `org.example.app`, to all matching `org.example.[a-z]+` apps, and excludes `org.example.excluded`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A negation and a non-negated expression cannot be in the same expression, because ~ essentially matches "everything except", and can only be combined with other ~ expressions to expand that "except". Otherwise, it leads to too many possible interpretations.


:::caution Restrictions

Apps in the modifier value cannot have a wildcard, e.g. `$app=com.*.music`.
Rules with such modifier are considered invalid.
Use regular expressions instead: `$app=/com\..*\.music/`.

:::

Expand Down