Skip to content

Print policy information before verifying attestations #9891

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.

Sign up for GitHub

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

Merged
malancas merged 22 commits into from
Dec 13, 2024
Merged

Print policy information before verifying attestations #9891

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
07e9a4a
add initial policy info method
malancas Nov 7, 2024
c7e4411
print policy information before verifying
malancas Nov 7, 2024
9157759
formatting
malancas Nov 14, 2024
a56ff4a
wording
malancas Nov 14, 2024
6ca5e6f
add newlines for additional policy info
malancas Nov 18, 2024
cfbc1c7
wording
malancas Nov 18, 2024
a89071c
wording
malancas Nov 18, 2024
b787a8b
wording
malancas Nov 18, 2024
a55f9a6
Merge branch 'trunk' into print-policy-info
malancas Nov 18, 2024
08a66f5
wording
malancas Nov 19, 2024
a170c91
experiment with table output
malancas Nov 20, 2024
862786c
Merge branch 'trunk' into print-policy-info
malancas Nov 22, 2024
241bb2e
Update pkg/cmd/attestation/verification/policy.go
malancas Nov 25, 2024
4b83d8e
Update pkg/cmd/attestation/verification/policy.go
malancas Nov 25, 2024
c7d3e6d
Update pkg/cmd/attestation/verification/policy.go
malancas Nov 25, 2024
ab3f368
Merge branch 'trunk' into print-policy-info
malancas Nov 26, 2024
645d750
order policy info so relevant info is printed next to each other
malancas Nov 26, 2024
c9be8ce
Merge branch 'print-policy-info' of github.com:malancas/cli into prin…
malancas Nov 26, 2024
a326f5c
drop table view
malancas Nov 26, 2024
92c623a
var naming
malancas Nov 26, 2024
389d0b3
wording
malancas Nov 26, 2024
dd95e5a
tweak output of build policy info
phillmv Dec 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions pkg/cmd/attestation/verification/policy.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package verification
import (
"encoding/hex"
"fmt"
"strings"

"github.com/cli/cli/v2/pkg/cmd/attestation/artifact"

Expand Down Expand Up @@ -49,3 +50,45 @@ func (c EnforcementCriteria) Valid() error {
}
return nil
}

func (c EnforcementCriteria) BuildPolicyInformation() string {
policyAttr := make([][]string, 0, 6)

policyAttr = appendStr(policyAttr, "- OIDC Issuer must match", c.Certificate.Issuer)
if c.Certificate.RunnerEnvironment == GitHubRunner {
policyAttr = appendStr(policyAttr, "- Action workflow Runner Environment must match ", GitHubRunner)
}

policyAttr = appendStr(policyAttr, "- Source Repository Owner URI must match", c.Certificate.SourceRepositoryOwnerURI)

if c.Certificate.SourceRepositoryURI != "" {
policyAttr = appendStr(policyAttr, "- Source Repository URI must match", c.Certificate.SourceRepositoryURI)
}

policyAttr = appendStr(policyAttr, "- Predicate type must match", c.PredicateType)

if c.SAN != "" {
policyAttr = appendStr(policyAttr, "- Subject Alternative Name must match", c.SAN)
} else if c.SANRegex != "" {
policyAttr = appendStr(policyAttr, "- Subject Alternative Name must match regex", c.SANRegex)
}

maxColLen := 0
for _, attr := range policyAttr {
if len(attr[0]) > maxColLen {
maxColLen = len(attr[0])
}
}

policyInfo := ""
for _, attr := range policyAttr {
dots := strings.Repeat(".", maxColLen-len(attr[0]))
policyInfo += fmt.Sprintf("%s:%s %s\n", attr[0], dots, attr[1])
}

return policyInfo
}

func appendStr(arr [][]string, a, b string) [][]string {
return append(arr, []string{a, b})
}
6 changes: 3 additions & 3 deletions pkg/cmd/attestation/verify/policy.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,9 @@ func expandToGitHubURL(tenant, ownerOrRepo string) string {
}

func newEnforcementCriteria(opts *Options) (verification.EnforcementCriteria, error) {
var c verification.EnforcementCriteria
c := verification.EnforcementCriteria{
PredicateType: opts.PredicateType,
}

// Set SANRegex using either the opts.SignerRepo or opts.SignerWorkflow values
if opts.SignerRepo != "" {
Expand Down Expand Up @@ -80,8 +82,6 @@ func newEnforcementCriteria(opts *Options) (verification.EnforcementCriteria, er
c.Certificate.Issuer = opts.OIDCIssuer
}

c.PredicateType = opts.PredicateType

return c, nil
}

Expand Down
4 changes: 3 additions & 1 deletion pkg/cmd/attestation/verify/verify.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,9 @@ func runVerify(opts *Options) error {
}
attestations = filteredAttestations

opts.Logger.VerbosePrintf("Verifying attestations with predicate type: %s\n", ec.PredicateType)
// print information about the policy that will be enforced against attestations
opts.Logger.Println("\nThe following policy criteria will be enforced:")
opts.Logger.Println(ec.BuildPolicyInformation())

verified, errMsg, err := verifyAttestations(*artifact, attestations, opts.SigstoreVerifier, ec)
if err != nil {
Expand Down