api.go 14.7 KB
Newer Older
Sietse Ringers's avatar
Sietse Ringers committed
1
// Package servercore is the core of the IRMA server library, allowing IRMA verifiers, issuers
2 3
// or attribute-based signature applications to perform IRMA sessions with irmaclient instances
// (i.e. the IRMA app). It exposes a small interface to expose to other programming languages
Sietse Ringers's avatar
Sietse Ringers committed
4
// through cgo. It is used by the irmaserver package but otherwise not meant for use in Go.
5
package servercore
6 7 8

import (
	"encoding/json"
9
	"io/ioutil"
10
	"net/http"
11
	"path/filepath"
12
	"regexp"
13
	"strings"
14
	"time"
15 16

	"github.com/go-errors/errors"
17
	"github.com/jasonlvhit/gocron"
18 19
	"github.com/privacybydesign/gabi"
	"github.com/privacybydesign/gabi/big"
20
	"github.com/privacybydesign/irmago"
21
	"github.com/privacybydesign/irmago/internal/fs"
Sietse Ringers's avatar
Sietse Ringers committed
22
	"github.com/privacybydesign/irmago/server"
23
	"github.com/sirupsen/logrus"
24 25
)

26
type Server struct {
27 28 29 30
	conf          *server.Configuration
	sessions      sessionStore
	scheduler     *gocron.Scheduler
	stopScheduler chan bool
31 32 33 34 35 36 37
}

func New(conf *server.Configuration) (*Server, error) {
	s := &Server{
		conf:      conf,
		scheduler: gocron.NewScheduler(),
		sessions: &memorySessionStore{
38 39 40
			requestor: make(map[string]*session),
			client:    make(map[string]*session),
			conf:      conf,
41 42 43 44 45
		},
	}
	s.scheduler.Every(10).Seconds().Do(func() {
		s.sessions.deleteExpired()
	})
46
	s.stopScheduler = s.scheduler.Start()
47 48 49

	return s, s.verifyConfiguration(s.conf)
}
50

51 52 53 54 55
func (s *Server) Stop() {
	s.stopScheduler <- true
	s.sessions.stop()
}

