Skip to content

Commit 93633d2

Browse files
committed
docs: add secret file authentication documentation
1 parent c125352 commit 93633d2

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -234,6 +234,7 @@ CONFIGURATIONS:
234234
-tlsi, -tls-impersonate enable experimental client hello (ja3) tls randomization
235235
-no-stdin Disable Stdin processing
236236
-hae, -http-api-endpoint string experimental http api endpoint
237+
-sf, -secret-file string path to secret file for authentication
237238

238239
DEBUG:
239240
-health-check, -hc run diagnostic check up
@@ -284,6 +285,24 @@ For details about running httpx, see https://docs.projectdiscovery.io/tools/http
284285
- The `-no-fallback` flag can be used to probe and display both **HTTP** and **HTTPS** result.
285286
- Custom scheme for ports can be defined, for example `-ports http:443,http:80,https:8443`
286287
- Custom resolver supports multiple protocol (**doh|tcp|udp**) in form of `protocol:resolver:port` (e.g. `udp:127.0.0.1:53`)
288+
- Secret files can be used for domain-based authentication via `-sf secrets.yaml`. Supported auth types: `BasicAuth`, `BearerToken`, `Header`, `Cookie`, `Query`. Example:
289+
```yaml
290+
id: example-auth
291+
info:
292+
name: Example Auth Config
293+
static:
294+
- type: Header
295+
domains:
296+
- api.example.com
297+
headers:
298+
- key: X-API-Key
299+
value: secret-key-here
300+
- type: BasicAuth
301+
domains-regex:
302+
- ".*\\.internal\\.com$"
303+
username: admin
304+
password: secret
305+
```
287306
- The following flags should be used for specific use cases instead of running them as default with other probes:
288307
- `-ports`
289308
- `-path`

0 commit comments

Comments
 (0)