mirror of
https://github.com/portainer/portainer.git
synced 2025-07-19 05:19:39 +02:00
* feat(api): introduce swagger * feat(api): anottate api * chore(api): tag endpoints * chore(api): remove tags * chore(api): add docs for oauth auth * chore(api): document create endpoint api * chore(api): document endpoint inspect and list * chore(api): document endpoint update and snapshots * docs(endpointgroups): document groups api * docs(auth): document auth api * chore(build): introduce a yarn script to build api docs * docs(api): document auth * docs(customtemplates): document customtemplates api * docs(tags): document api * docs(api): document the use of token * docs(dockerhub): document dockerhub api * docs(edgegroups): document edgegroups api * docs(edgejobs): document api * docs(edgestacks): doc api * docs(http/upload): add security * docs(api): document edge templates * docs(edge): document edge jobs * docs(endpointgroups): change description * docs(endpoints): document missing apis * docs(motd): doc api * docs(registries): doc api * docs(resourcecontrol): api doc * docs(role): add swagger docs * docs(settings): add swagger docs * docs(api/status): add swagger docs * docs(api/teammembership): add swagger docs * docs(api/teams): add swagger docs * docs(api/templates): add swagger docs * docs(api/users): add swagger docs * docs(api/webhooks): add swagger docs * docs(api/webscokets): add swagger docs * docs(api/stacks): swagger * docs(api): fix missing apis * docs(swagger): regen * chore(build): remove docs from build * docs(api): update tags * docs(api): document tags * docs(api): add description * docs(api): rename jwt token * docs(api): add info about types * docs(api): document types * docs(api): update request types annotation * docs(api): doc registry and resource control * chore(docs): add snippet * docs(api): add description to role * docs(api): add types for settings * docs(status): add types * style(swagger): remove documented code * docs(http/upload): update docs with types * docs(http/tags): add types * docs(api/custom_templates): add types * docs(api/teammembership): add types * docs(http/teams): add types * docs(http/stacks): add types * docs(edge): add types to edgestack * docs(http/teammembership): remove double returns * docs(api/user): add types * docs(http): fixes to make file built * chore(snippets): add scope to swagger snippet * chore(deps): install swag * chore(swagger): remove handler * docs(api): add description * docs(api): ignore docs folder * docs(api): add contributing guidelines * docs(api): cleanup handler * chore(deps): require swaggo * fix(auth): fix typo * fix(docs): make http ids pascal case * feat(edge): add ids to http handlers * fix(docs): add ids * fix(docs): show correct api version * chore(deps): remove swaggo dependency * chore(docs): add install script for swag
114 lines
3.6 KiB
Go
114 lines
3.6 KiB
Go
package auth
|
|
|
|
import (
|
|
"errors"
|
|
"log"
|
|
"net/http"
|
|
|
|
"github.com/asaskevich/govalidator"
|
|
httperror "github.com/portainer/libhttp/error"
|
|
"github.com/portainer/libhttp/request"
|
|
portainer "github.com/portainer/portainer/api"
|
|
bolterrors "github.com/portainer/portainer/api/bolt/errors"
|
|
httperrors "github.com/portainer/portainer/api/http/errors"
|
|
)
|
|
|
|
type oauthPayload struct {
|
|
// OAuth code returned from OAuth Provided
|
|
Code string
|
|
}
|
|
|
|
func (payload *oauthPayload) Validate(r *http.Request) error {
|
|
if govalidator.IsNull(payload.Code) {
|
|
return errors.New("Invalid OAuth authorization code")
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// @id AuthenticateOauth
|
|
// @summary Authenticate with OAuth
|
|
// @tags auth
|
|
// @accept json
|
|
// @produce json
|
|
// @param body body oauthPayload true "OAuth Credentials used for authentication"
|
|
// @success 200 {object} authenticateResponse "Success"
|
|
// @failure 400 "Invalid request"
|
|
// @failure 422 "Invalid Credentials"
|
|
// @failure 500 "Server error"
|
|
// @router /auth/oauth/validate [post]
|
|
func (handler *Handler) authenticateOAuth(code string, settings *portainer.OAuthSettings) (string, error) {
|
|
if code == "" {
|
|
return "", errors.New("Invalid OAuth authorization code")
|
|
}
|
|
|
|
if settings == nil {
|
|
return "", errors.New("Invalid OAuth configuration")
|
|
}
|
|
|
|
username, err := handler.OAuthService.Authenticate(code, settings)
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
|
|
return username, nil
|
|
}
|
|
|
|
func (handler *Handler) validateOAuth(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
|
|
var payload oauthPayload
|
|
err := request.DecodeAndValidateJSONPayload(r, &payload)
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusBadRequest, "Invalid request payload", err}
|
|
}
|
|
|
|
settings, err := handler.DataStore.Settings().Settings()
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to retrieve settings from the database", err}
|
|
}
|
|
|
|
if settings.AuthenticationMethod != 3 {
|
|
return &httperror.HandlerError{http.StatusForbidden, "OAuth authentication is not enabled", errors.New("OAuth authentication is not enabled")}
|
|
}
|
|
|
|
username, err := handler.authenticateOAuth(payload.Code, &settings.OAuthSettings)
|
|
if err != nil {
|
|
log.Printf("[DEBUG] - OAuth authentication error: %s", err)
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to authenticate through OAuth", httperrors.ErrUnauthorized}
|
|
}
|
|
|
|
user, err := handler.DataStore.User().UserByUsername(username)
|
|
if err != nil && err != bolterrors.ErrObjectNotFound {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to retrieve a user with the specified username from the database", err}
|
|
}
|
|
|
|
if user == nil && !settings.OAuthSettings.OAuthAutoCreateUsers {
|
|
return &httperror.HandlerError{http.StatusForbidden, "Account not created beforehand in Portainer and automatic user provisioning not enabled", httperrors.ErrUnauthorized}
|
|
}
|
|
|
|
if user == nil {
|
|
user = &portainer.User{
|
|
Username: username,
|
|
Role: portainer.StandardUserRole,
|
|
}
|
|
|
|
err = handler.DataStore.User().CreateUser(user)
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to persist user inside the database", err}
|
|
}
|
|
|
|
if settings.OAuthSettings.DefaultTeamID != 0 {
|
|
membership := &portainer.TeamMembership{
|
|
UserID: user.ID,
|
|
TeamID: settings.OAuthSettings.DefaultTeamID,
|
|
Role: portainer.TeamMember,
|
|
}
|
|
|
|
err = handler.DataStore.TeamMembership().CreateTeamMembership(membership)
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to persist team membership inside the database", err}
|
|
}
|
|
}
|
|
|
|
}
|
|
|
|
return handler.writeToken(w, user)
|
|
}
|