1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
|
// 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 github
import (
"context"
"crypto/x509"
"errors"
"net/url"
"github.com/coreos/go-oidc/v3/oidc"
"github.com/sigstore/fulcio/pkg/certificate"
"github.com/sigstore/fulcio/pkg/identity"
)
type workflowPrincipal struct {
// Subject matches the 'sub' claim from the OIDC ID token this is what is
// signed as proof of possession for Github workflow identities
subject string
// OIDC Issuer URL. Matches 'iss' claim from ID token. The real issuer URL is
// https://token.actions.githubusercontent.com/.well-known/openid-configution
issuer string
// URL of issuer
url string
// Commit SHA being built
sha string
// Event that triggered this workflow run. E.g "push", "tag"
eventName string
// Name of repository being built
repository string
// Deprecated
// Name of workflow that is running (mutable)
workflow string
// Git ref being built
ref string
// Specific build instructions (i.e. reusable workflow)
jobWorkflowRef string
// Commit SHA to specific build instructions
jobWorkflowSha string
// Whether the build took place in cloud or self-hosted infrastructure
runnerEnvironment string
// ID to the source repo
repositoryID string
// Owner of the source repo (mutable)
repositoryOwner string
// ID of the source repo
repositoryOwnerID string
// Visibility of the source repo
repositoryVisibility string
// Ref of top-level workflow that is running
workflowRef string
// Commit SHA of top-level workflow that is running
workflowSha string
// ID of workflow run
runID string
// Attempt number of workflow run
runAttempt string
}
func WorkflowPrincipalFromIDToken(_ context.Context, token *oidc.IDToken) (identity.Principal, error) {
var claims struct {
JobWorkflowRef string `json:"job_workflow_ref"`
Sha string `json:"sha"`
EventName string `json:"event_name"`
Repository string `json:"repository"`
Workflow string `json:"workflow"`
Ref string `json:"ref"`
JobWorkflowSha string `json:"job_workflow_sha"`
RunnerEnvironment string `json:"runner_environment"`
RepositoryID string `json:"repository_id"`
RepositoryOwner string `json:"repository_owner"`
RepositoryOwnerID string `json:"repository_owner_id"`
RepositoryVisibility string `json:"repository_visibility"`
WorkflowRef string `json:"workflow_ref"`
WorkflowSha string `json:"workflow_sha"`
RunID string `json:"run_id"`
RunAttempt string `json:"run_attempt"`
}
if err := token.Claims(&claims); err != nil {
return nil, err
}
if claims.JobWorkflowRef == "" {
return nil, errors.New("missing job_workflow_ref claim in ID token")
}
if claims.Sha == "" {
return nil, errors.New("missing sha claim in ID token")
}
if claims.EventName == "" {
return nil, errors.New("missing event_name claim in ID token")
}
if claims.Repository == "" {
return nil, errors.New("missing repository claim in ID token")
}
if claims.Workflow == "" {
return nil, errors.New("missing workflow claim in ID token")
}
if claims.Ref == "" {
return nil, errors.New("missing ref claim in ID token")
}
if claims.JobWorkflowSha == "" {
return nil, errors.New("missing job_workflow_sha claim in ID token")
}
if claims.RunnerEnvironment == "" {
return nil, errors.New("missing runner_environment claim in ID token")
}
if claims.RepositoryID == "" {
return nil, errors.New("missing repository_id claim in ID token")
}
if claims.RepositoryOwner == "" {
return nil, errors.New("missing repository_owner claim in ID token")
}
if claims.RepositoryOwnerID == "" {
return nil, errors.New("missing repository_owner_id claim in ID token")
}
if claims.RepositoryVisibility == "" {
return nil, errors.New("missing repository_visibility claim in ID token")
}
if claims.WorkflowRef == "" {
return nil, errors.New("missing workflow_ref claim in ID token")
}
if claims.WorkflowSha == "" {
return nil, errors.New("missing workflow_sha claim in ID token")
}
if claims.RunID == "" {
return nil, errors.New("missing run_id claim in ID token")
}
if claims.RunAttempt == "" {
return nil, errors.New("missing run_attempt claim in ID token")
}
return &workflowPrincipal{
subject: token.Subject,
issuer: token.Issuer,
url: `https://github.com/`,
sha: claims.Sha,
eventName: claims.EventName,
repository: claims.Repository,
workflow: claims.Workflow,
ref: claims.Ref,
jobWorkflowRef: claims.JobWorkflowRef,
jobWorkflowSha: claims.JobWorkflowSha,
runnerEnvironment: claims.RunnerEnvironment,
repositoryID: claims.RepositoryID,
repositoryOwner: claims.RepositoryOwner,
repositoryOwnerID: claims.RepositoryOwnerID,
repositoryVisibility: claims.RepositoryVisibility,
workflowRef: claims.WorkflowRef,
workflowSha: claims.WorkflowSha,
runID: claims.RunID,
runAttempt: claims.RunAttempt,
}, nil
}
func (w workflowPrincipal) Name(_ context.Context) string {
return w.subject
}
func (w workflowPrincipal) Embed(_ context.Context, cert *x509.Certificate) error {
baseURL, err := url.Parse(w.url)
if err != nil {
return err
}
// Set workflow ref URL to SubjectAlternativeName on certificate
cert.URIs = []*url.URL{baseURL.JoinPath(w.jobWorkflowRef)}
// Embed additional information into custom extensions
cert.ExtraExtensions, err = certificate.Extensions{
Issuer: w.issuer,
// BEGIN: Deprecated
GithubWorkflowTrigger: w.eventName,
GithubWorkflowSHA: w.sha,
GithubWorkflowName: w.workflow,
GithubWorkflowRepository: w.repository,
GithubWorkflowRef: w.ref,
// END: Deprecated
BuildSignerURI: baseURL.JoinPath(w.jobWorkflowRef).String(),
BuildSignerDigest: w.jobWorkflowSha,
RunnerEnvironment: w.runnerEnvironment,
SourceRepositoryURI: baseURL.JoinPath(w.repository).String(),
SourceRepositoryDigest: w.sha,
SourceRepositoryRef: w.ref,
SourceRepositoryIdentifier: w.repositoryID,
SourceRepositoryOwnerURI: baseURL.JoinPath(w.repositoryOwner).String(),
SourceRepositoryOwnerIdentifier: w.repositoryOwnerID,
BuildConfigURI: baseURL.JoinPath(w.workflowRef).String(),
BuildConfigDigest: w.workflowSha,
BuildTrigger: w.eventName,
RunInvocationURI: baseURL.JoinPath(w.repository, "actions/runs", w.runID, "attempts", w.runAttempt).String(),
SourceRepositoryVisibilityAtSigning: w.repositoryVisibility,
}.Render()
if err != nil {
return err
}
return nil
}
|