File: plugin.go

package info (click to toggle)
golang-github-notaryproject-notation-plugin-framework-go 1.0.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 280 kB
  • sloc: makefile: 26; sh: 12
file content (124 lines) | stat: -rw-r--r-- 3,850 bytes parent folder | download | duplicates (2)
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
// 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 mock contains various mock structures required for testing.
package mock

import (
	"context"
	"fmt"

	"github.com/notaryproject/notation-plugin-framework-go/plugin"
)

// Mock plugin used only for testing.
type mockPlugin struct {
	fail         bool
	envGenerator bool
}

func NewPlugin(failPlugin bool) *mockPlugin {
	return &mockPlugin{
		fail:         failPlugin,
		envGenerator: true,
	}
}

func NewSigGeneratorPlugin(failPlugin bool) *mockPlugin {
	return &mockPlugin{
		fail:         failPlugin,
		envGenerator: false,
	}
}

func (p *mockPlugin) DescribeKey(ctx context.Context, req *plugin.DescribeKeyRequest) (*plugin.DescribeKeyResponse, error) {
	if p.fail || p.envGenerator {
		return nil, fmt.Errorf("DescribeKey() expected error")
	}
	return &plugin.DescribeKeyResponse{
		KeyID:   "someKeyId",
		KeySpec: plugin.KeySpecRSA2048,
	}, nil
}

func (p *mockPlugin) GenerateSignature(ctx context.Context, req *plugin.GenerateSignatureRequest) (*plugin.GenerateSignatureResponse, error) {
	if p.fail || p.envGenerator {
		return nil, fmt.Errorf("GenerateSignature() expected error")
	}
	return &plugin.GenerateSignatureResponse{
		KeyID:            "someKeyId",
		Signature:        []byte("abcd"),
		SigningAlgorithm: plugin.SignatureAlgorithmRSASSA_PSS_SHA256,
		CertificateChain: [][]byte{[]byte("abcd"), []byte("wxyz")},
	}, nil
}

func (p *mockPlugin) GenerateEnvelope(ctx context.Context, req *plugin.GenerateEnvelopeRequest) (*plugin.GenerateEnvelopeResponse, error) {
	if p.fail || !p.envGenerator {
		return nil, fmt.Errorf("GenerateEnvelope() expected error")
	}
	return &plugin.GenerateEnvelopeResponse{
		SignatureEnvelope:     []byte(""),
		SignatureEnvelopeType: req.SignatureEnvelopeType,
		Annotations:           map[string]string{"manifestAnntnKey1": "value1"},
	}, nil
}

func (p *mockPlugin) VerifySignature(ctx context.Context, req *plugin.VerifySignatureRequest) (*plugin.VerifySignatureResponse, error) {
	if p.fail {
		return nil, fmt.Errorf("VerifySignature() expected error")
	}
	upAttrs := req.Signature.UnprocessedAttributes
	pAttrs := make([]interface{}, len(upAttrs))
	for i := range upAttrs {
		pAttrs[i] = upAttrs[i]
	}

	return &plugin.VerifySignatureResponse{
		ProcessedAttributes: pAttrs,
		VerificationResults: map[plugin.Capability]*plugin.VerificationResult{
			plugin.CapabilityTrustedIdentityVerifier: {
				Success: true,
				Reason:  "Valid trusted Identity",
			},
			plugin.CapabilityRevocationCheckVerifier: {
				Success: true,
				Reason:  "Not revoked",
			},
		},
	}, nil
}

func (p *mockPlugin) GetMetadata(ctx context.Context, req *plugin.GetMetadataRequest) (*plugin.GetMetadataResponse, error) {
	if p.fail {
		return nil, fmt.Errorf("GetMetadata() expected error")
	}

	cap := []plugin.Capability{
		plugin.CapabilityTrustedIdentityVerifier,
		plugin.CapabilityRevocationCheckVerifier,
	}
	if p.envGenerator {
		cap = append(cap, plugin.CapabilityEnvelopeGenerator)
	} else {
		cap = append(cap, plugin.CapabilitySignatureGenerator)
	}

	return &plugin.GetMetadataResponse{
		Name:         "Example Plugin",
		Description:  "This is an description of example plugin. 🍺",
		URL:          "https://example.com/notation/plugin",
		Version:      "1.0.0",
		Capabilities: cap,
	}, nil
}