Files
deploy/util/oidc/oidc_azure_test.go
zeekayandHanzo Dev 1ab6e799c1 cd: the module is github.com/hanzoai/cd, where it is actually hosted
go.mod still declared `module github.com/hanzoai/deploy` after the repo was
renamed. A Go module path is not cosmetic — it is the resolvable location. So
`go get github.com/hanzoai/cd` could not work, and anything importing this
module had to spell a name that no longer exists at that address. The build log
of v3.6.0 is where it surfaced: the compiler was still emitting
github.com/hanzoai/deploy/cmd/cd/commands.

3541 import paths across 690 .go, 19 .proto, 4 .yaml, 3 .sh, 2 .mod, Procfile
and Makefile. Plus the 62 ghcr.io/hanzoai/deploy image references, moved to
ghcr.io/hanzoai/cd to match hanzo.yml's build target — a distinct string from
the module path, replaced separately so neither could clobber the other.

go mod tidy clean, CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build ./... clean.

Co-authored-by: Hanzo Dev <[email protected]>
2026-07-28 21:16:24 -07:00

518 lines
16 KiB
Go

package oidc
import (
"encoding/json"
"net/http"
"net/http/httptest"
"testing"
"time"
"github.com/golang-jwt/jwt/v5"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/hanzoai/cd/util"
"github.com/hanzoai/cd/util/cache"
"github.com/hanzoai/cd/util/crypto"
"github.com/hanzoai/cd/util/settings"
)
func createTestJWT(t *testing.T, claims jwt.MapClaims) string {
t.Helper()
token := jwt.NewWithClaims(jwt.SigningMethodHS256, claims)
tokenString, err := token.SignedString([]byte("test-secret"))
require.NoError(t, err)
return tokenString
}
func TestHasAzureGroupsClaimOverflow(t *testing.T) {
tests := []struct {
name string
claims jwt.MapClaims
expected bool
}{
{
name: "no overage indicators",
claims: jwt.MapClaims{
"sub": "user123",
},
expected: false,
},
{
name: "with overage claim",
claims: jwt.MapClaims{
"sub": "user123",
"_claim_sources": map[string]any{
"src1": map[string]any{
"endpoint": "https://graph.windows.net/tenant-id/users/user-id/getMemberObjects",
},
},
"_claim_names": map[string]any{
"groups": "src1",
},
},
expected: true,
},
{
name: "with _claim_names but no groups key",
claims: jwt.MapClaims{
"sub": "user123",
"_claim_sources": map[string]any{
"src1": map[string]any{},
},
"_claim_names": map[string]any{
"roles": "src1",
},
},
expected: false,
},
{
name: "with _claim_names but missing _claim_sources",
claims: jwt.MapClaims{
"sub": "user123",
"_claim_names": map[string]any{
"groups": "src1",
},
},
expected: false,
},
{
name: "with nil _claim_names",
claims: jwt.MapClaims{
"sub": "user123",
"_claim_names": nil,
"_claim_sources": map[string]any{},
},
expected: false,
},
{
name: "with multiple overage keys including groups",
claims: jwt.MapClaims{
"sub": "user123",
"_claim_sources": map[string]any{
"src1": map[string]any{},
"src2": map[string]any{},
},
"_claim_names": map[string]any{
"groups": "src1",
"roles": "src2",
},
},
expected: true,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
result := hasAzureGroupsClaimOverflow(tt.claims)
assert.Equal(t, tt.expected, result)
})
}
}
func TestHasUserReadScope(t *testing.T) {
tests := []struct {
name string
accessToken string
expected bool
}{
{
name: "valid token with User.Read scope",
accessToken: createTestJWT(t, jwt.MapClaims{"scp": "User.Read profile email"}),
expected: true,
},
{
name: "valid token without User.Read scope",
accessToken: createTestJWT(t, jwt.MapClaims{"scp": "profile email"}),
expected: false,
},
{
name: "case insensitive User.Read",
accessToken: createTestJWT(t, jwt.MapClaims{"scp": "user.read profile"}),
expected: true,
},
{
name: "token without scp claim",
accessToken: createTestJWT(t, jwt.MapClaims{"sub": "user123"}),
expected: false,
},
{
name: "invalid token",
accessToken: "invalid.jwt.token",
expected: false,
},
{
name: "User.Read in array format",
accessToken: createTestJWT(t, jwt.MapClaims{"scp": []string{"User.Read", "profile"}}),
expected: true,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
result := hasUserReadScope(tt.accessToken)
assert.Equal(t, tt.expected, result)
})
}
}
func TestGetUserGroupsFromAzureOverageClaim(t *testing.T) {
overageClaims := jwt.MapClaims{
"sub": "user123",
"exp": float64(time.Now().Add(5 * time.Minute).Unix()),
"_claim_sources": map[string]any{
"src1": map[string]any{
"endpoint": "https://graph.windows.net/tenant-id/users/user-id/getMemberObjects",
},
},
"_claim_names": map[string]any{
"groups": "src1",
},
}
tests := []struct {
name string
claims jwt.MapClaims
idpHandler func(w http.ResponseWriter, r *http.Request)
cacheItems map[string]string // key -> value to pre-populate (will be encrypted)
expectedGroups []string
expectError bool
}{
{
name: "no overage claim returns nil",
claims: jwt.MapClaims{"sub": "user123", "exp": float64(time.Now().Add(5 * time.Minute).Unix())},
idpHandler: func(_ http.ResponseWriter, _ *http.Request) {
t.Fatal("Graph API should not be called when no overage claim")
},
expectedGroups: nil,
expectError: false,
},
{
name: "successful Graph API call",
claims: overageClaims,
idpHandler: func(w http.ResponseWriter, _ *http.Request) {
w.Header().Set("Content-Type", "application/json")
err := json.NewEncoder(w).Encode(map[string]any{
"value": []string{"group-id-1", "group-id-2"},
})
require.NoError(t, err)
},
cacheItems: map[string]string{
FormatAccessTokenCacheKey("user123"): createTestJWT(t, jwt.MapClaims{"scp": "User.Read profile email"}),
},
expectedGroups: []string{"group-id-1", "group-id-2"},
expectError: false,
},
{
name: "no access token in cache",
claims: overageClaims,
idpHandler: func(_ http.ResponseWriter, _ *http.Request) {
t.Fatal("Graph API should not be called without access token")
},
cacheItems: nil,
expectedGroups: nil,
expectError: true,
},
{
name: "access token missing User.Read scope",
claims: overageClaims,
idpHandler: func(_ http.ResponseWriter, _ *http.Request) {
t.Fatal("Graph API should not be called without User.Read scope")
},
cacheItems: map[string]string{
FormatAccessTokenCacheKey("user123"): createTestJWT(t, jwt.MapClaims{"scp": "profile email"}),
},
expectedGroups: nil,
expectError: true,
},
{
name: "Graph API returns error",
claims: overageClaims,
idpHandler: func(w http.ResponseWriter, _ *http.Request) {
w.WriteHeader(http.StatusForbidden)
},
cacheItems: map[string]string{
FormatAccessTokenCacheKey("user123"): createTestJWT(t, jwt.MapClaims{"scp": "User.Read profile email"}),
},
expectedGroups: nil,
expectError: true,
},
{
name: "Graph API rate limited",
claims: overageClaims,
idpHandler: func(w http.ResponseWriter, _ *http.Request) {
w.WriteHeader(http.StatusTooManyRequests)
},
cacheItems: map[string]string{
FormatAccessTokenCacheKey("user123"): createTestJWT(t, jwt.MapClaims{"scp": "User.Read profile email"}),
},
expectedGroups: nil,
expectError: true,
},
{
name: "cached groups returned without Graph API call",
claims: overageClaims,
idpHandler: func(_ http.ResponseWriter, _ *http.Request) {
t.Fatal("Graph API should not be called when groups are cached")
},
cacheItems: map[string]string{
FormatAccessTokenCacheKey("user123"): createTestJWT(t, jwt.MapClaims{"scp": "User.Read profile email"}),
FormatAzureGroupsOverageResponseCacheKey("user123"): `["cached-group-1","cached-group-2"]`,
},
expectedGroups: []string{"cached-group-1", "cached-group-2"},
expectError: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
ts := httptest.NewServer(http.HandlerFunc(tt.idpHandler))
defer ts.Close()
signature, err := util.MakeSignature(32)
require.NoError(t, err)
cdSettings := &settings.ArgoCDSettings{
ServerSignature: signature,
OIDCConfigRAW: `{"azure": {"enableUserGroupOverageClaim": true}}`,
}
encryptionKey, err := cdSettings.GetServerEncryptionKey()
require.NoError(t, err)
testCache := cache.NewInMemoryCache(24 * time.Hour)
a, err := NewClientApp(cdSettings, "", nil, "/argo-cd", testCache)
require.NoError(t, err)
for key, value := range tt.cacheItems {
encValue, err := crypto.Encrypt([]byte(value), encryptionKey)
require.NoError(t, err)
err = a.clientCache.Set(&cache.Item{
Key: key,
Object: encValue,
})
require.NoError(t, err)
}
groups, err := a.GetUserGroupsFromAzureOverageClaim(t.Context(), tt.claims, ts.URL)
assert.Equal(t, tt.expectedGroups, groups)
if tt.expectError {
require.Error(t, err)
} else {
require.NoError(t, err)
}
})
}
}
func TestFormatAzureGroupsOverageResponseCacheKey(t *testing.T) {
key := FormatAzureGroupsOverageResponseCacheKey("user123")
assert.Equal(t, "azure_groups_overage_response_user123", key)
}
func TestCacheAzureGroupsOverageResponse(t *testing.T) {
overageClaims := jwt.MapClaims{
"sub": "user123",
"exp": float64(time.Now().Add(5 * time.Minute).Unix()),
"_claim_sources": map[string]any{
"src1": map[string]any{},
},
"_claim_names": map[string]any{
"groups": "src1",
},
}
t.Run("successful cache write is readable", func(t *testing.T) {
signature, err := util.MakeSignature(32)
require.NoError(t, err)
cdSettings := &settings.ArgoCDSettings{
ServerSignature: signature,
OIDCConfigRAW: `{"azure": {"enableUserGroupOverageClaim": true}}`,
}
encryptionKey, err := cdSettings.GetServerEncryptionKey()
require.NoError(t, err)
testCache := cache.NewInMemoryCache(24 * time.Hour)
a, err := NewClientApp(cdSettings, "", nil, "/argo-cd", testCache)
require.NoError(t, err)
groups := []string{"group-1", "group-2"}
cacheKey := FormatAzureGroupsOverageResponseCacheKey("user123")
a.cacheAzureGroupsOverageResponse(cacheKey, groups, overageClaims)
var encValue []byte
err = testCache.Get(cacheKey, &encValue)
require.NoError(t, err)
decrypted, err := crypto.Decrypt(encValue, encryptionKey)
require.NoError(t, err)
var got []string
err = json.Unmarshal(decrypted, &got)
require.NoError(t, err)
assert.Equal(t, groups, got)
})
t.Run("cache uses token expiry when no custom setting", func(t *testing.T) {
signature, err := util.MakeSignature(32)
require.NoError(t, err)
cdSettings := &settings.ArgoCDSettings{
ServerSignature: signature,
OIDCConfigRAW: `{"azure": {"enableUserGroupOverageClaim": true}}`,
}
testCache := cache.NewInMemoryCache(24 * time.Hour)
a, err := NewClientApp(cdSettings, "", nil, "/argo-cd", testCache)
require.NoError(t, err)
groups := []string{"group-a"}
cacheKey := FormatAzureGroupsOverageResponseCacheKey("user123")
// No custom expiry configured — must fall back to token expiry without panic.
a.cacheAzureGroupsOverageResponse(cacheKey, groups, overageClaims)
var encValue []byte
err = testCache.Get(cacheKey, &encValue)
require.NoError(t, err)
assert.NotEmpty(t, encValue)
})
t.Run("cache uses custom expiry when shorter than token expiry", func(t *testing.T) {
signature, err := util.MakeSignature(32)
require.NoError(t, err)
// Set a custom expiry of 1 minute, shorter than the 5-minute token expiry.
cdSettings := &settings.ArgoCDSettings{
ServerSignature: signature,
OIDCConfigRAW: `{"azure": {"enableUserGroupOverageClaim": true, "userGroupOverageClaimCacheExpiration": "1m"}}`,
}
testCache := cache.NewInMemoryCache(24 * time.Hour)
a, err := NewClientApp(cdSettings, "", nil, "/argo-cd", testCache)
require.NoError(t, err)
groups := []string{"group-b"}
cacheKey := FormatAzureGroupsOverageResponseCacheKey("user123")
a.cacheAzureGroupsOverageResponse(cacheKey, groups, overageClaims)
var encValue []byte
err = testCache.Get(cacheKey, &encValue)
require.NoError(t, err)
assert.NotEmpty(t, encValue)
})
}
func TestGetUserGroupsFromAzureOverageClaim_CacheHitAfterFetch(t *testing.T) {
overageClaims := jwt.MapClaims{
"sub": "user123",
"exp": float64(time.Now().Add(5 * time.Minute).Unix()),
"_claim_sources": map[string]any{
"src1": map[string]any{
"endpoint": "https://graph.windows.net/tenant-id/users/user-id/getMemberObjects",
},
},
"_claim_names": map[string]any{
"groups": "src1",
},
}
graphCallCount := 0
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
graphCallCount++
w.Header().Set("Content-Type", "application/json")
err := json.NewEncoder(w).Encode(map[string]any{
"value": []string{"group-id-1", "group-id-2"},
})
require.NoError(t, err)
}))
defer ts.Close()
signature, err := util.MakeSignature(32)
require.NoError(t, err)
cdSettings := &settings.ArgoCDSettings{
ServerSignature: signature,
OIDCConfigRAW: `{"azure": {"enableUserGroupOverageClaim": true}}`,
}
encryptionKey, err := cdSettings.GetServerEncryptionKey()
require.NoError(t, err)
testCache := cache.NewInMemoryCache(24 * time.Hour)
a, err := NewClientApp(cdSettings, "", nil, "/argo-cd", testCache)
require.NoError(t, err)
accessToken := createTestJWT(t, jwt.MapClaims{"scp": "User.Read profile email"})
encAccessToken, err := crypto.Encrypt([]byte(accessToken), encryptionKey)
require.NoError(t, err)
err = testCache.Set(&cache.Item{Key: FormatAccessTokenCacheKey("user123"), Object: encAccessToken})
require.NoError(t, err)
// First call — should hit the Graph API.
groups, err := a.GetUserGroupsFromAzureOverageClaim(t.Context(), overageClaims, ts.URL)
require.NoError(t, err)
assert.Equal(t, []string{"group-id-1", "group-id-2"}, groups)
assert.Equal(t, 1, graphCallCount)
// Second call — groups should come from cache; Graph API must not be called again.
groups, err = a.GetUserGroupsFromAzureOverageClaim(t.Context(), overageClaims, ts.URL)
require.NoError(t, err)
assert.Equal(t, []string{"group-id-1", "group-id-2"}, groups)
assert.Equal(t, 1, graphCallCount, "Graph API should only be called once; second call must use cache")
}
func TestGetUserGroupsFromAzureOverageClaim_CorruptCacheCallsAPI(t *testing.T) {
overageClaims := jwt.MapClaims{
"sub": "user123",
"exp": float64(time.Now().Add(5 * time.Minute).Unix()),
"_claim_sources": map[string]any{
"src1": map[string]any{
"endpoint": "https://graph.windows.net/tenant-id/users/user-id/getMemberObjects",
},
},
"_claim_names": map[string]any{
"groups": "src1",
},
}
graphCallCount := 0
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
graphCallCount++
w.Header().Set("Content-Type", "application/json")
err := json.NewEncoder(w).Encode(map[string]any{
"value": []string{"group-from-api"},
})
require.NoError(t, err)
}))
defer ts.Close()
signature, err := util.MakeSignature(32)
require.NoError(t, err)
cdSettings := &settings.ArgoCDSettings{
ServerSignature: signature,
OIDCConfigRAW: `{"azure": {"enableUserGroupOverageClaim": true}}`,
}
encryptionKey, err := cdSettings.GetServerEncryptionKey()
require.NoError(t, err)
testCache := cache.NewInMemoryCache(24 * time.Hour)
a, err := NewClientApp(cdSettings, "", nil, "/argo-cd", testCache)
require.NoError(t, err)
// Populate cache with corrupt (non-JSON) data that is still validly encrypted.
corruptData, err := crypto.Encrypt([]byte("not valid json"), encryptionKey)
require.NoError(t, err)
err = testCache.Set(&cache.Item{
Key: FormatAzureGroupsOverageResponseCacheKey("user123"),
Object: corruptData,
})
require.NoError(t, err)
// Populate the access token cache so the Graph API call can proceed.
accessToken := createTestJWT(t, jwt.MapClaims{"scp": "User.Read profile email"})
encAccessToken, err := crypto.Encrypt([]byte(accessToken), encryptionKey)
require.NoError(t, err)
err = testCache.Set(&cache.Item{Key: FormatAccessTokenCacheKey("user123"), Object: encAccessToken})
require.NoError(t, err)
// Corrupt cache should be skipped and the Graph API called as fallback.
groups, err := a.GetUserGroupsFromAzureOverageClaim(t.Context(), overageClaims, ts.URL)
require.NoError(t, err)
assert.Equal(t, []string{"group-from-api"}, groups)
assert.Equal(t, 1, graphCallCount, "Graph API should be called when cached data is corrupt")
}