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
|
//
// Copyright 2021 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 kms implements the interface to access various ksm services
package kms
import (
"context"
"crypto"
"errors"
"fmt"
"os/exec"
"strings"
"sync"
"github.com/sigstore/sigstore/pkg/signature"
"github.com/sigstore/sigstore/pkg/signature/kms/cliplugin"
)
// ProviderNotFoundError indicates that no matching KMS provider was found
type ProviderNotFoundError struct {
ref string
}
func (e *ProviderNotFoundError) Error() string {
return fmt.Sprintf("no kms provider found for key reference: %s", e.ref)
}
// ProviderInit is a function that initializes provider-specific SignerVerifier.
//
// It takes a provider-specific resource ID and hash function, and returns a
// SignerVerifier using that resource, or any error that was encountered.
type ProviderInit func(context.Context, string, crypto.Hash, ...signature.RPCOption) (SignerVerifier, error)
// AddProvider adds the provider implementation into the local cache
func AddProvider(keyResourceID string, init ProviderInit) {
providersMapMu.Lock()
defer providersMapMu.Unlock()
providersMap[keyResourceID] = init
}
var (
providersMapMu sync.RWMutex
providersMap = map[string]ProviderInit{}
)
// Get returns a KMS SignerVerifier for the given resource string and hash function.
// If no matching built-in provider is found, it will try to use the plugin system as a provider.
// It returns a ProviderNotFoundError in these situations:
// - keyResourceID doesn't match any of our hard-coded providers' schemas,
// - the plugin name and key ref cannot be parsed from the input keyResourceID,
// - the plugin program, can't be found.
// It also returns an error if initializing the SignerVerifier fails.
func Get(ctx context.Context, keyResourceID string, hashFunc crypto.Hash, opts ...signature.RPCOption) (SignerVerifier, error) {
providersMapMu.RLock()
defer providersMapMu.RUnlock()
for ref, pi := range providersMap {
if strings.HasPrefix(keyResourceID, ref) {
sv, err := pi(ctx, keyResourceID, hashFunc, opts...)
if err != nil {
return nil, err
}
return sv, nil
}
}
sv, err := cliplugin.LoadSignerVerifier(ctx, keyResourceID, hashFunc, opts...)
if errors.Is(err, exec.ErrNotFound) || errors.Is(err, cliplugin.ErrorInputKeyResourceID) {
return nil, fmt.Errorf("%w: %w", &ProviderNotFoundError{ref: keyResourceID}, err)
}
return sv, err
}
// SupportedProviders returns list of initialized providers
func SupportedProviders() []string {
keys := make([]string, 0, len(providersMap))
providersMapMu.RLock()
defer providersMapMu.RUnlock()
for key := range providersMap {
keys = append(keys, key)
}
return keys
}
// SignerVerifier creates and verifies digital signatures over a message using a KMS service
type SignerVerifier interface {
signature.SignerVerifier
CreateKey(ctx context.Context, algorithm string) (crypto.PublicKey, error)
CryptoSigner(ctx context.Context, errFunc func(error)) (crypto.Signer, crypto.SignerOpts, error)
SupportedAlgorithms() []string
DefaultAlgorithm() string
}
|
