You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
When visiting a page that is suspect, but our certainty if the page is phishing is too low we'll show a banner on the page to warn users, if we're sure about the page being an AITM or phishing attack, we'll block the page entirely:
This too is completely brandable, and can be made to match company colours. The Contact Admin button is a mailto: link that contains the information about what page the user tried to visit, including a defanged URL.
61
+
This too is completely [brandable](settings/branding.md), and can be made to match company colours. The Contact Admin button is a mailto: link that contains the information about what page the user tried to visit, including a defanged URL.
Copy file name to clipboardExpand all lines: docs/advanced/creating-detection-rules.md
+11-7Lines changed: 11 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Creating Detection Rules
2
2
3
-
The extension uses a rule-driven architecture where all detection logic is defined in `rules/detection-rules.json`. This file contains:
3
+
The extension uses a rule-driven architecture where all detection logic is defined in [`rules/detection-rules.json`](https://github.com/CyberDrain/Check/blob/main/rules/detection-rules.json). This file contains:
4
4
5
5
-**Trusted domain patterns** - Microsoft domains that are always trusted
6
6
-**Exclusion system** - Domains that should never be scanned
@@ -13,16 +13,16 @@ Each of these rules has their own schema. You can create a custom rules file and
13
13
14
14
**Important:** After updating rules via the UI or changing custom URLs, reload any open tabs for changes to take effect on those pages. The extension loads rules at startup and on the configured interval.
15
15
16
-
Contributions to our rules can be done via [https://github.com/CyberDrain/Check/blob/main/rules/detection-rules.json](../../rules/detection-rules.json)
16
+
Contributions to our rules can be done via [https://github.com/CyberDrain/Check/blob/main/rules/detection-rules.json](https://github.com/CyberDrain/Check/blob/main/rules/detection-rules.json)
17
17
18
18
## Rule Configuration and Updates
19
19
20
-
Rules are managed by the `DetectionRulesManager` class in `scripts/modules/detection-rules-manager.js`. The manager:
20
+
Rules are managed by the [`DetectionRulesManager`](https://github.com/CyberDrain/Check/blob/main/scripts/modules/detection-rules-manager.js) class. It's job is to:
21
21
22
-
-Loads rules at extension startup
23
-
-Checks for updates based on the configured interval (default: 24 hours)
24
-
-Caches rules locally in browser storage for offline use
25
-
-Falls back to local rules (`rules/detection-rules.json`) if remote fetch fails
22
+
-Load rules at extension startup
23
+
-Check for updates based on the configured interval (default: 24 hours)
24
+
-Cache rules locally in browser storage for offline use
25
+
-Fall back to local rules ([`rules/detection-rules.json`](https://github.com/CyberDrain/Check/blob/main/rules/detection-rules.json)) if remote fetch fails
26
26
27
27
**Update Process:**
28
28
@@ -33,6 +33,10 @@ Rules are managed by the `DetectionRulesManager` class in `scripts/modules/detec
33
33
34
34
## Exclusions
35
35
36
+
{% hint style="info" %}
37
+
**For simple exclusions:** Most users should use the [Settings → Detection Rules](../settings/detection-rules.md#url-allowlist-regex-or-url-with-wildcards) UI field, which supports both wildcards and regex patterns. This section is for advanced users creating custom rule files.
38
+
{% endhint %}
39
+
36
40
To exclude domains from all scanning (complete bypass), add them to the `exclusion_system.domain_patterns` array:
Copy file name to clipboardExpand all lines: docs/settings/activity-logs.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -103,7 +103,7 @@ You tried to log into Office 365 but got blocked. Looking at logs:Timestamp:
103
103
1. Check "Enable Debug Logging"
104
104
2. Reproduce the problem
105
105
3. Export logs (see below)
106
-
4. Send logs to support
106
+
4. Send logs to support (see [Common Issues](../troubleshooting/common-issues.md) for additional troubleshooting steps)
107
107
5. Uncheck debug logging when done (saves storage space)
108
108
109
109
**For admins wanting to simulate end-user experience**
@@ -147,12 +147,12 @@ You tried to log into Office 365 but got blocked. Looking at logs:Timestamp:
147
147
2. Go to Activity Logs
148
148
3. Look for "Threat Blocked" entries around that time
149
149
4. Click the entry to see why it was blocked
150
-
5. If you think it was blocked incorrectly, contact support with the log details
150
+
5. If you think it was blocked incorrectly, contact support with the log details or check [Common Issues](../troubleshooting/common-issues.md) for known problems
151
151
152
152
**Scenario 3: Preparing for support**
153
153
154
154
1. Enable debug logging
155
155
2. Try to reproduce the problem
156
156
3. Export logs immediately after the problem occurs
157
157
4. Disable debug logging
158
-
5. Send the exported file to support
158
+
5. Send the exported file to support or check [Common Issues](../troubleshooting/common-issues.md) first
Copy file name to clipboardExpand all lines: docs/settings/detection-rules.md
+22-1Lines changed: 22 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,11 +33,32 @@ Controls how often Check fetches updated detection rules. The default is 24 hour
33
33
34
34
### **URL Allowlist (Regex or URL with wildcards)**
35
35
36
-
Add URLs or patterns that should be excluded from phishing detection. This is useful for internal company sites or trusted third-party services that might trigger false positives. You can use:
36
+
{% hint style="info" %}
37
+
**Need to allowlist a phishing training service?**
38
+
39
+
MSPs and IT departments commonly need to exclude phishing training platforms (like KnowBe4, Proofpoint, etc.) from detection. Check [Advanced → Creating Detection Rules](../advanced/creating-detection-rules.md#exclusions) for technical details.
40
+
{% endhint %}
41
+
42
+
Add URLs or patterns that should be excluded from phishing detection. This is useful for internal company sites or trusted third-party services that might trigger false positives.
43
+
44
+
**How it works:** Your allowlist patterns are **added to** (not replacing) the default CyberDrain exclusions, providing additional protection without losing baseline coverage.
45
+
46
+
You can use:
37
47
38
48
-**Simple URLs with wildcards:**`https://google.com/*` or `https://*.microsoft.com/*`
Copy file name to clipboardExpand all lines: docs/settings/general.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,6 +14,8 @@ This is Check's main job - blocking dangerous websites. When this is turned on (
14
14
15
15
CIPP is a system that IT professionals use to monitor security across multiple organizations. Enabling CIPP monitoring allows you to send detection information from Check directly to CIPP, thus allowing you to alert and report on what's happening with your endpoints. When enabled, you would configure the CIPP Server URL and Tenant ID/Domain below.
16
16
17
+
View CIPP reporting activity in the [Activity Logs](activity-logs.md) section.
18
+
17
19
### **CIPP Server URL**
18
20
19
21
Enter the base URL of your CIPP server for reporting Microsoft 365 logon detections. This should be the full URL to your CIPP instance (e.g., `https://your-cipp-server.com`). This field is only active when CIPP Reporting is enabled.
@@ -24,6 +26,8 @@ Enter your tenant identifier to include with CIPP alerts for multi-tenant enviro
24
26
25
27
{% hint style="info" %}
26
28
Currently, CIPP displays these alerts in the logbook. Future updates to CIPP are planned to provide additional functionality. Keep an eye on the CIPP release notes for more updates!
29
+
30
+
You can monitor CIPP reporting status and activity in [Activity Logs](activity-logs.md).
Copy file name to clipboardExpand all lines: docs/troubleshooting/common-issues.md
+13-9Lines changed: 13 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,29 +4,33 @@
4
4
5
5
<summary>Policies not appearing in Group Policy Management Console</summary>
6
6
7
-
* Verify ADMX/ADML files are in correct location
7
+
- Verify ADMX/ADML files are in correct location (see [Windows deployment docs](../deployment/chrome-edge-deployment-instructions/windows/README.md))
8
8
9
-
- Ensure files are not blocked (right-click > Properties > Unblock)
10
-
- Refresh Group Policy Editor
9
+
* Ensure files are not blocked (right-click > Properties > Unblock)
10
+
* Refresh Group Policy Editor
11
+
12
+
For complete deployment instructions, see [Domain Deployment guide](../deployment/chrome-edge-deployment-instructions/windows/domain-deployment.md).
11
13
12
14
</details>
13
15
14
16
<details>
15
17
16
18
<summary>Policies not applying to extension</summary>
17
19
18
-
* Check registry values are present
19
-
* Restart browser after policy changes
20
-
* Verify extension has necessary permissions
20
+
- Check registry values are present (see [Manual Deployment guide](../deployment/chrome-edge-deployment-instructions/windows/manual-deployment.md))
21
+
- Restart browser after policy changes
22
+
- Verify extension has necessary permissions
23
+
24
+
For troubleshooting policy deployment, consult the [Windows deployment documentation](../deployment/chrome-edge-deployment-instructions/windows/README.md).
21
25
22
26
</details>
23
27
24
28
<details>
25
29
26
30
<summary>Custom branding not working</summary>
27
31
28
-
* Verify URLs are accessible via HTTPS
29
-
* Check image formats are supported (PNG, JPG, SVG)
30
-
* Ensure color codes are valid hex format
32
+
- Verify URLs are accessible via HTTPS
33
+
- Check image formats are supported (PNG, JPG, SVG)
Instructions for how to spin up Evilginx 3.0 can be found via [this blog post from Jan Bakker](https://janbakker.tech/running-evilginx-3-0-on-windows/).
0 commit comments