// This file is part of MinIO Console Server // Copyright (c) 2021 MinIO, Inc. // // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU Affero General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU Affero General Public License for more details. // // You should have received a copy of the GNU Affero General Public License // along with this program. If not, see . // This file is safe to edit. Once it exists it will not be overwritten package restapi import ( "bytes" "crypto/tls" "crypto/x509" "io" "io/fs" "net/http" "strings" "time" portal_ui "github.com/minio/console/portal-ui" "github.com/go-openapi/errors" "github.com/go-openapi/swag" "github.com/minio/console/models" "github.com/minio/console/pkg/auth" "github.com/minio/console/restapi/operations" "github.com/unrolled/secure" ) //go:generate swagger generate server --target ../../console --name Console --spec ../swagger.yml var additionalServerFlags = struct { CertsDir string `long:"certs-dir" description:"path to certs directory" env:"CONSOLE_CERTS_DIR"` }{} func configureFlags(api *operations.ConsoleAPI) { api.CommandLineOptionsGroups = []swag.CommandLineOptionsGroup{ { ShortDescription: "additional server flags", Options: &additionalServerFlags, }, } } func configureAPI(api *operations.ConsoleAPI) http.Handler { // Applies when the "x-token" header is set api.KeyAuth = func(token string, scopes []string) (*models.Principal, error) { // we are validating the session token by decrypting the claims inside, if the operation succeed that means the jwt // was generated and signed by us in the first place claims, err := auth.SessionTokenAuthenticate(token) if err != nil { api.Logger("Unable to validate the session token %s: %v", token, err) return nil, errors.New(401, "incorrect api key auth") } return &models.Principal{ STSAccessKeyID: claims.STSAccessKeyID, Actions: claims.Actions, STSSecretAccessKey: claims.STSSecretAccessKey, STSSessionToken: claims.STSSessionToken, AccountAccessKey: claims.AccountAccessKey, }, nil } // Register login handlers registerLoginHandlers(api) // Register logout handlers registerLogoutHandlers(api) // Register bucket handlers registerBucketsHandlers(api) // Register all users handlers registerUsersHandlers(api) // Register groups handlers registerGroupsHandlers(api) // Register policies handlers registersPoliciesHandler(api) // Register configurations handlers registerConfigHandlers(api) // Register bucket events handlers registerBucketEventsHandlers(api) // Register bucket lifecycle handlers registerBucketsLifecycleHandlers(api) // Register service handlers registerServiceHandlers(api) // Register profiling handlers registerProfilingHandler(api) // Register session handlers registerSessionHandlers(api) // Register admin info handlers registerAdminInfoHandlers(api) // Register admin arns handlers registerAdminArnsHandlers(api) // Register admin notification endpoints handlers registerAdminNotificationEndpointsHandlers(api) // Register admin Service Account Handlers registerServiceAccountsHandlers(api) // Register admin remote buckets registerAdminBucketRemoteHandlers(api) // Register admin log search registerLogSearchHandlers(api) // Register admin subscription handlers registerSubscriptionHandlers(api) // Register Account handlers registerAdminTiersHandlers(api) // Operator Console // Register tenant handlers registerTenantHandlers(api) // Register ResourceQuota handlers registerResourceQuotaHandlers(api) // Register Nodes' handlers registerNodesHandlers(api) // Register Parity' handlers registerParityHandlers(api) // Register Object's Handlers registerObjectsHandlers(api) // Register Bucket Quota's Handlers registerBucketQuotaHandlers(api) // Register Account handlers registerAccountHandlers(api) // Direct CSI handlers registerDirectCSIHandlers(api) // Volumes handlers registerVolumesHandlers(api) api.PreServerShutdown = func() {} api.ServerShutdown = func() {} return setupGlobalMiddleware(api.Serve(setupMiddlewares)) } // The TLS configuration before HTTPS server starts. func configureTLS(tlsConfig *tls.Config) { if GlobalRootCAs == nil { GlobalRootCAs = &x509.CertPool{} } // Add the global public crts as part of global root CAs for _, publicCrt := range GlobalPublicCerts { // Add certificates to swagger TLS configuration tlsConfig.Certificates = append(tlsConfig.Certificates, tls.Certificate{ Certificate: [][]byte{publicCrt.Raw}, Leaf: publicCrt, }) GlobalRootCAs.AddCert(publicCrt) } tlsConfig.RootCAs = GlobalRootCAs if GlobalTLSCertsManager != nil { tlsConfig.GetCertificate = GlobalTLSCertsManager.GetCertificate } } // The middleware configuration is for the handler executors. These do not apply to the swagger.json document. // The middleware executes after routing but before authentication, binding and validation func setupMiddlewares(handler http.Handler) http.Handler { return handler } // The middleware configuration happens before anything, this middleware also applies to serving the swagger.json document. // So this is a good place to plug in a panic handling middleware, logging and metrics func setupGlobalMiddleware(handler http.Handler) http.Handler { // handle cookie or authorization header for session next := AuthenticationMiddleware(handler) // serve static files next = FileServerMiddleware(next) // Secure middleware, this middleware wrap all the previous handlers and add // HTTP security headers secureOptions := secure.Options{ AllowedHosts: getSecureAllowedHosts(), AllowedHostsAreRegex: getSecureAllowedHostsAreRegex(), HostsProxyHeaders: getSecureHostsProxyHeaders(), SSLRedirect: GetTLSRedirect() == "on" && len(GlobalPublicCerts) > 0, SSLHost: getSecureTLSHost(), STSSeconds: getSecureSTSSeconds(), STSIncludeSubdomains: getSecureSTSIncludeSubdomains(), STSPreload: getSecureSTSPreload(), SSLTemporaryRedirect: getSecureTLSTemporaryRedirect(), SSLHostFunc: nil, ForceSTSHeader: getSecureForceSTSHeader(), FrameDeny: getSecureFrameDeny(), ContentTypeNosniff: getSecureContentTypeNonSniff(), BrowserXssFilter: getSecureBrowserXSSFilter(), ContentSecurityPolicy: getSecureContentSecurityPolicy(), ContentSecurityPolicyReportOnly: getSecureContentSecurityPolicyReportOnly(), PublicKey: getSecurePublicKey(), ReferrerPolicy: getSecureReferrerPolicy(), FeaturePolicy: getSecureFeaturePolicy(), ExpectCTHeader: getSecureExpectCTHeader(), IsDevelopment: !getProductionMode(), } secureMiddleware := secure.New(secureOptions) return secureMiddleware.Handler(next) } func AuthenticationMiddleware(next http.Handler) http.Handler { return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { token, err := auth.GetTokenFromRequest(r) if err != nil && err != auth.ErrNoAuthToken { http.Error(w, err.Error(), http.StatusUnauthorized) return } // All handlers handle appropriately to return errors // based on their swagger rules, we do not need to // additionally return error here, let the next ServeHTTPs // handle it appropriately. if token != "" { r.Header.Add("Authorization", "Bearer "+token) } next.ServeHTTP(w, r) }) } // FileServerMiddleware serves files from the static folder func FileServerMiddleware(next http.Handler) http.Handler { return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { w.Header().Set("Server", globalAppName) // do not add version information switch { case strings.HasPrefix(r.URL.Path, "/ws"): serveWS(w, r) case strings.HasPrefix(r.URL.Path, "/api"): next.ServeHTTP(w, r) default: buildFs, err := fs.Sub(portal_ui.GetStaticAssets(), "build") if err != nil { panic(err) } wrapHandlerSinglePageApplication(http.FileServer(http.FS(buildFs))).ServeHTTP(w, r) } }) } type notFoundRedirectRespWr struct { http.ResponseWriter // We embed http.ResponseWriter status int } func (w *notFoundRedirectRespWr) WriteHeader(status int) { w.status = status // Store the status for our own use if status != http.StatusNotFound { w.ResponseWriter.WriteHeader(status) } } func (w *notFoundRedirectRespWr) Write(p []byte) (int, error) { if w.status != http.StatusNotFound { return w.ResponseWriter.Write(p) } return len(p), nil // Lie that we successfully wrote it } // wrapHandlerSinglePageApplication handles a http.FileServer returning a 404 and overrides it with index.html func wrapHandlerSinglePageApplication(h http.Handler) http.HandlerFunc { return func(w http.ResponseWriter, r *http.Request) { nfrw := ¬FoundRedirectRespWr{ResponseWriter: w} h.ServeHTTP(nfrw, r) if nfrw.status == 404 { indexPage, _ := portal_ui.GetStaticAssets().Open("build/index.html") indexPageBytes, _ := io.ReadAll(indexPage) w.Header().Set("Content-Type", "text/html; charset=utf-8") http.ServeContent(w, r, "index.html", time.Now(), bytes.NewReader(indexPageBytes)) } } }