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
|
// 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 cli
import (
"fmt"
"os"
"sort"
"strings"
"github.com/notaryproject/notation-plugin-framework-go/internal/slices"
"github.com/notaryproject/notation-plugin-framework-go/plugin"
)
func getValidArgsString(md *plugin.GetMetadataResponse) string {
return fmt.Sprintf(`<%s>`, strings.Join(getValidArgs(md), "|"))
}
// getValidArgs returns list of valid arguments depending upon the plugin capabilities
func getValidArgs(md *plugin.GetMetadataResponse) []string {
args := []string{
string(plugin.CommandGetMetadata), string(plugin.Version),
}
if slices.Contains(md.Capabilities, plugin.CapabilitySignatureGenerator) {
args = append(args, string(plugin.CommandGenerateSignature), string(plugin.CommandDescribeKey))
}
if slices.Contains(md.Capabilities, plugin.CapabilityEnvelopeGenerator) {
args = append(args, string(plugin.CommandGenerateEnvelope))
}
if slices.Contains(md.Capabilities, plugin.CapabilityTrustedIdentityVerifier) || slices.Contains(md.Capabilities, plugin.CapabilityRevocationCheckVerifier) {
args = append(args, string(plugin.CommandVerifySignature))
}
sort.Strings(args)
return args
}
// deliverError print to standard error and then return nonzero exit code
func deliverError(message string) {
_, _ = fmt.Fprint(os.Stderr, message)
os.Exit(1)
}
// deferStdout is used to make sure that nothing get emitted to stdout and stderr until intentionally rescued.
// This is required to make sure that the plugin or its dependency doesn't interfere with notation <-> plugin communication
func deferStdout() func() {
// Ignoring error because we don't want plugin to fail if `os.DevNull` is misconfigured.
null, _ := os.Open(os.DevNull)
sout := os.Stdout
serr := os.Stderr
os.Stdout = null
os.Stderr = null
return func() {
err := null.Close()
if err != nil {
return
}
os.Stdout = sout
os.Stderr = serr
}
}
// discardLogger implements Logger but logs nothing. It is used when user
// disenabled logging option in notation, i.e. loggerKey is not in the context.
type discardLogger struct{}
func (dl *discardLogger) Debug(_ ...interface{}) {
}
func (dl *discardLogger) Debugf(_ string, _ ...interface{}) {
}
func (dl *discardLogger) Debugln(_ ...interface{}) {
}
func (dl *discardLogger) Info(_ ...interface{}) {
}
func (dl *discardLogger) Infof(_ string, _ ...interface{}) {
}
func (dl *discardLogger) Infoln(_ ...interface{}) {
}
func (dl *discardLogger) Warn(_ ...interface{}) {
}
func (dl *discardLogger) Warnf(_ string, _ ...interface{}) {
}
func (dl *discardLogger) Warnln(_ ...interface{}) {
}
func (dl *discardLogger) Error(_ ...interface{}) {
}
func (dl *discardLogger) Errorf(_ string, _ ...interface{}) {
}
func (dl *discardLogger) Errorln(_ ...interface{}) {
}
|