server.go 15.6 KB
Newer Older
Sietse Ringers's avatar
Sietse Ringers committed
1
// Package requestorserver is a server allowing IRMA verifiers, issuers or attribute-based signature
Sietse Ringers's avatar
Sietse Ringers committed
2 3 4
// 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.
Sietse Ringers's avatar
Sietse Ringers committed
5
package requestorserver
6 7

import (
8
	"bytes"
9
	"context"
Sietse Ringers's avatar
Sietse Ringers committed
10
	"crypto/tls"
11
	"crypto/x509"
Sietse Ringers's avatar
Sietse Ringers committed
12
	"encoding/json"
13
	"encoding/pem"
14
	"fmt"
15
	"io/ioutil"
16
	"log"
17
	"net/http"
18
	"strings"
19
	"time"
20

21
	"github.com/dgrijalva/jwt-go"
22
	"github.com/go-chi/chi"
23
	"github.com/go-chi/chi/middleware"
Sietse Ringers's avatar
Sietse Ringers committed
24
	"github.com/go-chi/cors"
25
	"github.com/go-errors/errors"
26
	"github.com/privacybydesign/irmago"
Sietse Ringers's avatar
Sietse Ringers committed
27
	"github.com/privacybydesign/irmago/server"
28
	"github.com/privacybydesign/irmago/server/irmaserver"
29
	"github.com/sirupsen/logrus"
30 31
)

Sietse Ringers's avatar
Sietse Ringers committed
32
// Server is a requestor server instance.
33
type Server struct {
34 35 36
	conf     *Configuration
	irmaserv *irmaserver.Server
	stop     chan struct{}
37
	stopped  chan struct{}
38
}
39

40
// Start the server. If successful then it will not return until Stop() is called.
41 42 43
func (s *Server) Start(config *Configuration) error {
	if s.conf.LogJSON {
		s.conf.Logger.WithField("configuration", s.conf).Debug("Configuration")
44
	} else {
45 46
		bts, _ := json.MarshalIndent(s.conf, "", "   ")
		s.conf.Logger.Debug("Configuration: ", string(bts), "\n")
47
	}
48

49 50 51 52 53 54 55 56 57
	// 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
58
	if s.conf.separateClientServer() {
59
		count = 2
60
	}
61 62
	done := make(chan error, count)
	s.stop = make(chan struct{})
63
	s.stopped = make(chan struct{}, count)
64

65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86
	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
87 88
}

89
func (s *Server) startRequestorServer() error {
90
	tlsConf, _ := s.conf.tlsConfig()
91
	return s.startServer(s.Handler(), "Server", s.conf.ListenAddress, s.conf.Port, tlsConf)
92 93
}

94
func (s *Server) startClientServer() error {
95
	tlsConf, _ := s.conf.clientTlsConfig()
96
	return s.startServer(s.ClientHandler(), "Client server", s.conf.ClientListenAddress, s.conf.ClientPort, tlsConf)
97 98
}

99
func (s *Server) startServer(handler http.Handler, name, addr string, port int, tlsConf *tls.Config) error {
100
	fulladdr := fmt.Sprintf("%s:%d", addr, port)
101
	s.conf.Logger.Info(name, " listening at ", fulladdr)
102 103 104 105 106 107 108 109 110

	serv := &http.Server{
		Addr:      fulladdr,
		Handler:   handler,
		TLSConfig: tlsConf,
	}

	go func() {
		<-s.stop
111 112 113
		ctx, cancel := context.WithTimeout(context.Background(), 1*time.Second)
		defer cancel()
		if err := serv.Shutdown(ctx); err != nil {
114 115
			_ = server.LogError(err)
		}
116
		s.stopped <- struct{}{}
117 118
	}()

Sietse Ringers's avatar
Sietse Ringers committed
119
	if tlsConf != nil {
120
		// Disable HTTP/2 (see package documentation of http): it breaks server side events :(
121 122
		serv.TLSNextProto = make(map[string]func(*http.Server, *tls.Conn, http.Handler))
		s.conf.Logger.Info(name, " TLS enabled")
123
		return filterStopError(serv.ListenAndServeTLS("", ""))
Sietse Ringers's avatar
Sietse Ringers committed
124
	} else {
125
		return filterStopError(serv.ListenAndServe())
126 127 128
	}
}