56 57
func (s *Server) verifyConfiguration(configuration *server.Configuration) error {
	if s.conf.Logger == nil {
58
		s.conf.Logger = server.NewLogger(s.conf.Verbose, s.conf.Quiet, s.conf.LogJSON)
59
	}
60 61
	server.Logger = s.conf.Logger
	irma.Logger = s.conf.Logger
62

63
	if s.conf.IrmaConfiguration == nil {
64 65 66 67 68 69 70 71 72 73 74
		var (
			err    error
			exists bool
		)
		if s.conf.SchemesPath == "" {
			s.conf.SchemesPath = server.DefaultSchemesPath() // Returns an existing path
		}
		if exists, err = fs.PathExists(s.conf.SchemesPath); err != nil {
			return server.LogError(err)
		}
		if !exists {
75
			return server.LogError(errors.Errorf("Nonexisting schemes_path provided: %s", s.conf.SchemesPath))
76
		}
77
		s.conf.Logger.WithField("schemes_path", s.conf.SchemesPath).Info("Determined schemes path")
78 79
		if s.conf.SchemesAssetsPath == "" {
			s.conf.IrmaConfiguration, err = irma.NewConfiguration(s.conf.SchemesPath)
80
		} else {
81
			s.conf.IrmaConfiguration, err = irma.NewConfigurationFromAssets(s.conf.SchemesPath, s.conf.SchemesAssetsPath)
82
		}
83
		if err != nil {
84
			return server.LogError(err)
85
		}
86
		if err = s.conf.IrmaConfiguration.ParseFolder(); err != nil {
87
			return server.LogError(err)
88 89 90
		}
	}

91
	if len(s.conf.IrmaConfiguration.SchemeManagers) == 0 {
92 93 94
		s.conf.Logger.Infof("No schemes found in %s, downloading default (irma-demo and pbdf)", s.conf.SchemesPath)
		if err := s.conf.IrmaConfiguration.DownloadDefaultSchemes(); err != nil {
			return server.LogError(err)
95
		}
96
	}
97

98
	if !s.conf.DisableSchemesUpdate {
99 100 101
		if s.conf.SchemesUpdateInterval == 0 {
			s.conf.SchemesUpdateInterval = 60
		}
102
		s.conf.IrmaConfiguration.AutoUpdateSchemes(uint(s.conf.SchemesUpdateInterval))
103 104
	} else {
		s.conf.SchemesUpdateInterval = 0
Sietse Ringers's avatar
Sietse Ringers committed
105 106
	}

107 108
	if s.conf.IssuerPrivateKeys == nil {
		s.conf.IssuerPrivateKeys = make(map[irma.IssuerIdentifier]*gabi.PrivateKey)
109
	}
110 111
	if s.conf.IssuerPrivateKeysPath != "" {
		files, err := ioutil.ReadDir(s.conf.IssuerPrivateKeysPath)
112
		if err != nil {
113
			return server.LogError(err)
114 115 116
		}
		for _, file := range files {
			filename := file.Name()
117 118
			if filepath.Ext(filename) != ".xml" || filename[0] == '.' || strings.Count(filename, ".") != 2 {
				s.conf.Logger.WithField("file", filename).Infof("Skipping non-private key file encountered in private keys path")
119 120
				continue
			}
121
			issid := irma.NewIssuerIdentifier(strings.TrimSuffix(filename, filepath.Ext(filename))) // strip .xml
122
			if _, ok := s.conf.IrmaConfiguration.Issuers[issid]; !ok {
123
				return server.LogError(errors.Errorf("Private key %s belongs to an unknown issuer", filename))
124
			}
125
			sk, err := gabi.NewPrivateKeyFromFile(filepath.Join(s.conf.IssuerPrivateKeysPath, filename))
126
			if err != nil {
127
				return server.LogError(err)
128
			}
129
			s.conf.IssuerPrivateKeys[issid] = sk
130 131
		}
	}
132 133
	for issid, sk := range s.conf.IssuerPrivateKeys {
		pk, err := s.conf.IrmaConfiguration.PublicKey(issid, int(sk.Counter))
134
		if err != nil {
135
			return server.LogError(err)
136 137
		}
		if pk == nil {
138
			return server.LogError(errors.Errorf("Missing public key belonging to private key %s-%d", issid.String(), sk.Counter))
139 140
		}
		if new(big.Int).Mul(sk.P, sk.Q).Cmp(pk.N) != 0 {
141
			return server.LogError(errors.Errorf("Private key %s-%d does not belong to corresponding public key", issid.String(), sk.Counter))
142 143 144
		}
	}

145 146 147
	if s.conf.URL != "" {
		if !strings.HasSuffix(s.conf.URL, "/") {
			s.conf.URL = s.conf.URL + "/"
148
		}
149 150 151 152 153 154 155 156 157 158
		if !strings.HasPrefix(s.conf.URL, "https://") {
			if !s.conf.Production || s.conf.DisableTLS {
				s.conf.DisableTLS = true
				s.conf.Logger.Warnf("TLS is not enabled on the url \"%s\" to which the IRMA app will connect. "+
					"Ensure that attributes are encrypted in transit by either enabling TLS or adding TLS in a reverse proxy.", s.conf.URL)
			} else {
				return server.LogError(errors.Errorf("Running without TLS in production mode is unsafe without a reverse proxy. " +
					"Either use a https:// URL or explicitly disable TLS."))
			}
		}
159
	} else {
160
		s.conf.Logger.Warn("No url parameter specified in configuration; unless an url is elsewhere prepended in the QR, the IRMA client will not be able to connect")
161 162
	}

Sietse Ringers's avatar
Sietse Ringers committed
163 164 165 166 167
	if s.conf.Email != "" {
		// Very basic sanity checks
		if !strings.Contains(s.conf.Email, "@") || strings.Contains(s.conf.Email, "\n") {
			return server.LogError(errors.New("Invalid email address specified"))
		}
Sietse Ringers's avatar
Sietse Ringers committed
168
		t := irma.NewHTTPTransport("https://metrics.privacybydesign.foundation/history")
Sietse Ringers's avatar
Sietse Ringers committed
169 170
		t.SetHeader("User-Agent", "irmaserver")
		var x string
Sietse Ringers's avatar
Sietse Ringers committed
171
		_ = t.Post("email", &x, s.conf.Email)
Sietse Ringers's avatar
Sietse Ringers committed
172 173
	}

174 175 176
	return nil
}

