Skip to content
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
2 changes: 1 addition & 1 deletion echokit/auth0authenticator.go
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ func (a *Auth0Authenticator) GetAuthenticatedUser(c echo.Context) (*Authenticate
EmailVerified: emailVerified,
Picture: picture,
UpdatedAt: updatedAt,
Permissions: permissions,
Permissions: map[string][]string{a.config.Audience: permissions},
}, nil
}
}
Expand Down
2 changes: 1 addition & 1 deletion echokit/auth0jwtauthenticator.go
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ func (a *Auth0JWTAuthenticator) AuthenticateRequest(c echo.Context) error {
EmailVerified: customClaims.EmailVerified,
Picture: customClaims.Picture,
UpdatedAt: customClaims.UpdatedAt,
Permissions: customClaims.Permissions,
Permissions: map[string][]string{a.config.Audience: customClaims.Permissions},
}

c.Set(auth0JWTAuthenticatorContextKey, &authenticatedUser)
Expand Down
2 changes: 1 addition & 1 deletion echokit/authenticationmiddleware.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ type AuthenticatedUser struct {
EmailVerified bool
Picture string
UpdatedAt int64
Permissions []string
Permissions map[string][]string
}

type Authenticator interface {
Expand Down
25 changes: 23 additions & 2 deletions echokit/d3authjwtauthenticator.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package echokit

import (
"context"
"errors"
"net/http"
"net/url"
Expand All @@ -22,6 +23,26 @@ type D3AuthConfig struct {
Audience string
}

// D3AuthCustomClaims represents the custom claims in a d3-auth JWT.
// Permissions are keyed by API audience identifier.
type D3AuthCustomClaims struct {
Name string `json:"name"`
GivenName string `json:"given_name"`
FamilyName string `json:"family_name"`
MiddleName string `json:"middle_name"`
Nickname string `json:"nickname"`
PreferredUsername string `json:"preferred_username"`
Email string `json:"email"`
EmailVerified bool `json:"email_verified"`
Picture string `json:"picture"`
UpdatedAt int64 `json:"updated_at"`
Permissions map[string][]string `json:"permissions"`
}

func (c D3AuthCustomClaims) Validate(ctx context.Context) error {
return nil
}

type D3AuthJWTAuthenticator struct {
config D3AuthConfig
jwtValidator *validator.Validator
Expand All @@ -44,7 +65,7 @@ func NewD3AuthJWTAuthenticator(config D3AuthConfig) (Authenticator, error) {
[]string{config.Audience},
validator.WithCustomClaims(
func() validator.CustomClaims {
return &Auth0CustomClaims{}
return &D3AuthCustomClaims{}
},
),
validator.WithAllowedClockSkew(time.Minute),
Expand Down Expand Up @@ -80,7 +101,7 @@ func (a *D3AuthJWTAuthenticator) AuthenticateRequest(c echo.Context) error {
return errors.New("failed to cast to ValidatedClaims")
}

customClaims, ok := validatedClaims.CustomClaims.(*Auth0CustomClaims)
customClaims, ok := validatedClaims.CustomClaims.(*D3AuthCustomClaims)
if !ok {
return errors.New("failed to cast custom claims")
}
Expand Down
116 changes: 116 additions & 0 deletions echokit/d3authjwtauthenticator_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
package echokit

import (
"net/http"
"net/http/httptest"
"testing"

"github.com/labstack/echo/v4"
"github.com/stretchr/testify/assert"
)

func TestD3AuthJWTAuthenticator(t *testing.T) {
t.Run("returns_not_authenticated_when_no_authorization_header", func(t *testing.T) {
authenticator := &D3AuthJWTAuthenticator{}

_, c, _ := makeD3AuthTestContext(http.MethodGet, "/")

err := authenticator.AuthenticateRequest(c)

assert.NoError(t, err)
isAuth, _ := authenticator.IsAuthenticated(c)
assert.False(t, isAuth)
})

t.Run("returns_not_authenticated_when_authorization_header_is_not_bearer", func(t *testing.T) {
authenticator := &D3AuthJWTAuthenticator{}

_, c, _ := makeD3AuthTestContext(http.MethodGet, "/")
c.Request().Header.Set("Authorization", "Basic abc123")

err := authenticator.AuthenticateRequest(c)

assert.NoError(t, err)
isAuth, _ := authenticator.IsAuthenticated(c)
assert.False(t, isAuth)
})

t.Run("returns_authenticated_user_when_set_in_context", func(t *testing.T) {
authenticator := &D3AuthJWTAuthenticator{}

_, c, _ := makeD3AuthTestContext(http.MethodGet, "/")
c.Set(d3AuthJWTAuthenticatorContextKey, &AuthenticatedUser{
Sub: "theSubject",
Email: "theEmail@test.com",
})

isAuth, err := authenticator.IsAuthenticated(c)

assert.NoError(t, err)
assert.True(t, isAuth)

user, err := authenticator.GetAuthenticatedUser(c)

assert.NoError(t, err)
assert.Equal(t, "theSubject", user.Sub)
assert.Equal(t, "theEmail@test.com", user.Email)
})

t.Run("returns_error_from_GetAuthenticatedUser_when_not_authenticated", func(t *testing.T) {
authenticator := &D3AuthJWTAuthenticator{}

_, c, _ := makeD3AuthTestContext(http.MethodGet, "/")

user, err := authenticator.GetAuthenticatedUser(c)

assert.Error(t, err)
assert.Nil(t, user)
assert.Equal(t, "no authenticated user", err.Error())
})

t.Run("HandleNotAuthenticated_returns_401", func(t *testing.T) {
authenticator := &D3AuthJWTAuthenticator{}

_, c, rec := makeD3AuthTestContext(http.MethodGet, "/")

err := authenticator.HandleNotAuthenticated(c)

assert.NoError(t, err)
assert.Equal(t, http.StatusUnauthorized, rec.Code)
})
}

func TestNewD3AuthJWTAuthenticator(t *testing.T) {
t.Run("returns_an_error_when_base_url_is_invalid", func(t *testing.T) {
config := D3AuthConfig{
BaseURL: "://invalid",
Audience: "anAudience",
}

authenticator, err := NewD3AuthJWTAuthenticator(config)

assert.Nil(t, authenticator)
assert.Error(t, err)
assert.Contains(t, err.Error(), "failed to parse d3-auth base URL")
})

t.Run("creates_authenticator_with_valid_config", func(t *testing.T) {
config := D3AuthConfig{
BaseURL: "https://auth.example.com",
Audience: "https://api.example.com",
}

authenticator, err := NewD3AuthJWTAuthenticator(config)

assert.NoError(t, err)
assert.NotNil(t, authenticator)
})
}

func makeD3AuthTestContext(method, path string) (*echo.Echo, echo.Context, *httptest.ResponseRecorder) {
e := echo.New()
req := httptest.NewRequest(method, path, nil)
rec := httptest.NewRecorder()
c := e.NewContext(req, rec)
return e, c, rec
}
4 changes: 3 additions & 1 deletion echokit/entraidjwtauthenticator.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ const (

type EntraIDJWTAuthenticator struct {
tenantID string
audience string
jwtValidator *validator.Validator
}

Expand Down Expand Up @@ -72,6 +73,7 @@ func NewEntraIDJWTAuthenticator(tenantID, audience string) (Authenticator, error

return &EntraIDJWTAuthenticator{
tenantID: tenantID,
audience: audience,
jwtValidator: jwtValidator,
}, nil
}
Expand Down Expand Up @@ -120,7 +122,7 @@ func (a *EntraIDJWTAuthenticator) AuthenticateRequest(c echo.Context) error {
EmailVerified: false,
Picture: customClaims.Picture,
UpdatedAt: customClaims.UpdatedAt,
Permissions: permissions,
Permissions: map[string][]string{a.audience: permissions},
}

c.Set(entraIDJWTAuthenticatorContextKey, &authenticatedUser)
Expand Down
11 changes: 6 additions & 5 deletions echokit/requirepermissionsmiddleware.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import (
"github.com/labstack/echo/v4"
)

func RequirePermissions(permissions []string, orPermissions ...[]string) echo.MiddlewareFunc {
func RequirePermissions(audience string, permissions []string, orPermissions ...[]string) echo.MiddlewareFunc {
return func(next echo.HandlerFunc) echo.HandlerFunc {
return func(c echo.Context) error {
authenticator, err := GetAuthenticator(c)
Expand All @@ -36,10 +36,11 @@ func RequirePermissions(permissions []string, orPermissions ...[]string) echo.Mi

slog.Debug("checking user permissions", "user", authenticatedUser)

hasPermissions := checkPermissions(authenticatedUser.Permissions, permissions)
userPerms := authenticatedUser.Permissions[audience]
hasPermissions := checkPermissions(userPerms, permissions)
if !hasPermissions {
for _, orPerms := range orPermissions {
if checkPermissions(authenticatedUser.Permissions, orPerms) {
if checkPermissions(userPerms, orPerms) {
hasPermissions = true
break
}
Expand All @@ -56,13 +57,13 @@ func RequirePermissions(permissions []string, orPermissions ...[]string) echo.Mi
}
}

func RequirePermission(permission string, orPermission ...string) echo.MiddlewareFunc {
func RequirePermission(audience, permission string, orPermission ...string) echo.MiddlewareFunc {
orPermissions := [][]string{}
for _, orP := range orPermission {
orPermissions = append(orPermissions, []string{orP})
}

return RequirePermissions([]string{permission}, orPermissions...)
return RequirePermissions(audience, []string{permission}, orPermissions...)
}

func checkPermissions(userPermissions []string, requiredPermissions []string) bool {
Expand Down
Loading
Loading