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
|
// Copyright The Notary Project 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 envelope
import (
"encoding/json"
"errors"
"fmt"
"github.com/notaryproject/notation-core-go/signature"
"github.com/notaryproject/notation-core-go/signature/cose"
"github.com/notaryproject/notation-core-go/signature/jws"
ocispec "github.com/opencontainers/image-spec/specs-go/v1"
)
const (
// Supported envelope format.
COSE = "cose"
JWS = "jws"
// MediaTypePayloadV1 is the supported content type for signature's payload.
MediaTypePayloadV1 = "application/vnd.cncf.notary.payload.v1+json"
)
// Payload describes the content that gets signed.
type Payload struct {
TargetArtifact ocispec.Descriptor `json:"targetArtifact"`
}
// GetEnvelopeMediaType converts the envelope type to mediaType name.
func GetEnvelopeMediaType(sigFormat string) (string, error) {
switch sigFormat {
case JWS:
return jws.MediaTypeEnvelope, nil
case COSE:
return cose.MediaTypeEnvelope, nil
}
return "", fmt.Errorf("signature format %q not supported\nSupported signature envelope formats are \"jws\" and \"cose\"", sigFormat)
}
// ValidatePayloadContentType validates signature payload's content type.
func ValidatePayloadContentType(payload *signature.Payload) error {
switch payload.ContentType {
case MediaTypePayloadV1:
return nil
default:
return fmt.Errorf("payload content type %q not supported", payload.ContentType)
}
}
// DescriptorFromPayload parses a signature payload and returns the descriptor
// that was signed. Note: the descriptor was signed but may not be trusted
func DescriptorFromSignaturePayload(payload *signature.Payload) (*ocispec.Descriptor, error) {
if payload == nil {
return nil, errors.New("empty payload")
}
err := ValidatePayloadContentType(payload)
if err != nil {
return nil, err
}
var parsedPayload Payload
err = json.Unmarshal(payload.Content, &parsedPayload)
if err != nil {
return nil, errors.New("failed to unmarshall the payload content to Payload")
}
return &parsedPayload.TargetArtifact, nil
}
|