177
func (s *Server) validateRequest(request irma.SessionRequest) error {
178 179 180 181
	if _, err := s.conf.IrmaConfiguration.Download(request); err != nil {
		return err
	}
	return request.Disclosure().Disclose.Validate(s.conf.IrmaConfiguration)
182 183
}

184
func (s *Server) StartSession(req interface{}) (*irma.Qr, string, error) {
185 186
	rrequest, err := server.ParseSessionRequest(req)
	if err != nil {
187
		return nil, "", err
188
	}
189 190 191

	request := rrequest.SessionRequest()
	action := request.Action()
192

Leon's avatar
Leon committed
193 194 195 196
	if err := s.validateRequest(request); err != nil {
		return nil, "", err
	}

197
	if action == irma.ActionIssuing {
198
		if err := s.validateIssuanceRequest(request.(*irma.IssuanceRequest)); err != nil {
199
			return nil, "", err
200 201 202
		}
	}

203 204 205 206
	session := s.newSession(action, rrequest)
	s.conf.Logger.WithFields(logrus.Fields{"action": action, "session": session.token}).Infof("Session started")
	if s.conf.Logger.IsLevelEnabled(logrus.DebugLevel) {
		s.conf.Logger.WithFields(logrus.Fields{"session": session.token}).Info("Session request: ", server.ToJson(rrequest))
207
	} else {
208
		s.conf.Logger.WithFields(logrus.Fields{"session": session.token}).Info("Session request (purged of attribute values): ", server.ToJson(purgeRequest(rrequest)))
209
	}
210 211
	return &irma.Qr{
		Type: action,
212
		URL:  s.conf.URL + "session/" + session.clientToken,
213 214 215
	}, session.token, nil
}

216 217
func (s *Server) GetSessionResult(token string) *server.SessionResult {
	session := s.sessions.get(token)
218
	if session == nil {
219
		s.conf.Logger.Warn("Session result requested of unknown session ", token)
Sietse Ringers's avatar
Sietse Ringers committed
220 221 222 223 224
		return nil
	}
	return session.result
}

225 226
func (s *Server) GetRequest(token string) irma.RequestorRequest {
	session := s.sessions.get(token)
227
	if session == nil {
228
		s.conf.Logger.Warn("Session request requested of unknown session ", token)
229 230 231 232 233
		return nil
	}
	return session.rrequest
}

234 235
func (s *Server) CancelSession(token string) error {
	session := s.sessions.get(token)
236
	if session == nil {
237
		return server.LogError(errors.Errorf("can't cancel unknown session %s", token))
238 239 240 241 242
	}
	session.handleDelete()
	return nil
}

243
func ParsePath(path string) (string, string, error) {
244
	pattern := regexp.MustCompile("session/(\\w+)/?(|commitments|proofs|status|statusevents)$")
245 246 247 248 249 250 251
	matches := pattern.FindStringSubmatch(path)
	if len(matches) != 3 {
		return "", "", server.LogWarning(errors.Errorf("Invalid URL: %s", path))
	}
	return matches[1], matches[2], nil
}

