-
Notifications
You must be signed in to change notification settings - Fork 127
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
implement Issuer interface for buildkite (#1037)
Signed-off-by: Priya Wadhwa <priya@chainguard.dev>
- Loading branch information
1 parent
6f4b60c
commit ab5a564
Showing
2 changed files
with
113 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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,42 @@ | ||
// 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 buildkite | ||
|
||
import ( | ||
"context" | ||
|
||
"github.com/sigstore/fulcio/pkg/identity" | ||
) | ||
|
||
type buildkiteIssuer struct { | ||
issuerURL string | ||
} | ||
|
||
func Issuer(issuerURL string) identity.Issuer { | ||
return &buildkiteIssuer{issuerURL: issuerURL} | ||
} | ||
|
||
func (e *buildkiteIssuer) Authenticate(ctx context.Context, token string) (identity.Principal, error) { | ||
idtoken, err := identity.Authorize(ctx, token) | ||
if err != nil { | ||
return nil, err | ||
} | ||
return JobPrincipalFromIDToken(ctx, idtoken) | ||
} | ||
|
||
// Match checks if this issuer can authenticate tokens from a given issuer URL | ||
func (e *buildkiteIssuer) Match(ctx context.Context, url string) bool { | ||
return url == e.issuerURL | ||
} |
This file contains 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,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 buildkite | ||
|
||
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: "organization:acme-inc:pipeline:bash-example:ref:refs/heads/main:commit:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa:step:build", | ||
} | ||
claims, err := json.Marshal(map[string]interface{}{ | ||
"aud": "sigstore", | ||
"exp": 0, | ||
"iss": "https://agent.buildkite.com", | ||
"organization_slug": "acme-inc", | ||
"pipeline_slug": "bash-example", | ||
"sub": "organization:acme-inc:pipeline:bash-example:ref:refs/heads/main:commit:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa:step:build", | ||
}) | ||
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) != "organization:acme-inc:pipeline:bash-example:ref:refs/heads/main:commit:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa:step:build" { | ||
t.Fatalf("got unexpected name %s", principal.Name(ctx)) | ||
} | ||
}) | ||
} |