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.

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

✨ Support refreshing auth tokens #306

Merged
merged 1 commit into from
Apr 29, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
43 changes: 40 additions & 3 deletions api/auth.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,9 @@ import (
//
// Routes
const (
AuthRoot = "/auth"
AuthLoginRoot = AuthRoot + "/login"
AuthRoot = "/auth"
AuthLoginRoot = AuthRoot + "/login"
AuthRefreshRoot = AuthRoot + "/refresh"
)

//
Expand All @@ -23,6 +24,7 @@ type AuthHandler struct {
// AddRoutes adds routes.
func (h AuthHandler) AddRoutes(e *gin.Engine) {
e.POST(AuthLoginRoot, h.Login)
e.POST(AuthRefreshRoot, h.Refresh)
}

// Login godoc
Expand All @@ -39,7 +41,7 @@ func (h AuthHandler) Login(ctx *gin.Context) {
_ = ctx.Error(err)
return
}
r.Token, err = auth.Remote.Login(r.User, r.Password)
token, err := auth.Remote.Login(r.User, r.Password)
if err != nil {
h.Render(ctx,
http.StatusUnauthorized,
Expand All @@ -49,6 +51,39 @@ func (h AuthHandler) Login(ctx *gin.Context) {
return
}
r.Password = "" // Clear out password from response
r.Token = token.Access
r.Refresh = token.Refresh
r.Expiry = token.Expiry
h.Render(ctx, http.StatusCreated, r)
}

// Refresh godoc
// @summary Refresh bearer token.
// @description Refresh bearer token.
// @tags auth
// @produce json
// @success 201 {object} api.Login
// @router /auth/refresh [post]
func (h AuthHandler) Refresh(ctx *gin.Context) {
r := &Login{}
err := h.Bind(ctx, r)
if err != nil {
_ = ctx.Error(err)
return
}
token, err := auth.Remote.Refresh(r.Refresh)
if err != nil {
h.Render(ctx,
http.StatusUnauthorized,
gin.H{
"error": err.Error(),
})
return
}
r.Password = "" // Clear out password from response
r.Token = token.Access
r.Refresh = token.Refresh
r.Expiry = token.Expiry
h.Render(ctx, http.StatusCreated, r)
}

Expand All @@ -58,6 +93,8 @@ type Login struct {
User string `json:"user"`
Password string `json:"password,omitempty"`
Token string `json:"token"`
Refresh string `json:"refresh"`
Expiry int `json:"expiry"`
}

//
Expand Down
18 changes: 16 additions & 2 deletions auth/builtin.go
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,15 @@ func (r *NoAuth) User(jwToken *jwt.Token) (name string) {
return
}

//
// Login and obtain a token.
func (r *NoAuth) Login(user, password string) (token string, err error) {
func (r *NoAuth) Login(user, password string) (token Token, err error) {
return
}

//
// Refresh token.
func (r *NoAuth) Refresh(refresh string) (token Token, err error) {
return
}

Expand Down Expand Up @@ -140,8 +147,15 @@ func (r *Builtin) User(jwToken *jwt.Token) (user string) {
return
}

//
// Login and obtain a token.
func (r *Builtin) Login(user, password string) (token string, err error) {
func (r *Builtin) Login(user, password string) (token Token, err error) {
return
}

//
// Refresh token.
func (r *Builtin) Refresh(refresh string) (token Token, err error) {
return
}

Expand Down
25 changes: 23 additions & 2 deletions auth/keycloak.go
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,9 @@ func (r Keycloak) NewToken(user string, scopes []string, claims jwt.MapClaims) (
return
}

//
// Login and obtain a token.
func (r *Keycloak) Login(user, password string) (token string, err error) {
func (r *Keycloak) Login(user, password string) (token Token, err error) {
jwt, err := r.client.Login(
context.TODO(),
Settings.Auth.Keycloak.ClientID,
Expand All @@ -48,7 +49,27 @@ func (r *Keycloak) Login(user, password string) (token string, err error) {
password,
)
if err == nil {
token = jwt.AccessToken
token.Access = jwt.AccessToken
token.Refresh = jwt.RefreshToken
token.Expiry = jwt.ExpiresIn
}
return
}

//
// Refresh token.
func (r *Keycloak) Refresh(refresh string) (token Token, err error) {
jwt, err := r.client.RefreshToken(
context.TODO(),
refresh,
Settings.Auth.Keycloak.ClientID,
Settings.Auth.Keycloak.ClientSecret,
Settings.Auth.Keycloak.Realm,
)
if err == nil {
token.Access = jwt.AccessToken
token.Refresh = jwt.RefreshToken
token.Expiry = jwt.ExpiresIn
}
return
}
Expand Down
10 changes: 9 additions & 1 deletion auth/provider.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,15 @@ type Provider interface {
// User extracts the user from token.
User(jwToken *jwt.Token) (user string)
// Login and obtain a token.
Login(user, password string) (token string, err error)
Login(user, password string) (token Token, err error)
// Refresh token.
Refresh(refresh string) (token Token, err error)
}

type Token struct {
Access string
Refresh string
Expiry int
}

//
Expand Down