Skip to content

armgit / cua

Public Imported from GitHub
0

Scale computer-use 2.0 with open-source drivers, cross-OS sandboxes, and benchmarks for training, evaluation, and data generation.

feat(fleets): migrate GitHub WIF audience and guidance (#6644)

r33drichards32854fee2820
diff --git a/libs/fleet/backend/auth/auth.go b/libs/fleet/backend/auth/auth.go
index 983cb08f72..de0adcb14b 100644
--- a/libs/fleet/backend/auth/auth.go
+++ b/libs/fleet/backend/auth/auth.go
@@ -1,10 +1,9 @@
// Package auth — Keycloak JWT validation, adapted from r33drichards/grt.
//
// Differences from upstream:
-// - Issuer-based validation (`iss` must match the configured realm)
-// replaces grt's `aud`/scope checks — Keycloak service-account tokens
-// don't carry a useful `aud`, but `iss` + signature are sufficient
-// given we control the realm.
+// - Keycloak validation uses the configured issuer because service-account
+// tokens do not carry a useful `aud`; GitHub OIDC validates signed
+// audiences separately.
// - OPA (Rego) is used for all route-level authorization via
// OpaMiddleware; see auth/authz.rego. The gateway surface additionally
// enforces that the token's `namespace` claim equals "pool-{name}"
@@ -191,7 +190,6 @@ func validateGitHub(ctx context.Context, raw string) (*User, error) {
tok, err := jwt.Parse(raw, cachedGitHubJWKS.Keyfunc,
jwt.WithLeeway(30*time.Second),
jwt.WithIssuer(authConfig.GitHubOIDCIssuer),
- jwt.WithAudience(authConfig.GitHubOIDCAudience),
jwt.WithValidMethods(authConfig.GitHubOIDCAlgs),
)
if err != nil {
@@ -204,6 +202,13 @@ func validateGitHub(ctx context.Context, raw string) (*User, error) {
if !ok {
return nil, fmt.Errorf("unexpected claims type")
}
+ if err := validateGitHubAudience(
+ claims,
+ authConfig.GitHubOIDCAudience,
+ authConfig.GitHubOIDCLegacyAudiences,
+ ); err != nil {
+ return nil, err
+ }
repository := str(claims, "repository")
if repository == "" {
return nil, fmt.Errorf("missing repository claim")
@@ -255,6 +260,20 @@ func validateGitHub(ctx context.Context, raw string) (*User, error) {
}, nil
}
+func validateGitHubAudience(claims jwt.MapClaims, primary string, legacy []string) error {
+ audiences, err := claims.GetAudience()
+ if err != nil || len(audiences) == 0 {
+ return fmt.Errorf("missing or invalid github oidc audience")
+ }
+ accepted := append([]string{primary}, legacy...)
+ for _, audience := range audiences {
+ if slices.Contains(accepted, audience) {
+ return nil
+ }
+ }
+ return fmt.Errorf("github oidc audience is not accepted")
+}
+
func parseUnverifiedClaims(raw string) (jwt.MapClaims, error) {
parser := jwt.NewParser()
claims := jwt.MapClaims{}
diff --git a/libs/fleet/backend/auth/github_oidc_test.go b/libs/fleet/backend/auth/github_oidc_test.go
index 573821b54b..fe7b59fb7e 100644
--- a/libs/fleet/backend/auth/github_oidc_test.go
+++ b/libs/fleet/backend/auth/github_oidc_test.go
@@ -8,6 +8,7 @@ import (
"encoding/json"
"net/http"
"net/http/httptest"
+ "strings"
"testing"
"time"
@@ -18,7 +19,7 @@ import (
const (
testGitHubIssuer = "https://token.actions.githubusercontent.com"
- testGitHubAudience = "cyclops-cs"
+ testGitHubAudience = "fleets"
testGitHubKeyID = "github-test-key"
)
@@ -77,6 +78,73 @@ func TestValidate_GitHubOIDCResolvesOwnerAndNamespaces(t *testing.T) {
}
}
+func TestValidate_GitHubOIDCAcceptsMigratedAudiences(t *testing.T) {
+ signingKey, jwksURL := newGitHubJWKS(t)
+ t.Cleanup(func() {
+ SetGitHubTrustResolver(nil)
+ })
+ if err := Init(&config.AuthConfiguration{
+ Issuer: "https://issuer.example.test/realms/cyclops-cs",
+ JWKSUri: jwksURL,
+ SigningAlgs: []string{"RS256"},
+ SPAClientID: "cyclops-cs-spa",
+ KeyClientPfx: "key-",
+ UserKeyClientPfx: "ukey-",
+ GitHubOIDCIssuer: testGitHubIssuer,
+ GitHubOIDCJWKSUri: jwksURL,
+ GitHubOIDCAudience: testGitHubAudience,
+ GitHubOIDCLegacyAudiences: []string{"cyclops-cs"},
+ GitHubOIDCEnabled: true,
+ GitHubOIDCAlgs: []string{"RS256"},
+ }); err != nil {
+ t.Fatalf("Init err = %v", err)
+ }
+ SetGitHubTrustResolver(githubTrustResolverFunc(func(_ context.Context, repository string) ([]GitHubTrustPolicy, error) {
+ if repository != "trycua/cloud" {
+ t.Fatalf("repository = %q", repository)
+ }
+ return []GitHubTrustPolicy{{
+ ID: "p1",
+ OwnerSub: "user-123",
+ Repository: "trycua/cloud",
+ AllowedNamespaces: []string{"ns-a"},
+ Enabled: true,
+ }}, nil
+ }))
+
+ for _, tt := range []struct {
+ name string
+ audience string
+ wantErr string
+ }{
+ {name: "primary", audience: "fleets"},
+ {name: "legacy", audience: "cyclops-cs"},
+ {name: "rejected", audience: "unrelated-service", wantErr: "audience"},
+ } {
+ t.Run(tt.name, func(t *testing.T) {
+ raw := signGitHubToken(t, signingKey, jwt.MapClaims{
+ "iss": testGitHubIssuer,
+ "aud": tt.audience,
+ "sub": "repo:trycua/cloud:ref:refs/heads/main",
+ "repository": "trycua/cloud",
+ "exp": time.Now().Add(time.Hour).Unix(),
+ "iat": time.Now().Add(-time.Minute).Unix(),
+ })
+
+ _, err := validate(raw)
+ if tt.wantErr == "" {
+ if err != nil {
+ t.Fatalf("validate err = %v", err)
+ }
+ return
+ }
+ if err == nil || !strings.Contains(err.Error(), tt.wantErr) {
+ t.Fatalf("validate err = %v, want error containing %q", err, tt.wantErr)
+ }
+ })
+ }
+}
+
func TestValidate_GitHubOIDCFailsOnCrossOwnerCollision(t *testing.T) {
signingKey, jwksURL := newGitHubJWKS(t)
t.Cleanup(func() {
diff --git a/libs/fleet/backend/config/config.go b/libs/fleet/backend/config/config.go
index 043a65c114..6bed6aa722 100644
--- a/libs/fleet/backend/config/config.go
+++ b/libs/fleet/backend/config/config.go
@@ -13,6 +13,7 @@ package config
import (
"fmt"
+ "slices"
"strings"
"github.com/spf13/pflag"
@@ -38,17 +39,18 @@ type WebServerConfiguration struct {
// AuthConfiguration follows the grt naming so the JWKS / verifier code
// reads like the upstream template.
type AuthConfiguration struct {
- Issuer string // https://auth.cua.ai/realms/cyclops-cs
- JWKSUri string // <Issuer>/protocol/openid-connect/certs
- SigningAlgs []string // RS256, RS512, ES256
- SPAClientID string
- KeyClientPfx string // pool/gateway key client-id prefix ("key-")
- UserKeyClientPfx string // per-user key client-id prefix ("ukey-")
- GitHubOIDCEnabled bool
- GitHubOIDCIssuer string
- GitHubOIDCJWKSUri string
- GitHubOIDCAudience string
- GitHubOIDCAlgs []string
+ Issuer string // https://auth.cua.ai/realms/cyclops-cs
+ JWKSUri string // <Issuer>/protocol/openid-connect/certs
+ SigningAlgs []string // RS256, RS512, ES256
+ SPAClientID string
+ KeyClientPfx string // pool/gateway key client-id prefix ("key-")
+ UserKeyClientPfx string // per-user key client-id prefix ("ukey-")
+ GitHubOIDCEnabled bool
+ GitHubOIDCIssuer string
+ GitHubOIDCJWKSUri string
+ GitHubOIDCAudience string
+ GitHubOIDCLegacyAudiences []string
+ GitHubOIDCAlgs []string
}
type KeycloakConfiguration struct {
@@ -134,7 +136,8 @@ var specs = []flagSpec{
{"kc.user-key-client-prefix", "kc-user-key-client-prefix", "KC_USER_KEY_CLIENT_PFX", "ukey-", "per-user key client-id prefix"},
{"github.oidc-issuer", "github-oidc-issuer", "GITHUB_OIDC_ISSUER", "https://token.actions.githubusercontent.com", "GitHub Actions OIDC issuer"},
{"github.oidc-jwks-uri", "github-oidc-jwks-uri", "GITHUB_OIDC_JWKS_URI", "https://token.actions.githubusercontent.com/.well-known/jwks", "GitHub Actions OIDC JWKS URI"},
- {"github.oidc-audience", "github-oidc-audience", "GITHUB_OIDC_AUDIENCE", "cyclops-cs", "Audience required on inbound GitHub OIDC tokens"},
+ {"github.oidc-audience", "github-oidc-audience", "GITHUB_OIDC_AUDIENCE", "fleets", "Audience required on inbound GitHub OIDC tokens"},
+ {"github.oidc-legacy-audiences", "github-oidc-legacy-audiences", "GITHUB_OIDC_LEGACY_AUDIENCES", "cyclops-cs", "Comma-separated legacy audiences accepted on inbound GitHub OIDC tokens"},
{"kc.admin-client-id", "kc-admin-client-id", "KC_ADMIN_CLIENT_ID", "cyclops-cs-backend", "Keycloak admin client id"},
{"kc.admin-client-secret", "kc-admin-client-secret", "KC_ADMIN_CLIENT_SECRET", "", "Keycloak admin client secret (required)"},
{"kc.workload-realm", "kc-workload-realm", "KC_WORKLOAD_REALM", "workloads", "Keycloak realm AWS/OIDC trusts for pool VM tokens"},
@@ -177,6 +180,18 @@ func RegisterFlags(fs *pflag.FlagSet) {
}
}
+func splitCommaSeparated(value string) []string {
+ values := strings.FieldsFunc(value, func(r rune) bool { return r == ',' })
+ out := make([]string, 0, len(values))
+ for _, value := range values {
+ value = strings.TrimSpace(value)
+ if value != "" && !slices.Contains(out, value) {
+ out = append(out, value)
+ }
+ }
+ return out
+}
+
func LoadConfig() (*Configuration, error) {
base := strings.TrimRight(viper.GetString("kc.base-url"), "/")
realm := viper.GetString("kc.realm")
@@ -201,7 +216,10 @@ func LoadConfig() (*Configuration, error) {
GitHubOIDCIssuer: viper.GetString("github.oidc-issuer"),
GitHubOIDCJWKSUri: viper.GetString("github.oidc-jwks-uri"),
GitHubOIDCAudience: viper.GetString("github.oidc-audience"),
- GitHubOIDCAlgs: []string{"RS256"},
+ GitHubOIDCLegacyAudiences: splitCommaSeparated(
+ viper.GetString("github.oidc-legacy-audiences"),
+ ),
+ GitHubOIDCAlgs: []string{"RS256"},
},
Keycloak: KeycloakConfiguration{
BaseURL: base,
diff --git a/libs/fleet/backend/config/config_test.go b/libs/fleet/backend/config/config_test.go
index 1b9e6572ce..07baef0a38 100644
--- a/libs/fleet/backend/config/config_test.go
+++ b/libs/fleet/backend/config/config_test.go
@@ -1,6 +1,8 @@
package config
import (
+ "os"
+ "slices"
"testing"
"github.com/spf13/pflag"
@@ -106,6 +108,59 @@ func TestLoadConfig_StripeBillingDefaultsAbsent(t *testing.T) {
}
}
+func unsetEnv(t *testing.T, key string) {
+ t.Helper()
+ value, wasSet := os.LookupEnv(key)
+ if err := os.Unsetenv(key); err != nil {
+ t.Fatalf("Unsetenv(%q): %v", key, err)
+ }
+ t.Cleanup(func() {
+ if wasSet {
+ _ = os.Setenv(key, value)
+ return
+ }
+ _ = os.Unsetenv(key)
+ })
+}
+
+func loadGitHubOIDCTestConfig(t *testing.T) *Configuration {
+ t.Helper()
+ viper.Reset()
+ t.Cleanup(viper.Reset)
+ flags := pflag.NewFlagSet("test", pflag.ContinueOnError)
+ RegisterFlags(flags)
+ cfg, err := LoadConfig()
+ if err != nil {
+ t.Fatalf("LoadConfig: %v", err)
+ }
+ return cfg
+}
+
+func TestLoadConfigGitHubOIDCDefaults(t *testing.T) {
+ unsetEnv(t, "GITHUB_OIDC_AUDIENCE")
+ unsetEnv(t, "GITHUB_OIDC_LEGACY_AUDIENCES")
+ t.Setenv("KC_ADMIN_CLIENT_SECRET", "secret")
+ cfg := loadGitHubOIDCTestConfig(t)
+
+ if got := cfg.Auth.GitHubOIDCAudience; got != "fleets" {
+ t.Fatalf("GitHubOIDCAudience = %q, want fleets", got)
+ }
+ if got, want := cfg.Auth.GitHubOIDCLegacyAudiences, []string{"cyclops-cs"}; !slices.Equal(got, want) {
+ t.Fatalf("GitHubOIDCLegacyAudiences = %#v, want %#v", got, want)
+ }
+}
+
+func TestLoadConfigGitHubOIDCLegacyAudiencesEnvironmentOverride(t *testing.T) {
+ unsetEnv(t, "GITHUB_OIDC_AUDIENCE")
+ t.Setenv("KC_ADMIN_CLIENT_SECRET", "secret")
+ t.Setenv("GITHUB_OIDC_LEGACY_AUDIENCES", "cyclops-cs, old-fleets")
+ cfg := loadGitHubOIDCTestConfig(t)
+
+ if got, want := cfg.Auth.GitHubOIDCLegacyAudiences, []string{"cyclops-cs", "old-fleets"}; !slices.Equal(got, want) {
+ t.Fatalf("GitHubOIDCLegacyAudiences = %#v, want %#v", got, want)
+ }
+}
+
func TestLoadConfig_StateDatabaseURLs(t *testing.T) {
viper.Reset()
t.Cleanup(viper.Reset)
diff --git a/libs/fleet/backend/handlers/github_trust_policies_test.go b/libs/fleet/backend/handlers/github_trust_policies_test.go
index 675fd367b0..e529d449c5 100644
--- a/libs/fleet/backend/handlers/github_trust_policies_test.go
+++ b/libs/fleet/backend/handlers/github_trust_policies_test.go
@@ -130,8 +130,8 @@ func TestListGitHubTrustPolicies_Success(t *testing.T) {
if resp.OIDC.Issuer != "https://token.actions.githubusercontent.com" {
t.Fatalf("issuer = %q", resp.OIDC.Issuer)
}
- if resp.OIDC.Audience != "cyclops-cs" {
- t.Fatalf("audience = %q", resp.OIDC.Audience)
+ if resp.OIDC.Audience != "fleets" {
+ t.Fatalf("audience = %q, want fleets", resp.OIDC.Audience)
}
if len(resp.Policies) != 1 || resp.Policies[0].Repository != "trycua/cloud" {
t.Fatalf("unexpected policies payload: %+v", resp.Policies)
@@ -224,7 +224,8 @@ func TestGitHubTrustPolicies_StoreError(t *testing.T) {
func authConfigForHandlers() config.AuthConfiguration {
return config.AuthConfiguration{
- GitHubOIDCIssuer: "https://token.actions.githubusercontent.com",
- GitHubOIDCAudience: "cyclops-cs",
+ GitHubOIDCIssuer: "https://token.actions.githubusercontent.com",
+ GitHubOIDCAudience: "fleets",
+ GitHubOIDCLegacyAudiences: []string{"cyclops-cs"},
}
}
diff --git a/libs/fleet/e2e/fixtures/mock-api.ts b/libs/fleet/e2e/fixtures/mock-api.ts
index ec7baab82d..fc2d8a1c88 100644
--- a/libs/fleet/e2e/fixtures/mock-api.ts
+++ b/libs/fleet/e2e/fixtures/mock-api.ts
@@ -284,7 +284,7 @@ export async function mockGitHubTrustPoliciesApi(
policies,
oidc: {
issuer: "https://token.actions.githubusercontent.com",
- audience: "cyclops-cs",
+ audience: "fleets",
},
}),
})
diff --git a/libs/fleet/e2e/settings.spec.ts b/libs/fleet/e2e/settings.spec.ts
index 4281bd1909..5d609ca279 100644
--- a/libs/fleet/e2e/settings.spec.ts
+++ b/libs/fleet/e2e/settings.spec.ts
@@ -22,6 +22,26 @@ test.describe("Settings GitHub trust policies", () => {
await expect(page.getByText("trycua/cloud")).toBeVisible()
await expect(page.getByText("https://token.actions.githubusercontent.com")).toBeVisible()
await expect(page.getByText("permissions:")).toBeVisible()
+ await expect(page.getByText("fleets", { exact: true })).toBeVisible()
+ await expect(page.getByText("Workflow job snippet", { exact: true })).toBeVisible()
+ const workflowSnippet = page.locator("pre").filter({
+ hasText: "Get GitHub WIF token for Fleets",
+ })
+ await expect(workflowSnippet).toContainText("pip install cua-cli==0.1.13")
+ await expect(workflowSnippet).toContainText('token="$(cua wif-token github)"')
+ await expect(workflowSnippet).toContainText(
+ 'printf \'token=%s\\n\' "$token" >> "$GITHUB_OUTPUT"',
+ )
+ await expect(workflowSnippet).toContainText("curl --fail-with-body -sSL")
+ await expect(workflowSnippet).toContainText(
+ "https://run.cua.ai/api/namespaces",
+ )
+ await expect(workflowSnippet).toContainText("FLEETS_TOKEN")
+ await expect(workflowSnippet).toContainText("Get GitHub WIF token for Fleets")
+ await expect(workflowSnippet).not.toContainText(
+ "ACTIONS_ID_TOKEN_REQUEST_URL",
+ )
+ await expect(workflowSnippet).not.toContainText("CYCLOPS_CS_TOKEN")
})
test("can create, edit, disable, and delete a trust policy", async ({ page }) => {
diff --git a/libs/fleet/src/pages/Settings.tsx b/libs/fleet/src/pages/Settings.tsx
index e5e8f339c0..9d9532d23d 100644
--- a/libs/fleet/src/pages/Settings.tsx
+++ b/libs/fleet/src/pages/Settings.tsx
@@ -39,7 +39,7 @@ export function Settings() {
const [editingId, setEditingId] = useState<string | null>(null)
const [oidc, setOidc] = useState({
issuer: "https://token.actions.githubusercontent.com",
- audience: "cyclops-cs",
+ audience: "fleets",
})
const [loading, setLoading] = useState(true)
const [saving, setSaving] = useState(false)
@@ -168,19 +168,25 @@ export function Settings() {
contents: read
steps:
- - name: Request GitHub OIDC token for cyclops-cs
- id: oidc
+ - uses: actions/setup-python@v5
+ with:
+ python-version: "3.12"
+
+ - name: Install Cua CLI
+ run: pip install cua-cli==0.1.13
+
+ - name: Get GitHub WIF token for Fleets
+ id: fleets-token
run: |
- echo "token=$(curl -sSL \\
- -H \\"Authorization: bearer $ACTIONS_ID_TOKEN_REQUEST_TOKEN\\" \\
- \\"$ACTIONS_ID_TOKEN_REQUEST_URL&audience=${oidc.audience}\\" | jq -r '.value')" >> "$GITHUB_OUTPUT"
+ token="$(cua wif-token github)"
+ printf 'token=%s\\n' "$token" >> "$GITHUB_OUTPUT"
- - name: Call cyclops-cs
+ - name: Call Fleets
env:
- CYCLOPS_CS_TOKEN: \${{ steps.oidc.outputs.token }}
+ FLEETS_TOKEN: \${{ steps.fleets-token.outputs.token }}
run: |
- curl -sSL https://cyclops.example.test/api/namespaces \\
- -H "Authorization: Bearer $CYCLOPS_CS_TOKEN"`
+ curl --fail-with-body -sSL https://run.cua.ai/api/namespaces \\
+ -H "Authorization: Bearer $FLEETS_TOKEN"`
return (
<SpaceBetween size="l">
@@ -227,7 +233,7 @@ steps:
header={
<Header
variant="h2"
- description="Trust GitHub repositories to call cyclops-cs directly with GitHub Actions OIDC tokens."
+ description="Trust GitHub repositories to call Fleets directly with GitHub Actions OIDC tokens."
>
GitHub Actions OIDC
</Header>
@@ -383,7 +389,7 @@ steps:
copyErrorText="Failed to copy audience"
/>
</FormField>
- <FormField label="Example workflow">
+ <FormField label="Workflow job snippet">
<Box variant="code" padding="m">
<pre style={{ margin: 0, whiteSpace: "pre-wrap" }}>
{workflowSnippet}