Files
hanko/backend/handler/thirdparty.go
Lennart Fleischmann 062aee4d45 fix: SAML issues (#2041)
Rename identities table columns for more clarity. Rename parameters,
arguments etc. to accommodate these changes.
    
Change that the SAML provider domain is persisted in the identities
table as the provider ID. Use the SAML Entity ID/Issuer ID of the
IdP instead.
    
Introduce saml identity entity (including migrations and a persister)
as a specialization of an identity to allow for determining the
correct provider name to return to the client/frontend and for assisting
in determining whether an identity is a SAML identity (i.e. SAML
identities should have a corresponding SAML Identity instance while
OAuth/OIDC entities do not).
2025-01-31 14:17:52 +01:00

237 lines
7.6 KiB
Go

package handler
import (
"fmt"
"github.com/gobuffalo/pop/v6"
"github.com/labstack/echo/v4"
auditlog "github.com/teamhanko/hanko/backend/audit_log"
"github.com/teamhanko/hanko/backend/config"
"github.com/teamhanko/hanko/backend/dto"
"github.com/teamhanko/hanko/backend/dto/admin"
"github.com/teamhanko/hanko/backend/persistence"
"github.com/teamhanko/hanko/backend/persistence/models"
"github.com/teamhanko/hanko/backend/session"
"github.com/teamhanko/hanko/backend/thirdparty"
"github.com/teamhanko/hanko/backend/utils"
webhookUtils "github.com/teamhanko/hanko/backend/webhooks/utils"
"golang.org/x/oauth2"
"net/http"
"net/url"
)
type ThirdPartyHandler struct {
auditLogger auditlog.Logger
cfg *config.Config
persister persistence.Persister
sessionManager session.Manager
}
func NewThirdPartyHandler(cfg *config.Config, persister persistence.Persister, sessionManager session.Manager, auditLogger auditlog.Logger) *ThirdPartyHandler {
return &ThirdPartyHandler{
auditLogger: auditLogger,
cfg: cfg,
persister: persister,
sessionManager: sessionManager,
}
}
func (h *ThirdPartyHandler) Auth(c echo.Context) error {
errorRedirectTo := c.Request().Header.Get("Referer")
if errorRedirectTo == "" {
errorRedirectTo = h.cfg.ThirdParty.ErrorRedirectURL
}
var request dto.ThirdPartyAuthRequest
err := c.Bind(&request)
if err != nil {
return h.redirectError(c, thirdparty.ErrorServer("could not decode request payload").WithCause(err), errorRedirectTo)
}
err = c.Validate(request)
if err != nil {
return h.redirectError(c, thirdparty.ErrorInvalidRequest(err.Error()).WithCause(err), errorRedirectTo)
}
if ok := thirdparty.IsAllowedRedirect(h.cfg.ThirdParty, request.RedirectTo); !ok {
return h.redirectError(c, thirdparty.ErrorInvalidRequest(fmt.Sprintf("redirect to '%s' not allowed", request.RedirectTo)), errorRedirectTo)
}
provider, err := thirdparty.GetProvider(h.cfg.ThirdParty, request.Provider)
if err != nil {
return h.redirectError(c, thirdparty.ErrorInvalidRequest(err.Error()).WithCause(err), errorRedirectTo)
}
state, err := thirdparty.GenerateState(h.cfg, provider.ID(), request.RedirectTo)
if err != nil {
return h.redirectError(c, thirdparty.ErrorServer("could not generate state").WithCause(err), errorRedirectTo)
}
authCodeUrl := provider.AuthCodeURL(string(state), oauth2.SetAuthURLParam("prompt", "consent"))
cookie := utils.GenerateStateCookie(h.cfg, utils.HankoThirdpartyStateCookie, string(state), utils.CookieOptions{
MaxAge: 300,
Path: "/",
SameSite: http.SameSiteLaxMode,
})
c.SetCookie(cookie)
return c.Redirect(http.StatusTemporaryRedirect, authCodeUrl)
}
func (h *ThirdPartyHandler) CallbackPost(c echo.Context) error {
q, err := c.FormParams()
if err != nil {
return h.redirectError(c, thirdparty.ErrorServer("could not get form parameters"), h.cfg.ThirdParty.ErrorRedirectURL)
}
return c.Redirect(http.StatusSeeOther, fmt.Sprintf("/thirdparty/callback?%s", q.Encode()))
}
func (h *ThirdPartyHandler) Callback(c echo.Context) error {
var successRedirectTo *url.URL
var accountLinkingResult *thirdparty.AccountLinkingResult
err := h.persister.Transaction(func(tx *pop.Connection) error {
var callback dto.ThirdPartyAuthCallback
terr := c.Bind(&callback)
if terr != nil {
return thirdparty.ErrorServer("could not decode request payload").WithCause(terr)
}
terr = c.Validate(callback)
if terr != nil {
if eerr, ok := terr.(*echo.HTTPError); ok {
if message, ok2 := eerr.Message.(string); ok2 {
return thirdparty.ErrorInvalidRequest(message).WithCause(terr)
} else {
return thirdparty.ErrorInvalidRequest(terr.Error()).WithCause(terr)
}
} else {
return thirdparty.ErrorInvalidRequest(terr.Error()).WithCause(terr)
}
}
expectedState, terr := c.Cookie(utils.HankoThirdpartyStateCookie)
if terr != nil {
return thirdparty.ErrorInvalidRequest("thirdparty state cookie is missing")
}
state, terr := thirdparty.VerifyState(h.cfg, callback.State, expectedState.Value)
if terr != nil {
return thirdparty.ErrorInvalidRequest(terr.Error()).WithCause(terr)
}
if callback.HasError() {
return thirdparty.NewThirdPartyError(callback.Error, callback.ErrorDescription)
}
provider, terr := thirdparty.GetProvider(h.cfg.ThirdParty, state.Provider)
if terr != nil {
return thirdparty.ErrorInvalidRequest(terr.Error()).WithCause(terr)
}
if callback.AuthCode == "" {
return thirdparty.ErrorInvalidRequest("auth code missing from request")
}
oAuthToken, terr := provider.GetOAuthToken(callback.AuthCode)
if terr != nil {
return thirdparty.ErrorInvalidRequest("could not exchange authorization code for access token").WithCause(terr)
}
userData, terr := provider.GetUserData(oAuthToken)
if terr != nil {
return thirdparty.ErrorInvalidRequest("could not retrieve user data from provider").WithCause(terr)
}
linkingResult, terr := thirdparty.LinkAccount(tx, h.cfg, h.persister, userData, provider.ID(), false, nil, state.IsFlow)
if terr != nil {
return terr
}
accountLinkingResult = linkingResult
emailModel := linkingResult.User.Emails.GetEmailByAddress(userData.Metadata.Email)
identityModel := emailModel.Identities.GetIdentity(provider.ID(), userData.Metadata.Subject)
token, terr := models.NewToken(
linkingResult.User.ID,
models.TokenForFlowAPI(state.IsFlow),
models.TokenWithIdentityID(identityModel.ID),
models.TokenUserCreated(linkingResult.UserCreated))
if terr != nil {
return thirdparty.ErrorServer("could not create token").WithCause(terr)
}
terr = h.persister.GetTokenPersisterWithConnection(tx).Create(*token)
if terr != nil {
return thirdparty.ErrorServer("could not save token to db").WithCause(terr)
}
redirectTo, terr := url.Parse(state.RedirectTo)
if terr != nil {
return thirdparty.ErrorServer("could not parse redirect url").WithCause(terr)
}
query := redirectTo.Query()
query.Add(utils.HankoTokenQuery, token.Value)
redirectTo.RawQuery = query.Encode()
successRedirectTo = redirectTo
c.SetCookie(&http.Cookie{
Name: utils.HankoThirdpartyStateCookie,
Value: "",
Path: "/",
Domain: h.cfg.Session.Cookie.Domain,
MaxAge: -1,
Secure: h.cfg.Session.Cookie.Secure,
HttpOnly: h.cfg.Session.Cookie.HttpOnly,
SameSite: http.SameSiteLaxMode,
})
return nil
})
if err != nil {
return h.redirectError(c, err, h.cfg.ThirdParty.ErrorRedirectURL)
}
err = h.auditLogger.Create(c, accountLinkingResult.Type, accountLinkingResult.User, nil)
if err != nil {
return h.redirectError(c, thirdparty.ErrorServer("could not create audit log").WithCause(err), h.cfg.ThirdParty.ErrorRedirectURL)
}
if accountLinkingResult.WebhookEvent != nil {
err = webhookUtils.TriggerWebhooks(c, h.persister.GetConnection(), *accountLinkingResult.WebhookEvent, admin.FromUserModel(*accountLinkingResult.User))
if err != nil {
c.Logger().Warn(err)
}
}
return c.Redirect(http.StatusTemporaryRedirect, successRedirectTo.String())
}
func (h *ThirdPartyHandler) redirectError(c echo.Context, error error, to string) error {
redirectTo := h.cfg.ThirdParty.ErrorRedirectURL
if to != "" {
redirectTo = to
}
err := h.auditError(c, error)
if err != nil {
error = err
}
redirectURL := thirdparty.GetErrorUrl(redirectTo, error)
return c.Redirect(http.StatusTemporaryRedirect, redirectURL)
}
func (h *ThirdPartyHandler) auditError(c echo.Context, err error) error {
e, ok := err.(*thirdparty.ThirdPartyError)
var auditLogError error
if ok && e.Code != thirdparty.ErrorCodeServerError {
auditLogError = h.auditLogger.Create(c, models.AuditLogThirdPartySignInSignUpFailed, nil, err)
}
return auditLogError
}