/
server.go
302 lines (277 loc) · 8.02 KB
/
server.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
// server.go - Reunion server.
// Copyright (C) 2019, 2020 David Stainton.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
// Package server provides the Reunion protocol server.
package server
import (
"errors"
"sync"
"sync/atomic"
"time"
"github.com/katzenpost/katzenpost/core/log"
"github.com/katzenpost/katzenpost/core/worker"
"github.com/katzenpost/katzenpost/reunion/commands"
"github.com/katzenpost/katzenpost/reunion/epochtime"
"github.com/katzenpost/katzenpost/server/cborplugin"
"gopkg.in/op/go-logging.v1"
)
// Tune me.
const (
writeBackInterval = 10 * time.Second
epochGracePeriod = 3 * time.Minute
)
// Server is a reunion server.
type Server struct {
sync.RWMutex
worker.Worker
stateFilePath string
states *ReunionStates
nDirtyEntries uint64
epochClock epochtime.EpochClock
log *logging.Logger
logBackend *log.Backend
}
// NewServerFromStatefile loads the state from a file.
func NewServerFromStatefile(epochClock epochtime.EpochClock, stateFilePath, logPath, logLevel string) (*Server, error) {
logBackend, err := log.New(logPath, logLevel, false)
if err != nil {
return nil, err
}
s := &Server{
stateFilePath: stateFilePath,
states: NewReunionStates(),
nDirtyEntries: 0,
epochClock: epochClock,
logBackend: logBackend,
log: logBackend.GetLogger("reunion_server_core"),
}
err = s.states.LoadFromFile(stateFilePath)
if err != nil {
return nil, err
}
s.states.MaybeAddEpochs(s.epochClock)
s.states.GarbageCollectOldEpochs(epochClock)
s.Go(s.worker)
return s, nil
}
// NewServer returns a new Server with a new ReunionState.
func NewServer(epochClock epochtime.EpochClock, stateFilePath, logPath, logLevel string) (*Server, error) {
logBackend, err := log.New(logPath, logLevel, false)
if err != nil {
return nil, err
}
s := &Server{
stateFilePath: stateFilePath,
states: NewReunionStates(),
nDirtyEntries: 0,
epochClock: epochClock,
logBackend: logBackend,
log: logBackend.GetLogger("reunion_server_core"),
}
s.states.MaybeAddEpochs(s.epochClock)
s.Go(s.worker)
return s, nil
}
// GetNewLogger returns a logger for the given subsystem name.
func (s *Server) GetNewLogger(name string) *logging.Logger {
return s.logBackend.GetLogger(name)
}
func (s *Server) incrementDirtyEntryCount() {
atomic.AddUint64(&s.nDirtyEntries, 1)
}
func (s *Server) fetchState(fetchCmd *commands.FetchState) (*commands.StateResponse, error) {
state, err := s.states.GetStateFromEpoch(fetchCmd.Epoch)
if err != nil {
return nil, err
}
messages, ok := state.messageMap.Load(fetchCmd.T1Hash)
if !ok {
return nil, errors.New("invalid message map value")
}
messageList, ok := messages.(*LockedList)
if !ok {
return nil, errors.New("invalid message list")
}
t2t3messages, err := messageList.Serializable()
if err != nil {
return nil, err
}
t1Map, err := state.SerializableT1Map()
if err != nil {
return nil, err
}
requested := &RequestedReunionState{
T1Map: t1Map,
Messages: t2t3messages,
}
serialized, err := requested.Marshal()
if err != nil {
return nil, err
}
response := &commands.StateResponse{
ErrorCode: commands.ResponseStatusOK,
Truncated: false,
LeftOverChunksHint: 0,
Payload: serialized,
}
return response, nil
}
func (s *Server) sendT1(sendT1 *commands.SendT1) (*commands.MessageResponse, error) {
state, err := s.states.GetStateFromEpoch(sendT1.Epoch)
if err != nil {
return nil, err
}
err = state.AppendMessage(sendT1)
if err != nil {
return nil, err
}
s.incrementDirtyEntryCount()
response := &commands.MessageResponse{
ErrorCode: commands.ResponseStatusOK,
}
return response, nil
}
func (s *Server) sendT2(sendT2 *commands.SendT2) (*commands.MessageResponse, error) {
state, err := s.states.GetStateFromEpoch(sendT2.Epoch)
if err != nil {
return nil, err
}
err = state.AppendMessage(sendT2)
if err != nil {
return nil, err
}
s.incrementDirtyEntryCount()
response := &commands.MessageResponse{
ErrorCode: commands.ResponseStatusOK,
}
return response, nil
}
func (s *Server) sendT3(sendT3 *commands.SendT3) (*commands.MessageResponse, error) {
state, err := s.states.GetStateFromEpoch(sendT3.Epoch)
if err != nil {
return nil, err
}
err = state.AppendMessage(sendT3)
if err != nil {
return nil, err
}
s.incrementDirtyEntryCount()
response := &commands.MessageResponse{
ErrorCode: commands.ResponseStatusOK,
}
return response, nil
}
// RegisterConsumers implements cborplugin.PluginClient
func (s *Server) RegisterConsumer(*cborplugin.Server) {
// this is a no-op
}
// OnCommand implemenets cborplugin.PluginClient
func (s *Server) OnCommand(cmd cborplugin.Command) (cborplugin.Command, error) {
switch r := cmd.(type) {
case *cborplugin.Request:
cmd, err := commands.FromBytes(r.Payload)
var replyCmd commands.Command
if err != nil {
replyCmd = &commands.MessageResponse{ErrorCode: commands.ResponseInvalidCommand}
s.log.Errorf("invalid Reunion query command found in request Payload len %d: %s", len(r.Payload), err.Error())
return nil, err
}
replyCmd, err = s.ProcessQuery(cmd)
if err != nil {
s.log.Errorf("reunion HTTP server invalid reply command: %s", err.Error())
// XXX: this is also triggered by an expired epoch... and does not return error to client
replyCmd = &commands.MessageResponse{ErrorCode: commands.ResponseInvalidCommand}
}
rawReply := replyCmd.ToBytes()
reply := &cborplugin.Response{Payload: rawReply}
return reply, nil
default:
s.log.Errorf("OnCommand called with unknown Command type")
return nil, errors.New("Invalid Command type")
}
}
// ProcessQuery processes the given query command and returns a response command or an error.
func (s *Server) ProcessQuery(command commands.Command) (commands.Command, error) {
var err error
var response commands.Command
switch cmd := command.(type) {
case *commands.FetchState:
s.log.Debug("fetch state")
response, err = s.fetchState(cmd)
if err != nil {
return nil, err
}
case *commands.SendT1:
s.log.Debug("send t1")
response, err = s.sendT1(cmd)
if err != nil {
return nil, err
}
case *commands.SendT2:
s.log.Debug("send t2")
response, err = s.sendT2(cmd)
if err != nil {
return nil, err
}
case *commands.SendT3:
s.log.Debug("send t3")
response, err = s.sendT3(cmd)
if err != nil {
return nil, err
}
default:
s.log.Debug("Reunion server ProcessQuery received invalid query command")
return nil, errors.New("Reunion server ProcessQuery received invalid query command")
}
return response, nil
}
func (s *Server) doFlush() error {
return s.states.AtomicWriteToFile(s.stateFilePath)
}
func (s *Server) maybeFlush() {
nEntries := atomic.LoadUint64(&s.nDirtyEntries)
if nEntries == 0 {
return
}
err := s.doFlush()
if err != nil {
panic("flush to disk failure, aborting...") // XXX should we panic here or what?
}
atomic.StoreUint64(&s.nDirtyEntries, 0)
}
func (s *Server) worker() {
defer s.doFlush()
flushTicker := time.NewTicker(writeBackInterval)
defer flushTicker.Stop()
gcTicker := time.NewTicker(s.epochClock.Period() / 2)
defer gcTicker.Stop()
newEpochTicker := time.NewTicker(s.epochClock.Period() / 8)
defer flushTicker.Stop()
for {
select {
case <-s.HaltCh():
return
case <-flushTicker.C:
s.maybeFlush()
continue
case <-gcTicker.C:
s.states.GarbageCollectOldEpochs(s.epochClock)
continue
case <-newEpochTicker.C:
s.states.MaybeAddEpochs(s.epochClock)
continue
}
}
}