Skip to content

Commit ccbee1a

Browse files
frank9524sebix
authored andcommitted
Add documentation for securitytxt bot
1 parent 0a38f2f commit ccbee1a

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

docs/user/bots.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3524,6 +3524,49 @@ to true.
35243524
(optional, boolean) Query for IPs at `https://stat.ripe.net/data/maxmind-geo-lite/data.json?resource=%s`. Defaults to
35253525
true.
35263526

3527+
---
3528+
3529+
### SecurityTXT <div id="intelmq.bots.experts.securitytxt.expert" />
3530+
3531+
SecurityTXT is an initiative to standardize how websites publish their abuse contact information. Currently it is a `draft RFC <https://datatracker.ietf.org/doc/html/draft-foudil-securitytxt-12>`_. See this draft RFC for more information on security.txt. This bot automatically looks for security.txt files on a URL or IP, retrieves the primary contact information out of it and adds this to the event.
3532+
3533+
**Requirements**
3534+
3535+
To use this bot, you need to install the required dependencies:
3536+
3537+
```bash
3538+
pip3 install -r intelmq/bots/experts/securitytxt/REQUIREMENTS.txt
3539+
```
3540+
3541+
**Module:** `intelmq.bots.experts.securitytxt.expert`
3542+
3543+
**Parameters (also expects [cache parameters](#cache-parameters)):**
3544+
3545+
**`url_field`**
3546+
3547+
The field in the event that contains the URL/IP on which to look for the the security.txt file.
3548+
3549+
**`contact_field`**
3550+
3551+
The field in the event in which to put the found contact details
3552+
3553+
**`only_email_address`**
3554+
3555+
Contact details can be web URLs or email addresses. When this value is set to True, it only selects email addresses as contact information.
3556+
3557+
**`overwrite`**
3558+
3559+
Boolean indicating whether to override existing data in contact_field
3560+
3561+
**`check_expired`**
3562+
3563+
Boolean indicating whether to check if the security.txt has expired according to its own expiry date
3564+
3565+
**`check_canonical`**
3566+
3567+
Boolean indicating whether to check if the url is contained in the list of canonical urls.
3568+
3569+
35273570
---
35283571

35293572
### Sieve <div id="intelmq.bots.experts.sieve.expert" />

0 commit comments

Comments
 (0)