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
|
//
// Copyright 2024 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 cliplugin implements the plugin functionality.
package cliplugin
import (
"context"
"crypto"
"errors"
"fmt"
"os/exec"
"strings"
"github.com/sigstore/sigstore/pkg/signature"
"github.com/sigstore/sigstore/pkg/signature/kms/cliplugin/common"
"github.com/sigstore/sigstore/pkg/signature/kms/cliplugin/encoding"
"github.com/sigstore/sigstore/pkg/signature/kms/cliplugin/internal/signerverifier"
)
const (
// PluginBinaryPrefix is the prefix for all plugin binaries. e.g., sigstore-kms-my-hsm.
PluginBinaryPrefix = "sigstore-kms-"
)
// ErrorInputKeyResourceID indicates a problem parsing the key resource id.
var ErrorInputKeyResourceID = errors.New("parsing input key resource id")
// LoadSignerVerifier creates a PluginClient with these InitOptions.
// If the plugin executable does not exist, then it returns exec.ErrNotFound.
func LoadSignerVerifier(ctx context.Context, inputKeyResourceID string, hashFunc crypto.Hash, opts ...signature.RPCOption) (signerverifier.SignerVerifier, error) {
if err := ctx.Err(); err != nil {
return nil, err
}
executable, keyResourceID, err := getPluginExecutableAndKeyResourceID(inputKeyResourceID)
if err != nil {
return nil, err
}
if _, err := exec.LookPath(executable); err != nil {
return nil, err
}
initOptions := &common.InitOptions{
ProtocolVersion: common.ProtocolVersion,
KeyResourceID: keyResourceID,
HashFunc: hashFunc,
RPCOptions: encoding.PackRPCOptions(opts),
}
if deadline, ok := ctx.Deadline(); ok {
initOptions.CtxDeadline = &deadline
}
pluginClient := newPluginClient(executable, initOptions, makeCmd)
return pluginClient, nil
}
// getPluginExecutableAndKeyResourceID parses the inputKeyResourceID into the plugin executable and the actual keyResourceID.
func getPluginExecutableAndKeyResourceID(inputKeyResourceID string) (string, string, error) {
parts := strings.SplitN(inputKeyResourceID, "://", 2)
if len(parts) != 2 {
return "", "", fmt.Errorf("%w: expected format: [plugin name]://[key ref], got: %s", ErrorInputKeyResourceID, inputKeyResourceID)
}
pluginName, keyResourceID := parts[0], parts[1]
executable := PluginBinaryPrefix + pluginName
return executable, keyResourceID, nil
}
|
