Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor cookies #376

Merged
merged 1 commit into from
Nov 14, 2023
Merged

Refactor cookies #376

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions pkg/keycloak/proxy/handlers.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ func (r *OauthProxy) oauthAuthorizationHandler(wrt http.ResponseWriter, req *htt
oauth2.SetAuthURLParam(pkce.ParamCodeChallenge, codeChallenge),
oauth2.SetAuthURLParam(pkce.ParamCodeChallengeMethod, pkce.MethodS256),
)
r.writePKCECookie(wrt, codeVerifier)
r.Cm.WritePKCECookie(wrt, codeVerifier)
}

authURL := conf.AuthCodeURL(
Expand Down Expand Up @@ -226,7 +226,7 @@ func (r *OauthProxy) oauthCallbackHandler(writer http.ResponseWriter, req *http.
return
}
default:
r.DropRefreshTokenCookie(req, writer, encrypted, oidcTokensCookiesExp)
r.Cm.DropRefreshTokenCookie(req, writer, encrypted, oidcTokensCookiesExp)
}
}

Expand Down Expand Up @@ -282,14 +282,14 @@ func (r *OauthProxy) oauthCallbackHandler(writer http.ResponseWriter, req *http.
}
}

r.dropAccessTokenCookie(req, writer, accessToken, oidcTokensCookiesExp)
r.Cm.DropAccessTokenCookie(req, writer, accessToken, oidcTokensCookiesExp)
if r.Config.EnableIDTokenCookie {
r.dropIDTokenCookie(req, writer, identityToken, oidcTokensCookiesExp)
r.Cm.DropIDTokenCookie(req, writer, identityToken, oidcTokensCookiesExp)
}

if r.Config.EnableUma && umaError == nil {
scope.Logger.Debug("got uma token", zap.String("uma", umaToken))
r.dropUMATokenCookie(req, writer, umaToken, oidcTokensCookiesExp)
r.Cm.DropUMATokenCookie(req, writer, umaToken, oidcTokensCookiesExp)
}

if umaError != nil {
Expand Down Expand Up @@ -415,15 +415,15 @@ func (r *OauthProxy) loginHandler(writer http.ResponseWriter, req *http.Request)
}