252
func (s *Server) SubscribeServerSentEvents(w http.ResponseWriter, r *http.Request, token string, requestor bool) error {
253 254 255 256
	if !s.conf.EnableSSE {
		return errors.New("Server sent events disabled")
	}

257 258 259 260 261 262
	var session *session
	if requestor {
		session = s.sessions.get(token)
	} else {
		session = s.sessions.clientGet(token)
	}
263 264 265 266 267 268 269 270 271
	if session == nil {
		return server.LogError(errors.Errorf("can't subscribe to server sent events of unknown session %s", token))
	}
	if session.status.Finished() {
		return server.LogError(errors.Errorf("can't subscribe to server sent events of finished session %s", token))
	}

	session.Lock()
	defer session.Unlock()
272 273 274 275 276 277 278 279 280 281 282 283 284

	// The EventSource.onopen Javascript callback is not consistently called across browsers (Chrome yes, Firefox+Safari no).
	// However, when the SSE connection has been opened the webclient needs some signal so that it can early detect SSE failures.
	// So we manually send an "open" event. Unfortunately:
	// - we need to give the webclient that connected just now some time, otherwise it will miss the "open" event
	// - the "open" event also goes to all other webclients currently listening, as we have no way to send this
	//   event to just the webclient currently listening. (Thus the handler of this "open" event must be idempotent.)
	evtSource := session.eventSource()
	go func() {
		time.Sleep(200 * time.Millisecond)
		evtSource.SendEventMessage("", "open", "")
	}()
	evtSource.ServeHTTP(w, r)
285 286 287
	return nil
}

288
func (s *Server) HandleProtocolMessage(
289 290 291 292
	path string,
	method string,
	headers map[string][]string,
	message []byte,
293 294 295 296
) (int, []byte, *server.SessionResult) {
	var start time.Time
	if s.conf.Verbose >= 2 {
		start = time.Now()
297
		server.LogRequest("client", method, path, "", http.Header(headers), message)
298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313
	}

	status, output, result := s.handleProtocolMessage(path, method, headers, message)

	if s.conf.Verbose >= 2 {
		server.LogResponse(status, time.Now().Sub(start), output)
	}

	return status, output, result
}

