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 plugin defines the protocol layer for communication between notation
// and notation external plugin.
package plugin
// BinaryPrefix is the prefix required on all plugin binary names.
const BinaryPrefix = "notation-"
// ContractVersion is the <major>.<minor> version of the plugin contract.
const ContractVersion = "1.0"
// Capability is a feature available in the plugin contract.
type Capability string
const (
// CapabilitySignatureGenerator is the name of the capability
// for a plugin to support generating raw signatures.
CapabilitySignatureGenerator Capability = "SIGNATURE_GENERATOR.RAW"
// CapabilityEnvelopeGenerator is the name of the capability
// for a plugin to support generating envelope signatures.
CapabilityEnvelopeGenerator Capability = "SIGNATURE_GENERATOR.ENVELOPE"
// CapabilityTrustedIdentityVerifier is the name of the
// capability for a plugin to support verifying trusted identities.
CapabilityTrustedIdentityVerifier Capability = "SIGNATURE_VERIFIER.TRUSTED_IDENTITY"
// CapabilityRevocationCheckVerifier is the name of the
// capability for a plugin to support verifying revocation checks.
CapabilityRevocationCheckVerifier Capability = "SIGNATURE_VERIFIER.REVOCATION_CHECK"
)
// Command is a CLI command available in the plugin contract.
type Command string
// Request defines a plugin request, which is always associated to a command.
type Request interface {
Command() Command
Validate() error
}
const (
// CommandGetMetadata is the name of the plugin command
// which must be supported by every plugin and returns the
// plugin metadata.
CommandGetMetadata Command = "get-plugin-metadata"
// CommandDescribeKey is the name of the plugin command
// which must be supported by every plugin that has the
// SIGNATURE_GENERATOR.RAW capability.
CommandDescribeKey Command = "describe-key"
// CommandGenerateSignature is the name of the plugin command
// which must be supported by every plugin that has the
// SIGNATURE_GENERATOR.RAW capability.
CommandGenerateSignature Command = "generate-signature"
// CommandGenerateEnvelope is the name of the plugin command
// which must be supported by every plugin that has the
// SIGNATURE_GENERATOR.ENVELOPE capability.
CommandGenerateEnvelope Command = "generate-envelope"
// CommandVerifySignature is the name of the plugin command
// which must be supported by every plugin that has
// any SIGNATURE_VERIFIER.* capability
CommandVerifySignature Command = "verify-signature"
Version Command = "version"
)
|