// drop in the access token - cookie expiration = access token
r.dropAccessTokenCookie(
r.Cm.DropAccessTokenCookie(
req,
writer,
accessToken,
r.GetAccessCookieExpiration(token.RefreshToken),
)

if r.Config.EnableIDTokenCookie {
r.dropIDTokenCookie(
r.Cm.DropIDTokenCookie(
req,
writer,
idToken,
Expand Down Expand Up @@ -458,17 +458,17 @@ func (r *OauthProxy) loginHandler(writer http.ResponseWriter, req *http.Request)
)
}
default:
r.DropRefreshTokenCookie(req, writer, refreshToken, expiration)
r.Cm.DropRefreshTokenCookie(req, writer, refreshToken, expiration)
}
} else {
r.dropAccessTokenCookie(
r.Cm.DropAccessTokenCookie(
req,
writer,
accessToken,
time.Until(identity.ExpiresAt),
)
if r.Config.EnableIDTokenCookie {
r.dropIDTokenCookie(
r.Cm.DropIDTokenCookie(
req,
writer,
idToken,
Expand Down Expand Up @@ -588,7 +588,7 @@ func (r *OauthProxy) logoutHandler(writer http.ResponseWriter, req *http.Request
idToken = user.RawToken
}

r.ClearAllCookies(req, writer)
r.Cm.ClearAllCookies(req, writer)

// @metric increment the logout counter
metrics.OauthTokensMetric.WithLabelValues("logout").Inc()
Expand Down
8 changes: 4 additions & 4 deletions pkg/keycloak/proxy/middleware.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -283,7 +283,7 @@ func (r *OauthProxy) authenticationMiddleware() func(http.Handler) http.Handler
switch err {
case apperrors.ErrRefreshTokenExpired:
lLog.Warn("refresh token has expired, cannot retrieve access token")
r.ClearAllCookies(req.WithContext(ctx), wrt)
r.Cm.ClearAllCookies(req.WithContext(ctx), wrt)
default:
lLog.Debug(
apperrors.ErrAccTokenRefreshFailure.Error(),
Expand Down Expand Up @@ -337,7 +337,7 @@ func (r *OauthProxy) authenticationMiddleware() func(http.Handler) http.Handler
}

// step: inject the refreshed access token
r.dropAccessTokenCookie(req.WithContext(ctx), wrt, accessToken, accessExpiresIn)
r.Cm.DropAccessTokenCookie(req.WithContext(ctx), wrt, accessToken, accessExpiresIn)

// step: inject the renewed refresh token
if newRefreshToken != "" {
Expand Down Expand Up @@ -374,7 +374,7 @@ func (r *OauthProxy) authenticationMiddleware() func(http.Handler) http.Handler
}
}(user.RawToken, newRawAccToken, encryptedRefreshToken)
} else {
r.DropRefreshTokenCookie(req.WithContext(ctx), wrt, encryptedRefreshToken, refreshExpiresIn)
r.Cm.DropRefreshTokenCookie(req.WithContext(ctx), wrt, encryptedRefreshToken, refreshExpiresIn)
}
}

Expand Down Expand Up @@ -487,7 +487,7 @@ func (r *OauthProxy) authorizationMiddleware() func(http.Handler) http.Handler {
}
}

r.dropUMATokenCookie(req, wrt, umaToken, time.Until(umaUser.ExpiresAt))
r.Cm.DropUMATokenCookie(req, wrt, umaToken, time.Until(umaUser.ExpiresAt))
wrt.Header().Set(constant.UMAHeader, umaToken)
scope.Logger.Debug("got uma token")
decision, err = authzFunc(authzPath, umaUser.Permissions)
Expand Down
2 changes: 1 addition & 1 deletion pkg/keycloak/proxy/misc.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ func (r *OauthProxy) redirectToAuthorization(wrt http.ResponseWriter, req *http.
}

// step: add a state referrer to the authorization page
uuid := r.writeStateParameterCookie(req, wrt)
uuid := r.Cm.WriteStateParameterCookie(req, wrt)
authQuery := fmt.Sprintf("?state=%s", uuid)

// step: if verification is switched off, we can't authorization
Expand Down
2 changes: 2 additions & 0 deletions pkg/keycloak/proxy/oauth_proxy.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import (
"github.com/gogatekeeper/gatekeeper/pkg/authorization"
"github.com/gogatekeeper/gatekeeper/pkg/constant"
"github.com/gogatekeeper/gatekeeper/pkg/keycloak/config"
"github.com/gogatekeeper/gatekeeper/pkg/proxy/cookie"
"github.com/gogatekeeper/gatekeeper/pkg/storage"
"go.uber.org/zap"
"gopkg.in/square/go-jose.v2/jwt"
Expand Down Expand Up @@ -55,6 +56,7 @@ type OauthProxy struct {
accessError func(wrt http.ResponseWriter, req *http.Request) context.Context
customSignInPage func(wrt http.ResponseWriter, authURL string)
GetIdentity func(req *http.Request, tokenCookie string, tokenHeader string) (*UserContext, error)
Cm *cookie.Manager
}

// TokenResponse
Expand Down
19 changes: 19 additions & 0 deletions pkg/keycloak/proxy/server.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ import (
"github.com/gogatekeeper/gatekeeper/pkg/constant"
"github.com/gogatekeeper/gatekeeper/pkg/encryption"
"github.com/gogatekeeper/gatekeeper/pkg/keycloak/config"
"github.com/gogatekeeper/gatekeeper/pkg/proxy/cookie"
proxycore "github.com/gogatekeeper/gatekeeper/pkg/proxy/core"
"github.com/gogatekeeper/gatekeeper/pkg/proxy/handlers"
"github.com/gogatekeeper/gatekeeper/pkg/proxy/metrics"
Expand Down Expand Up @@ -289,6 +290,24 @@ func (r *OauthProxy) CreateReverseProxy() error {
engine := chi.NewRouter()
r.useDefaultStack(engine)

r.Cm = &cookie.Manager{
CookieDomain: r.Config.CookieDomain,
BaseURI: r.Config.BaseURI,
HTTPOnlyCookie: r.Config.HTTPOnlyCookie,
SecureCookie: r.Config.SecureCookie,
EnableSessionCookies: r.Config.EnableSessionCookies,
SameSiteCookie: r.Config.SameSiteCookie,
CookieAccessName: r.Config.CookieAccessName,
CookieRefreshName: r.Config.CookieRefreshName,
CookieIDTokenName: r.Config.CookieIDTokenName,
CookiePKCEName: r.Config.CookiePKCEName,
CookieUMAName: r.Config.CookieUMAName,
CookieRequestURIName: r.Config.CookieRequestURIName,
CookieOAuthStateName: r.Config.CookieOAuthStateName,
NoProxy: r.Config.NoProxy,
NoRedirects: r.Config.NoRedirects,
}

r.GetIdentity = GetIdentity(
r.Log,
r.Config.SkipAuthorizationHeaderIdentity,
Expand Down
Loading