forked from privacybydesign/irmago
-
Notifications
You must be signed in to change notification settings - Fork 0
/
server.go
584 lines (520 loc) · 17.6 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
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
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
// Package requestorserver is a server allowing IRMA verifiers, issuers or attribute-based signature
// applications (the requestor) to perform IRMA sessions with irmaclient instances (i.e. the IRMA
// app). It exposes a RESTful protocol with which the requestor can start and manage the session as
// well as HTTP endpoints for the irmaclient.
package requestorserver
import (
"bytes"
"context"
"crypto/tls"
"crypto/x509"
"encoding/json"
"encoding/pem"
"fmt"
"io/ioutil"
"net/http"
"strings"
"time"
"github.com/dgrijalva/jwt-go"
"github.com/go-chi/chi"
"github.com/go-chi/chi/middleware"
"github.com/go-chi/cors"
"github.com/go-errors/errors"
"github.com/privacybydesign/irmago"
"github.com/privacybydesign/irmago/server"
"github.com/privacybydesign/irmago/server/irmaserver"
"github.com/sirupsen/logrus"
)
// Server is a requestor server instance.
type Server struct {
conf *Configuration
irmaserv *irmaserver.Server
stop chan struct{}
stopped chan struct{}
}
// Start the server. If successful then it will not return until Stop() is called.
func (s *Server) Start(config *Configuration) error {
if s.conf.LogJSON {
s.conf.Logger.WithField("configuration", s.conf).Debug("Configuration")
} else {
bts, _ := json.MarshalIndent(s.conf, "", " ")
s.conf.Logger.Debug("Configuration: ", string(bts), "\n")
}
// We start either one or two servers, depending on whether a separate client server is enabled, such that:
// - if any of them returns, the other is also stopped (neither of them is of use without the other)
// - if any of them returns an unexpected error (ie. other than http.ErrServerClosed), the error is logged and returned
// - we have a way of stopping all servers from outside (with Stop())
// - the function returns only after all servers have been stopped
// - any unexpected error is dealt with here instead of when stopping using Stop().
// Inspired by https://dave.cheney.net/practical-go/presentations/qcon-china.html#_never_start_a_goroutine_without_when_it_will_stop
count := 1
if s.conf.separateClientServer() {
count = 2
}
done := make(chan error, count)
s.stop = make(chan struct{})
s.stopped = make(chan struct{}, count)
if s.conf.separateClientServer() {
go func() {
done <- s.startClientServer()
}()
}
go func() {
done <- s.startRequestorServer()
}()
var stopped bool
var err error
for i := 0; i < cap(done); i++ {
if err = <-done; err != nil {
_ = server.LogError(err)
}
if !stopped {
stopped = true
close(s.stop)
}
}
return err
}
func (s *Server) startRequestorServer() error {
tlsConf, _ := s.conf.tlsConfig()
return s.startServer(s.Handler(), "Server", s.conf.ListenAddress, s.conf.Port, tlsConf)
}
func (s *Server) startClientServer() error {
tlsConf, _ := s.conf.clientTlsConfig()
return s.startServer(s.ClientHandler(), "Client server", s.conf.ClientListenAddress, s.conf.ClientPort, tlsConf)
}
func (s *Server) startServer(handler http.Handler, name, addr string, port int, tlsConf *tls.Config) error {
fulladdr := fmt.Sprintf("%s:%d", addr, port)
s.conf.Logger.Info(name, " listening at ", fulladdr)
serv := &http.Server{
Addr: fulladdr,
Handler: handler,
TLSConfig: tlsConf,
}
go func() {
<-s.stop
ctx, cancel := context.WithTimeout(context.Background(), 1*time.Second)
defer cancel()
if err := serv.Shutdown(ctx); err != nil {
_ = server.LogError(err)
}
s.stopped <- struct{}{}
}()
if tlsConf != nil {
// Disable HTTP/2 (see package documentation of http): it breaks server side events :(
serv.TLSNextProto = make(map[string]func(*http.Server, *tls.Conn, http.Handler))
s.conf.Logger.Info(name, " TLS enabled")
return filterStopError(serv.ListenAndServeTLS("", ""))
} else {
return filterStopError(serv.ListenAndServe())
}
}
func filterStopError(err error) error {
if err == http.ErrServerClosed {
return nil
}
return err
}
func (s *Server) Stop() {
s.irmaserv.Stop()
s.stop <- struct{}{}
<-s.stopped
if s.conf.separateClientServer() {
<-s.stopped
}
}
func New(config *Configuration) (*Server, error) {
irmaserv, err := irmaserver.New(config.Configuration)
if err != nil {
return nil, err
}
if err := config.initialize(); err != nil {
return nil, err
}
return &Server{
conf: config,
irmaserv: irmaserv,
}, nil
}
var corsOptions = cors.Options{
AllowedOrigins: []string{"*"},
AllowedHeaders: []string{"Accept", "Authorization", "Content-Type", "Cache-Control"},
AllowedMethods: []string{http.MethodGet, http.MethodPost, http.MethodDelete},
}
func (s *Server) ClientHandler() http.Handler {
router := chi.NewRouter()
router.Use(cors.New(corsOptions).Handler)
s.attachClientEndpoints(router)
return router
}
func (s *Server) attachClientEndpoints(router *chi.Mux) {
router.Mount("/irma/", s.irmaserv.HandlerFunc())
if s.conf.StaticPath != "" {
router.Mount(s.conf.StaticPrefix, s.StaticFilesHandler())
}
router.Group(func(r chi.Router) {
if s.conf.Verbose >= 2 {
r.Use(s.logHandler("staticsession", true, true, true))
}
r.Post("/irma/session/{name}", s.handleCreateStatic)
})
}
// Handler returns a http.Handler that handles all IRMA requestor messages
// and IRMA client messages.
func (s *Server) Handler() http.Handler {
router := chi.NewRouter()
router.Use(cors.New(corsOptions).Handler)
if !s.conf.separateClientServer() {
// Mount server for irmaclient
s.attachClientEndpoints(router)
}
router.NotFound(s.logHandler("requestor", false, true, true)(router.NotFoundHandler()).ServeHTTP)
router.MethodNotAllowed(s.logHandler("requestor", false, true, true)(router.MethodNotAllowedHandler()).ServeHTTP)
// Group main API endpoints, so we can attach our request/response logger to it
// while not adding it to the endpoints already added above (which do their own logging).
router.Group(func(r chi.Router) {
r.Use(cors.New(corsOptions).Handler)
if s.conf.Verbose >= 2 {
r.Use(s.logHandler("requestor", true, true, true))
}
// Server routes
r.Post("/session", s.handleCreate)
r.Delete("/session/{token}", s.handleDelete)
r.Get("/session/{token}/status", s.handleStatus)
r.Get("/session/{token}/statusevents", s.handleStatusEvents)
r.Get("/session/{token}/result", s.handleResult)
// Routes for getting signed JWTs containing the session result. Only work if configuration has a private key
r.Get("/session/{token}/result-jwt", s.handleJwtResult)
r.Get("/session/{token}/getproof", s.handleJwtProofs) // irma_api_server-compatible JWT
r.Get("/publickey", s.handlePublicKey)
})
return router
}
// logHandler is middleware for logging HTTP requests and responses.
func (s *Server) logHandler(typ string, logResponse, logHeaders, logFrom bool) func(next http.Handler) http.Handler {
return func(next http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
var message []byte
var err error
// Read r.Body, and then replace with a fresh ReadCloser for the next handler
if message, err = ioutil.ReadAll(r.Body); err != nil {
message = []byte("<failed to read body: " + err.Error() + ">")
}
_ = r.Body.Close()
r.Body = ioutil.NopCloser(bytes.NewBuffer(message))
var headers http.Header
var from string
if logHeaders {
headers = r.Header
}
if logFrom {
from = r.RemoteAddr
}
server.LogRequest(typ, r.Method, r.URL.String(), from, headers, message)
// copy output of HTTP handler to our buffer for later logging
ww := middleware.NewWrapResponseWriter(w, r.ProtoMajor)
var buf *bytes.Buffer
if logResponse {
buf = new(bytes.Buffer)
ww.Tee(buf)
}
// print response afterwards
var resp []byte
var start time.Time
defer func() {
if logResponse && ww.BytesWritten() > 0 {
resp = buf.Bytes()
}
server.LogResponse(ww.Status(), time.Since(start), resp)
}()
// start timer and preform request
start = time.Now()
next.ServeHTTP(ww, r)
})
}
}
func (s *Server) StaticFilesHandler() http.Handler {
if len(s.conf.URL) > 6 {
url := s.conf.URL[:len(s.conf.URL)-6] + s.conf.StaticPrefix
s.conf.Logger.Infof("Hosting files at %s under %s", s.conf.StaticPath, url)
} else { // URL not known, don't log it but otherwise continue
s.conf.Logger.Infof("Hosting files at %s", s.conf.StaticPath)
}
return http.StripPrefix(s.conf.StaticPrefix, s.logHandler("static", false, false, false)(
http.FileServer(http.Dir(s.conf.StaticPath))),
)
}
func (s *Server) handleCreate(w http.ResponseWriter, r *http.Request) {
body, err := ioutil.ReadAll(r.Body)
if err != nil {
s.conf.Logger.Error("Could not read session request HTTP POST body")
_ = server.LogError(err)
server.WriteError(w, server.ErrorInvalidRequest, err.Error())
return
}
// Authenticate request: check if the requestor is known and allowed to submit requests.
// We do this by feeding the HTTP POST details to all known authenticators, and see if
// one of them is applicable and able to authenticate the request.
var (
rrequest irma.RequestorRequest
request irma.SessionRequest
requestor string
rerr *irma.RemoteError
applies bool
)
for _, authenticator := range authenticators { // rrequest abbreviates "requestor request"
applies, rrequest, requestor, rerr = authenticator.Authenticate(r.Header, body)
if applies || rerr != nil {
break
}
}
if rerr != nil {
_ = server.LogError(rerr)
server.WriteResponse(w, nil, rerr)
return
}
if !applies {
s.conf.Logger.Warnf("Session request uses unknown authentication method, HTTP headers: %s, HTTP POST body: %s",
server.ToJson(r.Header), string(body))
server.WriteError(w, server.ErrorInvalidRequest, "Request could not be authorized")
return
}
// Authorize request: check if the requestor is allowed to verify or issue
// the requested attributes or credentials
request = rrequest.SessionRequest()
if request.Action() == irma.ActionIssuing {
allowed, reason := s.conf.CanIssue(requestor, request.(*irma.IssuanceRequest).Credentials)
if !allowed {
s.conf.Logger.WithFields(logrus.Fields{"requestor": requestor, "id": reason}).
Warn("Requestor not authorized to issue credential; full request: ", server.ToJson(request))
server.WriteError(w, server.ErrorUnauthorized, reason)
return
}
}
condiscon := request.Disclosure().Disclose
if len(condiscon) > 0 {
allowed, reason := s.conf.CanVerifyOrSign(requestor, request.Action(), condiscon)
if !allowed {
s.conf.Logger.WithFields(logrus.Fields{"requestor": requestor, "id": reason}).
Warn("Requestor not authorized to verify attribute; full request: ", server.ToJson(request))
server.WriteError(w, server.ErrorUnauthorized, reason)
return
}
}
if rrequest.Base().CallbackUrl != "" && s.conf.jwtPrivateKey == nil {
s.conf.Logger.WithFields(logrus.Fields{"requestor": requestor}).Warn("Requestor provided callbackUrl but no JWT private key is installed")
server.WriteError(w, server.ErrorUnsupported, "")
return
}
// Everything is authenticated and parsed, we're good to go!
qr, token, err := s.irmaserv.StartSession(rrequest, s.doResultCallback)
if err != nil {
server.WriteError(w, server.ErrorInvalidRequest, err.Error())
return
}
server.WriteJson(w, server.SessionPackage{
SessionPtr: qr,
Token: token,
})
}
func (s *Server) handleCreateStatic(w http.ResponseWriter, r *http.Request) {
name := chi.URLParam(r, "name")
rrequest := s.conf.staticSessions[name]
if rrequest == nil {
server.WriteError(w, server.ErrorInvalidRequest, "unknown static session")
return
}
qr, _, err := s.irmaserv.StartSession(rrequest, s.doResultCallback)
if err != nil {
server.WriteError(w, server.ErrorInvalidRequest, err.Error())
return
}
server.WriteJson(w, qr)
}
func (s *Server) handleStatus(w http.ResponseWriter, r *http.Request) {
res := s.irmaserv.GetSessionResult(chi.URLParam(r, "token"))
if res == nil {
server.WriteError(w, server.ErrorSessionUnknown, "")
return
}
server.WriteJson(w, res.Status)
}
func (s *Server) handleStatusEvents(w http.ResponseWriter, r *http.Request) {
token := chi.URLParam(r, "token")
s.conf.Logger.WithFields(logrus.Fields{"session": token}).Debug("new client subscribed to server sent events")
if err := s.irmaserv.SubscribeServerSentEvents(w, r, token, true); err != nil {
server.WriteResponse(w, nil, &irma.RemoteError{
Status: server.ErrorUnsupported.Status,
ErrorName: string(server.ErrorUnsupported.Type),
Description: server.ErrorUnsupported.Description,
})
}
}
func (s *Server) handleDelete(w http.ResponseWriter, r *http.Request) {
err := s.irmaserv.CancelSession(chi.URLParam(r, "token"))
if err != nil {
server.WriteError(w, server.ErrorSessionUnknown, "")
}
}
func (s *Server) handleResult(w http.ResponseWriter, r *http.Request) {
res := s.irmaserv.GetSessionResult(chi.URLParam(r, "token"))
if res == nil {
server.WriteError(w, server.ErrorSessionUnknown, "")
return
}
if res.LegacySession {
server.WriteJson(w, res.Legacy())
} else {
server.WriteJson(w, res)
}
}
func (s *Server) handleJwtResult(w http.ResponseWriter, r *http.Request) {
if s.conf.jwtPrivateKey == nil {
s.conf.Logger.Warn("Session result JWT requested but no JWT private key is configured")
server.WriteError(w, server.ErrorUnknown, "JWT signing not supported")
return
}
sessiontoken := chi.URLParam(r, "token")
res := s.irmaserv.GetSessionResult(sessiontoken)
if res == nil {
server.WriteError(w, server.ErrorSessionUnknown, "")
return
}
j, err := s.resultJwt(res)
if err != nil {
s.conf.Logger.Error("Failed to sign session result JWT")
_ = server.LogError(err)
server.WriteError(w, server.ErrorUnknown, err.Error())
return
}
server.WriteString(w, j)
}
func (s *Server) handleJwtProofs(w http.ResponseWriter, r *http.Request) {
if s.conf.jwtPrivateKey == nil {
s.conf.Logger.Warn("Session result JWT requested but no JWT private key is configured")
server.WriteError(w, server.ErrorUnknown, "JWT signing not supported")
return
}
sessiontoken := chi.URLParam(r, "token")
res := s.irmaserv.GetSessionResult(sessiontoken)
if res == nil {
server.WriteError(w, server.ErrorSessionUnknown, "")
return
}
claims := jwt.MapClaims{}
// Fill standard claims
switch res.Type {
case irma.ActionDisclosing:
claims["sub"] = "disclosure_result"
case irma.ActionSigning:
claims["sub"] = "abs_result"
case irma.ActionIssuing:
claims["sub"] = "issue_result"
default:
server.WriteError(w, server.ErrorInvalidRequest, "")
return
}
claims["iat"] = time.Now().Unix()
if s.conf.JwtIssuer != "" {
claims["iss"] = s.conf.JwtIssuer
}
claims["status"] = res.ProofStatus
validity := s.irmaserv.GetRequest(sessiontoken).Base().ResultJwtValidity
if validity != 0 {
claims["exp"] = time.Now().Unix() + int64(validity)
}
// Disclosed credentials and possibly signature
m := make(map[irma.AttributeTypeIdentifier]string, len(res.Disclosed))
for _, set := range res.Disclosed {
for _, attr := range set {
m[attr.Identifier] = attr.Value[""]
}
}
claims["attributes"] = m
if res.Signature != nil {
claims["signature"] = res.Signature
}
// Sign the jwt and return it
token := jwt.NewWithClaims(jwt.SigningMethodRS256, claims)
resultJwt, err := token.SignedString(s.conf.jwtPrivateKey)
if err != nil {
s.conf.Logger.Error("Failed to sign session result JWT")
_ = server.LogError(err)
server.WriteError(w, server.ErrorUnknown, err.Error())
return
}
server.WriteString(w, resultJwt)
}
func (s *Server) handlePublicKey(w http.ResponseWriter, r *http.Request) {
if s.conf.jwtPrivateKey == nil {
server.WriteError(w, server.ErrorUnsupported, "")
return
}
bts, err := x509.MarshalPKIXPublicKey(&s.conf.jwtPrivateKey.PublicKey)
if err != nil {
server.WriteError(w, server.ErrorUnknown, err.Error())
return
}
pubBytes := pem.EncodeToMemory(&pem.Block{
Type: "PUBLIC KEY",
Bytes: bts,
})
_, _ = w.Write(pubBytes)
}
func (s *Server) resultJwt(sessionresult *server.SessionResult) (string, error) {
standardclaims := jwt.StandardClaims{
Issuer: s.conf.JwtIssuer,
IssuedAt: time.Now().Unix(),
Subject: string(sessionresult.Type) + "_result",
}
validity := s.irmaserv.GetRequest(sessionresult.Token).Base().ResultJwtValidity
standardclaims.ExpiresAt = time.Now().Unix() + int64(validity)
var claims jwt.Claims
if sessionresult.LegacySession {
claims = struct {
jwt.StandardClaims
*server.LegacySessionResult
}{standardclaims, sessionresult.Legacy()}
} else {
claims = struct {
jwt.StandardClaims
*server.SessionResult
}{standardclaims, sessionresult}
}
// Sign the jwt and return it
token := jwt.NewWithClaims(jwt.SigningMethodRS256, claims)
return token.SignedString(s.conf.jwtPrivateKey)
}
func (s *Server) doResultCallback(result *server.SessionResult) {
callbackUrl := s.irmaserv.GetRequest(result.Token).Base().CallbackUrl
if callbackUrl == "" {
return
}
logger := s.conf.Logger.WithFields(logrus.Fields{"session": result.Token, "callbackUrl": callbackUrl})
if !strings.HasPrefix(callbackUrl, "https") {
logger.Warn("POSTing session result to callback URL without TLS: attributes are unencrypted in traffic")
} else {
logger.Debug("POSTing session result")
}
var res string
if s.conf.jwtPrivateKey != nil {
var err error
res, err = s.resultJwt(result)
if err != nil {
_ = server.LogError(errors.WrapPrefix(err, "Failed to create JWT for result callback", 0))
return
}
} else {
bts, err := json.Marshal(result)
if err != nil {
_ = server.LogError(errors.WrapPrefix(err, "Failed to marshal session result for result callback", 0))
return
}
res = string(bts)
}
var x string // dummy for the server's return value that we don't care about
if err := irma.NewHTTPTransport(callbackUrl).Post("", &x, res); err != nil {
// not our problem, log it and go on
logger.Warn(errors.WrapPrefix(err, "Failed to POST session result to callback URL", 0))
}
}