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
|
// 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 admin
import (
"context"
"fmt"
"github.com/google/trillian"
"github.com/google/trillian/extension"
"github.com/google/trillian/storage"
"google.golang.org/genproto/protobuf/field_mask"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
"k8s.io/klog/v2"
)
// Server is an implementation of trillian.TrillianAdminServer.
type Server struct {
registry extension.Registry
allowedTreeTypes []trillian.TreeType
}
// New returns a trillian.TrillianAdminServer implementation.
// registry is the extension.Registry used by the Server.
// allowedTreeTypes defines which tree types may be created through this server,
// with nil meaning unrestricted.
func New(registry extension.Registry, allowedTreeTypes []trillian.TreeType) *Server {
return &Server{
registry: registry,
allowedTreeTypes: allowedTreeTypes,
}
}
// IsHealthy returns nil if the server is healthy, error otherwise.
// TODO(Martin2112): This method (and the one in the log server) should probably have ctx as a param
func (s *Server) IsHealthy() error {
return s.registry.AdminStorage.CheckDatabaseAccessible(context.Background())
}
// ListTrees implements trillian.TrillianAdminServer.ListTrees.
func (s *Server) ListTrees(ctx context.Context, req *trillian.ListTreesRequest) (*trillian.ListTreesResponse, error) {
// TODO(codingllama): This needs access control
resp, err := storage.ListTrees(ctx, s.registry.AdminStorage, req.GetShowDeleted())
if err != nil {
return nil, err
}
return &trillian.ListTreesResponse{Tree: resp}, nil
}
// GetTree implements trillian.TrillianAdminServer.GetTree.
func (s *Server) GetTree(ctx context.Context, req *trillian.GetTreeRequest) (*trillian.Tree, error) {
tree, err := storage.GetTree(ctx, s.registry.AdminStorage, req.GetTreeId())
if err != nil {
return nil, err
}
return tree, nil
}
// CreateTree implements trillian.TrillianAdminServer.CreateTree.
func (s *Server) CreateTree(ctx context.Context, req *trillian.CreateTreeRequest) (*trillian.Tree, error) {
tree := req.GetTree()
if tree == nil {
return nil, status.Errorf(codes.InvalidArgument, "a tree is required")
}
if err := s.validateAllowedTreeType(tree.TreeType); err != nil {
return nil, status.Error(codes.InvalidArgument, err.Error())
}
if tree.TreeType != trillian.TreeType_LOG && tree.TreeType != trillian.TreeType_PREORDERED_LOG {
return nil, status.Errorf(codes.InvalidArgument, "invalid tree type: %v", tree.TreeType)
}
// Clear generated fields, storage must set those
tree.TreeId = 0
tree.CreateTime = nil
tree.UpdateTime = nil
tree.Deleted = false
tree.DeleteTime = nil
createdTree, err := storage.CreateTree(ctx, s.registry.AdminStorage, tree)
if err != nil {
return nil, err
}
return createdTree, nil
}
func (s *Server) validateAllowedTreeType(tt trillian.TreeType) error {
if s.allowedTreeTypes == nil {
return nil // All types OK
}
for _, allowedType := range s.allowedTreeTypes {
if tt == allowedType {
return nil
}
}
return fmt.Errorf("tree type %s not allowed by this server", tt)
}
// UpdateTree implements trillian.TrillianAdminServer.UpdateTree.
func (s *Server) UpdateTree(ctx context.Context, req *trillian.UpdateTreeRequest) (*trillian.Tree, error) {
tree := req.GetTree()
mask := req.GetUpdateMask()
if tree == nil {
return nil, status.Errorf(codes.InvalidArgument, "a tree is required")
}
// Apply the mask to a couple of empty trees just to check that the paths are correct.
if err := applyUpdateMask(&trillian.Tree{}, &trillian.Tree{}, mask); err != nil {
return nil, err
}
updatedTree, err := storage.UpdateTree(ctx, s.registry.AdminStorage, tree.TreeId, func(other *trillian.Tree) {
if err := applyUpdateMask(tree, other, mask); err != nil {
// Should never happen (famous last words).
klog.Errorf("Error applying mask on tree update: %v", err)
}
})
if err != nil {
return nil, err
}
return updatedTree, nil
}
func applyUpdateMask(from, to *trillian.Tree, mask *field_mask.FieldMask) error {
if mask == nil || len(mask.Paths) == 0 {
return status.Errorf(codes.InvalidArgument, "an update_mask is required")
}
for _, path := range mask.Paths {
switch path {
case "tree_state":
to.TreeState = from.TreeState
case "tree_type":
to.TreeType = from.TreeType
case "display_name":
to.DisplayName = from.DisplayName
case "description":
to.Description = from.Description
case "storage_settings":
to.StorageSettings = from.StorageSettings
case "max_root_duration":
to.MaxRootDuration = from.MaxRootDuration
default:
return status.Errorf(codes.InvalidArgument, "invalid update_mask path: %q", path)
}
}
return nil
}
// DeleteTree implements trillian.TrillianAdminServer.DeleteTree.
func (s *Server) DeleteTree(ctx context.Context, req *trillian.DeleteTreeRequest) (*trillian.Tree, error) {
tree, err := storage.SoftDeleteTree(ctx, s.registry.AdminStorage, req.GetTreeId())
if err != nil {
return nil, err
}
return tree, nil
}
// UndeleteTree implements trillian.TrillianAdminServer.UndeleteTree.
func (s *Server) UndeleteTree(ctx context.Context, req *trillian.UndeleteTreeRequest) (*trillian.Tree, error) {
tree, err := storage.UndeleteTree(ctx, s.registry.AdminStorage, req.GetTreeId())
if err != nil {
return nil, err
}
return tree, nil
}
|
