-
Notifications
You must be signed in to change notification settings - Fork 24
feat(authz): JWT ERS that just returns claims #1630
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
Merged
Merged
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
30c3735
dummy ers mode
elizabethhealy 4cbd0b2
linting
elizabethhealy 67ba84d
linting
elizabethhealy 0869524
linting
elizabethhealy 0cd2dc8
rename to claims ERS
elizabethhealy fdbd799
Merge branch 'main' into dummy-ers-impl
elizabethhealy a25215c
Merge branch 'main' into dummy-ers-impl
elizabethhealy File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
141 changes: 141 additions & 0 deletions
141
service/entityresolution/claims/claims_entity_resolution.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,141 @@ | ||
| package entityresolution | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "log/slog" | ||
|
|
||
| "github.com/grpc-ecosystem/grpc-gateway/v2/runtime" | ||
| "github.com/lestrrat-go/jwx/v2/jwt" | ||
| "github.com/opentdf/platform/protocol/go/authorization" | ||
| "github.com/opentdf/platform/protocol/go/entityresolution" | ||
| auth "github.com/opentdf/platform/service/authorization" | ||
| "github.com/opentdf/platform/service/logger" | ||
| "github.com/opentdf/platform/service/pkg/serviceregistry" | ||
| "google.golang.org/protobuf/encoding/protojson" | ||
| "google.golang.org/protobuf/types/known/anypb" | ||
| "google.golang.org/protobuf/types/known/structpb" | ||
| ) | ||
|
|
||
| type ClaimsEntityResolutionService struct { | ||
| entityresolution.UnimplementedEntityResolutionServiceServer | ||
| logger *logger.Logger | ||
| } | ||
|
|
||
| func RegisterClaimsERS(_ serviceregistry.ServiceConfig, logger *logger.Logger) (any, serviceregistry.HandlerServer) { | ||
| return &ClaimsEntityResolutionService{logger: logger}, | ||
| func(ctx context.Context, mux *runtime.ServeMux, server any) error { | ||
| return entityresolution.RegisterEntityResolutionServiceHandlerServer(ctx, mux, server.(entityresolution.EntityResolutionServiceServer)) //nolint:forcetypeassert // allow type assert, following other services | ||
| } | ||
| } | ||
|
|
||
| func (s ClaimsEntityResolutionService) ResolveEntities(ctx context.Context, req *entityresolution.ResolveEntitiesRequest) (*entityresolution.ResolveEntitiesResponse, error) { | ||
| resp, err := EntityResolution(ctx, req, s.logger) | ||
| return &resp, err | ||
| } | ||
|
|
||
| func (s ClaimsEntityResolutionService) CreateEntityChainFromJwt(ctx context.Context, req *entityresolution.CreateEntityChainFromJwtRequest) (*entityresolution.CreateEntityChainFromJwtResponse, error) { | ||
| resp, err := CreateEntityChainFromJwt(ctx, req, s.logger) | ||
| return &resp, err | ||
| } | ||
|
|
||
| func CreateEntityChainFromJwt( | ||
| _ context.Context, | ||
| req *entityresolution.CreateEntityChainFromJwtRequest, | ||
| _ *logger.Logger, | ||
| ) (entityresolution.CreateEntityChainFromJwtResponse, error) { | ||
| entityChains := []*authorization.EntityChain{} | ||
| // for each token in the tokens form an entity chain | ||
| for _, tok := range req.GetTokens() { | ||
| entities, err := getEntitiesFromToken(tok.GetJwt()) | ||
| if err != nil { | ||
| return entityresolution.CreateEntityChainFromJwtResponse{}, err | ||
| } | ||
| entityChains = append(entityChains, &authorization.EntityChain{Id: tok.GetId(), Entities: entities}) | ||
| } | ||
|
|
||
| return entityresolution.CreateEntityChainFromJwtResponse{EntityChains: entityChains}, nil | ||
| } | ||
|
|
||
| func EntityResolution(_ context.Context, | ||
| req *entityresolution.ResolveEntitiesRequest, logger *logger.Logger, | ||
| ) (entityresolution.ResolveEntitiesResponse, error) { | ||
| payload := req.GetEntities() | ||
| var resolvedEntities []*entityresolution.EntityRepresentation | ||
|
|
||
| for idx, ident := range payload { | ||
| var entityStruct = &structpb.Struct{} | ||
| switch ident.GetEntityType().(type) { | ||
| case *authorization.Entity_Claims: | ||
| claims := ident.GetClaims() | ||
| if claims != nil { | ||
| err := claims.UnmarshalTo(entityStruct) | ||
| if err != nil { | ||
| return entityresolution.ResolveEntitiesResponse{}, fmt.Errorf("error unpacking anypb.Any to structpb.Struct: %w", err) | ||
| } | ||
| } | ||
| default: | ||
| retrievedStruct, err := entityToStructPb(ident) | ||
| if err != nil { | ||
| logger.Error("unable to make entity struct", slog.String("error", err.Error())) | ||
| return entityresolution.ResolveEntitiesResponse{}, fmt.Errorf("unable to make entity struct: %w", err) | ||
| } | ||
| entityStruct = retrievedStruct | ||
| } | ||
| // make sure the id field is populated | ||
| originialID := ident.GetId() | ||
| if originialID == "" { | ||
| originialID = auth.EntityIDPrefix + fmt.Sprint(idx) | ||
| } | ||
| resolvedEntities = append( | ||
| resolvedEntities, | ||
| &entityresolution.EntityRepresentation{ | ||
| OriginalId: originialID, | ||
| AdditionalProps: []*structpb.Struct{entityStruct}, | ||
| }, | ||
| ) | ||
| } | ||
| return entityresolution.ResolveEntitiesResponse{EntityRepresentations: resolvedEntities}, nil | ||
| } | ||
|
|
||
| func getEntitiesFromToken(jwtString string) ([]*authorization.Entity, error) { | ||
| token, err := jwt.ParseString(jwtString, jwt.WithVerify(false), jwt.WithValidate(false)) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("error parsing jwt: %w", err) | ||
| } | ||
|
|
||
| claims := token.PrivateClaims() | ||
| entities := []*authorization.Entity{} | ||
|
|
||
| // Convert map[string]interface{} to *structpb.Struct | ||
| structClaims, err := structpb.NewStruct(claims) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("error converting to structpb.Struct: %w", err) | ||
| } | ||
|
|
||
| // Wrap the struct in an *anypb.Any message | ||
| anyClaims, err := anypb.New(structClaims) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("error wrapping in anypb.Any: %w", err) | ||
| } | ||
|
|
||
| entities = append(entities, &authorization.Entity{ | ||
| EntityType: &authorization.Entity_Claims{Claims: anyClaims}, | ||
| Id: "jwtentity-claims", | ||
| Category: authorization.Entity_CATEGORY_SUBJECT, | ||
| }) | ||
| return entities, nil | ||
| } | ||
|
|
||
| func entityToStructPb(ident *authorization.Entity) (*structpb.Struct, error) { | ||
| entityBytes, err := protojson.Marshal(ident) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| var entityStruct structpb.Struct | ||
| err = entityStruct.UnmarshalJSON(entityBytes) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| return &entityStruct, nil | ||
| } | ||
125 changes: 125 additions & 0 deletions
125
service/entityresolution/claims/claims_entity_resolution_test.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,125 @@ | ||
| package entityresolution_test | ||
|
|
||
| import ( | ||
| "context" | ||
| "testing" | ||
|
|
||
| "github.com/opentdf/platform/protocol/go/authorization" | ||
| "github.com/opentdf/platform/protocol/go/entityresolution" | ||
| claims "github.com/opentdf/platform/service/entityresolution/claims" | ||
| "github.com/opentdf/platform/service/logger" | ||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/require" | ||
| "google.golang.org/protobuf/types/known/anypb" | ||
| "google.golang.org/protobuf/types/known/structpb" | ||
| ) | ||
|
|
||
| const samplejwt = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6ImhlbGxvd29ybGQiLCJpYXQiOjE1MTYyMzkwMjJ9.EAOittOMzKENEAs44eaMuZe-xas7VNVsgBxhwmxYiIw" | ||
|
|
||
| func Test_ClientResolveEntity(t *testing.T) { | ||
| var validBody []*authorization.Entity | ||
| validBody = append(validBody, &authorization.Entity{Id: "1234", EntityType: &authorization.Entity_ClientId{ClientId: "random"}}) | ||
|
|
||
| var ctxb = context.Background() | ||
|
|
||
| var req = entityresolution.ResolveEntitiesRequest{} | ||
| req.Entities = validBody | ||
|
|
||
| var resp, reserr = claims.EntityResolution(ctxb, &req, logger.CreateTestLogger()) | ||
|
|
||
| require.NoError(t, reserr) | ||
|
|
||
| var entityRepresentations = resp.GetEntityRepresentations() | ||
| assert.NotNil(t, entityRepresentations) | ||
| assert.Len(t, entityRepresentations, 1) | ||
|
|
||
| assert.Equal(t, "1234", entityRepresentations[0].GetOriginalId()) | ||
| assert.Len(t, entityRepresentations[0].GetAdditionalProps(), 1) | ||
| var propMap = entityRepresentations[0].GetAdditionalProps()[0].AsMap() | ||
| assert.Equal(t, "random", propMap["clientId"]) | ||
| assert.Equal(t, "1234", propMap["id"]) | ||
| } | ||
|
|
||
| func Test_EmailResolveEntity(t *testing.T) { | ||
| var validBody []*authorization.Entity | ||
| validBody = append(validBody, &authorization.Entity{Id: "1234", EntityType: &authorization.Entity_EmailAddress{EmailAddress: "random"}}) | ||
|
|
||
| var ctxb = context.Background() | ||
|
|
||
| var req = entityresolution.ResolveEntitiesRequest{} | ||
| req.Entities = validBody | ||
|
|
||
| var resp, reserr = claims.EntityResolution(ctxb, &req, logger.CreateTestLogger()) | ||
|
|
||
| require.NoError(t, reserr) | ||
|
|
||
| var entityRepresentations = resp.GetEntityRepresentations() | ||
| assert.NotNil(t, entityRepresentations) | ||
| assert.Len(t, entityRepresentations, 1) | ||
|
|
||
| assert.Equal(t, "1234", entityRepresentations[0].GetOriginalId()) | ||
| assert.Len(t, entityRepresentations[0].GetAdditionalProps(), 1) | ||
| var propMap = entityRepresentations[0].GetAdditionalProps()[0].AsMap() | ||
| assert.Equal(t, "random", propMap["emailAddress"]) | ||
| assert.Equal(t, "1234", propMap["id"]) | ||
| } | ||
|
|
||
| func Test_ClaimsResolveEntity(t *testing.T) { | ||
| customclaims := map[string]interface{}{ | ||
| "foo": "bar", | ||
| "baz": 42, | ||
| } | ||
| // Convert map[string]interface{} to *structpb.Struct | ||
| structClaims, err := structpb.NewStruct(customclaims) | ||
| require.NoError(t, err) | ||
|
|
||
| // Wrap the struct in an *anypb.Any | ||
| anyClaims, err := anypb.New(structClaims) | ||
| require.NoError(t, err) | ||
|
|
||
| var validBody []*authorization.Entity | ||
| validBody = append(validBody, &authorization.Entity{Id: "1234", EntityType: &authorization.Entity_Claims{Claims: anyClaims}}) | ||
|
|
||
| var ctxb = context.Background() | ||
|
|
||
| var req = entityresolution.ResolveEntitiesRequest{} | ||
| req.Entities = validBody | ||
|
|
||
| var resp, reserr = claims.EntityResolution(ctxb, &req, logger.CreateTestLogger()) | ||
|
|
||
| require.NoError(t, reserr) | ||
|
|
||
| var entityRepresentations = resp.GetEntityRepresentations() | ||
| assert.NotNil(t, entityRepresentations) | ||
| assert.Len(t, entityRepresentations, 1) | ||
|
|
||
| assert.Equal(t, "1234", entityRepresentations[0].GetOriginalId()) | ||
| assert.Len(t, entityRepresentations[0].GetAdditionalProps(), 1) | ||
| var propMap = entityRepresentations[0].GetAdditionalProps()[0].AsMap() | ||
| assert.Equal(t, "bar", propMap["foo"]) | ||
| assert.EqualValues(t, 42, propMap["baz"]) | ||
| } | ||
|
|
||
| func Test_JWTToEntityChainClaims(t *testing.T) { | ||
| var ctxb = context.Background() | ||
|
|
||
| validBody := []*authorization.Token{{Jwt: samplejwt}} | ||
|
|
||
| var resp, reserr = claims.CreateEntityChainFromJwt(ctxb, &entityresolution.CreateEntityChainFromJwtRequest{Tokens: validBody}, logger.CreateTestLogger()) | ||
|
|
||
| require.NoError(t, reserr) | ||
|
|
||
| assert.Len(t, resp.GetEntityChains(), 1) | ||
| assert.Len(t, resp.GetEntityChains()[0].GetEntities(), 1) | ||
| assert.IsType(t, &authorization.Entity_Claims{}, resp.GetEntityChains()[0].GetEntities()[0].GetEntityType()) | ||
| assert.Equal(t, authorization.Entity_CATEGORY_SUBJECT, resp.GetEntityChains()[0].GetEntities()[0].GetCategory()) | ||
|
|
||
| var unpackedStruct structpb.Struct | ||
| err := resp.GetEntityChains()[0].GetEntities()[0].GetClaims().UnmarshalTo(&unpackedStruct) | ||
| require.NoError(t, err) | ||
|
|
||
| // Convert structpb.Struct to map[string]interface{} | ||
| claimsMap := unpackedStruct.AsMap() | ||
|
|
||
| assert.Equal(t, "helloworld", claimsMap["name"]) | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,48 +1,36 @@ | ||
| package entityresolution | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| "github.com/grpc-ecosystem/grpc-gateway/v2/runtime" | ||
| "github.com/mitchellh/mapstructure" | ||
| "github.com/opentdf/platform/protocol/go/entityresolution" | ||
| claims "github.com/opentdf/platform/service/entityresolution/claims" | ||
| keycloak "github.com/opentdf/platform/service/entityresolution/keycloak" | ||
| "github.com/opentdf/platform/service/logger" | ||
| "github.com/opentdf/platform/service/pkg/serviceregistry" | ||
| ) | ||
|
|
||
| type EntityResolutionService struct { //nolint:revive // allow for simple naming | ||
| entityresolution.UnimplementedEntityResolutionServiceServer | ||
| idpConfig keycloak.KeycloakConfig | ||
| logger *logger.Logger | ||
| type ERSConfig struct { | ||
| Mode string `mapstructure:"mode" json:"mode"` | ||
| } | ||
|
|
||
| const KeycloakMode = "keycloak" | ||
| const ClaimsMode = "claims" | ||
|
|
||
| func NewRegistration() serviceregistry.Registration { | ||
| return serviceregistry.Registration{ | ||
| Namespace: "entityresolution", | ||
| ServiceDesc: &entityresolution.EntityResolutionService_ServiceDesc, | ||
| RegisterFunc: func(srp serviceregistry.RegistrationParams) (any, serviceregistry.HandlerServer) { | ||
| var inputIdpConfig keycloak.KeycloakConfig | ||
| var inputConfig ERSConfig | ||
|
|
||
| if err := mapstructure.Decode(srp.Config, &inputIdpConfig); err != nil { | ||
| if err := mapstructure.Decode(srp.Config, &inputConfig); err != nil { | ||
| panic(err) | ||
| } | ||
|
|
||
| srp.Logger.Debug("entity_resolution configuration", "config", inputIdpConfig) | ||
|
|
||
| return &EntityResolutionService{idpConfig: inputIdpConfig, logger: srp.Logger}, func(ctx context.Context, mux *runtime.ServeMux, server any) error { | ||
| return entityresolution.RegisterEntityResolutionServiceHandlerServer(ctx, mux, server.(entityresolution.EntityResolutionServiceServer)) //nolint:forcetypeassert // allow type assert, following other services | ||
| if inputConfig.Mode == ClaimsMode { | ||
| return claims.RegisterClaimsERS(srp.Config, srp.Logger) | ||
| } | ||
|
|
||
| // Default to keyclaok ERS | ||
| return keycloak.RegisterKeycloakERS(srp.Config, srp.Logger) | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| func (s EntityResolutionService) ResolveEntities(ctx context.Context, req *entityresolution.ResolveEntitiesRequest) (*entityresolution.ResolveEntitiesResponse, error) { | ||
| resp, err := keycloak.EntityResolution(ctx, req, s.idpConfig, s.logger) | ||
| return &resp, err | ||
| } | ||
|
|
||
| func (s EntityResolutionService) CreateEntityChainFromJwt(ctx context.Context, req *entityresolution.CreateEntityChainFromJwtRequest) (*entityresolution.CreateEntityChainFromJwtResponse, error) { | ||
| resp, err := keycloak.CreateEntityChainFromJwt(ctx, req, s.idpConfig, s.logger) | ||
| return &resp, err | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.