-
Notifications
You must be signed in to change notification settings - Fork 137
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add Buildkite OIDC to Fulcio #890
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
8b85831
Add Buildkite to federation
sj26 e4268a1
Support Buildkite job principals
sj26 c01a664
Update pkg/identity/buildkite/principal.go
sj26 8066d10
Use Buildkite Pipeline URL as SAN
sj26 200bc2c
This test is about GitHub, not Git
sj26 ab268bc
GitHub subjects look different to URIs
sj26 0029135
Add more Buildkite tests
sj26 23d0247
Update new files to 2023
sj26 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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,18 @@ | ||
# 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. | ||
|
||
url: https://agent.buildkite.com | ||
contact: support@buildkite.com | ||
description: "Buildkite Agent OIDC tokens for job identity" | ||
type: "buildkite-job" |
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
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
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
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,88 @@ | ||
// 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" | ||
"crypto/x509" | ||
"errors" | ||
"fmt" | ||
"net/url" | ||
|
||
"github.com/coreos/go-oidc/v3/oidc" | ||
"github.com/sigstore/fulcio/pkg/certificate" | ||
"github.com/sigstore/fulcio/pkg/identity" | ||
) | ||
|
||
type jobPrincipal struct { | ||
// Subject matches the 'sub' claim from the OIDC ID token this is what is | ||
// signed as proof of possession for Buildkite job identities | ||
subject string | ||
|
||
// OIDC Issuer URL. Matches 'iss' claim from ID token. The real issuer URL is | ||
// https://agent.buildkite.com/.well-known/openid-configuration | ||
issuer string | ||
|
||
// The URL of the pipeline, the container of many builds. This will be | ||
// set as a human-friendly SubjectAlternativeName URI in the certificate. | ||
url string | ||
} | ||
|
||
func JobPrincipalFromIDToken(ctx context.Context, token *oidc.IDToken) (identity.Principal, error) { | ||
var claims struct { | ||
OrganizationSlug string `json:"organization_slug"` | ||
PipelineSlug string `json:"pipeline_slug"` | ||
} | ||
if err := token.Claims(&claims); err != nil { | ||
return nil, err | ||
} | ||
|
||
if claims.OrganizationSlug == "" { | ||
return nil, errors.New("missing organization_slug claim in ID token") | ||
} | ||
|
||
if claims.PipelineSlug == "" { | ||
return nil, errors.New("missing pipeline_slug claim in ID token") | ||
} | ||
|
||
return &jobPrincipal{ | ||
subject: token.Subject, | ||
issuer: token.Issuer, | ||
url: fmt.Sprintf("https://buildkite.com/%s/%s", claims.OrganizationSlug, claims.PipelineSlug), | ||
}, nil | ||
} | ||
|
||
func (p jobPrincipal) Name(ctx context.Context) string { | ||
return p.subject | ||
} | ||
|
||
func (p jobPrincipal) Embed(ctx context.Context, cert *x509.Certificate) error { | ||
// Set SubjectAlternativeName to the pipeline URL on the certificate | ||
parsed, err := url.Parse(p.url) | ||
if err != nil { | ||
return err | ||
} | ||
cert.URIs = []*url.URL{parsed} | ||
|
||
// Embed additional information into custom extensions | ||
cert.ExtraExtensions, err = certificate.Extensions{ | ||
Issuer: p.issuer, | ||
}.Render() | ||
if err != nil { | ||
return err | ||
} | ||
|
||
return nil | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you have an example of a token? Curious to see what claims are available and what examples values look like.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh yeah! Here's an example payload from our test suite: