Skip to content

Commit

Permalink
Implement Issuer interface for spiffe and kubernetes types
Browse files Browse the repository at this point in the history
Signed-off-by: Priya Wadhwa <priya@chainguard.dev>
  • Loading branch information
priyawadhwa committed Mar 2, 2023
1 parent 305fac7 commit 41f72d2
Show file tree
Hide file tree
Showing 4 changed files with 234 additions and 0 deletions.
42 changes: 42 additions & 0 deletions pkg/identity/kubernetes/issuer.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
// Copyright 2022 The Sigstore Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package kubernetes

import (
"context"

"github.com/sigstore/fulcio/pkg/identity"
)

type kubernetesIssuer struct {
issuerURL string
}

func Issuer(issuerURL string) identity.Issuer {
return &kubernetesIssuer{issuerURL: issuerURL}
}

func (e *kubernetesIssuer) Authenticate(ctx context.Context, token string) (identity.Principal, error) {
idtoken, err := identity.Authorize(ctx, token)
if err != nil {
return nil, err
}
return PrincipalFromIDToken(ctx, idtoken)
}

// Match checks if this issuer can authenticate tokens from a given issuer URL
func (e *kubernetesIssuer) Match(ctx context.Context, url string) bool {
return url == e.issuerURL
}
79 changes: 79 additions & 0 deletions pkg/identity/kubernetes/issuer_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
// Copyright 2023 The Sigstore Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package kubernetes

import (
"context"
"encoding/json"
"testing"

"github.com/coreos/go-oidc/v3/oidc"
"github.com/sigstore/fulcio/pkg/identity"
)

func TestIssuer(t *testing.T) {
ctx := context.Background()
url := "test-issuer-url"
issuer := Issuer(url)

// test the Match function
t.Run("match", func(t *testing.T) {
if matches := issuer.Match(ctx, url); !matches {
t.Fatal("expected url to match but it doesn't")
}
if matches := issuer.Match(ctx, "some-other-url"); matches {
t.Fatal("expected match to fail but it didn't")
}
})

t.Run("authenticate", func(t *testing.T) {
token := &oidc.IDToken{
Issuer: "https://iss.example.com",
Subject: "subject",
}
claims, err := json.Marshal(map[string]interface{}{
"aud": []string{"sigstore"},
"iss": "https://iss.example.com",
"kubernetes.io": map[string]interface{}{
"namespace": "foo",
"pod": map[string]string{
"name": "bar",
"uid": "2ff0bae1-6b8a-445b-ae03-1f8d2a08d031",
},
"serviceaccount": map[string]string{
"name": "baz",
"uid": "5cb6264f-e283-4365-9a1f-d5a15090527e",
},
},
"sub": "system:serviceaccount:foo:baz",
})
if err != nil {
t.Fatal(err)
}
withClaims(token, claims)

identity.Authorize = func(_ context.Context, _ string) (*oidc.IDToken, error) {
return token, nil
}
principal, err := issuer.Authenticate(ctx, "token")
if err != nil {
t.Fatal(err)
}

if principal.Name(ctx) != "subject" {
t.Fatalf("got unexpected name %s", principal.Name(ctx))
}
})
}
42 changes: 42 additions & 0 deletions pkg/identity/spiffe/issuer.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
// Copyright 2022 The Sigstore Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package spiffe

import (
"context"

"github.com/sigstore/fulcio/pkg/identity"
)

type spiffeIssuer struct {
issuerURL string
}

func Issuer(issuerURL string) identity.Issuer {
return &spiffeIssuer{issuerURL: issuerURL}
}

func (e *spiffeIssuer) Authenticate(ctx context.Context, token string) (identity.Principal, error) {
idtoken, err := identity.Authorize(ctx, token)
if err != nil {
return nil, err
}
return PrincipalFromIDToken(ctx, idtoken)
}

// Match checks if this issuer can authenticate tokens from a given issuer URL
func (e *spiffeIssuer) Match(ctx context.Context, url string) bool {
return url == e.issuerURL
}
71 changes: 71 additions & 0 deletions pkg/identity/spiffe/issuer_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
// Copyright 2023 The Sigstore Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package spiffe

import (
"context"
"testing"

"github.com/coreos/go-oidc/v3/oidc"
"github.com/sigstore/fulcio/pkg/config"
"github.com/sigstore/fulcio/pkg/identity"
)

func TestIssuer(t *testing.T) {
ctx := context.Background()
url := "test-issuer-url"
issuer := Issuer(url)

// test the Match function
t.Run("match", func(t *testing.T) {
if matches := issuer.Match(ctx, url); !matches {
t.Fatal("expected url to match but it doesn't")
}
if matches := issuer.Match(ctx, "some-other-url"); matches {
t.Fatal("expected match to fail but it didn't")
}
})

t.Run("authenticate", func(t *testing.T) {
token := &oidc.IDToken{
Issuer: "https://issuer.example.com",
Subject: "spiffe://example.com/foo/bar",
}

cfg := &config.FulcioConfig{
OIDCIssuers: map[string]config.OIDCIssuer{
"https://issuer.example.com": {
IssuerURL: "https://issuer.example.com",
ClientID: "sigstore",
Type: "spiffe",
SPIFFETrustDomain: "example.com",
},
},
}
ctx := config.With(context.Background(), cfg)

identity.Authorize = func(_ context.Context, _ string) (*oidc.IDToken, error) {
return token, nil
}
principal, err := issuer.Authenticate(ctx, "token")
if err != nil {
t.Fatal(err)
}

if principal.Name(ctx) != "spiffe://example.com/foo/bar" {
t.Fatalf("got unexpected name %s", principal.Name(ctx))
}
})
}

0 comments on commit 41f72d2

Please sign in to comment.