Skip to content

Commit

Permalink
Add documentation for securitytxt bot
Browse files Browse the repository at this point in the history
  • Loading branch information
frank9524 authored and sebix committed Nov 30, 2024
1 parent 0a38f2f commit ccbee1a
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions docs/user/bots.md
Original file line number Diff line number Diff line change
Expand Up @@ -3524,6 +3524,49 @@ to true.
(optional, boolean) Query for IPs at `https://stat.ripe.net/data/maxmind-geo-lite/data.json?resource=%s`. Defaults to
true.

---

### SecurityTXT <div id="intelmq.bots.experts.securitytxt.expert" />

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.

**Requirements**

To use this bot, you need to install the required dependencies:

```bash
pip3 install -r intelmq/bots/experts/securitytxt/REQUIREMENTS.txt
```

**Module:** `intelmq.bots.experts.securitytxt.expert`

**Parameters (also expects [cache parameters](#cache-parameters)):**

**`url_field`**

The field in the event that contains the URL/IP on which to look for the the security.txt file.

**`contact_field`**

The field in the event in which to put the found contact details

**`only_email_address`**

Contact details can be web URLs or email addresses. When this value is set to True, it only selects email addresses as contact information.

**`overwrite`**

Boolean indicating whether to override existing data in contact_field

**`check_expired`**

Boolean indicating whether to check if the security.txt has expired according to its own expiry date

**`check_canonical`**

Boolean indicating whether to check if the url is contained in the list of canonical urls.


---

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

0 comments on commit ccbee1a

Please sign in to comment.