129 130 131
func filterStopError(err error) error {
	if err == http.ErrServerClosed {
		return nil
132
	}
133 134
	return err
}
135

136 137 138
func (s *Server) Stop() {
	s.irmaserv.Stop()
	s.stop <- struct{}{}
139 140 141 142
	<-s.stopped
	if s.conf.separateClientServer() {
		<-s.stopped
	}
143 144
}

145
func New(config *Configuration) (*Server, error) {
146
	irmaserv, err := irmaserver.New(config.Configuration)
147 148
	if err != nil {
		return nil, err
149
	}
150 151
	if err := config.initialize(); err != nil {
		return nil, err
152
	}
153 154 155 156
	return &Server{
		conf:     config,
		irmaserv: irmaserv,
	}, nil
157
}
158

159 160 161 162 163 164
var corsOptions = cors.Options{
	AllowedOrigins: []string{"*"},
	AllowedHeaders: []string{"Accept", "Authorization", "Content-Type", "Cache-Control"},
	AllowedMethods: []string{http.MethodGet, http.MethodPost, http.MethodDelete},
}

165
func (s *Server) ClientHandler() http.Handler {
166
	router := chi.NewRouter()
167
	router.Use(cors.New(corsOptions).Handler)
Sietse Ringers's avatar
Sietse Ringers committed
168

Sietse Ringers's avatar
Sietse Ringers committed
169
	router.Mount("/irma/", s.irmaserv.HandlerFunc())
170
	if s.conf.StaticPath != "" {
171
		router.Mount(s.conf.StaticPrefix, s.StaticFilesHandler())
172 173
	}

174 175 176 177 178
	return router
}

// Handler returns a http.Handler that handles all IRMA requestor messages
// and IRMA client messages.
179
func (s *Server) Handler() http.Handler {
180
	router := chi.NewRouter()
181
	router.Use(cors.New(corsOptions).Handler)
182 183 184
	if s.conf.Verbose >= 2 {
		router.Use(s.logHandler)
	}
185

186
	if !s.conf.separateClientServer() {
187
		// Mount server for irmaclient
Sietse Ringers's avatar
Sietse Ringers committed
188
		router.Mount("/irma/", s.irmaserv.HandlerFunc())
189 190 191
		if s.conf.StaticPath != "" {
			router.Mount(s.conf.StaticPrefix, s.StaticFilesHandler())
		}
192
	}
193

194
	// Server routes
195 196 197 198 199
	router.Post("/session", s.handleCreate)
	router.Delete("/session/{token}", s.handleDelete)
	router.Get("/session/{token}/status", s.handleStatus)
	router.Get("/session/{token}/statusevents", s.handleStatusEvents)
	router.Get("/session/{token}/result", s.handleResult)
Sietse Ringers's avatar
Sietse Ringers committed
200 201

	// Routes for getting signed JWTs containing the session result. Only work if configuration has a private key
202 203
	router.Get("/session/{token}/result-jwt", s.handleJwtResult)
	router.Get("/session/{token}/getproof", s.handleJwtProofs) // irma_api_server-compatible JWT
204

205
	router.Get("/publickey", s.handlePublicKey)
206

207
	return router
208 209
}

