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
|
// Copyright 2017 Google LLC. All Rights Reserved.
//
// 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 storage
import (
"context"
"github.com/google/trillian"
)
// ReadOnlyAdminTX is a transaction capable only of read operations in the
// AdminStorage.
type ReadOnlyAdminTX interface {
// GetTree returns the tree corresponding to treeID or an error.
GetTree(ctx context.Context, treeID int64) (*trillian.Tree, error)
// ListTrees returns all trees in storage.
// Note that there's no authorization restriction on the trees returned,
// so it should be used with caution in production code.
ListTrees(ctx context.Context, includeDeleted bool) ([]*trillian.Tree, error)
// Commit applies the operations performed to the underlying storage. It must
// be called before any reads from storage are considered consistent.
Commit() error
// Close rolls back the transaction if it wasn't committed or closed
// previously. Resources are cleaned up regardless of the success, and the
// transaction should not be used after it.
Close() error
}
// AdminTX is a transaction capable of read and write operations in the
// AdminStorage.
type AdminTX interface {
ReadOnlyAdminTX
AdminWriter
}
// AdminTXFunc is the signature for functions passed to ReadWriteTransaction.
type AdminTXFunc func(context.Context, AdminTX) error
// AdminStorage represents the persistent storage of tree data.
type AdminStorage interface {
// Snapshot starts a read-only transaction.
// A transaction must be explicitly committed before the data read by it
// is considered consistent.
Snapshot(ctx context.Context) (ReadOnlyAdminTX, error)
// ReadWriteTransaction creates a transaction, and runs f with it.
// Some storage implementations may retry aborted transactions, so
// f MUST be idempotent.
ReadWriteTransaction(ctx context.Context, f AdminTXFunc) error
// CheckDatabaseAccessible checks whether we are able to connect to / open the
// underlying storage.
CheckDatabaseAccessible(ctx context.Context) error
}
// AdminWriter provides a write-only interface for tree data.
type AdminWriter interface {
// CreateTree inserts the specified tree in storage, returning a tree
// with all storage-generated fields set.
// Note that treeID and timestamps will be automatically generated by
// the storage layer, thus may be ignored by the implementation.
// Remaining fields must be set to valid values.
// Returns an error if the tree is invalid or creation fails.
CreateTree(ctx context.Context, tree *trillian.Tree) (*trillian.Tree, error)
// UpdateTree updates the specified tree in storage, returning a tree
// with all storage-generated fields set.
// updateFunc is called to perform the desired tree modifications. Refer
// to trillian.Tree for details on which fields are mutable and what is
// considered valid.
// Returns an error if the tree is invalid or the update cannot be
// performed.
UpdateTree(ctx context.Context, treeID int64, updateFunc func(*trillian.Tree)) (*trillian.Tree, error)
// SoftDeleteTree soft deletes the specified tree.
// The tree must exist and not be already soft deleted, otherwise an error is returned.
// Soft deletion may be undone via UndeleteTree.
SoftDeleteTree(ctx context.Context, treeID int64) (*trillian.Tree, error)
// HardDeleteTree hard deletes (i.e. completely removes from storage) the specified tree and all
// records related to it.
// The tree must exist and currently be soft deleted, as per SoftDeletedTree, otherwise an error
// is returned.
// Hard deleted trees cannot be recovered.
HardDeleteTree(ctx context.Context, treeID int64) error
// UndeleteTree undeletes a soft-deleted tree.
// The tree must exist and currently be soft deleted, as per SoftDeletedTree, otherwise an error
// is returned.
UndeleteTree(ctx context.Context, treeID int64) (*trillian.Tree, error)
}
|