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
|
//
// 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 git
import (
"bytes"
"context"
"crypto/x509"
"errors"
"fmt"
"github.com/go-git/go-git/v5/plumbing"
"github.com/go-git/go-git/v5/plumbing/object"
"github.com/sigstore/gitsign/pkg/rekor"
"github.com/sigstore/rekor/pkg/generated/models"
)
// VerificationSummary holds artifacts of the gitsign verification of a Git commit or tag.
type VerificationSummary struct {
// Certificate used to sign the commit.
Cert *x509.Certificate
// Rekor log entry of the commit.
LogEntry *models.LogEntryAnon
// List of claims about what succeeded / failed during validation.
// This can be used to get details on what succeeded / failed during
// validation. This is not an exhaustive list - claims may be missing
// if validation ended early.
Claims []Claim
}
// Claim is a key value pair representing the status of a given ClaimCondition.
type Claim struct {
Key ClaimCondition
Value bool
}
type ClaimCondition string
const (
ClaimValidatedSignature ClaimCondition = "Validated Git signature"
ClaimValidatedRekorEntry ClaimCondition = "Validated Rekor entry"
ClaimValidatedCerificate ClaimCondition = "Validated Certificate claims"
)
func NewClaim(c ClaimCondition, ok bool) Claim {
return Claim{
Key: c,
Value: ok,
}
}
// Verify takes a context, rekor verifier client, Git object data (everything but the signature), and a Git signature.
// A VerificationSummary is returned with the signing certificate & Rekor transparency log index of the Git object, if found,
// and whether each is valid for the given Git data.
func Verify(ctx context.Context, git Verifier, rekor rekor.Verifier, data, sig []byte, detached bool) (*VerificationSummary, error) {
claims := []Claim{}
cert, err := git.Verify(ctx, data, sig, detached)
if err != nil {
return nil, err
}
claims = append(claims, NewClaim(ClaimValidatedSignature, true))
if tlog, err := rekor.VerifyInclusion(ctx, sig, cert); err == nil {
return &VerificationSummary{
Cert: cert,
LogEntry: tlog,
Claims: claims,
}, nil
}
// Legacy commit based lookup.
commit, err := ObjectHash(data, sig)
if err != nil {
return nil, err
}
tlog, err := rekor.Verify(ctx, commit, cert)
if err != nil {
return nil, fmt.Errorf("failed to validate rekor entry: %w", err)
}
claims = append(claims, NewClaim(ClaimValidatedRekorEntry, true))
return &VerificationSummary{
Cert: cert,
LogEntry: tlog,
Claims: claims,
}, nil
}
// VerifySignature verifies for a given Git data + signature pair.
//
// Data should be the Git data that was signed (i.e. everything in the commit
// besides the signature). Note: passing in the commit object itself will not
// work.
//
// Signatures should be CMS/PKCS7 formatted.
//
// Deprecated: Use CertVerifier.Verify instead.
func VerifySignature(data, sig []byte, detached bool, rootCerts, intermediates *x509.CertPool) (*x509.Certificate, error) {
v, err := NewCertVerifier(WithRootPool(rootCerts), WithIntermediatePool(intermediates))
if err != nil {
return nil, err
}
return v.Verify(context.Background(), data, sig, detached)
}
type encoder interface {
Encode(o plumbing.EncodedObject) error
}
// ObjectHash is a string representation of an encoded Git object
func ObjectHash(data, sig []byte) (string, error) {
// Precompute commit hash to store in tlog
obj := &plumbing.MemoryObject{}
if _, err := obj.Write(data); err != nil {
return "", err
}
var (
encoder encoder
err error
)
// We're making big assumptions here about the ordering of fields
// in Git objects. Unfortunately go-git does loose parsing of objects,
// so it will happily decode objects that don't match the unmarshal type.
// We should see if there's a better way to detect object types.
switch {
case bytes.HasPrefix(data, []byte("tree ")):
encoder, err = commit(obj, sig)
case bytes.HasPrefix(data, []byte("object ")):
encoder, err = tag(obj, sig)
default:
return "", errors.New("could not determine Git object type")
}
if err != nil {
return "", err
}
// go-git will compute a hash on decode and preserve even if we alter the
// object data. To work around this, re-encode the object into a new object
// to force a new hash to be computed.
out := &plumbing.MemoryObject{}
err = encoder.Encode(out)
return out.Hash().String(), err
}
func commit(obj *plumbing.MemoryObject, sig []byte) (*object.Commit, error) {
obj.SetType(plumbing.CommitObject)
base := object.Commit{}
if err := base.Decode(obj); err != nil {
return nil, err
}
return &object.Commit{
Author: base.Author,
Committer: base.Committer,
PGPSignature: string(sig),
Message: base.Message,
TreeHash: base.TreeHash,
ParentHashes: base.ParentHashes,
}, nil
}
func tag(obj *plumbing.MemoryObject, sig []byte) (*object.Tag, error) {
obj.SetType(plumbing.TagObject)
base := object.Tag{}
if err := base.Decode(obj); err != nil {
return nil, err
}
return &object.Tag{
Tagger: base.Tagger,
Name: base.Name,
TargetType: base.TargetType,
Target: base.Target,
Message: base.Message,
PGPSignature: string(sig),
}, nil
}
|