210
// logHandler is middleware for logging HTTP requests and responses.
211 212
func (s *Server) logHandler(next http.Handler) http.Handler {
	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
213 214 215 216 217
		// /irma/ is handled by the servercore library which does its own logging of these endpoints
		if strings.HasPrefix(r.URL.EscapedPath(), "/irma/") {
			next.ServeHTTP(w, r)
			return
		}
218

219 220 221 222 223 224 225 226 227 228 229 230 231
		server.LogRequest(r.Method, r.URL.EscapedPath(), r.Proto, r.RemoteAddr, r.Header)

		// copy output of HTTP handler to our buffer for later logging
		ww := middleware.NewWrapResponseWriter(w, r.ProtoMajor)
		respBuf := new(bytes.Buffer)
		ww.Tee(respBuf)

		// print response after HTTP is served
		start := time.Now()
		defer func() {
			var resp []byte
			if ww.BytesWritten() > 0 {
				resp = respBuf.Bytes()
232
			}
233 234
			server.LogResponse(ww.Status(), time.Since(start), resp)
		}()
235 236 237 238 239 240

		next.ServeHTTP(ww, r)
		return
	})
}

241
func (s *Server) StaticFilesHandler() http.Handler {
242 243 244 245 246 247
	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)
	}
248 249 250 251 252 253 254 255
	// Hook up chi middleware logger with our own logger
	middleware.DefaultLogger = middleware.RequestLogger(&middleware.DefaultLogFormatter{
		Logger:  log.New(s.conf.Logger.WriterLevel(logrus.TraceLevel), "static: ", 0),
		NoColor: true,
	})
	return http.StripPrefix(s.conf.StaticPrefix, middleware.Logger(http.FileServer(http.Dir(s.conf.StaticPath))))
}

256
func (s *Server) handleCreate(w http.ResponseWriter, r *http.Request) {
257 258
	body, err := ioutil.ReadAll(r.Body)
	if err != nil {
259
		s.conf.Logger.Error("Could not read session request HTTP POST body")
260
		_ = server.LogError(err)
Sietse Ringers's avatar
Sietse Ringers committed
261
		server.WriteError(w, server.ErrorInvalidRequest, err.Error())
262 263
		return
	}
264

Sietse Ringers's avatar
Sietse Ringers committed
265 266 267
	// 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.
268
	var (
269
		rrequest  irma.RequestorRequest
270 271 272 273 274
		request   irma.SessionRequest
		requestor string
		rerr      *irma.RemoteError
		applies   bool
	)
Sietse Ringers's avatar
Sietse Ringers committed
275
	for _, authenticator := range authenticators { // rrequest abbreviates "requestor request"
276
		applies, rrequest, requestor, rerr = authenticator.Authenticate(r.Header, body)
277 278 279 280 281
		if applies || rerr != nil {
			break
		}
	}
	if rerr != nil {
282
		_ = server.LogError(rerr)
283 284 285 286
		server.WriteResponse(w, nil, rerr)
		return
	}
	if !applies {
287
		s.conf.Logger.Warnf("Session request uses unknown authentication method, HTTP headers: %s, HTTP POST body: %s",
288
			server.ToJson(r.Header), string(body))
Sietse Ringers's avatar
Sietse Ringers committed
289
		server.WriteError(w, server.ErrorInvalidRequest, "Request could not be authorized")
290 291 292
		return
	}

293 294
	// Authorize request: check if the requestor is allowed to verify or issue
	// the requested attributes or credentials
295
	request = rrequest.SessionRequest()
296
	if request.Action() == irma.ActionIssuing {
297
		allowed, reason := s.conf.CanIssue(requestor, request.(*irma.IssuanceRequest).Credentials)
298
		if !allowed {
299
			s.conf.Logger.WithFields(logrus.Fields{"requestor": requestor, "id": reason}).
300
				Warn("Requestor not authorized to issue credential; full request: ", server.ToJson(request))
301 302 303 304
			server.WriteError(w, server.ErrorUnauthorized, reason)
			return
		}
	}
305 306 307
	condiscon := request.Disclosure().Disclose
	if len(condiscon) > 0 {
		allowed, reason := s.conf.CanVerifyOrSign(requestor, request.Action(), condiscon)
308
		if !allowed {
309
			s.conf.Logger.WithFields(logrus.Fields{"requestor": requestor, "id": reason}).
310
				Warn("Requestor not authorized to verify attribute; full request: ", server.ToJson(request))
311 312 313 314
			server.WriteError(w, server.ErrorUnauthorized, reason)
			return
		}
	}
315 316
	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")
317 318 319
		server.WriteError(w, server.ErrorUnsupported, "")
		return
	}
