mirror of
https://github.com/portainer/portainer.git
synced 2025-07-20 13:59:40 +02:00
f674573cdf
* add updateSettingsToDB28 func and test * update DBversion const * migration func naming modification * feat(oauth): add sso, hide internal auth teaser and logout options. (#5039) * cleanup and make helper func for unit testing * dbversion update * feat(publicSettings): public settings response modification for OAuth SSO EE-608 (#5062) * feat(oauth): updated logout logic with logoutUrl. (#5064) * add exclusive token generation for OAuth * swagger annotation revision * add unit test * updates based on tech review feedback * feat(oauth): updated oauth settings model * feat(oauth): added oauth logout url * feat(oauth): fixed SSO toggle and logout issue. * set SSO to ON by default * update migrator unit test * set SSO to true by default for new instance * prevent applying the SSO logout url to the initial admin user Co-authored-by: fhanportainer <79428273+fhanportainer@users.noreply.github.com> Co-authored-by: Felix Han <felix.han@portainer.io>
67 lines
2.9 KiB
Go
67 lines
2.9 KiB
Go
package settings
|
|
|
|
import (
|
|
"fmt"
|
|
"net/http"
|
|
|
|
httperror "github.com/portainer/libhttp/error"
|
|
"github.com/portainer/libhttp/response"
|
|
portainer "github.com/portainer/portainer/api"
|
|
)
|
|
|
|
type publicSettingsResponse struct {
|
|
// URL to a logo that will be displayed on the login page as well as on top of the sidebar. Will use default Portainer logo when value is empty string
|
|
LogoURL string `json:"LogoURL" example:"https://mycompany.mydomain.tld/logo.png"`
|
|
// Active authentication method for the Portainer instance. Valid values are: 1 for internal, 2 for LDAP, or 3 for oauth
|
|
AuthenticationMethod portainer.AuthenticationMethod `json:"AuthenticationMethod" example:"1"`
|
|
// Whether edge compute features are enabled
|
|
EnableEdgeComputeFeatures bool `json:"EnableEdgeComputeFeatures" example:"true"`
|
|
// The URL used for oauth login
|
|
OAuthLoginURI string `json:"OAuthLoginURI" example:"https://gitlab.com/oauth"`
|
|
// The URL used for oauth logout
|
|
OAuthLogoutURI string `json:"OAuthLogoutURI" example:"https://gitlab.com/oauth/logout"`
|
|
// Whether telemetry is enabled
|
|
EnableTelemetry bool `json:"EnableTelemetry" example:"true"`
|
|
}
|
|
|
|
// @id SettingsPublic
|
|
// @summary Retrieve Portainer public settings
|
|
// @description Retrieve public settings. Returns a small set of settings that are not reserved to administrators only.
|
|
// @description **Access policy**: public
|
|
// @tags settings
|
|
// @produce json
|
|
// @success 200 {object} publicSettingsResponse "Success"
|
|
// @failure 500 "Server error"
|
|
// @router /settings/public [get]
|
|
func (handler *Handler) settingsPublic(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
|
|
settings, err := handler.DataStore.Settings().Settings()
|
|
if err != nil {
|
|
return &httperror.HandlerError{StatusCode: http.StatusInternalServerError, Message: "Unable to retrieve the settings from the database", Err: err}
|
|
}
|
|
|
|
publicSettings := generatePublicSettings(settings)
|
|
return response.JSON(w, publicSettings)
|
|
}
|
|
|
|
func generatePublicSettings(appSettings *portainer.Settings) *publicSettingsResponse {
|
|
publicSettings := &publicSettingsResponse{
|
|
LogoURL: appSettings.LogoURL,
|
|
AuthenticationMethod: appSettings.AuthenticationMethod,
|
|
EnableEdgeComputeFeatures: appSettings.EnableEdgeComputeFeatures,
|
|
EnableTelemetry: appSettings.EnableTelemetry,
|
|
}
|
|
//if OAuth authentication is on, compose the related fields from application settings
|
|
if publicSettings.AuthenticationMethod == portainer.AuthenticationOAuth {
|
|
publicSettings.OAuthLogoutURI = appSettings.OAuthSettings.LogoutURI
|
|
publicSettings.OAuthLoginURI = fmt.Sprintf("%s?response_type=code&client_id=%s&redirect_uri=%s&scope=%s",
|
|
appSettings.OAuthSettings.AuthorizationURI,
|
|
appSettings.OAuthSettings.ClientID,
|
|
appSettings.OAuthSettings.RedirectURI,
|
|
appSettings.OAuthSettings.Scopes)
|
|
//control prompt=login param according to the SSO setting
|
|
if !appSettings.OAuthSettings.SSO {
|
|
publicSettings.OAuthLoginURI += "&prompt=login"
|
|
}
|
|
}
|
|
return publicSettings
|
|
}
|