324 lines
12 KiB
HTML
324 lines
12 KiB
HTML
{% extends "base.html" %}
|
|
|
|
{% block title %}API Documentation - IP WHOIS Analyzer Pro{% endblock %}
|
|
|
|
{% block nav_api %}active{% endblock %}
|
|
|
|
{% block extra_css %}
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/github-dark.min.css">
|
|
{% endblock %}
|
|
|
|
{% block content %}
|
|
<!-- API Info -->
|
|
<div class="row mb-4">
|
|
<div class="col-md-12">
|
|
<div class="alert alert-info">
|
|
<h5 class="alert-heading"><i class="fas fa-info-circle"></i> API Information</h5>
|
|
<p class="mb-1"><strong>Base URL:</strong> <code>http://localhost:5000</code></p>
|
|
<p class="mb-1"><strong>Format:</strong> JSON</p>
|
|
<p class="mb-0"><strong>Authentication:</strong> None (local use)</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="row">
|
|
<!-- Sidebar Navigation -->
|
|
<div class="col-md-3">
|
|
<div class="card mb-4 position-sticky" style="top: 70px;">
|
|
<div class="card-header bg-primary text-white">
|
|
<h6 class="mb-0"><i class="fas fa-list"></i> Endpoints</h6>
|
|
</div>
|
|
<div class="list-group list-group-flush">
|
|
<a href="#analyze" class="list-group-item list-group-item-action">
|
|
<i class="fas fa-search"></i> Analyze IPs
|
|
</a>
|
|
<a href="#filter" class="list-group-item list-group-item-action">
|
|
<i class="fas fa-filter"></i> Filter Results
|
|
</a>
|
|
<a href="#export-ipset" class="list-group-item list-group-item-action">
|
|
<i class="fas fa-list"></i> Export IPSet
|
|
</a>
|
|
<a href="#export-iptables" class="list-group-item list-group-item-action">
|
|
<i class="fas fa-shield-alt"></i> Export iptables
|
|
</a>
|
|
<a href="#export-nginx" class="list-group-item list-group-item-action">
|
|
<i class="fas fa-server"></i> Export Nginx
|
|
</a>
|
|
<a href="#export-apache" class="list-group-item list-group-item-action">
|
|
<i class="fas fa-feather"></i> Export Apache
|
|
</a>
|
|
<a href="#export-firewalld" class="list-group-item list-group-item-action">
|
|
<i class="fas fa-fire"></i> Export Firewalld
|
|
</a>
|
|
<a href="#export-mikrotik" class="list-group-item list-group-item-action">
|
|
<i class="fas fa-network-wired"></i> Export MikroTik
|
|
</a>
|
|
<a href="#export-cidr" class="list-group-item list-group-item-action">
|
|
<i class="fas fa-sitemap"></i> Export CIDR
|
|
</a>
|
|
<a href="#export-csv" class="list-group-item list-group-item-action">
|
|
<i class="fas fa-file-csv"></i> Export CSV
|
|
</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<!-- Main Content -->
|
|
<div class="col-md-9">
|
|
<!-- POST /api/analyze -->
|
|
<div class="card endpoint-card mb-4" id="analyze">
|
|
<div class="card-header">
|
|
<h4 class="mb-0">
|
|
<span class="method-badge method-post">POST</span>
|
|
/api/analyze
|
|
</h4>
|
|
</div>
|
|
<div class="card-body">
|
|
<p>Analyze a list of IP addresses and return WHOIS information (ASN, owner, country, network).</p>
|
|
|
|
<h6 class="mt-3">Request Body:</h6>
|
|
<div class="position-relative">
|
|
<button class="btn btn-sm btn-secondary position-absolute top-0 end-0 m-2" onclick="copyCode(this)" style="z-index: 10;">
|
|
<i class="fas fa-copy"></i>
|
|
</button>
|
|
<pre class="mb-0"><code class="language-json">{
|
|
"ips": "1.1.1.1, 8.8.8.8, 9.9.9.9"
|
|
}</code></pre>
|
|
</div>
|
|
|
|
<h6 class="mt-3">Python Example:</h6>
|
|
<div class="position-relative">
|
|
<button class="btn btn-sm btn-secondary position-absolute top-0 end-0 m-2" onclick="copyCode(this)" style="z-index: 10;">
|
|
<i class="fas fa-copy"></i>
|
|
</button>
|
|
<pre class="mb-0"><code class="language-python">import requests
|
|
|
|
response = requests.post('http://localhost:5000/api/analyze',
|
|
json={'ips': '1.1.1.1, 8.8.8.8, 9.9.9.9'})
|
|
|
|
data = response.json()
|
|
print(f"Total IPs: {data['stats']['total']}")
|
|
for ip_info in data['results']:
|
|
print(f"{ip_info['ip']} -> {ip_info['country']} ({ip_info['asn']})")</code></pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<!-- POST /api/filter -->
|
|
<div class="card endpoint-card mb-4" id="filter">
|
|
<div class="card-header">
|
|
<h4 class="mb-0">
|
|
<span class="method-badge method-post">POST</span>
|
|
/api/filter
|
|
</h4>
|
|
</div>
|
|
<div class="card-body">
|
|
<p>Filter results by countries, ASNs, or owners.</p>
|
|
|
|
<h6 class="mt-3">Python Example:</h6>
|
|
<div class="position-relative">
|
|
<button class="btn btn-sm btn-secondary position-absolute top-0 end-0 m-2" onclick="copyCode(this)" style="z-index: 10;">
|
|
<i class="fas fa-copy"></i>
|
|
</button>
|
|
<pre class="mb-0"><code class="language-python">import requests
|
|
|
|
# First, analyze
|
|
analyze_response = requests.post('http://localhost:5000/api/analyze',
|
|
json={'ips': 'your IP list...'})
|
|
results = analyze_response.json()['results']
|
|
|
|
# Then filter
|
|
filter_response = requests.post('http://localhost:5000/api/filter',
|
|
json={
|
|
'results': results,
|
|
'filters': {
|
|
'countries': ['CN', 'RU'],
|
|
'asns': ['AS4134']
|
|
}
|
|
})
|
|
|
|
filtered = filter_response.json()['filtered']
|
|
print(f"Filtered: {len(filtered)} IPs")</code></pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<!-- POST /api/export/ipset -->
|
|
<div class="card endpoint-card mb-4" id="export-ipset">
|
|
<div class="card-header">
|
|
<h4 class="mb-0">
|
|
<span class="method-badge method-post">POST</span>
|
|
/api/export/ipset
|
|
</h4>
|
|
</div>
|
|
<div class="card-body">
|
|
<p>Generate IPSet rules with timeout (default 24 hours).</p>
|
|
|
|
<h6 class="mt-3">Python Example:</h6>
|
|
<div class="position-relative">
|
|
<button class="btn btn-sm btn-secondary position-absolute top-0 end-0 m-2" onclick="copyCode(this)" style="z-index: 10;">
|
|
<i class="fas fa-copy"></i>
|
|
</button>
|
|
<pre class="mb-0"><code class="language-python">import requests
|
|
|
|
response = requests.post('http://localhost:5000/api/export/ipset',
|
|
json={
|
|
'ips': ['1.1.1.1', '8.8.8.8'],
|
|
'timeout': 43200 # 12 hours
|
|
})
|
|
|
|
rules = response.text
|
|
with open('block_ips.sh', 'w') as f:
|
|
f.write(rules)
|
|
print("Saved to block_ips.sh")</code></pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<!-- Other endpoints (shorter) -->
|
|
<div class="card endpoint-card mb-4" id="export-iptables">
|
|
<div class="card-header">
|
|
<h4 class="mb-0">
|
|
<span class="method-badge method-post">POST</span>
|
|
/api/export/iptables
|
|
</h4>
|
|
</div>
|
|
<div class="card-body">
|
|
<p>Generate iptables DROP rules for INPUT and FORWARD chains.</p>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="card endpoint-card mb-4" id="export-nginx">
|
|
<div class="card-header">
|
|
<h4 class="mb-0">
|
|
<span class="method-badge method-post">POST</span>
|
|
/api/export/nginx
|
|
</h4>
|
|
</div>
|
|
<div class="card-body">
|
|
<p>Generate Nginx deny directives.</p>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="card endpoint-card mb-4" id="export-apache">
|
|
<div class="card-header">
|
|
<h4 class="mb-0">
|
|
<span class="method-badge method-post">POST</span>
|
|
/api/export/apache
|
|
</h4>
|
|
</div>
|
|
<div class="card-body">
|
|
<p>Generate Apache deny rules (.htaccess or VirtualHost).</p>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="card endpoint-card mb-4" id="export-firewalld">
|
|
<div class="card-header">
|
|
<h4 class="mb-0">
|
|
<span class="method-badge method-post">POST</span>
|
|
/api/export/firewalld
|
|
</h4>
|
|
</div>
|
|
<div class="card-body">
|
|
<p>Generate Firewalld rich rules.</p>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="card endpoint-card mb-4" id="export-mikrotik">
|
|
<div class="card-header">
|
|
<h4 class="mb-0">
|
|
<span class="method-badge method-post">POST</span>
|
|
/api/export/mikrotik
|
|
</h4>
|
|
</div>
|
|
<div class="card-body">
|
|
<p>Generate MikroTik RouterOS commands (address-list + firewall filter).</p>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="card endpoint-card mb-4" id="export-cidr">
|
|
<div class="card-header">
|
|
<h4 class="mb-0">
|
|
<span class="method-badge method-post">POST</span>
|
|
/api/export/cidr
|
|
</h4>
|
|
</div>
|
|
<div class="card-body">
|
|
<p>Export unique CIDR network blocks.</p>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="card endpoint-card mb-4" id="export-csv">
|
|
<div class="card-header">
|
|
<h4 class="mb-0">
|
|
<span class="method-badge method-post">POST</span>
|
|
/api/export/csv
|
|
</h4>
|
|
</div>
|
|
<div class="card-body">
|
|
<p>Export data in CSV format with automatic download.</p>
|
|
</div>
|
|
</div>
|
|
|
|
<!-- Complete Workflow Example -->
|
|
<div class="card border-success mb-4">
|
|
<div class="card-header bg-success text-white">
|
|
<h4 class="mb-0"><i class="fas fa-code-branch"></i> Complete Workflow Example</h4>
|
|
</div>
|
|
<div class="card-body">
|
|
<p>Full example: analyze → filter → export to MikroTik</p>
|
|
|
|
<div class="position-relative">
|
|
<button class="btn btn-sm btn-secondary position-absolute top-0 end-0 m-2" onclick="copyCode(this)" style="z-index: 10;">
|
|
<i class="fas fa-copy"></i>
|
|
</button>
|
|
<pre class="mb-0"><code class="language-python">import requests
|
|
|
|
BASE_URL = 'http://localhost:5000'
|
|
|
|
# 1. Analyze IPs from log file
|
|
with open('/var/log/attacks.log', 'r') as f:
|
|
log_content = f.read()
|
|
|
|
response = requests.post(f'{BASE_URL}/api/analyze',
|
|
json={'ips': log_content})
|
|
|
|
data = response.json()
|
|
results = data['results']
|
|
print(f"Analyzed: {len(results)} IPs")
|
|
|
|
# 2. Filter China and Russia only
|
|
filter_response = requests.post(f'{BASE_URL}/api/filter',
|
|
json={
|
|
'results': results,
|
|
'filters': {'countries': ['CN', 'RU']}
|
|
})
|
|
|
|
filtered = filter_response.json()['filtered']
|
|
ips_to_block = [item['ip'] for item in filtered]
|
|
|
|
# 3. Generate MikroTik rules
|
|
mikrotik_response = requests.post(f'{BASE_URL}/api/export/mikrotik',
|
|
json={'ips': ips_to_block})
|
|
|
|
# 4. Save to file
|
|
with open('block_cn_ru.rsc', 'w') as f:
|
|
f.write(mikrotik_response.text)
|
|
|
|
print(f"Generated rules for {len(ips_to_block)} IPs")</code></pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
{% endblock %}
|
|
|
|
{% block extra_scripts %}
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js"></script>
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/languages/python.min.js"></script>
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/languages/json.min.js"></script>
|
|
{% endblock %}
|
|
|
|
{% block page_script %}
|
|
<script src="{{ static_hash('js/api.js') }}"></script>
|
|
{% endblock %} |