/
politeiad.go
548 lines (479 loc) · 14.3 KB
/
politeiad.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
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
// Copyright (c) 2017-2021 The Decred developers
// Use of this source code is governed by an ISC
// license that can be found in the LICENSE file.
package main
import (
"crypto/elliptic"
"crypto/x509"
"encoding/json"
"fmt"
"net/http"
"net/http/httputil"
"os"
"os/signal"
"regexp"
"runtime/debug"
"strings"
"syscall"
"time"
"github.com/decred/dcrd/chaincfg/v3"
v1 "github.com/decred/politeia/politeiad/api/v1"
"github.com/decred/politeia/politeiad/api/v1/identity"
v2 "github.com/decred/politeia/politeiad/api/v2"
"github.com/decred/politeia/politeiad/backend"
"github.com/decred/politeia/politeiad/backend/gitbe"
"github.com/decred/politeia/politeiad/backendv2"
"github.com/decred/politeia/politeiad/backendv2/tstorebe"
"github.com/decred/politeia/util"
"github.com/gorilla/mux"
"github.com/pkg/errors"
)
type permission uint
const (
permissionPublic permission = iota
permissionAuth
)
// politeia application context.
type politeia struct {
backend backend.Backend
backendv2 backendv2.Backend
cfg *config
router *mux.Router
identity *identity.FullIdentity
}
func remoteAddr(r *http.Request) string {
via := r.RemoteAddr
xff := r.Header.Get(v1.Forward)
if xff != "" {
return fmt.Sprintf("%v via %v", xff, r.RemoteAddr)
}
return via
}
// handleNotFound is a generic handler for an invalid route.
func (p *politeia) handleNotFound(w http.ResponseWriter, r *http.Request) {
// Log incoming connection
log.Debugf("Invalid route: %v %v %v %v", remoteAddr(r), r.Method, r.URL,
r.Proto)
// Trace incoming request
log.Tracef("%v", newLogClosure(func() string {
trace, err := httputil.DumpRequest(r, true)
if err != nil {
trace = []byte(fmt.Sprintf("logging: "+
"DumpRequest %v", err))
}
return string(trace)
}))
util.RespondWithJSON(w, http.StatusNotFound, v1.ServerErrorReply{})
}
func (p *politeia) respondWithUserError(w http.ResponseWriter, errorCode v1.ErrorStatusT, errorContext []string) {
util.RespondWithJSON(w, http.StatusBadRequest, v1.UserErrorReply{
ErrorCode: errorCode,
ErrorContext: errorContext,
})
}
func (p *politeia) respondWithServerError(w http.ResponseWriter, errorCode int64, err error) {
// If this is a pkg/errors error then we can pull the
// stack trace out of the error, otherwise, we use the
// stack trace for this function.
stack, ok := util.StackTrace(err)
if !ok {
stack = string(debug.Stack())
}
log.Errorf("Stacktrace (NOT A REAL CRASH): %v", stack)
util.RespondWithJSON(w, http.StatusInternalServerError, v1.ServerErrorReply{
ErrorCode: errorCode,
})
}
func (p *politeia) check(user, pass string) bool {
if user != p.cfg.RPCUser || pass != p.cfg.RPCPass {
return false
}
return true
}
func (p *politeia) auth(fn http.HandlerFunc) http.HandlerFunc {
return func(w http.ResponseWriter, r *http.Request) {
user, pass, ok := r.BasicAuth()
if !ok || !p.check(user, pass) {
log.Infof("%v Unauthorized access for: %v",
remoteAddr(r), user)
w.Header().Set("WWW-Authenticate",
`Basic realm="Politeiad"`)
w.WriteHeader(401)
p.respondWithUserError(w, v1.ErrorStatusInvalidRPCCredentials, nil)
return
}
log.Infof("%v Authorized access for: %v",
remoteAddr(r), user)
fn(w, r)
}
}
func (p *politeia) addRoute(method string, route string, handler http.HandlerFunc, perm permission) {
if perm == permissionAuth {
handler = p.auth(handler)
}
p.router.StrictSlash(true).HandleFunc(route, handler).Methods(method)
}
func (p *politeia) addRouteV2(method string, route string, handler http.HandlerFunc, perm permission) {
route = v2.APIRoute + route
p.addRoute(method, route, handler, perm)
}
func (p *politeia) setupBackendGit(anp *chaincfg.Params) error {
if p.router == nil {
return errors.Errorf("router must be initialized")
}
b, err := gitbe.New(anp, p.cfg.DataDir, p.cfg.DcrtimeHost,
"", p.identity, p.cfg.GitTrace, p.cfg.DcrdataHost)
if err != nil {
return fmt.Errorf("new gitbe: %v", err)
}
p.backend = b
// Not found
p.router.NotFoundHandler = http.HandlerFunc(p.handleNotFound)
// Unprivileged routes
p.addRoute(http.MethodPost, v1.IdentityRoute, p.getIdentity,
permissionPublic)
p.addRoute(http.MethodPost, v1.NewRecordRoute, p.newRecord,
permissionPublic)
p.addRoute(http.MethodPost, v1.UpdateUnvettedRoute, p.updateUnvetted,
permissionPublic)
p.addRoute(http.MethodPost, v1.UpdateVettedRoute, p.updateVetted,
permissionPublic)
p.addRoute(http.MethodPost, v1.GetUnvettedRoute, p.getUnvetted,
permissionPublic)
p.addRoute(http.MethodPost, v1.GetVettedRoute, p.getVetted,
permissionPublic)
// Routes that require auth
p.addRoute(http.MethodPost, v1.InventoryRoute, p.inventory,
permissionAuth)
p.addRoute(http.MethodPost, v1.SetUnvettedStatusRoute,
p.setUnvettedStatus, permissionAuth)
p.addRoute(http.MethodPost, v1.SetVettedStatusRoute,
p.setVettedStatus, permissionAuth)
p.addRoute(http.MethodPost, v1.UpdateVettedMetadataRoute,
p.updateVettedMetadata, permissionAuth)
// Set plugin routes. Requires auth.
p.addRoute(http.MethodPost, v1.PluginCommandRoute, p.pluginCommand,
permissionAuth)
p.addRoute(http.MethodPost, v1.PluginInventoryRoute, p.pluginInventory,
permissionAuth)
return nil
}
var (
// regexpPluginSettingMulti matches against the plugin setting
// value when it contains multiple values.
//
// pluginID,key,["value1","value2"] matches ["value1","value2"]
regexpPluginSettingMulti = regexp.MustCompile(`(\[.*\]$)`)
)
// parsePluginSetting parses a politeiad config plugin setting. Plugin settings
// will be in following format. The value may be a single value or an array of
// values.
//
// pluginID,key,value
// pluginID,key,["value1","value2","value3"...]
//
// When multiple values are provided, the values must be formatted as a JSON
// encoded []string.
func parsePluginSetting(setting string) (string, *backendv2.PluginSetting, error) {
formatMsg := `expected plugin setting format is ` +
`pluginID,key,value OR pluginID,key,["value1","value2","value3"]`
// Parse the plugin setting
var (
parsed = strings.Split(setting, ",")
// isMulti indicates whether the plugin setting contains
// multiple values. If the setting only contains a single
// value then isMulti will be false.
isMulti = regexpPluginSettingMulti.MatchString(setting)
)
switch {
case len(parsed) < 3:
return "", nil, errors.Errorf("missing csv entry '%v'; %v",
setting, formatMsg)
case len(parsed) == 3:
// This is expected; continue
case len(parsed) > 3 && isMulti:
// This is expected; continue
default:
return "", nil, errors.Errorf("invalid format '%v'; %v",
setting, formatMsg)
}
var (
pluginID = parsed[0]
settingKey = parsed[1]
settingValue = parsed[2]
)
// Clean the strings. The setting value is allowed to be case
// sensitive.
pluginID = strings.ToLower(strings.TrimSpace(pluginID))
settingKey = strings.ToLower(strings.TrimSpace(settingKey))
settingValue = strings.TrimSpace(settingValue)
// Handle multiple values
if isMulti {
// Parse values
values := regexpPluginSettingMulti.FindString(setting)
// Verify the values are formatted as valid JSON
var s []string
err := json.Unmarshal([]byte(values), &s)
if err != nil {
return "", nil, err
}
// Re-encode the JSON. This will remove any funny
// formatting like whitespaces.
b, err := json.Marshal(s)
if err != nil {
return "", nil, err
}
// Save the value
settingValue = string(b)
}
return pluginID, &backendv2.PluginSetting{
Key: settingKey,
Value: settingValue,
}, nil
}
func (p *politeia) setupBackendTstore(anp *chaincfg.Params) error {
if p.router == nil {
return errors.Errorf("router must be initialized")
}
b, err := tstorebe.New(p.cfg.HomeDir, p.cfg.DataDir,
anp, p.cfg.TlogHost, p.cfg.DBHost, p.cfg.DBPass,
p.cfg.DcrtimeHost, p.cfg.DcrtimeCert)
if err != nil {
return fmt.Errorf("new tstorebe: %v", err)
}
p.backendv2 = b
// Setup not found handler
p.router.NotFoundHandler = http.HandlerFunc(p.handleNotFound)
// Setup v1 routes
p.addRoute(http.MethodPost, v1.IdentityRoute,
p.getIdentity, permissionPublic)
// Setup v2 routes
p.addRouteV2(http.MethodPost, v2.RouteRecordNew,
p.handleRecordNew, permissionPublic)
p.addRouteV2(http.MethodPost, v2.RouteRecordEdit,
p.handleRecordEdit, permissionPublic)
p.addRouteV2(http.MethodPost, v2.RouteRecordEditMetadata,
p.handleRecordEditMetadata, permissionPublic)
p.addRouteV2(http.MethodPost, v2.RouteRecordSetStatus,
p.handleRecordSetStatus, permissionPublic)
p.addRouteV2(http.MethodPost, v2.RouteRecords,
p.handleRecords, permissionPublic)
p.addRouteV2(http.MethodPost, v2.RouteRecordTimestamps,
p.handleRecordTimestamps, permissionPublic)
p.addRouteV2(http.MethodPost, v2.RouteInventory,
p.handleInventory, permissionPublic)
p.addRouteV2(http.MethodPost, v2.RouteInventoryOrdered,
p.handleInventoryOrdered, permissionPublic)
p.addRouteV2(http.MethodPost, v2.RoutePluginWrite,
p.handlePluginWrite, permissionPublic)
p.addRouteV2(http.MethodPost, v2.RoutePluginReads,
p.handlePluginReads, permissionPublic)
p.addRouteV2(http.MethodPost, v2.RoutePluginInventory,
p.handlePluginInventory, permissionPublic)
p.addRouteV2(http.MethodPost, v2.RoutePluginInventory,
p.handlePluginInventory, permissionPublic)
// Setup plugins
if len(p.cfg.Plugins) > 0 {
// Parse plugin settings
settings := make(map[string][]backendv2.PluginSetting)
for _, v := range p.cfg.PluginSettings {
// Parse plugin setting
pluginID, ps, err := parsePluginSetting(v)
if err != nil {
return err
}
// Add to settings list
pss, ok := settings[pluginID]
if !ok {
pss = make([]backendv2.PluginSetting, 0, 16)
}
pss = append(pss, *ps)
// Save settings list
settings[pluginID] = pss
}
// Register plugins
for _, v := range p.cfg.Plugins {
// Setup plugin
ps, ok := settings[v]
if !ok {
ps = make([]backendv2.PluginSetting, 0)
}
plugin := backendv2.Plugin{
ID: v,
Settings: ps,
Identity: p.identity,
}
// Register plugin
log.Infof("Register plugin: %v", v)
err = p.backendv2.PluginRegister(plugin)
if err != nil {
return fmt.Errorf("PluginRegister %v: %v", v, err)
}
}
// Setup plugins
for _, v := range p.backendv2.PluginInventory() {
log.Infof("Setup plugin: %v", v.ID)
err = p.backendv2.PluginSetup(v.ID)
if err != nil {
return fmt.Errorf("plugin setup %v: %v", v.ID, err)
}
}
}
// Perform filesytem check
if p.cfg.Fsck {
err = p.backendv2.Fsck()
if err != nil {
return err
}
}
return nil
}
func _main() error {
// Load configuration and parse command line. This function also
// initializes logging and configures it accordingly.
cfg, _, err := loadConfig()
if err != nil {
return fmt.Errorf("Could not load configuration file: %v", err)
}
defer func() {
if logRotator != nil {
logRotator.Close()
}
}()
log.Infof("Version : %v", cfg.Version)
log.Infof("Network : %v", activeNetParams.Params.Name)
log.Infof("Home dir: %v", cfg.HomeDir)
// Create the data directory in case it does not exist.
err = os.MkdirAll(cfg.DataDir, 0700)
if err != nil {
return err
}
// Generate the TLS cert and key file if both don't already
// exist.
if !util.FileExists(cfg.HTTPSKey) &&
!util.FileExists(cfg.HTTPSCert) {
log.Infof("Generating HTTPS keypair...")
err := util.GenCertPair(elliptic.P521(), "politeiad",
cfg.HTTPSCert, cfg.HTTPSKey)
if err != nil {
return fmt.Errorf("unable to create https keypair: %v",
err)
}
log.Infof("HTTPS keypair created...")
}
// Generate ed25519 identity to save messages, tokens etc.
if !util.FileExists(cfg.Identity) {
log.Infof("Generating signing identity...")
id, err := identity.New()
if err != nil {
return err
}
err = id.Save(cfg.Identity)
if err != nil {
return err
}
log.Infof("Signing identity created...")
}
// Setup the router. Middleware is executed in
// the same order that they are registered in.
router := mux.NewRouter()
m := middleware{
reqBodySizeLimit: cfg.ReqBodySizeLimit,
}
router.Use(closeBodyMiddleware) // MUST be registered first
router.Use(m.reqBodySizeLimitMiddleware)
router.Use(loggingMiddleware)
router.Use(recoverMiddleware)
// Setup application context.
p := &politeia{
cfg: cfg,
router: router,
}
// Load identity.
p.identity, err = identity.LoadFullIdentity(cfg.Identity)
if err != nil {
return err
}
log.Infof("Public key: %x", p.identity.Public.Key)
// Load certs, if there. If they aren't there assume OS is used to
// resolve cert validity.
if len(cfg.DcrtimeCert) != 0 {
var certPool *x509.CertPool
if !util.FileExists(cfg.DcrtimeCert) {
return fmt.Errorf("unable to find dcrtime cert %v",
cfg.DcrtimeCert)
}
dcrtimeCert, err := os.ReadFile(cfg.DcrtimeCert)
if err != nil {
return fmt.Errorf("unable to read dcrtime cert %v: %v",
cfg.DcrtimeCert, err)
}
certPool = x509.NewCertPool()
if !certPool.AppendCertsFromPEM(dcrtimeCert) {
return fmt.Errorf("unable to load cert")
}
}
// Setup backend
log.Infof("Backend: %v", cfg.Backend)
switch cfg.Backend {
case backendGit:
err := p.setupBackendGit(activeNetParams.Params)
if err != nil {
return err
}
case backendTstore:
err := p.setupBackendTstore(activeNetParams.Params)
if err != nil {
return err
}
default:
return fmt.Errorf("invalid backend selected: %v", cfg.Backend)
}
// Bind to a port and pass our router in
listenC := make(chan error)
for _, listener := range cfg.Listeners {
listen := listener
go func() {
s := &http.Server{
Handler: p.router,
Addr: listen,
ReadTimeout: time.Duration(cfg.ReadTimeout) * time.Second,
WriteTimeout: time.Duration(cfg.WriteTimeout) * time.Second,
}
log.Infof("Listen: %v", listen)
listenC <- s.ListenAndServeTLS(cfg.HTTPSCert, cfg.HTTPSKey)
}()
}
// Tell user we are ready to go.
log.Infof("Start of day")
// Setup OS signals
sigs := make(chan os.Signal, 1)
signal.Notify(sigs, syscall.SIGINT, syscall.SIGTERM)
signal.Notify(sigs, syscall.SIGINT, syscall.SIGINT)
for {
select {
case sig := <-sigs:
log.Infof("Terminating with %v", sig)
goto done
case err := <-listenC:
log.Errorf("%v", err)
goto done
}
}
done:
switch p.cfg.Backend {
case backendGit:
p.backend.Close()
case backendTstore:
p.backendv2.Close()
}
log.Infof("Exiting")
return nil
}
func main() {
err := _main()
if err != nil {
fmt.Fprintf(os.Stderr, "%v\n", err)
os.Exit(1)
}
}