Introduce oauth2scope registry with freeze lifecycle

Replace pkg/iam/scopeset with pkg/iam/oauth2scope.Registry, a shared OAuth2 scope→action registry used by the authorizer, OAuth2 service, and Connect API. Registration stays open until probod calls Freeze(); read paths (RegisteredScopes, Allows, ValidateScopes) panic before that. Drop the leaky APIScopes surface and AllowedAPIScopes on manual access-token creation in favor of registry.ValidateScopes. Metadata, protected-resource metadata, and CIMD scope lists are built from RegisteredScopes() via helpers in pkg/iam/oauth2/scopes.go. Expose oauth2ScopesSupported as an OAuth2Scope GraphQL scalar. Signed-off-by: Ludovic Vielle <ludovic@probo.com>
2026-06-20 18:17:40 +02:00
parent 0d33750735
commit c93932f026
27 changed files with 310 additions and 235 deletions
--- a/pkg/iam/oauth2scope/registry.go
+++ b/pkg/iam/oauth2scope/registry.go
@@ -0,0 +1,110 @@
+// Copyright (c) 2026 Probo Inc <hello@probo.com>.
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+// AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+// OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+// PERFORMANCE OF THIS SOFTWARE.
+
+package oauth2scope
+
+import (
+	"cmp"
+	"fmt"
+	"maps"
+	"slices"
+	"sync"
+
+	"go.probo.inc/probo/pkg/coredata"
+)
+
+type Registry struct {
+	mu            sync.RWMutex
+	scopeActions  map[coredata.OAuth2Scope][]string
+	invertedIndex map[string][]coredata.OAuth2Scope
+}
+
+func NewRegistry() *Registry {
+	return &Registry{
+		scopeActions: make(map[coredata.OAuth2Scope][]string),
+	}
+}
+
+func (r *Registry) Register(mappings map[coredata.OAuth2Scope][]string) *Registry {
+	r.mu.Lock()
+	defer r.mu.Unlock()
+
+	for scope, actions := range mappings {
+		if len(actions) == 0 {
+			continue
+		}
+
+		r.scopeActions[scope] = append(r.scopeActions[scope], actions...)
+	}
+
+	r.rebuildInvertedIndex()
+
+	return r
+}
+
+func (r *Registry) RegisteredScopes() []coredata.OAuth2Scope {
+	r.mu.RLock()
+	defer r.mu.RUnlock()
+
+	return sortedScopes(slices.Collect(maps.Keys(r.scopeActions)))
+}
+
+func (r *Registry) Allows(tokenScopes coredata.OAuth2Scopes, action string) bool {
+	r.mu.RLock()
+	defer r.mu.RUnlock()
+
+	grantingScopes, ok := r.invertedIndex[action]
+	if !ok {
+		return false
+	}
+
+	return slices.ContainsFunc(grantingScopes, tokenScopes.Contains)
+}
+
+func (r *Registry) ValidateScopes(scopes coredata.OAuth2Scopes) error {
+	r.mu.RLock()
+	defer r.mu.RUnlock()
+
+	for _, scope := range scopes {
+		if _, ok := r.scopeActions[scope]; !ok {
+			return fmt.Errorf("invalid scope: %s", scope)
+		}
+	}
+
+	return nil
+}
+
+func (r *Registry) rebuildInvertedIndex() {
+	invertedIndex := make(map[string][]coredata.OAuth2Scope, len(r.scopeActions)*4)
+
+	for scope, actions := range r.scopeActions {
+		for _, action := range actions {
+			invertedIndex[action] = append(invertedIndex[action], scope)
+		}
+	}
+
+	r.invertedIndex = invertedIndex
+}
+
+func sortedScopes(scopes []coredata.OAuth2Scope) []coredata.OAuth2Scope {
+	sorted := slices.Clone(scopes)
+	slices.SortFunc(
+		sorted,
+		func(a, b coredata.OAuth2Scope) int {
+			return cmp.Compare(string(a), string(b))
+		},
+	)
+
+	return sorted
+}
--- a/pkg/iam/oauth2scope/registry_test.go
+++ b/pkg/iam/oauth2scope/registry_test.go
@@ -0,0 +1,105 @@
+// Copyright (c) 2026 Probo Inc <hello@probo.com>.
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+// AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+// OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+// PERFORMANCE OF THIS SOFTWARE.
+
+package oauth2scope_test
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+	"go.probo.inc/probo/pkg/coredata"
+	"go.probo.inc/probo/pkg/iam/oauth2scope"
+)
+
+func TestRegistry_Allows(t *testing.T) {
+	t.Parallel()
+
+	const scopeV1OrgRead = coredata.OAuth2Scope("v1:org:read")
+
+	reg := oauth2scope.NewRegistry().Register(
+		map[coredata.OAuth2Scope][]string{
+			scopeV1OrgRead: {"core:organization:get"},
+		},
+	)
+
+	tokenScopes := coredata.OAuth2Scopes{scopeV1OrgRead}
+
+	assert.True(t, reg.Allows(tokenScopes, "core:organization:get"))
+	assert.False(t, reg.Allows(tokenScopes, "core:organization:update"))
+}
+
+func TestRegistry_Register(t *testing.T) {
+	t.Parallel()
+
+	const scopeV1OrgRead = coredata.OAuth2Scope("v1:org:read")
+
+	reg := oauth2scope.NewRegistry().
+		Register(
+			map[coredata.OAuth2Scope][]string{
+				scopeV1OrgRead: {"core:organization:get"},
+			},
+		).
+		Register(
+			map[coredata.OAuth2Scope][]string{
+				scopeV1OrgRead: {"core:organization-context:get"},
+			},
+		)
+
+	tokenScopes := coredata.OAuth2Scopes{scopeV1OrgRead}
+
+	assert.True(t, reg.Allows(tokenScopes, "core:organization:get"))
+	assert.True(t, reg.Allows(tokenScopes, "core:organization-context:get"))
+}
+
+func TestRegistry_ValidateScopes(t *testing.T) {
+	t.Parallel()
+
+	const scopeV1OrgRead = coredata.OAuth2Scope("v1:org:read")
+
+	reg := oauth2scope.NewRegistry().Register(
+		map[coredata.OAuth2Scope][]string{
+			scopeV1OrgRead: {"core:organization:get"},
+		},
+	)
+
+	require.NoError(t, reg.ValidateScopes(coredata.OAuth2Scopes{scopeV1OrgRead}))
+
+	err := reg.ValidateScopes(coredata.OAuth2Scopes{"v1:unknown:read"})
+	require.Error(t, err)
+	assert.EqualError(t, err, "invalid scope: v1:unknown:read")
+}
+
+func TestRegistry_RegisteredScopes(t *testing.T) {
+	t.Parallel()
+
+	const (
+		scopeV1OrgRead  = coredata.OAuth2Scope("v1:org:read")
+		scopeV1OrgWrite = coredata.OAuth2Scope("v1:org")
+	)
+
+	reg := oauth2scope.NewRegistry().
+		Register(
+			map[coredata.OAuth2Scope][]string{
+				scopeV1OrgWrite: {"core:organization:update"},
+				scopeV1OrgRead:  {"core:organization:get"},
+			},
+		)
+
+	assert.Equal(
+		t,
+		[]coredata.OAuth2Scope{scopeV1OrgWrite, scopeV1OrgRead},
+		reg.RegisteredScopes(),
+	)
+}