File: token.go

package info (click to toggle)
relic 7.6.1-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 3,108 kB
  • sloc: sh: 230; makefile: 10
file content (266 lines) | stat: -rw-r--r-- 7,400 bytes parent folder | download
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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
package azuretoken

import (
	"context"
	"crypto"
	"crypto/ecdsa"
	"crypto/rsa"
	"crypto/x509"
	"encoding/base64"
	"encoding/json"
	"errors"
	"fmt"
	"io"
	"strings"

	"github.com/Azure/azure-sdk-for-go/services/keyvault/2016-10-01/keyvault"
	"github.com/go-jose/go-jose/v3"

	"github.com/sassoftware/relic/v7/config"
	"github.com/sassoftware/relic/v7/lib/passprompt"
	"github.com/sassoftware/relic/v7/lib/x509tools"
	"github.com/sassoftware/relic/v7/token"
)

const tokenType = "azure"

type kvToken struct {
	config *config.Config
	tconf  *config.TokenConfig
	cli    *keyvault.BaseClient
}

type kvKey struct {
	kconf    *config.KeyConfig
	cli      *keyvault.BaseClient
	pub      crypto.PublicKey
	kbase    string
	kname    string
	kversion string
	id       []byte
	cert     []byte
}

func init() {
	token.Openers[tokenType] = open
}

func open(conf *config.Config, tokenName string, pinProvider passprompt.PasswordGetter) (token.Token, error) {
	tconf, err := conf.GetToken(tokenName)
	if err != nil {
		return nil, err
	}
	auth, err := newAuthorizer(tconf)
	if err != nil {
		return nil, fmt.Errorf("configuring azure auth: %w", err)
	}
	cli := keyvault.New()
	cli.Authorizer = auth
	return &kvToken{
		config: conf,
		tconf:  tconf,
		cli:    &cli,
	}, nil
}

func (t *kvToken) Close() error {
	return nil
}

func (t *kvToken) Ping(ctx context.Context) error {
	// query info for one of the keys in this token
	for _, keyConf := range t.config.Keys {
		if keyConf.Token != t.tconf.Name() || keyConf.Hide {
			continue
		}
		ctx, cancel := context.WithTimeout(ctx, keyConf.GetTimeout())
		defer cancel()
		_, err := t.getKey(ctx, keyConf, true)
		if err != nil {
			return fmt.Errorf("checking key %q: %w", keyConf.Name(), err)
		}
		break
	}
	return nil
}

func (t *kvToken) Config() *config.TokenConfig {
	return t.tconf
}

func (t *kvToken) GetKey(ctx context.Context, keyName string) (token.Key, error) {
	keyConf, err := t.config.GetKey(keyName)
	if err != nil {
		return nil, err
	}
	return t.getKey(ctx, keyConf, false)
}

func (t *kvToken) getKey(ctx context.Context, keyConf *config.KeyConfig, pingOnly bool) (token.Key, error) {
	words, baseURL, err := parseKeyURL(keyConf.ID)
	if err != nil {
		return nil, fmt.Errorf("key %q: %w", keyConf.Name(), err)
	}
	wantKeyID := token.KeyID(ctx)
	var cert *certRef
	switch {
	case len(wantKeyID) != 0:
		// reusing a key the client saw before
		cert = refFromKeyID(wantKeyID)
		if cert == nil {
			return nil, errors.New("invalid keyID")
		}
		cert = &certRef{KeyName: words[0], KeyVersion: words[1]}
	case len(words) == 4 && words[1] == "keys":
		// directly to a key version, no cert provided
		cert = &certRef{KeyName: words[2], KeyVersion: words[3]}
	case len(words) == 4 && words[1] == "certificates":
		// link to a cert version, get the key version and cert contents from it
		cert, err = t.loadCertificateVersion(ctx, baseURL, words[2], words[3])
		if err != nil {
			return nil, fmt.Errorf("key %q: fetching certificate: %w", keyConf.Name(), err)
		} else if pingOnly {
			return nil, nil
		}
	case len(words) == 3 && words[1] == "certificates":
		// link to a cert, pick the latest version
		cert, err = t.loadCertificateLatest(ctx, baseURL, words[2])
		if err != nil {
			return nil, fmt.Errorf("key %q: fetching certificate: %w", keyConf.Name(), err)
		} else if pingOnly {
			return nil, nil
		}
	default:
		return nil, fmt.Errorf("key %q: %w", keyConf.Name(), errKeyID)
	}
	key, err := t.cli.GetKey(ctx, baseURL, cert.KeyName, cert.KeyVersion)
	if err != nil {
		return nil, fmt.Errorf("key %q: %w", keyConf.Name(), err)
	} else if pingOnly {
		return nil, nil
	}
	// strip off -HSM suffix to get a key type jose will accept
	kty := strings.TrimSuffix(string(key.Key.Kty), "-HSM")
	key.Key.Kty = keyvault.JSONWebKeyType(kty)
	// marshal back to JSON and then parse using jose to get a PublicKey
	keyBlob, err := json.Marshal(key.Key)
	if err != nil {
		return nil, fmt.Errorf("marshaling public key: %w", err)
	}
	var jwk jose.JSONWebKey
	if err := json.Unmarshal(keyBlob, &jwk); err != nil {
		return nil, fmt.Errorf("unmarshaling public key: %w", err)
	}
	return &kvKey{
		kconf:    keyConf,
		cli:      t.cli,
		pub:      jwk.Key,
		kbase:    baseURL,
		kname:    cert.KeyName,
		kversion: cert.KeyVersion,
		cert:     cert.CertBlob,
		id:       cert.KeyID(),
	}, nil
}

