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
Copy file name to clipboardExpand all lines: README.md
+22Lines changed: 22 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -55,6 +55,18 @@ GitLab Watchman can enumerate potentially useful information from a GitLab insta
55
55
### Signatures
56
56
GitLab Watchman uses custom YAML signatures to detect matches in GitLab. These signatures are pulled from the central [Watchman Signatures repository](https://github.com/PaperMtn/watchman-signatures). Slack Watchman automatically updates its signature base at runtime to ensure its using the latest signatures to detect secrets.
57
57
58
+
#### Suppressing Signatures
59
+
You can define signatures that you want to disable when running GitLab Watchman by adding their IDs to the `disabled_signatures` section of the `watchman.conf` file. For example:
60
+
61
+
```yaml
62
+
gitlab_watchman:
63
+
disabled_signatures:
64
+
- tokens_generic_bearer_tokens
65
+
- tokens_generic_access_tokens
66
+
```
67
+
68
+
You can find the ID of a signature in the individual YAML files in [Watchman Signatures repository](https://github.com/PaperMtn/watchman-signatures).
69
+
58
70
### Logging
59
71
60
72
GitLab Watchman gives the following logging options:
@@ -106,6 +118,16 @@ You also need to provide the URL of your GitLab instance.
106
118
#### Providing token & URL
107
119
GitLab Watchman will get the GitLab token and URL from the environment variables `GITLAB_WATCHMAN_TOKEN` and `GITLAB_WATCHMAN_URL`.
108
120
121
+
### watchman.conf file
122
+
Configuration options can be passed in a file named `watchman.conf` which must be stored in your home directory. The file should follow the YAML format, and should look like below:
123
+
```yaml
124
+
gitlab_watchman:
125
+
disabled_signatures:
126
+
- tokens_generic_bearer_tokens
127
+
- tokens_generic_access_tokens
128
+
```
129
+
GitLab Watchman will look for this file at runtime, and use the configuration options from here.
130
+
109
131
## Installation
110
132
You can install the latest stable version via pip:
0 commit comments