Skip to content
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

fix(workaround): allow old norm algos to be hashed with old digest ctxts #1264

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/config/golangci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -194,5 +194,5 @@ issues:
- path: "cmds/.*|api/.*"
linters:
- staticcheck
text: "SA1019: legacy.DefaultingOfVersionIntoExtraIdentity is deprecated"
text: "SA1019: legacy.DefaultingOfVersionIntoExtraIdentityForDescriptor is deprecated"

16 changes: 16 additions & 0 deletions api/ocm/compdesc/meta/v1/signature.go
Original file line number Diff line number Diff line change
Expand Up @@ -333,6 +333,22 @@ type ArtefactDigest struct {
Digest DigestSpec `json:"digest"`
}

func (d *ArtefactDigest) GetExtraIdentity() Identity {
return d.ExtraIdentity
}

func (d *ArtefactDigest) GetName() string {
return d.Name
}

func (d *ArtefactDigest) GetVersion() string {
return d.Version
}

func (d *ArtefactDigest) SetExtraIdentity(identity Identity) {
d.ExtraIdentity = identity
}

func (d *ArtefactDigest) Copy() *ArtefactDigest {
r := *d
r.ExtraIdentity = d.ExtraIdentity.Copy()
Expand Down
2 changes: 1 addition & 1 deletion api/ocm/compdesc/normalizations/jsonv1/norm.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ func init() {
type normalization struct{}

func (m normalization) Normalize(cd *compdesc.ComponentDescriptor) ([]byte, error) {
legacy.DefaultingOfVersionIntoExtraIdentity(cd)
legacy.DefaultingOfVersionIntoExtraIdentityForDescriptor(cd)
cv := compdesc.DefaultSchemes[cd.SchemaVersion()]
if cv == nil {
return nil, errors.ErrNotSupported(errkind.KIND_SCHEMAVERSION, cd.SchemaVersion())
Expand Down
2 changes: 1 addition & 1 deletion api/ocm/compdesc/normalizations/jsonv2/norm.go
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ func init() {
type normalization struct{}

func (m normalization) Normalize(cd *compdesc.ComponentDescriptor) ([]byte, error) {
legacy.DefaultingOfVersionIntoExtraIdentity(cd)
legacy.DefaultingOfVersionIntoExtraIdentityForDescriptor(cd)
data, err := signing.Normalize(jcs.Type, cd, CDExcludes)
return data, err
}
Expand Down
22 changes: 15 additions & 7 deletions api/ocm/compdesc/normalizations/legacy/legacy.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import (
"fmt"

"ocm.software/ocm/api/ocm/compdesc"
"ocm.software/ocm/api/ocm/selectors/accessors"
metav1 "ocm.software/ocm/api/ocm/compdesc/meta/v1"
"ocm.software/ocm/api/utils/logging"
)

Expand All @@ -13,7 +13,7 @@ var (
Logger = logging.DynamicLogger(REALM)
)

// DefaultingOfVersionIntoExtraIdentity normalizes the extra identity of the resources.
// DefaultingOfVersionIntoExtraIdentityForDescriptor normalizes the extra identity of the resources.
// It sets the version of the resource, reference or source as extra identity field if the combination of name+extra identity
// is the same for multiple items. However, the last item in the list will not be updated as it is unique wihout this.
//
Expand All @@ -23,15 +23,23 @@ var (
// for backwards compatibility of normalization (for example used for signatures). It was needed because the original
// defaulting was made part of the normalization by accident and is now no longer included by default due to
// https://github.com/open-component-model/ocm/pull/1026
func DefaultingOfVersionIntoExtraIdentity(cd *compdesc.ComponentDescriptor) {
resources := make([]accessors.ElementMeta, len(cd.Resources))
func DefaultingOfVersionIntoExtraIdentityForDescriptor(cd *compdesc.ComponentDescriptor) {
resources := make([]IdentityDefaultable, len(cd.Resources))
for i := range cd.Resources {
resources[i] = &cd.Resources[i]
}
defaultingOfVersionIntoExtraIdentity(resources)

DefaultingOfVersionIntoExtraIdentity(resources)
}

type IdentityDefaultable interface {
GetExtraIdentity() metav1.Identity
SetExtraIdentity(metav1.Identity)
GetName() string
GetVersion() string
}

func defaultingOfVersionIntoExtraIdentity(meta []accessors.ElementMeta) {
func DefaultingOfVersionIntoExtraIdentity(meta []IdentityDefaultable) {
for i := range meta {
for j := range meta {
// don't match with itself and only match with the same name
Expand All @@ -46,7 +54,7 @@ func defaultingOfVersionIntoExtraIdentity(meta []accessors.ElementMeta) {
}

eid.Set(compdesc.SystemIdentityVersion, meta[i].GetVersion())
meta[i].GetMeta().SetExtraIdentity(eid)
meta[i].SetExtraIdentity(eid)

Logger.Warn(fmt.Sprintf("resource identity duplication was normalized for backwards compatibility, "+
"to avoid this either specify a unique extra identity per item or switch to %s", compdesc.JsonNormalisationV3),
Expand Down
23 changes: 22 additions & 1 deletion api/ocm/tools/signing/digestctx.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import (
"ocm.software/ocm/api/ocm"
"ocm.software/ocm/api/ocm/compdesc"
metav1 "ocm.software/ocm/api/ocm/compdesc/meta/v1"
"ocm.software/ocm/api/ocm/compdesc/normalizations/legacy"
"ocm.software/ocm/api/tech/signing"
"ocm.software/ocm/api/tech/signing/signutils"
"ocm.software/ocm/api/utils"
Expand Down Expand Up @@ -127,9 +128,17 @@ func (dc *DigestContext) Propagate(d *metav1.DigestSpec) error {
preset := dc.GetPreset(dc.Key)

if preset != nil {
if !digs.Resources.Match(preset.Resources) {
var match bool
switch d.NormalisationAlgorithm {
case compdesc.JsonNormalisationV1, compdesc.JsonNormalisationV2:
match = matchLegacy(digs.Resources, preset.Resources)
default:
match = digs.Resources.Match(preset.Resources)
}
if !match {
return fmt.Errorf("digest set for %s does not match", dc.Key)
}

digs = preset
}
dc.Out[dc.Key] = digs
Expand All @@ -138,9 +147,21 @@ func (dc *DigestContext) Propagate(d *metav1.DigestSpec) error {
dc.Parent.Refs[nv] = d
}
}

return nil
}

func matchLegacy(resources, preset metav1.ArtefactDigests) bool {
preset = preset.DeepCopy()
presetWithDefaults := make([]legacy.IdentityDefaultable, len(preset))
for i := range preset {
presetWithDefaults[i] = &preset[i]
}
legacy.DefaultingOfVersionIntoExtraIdentity(presetWithDefaults)

return resources.Match(preset)
}

func (dc *DigestContext) Use(ctx *DigestContext) error {
for nv, digs := range ctx.Out {
if cur := dc.Out[nv]; cur != nil {
Expand Down
Loading