func (t *kvToken) Import(keyName string, privKey crypto.PrivateKey) (token.Key, error) {
	return nil, token.NotImplementedError{Op: "import-key", Type: tokenType}
}

func (t *kvToken) ImportCertificate(cert *x509.Certificate, labelBase string) error {
	return token.NotImplementedError{Op: "import-certificate", Type: tokenType}
}

func (t *kvToken) Generate(keyName string, keyType token.KeyType, bits uint) (token.Key, error) {
	return nil, token.NotImplementedError{Op: "generate-key", Type: tokenType}
}

func (t *kvToken) ListKeys(opts token.ListOptions) error {
	return token.NotImplementedError{Op: "list-keys", Type: tokenType}
}

func (k *kvKey) Public() crypto.PublicKey {
	return k.pub
}

func (k *kvKey) Sign(rand io.Reader, digest []byte, opts crypto.SignerOpts) (signature []byte, err error) {
	return k.SignContext(context.Background(), digest, opts)
}

func (k *kvKey) SignContext(ctx context.Context, digest []byte, opts crypto.SignerOpts) (signature []byte, err error) {
	alg, err := k.sigAlgorithm(opts)
	if err != nil {
		return nil, err
	}
	encoded := base64.RawURLEncoding.EncodeToString(digest)
	kname, kversion := k.kname, k.kversion
	if wantKeyID := token.KeyID(ctx); len(wantKeyID) != 0 {
		// reusing a key the client saw before
		cert := refFromKeyID(wantKeyID)
		if cert == nil {
			return nil, errors.New("invalid keyID")
		}
		kname, kversion = cert.KeyName, cert.KeyVersion
	}
	resp, err := k.cli.Sign(ctx, k.kbase, kname, kversion, keyvault.KeySignParameters{
		Algorithm: keyvault.JSONWebKeySignatureAlgorithm(alg),
		Value:     &encoded,
	})
	if err != nil {
		return nil, err
	}
	sig, err := base64.RawURLEncoding.DecodeString(*resp.Result)
	if err != nil {
		return nil, err
	}
	if _, ok := k.pub.(*ecdsa.PublicKey); ok {
		// repack as ASN.1
		unpacked, err := x509tools.UnpackEcdsaSignature(sig)
		if err != nil {
			return nil, err
		}
		sig = unpacked.Marshal()
	}
	return sig, nil
}

func (k *kvKey) Config() *config.KeyConfig { return k.kconf }
func (k *kvKey) Certificate() []byte       { return k.cert }
func (k *kvKey) GetID() []byte             { return k.id }

func (k *kvKey) ImportCertificate(cert *x509.Certificate) error {
	return token.NotImplementedError{Op: "import-certificate", Type: tokenType}
}

// select a JOSE signature algorithm based on the public key algorithm and requested hash func
func (k *kvKey) sigAlgorithm(opts crypto.SignerOpts) (string, error) {
	var alg string
	switch opts.HashFunc() {
	case crypto.SHA256:
		alg = "256"
	case crypto.SHA384:
		alg = "384"
	case crypto.SHA512:
		alg = "512"
	default:
		return "", token.KeyUsageError{
			Key: k.kconf.Name(),
			Err: fmt.Errorf("unsupported digest algorithm %s", opts.HashFunc()),
		}
	}
	switch k.pub.(type) {
	case *rsa.PublicKey:
		if _, ok := opts.(*rsa.PSSOptions); ok {
			return "PS" + alg, nil
		} else {
			return "RS" + alg, nil
		}
	case *ecdsa.PublicKey:
		return "ES" + alg, nil
	default:
		return "", token.KeyUsageError{
			Key: k.kconf.Name(),
			Err: fmt.Errorf("unsupported public key type %T", k.pub),
		}
	}
}