320 321

	// Everything is authenticated and parsed, we're good to go!
322
	qr, token, err := s.irmaserv.StartSession(rrequest, s.doResultCallback)
323
	if err != nil {
Sietse Ringers's avatar
Sietse Ringers committed
324
		server.WriteError(w, server.ErrorInvalidRequest, err.Error())
325 326 327
		return
	}

328 329 330 331
	server.WriteJson(w, server.SessionPackage{
		SessionPtr: qr,
		Token:      token,
	})
332 333
}

334 335
func (s *Server) handleStatus(w http.ResponseWriter, r *http.Request) {
	res := s.irmaserv.GetSessionResult(chi.URLParam(r, "token"))
336
	if res == nil {
Sietse Ringers's avatar
Sietse Ringers committed
337
		server.WriteError(w, server.ErrorSessionUnknown, "")
338 339
		return
	}
Sietse Ringers's avatar
Sietse Ringers committed
340
	server.WriteJson(w, res.Status)
341 342
}

343
func (s *Server) handleStatusEvents(w http.ResponseWriter, r *http.Request) {
344
	token := chi.URLParam(r, "token")
345
	s.conf.Logger.WithFields(logrus.Fields{"session": token}).Debug("new client subscribed to server sent events")
346
	if err := s.irmaserv.SubscribeServerSentEvents(w, r, token, true); err != nil {
347 348 349 350 351
		server.WriteResponse(w, nil, &irma.RemoteError{
			Status:      server.ErrorUnsupported.Status,
			ErrorName:   string(server.ErrorUnsupported.Type),
			Description: server.ErrorUnsupported.Description,
		})
352 353 354
	}
}

355 356
func (s *Server) handleDelete(w http.ResponseWriter, r *http.Request) {
	err := s.irmaserv.CancelSession(chi.URLParam(r, "token"))
357 358 359 360 361
	if err != nil {
		server.WriteError(w, server.ErrorSessionUnknown, "")
	}
}

362 363
func (s *Server) handleResult(w http.ResponseWriter, r *http.Request) {
	res := s.irmaserv.GetSessionResult(chi.URLParam(r, "token"))
364
	if res == nil {
Sietse Ringers's avatar
Sietse Ringers committed
365
		server.WriteError(w, server.ErrorSessionUnknown, "")
366 367
		return
	}
Sietse Ringers's avatar
Sietse Ringers committed
368
	server.WriteJson(w, res)
369 370
}

371 372 373
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")
374 375
		server.WriteError(w, server.ErrorUnknown, "JWT signing not supported")
		return
376
	}
377

378
	sessiontoken := chi.URLParam(r, "token")
379
	res := s.irmaserv.GetSessionResult(sessiontoken)
380 381 382
	if res == nil {
		server.WriteError(w, server.ErrorSessionUnknown, "")
		return
383
	}
384

385
	j, err := s.resultJwt(res)
386
	if err != nil {
387
		s.conf.Logger.Error("Failed to sign session result JWT")
388
		_ = server.LogError(err)
389 390 391
		server.WriteError(w, server.ErrorUnknown, err.Error())
		return
	}
392
	server.WriteString(w, j)
393 394
}

395 396 397
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")
398 399 400 401
		server.WriteError(w, server.ErrorUnknown, "JWT signing not supported")
		return
	}

402
	sessiontoken := chi.URLParam(r, "token")
403
	res := s.irmaserv.GetSessionResult(sessiontoken)
404 405 406 407 408 409 410 411 412 413
	if res == nil {
		server.WriteError(w, server.ErrorSessionUnknown, "")
		return
	}

	claims := jwt.MapClaims{}

	// Fill standard claims
	switch res.Type {
	case irma.ActionDisclosing:
414
		claims["sub"] = "disclosure_result"
415
	case irma.ActionSigning:
416
		claims["sub"] = "abs_result"
417
	default:
418 419
		server.WriteError(w, server.ErrorInvalidRequest, "")
		return
420 421
	}
	claims["iat"] = time.Now().Unix()
