mirror of
https://github.com/portainer/portainer.git
synced 2025-07-20 13:59:40 +02:00
69c17986d9
* feat(access-token): Multi-auth middleware support EE-1891 (#5936) * AnyAuth middleware initial implementation with tests * using mux.MiddlewareFunc instead of custom definition * removed redundant comments * - ExtractBearerToken bouncer func made private - changed helm token handling functionality to use jwt service to convert token to jwt string - updated tests - fixed helm list broken test due to missing token in request context * rename mwCheckAuthentication -> mwCheckJWTAuthentication * - introduce initial api-key auth support using X-API-KEY header - added tests to validate x-api-key request header presence * updated core mwAuthenticatedUser middleware to support multiple auth paradigms * - simplified anyAuth middleware - enforcing authmiddleware to implement verificationFunc interface - created tests for middleware * simplify bouncer Co-authored-by: Dmitry Salakhov <to@dimasalakhov.com> * feat(api-key): user-access-token generation endpoint EE-1889 EE-1888 EE-1895 (#6012) * user-access-token generation endpoint * fix comment * - introduction of apikey service - seperation of repository from service logic - called in handler * fixed tests * - fixed api key prefix - added tests * added another test for digest matching * updated swagger spec for access token creation * api key response returns raw key and struct - easing testability * test for api key prefix length * added another TODO to middleware * - api-key prefix rune -> string (rune does not auto-encode when response sent back to client) - digest -> pointer as we want to allow nil values and omit digest in responses (when nil) * - updated apikey struct - updated apikey service to support all common operations - updated apikey repo - integration of apikey service into bouncer - added test for all apikey service functions - boilerplate code for apikey service integration * - user access token generation tests - apiKeyLookup updated to support query params - added api-key tests for query params - added api-key tests for apiKeyLookup * get and remove access token handlers * get and remove access token handler tests * - delete user deletes all associated api keys - tests for this functionality * removed redundant []byte cast * automatic api-key eviction set within cache for 1 hour * fixed bug with loop var using final value * fixed service comment * ignore bolt error responses * case-insensitive query param check * simplified query var assignment * - added GetAPIKey func to get by unique id - updated DeleteAPIKey func to not require user ID - updated tests * GenerateRandomKey helper func from github.com/gorilla/securecookie moved to codebase * json response casing for api-keys fixed * updating api-key will update the cache * updated golang LRU cache * using hashicorps golang-LRU cache for api keys * simplified jwt check in create user access token * fixed api-key update logic on cache miss * Prefix generated api-keys with `ptr_` (#6067) * prefix api-keys with 'ptr_' * updated apikey description * refactor Co-authored-by: Dmitry Salakhov <to@dimasalakhov.com> * helm list test refactor * fixed user delete test * reduce test nil pointer errors * using correct http 201 created status code for token creation; updated tests * fixed swagger doc user id path param for user access token based endpoints * added api-key security openapi spec to existing jwt secured endpoints (#6091) * fixed flaky test * apikey datecreated and lastused attrs converted to unix timestamp * feat(user): added access token datatable. (#6124) * feat(user): added access token datatable. * feat(tokens): only display lastUsed time when it is not the default date * Update app/portainer/views/account/accountController.js Co-authored-by: zees-dev <63374656+zees-dev@users.noreply.github.com> * Update app/portainer/views/account/accountController.js Co-authored-by: zees-dev <63374656+zees-dev@users.noreply.github.com> * Update app/portainer/views/account/accountController.js Co-authored-by: zees-dev <63374656+zees-dev@users.noreply.github.com> * Update app/portainer/components/datatables/access-tokens-datatable/accessTokensDatatableController.js Co-authored-by: zees-dev <63374656+zees-dev@users.noreply.github.com> * Update app/portainer/services/api/userService.js Co-authored-by: zees-dev <63374656+zees-dev@users.noreply.github.com> * feat(improvements): proposed datatable improvements to speed up dev time (#6138) * modal code update * updated datatable filenames, updated controller to be default class export * fix(access-token): code improvement. Co-authored-by: zees-dev <63374656+zees-dev@users.noreply.github.com> * feat(apikeys): create access token view initial implementation EE-1886 (#6129) * CopyButton implementation * Code component implementation * ToolTip component migration to another folder * TextTip component implementation - continued * form Heading component * Button component updated to be more dynamic * copybutton - small size * form control pass tip error * texttip small text * CreateAccessToken react feature initial implementation * create user access token angularjs view implementation * registration of CreateAccessToken component in AngularJS * user token generation API request moved to angular service, method passed down instead * consistent naming of access token operations; clustered similar code together * any user can add access token * create access token page routing * moved code component to the correct location * removed isadmin check as all functionality applicable to all users * create access token angular view moved up a level * fixed PR issues, updated PR * addressed PR issues/improvements * explicit hr for horizontal line * fixed merge conflict storybook build breaking * - apikey test - cache test * addressed testing issues: - description validations - remove token description link on table * fix(api-keys): user role change evicts user keys in cache EE-2113 (#6168) * user role change evicts user api keys in cache * EvictUserKeyCache -> InvalidateUserKeyCache * godoc for InvalidateUserKeyCache func * additional test line * disable add access token button after adding token to prevent spam Co-authored-by: Dmitry Salakhov <to@dimasalakhov.com> Co-authored-by: fhanportainer <79428273+fhanportainer@users.noreply.github.com>
247 lines
11 KiB
Go
247 lines
11 KiB
Go
package handler
|
|
|
|
import (
|
|
"net/http"
|
|
"strings"
|
|
|
|
"github.com/portainer/portainer/api/http/handler/auth"
|
|
"github.com/portainer/portainer/api/http/handler/backup"
|
|
"github.com/portainer/portainer/api/http/handler/customtemplates"
|
|
"github.com/portainer/portainer/api/http/handler/edgegroups"
|
|
"github.com/portainer/portainer/api/http/handler/edgejobs"
|
|
"github.com/portainer/portainer/api/http/handler/edgestacks"
|
|
"github.com/portainer/portainer/api/http/handler/edgetemplates"
|
|
"github.com/portainer/portainer/api/http/handler/endpointedge"
|
|
"github.com/portainer/portainer/api/http/handler/endpointgroups"
|
|
"github.com/portainer/portainer/api/http/handler/endpointproxy"
|
|
"github.com/portainer/portainer/api/http/handler/endpoints"
|
|
"github.com/portainer/portainer/api/http/handler/file"
|
|
"github.com/portainer/portainer/api/http/handler/helm"
|
|
"github.com/portainer/portainer/api/http/handler/hostmanagement/openamt"
|
|
"github.com/portainer/portainer/api/http/handler/kubernetes"
|
|
"github.com/portainer/portainer/api/http/handler/ldap"
|
|
"github.com/portainer/portainer/api/http/handler/motd"
|
|
"github.com/portainer/portainer/api/http/handler/registries"
|
|
"github.com/portainer/portainer/api/http/handler/resourcecontrols"
|
|
"github.com/portainer/portainer/api/http/handler/roles"
|
|
"github.com/portainer/portainer/api/http/handler/settings"
|
|
"github.com/portainer/portainer/api/http/handler/ssl"
|
|
"github.com/portainer/portainer/api/http/handler/stacks"
|
|
"github.com/portainer/portainer/api/http/handler/status"
|
|
"github.com/portainer/portainer/api/http/handler/storybook"
|
|
"github.com/portainer/portainer/api/http/handler/tags"
|
|
"github.com/portainer/portainer/api/http/handler/teammemberships"
|
|
"github.com/portainer/portainer/api/http/handler/teams"
|
|
"github.com/portainer/portainer/api/http/handler/templates"
|
|
"github.com/portainer/portainer/api/http/handler/upload"
|
|
"github.com/portainer/portainer/api/http/handler/users"
|
|
"github.com/portainer/portainer/api/http/handler/webhooks"
|
|
"github.com/portainer/portainer/api/http/handler/websocket"
|
|
)
|
|
|
|
// Handler is a collection of all the service handlers.
|
|
type Handler struct {
|
|
AuthHandler *auth.Handler
|
|
BackupHandler *backup.Handler
|
|
CustomTemplatesHandler *customtemplates.Handler
|
|
EdgeGroupsHandler *edgegroups.Handler
|
|
EdgeJobsHandler *edgejobs.Handler
|
|
EdgeStacksHandler *edgestacks.Handler
|
|
EdgeTemplatesHandler *edgetemplates.Handler
|
|
EndpointEdgeHandler *endpointedge.Handler
|
|
EndpointGroupHandler *endpointgroups.Handler
|
|
EndpointHandler *endpoints.Handler
|
|
EndpointHelmHandler *helm.Handler
|
|
EndpointProxyHandler *endpointproxy.Handler
|
|
HelmTemplatesHandler *helm.Handler
|
|
KubernetesHandler *kubernetes.Handler
|
|
FileHandler *file.Handler
|
|
LDAPHandler *ldap.Handler
|
|
MOTDHandler *motd.Handler
|
|
RegistryHandler *registries.Handler
|
|
ResourceControlHandler *resourcecontrols.Handler
|
|
RoleHandler *roles.Handler
|
|
SettingsHandler *settings.Handler
|
|
SSLHandler *ssl.Handler
|
|
OpenAMTHandler *openamt.Handler
|
|
StackHandler *stacks.Handler
|
|
StatusHandler *status.Handler
|
|
StorybookHandler *storybook.Handler
|
|
TagHandler *tags.Handler
|
|
TeamMembershipHandler *teammemberships.Handler
|
|
TeamHandler *teams.Handler
|
|
TemplatesHandler *templates.Handler
|
|
UploadHandler *upload.Handler
|
|
UserHandler *users.Handler
|
|
WebSocketHandler *websocket.Handler
|
|
WebhookHandler *webhooks.Handler
|
|
}
|
|
|
|
// @title PortainerCE API
|
|
// @version 2.9.3
|
|
// @description.markdown api-description.md
|
|
// @termsOfService
|
|
|
|
// @contact.email info@portainer.io
|
|
|
|
// @license.name zlib
|
|
// @license.url https://github.com/portainer/portainer/blob/develop/LICENSE
|
|
|
|
// @host
|
|
// @BasePath /api
|
|
// @schemes http https
|
|
|
|
// @securitydefinitions.apikey ApiKeyAuth
|
|
// @in header
|
|
// @name Authorization
|
|
|
|
// @securitydefinitions.apikey jwt
|
|
// @in header
|
|
// @name Authorization
|
|
|
|
// @tag.name auth
|
|
// @tag.description Authenticate against Portainer HTTP API
|
|
// @tag.name custom_templates
|
|
// @tag.description Manage Custom Templates
|
|
// @tag.name edge_groups
|
|
// @tag.description Manage Edge Groups
|
|
// @tag.name edge_jobs
|
|
// @tag.description Manage Edge Jobs
|
|
// @tag.name edge_stacks
|
|
// @tag.description Manage Edge Stacks
|
|
// @tag.name edge_templates
|
|
// @tag.description Manage Edge Templates
|
|
// @tag.name edge
|
|
// @tag.description Manage Edge related environment(endpoint) settings
|
|
// @tag.name endpoints
|
|
// @tag.description Manage Docker environments(endpoints)
|
|
// @tag.name endpoint_groups
|
|
// @tag.description Manage environment(endpoint) groups
|
|
// @tag.name kubernetes
|
|
// @tag.description Manage Kubernetes cluster
|
|
// @tag.name motd
|
|
// @tag.description Fetch the message of the day
|
|
// @tag.name registries
|
|
// @tag.description Manage Docker registries
|
|
// @tag.name resource_controls
|
|
// @tag.description Manage access control on Docker resources
|
|
// @tag.name roles
|
|
// @tag.description Manage roles
|
|
// @tag.name settings
|
|
// @tag.description Manage Portainer settings
|
|
// @tag.name status
|
|
// @tag.description Information about the Portainer instance
|
|
// @tag.name users
|
|
// @tag.description Manage users
|
|
// @tag.name tags
|
|
// @tag.description Manage tags
|
|
// @tag.name teams
|
|
// @tag.description Manage teams
|
|
// @tag.name team_memberships
|
|
// @tag.description Manage team memberships
|
|
// @tag.name templates
|
|
// @tag.description Manage App Templates
|
|
// @tag.name stacks
|
|
// @tag.description Manage stacks
|
|
// @tag.name ssl
|
|
// @tag.description Manage ssl settings
|
|
// @tag.name upload
|
|
// @tag.description Upload files
|
|
// @tag.name webhooks
|
|
// @tag.description Manage webhooks
|
|
// @tag.name websocket
|
|
// @tag.description Create exec sessions using websockets
|
|
|
|
// ServeHTTP delegates a request to the appropriate subhandler.
|
|
func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
|
|
switch {
|
|
case strings.HasPrefix(r.URL.Path, "/api/auth"):
|
|
http.StripPrefix("/api", h.AuthHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/api/backup"):
|
|
http.StripPrefix("/api", h.BackupHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/api/restore"):
|
|
http.StripPrefix("/api", h.BackupHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/api/custom_templates"):
|
|
http.StripPrefix("/api", h.CustomTemplatesHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/api/edge_stacks"):
|
|
http.StripPrefix("/api", h.EdgeStacksHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/api/edge_groups"):
|
|
http.StripPrefix("/api", h.EdgeGroupsHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/api/edge_jobs"):
|
|
http.StripPrefix("/api", h.EdgeJobsHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/api/edge_stacks"):
|
|
http.StripPrefix("/api", h.EdgeStacksHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/api/edge_templates"):
|
|
http.StripPrefix("/api", h.EdgeTemplatesHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/api/endpoint_groups"):
|
|
http.StripPrefix("/api", h.EndpointGroupHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/api/kubernetes"):
|
|
http.StripPrefix("/api", h.KubernetesHandler).ServeHTTP(w, r)
|
|
|
|
// Helm subpath under kubernetes -> /api/endpoints/{id}/kubernetes/helm
|
|
case strings.HasPrefix(r.URL.Path, "/api/endpoints/") && strings.Contains(r.URL.Path, "/kubernetes/helm"):
|
|
http.StripPrefix("/api/endpoints", h.EndpointHelmHandler).ServeHTTP(w, r)
|
|
|
|
case strings.HasPrefix(r.URL.Path, "/api/endpoints"):
|
|
switch {
|
|
case strings.Contains(r.URL.Path, "/docker/"):
|
|
http.StripPrefix("/api/endpoints", h.EndpointProxyHandler).ServeHTTP(w, r)
|
|
case strings.Contains(r.URL.Path, "/kubernetes/"):
|
|
http.StripPrefix("/api/endpoints", h.EndpointProxyHandler).ServeHTTP(w, r)
|
|
case strings.Contains(r.URL.Path, "/storidge/"):
|
|
http.StripPrefix("/api/endpoints", h.EndpointProxyHandler).ServeHTTP(w, r)
|
|
case strings.Contains(r.URL.Path, "/azure/"):
|
|
http.StripPrefix("/api/endpoints", h.EndpointProxyHandler).ServeHTTP(w, r)
|
|
case strings.Contains(r.URL.Path, "/agent/"):
|
|
http.StripPrefix("/api/endpoints", h.EndpointProxyHandler).ServeHTTP(w, r)
|
|
case strings.Contains(r.URL.Path, "/edge/"):
|
|
http.StripPrefix("/api/endpoints", h.EndpointEdgeHandler).ServeHTTP(w, r)
|
|
default:
|
|
http.StripPrefix("/api", h.EndpointHandler).ServeHTTP(w, r)
|
|
}
|
|
case strings.HasPrefix(r.URL.Path, "/api/ldap"):
|
|
http.StripPrefix("/api", h.LDAPHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/api/motd"):
|
|
http.StripPrefix("/api", h.MOTDHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/api/registries"):
|
|
http.StripPrefix("/api", h.RegistryHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/api/resource_controls"):
|
|
http.StripPrefix("/api", h.ResourceControlHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/api/roles"):
|
|
http.StripPrefix("/api", h.RoleHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/api/settings"):
|
|
http.StripPrefix("/api", h.SettingsHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/api/stacks"):
|
|
http.StripPrefix("/api", h.StackHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/api/status"):
|
|
http.StripPrefix("/api", h.StatusHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/api/tags"):
|
|
http.StripPrefix("/api", h.TagHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/api/templates/helm"):
|
|
http.StripPrefix("/api", h.HelmTemplatesHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/api/templates"):
|
|
http.StripPrefix("/api", h.TemplatesHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/api/upload"):
|
|
http.StripPrefix("/api", h.UploadHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/api/users"):
|
|
http.StripPrefix("/api", h.UserHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/api/ssl"):
|
|
http.StripPrefix("/api", h.SSLHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/api/open_amt"):
|
|
if h.OpenAMTHandler != nil {
|
|
http.StripPrefix("/api", h.OpenAMTHandler).ServeHTTP(w, r)
|
|
}
|
|
case strings.HasPrefix(r.URL.Path, "/api/teams"):
|
|
http.StripPrefix("/api", h.TeamHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/api/team_memberships"):
|
|
http.StripPrefix("/api", h.TeamMembershipHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/api/websocket"):
|
|
http.StripPrefix("/api", h.WebSocketHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/api/webhooks"):
|
|
http.StripPrefix("/api", h.WebhookHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/storybook"):
|
|
http.StripPrefix("/storybook", h.StorybookHandler).ServeHTTP(w, r)
|
|
case strings.HasPrefix(r.URL.Path, "/"):
|
|
h.FileHandler.ServeHTTP(w, r)
|
|
}
|
|
}
|