2022-02-13 13:30:20 +00:00
|
|
|
package httpd
|
|
|
|
|
|
|
|
import (
|
|
|
|
"context"
|
|
|
|
"errors"
|
|
|
|
"fmt"
|
|
|
|
"net/http"
|
|
|
|
"net/url"
|
|
|
|
"strings"
|
|
|
|
"time"
|
|
|
|
|
|
|
|
"github.com/coreos/go-oidc/v3/oidc"
|
|
|
|
"github.com/rs/xid"
|
|
|
|
"golang.org/x/oauth2"
|
|
|
|
|
|
|
|
"github.com/drakkan/sftpgo/v2/common"
|
|
|
|
"github.com/drakkan/sftpgo/v2/dataprovider"
|
|
|
|
"github.com/drakkan/sftpgo/v2/httpclient"
|
|
|
|
"github.com/drakkan/sftpgo/v2/logger"
|
|
|
|
"github.com/drakkan/sftpgo/v2/util"
|
|
|
|
)
|
|
|
|
|
|
|
|
const (
|
|
|
|
oidcCookieKey = "oidc"
|
2022-05-22 12:38:25 +00:00
|
|
|
adminRoleFieldValue = "admin"
|
2022-02-13 13:30:20 +00:00
|
|
|
authStateValidity = 1 * 60 * 1000 // 1 minute
|
|
|
|
tokenUpdateInterval = 3 * 60 * 1000 // 3 minutes
|
|
|
|
tokenDeleteInterval = 2 * 3600 * 1000 // 2 hours
|
|
|
|
)
|
|
|
|
|
|
|
|
var (
|
|
|
|
oidcTokenKey = &contextKey{"OIDC token key"}
|
|
|
|
oidcGeneratedToken = &contextKey{"OIDC generated token"}
|
|
|
|
)
|
|
|
|
|
|
|
|
// OAuth2Config defines an interface for OAuth2 methods, so we can mock them
|
|
|
|
type OAuth2Config interface {
|
|
|
|
AuthCodeURL(state string, opts ...oauth2.AuthCodeOption) string
|
|
|
|
Exchange(ctx context.Context, code string, opts ...oauth2.AuthCodeOption) (*oauth2.Token, error)
|
|
|
|
TokenSource(ctx context.Context, t *oauth2.Token) oauth2.TokenSource
|
|
|
|
}
|
|
|
|
|
|
|
|
// OIDCTokenVerifier defines an interface for OpenID token verifier, so we can mock them
|
|
|
|
type OIDCTokenVerifier interface {
|
|
|
|
Verify(ctx context.Context, rawIDToken string) (*oidc.IDToken, error)
|
|
|
|
}
|
|
|
|
|
|
|
|
// OIDC defines the OpenID Connect configuration
|
|
|
|
type OIDC struct {
|
|
|
|
// ClientID is the application's ID
|
|
|
|
ClientID string `json:"client_id" mapstructure:"client_id"`
|
|
|
|
// ClientSecret is the application's secret
|
|
|
|
ClientSecret string `json:"client_secret" mapstructure:"client_secret"`
|
|
|
|
// ConfigURL is the identifier for the service.
|
|
|
|
// SFTPGo will try to retrieve the provider configuration on startup and then
|
|
|
|
// will refuse to start if it fails to connect to the specified URL
|
|
|
|
ConfigURL string `json:"config_url" mapstructure:"config_url"`
|
|
|
|
// RedirectBaseURL is the base URL to redirect to after OpenID authentication.
|
|
|
|
// The suffix "/web/oidc/redirect" will be added to this base URL, adding also the
|
|
|
|
// "web_root" if configured
|
|
|
|
RedirectBaseURL string `json:"redirect_base_url" mapstructure:"redirect_base_url"`
|
|
|
|
// ID token claims field to map to the SFTPGo username
|
|
|
|
UsernameField string `json:"username_field" mapstructure:"username_field"`
|
|
|
|
// Optional ID token claims field to map to a SFTPGo role.
|
|
|
|
// If the defined ID token claims field is set to "admin" the authenticated user
|
|
|
|
// is mapped to an SFTPGo admin.
|
|
|
|
// You don't need to specify this field if you want to use OpenID only for the
|
|
|
|
// Web Client UI
|
2022-04-12 17:31:25 +00:00
|
|
|
RoleField string `json:"role_field" mapstructure:"role_field"`
|
2022-05-22 12:38:25 +00:00
|
|
|
// If set, the `RoleField` is ignored and the SFTPGo role is assumed based on
|
|
|
|
// the login link used
|
|
|
|
ImplicitRoles bool `json:"implicit_roles" mapstructure:"implicit_roles"`
|
2022-06-25 08:41:15 +00:00
|
|
|
// Scopes required by the OAuth provider to retrieve information about the authenticated user.
|
|
|
|
// The "openid" scope is required.
|
|
|
|
// Refer to your OAuth provider documentation for more information about this
|
2022-06-25 08:40:39 +00:00
|
|
|
Scopes []string `json:"scopes" mapstructure:"scopes"`
|
2022-04-12 17:31:25 +00:00
|
|
|
// Custom token claims fields to pass to the pre-login hook
|
|
|
|
CustomFields []string `json:"custom_fields" mapstructure:"custom_fields"`
|
2022-02-13 13:30:20 +00:00
|
|
|
provider *oidc.Provider
|
|
|
|
verifier OIDCTokenVerifier
|
|
|
|
providerLogoutURL string
|
|
|
|
oauth2Config OAuth2Config
|
|
|
|
}
|
|
|
|
|
|
|
|
func (o *OIDC) isEnabled() bool {
|
|
|
|
return o.provider != nil
|
|
|
|
}
|
|
|
|
|
|
|
|
func (o *OIDC) hasRoles() bool {
|
2022-05-22 12:38:25 +00:00
|
|
|
return o.isEnabled() && (o.RoleField != "" || o.ImplicitRoles)
|
|
|
|
}
|
|
|
|
|
|
|
|
func (o *OIDC) getForcedRole(audience string) string {
|
|
|
|
if !o.ImplicitRoles {
|
|
|
|
return ""
|
|
|
|
}
|
|
|
|
if audience == tokenAudienceWebAdmin {
|
|
|
|
return adminRoleFieldValue
|
|
|
|
}
|
|
|
|
return ""
|
2022-02-13 13:30:20 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
func (o *OIDC) getRedirectURL() string {
|
|
|
|
url := o.RedirectBaseURL
|
|
|
|
if strings.HasSuffix(o.RedirectBaseURL, "/") {
|
|
|
|
url = strings.TrimSuffix(o.RedirectBaseURL, "/")
|
|
|
|
}
|
|
|
|
url += webOIDCRedirectPath
|
|
|
|
logger.Debug(logSender, "", "oidc redirect URL: %#v", url)
|
|
|
|
return url
|
|
|
|
}
|
|
|
|
|
|
|
|
func (o *OIDC) initialize() error {
|
|
|
|
if o.ConfigURL == "" {
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
if o.UsernameField == "" {
|
|
|
|
return errors.New("oidc: username field cannot be empty")
|
|
|
|
}
|
|
|
|
if o.RedirectBaseURL == "" {
|
|
|
|
return errors.New("oidc: redirect base URL cannot be empty")
|
|
|
|
}
|
2022-06-25 08:41:15 +00:00
|
|
|
if !util.Contains(o.Scopes, oidc.ScopeOpenID) {
|
|
|
|
return fmt.Errorf("oidc: required scope %q is not set", oidc.ScopeOpenID)
|
|
|
|
}
|
2022-02-13 13:30:20 +00:00
|
|
|
ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
|
|
|
|
defer cancel()
|
|
|
|
|
|
|
|
provider, err := oidc.NewProvider(ctx, o.ConfigURL)
|
|
|
|
if err != nil {
|
|
|
|
return fmt.Errorf("oidc: unable to initialize provider for URL %#v: %w", o.ConfigURL, err)
|
|
|
|
}
|
2022-05-19 17:49:51 +00:00
|
|
|
claims := make(map[string]any)
|
2022-02-13 13:30:20 +00:00
|
|
|
// we cannot get an error here because the response body was already parsed as JSON
|
|
|
|
// on provider creation
|
|
|
|
provider.Claims(&claims) //nolint:errcheck
|
|
|
|
endSessionEndPoint, ok := claims["end_session_endpoint"]
|
|
|
|
if ok {
|
|
|
|
if val, ok := endSessionEndPoint.(string); ok {
|
|
|
|
o.providerLogoutURL = val
|
|
|
|
logger.Debug(logSender, "", "oidc end session endpoint %#v", o.providerLogoutURL)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
o.provider = provider
|
|
|
|
o.verifier = provider.Verifier(&oidc.Config{
|
|
|
|
ClientID: o.ClientID,
|
|
|
|
})
|
|
|
|
o.oauth2Config = &oauth2.Config{
|
|
|
|
ClientID: o.ClientID,
|
|
|
|
ClientSecret: o.ClientSecret,
|
|
|
|
Endpoint: o.provider.Endpoint(),
|
|
|
|
RedirectURL: o.getRedirectURL(),
|
2022-06-25 08:40:39 +00:00
|
|
|
Scopes: o.Scopes,
|
2022-02-13 13:30:20 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
type oidcPendingAuth struct {
|
2022-05-19 17:49:51 +00:00
|
|
|
State string `json:"state"`
|
|
|
|
Nonce string `json:"nonce"`
|
|
|
|
Audience tokenAudience `json:"audience"`
|
|
|
|
IssuedAt int64 `json:"issued_at"`
|
2022-02-13 13:30:20 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
func newOIDCPendingAuth(audience tokenAudience) oidcPendingAuth {
|
|
|
|
return oidcPendingAuth{
|
|
|
|
State: xid.New().String(),
|
|
|
|
Nonce: xid.New().String(),
|
|
|
|
Audience: audience,
|
2022-05-19 17:49:51 +00:00
|
|
|
IssuedAt: util.GetTimeAsMsSinceEpoch(time.Now()),
|
2022-02-13 13:30:20 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
type oidcToken struct {
|
2022-05-19 17:49:51 +00:00
|
|
|
AccessToken string `json:"access_token"`
|
|
|
|
TokenType string `json:"token_type,omitempty"`
|
|
|
|
RefreshToken string `json:"refresh_token,omitempty"`
|
|
|
|
ExpiresAt int64 `json:"expires_at,omitempty"`
|
|
|
|
SessionID string `json:"session_id"`
|
|
|
|
IDToken string `json:"id_token"`
|
|
|
|
Nonce string `json:"nonce"`
|
|
|
|
Username string `json:"username"`
|
|
|
|
Permissions []string `json:"permissions"`
|
|
|
|
Role any `json:"role"`
|
|
|
|
CustomFields *map[string]any `json:"custom_fields,omitempty"`
|
|
|
|
Cookie string `json:"cookie"`
|
|
|
|
UsedAt int64 `json:"used_at"`
|
|
|
|
}
|
|
|
|
|
2022-05-22 12:38:25 +00:00
|
|
|
func (t *oidcToken) parseClaims(claims map[string]any, usernameField, roleField string, customFields []string,
|
|
|
|
forcedRole string,
|
|
|
|
) error {
|
2022-02-22 09:20:14 +00:00
|
|
|
getClaimsFields := func() []string {
|
|
|
|
keys := make([]string, 0, len(claims))
|
|
|
|
for k := range claims {
|
|
|
|
keys = append(keys, k)
|
|
|
|
}
|
|
|
|
return keys
|
|
|
|
}
|
|
|
|
|
2022-02-13 13:30:20 +00:00
|
|
|
username, ok := claims[usernameField].(string)
|
|
|
|
if !ok || username == "" {
|
2022-02-22 09:20:14 +00:00
|
|
|
logger.Warn(logSender, "", "username field %#v not found, claims fields: %+v", usernameField, getClaimsFields())
|
2022-02-13 13:30:20 +00:00
|
|
|
return errors.New("no username field")
|
|
|
|
}
|
|
|
|
t.Username = username
|
2022-05-22 12:38:25 +00:00
|
|
|
if forcedRole != "" {
|
|
|
|
t.Role = forcedRole
|
|
|
|
} else {
|
|
|
|
if roleField != "" {
|
|
|
|
role, ok := claims[roleField]
|
|
|
|
if ok {
|
|
|
|
t.Role = role
|
|
|
|
}
|
2022-02-13 13:30:20 +00:00
|
|
|
}
|
|
|
|
}
|
2022-04-12 17:31:25 +00:00
|
|
|
t.CustomFields = nil
|
|
|
|
if len(customFields) > 0 {
|
|
|
|
for _, field := range customFields {
|
|
|
|
if val, ok := claims[field]; ok {
|
|
|
|
if t.CustomFields == nil {
|
2022-05-19 17:49:51 +00:00
|
|
|
customFields := make(map[string]any)
|
2022-04-12 17:31:25 +00:00
|
|
|
t.CustomFields = &customFields
|
|
|
|
}
|
|
|
|
logger.Debug(logSender, "", "custom field %#v found in token claims", field)
|
|
|
|
(*t.CustomFields)[field] = val
|
|
|
|
} else {
|
|
|
|
logger.Info(logSender, "", "custom field %#v not found in token claims", field)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
2022-02-13 13:30:20 +00:00
|
|
|
sid, ok := claims["sid"].(string)
|
|
|
|
if ok {
|
|
|
|
t.SessionID = sid
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
func (t *oidcToken) isAdmin() bool {
|
2022-03-25 09:36:35 +00:00
|
|
|
switch v := t.Role.(type) {
|
|
|
|
case string:
|
2022-05-22 12:38:25 +00:00
|
|
|
return v == adminRoleFieldValue
|
2022-05-19 17:49:51 +00:00
|
|
|
case []any:
|
2022-03-25 09:36:35 +00:00
|
|
|
for _, s := range v {
|
2022-05-22 12:38:25 +00:00
|
|
|
if val, ok := s.(string); ok && val == adminRoleFieldValue {
|
2022-03-25 09:36:35 +00:00
|
|
|
return true
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return false
|
|
|
|
default:
|
|
|
|
return false
|
|
|
|
}
|
2022-02-13 13:30:20 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
func (t *oidcToken) isExpired() bool {
|
|
|
|
if t.ExpiresAt == 0 {
|
|
|
|
return false
|
|
|
|
}
|
|
|
|
return t.ExpiresAt < util.GetTimeAsMsSinceEpoch(time.Now())
|
|
|
|
}
|
|
|
|
|
|
|
|
func (t *oidcToken) refresh(config OAuth2Config, verifier OIDCTokenVerifier) error {
|
|
|
|
if t.RefreshToken == "" {
|
|
|
|
logger.Debug(logSender, "", "refresh token not set, unable to refresh cookie %#v", t.Cookie)
|
|
|
|
return errors.New("refresh token not set")
|
|
|
|
}
|
|
|
|
oauth2Token := oauth2.Token{
|
|
|
|
AccessToken: t.AccessToken,
|
|
|
|
TokenType: t.TokenType,
|
|
|
|
RefreshToken: t.RefreshToken,
|
|
|
|
}
|
|
|
|
if t.ExpiresAt > 0 {
|
|
|
|
oauth2Token.Expiry = util.GetTimeFromMsecSinceEpoch(t.ExpiresAt)
|
|
|
|
}
|
|
|
|
ctx, cancel := context.WithTimeout(context.Background(), 20*time.Second)
|
|
|
|
defer cancel()
|
|
|
|
|
|
|
|
newToken, err := config.TokenSource(ctx, &oauth2Token).Token()
|
|
|
|
if err != nil {
|
|
|
|
logger.Debug(logSender, "", "unable to refresh token for cookie %#v: %v", t.Cookie, err)
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
rawIDToken, ok := newToken.Extra("id_token").(string)
|
|
|
|
if !ok {
|
|
|
|
logger.Debug(logSender, "", "the refreshed token has no id token, cookie %#v", t.Cookie)
|
|
|
|
return errors.New("the refreshed token has no id token")
|
|
|
|
}
|
|
|
|
|
|
|
|
t.AccessToken = newToken.AccessToken
|
|
|
|
t.TokenType = newToken.TokenType
|
|
|
|
t.RefreshToken = newToken.RefreshToken
|
|
|
|
t.IDToken = rawIDToken
|
|
|
|
if !newToken.Expiry.IsZero() {
|
|
|
|
t.ExpiresAt = util.GetTimeAsMsSinceEpoch(newToken.Expiry)
|
|
|
|
} else {
|
|
|
|
t.ExpiresAt = 0
|
|
|
|
}
|
|
|
|
idToken, err := verifier.Verify(ctx, rawIDToken)
|
|
|
|
if err != nil {
|
|
|
|
logger.Debug(logSender, "", "unable to verify refreshed id token for cookie %#v: %v", t.Cookie, err)
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
if idToken.Nonce != t.Nonce {
|
|
|
|
logger.Debug(logSender, "", "unable to verify refreshed id token for cookie %#v: nonce mismatch", t.Cookie)
|
|
|
|
return errors.New("the refreshed token nonce mismatch")
|
|
|
|
}
|
2022-05-19 17:49:51 +00:00
|
|
|
claims := make(map[string]any)
|
2022-02-13 13:30:20 +00:00
|
|
|
err = idToken.Claims(&claims)
|
|
|
|
if err != nil {
|
|
|
|
logger.Debug(logSender, "", "unable to get refreshed id token claims for cookie %#v: %v", t.Cookie, err)
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
sid, ok := claims["sid"].(string)
|
|
|
|
if ok {
|
|
|
|
t.SessionID = sid
|
|
|
|
}
|
|
|
|
logger.Debug(logSender, "", "oidc token refreshed for user %#v, cookie %#v", t.Username, t.Cookie)
|
|
|
|
oidcMgr.addToken(*t)
|
|
|
|
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
func (t *oidcToken) getUser(r *http.Request) error {
|
|
|
|
if t.isAdmin() {
|
|
|
|
admin, err := dataprovider.AdminExists(t.Username)
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
if err := admin.CanLogin(util.GetIPFromRemoteAddress(r.RemoteAddr)); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
t.Permissions = admin.Permissions
|
|
|
|
dataprovider.UpdateAdminLastLogin(&admin)
|
|
|
|
return nil
|
|
|
|
}
|
2022-02-19 09:53:35 +00:00
|
|
|
ipAddr := util.GetIPFromRemoteAddress(r.RemoteAddr)
|
2022-04-12 17:31:25 +00:00
|
|
|
user, err := dataprovider.GetUserAfterIDPAuth(t.Username, ipAddr, common.ProtocolOIDC, t.CustomFields)
|
2022-02-13 13:30:20 +00:00
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
2022-02-19 09:53:35 +00:00
|
|
|
if err := common.Config.ExecutePostConnectHook(ipAddr, common.ProtocolOIDC); err != nil {
|
|
|
|
updateLoginMetrics(&user, dataprovider.LoginMethodIDP, ipAddr, err)
|
2022-02-13 13:30:20 +00:00
|
|
|
return fmt.Errorf("access denied by post connect hook: %w", err)
|
|
|
|
}
|
|
|
|
if err := user.CheckLoginConditions(); err != nil {
|
2022-02-19 09:53:35 +00:00
|
|
|
updateLoginMetrics(&user, dataprovider.LoginMethodIDP, ipAddr, err)
|
2022-02-13 13:30:20 +00:00
|
|
|
return err
|
|
|
|
}
|
2022-02-19 09:53:35 +00:00
|
|
|
connectionID := fmt.Sprintf("%v_%v", common.ProtocolOIDC, xid.New().String())
|
2022-04-14 17:07:41 +00:00
|
|
|
if err := checkHTTPClientUser(&user, r, connectionID, true); err != nil {
|
2022-02-19 09:53:35 +00:00
|
|
|
updateLoginMetrics(&user, dataprovider.LoginMethodIDP, ipAddr, err)
|
2022-02-13 13:30:20 +00:00
|
|
|
return err
|
|
|
|
}
|
|
|
|
defer user.CloseFs() //nolint:errcheck
|
|
|
|
err = user.CheckFsRoot(connectionID)
|
|
|
|
if err != nil {
|
|
|
|
logger.Warn(logSender, connectionID, "unable to check fs root: %v", err)
|
2022-02-19 09:53:35 +00:00
|
|
|
updateLoginMetrics(&user, dataprovider.LoginMethodIDP, ipAddr, common.ErrInternalFailure)
|
2022-02-13 13:30:20 +00:00
|
|
|
return err
|
|
|
|
}
|
2022-02-19 09:53:35 +00:00
|
|
|
updateLoginMetrics(&user, dataprovider.LoginMethodIDP, ipAddr, nil)
|
2022-02-13 13:30:20 +00:00
|
|
|
dataprovider.UpdateLastLogin(&user)
|
|
|
|
t.Permissions = user.Filters.WebClient
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
func (s *httpdServer) validateOIDCToken(w http.ResponseWriter, r *http.Request, isAdmin bool) (oidcToken, error) {
|
|
|
|
doRedirect := func() {
|
|
|
|
removeOIDCCookie(w, r)
|
|
|
|
if isAdmin {
|
|
|
|
http.Redirect(w, r, webAdminLoginPath, http.StatusFound)
|
|
|
|
return
|
|
|
|
}
|
|
|
|
http.Redirect(w, r, webClientLoginPath, http.StatusFound)
|
|
|
|
}
|
|
|
|
|
|
|
|
cookie, err := r.Cookie(oidcCookieKey)
|
|
|
|
if err != nil {
|
|
|
|
logger.Debug(logSender, "", "no oidc cookie, redirecting to login page")
|
|
|
|
doRedirect()
|
|
|
|
return oidcToken{}, errInvalidToken
|
|
|
|
}
|
|
|
|
token, err := oidcMgr.getToken(cookie.Value)
|
|
|
|
if err != nil {
|
|
|
|
logger.Debug(logSender, "", "error getting oidc token associated with cookie %#v: %v", cookie.Value, err)
|
|
|
|
doRedirect()
|
|
|
|
return oidcToken{}, errInvalidToken
|
|
|
|
}
|
|
|
|
if token.isExpired() {
|
|
|
|
logger.Debug(logSender, "", "oidc token associated with cookie %#v is expired", token.Cookie)
|
|
|
|
if err = token.refresh(s.binding.OIDC.oauth2Config, s.binding.OIDC.verifier); err != nil {
|
|
|
|
setFlashMessage(w, r, "Your OpenID token is expired, please log-in again")
|
|
|
|
doRedirect()
|
|
|
|
return oidcToken{}, errInvalidToken
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
oidcMgr.updateTokenUsage(token)
|
|
|
|
}
|
|
|
|
if isAdmin {
|
|
|
|
if !token.isAdmin() {
|
|
|
|
logger.Debug(logSender, "", "oidc token associated with cookie %#v is not valid for admin users", token.Cookie)
|
|
|
|
setFlashMessage(w, r, "Your OpenID token is not valid for the SFTPGo Web Admin UI. Please logout from your OpenID server and log-in as an SFTPGo admin")
|
|
|
|
doRedirect()
|
|
|
|
return oidcToken{}, errInvalidToken
|
|
|
|
}
|
|
|
|
return token, nil
|
|
|
|
}
|
|
|
|
if token.isAdmin() {
|
|
|
|
logger.Debug(logSender, "", "oidc token associated with cookie %#v is valid for admin users", token.Cookie)
|
|
|
|
setFlashMessage(w, r, "Your OpenID token is not valid for the SFTPGo Web Client UI. Please logout from your OpenID server and log-in as an SFTPGo user")
|
|
|
|
doRedirect()
|
|
|
|
return oidcToken{}, errInvalidToken
|
|
|
|
}
|
|
|
|
return token, nil
|
|
|
|
}
|
|
|
|
|
|
|
|
func (s *httpdServer) oidcTokenAuthenticator(audience tokenAudience) func(next http.Handler) http.Handler {
|
|
|
|
return func(next http.Handler) http.Handler {
|
|
|
|
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
|
|
if canSkipOIDCValidation(r) {
|
|
|
|
next.ServeHTTP(w, r)
|
|
|
|
return
|
|
|
|
}
|
|
|
|
token, err := s.validateOIDCToken(w, r, audience == tokenAudienceWebAdmin)
|
|
|
|
if err != nil {
|
|
|
|
return
|
|
|
|
}
|
|
|
|
jwtTokenClaims := jwtTokenClaims{
|
|
|
|
Username: token.Username,
|
|
|
|
Permissions: token.Permissions,
|
|
|
|
}
|
2022-03-24 21:03:17 +00:00
|
|
|
_, tokenString, err := jwtTokenClaims.createToken(s.tokenAuth, audience, util.GetIPFromRemoteAddress(r.RemoteAddr))
|
2022-02-13 13:30:20 +00:00
|
|
|
if err != nil {
|
|
|
|
setFlashMessage(w, r, "Unable to create cookie")
|
|
|
|
if audience == tokenAudienceWebAdmin {
|
|
|
|
http.Redirect(w, r, webAdminLoginPath, http.StatusFound)
|
|
|
|
} else {
|
|
|
|
http.Redirect(w, r, webClientLoginPath, http.StatusFound)
|
|
|
|
}
|
|
|
|
return
|
|
|
|
}
|
|
|
|
ctx := context.WithValue(r.Context(), oidcTokenKey, token.Cookie)
|
|
|
|
ctx = context.WithValue(ctx, oidcGeneratedToken, tokenString)
|
|
|
|
|
|
|
|
next.ServeHTTP(w, r.WithContext(ctx))
|
|
|
|
})
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
func (s *httpdServer) handleWebAdminOIDCLogin(w http.ResponseWriter, r *http.Request) {
|
|
|
|
s.oidcLoginRedirect(w, r, tokenAudienceWebAdmin)
|
|
|
|
}
|
|
|
|
|
|
|
|
func (s *httpdServer) handleWebClientOIDCLogin(w http.ResponseWriter, r *http.Request) {
|
|
|
|
s.oidcLoginRedirect(w, r, tokenAudienceWebClient)
|
|
|
|
}
|
|
|
|
|
|
|
|
func (s *httpdServer) oidcLoginRedirect(w http.ResponseWriter, r *http.Request, audience tokenAudience) {
|
|
|
|
pendingAuth := newOIDCPendingAuth(audience)
|
|
|
|
oidcMgr.addPendingAuth(pendingAuth)
|
|
|
|
http.Redirect(w, r, s.binding.OIDC.oauth2Config.AuthCodeURL(pendingAuth.State,
|
|
|
|
oidc.Nonce(pendingAuth.Nonce)), http.StatusFound)
|
|
|
|
}
|
|
|
|
|
|
|
|
func (s *httpdServer) handleOIDCRedirect(w http.ResponseWriter, r *http.Request) {
|
|
|
|
state := r.URL.Query().Get("state")
|
|
|
|
authReq, err := oidcMgr.getPendingAuth(state)
|
|
|
|
if err != nil {
|
|
|
|
logger.Debug(logSender, "", "oidc authentication state did not match")
|
2022-03-19 20:44:27 +00:00
|
|
|
s.renderClientMessagePage(w, r, "Invalid authentication request", "Authentication state did not match",
|
2022-02-13 13:30:20 +00:00
|
|
|
http.StatusBadRequest, nil, "")
|
|
|
|
return
|
|
|
|
}
|
|
|
|
oidcMgr.removePendingAuth(state)
|
|
|
|
|
|
|
|
doRedirect := func() {
|
|
|
|
if authReq.Audience == tokenAudienceWebAdmin {
|
|
|
|
http.Redirect(w, r, webAdminLoginPath, http.StatusFound)
|
|
|
|
return
|
|
|
|
}
|
|
|
|
http.Redirect(w, r, webClientLoginPath, http.StatusFound)
|
|
|
|
}
|
|
|
|
doLogout := func(rawIDToken string) {
|
|
|
|
s.logoutFromOIDCOP(rawIDToken)
|
|
|
|
}
|
|
|
|
|
|
|
|
ctx, cancel := context.WithTimeout(r.Context(), 20*time.Second)
|
|
|
|
defer cancel()
|
|
|
|
|
|
|
|
oauth2Token, err := s.binding.OIDC.oauth2Config.Exchange(ctx, r.URL.Query().Get("code"))
|
|
|
|
if err != nil {
|
|
|
|
logger.Debug(logSender, "", "failed to exchange oidc token: %v", err)
|
|
|
|
setFlashMessage(w, r, "Failed to exchange OpenID token")
|
|
|
|
doRedirect()
|
|
|
|
return
|
|
|
|
}
|
|
|
|
rawIDToken, ok := oauth2Token.Extra("id_token").(string)
|
|
|
|
if !ok {
|
|
|
|
logger.Debug(logSender, "", "no id_token field in OAuth2 OpenID token")
|
|
|
|
setFlashMessage(w, r, "No id_token field in OAuth2 OpenID token")
|
|
|
|
doRedirect()
|
|
|
|
return
|
|
|
|
}
|
|
|
|
idToken, err := s.binding.OIDC.verifier.Verify(ctx, rawIDToken)
|
|
|
|
if err != nil {
|
|
|
|
logger.Debug(logSender, "", "failed to verify oidc token: %v", err)
|
|
|
|
setFlashMessage(w, r, "Failed to verify OpenID token")
|
|
|
|
doRedirect()
|
|
|
|
doLogout(rawIDToken)
|
|
|
|
return
|
|
|
|
}
|
|
|
|
if idToken.Nonce != authReq.Nonce {
|
|
|
|
logger.Debug(logSender, "", "oidc authentication nonce did not match")
|
|
|
|
setFlashMessage(w, r, "OpenID authentication nonce did not match")
|
|
|
|
doRedirect()
|
|
|
|
doLogout(rawIDToken)
|
|
|
|
return
|
|
|
|
}
|
|
|
|
|
2022-05-19 17:49:51 +00:00
|
|
|
claims := make(map[string]any)
|
2022-02-13 13:30:20 +00:00
|
|
|
err = idToken.Claims(&claims)
|
|
|
|
if err != nil {
|
|
|
|
logger.Debug(logSender, "", "unable to get oidc token claims: %v", err)
|
|
|
|
setFlashMessage(w, r, "Unable to get OpenID token claims")
|
|
|
|
doRedirect()
|
|
|
|
doLogout(rawIDToken)
|
|
|
|
return
|
|
|
|
}
|
|
|
|
token := oidcToken{
|
|
|
|
AccessToken: oauth2Token.AccessToken,
|
|
|
|
TokenType: oauth2Token.TokenType,
|
|
|
|
RefreshToken: oauth2Token.RefreshToken,
|
|
|
|
IDToken: rawIDToken,
|
|
|
|
Nonce: idToken.Nonce,
|
|
|
|
Cookie: xid.New().String(),
|
|
|
|
}
|
|
|
|
if !oauth2Token.Expiry.IsZero() {
|
|
|
|
token.ExpiresAt = util.GetTimeAsMsSinceEpoch(oauth2Token.Expiry)
|
|
|
|
}
|
2022-05-22 12:38:25 +00:00
|
|
|
err = token.parseClaims(claims, s.binding.OIDC.UsernameField, s.binding.OIDC.RoleField,
|
|
|
|
s.binding.OIDC.CustomFields, s.binding.OIDC.getForcedRole(authReq.Audience))
|
|
|
|
if err != nil {
|
2022-02-13 13:30:20 +00:00
|
|
|
logger.Debug(logSender, "", "unable to parse oidc token claims: %v", err)
|
|
|
|
setFlashMessage(w, r, fmt.Sprintf("Unable to parse OpenID token claims: %v", err))
|
|
|
|
doRedirect()
|
|
|
|
doLogout(rawIDToken)
|
|
|
|
return
|
|
|
|
}
|
|
|
|
switch authReq.Audience {
|
|
|
|
case tokenAudienceWebAdmin:
|
|
|
|
if !token.isAdmin() {
|
|
|
|
logger.Debug(logSender, "", "wrong oidc token role, the mapped user is not an SFTPGo admin")
|
|
|
|
setFlashMessage(w, r, "Wrong OpenID role, the logged in user is not an SFTPGo admin")
|
|
|
|
doRedirect()
|
|
|
|
doLogout(rawIDToken)
|
|
|
|
return
|
|
|
|
}
|
|
|
|
case tokenAudienceWebClient:
|
|
|
|
if token.isAdmin() {
|
|
|
|
logger.Debug(logSender, "", "wrong oidc token role, the mapped user is an SFTPGo admin")
|
|
|
|
setFlashMessage(w, r, "Wrong OpenID role, the logged in user is an SFTPGo admin")
|
|
|
|
doRedirect()
|
|
|
|
doLogout(rawIDToken)
|
|
|
|
return
|
|
|
|
}
|
|
|
|
}
|
|
|
|
err = token.getUser(r)
|
|
|
|
if err != nil {
|
|
|
|
logger.Debug(logSender, "", "unable to get the sftpgo user associated with oidc token: %v", err)
|
|
|
|
setFlashMessage(w, r, "Unable to get the user associated with the OpenID token")
|
|
|
|
doRedirect()
|
|
|
|
doLogout(rawIDToken)
|
|
|
|
return
|
|
|
|
}
|
|
|
|
|
|
|
|
loginOIDCUser(w, r, token)
|
|
|
|
}
|
|
|
|
|
|
|
|
func loginOIDCUser(w http.ResponseWriter, r *http.Request, token oidcToken) {
|
|
|
|
oidcMgr.addToken(token)
|
|
|
|
|
|
|
|
cookie := http.Cookie{
|
|
|
|
Name: oidcCookieKey,
|
|
|
|
Value: token.Cookie,
|
|
|
|
Path: "/",
|
|
|
|
HttpOnly: true,
|
|
|
|
Secure: isTLS(r),
|
|
|
|
SameSite: http.SameSiteLaxMode,
|
|
|
|
}
|
|
|
|
// we don't set a cookie expiration so we can refresh the token without setting a new cookie
|
|
|
|
// the cookie will be invalidated on browser close
|
|
|
|
http.SetCookie(w, &cookie)
|
|
|
|
if token.isAdmin() {
|
|
|
|
http.Redirect(w, r, webUsersPath, http.StatusFound)
|
|
|
|
return
|
|
|
|
}
|
|
|
|
http.Redirect(w, r, webClientFilesPath, http.StatusFound)
|
|
|
|
}
|
|
|
|
|
|
|
|
func (s *httpdServer) logoutOIDCUser(w http.ResponseWriter, r *http.Request) {
|
|
|
|
if oidcKey, ok := r.Context().Value(oidcTokenKey).(string); ok {
|
|
|
|
removeOIDCCookie(w, r)
|
|
|
|
token, err := oidcMgr.getToken(oidcKey)
|
|
|
|
if err == nil {
|
|
|
|
s.logoutFromOIDCOP(token.IDToken)
|
|
|
|
}
|
|
|
|
oidcMgr.removeToken(oidcKey)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
func (s *httpdServer) logoutFromOIDCOP(idToken string) {
|
|
|
|
if s.binding.OIDC.providerLogoutURL == "" {
|
|
|
|
logger.Debug(logSender, "", "oidc: provider logout URL not set, unable to logout from the OP")
|
|
|
|
return
|
|
|
|
}
|
|
|
|
go s.doOIDCFromLogout(idToken)
|
|
|
|
}
|
|
|
|
|
|
|
|
func (s *httpdServer) doOIDCFromLogout(idToken string) {
|
|
|
|
logoutURL, err := url.Parse(s.binding.OIDC.providerLogoutURL)
|
|
|
|
if err != nil {
|
|
|
|
logger.Warn(logSender, "", "oidc: unable to parse logout URL: %v", err)
|
|
|
|
return
|
|
|
|
}
|
|
|
|
query := logoutURL.Query()
|
|
|
|
if idToken != "" {
|
|
|
|
query.Set("id_token_hint", idToken)
|
|
|
|
}
|
|
|
|
logoutURL.RawQuery = query.Encode()
|
|
|
|
resp, err := httpclient.RetryableGet(logoutURL.String())
|
|
|
|
if err != nil {
|
|
|
|
logger.Warn(logSender, "", "oidc: error calling logout URL %#v: %v", logoutURL.String(), err)
|
|
|
|
return
|
|
|
|
}
|
|
|
|
defer resp.Body.Close()
|
|
|
|
logger.Debug(logSender, "", "oidc: logout url response code %v", resp.StatusCode)
|
|
|
|
}
|
|
|
|
|
|
|
|
func removeOIDCCookie(w http.ResponseWriter, r *http.Request) {
|
|
|
|
http.SetCookie(w, &http.Cookie{
|
|
|
|
Name: oidcCookieKey,
|
|
|
|
Value: "",
|
|
|
|
Path: "/",
|
|
|
|
Expires: time.Unix(0, 0),
|
|
|
|
MaxAge: -1,
|
|
|
|
HttpOnly: true,
|
|
|
|
Secure: isTLS(r),
|
|
|
|
SameSite: http.SameSiteLaxMode,
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
|
|
|
// canSkipOIDCValidation returns true if there is no OIDC cookie but a jwt cookie is set
|
|
|
|
// and so we check if the user is logged in using a built-in user
|
|
|
|
func canSkipOIDCValidation(r *http.Request) bool {
|
|
|
|
_, err := r.Cookie(oidcCookieKey)
|
|
|
|
if err != nil {
|
|
|
|
_, err = r.Cookie(jwtCookieKey)
|
|
|
|
return err == nil
|
|
|
|
}
|
|
|
|
return false
|
|
|
|
}
|
|
|
|
|
|
|
|
func isLoggedInWithOIDC(r *http.Request) bool {
|
|
|
|
_, ok := r.Context().Value(oidcTokenKey).(string)
|
|
|
|
return ok
|
|
|
|
}
|