-
Notifications
You must be signed in to change notification settings - Fork 0
/
keyring.go
330 lines (248 loc) · 7.39 KB
/
keyring.go
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
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
package secretstorage
import (
"encoding"
"errors"
"fmt"
"mime"
"strconv"
"strings"
"sync"
"github.com/zalando/go-keyring"
"go.uber.org/multierr"
)
var (
// ErrNotFound is a not found error.
ErrNotFound = keyring.ErrNotFound
// ErrUnsupportedType is an unsupported type error.
ErrUnsupportedType = errors.New("unsupported type")
)
const (
mimeMultipartSecret = "application/multipart-secret"
minPages = 2
maxLength = 2048
)
var (
_ Storage[any] = (*KeyringStorage[any])(nil)
_ configurableKeyringStorage = (*KeyringStorage[any])(nil)
)
// KeyringStorage is a storage implementation that uses the OS keyring.
type KeyringStorage[V any] struct {
keyring keyring.Keyring
mu sync.Map
}
func (ss *KeyringStorage[V]) mutex(service, key string) *sync.RWMutex {
m, _ := ss.mu.LoadOrStore(fmt.Sprintf("%s:%s", service, key), &sync.RWMutex{})
return m.(*sync.RWMutex) //nolint: forcetypeassert
}
func (ss *KeyringStorage[V]) withKeyring(keyring keyring.Keyring) {
ss.keyring = keyring
}
func (ss *KeyringStorage[V]) get(service string, key string) (V, error) {
var result V
d, err := ss.keyring.Get(service, key)
if err != nil {
return result, fmt.Errorf("failed to read data from keyring: %w", err)
}
if strings.HasPrefix(d, mimeMultipartSecret) {
_, params, err := mime.ParseMediaType(d)
if err != nil {
return result, fmt.Errorf("failed to get params from data: %w", err)
}
pages, err := strconv.Atoi(params["pages"])
if err != nil {
return result, fmt.Errorf("failed to get pages from data: %w", err)
}
if pages < minPages {
return result, fmt.Errorf("invalid secret pages: %d", pages) //nolint: goerr113
}
var sb strings.Builder
for i := 1; i <= pages; i++ {
p, err := ss.keyring.Get(service, formatPage(key, i))
if err != nil {
return result, fmt.Errorf("failed to read multipart data #%d from keyring: %w", i, err)
}
sb.WriteString(p)
}
d = sb.String()
}
if err := unmarshalData(d, &result); err != nil {
return result, fmt.Errorf("failed to unmarshal data read from keyring: %w", err)
}
return result, nil
}
func (ss *KeyringStorage[V]) set(service string, key string, value string) error {
if err := ss.keyring.Set(service, key, value); err != nil {
return fmt.Errorf("failed to write data to keyring: %w", err)
}
return nil
}
func (ss *KeyringStorage[V]) setMultipart(service string, key string, value string) error {
var err error
length := len(value)
pages := length / maxLength
if length%maxLength != 0 {
pages++
}
page := 0
defer func() {
if err != nil {
for i := 1; i < page; i++ {
_ = ss.keyring.Delete(service, formatPage(key, i)) //nolint: errcheck
}
}
}()
for page = 1; page <= pages; page++ {
end := page * maxLength
if end > length {
end = length
}
data := value[(page-1)*maxLength : end]
if err = ss.keyring.Set(service, formatPage(key, page), data); err != nil {
return fmt.Errorf("failed to write multipart data #%d to keyring: %w", page, err)
}
}
value = mime.FormatMediaType(mimeMultipartSecret, map[string]string{"pages": strconv.Itoa(pages)})
if err = ss.keyring.Set(service, key, value); err != nil {
return fmt.Errorf("failed to write data to keyring: %w", err)
}
return nil
}
func (ss *KeyringStorage[V]) delete(service string, key string) error {
var err error
d, err := ss.keyring.Get(service, key)
if err != nil {
return fmt.Errorf("failed to delete data in keyring: %w", err)
}
deleteMainKey := true
if strings.HasPrefix(d, mimeMultipartSecret) {
var (
params map[string]string
pages int
)
_, params, err = mime.ParseMediaType(d)
if err != nil {
return fmt.Errorf("failed to get params from data for deletion: %w", err)
}
pages, err = strconv.Atoi(params["pages"])
if err != nil {
return fmt.Errorf("failed to get pages from data for deletion: %w", err)
}
deleteMainKey = false
for i := 1; i <= pages; i++ {
if err = ss.keyring.Delete(service, formatPage(key, i)); err != nil {
err = fmt.Errorf("failed to delete multipart data #%d in keyring: %w", i, err)
break
}
deleteMainKey = true
}
}
if !deleteMainKey {
return err
}
if dErr := ss.keyring.Delete(service, key); dErr != nil {
err = multierr.Combine(err, fmt.Errorf("failed to delete data in keyring: %w", dErr))
}
return err
}
// Get gets the value for the given key.
func (ss *KeyringStorage[V]) Get(service string, key string) (V, error) {
mu := ss.mutex(service, key)
mu.RLock()
defer mu.RUnlock()
return ss.get(service, key)
}
// Set sets the value for the given key.
func (ss *KeyringStorage[V]) Set(service string, key string, value V) error {
mu := ss.mutex(service, key)
mu.Lock()
defer mu.Unlock()
var err error
d, err := marshalData(value)
if err != nil {
return fmt.Errorf("failed to marshal data for writing to keyring: %w", err)
}
// Delete the data because it could be multipart.
if err = ss.delete(service, key); err != nil && !errors.Is(err, ErrNotFound) {
return fmt.Errorf("failed to delete old data in keyring: %w", errors.Unwrap(err))
}
length := len(d)
if length <= maxLength {
return ss.set(service, key, d)
}
return ss.setMultipart(service, key, d)
}
// Delete deletes the value for the given key.
func (ss *KeyringStorage[V]) Delete(service string, key string) error {
mu := ss.mutex(service, key)
mu.Lock()
defer mu.Unlock()
return ss.delete(service, key)
}
// NewKeyringStorage creates a new KeyringStorage that uses the OS keyring.
func NewKeyringStorage[V any](opts ...KeyringStorageOption) *KeyringStorage[V] {
s := &KeyringStorage[V]{
keyring: defaultKeyring{},
}
for _, opt := range opts {
opt.applyKeyringStorageOption(s)
}
return s
}
type configurableKeyringStorage interface {
withKeyring(k keyring.Keyring)
}
// KeyringStorageOption is an option to configure KeyringStorage.
type KeyringStorageOption interface {
applyKeyringStorageOption(ss configurableKeyringStorage)
}
type keyringStorageOptionFunc func(ss configurableKeyringStorage)
func (f keyringStorageOptionFunc) applyKeyringStorageOption(ss configurableKeyringStorage) {
f(ss)
}
// WithKeyring sets the keyring to use.
func WithKeyring(k keyring.Keyring) KeyringStorageOption {
return keyringStorageOptionFunc(func(ss configurableKeyringStorage) {
ss.withKeyring(k)
})
}
func formatPage(key string, page int) string {
return fmt.Sprintf("%s-%04d", key, page)
}
func marshalData(v any) (string, error) {
switch v := v.(type) {
case string:
return v, nil
case []byte:
return string(v), nil
case encoding.TextMarshaler:
b, err := v.MarshalText()
if err != nil {
return "", err //nolint: wrapcheck
}
return string(b), nil
}
return "", fmt.Errorf("%w: %T", ErrUnsupportedType, v)
}
func unmarshalData(v string, dest any) error {
switch dest := dest.(type) {
case *string:
*dest = v
case *[]byte:
*dest = []byte(v)
case encoding.TextUnmarshaler:
return dest.UnmarshalText([]byte(v)) //nolint: wrapcheck
default:
return fmt.Errorf("%w: %T", ErrUnsupportedType, dest)
}
return nil
}
type defaultKeyring struct{}
func (defaultKeyring) Set(service, user, password string) error {
return keyring.Set(service, user, password) //nolint: wrapcheck
}
func (defaultKeyring) Get(service, user string) (string, error) {
return keyring.Get(service, user) //nolint: wrapcheck
}
func (defaultKeyring) Delete(service, user string) error {
return keyring.Delete(service, user) //nolint: wrapcheck
}