-
Notifications
You must be signed in to change notification settings - Fork 375
/
sqladminstorage.go
427 lines (382 loc) · 11.6 KB
/
sqladminstorage.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
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
// Copyright 2017 Trillian 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 crdb
import (
"context"
"database/sql"
"fmt"
"sync"
"time"
"github.com/google/trillian"
"github.com/google/trillian/storage"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
"google.golang.org/protobuf/proto"
"google.golang.org/protobuf/types/known/timestamppb"
"k8s.io/klog/v2"
)
const (
defaultSequenceIntervalSeconds = 60
nonDeletedWhere = " WHERE (Deleted IS NULL OR Deleted = 'false')"
selectTrees = `
SELECT
TreeId,
TreeState,
TreeType,
HashStrategy,
HashAlgorithm,
SignatureAlgorithm,
DisplayName,
Description,
CreateTimeMillis,
UpdateTimeMillis,
PrivateKey,
PublicKey,
MaxRootDurationMillis,
Deleted,
DeleteTimeMillis
FROM Trees`
selectNonDeletedTrees = selectTrees + nonDeletedWhere
selectTreeByID = selectTrees + " WHERE TreeId = $1"
updateTreeSQL = `UPDATE Trees
SET TreeState = $1, TreeType = $2, DisplayName = $3, Description = $4, UpdateTimeMillis = $5, MaxRootDurationMillis = $6, PrivateKey = $7
WHERE TreeId = $8`
)
// NewSQLAdminStorage returns a SQL storage.AdminStorage implementation backed by DB.
// Should work for MySQL and CockroachDB
func NewSQLAdminStorage(db *sql.DB) storage.AdminStorage {
return &sqlAdminStorage{db}
}
// sqlAdminStorage implements storage.AdminStorage
type sqlAdminStorage struct {
db *sql.DB
}
func (s *sqlAdminStorage) Snapshot(ctx context.Context) (storage.ReadOnlyAdminTX, error) {
return s.beginInternal(ctx)
}
func (s *sqlAdminStorage) beginInternal(ctx context.Context) (storage.AdminTX, error) {
tx, err := s.db.BeginTx(ctx, nil /* opts */)
if err != nil {
return nil, err
}
return &adminTX{tx: tx}, nil
}
func (s *sqlAdminStorage) ReadWriteTransaction(ctx context.Context, f storage.AdminTXFunc) error {
tx, err := s.beginInternal(ctx)
if err != nil {
return err
}
defer func() {
if err := tx.Close(); err != nil {
klog.Errorf("tx.Close(): %v", err)
}
}()
if err := f(ctx, tx); err != nil {
return err
}
return tx.Commit()
}
func (s *sqlAdminStorage) CheckDatabaseAccessible(ctx context.Context) error {
return s.db.PingContext(ctx)
}
type adminTX struct {
tx *sql.Tx
// mu guards reads/writes on closed, which happen on Commit/Close methods.
//
// We don't check closed on methods apart from the ones above, as we trust tx
// to keep tabs on its state, and hence fail to do queries after closed.
mu sync.RWMutex
closed bool
}
func (t *adminTX) Commit() error {
t.mu.Lock()
defer t.mu.Unlock()
t.closed = true
return t.tx.Commit()
}
func (t *adminTX) Close() error {
t.mu.Lock()
defer t.mu.Unlock()
if t.closed {
return nil
}
t.closed = true
return t.tx.Rollback()
}
func (t *adminTX) GetTree(ctx context.Context, treeID int64) (*trillian.Tree, error) {
stmt, err := t.tx.PrepareContext(ctx, selectTreeByID)
if err != nil {
return nil, err
}
defer func() {
if err := stmt.Close(); err != nil {
klog.Errorf("stmt.Close(): %v", err)
}
}()
// GetTree is an entry point for most RPCs, let's provide somewhat nicer error messages.
tree, err := readTree(stmt.QueryRowContext(ctx, treeID))
switch {
case err == sql.ErrNoRows:
// ErrNoRows doesn't provide useful information, so we don't forward it.
return nil, status.Errorf(codes.NotFound, "tree %v not found", treeID)
case err != nil:
return nil, fmt.Errorf("error reading tree %v: %v", treeID, err)
}
return tree, nil
}
func (t *adminTX) ListTrees(ctx context.Context, includeDeleted bool) ([]*trillian.Tree, error) {
var query string
if includeDeleted {
query = selectTrees
} else {
query = selectNonDeletedTrees
}
stmt, err := t.tx.PrepareContext(ctx, query)
if err != nil {
return nil, err
}
defer func() {
if err := stmt.Close(); err != nil {
klog.Errorf("stmt.Close(): %v", err)
}
}()
rows, err := stmt.QueryContext(ctx)
if err != nil {
return nil, err
}
defer func() {
if err := rows.Close(); err != nil {
klog.Errorf("rows.Close(): %v", err)
}
}()
trees := []*trillian.Tree{}
for rows.Next() {
tree, err := readTree(rows)
if err != nil {
return nil, err
}
trees = append(trees, tree)
}
return trees, nil
}
func (t *adminTX) CreateTree(ctx context.Context, tree *trillian.Tree) (*trillian.Tree, error) {
if err := storage.ValidateTreeForCreation(ctx, tree); err != nil {
return nil, err
}
if err := validateStorageSettings(tree); err != nil {
return nil, err
}
id, err := storage.NewTreeID()
if err != nil {
return nil, err
}
// Use the time truncated-to-millis throughout, as that's what's stored.
nowMillis := toMillisSinceEpoch(time.Now())
now := fromMillisSinceEpoch(nowMillis)
newTree := proto.Clone(tree).(*trillian.Tree)
newTree.TreeId = id
newTree.CreateTime = timestamppb.New(now)
if err := newTree.CreateTime.CheckValid(); err != nil {
return nil, fmt.Errorf("failed to build create time: %w", err)
}
newTree.UpdateTime = timestamppb.New(now)
if err := newTree.UpdateTime.CheckValid(); err != nil {
return nil, fmt.Errorf("failed to build update time: %w", err)
}
if err := newTree.MaxRootDuration.CheckValid(); err != nil {
return nil, fmt.Errorf("could not parse MaxRootDuration: %w", err)
}
rootDuration := newTree.MaxRootDuration.AsDuration()
insertTreeStmt, err := t.tx.PrepareContext(
ctx,
`INSERT INTO Trees(
TreeId,
TreeState,
TreeType,
HashStrategy,
HashAlgorithm,
SignatureAlgorithm,
DisplayName,
Description,
CreateTimeMillis,
UpdateTimeMillis,
PrivateKey,
PublicKey,
MaxRootDurationMillis)
VALUES($1, $2, $3, $4, $5, $6, $7, $8, $9, $10, $11, $12, $13)`)
if err != nil {
return nil, err
}
defer func() {
if err := insertTreeStmt.Close(); err != nil {
klog.Errorf("insertTreeStmt.Close(): %v", err)
}
}()
_, err = insertTreeStmt.ExecContext(
ctx,
newTree.TreeId,
newTree.TreeState.String(),
newTree.TreeType.String(),
"RFC6962_SHA256", // Unused, filling in for backward compatibility.
"SHA256", // Unused, filling in for backward compatibility.
"ECDSA", // Unused, filling in for backward compatibility.
newTree.DisplayName,
newTree.Description,
nowMillis,
nowMillis,
[]byte{}, // Unused, filling in for backward compatibility.
[]byte{}, // Unused, filling in for backward compatibility.
rootDuration/time.Millisecond,
)
if err != nil {
return nil, err
}
// MySQL silently truncates data when running in non-strict mode.
// We shouldn't be using non-strict modes, but let's guard against it
// anyway.
if _, err := t.GetTree(ctx, newTree.TreeId); err != nil {
// GetTree will fail for truncated enums (they get recorded as
// empty strings, which will not match any known value).
return nil, fmt.Errorf("enum truncated: %v", err)
}
insertControlStmt, err := t.tx.PrepareContext(
ctx,
`INSERT INTO TreeControl(
TreeId,
SigningEnabled,
SequencingEnabled,
SequenceIntervalSeconds)
VALUES($1, $2, $3, $4)`)
if err != nil {
return nil, err
}
defer func() {
if err := insertControlStmt.Close(); err != nil {
klog.Errorf("insertControlStmt.Close(): %v", err)
}
}()
_, err = insertControlStmt.ExecContext(
ctx,
newTree.TreeId,
true, /* SigningEnabled */
true, /* SequencingEnabled */
defaultSequenceIntervalSeconds,
)
if err != nil {
return nil, err
}
return newTree, nil
}
func (t *adminTX) UpdateTree(ctx context.Context, treeID int64, updateFunc func(*trillian.Tree)) (*trillian.Tree, error) {
tree, err := t.GetTree(ctx, treeID)
if err != nil {
return nil, err
}
beforeUpdate := proto.Clone(tree).(*trillian.Tree)
updateFunc(tree)
if err := storage.ValidateTreeForUpdate(ctx, beforeUpdate, tree); err != nil {
return nil, err
}
if err := validateStorageSettings(tree); err != nil {
return nil, err
}
// TODO(pavelkalinnikov): When switching TreeType from PREORDERED_LOG to LOG,
// ensure all entries in SequencedLeafData are integrated.
// Use the time truncated-to-millis throughout, as that's what's stored.
nowMillis := toMillisSinceEpoch(time.Now())
now := fromMillisSinceEpoch(nowMillis)
tree.UpdateTime = timestamppb.New(now)
if err != nil {
return nil, fmt.Errorf("failed to build update time: %v", err)
}
if err := tree.MaxRootDuration.CheckValid(); err != nil {
return nil, fmt.Errorf("could not parse MaxRootDuration: %w", err)
}
rootDuration := tree.MaxRootDuration.AsDuration()
stmt, err := t.tx.PrepareContext(ctx, updateTreeSQL)
if err != nil {
return nil, err
}
defer func() {
if err := stmt.Close(); err != nil {
klog.Errorf("stmt.Close(): %v", err)
}
}()
if _, err = stmt.ExecContext(
ctx,
tree.TreeState.String(),
tree.TreeType.String(),
tree.DisplayName,
tree.Description,
nowMillis,
rootDuration/time.Millisecond,
[]byte{}, // Unused, filling in for backward compatibility.
tree.TreeId); err != nil {
return nil, err
}
return tree, nil
}
func (t *adminTX) SoftDeleteTree(ctx context.Context, treeID int64) (*trillian.Tree, error) {
return t.updateDeleted(ctx, treeID, true /* deleted */, toMillisSinceEpoch(time.Now()) /* deleteTimeMillis */)
}
func (t *adminTX) UndeleteTree(ctx context.Context, treeID int64) (*trillian.Tree, error) {
return t.updateDeleted(ctx, treeID, false /* deleted */, nil /* deleteTimeMillis */)
}
// updateDeleted updates the Deleted and DeleteTimeMillis fields of the specified tree.
// deleteTimeMillis must be either an int64 (in millis since epoch) or nil.
func (t *adminTX) updateDeleted(ctx context.Context, treeID int64, deleted bool, deleteTimeMillis interface{}) (*trillian.Tree, error) {
if err := validateDeleted(ctx, t.tx, treeID, !deleted); err != nil {
return nil, err
}
if _, err := t.tx.ExecContext(
ctx,
"UPDATE Trees SET Deleted = $1, DeleteTimeMillis = $2 WHERE TreeId = $3",
deleted, deleteTimeMillis, treeID); err != nil {
return nil, err
}
return t.GetTree(ctx, treeID)
}
func (t *adminTX) HardDeleteTree(ctx context.Context, treeID int64) error {
if err := validateDeleted(ctx, t.tx, treeID, true /* wantDeleted */); err != nil {
return err
}
// TreeControl didn't have "ON DELETE CASCADE" on previous versions, so let's hit it explicitly
if _, err := t.tx.ExecContext(ctx, "DELETE FROM TreeControl WHERE TreeId = $1", treeID); err != nil {
return err
}
_, err := t.tx.ExecContext(ctx, "DELETE FROM Trees WHERE TreeId = $1", treeID)
return err
}
func validateDeleted(ctx context.Context, tx *sql.Tx, treeID int64, wantDeleted bool) error {
var nullDeleted sql.NullBool
switch err := tx.QueryRowContext(ctx, "SELECT Deleted FROM Trees WHERE TreeId = $1", treeID).Scan(&nullDeleted); {
case err == sql.ErrNoRows:
return status.Errorf(codes.NotFound, "tree %v not found", treeID)
case err != nil:
return err
}
switch deleted := nullDeleted.Valid && nullDeleted.Bool; {
case wantDeleted && !deleted:
return status.Errorf(codes.FailedPrecondition, "tree %v is not soft deleted", treeID)
case !wantDeleted && deleted:
return status.Errorf(codes.FailedPrecondition, "tree %v already soft deleted", treeID)
}
return nil
}
func validateStorageSettings(tree *trillian.Tree) error {
if tree.StorageSettings != nil {
return fmt.Errorf("storage_settings not supported, but got %v", tree.StorageSettings)
}
return nil
}