options.go

//
// Copyright 2021 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 static

import (
	"encoding/json"

	"github.com/google/go-containerregistry/pkg/v1/types"
	"github.com/sigstore/cosign/v2/pkg/cosign/bundle"
	ctypes "github.com/sigstore/cosign/v2/pkg/types"
)

// StaticOption is a functional option for customizing static signatures.
type StaticOption func(*options)

type options struct {
	LayerMediaType          types.MediaType
	ConfigMediaType         types.MediaType
	Bundle                  *bundle.RekorBundle
	RFC3161Timestamp        *bundle.RFC3161Timestamp
	Cert                    []byte
	Chain                   []byte
	Annotations             map[string]string
	RecordCreationTimestamp bool
}

func makeOptions(staticOpts ...StaticOption) (*options, error) {
	o := &options{
		LayerMediaType:  ctypes.SimpleSigningMediaType,
		ConfigMediaType: types.OCIConfigJSON,
		Annotations:     make(map[string]string),
	}

	for _, opt := range staticOpts {
		opt(o)
	}

	if o.Cert != nil {
		o.Annotations[CertificateAnnotationKey] = string(o.Cert)
		o.Annotations[ChainAnnotationKey] = string(o.Chain)
	}

	if o.Bundle != nil {
		b, err := json.Marshal(o.Bundle)
		if err != nil {
			return nil, err
		}
		o.Annotations[BundleAnnotationKey] = string(b)
	}

	if o.RFC3161Timestamp != nil {
		b, err := json.Marshal(o.RFC3161Timestamp)
		if err != nil {
			return nil, err
		}
		o.Annotations[RFC3161TimestampAnnotationKey] = string(b)
	}
	return o, nil
}

// WithLayerMediaType sets the media type of the signature.
func WithLayerMediaType(mt types.MediaType) StaticOption {
	return func(o *options) {
		o.LayerMediaType = mt
	}
}

// WithConfigMediaType sets the media type of the signature.
func WithConfigMediaType(mt types.MediaType) StaticOption {
	return func(o *options) {
		o.ConfigMediaType = mt
	}
}

// WithAnnotations sets the annotations that will be associated.
func WithAnnotations(ann map[string]string) StaticOption {
	return func(o *options) {
		o.Annotations = ann
	}
}

// WithBundle sets the bundle to attach to the signature
func WithBundle(b *bundle.RekorBundle) StaticOption {
	return func(o *options) {
		o.Bundle = b
	}
}

// WithRFC3161Timestamp sets the time-stamping bundle to attach to the signature
func WithRFC3161Timestamp(b *bundle.RFC3161Timestamp) StaticOption {
	return func(o *options) {
		o.RFC3161Timestamp = b
	}
}

// WithCertChain sets the certificate chain for this signature.
func WithCertChain(cert, chain []byte) StaticOption {
	return func(o *options) {
		o.Cert = cert
		o.Chain = chain
	}
}

// WithRecordCreationTimestamp sets the feature flag to honor the creation timestamp to time of running
func WithRecordCreationTimestamp(rct bool) StaticOption {
	return func(o *options) {
		o.RecordCreationTimestamp = rct
	}
}