422 423
	if s.conf.JwtIssuer != "" {
		claims["iss"] = s.conf.JwtIssuer
424
	}
425
	claims["status"] = res.ProofStatus
426
	validity := s.irmaserv.GetRequest(sessiontoken).Base().ResultJwtValidity
427 428 429
	if validity != 0 {
		claims["exp"] = time.Now().Unix() + int64(validity)
	}
430 431 432

	// Disclosed credentials and possibly signature
	m := make(map[irma.AttributeTypeIdentifier]string, len(res.Disclosed))
433 434 435 436
	for _, set := range res.Disclosed {
		for _, attr := range set {
			m[attr.Identifier] = attr.Value[""]
		}
437 438 439 440 441 442 443 444
	}
	claims["attributes"] = m
	if res.Signature != nil {
		claims["signature"] = res.Signature
	}

	// Sign the jwt and return it
	token := jwt.NewWithClaims(jwt.SigningMethodRS256, claims)
445
	resultJwt, err := token.SignedString(s.conf.jwtPrivateKey)
446
	if err != nil {
447
		s.conf.Logger.Error("Failed to sign session result JWT")
448
		_ = server.LogError(err)
449 450
		server.WriteError(w, server.ErrorUnknown, err.Error())
		return
451
	}
452
	server.WriteString(w, resultJwt)
453
}
454

455 456
func (s *Server) handlePublicKey(w http.ResponseWriter, r *http.Request) {
	if s.conf.jwtPrivateKey == nil {
457 458 459 460
		server.WriteError(w, server.ErrorUnsupported, "")
		return
	}

461
	bts, err := x509.MarshalPKIXPublicKey(&s.conf.jwtPrivateKey.PublicKey)
462 463 464 465 466 467 468 469 470 471
	if err != nil {
		server.WriteError(w, server.ErrorUnknown, err.Error())
		return
	}
	pubBytes := pem.EncodeToMemory(&pem.Block{
		Type:  "PUBLIC KEY",
		Bytes: bts,
	})
	_, _ = w.Write(pubBytes)
}
472

473
func (s *Server) resultJwt(sessionresult *server.SessionResult) (string, error) {
474 475 476 477 478
	claims := struct {
		jwt.StandardClaims
		*server.SessionResult
	}{
		StandardClaims: jwt.StandardClaims{
479
			Issuer:   s.conf.JwtIssuer,
480 481 482 483 484
			IssuedAt: time.Now().Unix(),
			Subject:  string(sessionresult.Type) + "_result",
		},
		SessionResult: sessionresult,
	}
485
	validity := s.irmaserv.GetRequest(sessionresult.Token).Base().ResultJwtValidity
486 487 488 489 490 491
	if validity != 0 {
		claims.ExpiresAt = time.Now().Unix() + int64(validity)
	}

	// Sign the jwt and return it
	token := jwt.NewWithClaims(jwt.SigningMethodRS256, claims)
492
	return token.SignedString(s.conf.jwtPrivateKey)
493 494
}

495 496 497
func (s *Server) doResultCallback(result *server.SessionResult) {
	callbackUrl := s.irmaserv.GetRequest(result.Token).Base().CallbackUrl
	if callbackUrl == "" || s.conf.jwtPrivateKey == nil {
498 499
		return
	}
500
	s.conf.Logger.WithFields(logrus.Fields{"session": result.Token, "callbackUrl": callbackUrl}).Debug("POSTing session result")
501

502
	j, err := s.resultJwt(result)
503 504 505 506 507 508 509 510
	if err != nil {
		_ = server.LogError(errors.WrapPrefix(err, "Failed to create JWT for result callback", 0))
		return
	}

	var x string // dummy for the server's return value that we don't care about
	if err := irma.NewHTTPTransport(callbackUrl).Post("", &x, j); err != nil {
		// not our problem, log it and go on
511
		s.conf.Logger.Warn(errors.WrapPrefix(err, "Failed to POST session result to callback URL", 0))
512 513
	}
}