swissmakers_gmbh/fail2ban-ui
12
1
Fork 0
mirror of https://github.com/swissmakers/fail2ban-ui.git synced 2026-04-19 15:03:14 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

Fix console logger file and reorder routes, add comments for interlnal/external APIs

Browse Source
This commit is contained in:
Michael Reber
2026-02-15 20:55:52 +01:00
parent da05afd115
commit 737d634704
2 changed files with 46 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
pkg/web/routes.go
View File

@@ -1,6 +1,6 @@
// Fail2ban UI - A Swiss made, management interface for Fail2ban.
//
// Copyright (C) 2025 Swissmakers GmbH (https://swissmakers.ch)
// Copyright (C) 2026 Swissmakers GmbH (https://swissmakers.ch)
//
// Licensed under the GNU General Public License, Version 3 (GPL-3.0)
// You may not use this file except in compliance with the License.
@@ -20,12 +20,14 @@ import (
"github.com/gin-gonic/gin"
)
// RegisterRoutes sets up the routes for the Fail2ban UI.
// =========================================================================
// Route Registration
// =========================================================================
func RegisterRoutes(r *gin.Engine, hub *Hub) {
// Set the global WebSocket hub
SetWebSocketHub(hub)
// Public authentication routes (no auth required)
// Public routes; do not require authentication
authRoutes := r.Group("/auth")
{
authRoutes.GET("/login", LoginHandler)
@@ -35,40 +37,52 @@ func RegisterRoutes(r *gin.Engine, hub *Hub) {
authRoutes.GET("/user", UserInfoHandler)
}
// Apply authentication middleware to all routes
// Initialize authentication middleware; all routes below here require authentication
r.Use(AuthMiddleware())
// Render the dashboard
// Default currently "/" renders the dashboard -> TODO: To run f2b-UI on a different (sub)-path, we need to prefix that.
r.GET("/", renderIndexPage)
// API routes group
api := r.Group("/api")
{
// Internal call from frontend to the Fail2ban-UI backend to get the summary of the servers (banned IPs per active jail)
api.GET("/summary", SummaryHandler)
// External API calls from Fail2ban servers that notify Fail2Ban-UI backend about ban/unban events that where triggered.
api.POST("/ban", BanNotificationHandler)
api.POST("/unban", UnbanNotificationHandler)
// Internal API calls from frontend (e.g. manual actions) to backend to execute Ban / Unban
api.POST("/jails/:jail/unban/:ip", UnbanIPHandler)
api.POST("/jails/:jail/ban/:ip", BanIPHandler)
// Routes for jail-filter management (TODO: rename API-call)
// Internal API calls for jail-filter management (TODO: rename API-call)
api.GET("/jails/:jail/config", GetJailFilterConfigHandler)
api.POST("/jails/:jail/config", SetJailFilterConfigHandler)
api.POST("/jails/:jail/logpath/test", TestLogpathHandler)
// Routes for jail management
api.GET("/jails/manage", ManageJailsHandler)
api.POST("/jails/manage", UpdateJailManagementHandler)
api.POST("/jails", CreateJailHandler)
api.DELETE("/jails/:jail", DeleteJailHandler)
// Version and update check (only on page load; UPDATE_CHECK=false disables GitHub request)
api.GET("/version", GetVersionHandler)
// Internal API calls for filter management
api.GET("/filters", ListFiltersHandler)
api.GET("/filters/:filter/content", GetFilterContentHandler)
api.POST("/filters/test", TestFilterHandler)
api.POST("/filters", CreateFilterHandler)
api.DELETE("/filters/:filter", DeleteFilterHandler)
// Settings endpoints
// Internal API calls for Fail2ban-UI settings
api.GET("/settings", GetSettingsHandler)
api.POST("/settings", UpdateSettingsHandler)
api.POST("/settings/test-email", TestEmailHandler)
// Internal API calls for advanced actions
api.GET("/advanced-actions/blocks", ListPermanentBlocksHandler)
api.POST("/advanced-actions/test", AdvancedActionsTestHandler)
// Fail2ban servers management
// Internal API calls for Fail2ban-UI server management
api.GET("/servers", ListServersHandler)
api.POST("/servers", UpsertServerHandler)
api.DELETE("/servers/:id", DeleteServerHandler)
@@ -76,26 +90,18 @@ func RegisterRoutes(r *gin.Engine, hub *Hub) {
api.GET("/ssh/keys", ListSSHKeysHandler)
api.POST("/servers/:id/test", TestServerHandler)
// Filter debugger endpoints
api.GET("/filters", ListFiltersHandler)
api.GET("/filters/:filter/content", GetFilterContentHandler)
api.POST("/filters/test", TestFilterHandler)
api.POST("/filters", CreateFilterHandler)
api.DELETE("/filters/:filter", DeleteFilterHandler)
// Restart endpoint
// Internal API to restart Fail2ban
api.POST("/fail2ban/restart", RestartFail2banHandler)
// Handle Fail2Ban notifications
api.POST("/ban", BanNotificationHandler)
api.POST("/unban", UnbanNotificationHandler)
// Internal database overview
// Internal API calls to get the stats of the bans
api.GET("/events/bans", ListBanEventsHandler)
api.GET("/events/bans/stats", BanStatisticsHandler)
api.GET("/events/bans/insights", BanInsightsHandler)
// WebSocket endpoint
api.GET("/ws", WebSocketHandler(hub))
// Internal & external API to get the version of the Fail2ban-UI and check for updates
api.GET("/version", GetVersionHandler)
}
}