add cleanup webhook called on disconnect and shutdown

Author: devinchristianson

config/appconfig.go

@@ -19,6 +19,9 @@ type AppConfig struct {
 	// Auth contains the configuration for user authentication.
 	// swagger:ignore
 	Auth AuthConfig `json:"auth" yaml:"auth"`
+	// CleanupServer contains the settings for fetching the user-specific cleanup webhook.
+	// swagger:ignore
+	CleanupServer HTTPClientConfiguration `json:"cleanupserver" yaml:"cleanupserver"`
 	// Log contains the configuration for the logging level.
 	// swagger:ignore
 	Log LogConfig `json:"log" yaml:"log"`
@@ -119,6 +122,9 @@ func (cfg *AppConfig) Validate(dynamic bool) error {
 	queue.add("geoip", &cfg.GeoIP)
 	queue.add("audit", &cfg.Audit)
 	queue.add("health", &cfg.Health)
+	if cfg.CleanupServer.URL != "" {
+		queue.add("cleanupserver", &cfg.CleanupServer)
+	}
 
 	if cfg.ConfigServer.URL != "" && !dynamic {
 		return queue.Validate()

internal/backend/handler.go

@@ -9,6 +9,7 @@ import (
 
     auth2 "go.containerssh.io/libcontainerssh/auth"
     "go.containerssh.io/libcontainerssh/config"
+    "go.containerssh.io/libcontainerssh/http"
     internalConfig "go.containerssh.io/libcontainerssh/internal/config"
     "go.containerssh.io/libcontainerssh/internal/docker"
     "go.containerssh.io/libcontainerssh/internal/kubernetes"
@@ -27,6 +28,7 @@ type handler struct {
 
 	config                 config.AppConfig
 	configLoader           internalConfig.Loader
+	cleanupClient          http.Client
 	authResponse           sshserver.AuthResponse
 	metricsCollector       metrics.Collector
 	logger                 log.Logger
@@ -219,6 +221,7 @@ func (n *networkHandler) OnDisconnect() {
 	n.lock.Lock()
 	defer n.lock.Unlock()
 	if n.backend != nil {
+		n.cleanupWebhook()
 		n.backend.OnDisconnect()
 		n.backend = nil
 	}
@@ -227,10 +230,26 @@ func (n *networkHandler) OnDisconnect() {
 func (n *networkHandler) OnShutdown(shutdownContext context.Context) {
 	n.lock.Lock()
 	if n.backend != nil {
+		n.cleanupWebhook()
 		backend := n.backend
 		n.lock.Unlock()
 		backend.OnShutdown(shutdownContext)
 	} else {
 		n.lock.Unlock()
 	}
 }
+
+func (n *networkHandler) cleanupWebhook() {
+	if n.rootHandler.cleanupClient != nil {
+		_, err := n.rootHandler.cleanupClient.Post("", map[string]interface{}{
+			"connectionId": n.connectionID,
+		}, nil)
+		if err != nil {
+			n.logger.Error(message.Wrap(
+				err,
+				message.ECleanupWebhook,
+				"Got unexpected response from cleanup webhook",
+			))
+		}
+	}
+}

internal/backend/handler_factory.go

@@ -4,6 +4,7 @@ import (
 	"sync"
 
     "go.containerssh.io/libcontainerssh/config"
+    "go.containerssh.io/libcontainerssh/http"
     internalConfig "go.containerssh.io/libcontainerssh/internal/config"
     "go.containerssh.io/libcontainerssh/internal/metrics"
     "go.containerssh.io/libcontainerssh/internal/sshserver"
@@ -26,7 +27,16 @@ func New(
 	if err != nil {
 		return nil, err
 	}
-
+	var cleanupClient http.Client
+	if config.CleanupServer.URL != "" {
+		cleanupClient, err = http.NewClient(
+			config.CleanupServer,
+			logger,
+		)
+		if err != nil {
+			return nil, err
+		}
+	}
 	backendRequestsCounter := metricsCollector.MustCreateCounter(
 		MetricNameBackendRequests,
 		MetricUnitBackendRequests,
@@ -41,6 +51,7 @@ func New(
 	return &handler{
 		config:                 config,
 		configLoader:           loader,
+		cleanupClient:          cleanupClient,
 		authResponse:           defaultAuthResponse,
 		metricsCollector:       metricsCollector,
 		logger:                 logger,

message/backend.go

@@ -2,3 +2,6 @@ package message
 
 // EBackendConfig indicates that there is an error in the backend configuration.
 const EBackendConfig = "BACKEND_CONFIG_ERROR"
+
+// ECleanupWebhook indicates that in calling the cleanup webhook
+const ECleanupWebhook = "BACKEND_CLEANUP_WEBHOOK_ERROR"