portainer/portainer

package endpoints

import (
    "net/http"

    portainer "github.com/portainer/portainer/api"
    "github.com/portainer/portainer/api/dataservices"
    "github.com/portainer/portainer/api/demo"
    dockerclient "github.com/portainer/portainer/api/docker/client"
    "github.com/portainer/portainer/api/http/proxy"
    "github.com/portainer/portainer/api/http/security"
    "github.com/portainer/portainer/api/internal/authorization"
    "github.com/portainer/portainer/api/kubernetes/cli"
    "github.com/portainer/portainer/api/pendingactions"
    httperror "github.com/portainer/portainer/pkg/libhttp/error"

    "github.com/gorilla/mux"
)

func hideFields(endpoint *portainer.Endpoint) {
    endpoint.AzureCredentials = portainer.AzureCredentials{}
    if len(endpoint.Snapshots) > 0 {
        endpoint.Snapshots[0].SnapshotRaw = portainer.DockerSnapshotRaw{}
    }
}

// Handler is the HTTP handler used to handle environment(endpoint) operations.
type Handler struct {
    *mux.Router
    requestBouncer        security.BouncerService
    demoService           *demo.Service
    DataStore             dataservices.DataStore
    FileService           portainer.FileService
    ProxyManager          *proxy.Manager
    ReverseTunnelService  portainer.ReverseTunnelService
    SnapshotService       portainer.SnapshotService
    K8sClientFactory      *cli.ClientFactory
    ComposeStackManager   portainer.ComposeStackManager
    AuthorizationService  *authorization.Service
    DockerClientFactory   *dockerclient.ClientFactory
    BindAddress           string
    BindAddressHTTPS      string
    PendingActionsService *pendingactions.PendingActionsService
}

// NewHandler creates a handler to manage environment(endpoint) operations.
func NewHandler(bouncer security.BouncerService, demoService *demo.Service) *Handler {
    h := &Handler{
        Router:         mux.NewRouter(),
        requestBouncer: bouncer,
        demoService:    demoService,
    }

    h.Handle("/endpoints",
        bouncer.AdminAccess(httperror.LoggerHandler(h.endpointCreate))).Methods(http.MethodPost)
    h.Handle("/endpoints/{id}/settings",
        bouncer.AdminAccess(httperror.LoggerHandler(h.endpointSettingsUpdate))).Methods(http.MethodPut)
    h.Handle("/endpoints/{id}/association",
        bouncer.AdminAccess(httperror.LoggerHandler(h.endpointAssociationDelete))).Methods(http.MethodDelete)
    h.Handle("/endpoints/snapshot",
        bouncer.AdminAccess(httperror.LoggerHandler(h.endpointSnapshots))).Methods(http.MethodPost)
    h.Handle("/endpoints",
        bouncer.RestrictedAccess(httperror.LoggerHandler(h.endpointList))).Methods(http.MethodGet)
    h.Handle("/endpoints/agent_versions",
        bouncer.RestrictedAccess(httperror.LoggerHandler(h.agentVersions))).Methods(http.MethodGet)
    h.Handle("/endpoints/relations", bouncer.RestrictedAccess(httperror.LoggerHandler(h.updateRelations))).Methods(http.MethodPut)

    h.Handle("/endpoints/{id}",
        bouncer.RestrictedAccess(httperror.LoggerHandler(h.endpointInspect))).Methods(http.MethodGet)
    h.Handle("/endpoints/{id}",
        bouncer.AdminAccess(httperror.LoggerHandler(h.endpointUpdate))).Methods(http.MethodPut)
    h.Handle("/endpoints/{id}",
        bouncer.AdminAccess(httperror.LoggerHandler(h.endpointDelete))).Methods(http.MethodDelete)
    h.Handle("/endpoints/remove",
        bouncer.AdminAccess(httperror.LoggerHandler(h.endpointDeleteMultiple))).Methods(http.MethodPost)
    h.Handle("/endpoints/{id}/dockerhub/{registryId}",
        bouncer.AuthenticatedAccess(httperror.LoggerHandler(h.endpointDockerhubStatus))).Methods(http.MethodGet)
    h.Handle("/endpoints/{id}/snapshot",
        bouncer.AdminAccess(httperror.LoggerHandler(h.endpointSnapshot))).Methods(http.MethodPost)
    h.Handle("/endpoints/{id}/registries",
        bouncer.AuthenticatedAccess(httperror.LoggerHandler(h.endpointRegistriesList))).Methods(http.MethodGet)
    h.Handle("/endpoints/{id}/registries/{registryId}",
        bouncer.AuthenticatedAccess(httperror.LoggerHandler(h.endpointRegistryAccess))).Methods(http.MethodPut)

    h.Handle("/endpoints/global-key", bouncer.PublicAccess(httperror.LoggerHandler(h.endpointCreateGlobalKey))).Methods(http.MethodPost)
    h.Handle("/endpoints/{id}/forceupdateservice",
        bouncer.AuthenticatedAccess(httperror.LoggerHandler(h.endpointForceUpdateService))).Methods(http.MethodPut)

    // DEPRECATED
    h.Handle("/endpoints/{id}/status", bouncer.PublicAccess(httperror.LoggerHandler(h.endpointStatusInspect))).Methods(http.MethodGet)

    return h
}