Merge pull request #778 from crowdsecurity/add-ipdex-documentation

Add ipdex documentation

Author: AlteredCoder

crowdsec-docs/sidebarsUnversioned.js

@@ -37,6 +37,7 @@ module.exports = {
                 id: "cti_api/integration_intro",
             },
             items: [
+                "cti_api/integration_ipdex",
                 "cti_api/integration_chrome",
                 "cti_api/integration_gigasheet",
                 "cti_api/integration_intelowl",

crowdsec-docs/static/img/ipdex/ipdex_ip.png

@@ -48,6 +48,8 @@ On the next page you can create an API key by clicking the `+ New Key` button.
 
 ## Accessing the API
 
+### cURL
+
 You can test your newly created API key by running the following command in your terminal:
 
 :::info
@@ -216,6 +218,69 @@ And the default output looks something like this:
 
 </details>
 
+### ipdex
+
+You can interact with the CrowdSec CTI API with the [`ipdex`](https://github.com/crowdsecurity/ipdex) tool.
+
+First, initiliaze the tool with your API key:
+
+```console
+ipdex init
+```
+
+And then analyze an IP or a file of IPs:
+
+```console
+ipdex 193.105.134.155
+```
+
+<details>
+
+<summary>Command Output</summary>
+
+```console
+IP Information
+
+IP                       	193.105.134.155
+Reputation               	malicious
+Confidence               	high
+Country                  	SE 🇸🇪
+Autonomous System        	w1n ltd
+Reverse DNS              	N/A
+Range                    	193.105.134.0/24
+First Seen               	2023-06-23T01:15:00
+Last Seen                	2025-05-11T11:15:00
+Console URL              	https://app.crowdsec.net/cti/193.105.134.155
+Last Local Refresh       	2025-05-12 16:44:21
+
+Threat Information
+
+Behaviors
+                         	HTTP Scan
+                         	HTTP Bruteforce
+                         	SSH Bruteforce
+                         	... and 2 more
+
+
+Classifications
+                         	Spoofed User Agent
+                         	TOR exit node
+                         	VPN or Proxy
+                         	... and 1 more
+
+
+Blocklists
+                         	Extended AI-Detected VPN/Proxy
+                         	CrowdSec Intelligence Blocklist
+
+Target countries
+     🇺🇸 US             		29%
+     🇩🇪 DE             		15%
+     🇵🇱 PL             		12%
+                         	... and 2 more
+```
+</details>
+
 <AcademyPromo
   image="crowdsec_threat_intelligence.svg"
   description="Watch a short series of videos on how to get the most out of CrowdSec’s Cyber Threat Intelligence database"

crowdsec-docs/static/img/ipdex/ipdex_log_file.png

@@ -0,0 +1,30 @@
+---
+id: integration_ipdex
+title: IPDEX
+sidebar_position: 1
+---
+
+`ipdex` is a simple CLI tool developed by CrowdSec to gather insight about a list of IPs or an IP using the CrowdSec CTI (Cyber Threat Intelligence) API.
+
+[Official IPDEX Repository](https://github.com/crowdsecurity/ipdex)
+
+## Installation
+
+You can check the [install guide on ipdex repository](https://github.com/crowdsecurity/ipdex?tab=readme-ov-file#1-install).
+
+
+## Usage
+
+You can check the [user guide on ipdex repository](https://github.com/crowdsecurity/ipdex?tab=readme-ov-file#user-guide).
+
+Here are some screenshot to demonstrate ipdex user experience.
+
+### Analyzing an IP address
+
+![IP Analyses](/img/ipdex/ipdex_ip.png)
+
+
+### Analyzing a log file
+
+
+![Log File Analyses](/img/ipdex/ipdex_log_file.png)