Add TCP port scan persistence and API endpoint.
Probe configured ports for alive hosts, persist port states, and expose scan port results via REST. Made-with: Cursor
This commit is contained in:
@@ -9,6 +9,7 @@
|
|||||||
- `GET /api/scans` - список сканов.
|
- `GET /api/scans` - список сканов.
|
||||||
- `GET /api/scans/{id}` - просмотр созданного задания.
|
- `GET /api/scans/{id}` - просмотр созданного задания.
|
||||||
- `GET /api/scans/{id}/hosts` - результаты проверки хостов по скану.
|
- `GET /api/scans/{id}/hosts` - результаты проверки хостов по скану.
|
||||||
|
- `GET /api/scans/{id}/ports` - результаты проверки TCP-портов по скану.
|
||||||
- Валидация CIDR и exclude IP.
|
- Валидация CIDR и exclude IP.
|
||||||
- Два backend-хранилища: in-memory и PostgreSQL.
|
- Два backend-хранилища: in-memory и PostgreSQL.
|
||||||
- После создания scan запускается фоновый discovery с обновлением статуса и прогресса.
|
- После создания scan запускается фоновый discovery с обновлением статуса и прогресса.
|
||||||
@@ -137,6 +138,12 @@ curl -s http://localhost:8080/api/scans?limit=20
|
|||||||
curl -s http://localhost:8080/api/scans/<scan_id>/hosts?limit=200
|
curl -s http://localhost:8080/api/scans/<scan_id>/hosts?limit=200
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Получить результаты по портам:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -s http://localhost:8080/api/scans/<scan_id>/ports?limit=500
|
||||||
|
```
|
||||||
|
|
||||||
## Запуск как сервис на Linux (systemd)
|
## Запуск как сервис на Linux (systemd)
|
||||||
|
|
||||||
1. Собрать бинарник:
|
1. Собрать бинарник:
|
||||||
|
|||||||
@@ -26,6 +26,7 @@ func (h *Handler) Routes() http.Handler {
|
|||||||
mux.HandleFunc("GET /api/scans", h.listScans)
|
mux.HandleFunc("GET /api/scans", h.listScans)
|
||||||
mux.HandleFunc("GET /api/scans/{id}", h.getScan)
|
mux.HandleFunc("GET /api/scans/{id}", h.getScan)
|
||||||
mux.HandleFunc("GET /api/scans/{id}/hosts", h.getScanHosts)
|
mux.HandleFunc("GET /api/scans/{id}/hosts", h.getScanHosts)
|
||||||
|
mux.HandleFunc("GET /api/scans/{id}/ports", h.getScanPorts)
|
||||||
return withJSON(mux)
|
return withJSON(mux)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -121,6 +122,32 @@ func (h *Handler) getScanHosts(w http.ResponseWriter, r *http.Request) {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (h *Handler) getScanPorts(w http.ResponseWriter, r *http.Request) {
|
||||||
|
id := r.PathValue("id")
|
||||||
|
if id == "" {
|
||||||
|
writeError(w, http.StatusBadRequest, "scan id is required")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if _, ok := h.store.GetScan(id); !ok {
|
||||||
|
writeError(w, http.StatusNotFound, "scan not found")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
limit := 1000
|
||||||
|
if raw := r.URL.Query().Get("limit"); raw != "" {
|
||||||
|
n, err := strconv.Atoi(raw)
|
||||||
|
if err != nil || n <= 0 || n > 10000 {
|
||||||
|
writeError(w, http.StatusBadRequest, "limit must be between 1 and 10000")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
limit = n
|
||||||
|
}
|
||||||
|
|
||||||
|
writeJSON(w, http.StatusOK, map[string]any{
|
||||||
|
"items": h.store.ListOpenPortResults(id, limit),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
func withJSON(next http.Handler) http.Handler {
|
func withJSON(next http.Handler) http.Handler {
|
||||||
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
w.Header().Set("Content-Type", "application/json; charset=utf-8")
|
w.Header().Set("Content-Type", "application/json; charset=utf-8")
|
||||||
|
|||||||
@@ -315,3 +315,46 @@ limit $2`
|
|||||||
}
|
}
|
||||||
return out
|
return out
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (s *PostgresStore) SaveOpenPortResult(scanID string, result OpenPortResult) error {
|
||||||
|
query := `
|
||||||
|
insert into scan_ports (scan_id, ip, port, is_open, checked_at)
|
||||||
|
values ($1, $2, $3, $4, $5)`
|
||||||
|
_, err := s.db.ExecContext(
|
||||||
|
context.Background(),
|
||||||
|
query,
|
||||||
|
scanID,
|
||||||
|
result.IP,
|
||||||
|
result.Port,
|
||||||
|
result.IsOpen,
|
||||||
|
result.CheckedAt,
|
||||||
|
)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *PostgresStore) ListOpenPortResults(scanID string, limit int) []OpenPortResult {
|
||||||
|
if limit <= 0 {
|
||||||
|
limit = 1000
|
||||||
|
}
|
||||||
|
query := `
|
||||||
|
select ip::text, port, is_open, checked_at
|
||||||
|
from scan_ports
|
||||||
|
where scan_id = $1
|
||||||
|
order by checked_at desc
|
||||||
|
limit $2`
|
||||||
|
rows, err := s.db.QueryContext(context.Background(), query, scanID, limit)
|
||||||
|
if err != nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
defer rows.Close()
|
||||||
|
|
||||||
|
out := make([]OpenPortResult, 0, limit)
|
||||||
|
for rows.Next() {
|
||||||
|
var p OpenPortResult
|
||||||
|
if err = rows.Scan(&p.IP, &p.Port, &p.IsOpen, &p.CheckedAt); err != nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
out = append(out, p)
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|||||||
@@ -3,6 +3,7 @@ package scans
|
|||||||
import (
|
import (
|
||||||
"log"
|
"log"
|
||||||
"net"
|
"net"
|
||||||
|
"net/netip"
|
||||||
"os/exec"
|
"os/exec"
|
||||||
"runtime"
|
"runtime"
|
||||||
"strconv"
|
"strconv"
|
||||||
@@ -70,11 +71,22 @@ func (r *Runner) run(job ScanJob) {
|
|||||||
defer wg.Done()
|
defer wg.Done()
|
||||||
for ip := range workCh {
|
for ip := range workCh {
|
||||||
isUp := probeHost(ip, job.Options.PingTimeoutMS)
|
isUp := probeHost(ip, job.Options.PingTimeoutMS)
|
||||||
|
checkedAt := time.Now().UTC()
|
||||||
_ = r.store.SaveHostResult(job.ID, HostResult{
|
_ = r.store.SaveHostResult(job.ID, HostResult{
|
||||||
IP: ip,
|
IP: ip,
|
||||||
IsUp: isUp,
|
IsUp: isUp,
|
||||||
CheckedAt: time.Now().UTC(),
|
CheckedAt: checkedAt,
|
||||||
})
|
})
|
||||||
|
if isUp && job.Options.PortScanEnabled {
|
||||||
|
for _, p := range job.Options.Ports {
|
||||||
|
_ = r.store.SaveOpenPortResult(job.ID, OpenPortResult{
|
||||||
|
IP: ip,
|
||||||
|
Port: p,
|
||||||
|
IsOpen: probeTCPPort(ip, p, job.Options.PingTimeoutMS),
|
||||||
|
CheckedAt: checkedAt,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
mu.Lock()
|
mu.Lock()
|
||||||
done++
|
done++
|
||||||
@@ -166,6 +178,23 @@ func probeHost(ip string, timeoutMS int) bool {
|
|||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func probeTCPPort(ip string, port int, timeoutMS int) bool {
|
||||||
|
if timeoutMS <= 0 {
|
||||||
|
timeoutMS = 700
|
||||||
|
}
|
||||||
|
addr, err := netip.ParseAddr(ip)
|
||||||
|
if err != nil {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
target := net.JoinHostPort(addr.String(), strconv.Itoa(port))
|
||||||
|
conn, err := net.DialTimeout("tcp", target, time.Duration(timeoutMS)*time.Millisecond)
|
||||||
|
if err != nil {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
_ = conn.Close()
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
func dupIP(ip net.IP) net.IP {
|
func dupIP(ip net.IP) net.IP {
|
||||||
out := make(net.IP, len(ip))
|
out := make(net.IP, len(ip))
|
||||||
copy(out, ip)
|
copy(out, ip)
|
||||||
|
|||||||
@@ -61,6 +61,8 @@ type Store interface {
|
|||||||
UpdateScan(id string, update ScanUpdate) (ScanJob, bool)
|
UpdateScan(id string, update ScanUpdate) (ScanJob, bool)
|
||||||
SaveHostResult(scanID string, host HostResult) error
|
SaveHostResult(scanID string, host HostResult) error
|
||||||
ListHostResults(scanID string, limit int) []HostResult
|
ListHostResults(scanID string, limit int) []HostResult
|
||||||
|
SaveOpenPortResult(scanID string, result OpenPortResult) error
|
||||||
|
ListOpenPortResults(scanID string, limit int) []OpenPortResult
|
||||||
}
|
}
|
||||||
|
|
||||||
type HostResult struct {
|
type HostResult struct {
|
||||||
@@ -69,16 +71,25 @@ type HostResult struct {
|
|||||||
CheckedAt time.Time `json:"checked_at"`
|
CheckedAt time.Time `json:"checked_at"`
|
||||||
}
|
}
|
||||||
|
|
||||||
|
type OpenPortResult struct {
|
||||||
|
IP string `json:"ip"`
|
||||||
|
Port int `json:"port"`
|
||||||
|
IsOpen bool `json:"is_open"`
|
||||||
|
CheckedAt time.Time `json:"checked_at"`
|
||||||
|
}
|
||||||
|
|
||||||
type MemoryStore struct {
|
type MemoryStore struct {
|
||||||
mu sync.RWMutex
|
mu sync.RWMutex
|
||||||
jobs map[string]ScanJob
|
jobs map[string]ScanJob
|
||||||
hosts map[string][]HostResult
|
hosts map[string][]HostResult
|
||||||
|
ports map[string][]OpenPortResult
|
||||||
}
|
}
|
||||||
|
|
||||||
func NewMemoryStore() *MemoryStore {
|
func NewMemoryStore() *MemoryStore {
|
||||||
return &MemoryStore{
|
return &MemoryStore{
|
||||||
jobs: make(map[string]ScanJob),
|
jobs: make(map[string]ScanJob),
|
||||||
hosts: make(map[string][]HostResult),
|
hosts: make(map[string][]HostResult),
|
||||||
|
ports: make(map[string][]OpenPortResult),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -200,6 +211,35 @@ func (s *MemoryStore) ListHostResults(scanID string, limit int) []HostResult {
|
|||||||
return out
|
return out
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (s *MemoryStore) SaveOpenPortResult(scanID string, result OpenPortResult) error {
|
||||||
|
s.mu.Lock()
|
||||||
|
defer s.mu.Unlock()
|
||||||
|
|
||||||
|
if _, ok := s.jobs[scanID]; !ok {
|
||||||
|
return errors.New("scan not found")
|
||||||
|
}
|
||||||
|
s.ports[scanID] = append(s.ports[scanID], result)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *MemoryStore) ListOpenPortResults(scanID string, limit int) []OpenPortResult {
|
||||||
|
if limit <= 0 {
|
||||||
|
limit = 1000
|
||||||
|
}
|
||||||
|
s.mu.RLock()
|
||||||
|
defer s.mu.RUnlock()
|
||||||
|
|
||||||
|
items := s.ports[scanID]
|
||||||
|
if len(items) <= limit {
|
||||||
|
out := make([]OpenPortResult, len(items))
|
||||||
|
copy(out, items)
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
out := make([]OpenPortResult, limit)
|
||||||
|
copy(out, items[:limit])
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
func applyDefaultOptions(opts *ScanOptions) {
|
func applyDefaultOptions(opts *ScanOptions) {
|
||||||
if opts.PingTimeoutMS <= 0 {
|
if opts.PingTimeoutMS <= 0 {
|
||||||
opts.PingTimeoutMS = 700
|
opts.PingTimeoutMS = 700
|
||||||
|
|||||||
@@ -28,3 +28,15 @@ create table if not exists scan_hosts (
|
|||||||
|
|
||||||
create index if not exists idx_scan_hosts_scan_id_checked_at
|
create index if not exists idx_scan_hosts_scan_id_checked_at
|
||||||
on scan_hosts (scan_id, checked_at desc);
|
on scan_hosts (scan_id, checked_at desc);
|
||||||
|
|
||||||
|
create table if not exists scan_ports (
|
||||||
|
id bigserial primary key,
|
||||||
|
scan_id text not null references scan_jobs(id) on delete cascade,
|
||||||
|
ip inet not null,
|
||||||
|
port int not null,
|
||||||
|
is_open boolean not null,
|
||||||
|
checked_at timestamptz not null
|
||||||
|
);
|
||||||
|
|
||||||
|
create index if not exists idx_scan_ports_scan_id_checked_at
|
||||||
|
on scan_ports (scan_id, checked_at desc);
|
||||||
|
|||||||
Reference in New Issue
Block a user