PapaTramp/nettopo-go
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add SNMP v2c probing and results endpoint.

Browse Source 
Probe sysName/sysDescr/sysObjectID for alive hosts, persist SNMP outcomes, and expose scan SNMP data via REST.

Made-with: Cursor
This commit is contained in:
Andrey Lutsenko
2026-04-09 21:56:31 +10:00
parent e9452dcc0a
commit cca4477792
10 changed files with 234 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.env.example
+2
View File
@@ -2,3 +2,5 @@ HTTP_ADDR=:8080
STORE_BACKEND=memory
# DB_DSN=postgres://nettopo:nettopo@localhost:5432/nettopo?sslmode=disable
RUN_MIGRATIONS=true
SNMP_ENABLED=true
SNMP_COMMUNITY=public
README.md
+8
View File
@@ -10,6 +10,7 @@
- `GET /api/scans/{id}` - просмотр созданного задания.
- `GET /api/scans/{id}/hosts` - результаты проверки хостов по скану.
- `GET /api/scans/{id}/ports` - результаты проверки TCP-портов по скану.
- `GET /api/scans/{id}/snmp` - результаты SNMP v2c (`sysName`, `sysDescr`, `sysObjectID`).
- Валидация CIDR и exclude IP.
- Два backend-хранилища: in-memory и PostgreSQL.
- После создания scan запускается фоновый discovery с обновлением статуса и прогресса.
@@ -45,6 +46,7 @@ HTTP_ADDR=:8080 go run ./cmd/server
```
По умолчанию используется `STORE_BACKEND=memory`.
SNMP-проверка по умолчанию включена (`SNMP_ENABLED=true`, community `public`).
## PostgreSQL без Docker
@@ -144,6 +146,12 @@ curl -s http://localhost:8080/api/scans/<scan_id>/hosts?limit=200
curl -s http://localhost:8080/api/scans/<scan_id>/ports?limit=500
```
Получить SNMP результаты:
```bash
curl -s http://localhost:8080/api/scans/<scan_id>/snmp?limit=500
```
## Запуск как сервис на Linux (systemd)
1. Собрать бинарник:
cmd/server/main.go
+4 -1
View File
@@ -20,7 +20,10 @@ func main() {
defer dbClose()
}
runner := scans.NewRunner(scanStore)
runner := scans.NewRunner(scanStore, scans.RunnerConfig{
SNMPEnabled: cfg.SNMPEnabled,
SNMPCommunity: cfg.SNMPCommunity,
})
handler := api.NewHandler(scanStore, runner)
server := &http.Server{
go.mod
+2
View File
@@ -3,3 +3,5 @@ module nettopo-go
go 1.22
require github.com/jackc/pgx/v5 v5.7.6
require github.com/gosnmp/gosnmp v1.41.0
internal/api/handler.go
+27
View File
@@ -27,6 +27,7 @@ func (h *Handler) Routes() http.Handler {
mux.HandleFunc("GET /api/scans/{id}", h.getScan)
mux.HandleFunc("GET /api/scans/{id}/hosts", h.getScanHosts)
mux.HandleFunc("GET /api/scans/{id}/ports", h.getScanPorts)
mux.HandleFunc("GET /api/scans/{id}/snmp", h.getScanSNMP)
return withJSON(mux)
}
@@ -148,6 +149,32 @@ func (h *Handler) getScanPorts(w http.ResponseWriter, r *http.Request) {
})
}
func (h *Handler) getScanSNMP(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.ListSNMPResults(id, limit),
})
}
func withJSON(next http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Content-Type", "application/json; charset=utf-8")
internal/config/config.go
+12
View File
@@ -7,6 +7,8 @@ type Config struct {
DBDSN string
StoreBackend string
RunMigrations bool
SNMPEnabled bool
SNMPCommunity string
}
func FromEnv() Config {
@@ -29,11 +31,21 @@ func FromEnv() Config {
if os.Getenv("RUN_MIGRATIONS") == "false" {
runMigrations = false
}
snmpEnabled := true
if os.Getenv("SNMP_ENABLED") == "false" {
snmpEnabled = false
}
snmpCommunity := os.Getenv("SNMP_COMMUNITY")
if snmpCommunity == "" {
snmpCommunity = "public"
}
return Config{
HTTPAddr: addr,
DBDSN: dbDSN,
StoreBackend: storeBackend,
RunMigrations: runMigrations,
SNMPEnabled: snmpEnabled,
SNMPCommunity: snmpCommunity,
}
}
internal/scans/postgres_store.go
+55
View File
@@ -358,3 +358,58 @@ limit $2`
}
return out
}
func (s *PostgresStore) SaveSNMPResult(scanID string, result SNMPResult) error {
query := `
insert into scan_snmp (scan_id, ip, success, sys_name, sys_descr, sys_object_id, error_text, checked_at)
values ($1, $2, $3, $4, $5, $6, $7, $8)`
_, err := s.db.ExecContext(
context.Background(),
query,
scanID,
result.IP,
result.Success,
result.SysName,
result.SysDescr,
result.SysObjectID,
result.Error,
result.CheckedAt,
)
return err
}
func (s *PostgresStore) ListSNMPResults(scanID string, limit int) []SNMPResult {
if limit <= 0 {
limit = 1000
}
query := `
select ip::text, success, coalesce(sys_name, ''), coalesce(sys_descr, ''), coalesce(sys_object_id, ''),
coalesce(error_text, ''), checked_at
from scan_snmp
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([]SNMPResult, 0, limit)
for rows.Next() {
var sres SNMPResult
if err = rows.Scan(
&sres.IP,
&sres.Success,
&sres.SysName,
&sres.SysDescr,
&sres.SysObjectID,
&sres.Error,
&sres.CheckedAt,
); err != nil {
return nil
}
out = append(out, sres)
}
return out
}
internal/scans/runner.go
+66 -2
View File
@@ -1,6 +1,7 @@
package scans
import (
"fmt"
"log"
"net"
"net/netip"
@@ -9,14 +10,22 @@ import (
"strconv"
"sync"
"time"
"github.com/gosnmp/gosnmp"
)
type Runner struct {
store Store
cfg RunnerConfig
}
func NewRunner(store Store) *Runner {
return &Runner{store: store}
type RunnerConfig struct {
SNMPEnabled bool
SNMPCommunity string
}
func NewRunner(store Store, cfg RunnerConfig) *Runner {
return &Runner{store: store, cfg: cfg}
}
func (r *Runner) Start(job ScanJob) {
@@ -87,6 +96,9 @@ func (r *Runner) run(job ScanJob) {
})
}
}
if isUp && r.cfg.SNMPEnabled {
_ = r.store.SaveSNMPResult(job.ID, probeSNMP(ip, r.cfg.SNMPCommunity, checkedAt, job.Options.PingTimeoutMS))
}
mu.Lock()
done++
@@ -125,6 +137,58 @@ func (r *Runner) run(job ScanJob) {
})
}
func probeSNMP(ip, community string, checkedAt time.Time, timeoutMS int) SNMPResult {
if timeoutMS <= 0 {
timeoutMS = 700
}
if community == "" {
community = "public"
}
client := &gosnmp.GoSNMP{
Target: ip,
Port: 161,
Version: gosnmp.Version2c,
Community: community,
Timeout: time.Duration(timeoutMS) * time.Millisecond,
Retries: 1,
}
if err := client.Connect(); err != nil {
return SNMPResult{IP: ip, Success: false, Error: err.Error(), CheckedAt: checkedAt}
}
defer client.Conn.Close()
oids := []string{
".1.3.6.1.2.1.1.5.0",
".1.3.6.1.2.1.1.1.0",
".1.3.6.1.2.1.1.2.0",
}
pkt, err := client.Get(oids)
if err != nil {
return SNMPResult{IP: ip, Success: false, Error: err.Error(), CheckedAt: checkedAt}
}
out := SNMPResult{IP: ip, Success: true, CheckedAt: checkedAt}
for _, vb := range pkt.Variables {
switch vb.Name {
case ".1.3.6.1.2.1.1.5.0":
out.SysName = snmpValueToString(vb.Value)
case ".1.3.6.1.2.1.1.1.0":
out.SysDescr = snmpValueToString(vb.Value)
case ".1.3.6.1.2.1.1.2.0":
out.SysObjectID = snmpValueToString(vb.Value)
}
}
return out
}
func snmpValueToString(v any) string {
if b, ok := v.([]byte); ok {
return string(b)
}
return fmt.Sprint(v)
}
func expandTargets(cidrs []string, excludeIPs []string) ([]string, error) {
excluded := make(map[string]struct{}, len(excludeIPs))
for _, ip := range excludeIPs {
internal/scans/store.go
+43
View File
@@ -63,6 +63,8 @@ type Store interface {
ListHostResults(scanID string, limit int) []HostResult
SaveOpenPortResult(scanID string, result OpenPortResult) error
ListOpenPortResults(scanID string, limit int) []OpenPortResult
SaveSNMPResult(scanID string, result SNMPResult) error
ListSNMPResults(scanID string, limit int) []SNMPResult
}
type HostResult struct {
@@ -78,11 +80,22 @@ type OpenPortResult struct {
CheckedAt time.Time `json:"checked_at"`
}
type SNMPResult struct {
IP string `json:"ip"`
Success bool `json:"success"`
SysName string `json:"sys_name"`
SysDescr string `json:"sys_descr"`
SysObjectID string `json:"sys_object_id"`
Error string `json:"error,omitempty"`
CheckedAt time.Time `json:"checked_at"`
}
type MemoryStore struct {
mu sync.RWMutex
jobs map[string]ScanJob
hosts map[string][]HostResult
ports map[string][]OpenPortResult
snmp map[string][]SNMPResult
}
func NewMemoryStore() *MemoryStore {
@@ -90,6 +103,7 @@ func NewMemoryStore() *MemoryStore {
jobs: make(map[string]ScanJob),
hosts: make(map[string][]HostResult),
ports: make(map[string][]OpenPortResult),
snmp: make(map[string][]SNMPResult),
}
}
@@ -240,6 +254,35 @@ func (s *MemoryStore) ListOpenPortResults(scanID string, limit int) []OpenPortRe
return out
}
func (s *MemoryStore) SaveSNMPResult(scanID string, result SNMPResult) error {
s.mu.Lock()
defer s.mu.Unlock()
if _, ok := s.jobs[scanID]; !ok {
return errors.New("scan not found")
}
s.snmp[scanID] = append(s.snmp[scanID], result)
return nil
}
func (s *MemoryStore) ListSNMPResults(scanID string, limit int) []SNMPResult {
if limit <= 0 {
limit = 1000
}
s.mu.RLock()
defer s.mu.RUnlock()
items := s.snmp[scanID]
if len(items) <= limit {
out := make([]SNMPResult, len(items))
copy(out, items)
return out
}
out := make([]SNMPResult, limit)
copy(out, items[:limit])
return out
}
func applyDefaultOptions(opts *ScanOptions) {
if opts.PingTimeoutMS <= 0 {
opts.PingTimeoutMS = 700
internal/store/sql/001_init.sql
+15
View File
@@ -40,3 +40,18 @@ create table if not exists scan_ports (
create index if not exists idx_scan_ports_scan_id_checked_at
on scan_ports (scan_id, checked_at desc);
create table if not exists scan_snmp (
id bigserial primary key,
scan_id text not null references scan_jobs(id) on delete cascade,
ip inet not null,
success boolean not null,
sys_name text null,
sys_descr text null,
sys_object_id text null,
error_text text null,
checked_at timestamptz not null
);
create index if not exists idx_scan_snmp_scan_id_checked_at
on scan_snmp (scan_id, checked_at desc);