func (s *Server) handleProtocolMessage(
	path string,
	method string,
	headers map[string][]string,
	message []byte,
Sietse Ringers's avatar
Sietse Ringers committed
314
) (status int, output []byte, result *server.SessionResult) {
315 316 317 318 319 320 321 322 323
	// Parse path into session and action
	if len(path) > 0 { // Remove any starting and trailing slash
		if path[0] == '/' {
			path = path[1:]
		}
		if path[len(path)-1] == '/' {
			path = path[:len(path)-1]
		}
	}
324

325 326 327
	token, noun, err := ParsePath(path)
	if err != nil {
		status, output = server.JsonResponse(nil, server.RemoteError(server.ErrorUnsupported, ""))
328
		return
329 330
	}

Sietse Ringers's avatar
Sietse Ringers committed
331
	// Fetch the session
332
	session := s.sessions.clientGet(token)
333
	if session == nil {
334
		s.conf.Logger.WithField("clientToken", token).Warn("Session not found")
Sietse Ringers's avatar
Sietse Ringers committed
335
		status, output = server.JsonResponse(nil, server.RemoteError(server.ErrorSessionUnknown, ""))
336
		return
337
	}
338 339
	session.Lock()
	defer session.Unlock()
340

341 342
	// However we return, if the session status has been updated
	// then we should inform the user by returning a SessionResult
343
	defer func() {
344 345
		if session.status != session.prevStatus {
			session.prevStatus = session.status
346 347 348 349
			result = session.result
		}
	}()

350
	// Route to handler
351
	switch len(noun) {
352
	case 0:
353
		if method == http.MethodDelete {
354 355 356
			session.handleDelete()
			status = http.StatusOK
			return
357
		}
358
		if method == http.MethodGet {
359 360 361 362
			status, output = session.checkCache(message, server.StatusConnected)
			if len(output) != 0 {
				return
			}
363 364 365 366
			h := http.Header(headers)
			min := &irma.ProtocolVersion{}
			max := &irma.ProtocolVersion{}
			if err := json.Unmarshal([]byte(h.Get(irma.MinVersionHeader)), min); err != nil {
Sietse Ringers's avatar
Sietse Ringers committed
367
				status, output = server.JsonResponse(nil, session.fail(server.ErrorMalformedInput, err.Error()))
368
				return
369 370
			}
			if err := json.Unmarshal([]byte(h.Get(irma.MaxVersionHeader)), max); err != nil {
Sietse Ringers's avatar
Sietse Ringers committed
371
				status, output = server.JsonResponse(nil, session.fail(server.ErrorMalformedInput, err.Error()))
372
				return
373
			}
Sietse Ringers's avatar
Sietse Ringers committed
374
			status, output = server.JsonResponse(session.handleGetRequest(min, max))
375
			session.responseCache = responseCache{message: message, response: output, status: status, sessionStatus: server.StatusConnected}
376
			return
377
		}
Sietse Ringers's avatar
Sietse Ringers committed
378
		status, output = server.JsonResponse(nil, session.fail(server.ErrorInvalidRequest, ""))
379
		return
380

381
	default:
382 383 384 385 386 387
		if noun == "statusevents" {
			err := server.RemoteError(server.ErrorInvalidRequest, "server sent events not supported by this server")
			status, output = server.JsonResponse(nil, err)
			return
		}

388 389
		if method == http.MethodGet && noun == "status" {
			status, output = server.JsonResponse(session.handleGetStatus())
Sietse Ringers's avatar
Sietse Ringers committed
390
			return
391 392 393
		}

		// Below are only POST enpoints
394
		if method != http.MethodPost {
Sietse Ringers's avatar
Sietse Ringers committed
395
			status, output = server.JsonResponse(nil, session.fail(server.ErrorInvalidRequest, ""))
Sietse Ringers's avatar
Sietse Ringers committed
396 397 398
			return
		}

399
		if noun == "commitments" && session.action == irma.ActionIssuing {
400 401 402 403
			status, output = session.checkCache(message, server.StatusDone)
			if len(output) != 0 {
				return
			}
Sietse Ringers's avatar
Sietse Ringers committed
404
			commitments := &irma.IssueCommitmentMessage{}
405 406
			if err = irma.UnmarshalValidate(message, commitments); err != nil {
				status, output = server.JsonResponse(nil, session.fail(server.ErrorMalformedInput, err.Error()))
407
				return
408
			}
Sietse Ringers's avatar
Sietse Ringers committed
409
			status, output = server.JsonResponse(session.handlePostCommitments(commitments))
410
			session.responseCache = responseCache{message: message, response: output, status: status, sessionStatus: server.StatusDone}
Sietse Ringers's avatar
Sietse Ringers committed
411 412
			return
		}
413

414
		if noun == "proofs" && session.action == irma.ActionDisclosing {
415 416 417 418 419 420 421
			status, output = session.checkCache(message, server.StatusDone)
			if len(output) != 0 {
				return
			}
			disclosure := &irma.Disclosure{}
			if err = irma.UnmarshalValidate(message, disclosure); err != nil {
				status, output = server.JsonResponse(nil, session.fail(server.ErrorMalformedInput, err.Error()))
422
				return
423
			}
Sietse Ringers's avatar
Sietse Ringers committed
424
			status, output = server.JsonResponse(session.handlePostDisclosure(disclosure))
425
			session.responseCache = responseCache{message: message, response: output, status: status, sessionStatus: server.StatusDone}
Sietse Ringers's avatar
Sietse Ringers committed
426 427
			return
		}
428

429
		if noun == "proofs" && session.action == irma.ActionSigning {
430 431 432 433
			status, output = session.checkCache(message, server.StatusDone)
			if len(output) != 0 {
				return
			}
Sietse Ringers's avatar
Sietse Ringers committed
434
			signature := &irma.SignedMessage{}
435 436
			if err = irma.UnmarshalValidate(message, signature); err != nil {
				status, output = server.JsonResponse(nil, session.fail(server.ErrorMalformedInput, err.Error()))
437
				return
438
			}
Sietse Ringers's avatar
Sietse Ringers committed
439
			status, output = server.JsonResponse(session.handlePostSignature(signature))
440
			session.responseCache = responseCache{message: message, response: output, status: status, sessionStatus: server.StatusDone}
441
			return
442
		}
Sietse Ringers's avatar
Sietse Ringers committed
443

Sietse Ringers's avatar
Sietse Ringers committed
444
		status, output = server.JsonResponse(nil, session.fail(server.ErrorInvalidRequest, ""))
445
		return
446 447
	}
}