server.go 18.6 KB
Newer Older
1
package keyshareserver
2
3

import (
4
	"bytes"
5
6
7
8
9
10
11
12
	"crypto/rand"
	"encoding/base64"
	"encoding/json"
	"fmt"
	"io/ioutil"
	"net/http"
	"strings"
	"sync"
13
	"time"
14

15
	"github.com/jasonlvhit/gocron"
16
17
18
19
20
	"github.com/privacybydesign/gabi"
	"github.com/privacybydesign/gabi/big"
	irma "github.com/privacybydesign/irmago"
	"github.com/sirupsen/logrus"

21
	"github.com/privacybydesign/irmago/internal/common"
22
	"github.com/privacybydesign/irmago/internal/keysharecore"
23
24
25
26
27
28
29
30
	"github.com/privacybydesign/irmago/server"
	"github.com/privacybydesign/irmago/server/irmaserver"

	"github.com/go-chi/chi"
	"github.com/go-chi/chi/middleware"
)

type SessionData struct {
31
	LastKeyID    irma.PublicKeyIdentifier // last used key, used in signing the issuance message
32
	LastCommitID uint64
33
	expiry       time.Time
34
35
36
}

type Server struct {
37
	// configuration
38
39
	conf *Configuration

40
	// external components
41
	core          *keysharecore.KeyshareCore
42
43
	sessionserver *irmaserver.Server
	db            KeyshareDB
44
45

	// Scheduler used to clean sessions
46
47
	scheduler     *gocron.Scheduler
	stopScheduler chan<- bool
48

49
	// Session data, keeping track of current keyshare protocol session state for each user
50
51
52
53
54
55
56
	sessions    map[string]*SessionData
	sessionLock sync.Mutex
}

func New(conf *Configuration) (*Server, error) {
	var err error
	s := &Server{
57
58
59
		conf:      conf,
		sessions:  map[string]*SessionData{},
		scheduler: gocron.NewScheduler(),
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
	}

	// Do initial processing of configuration and create keyshare core
	s.core, err = processConfiguration(conf)
	if err != nil {
		return nil, err
	}

	// Load neccessary idemix keys into core, and ensure that future updates
	// to them are processed
	s.LoadIdemixKeys(conf.ServerConfiguration.IrmaConfiguration)
	conf.ServerConfiguration.IrmaConfiguration.UpdateListeners = append(
		conf.ServerConfiguration.IrmaConfiguration.UpdateListeners,
		s.LoadIdemixKeys)

75
	// Setup IRMA session server
76
77
78
79
80
	s.sessionserver, err = irmaserver.New(conf.ServerConfiguration)
	if err != nil {
		return nil, err
	}

81
82
	// Setup DB
	s.db = conf.DB
83

84
85
86
87
	// Setup session cache clearing
	s.scheduler.Every(10).Seconds().Do(s.clearSessions)
	s.stopScheduler = s.scheduler.Start()

88
89
90
	return s, nil
}

91
92
93
94
95
func (s *Server) Stop() {
	s.stopScheduler <- true
	s.sessionserver.Stop()
}

96
// clean up any expired sessions
97
98
99
100
101
102
103
104
105
106
107
func (s *Server) clearSessions() {
	now := time.Now()
	s.sessionLock.Lock()
	defer s.sessionLock.Unlock()
	for k, v := range s.sessions {
		if now.After(v.expiry) {
			delete(s.sessions, k)
		}
	}
}

108
109
110
func (s *Server) Handler() http.Handler {
	router := chi.NewRouter()
	router.Use(middleware.Logger)
111
	// Registration
112
	router.Post("/client/register", s.handleRegister)
113
114

	// Pin and login
115
116
117
	router.Post("/users/isAuthorized", s.handleValidate)
	router.Post("/users/verify/pin", s.handleVerifyPin)
	router.Post("/users/change/pin", s.handleChangePin)
118
119

	// Keyshare sessions
120
121
	router.Post("/prove/getCommitments", s.handleCommitments)
	router.Post("/prove/getResponse", s.handleResponse)
122

123
	// IRMA server for issuing myirma credential during registration
124
125
126
127
	router.Mount("/irma/", s.sessionserver.HandlerFunc())
	return router
}

128
// On configuration changes, inform the keyshare core of any
129
// new IRMA issuer public keys.
130
131
func (s *Server) LoadIdemixKeys(conf *irma.Configuration) {
	for _, issuer := range conf.Issuers {
132
		keyIDs, err := conf.PublicKeyIndices(issuer.Identifier())
133
		if err != nil {
134
			s.conf.Logger.WithFields(logrus.Fields{"issuer": issuer, "error": err}).Warn("Could not find keyIDs for issuer")
135
136
			continue
		}
137
		for _, id := range keyIDs {
138
139
			key, err := conf.PublicKey(issuer.Identifier(), id)
			if err != nil {
140
				s.conf.Logger.WithFields(logrus.Fields{"keyID": id, "error": err}).Warn("Could not fetch public key for issuer")
141
142
143
144
145
146
147
				continue
			}
			s.core.DangerousAddTrustedPublicKey(irma.PublicKeyIdentifier{Issuer: issuer.Identifier(), Counter: uint(id)}, key)
		}
	}
}

148
// /prove/getCommitments
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
func (s *Server) handleCommitments(w http.ResponseWriter, r *http.Request) {
	// Read keys
	body, err := ioutil.ReadAll(r.Body)
	if err != nil {
		s.conf.Logger.WithField("error", err).Info("Malformed request: could not read request body")
		server.WriteError(w, server.ErrorInvalidRequest, err.Error())
		return
	}
	var keys []irma.PublicKeyIdentifier
	err = json.Unmarshal(body, &keys)
	if err != nil {
		s.conf.Logger.WithField("error", err).Info("Malformed request: could not parse request body")
		s.conf.Logger.WithField("body", body).Debug("Malformed request data")
		server.WriteError(w, server.ErrorInvalidRequest, err.Error())
		return
	}
	if len(keys) == 0 {
		s.conf.Logger.Info("Malformed request: no keys over which to commit specified")
		server.WriteError(w, server.ErrorInvalidRequest, "No key specified")
		return
	}

	// Extract username and authorization from request
	username := r.Header.Get("X-IRMA-Keyshare-Username")
	authorization := r.Header.Get("Authorization")
174
175
176
	if strings.HasPrefix(authorization, "Bearer ") {
		authorization = authorization[7:]
	}
177
178
179
180
181
182
183
184

	user, err := s.db.User(username)
	if err != nil {
		s.conf.Logger.WithFields(logrus.Fields{"username": username, "error": err}).Warn("User not found in db")
		server.WriteError(w, server.ErrorUserNotRegistered, err.Error())
		return
	}

185
	// Generate commitments
186
	commitments, commitID, err := s.core.GenerateCommitments(user.Data().Coredata, authorization, keys)
187
188
189
190
191
192
193
194
	if err != nil {
		s.conf.Logger.WithField("error", err).Warn("Could not generate commitments for request")
		server.WriteError(w, server.ErrorInvalidRequest, err.Error())
		return
	}

	// Prepare output message format
	mappedCommitments := map[string]*gabi.ProofPCommitment{}
195
196
	for i, keyID := range keys {
		keyIDV, err := keyID.MarshalText()
197
		if err != nil {
198
			s.conf.Logger.WithFields(logrus.Fields{"keyid": keyID, "error": err}).Error("Could not convert key identifier to string")
199
200
201
			server.WriteError(w, server.ErrorInternal, err.Error())
			return
		}
202
		mappedCommitments[string(keyIDV)] = commitments[i]
203
204
205
206
207
208
209
	}

	// Store needed data for later requests.
	s.sessionLock.Lock()
	if _, ok := s.sessions[username]; !ok {
		s.sessions[username] = &SessionData{}
	}
210
211
	s.sessions[username].LastCommitID = commitID
	s.sessions[username].LastKeyID = keys[0]
212
	s.sessions[username].expiry = time.Now().Add(10 * time.Second)
213
214
215
216
217
218
	s.sessionLock.Unlock()

	// And send response
	server.WriteJson(w, proofPCommitmentMap{Commitments: mappedCommitments})
}

219
// /prove/getResponse
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
func (s *Server) handleResponse(w http.ResponseWriter, r *http.Request) {
	// Read challenge
	body, err := ioutil.ReadAll(r.Body)
	if err != nil {
		s.conf.Logger.WithField("error", err).Info("Malformed request: could not read request body")
		server.WriteError(w, server.ErrorInvalidRequest, err.Error())
		return
	}
	challenge := new(big.Int)
	err = json.Unmarshal(body, challenge)
	if err != nil {
		s.conf.Logger.Info("Malformed request: could not parse challenge")
		server.WriteError(w, server.ErrorInvalidRequest, err.Error())
		return
	}

	// Extract username and authorization from request
	username := r.Header.Get("X-IRMA-Keyshare-Username")
	authorization := r.Header.Get("Authorization")
239
240
241
	if strings.HasPrefix(authorization, "Bearer ") {
		authorization = authorization[7:]
	}
242
243
244
245
246
247
248
249
250
251

	// Fetch user
	user, err := s.db.User(username)
	if err != nil {
		s.conf.Logger.WithFields(logrus.Fields{"username": username, "error": err}).Warn("Could not find user in db")
		server.WriteError(w, server.ErrorUserNotRegistered, err.Error())
		return
	}

	// verify access (avoids leaking information to unauthorized callers)
252
	err = s.core.ValidateJWT(user.Data().Coredata, authorization)
253
254
255
256
257
258
	if err != nil {
		s.conf.Logger.WithField("error", err).Warn("Could not generate keyshare response")
		server.WriteError(w, server.ErrorInvalidRequest, err.Error())
		return
	}

David Venhoek's avatar
David Venhoek committed
259
260
261
262
263
264
265
	// Indicate activity on user account
	err = s.db.SetSeen(user)
	if err != nil {
		s.conf.Logger.WithField("error", err).Error("Could not mark user as seen recently")
		// Do not send to user
	}

266
267
268
269
270
271
272
273
274
275
	// Get data from session
	s.sessionLock.Lock()
	sessionData, ok := s.sessions[username]
	s.sessionLock.Unlock()
	if !ok {
		s.conf.Logger.Warn("Request for response without previous call to get commitments")
		server.WriteError(w, server.ErrorInvalidRequest, "Missing previous call to getCommitments")
		return
	}

276
277
278
279
280
281
282
283
	// Make log entry
	err = s.db.AddLog(user, IrmaSession, nil)
	if err != nil {
		s.conf.Logger.WithField("error", err).Error("Could not add log entry for user")
		server.WriteError(w, server.ErrorInternal, err.Error())
		return
	}

284
	proofResponse, err := s.core.GenerateResponse(user.Data().Coredata, authorization, sessionData.LastCommitID, challenge, sessionData.LastKeyID)
285
286
287
288
289
290
291
292
293
	if err != nil {
		s.conf.Logger.WithField("error", err).Error("Could not generate response for request")
		server.WriteError(w, server.ErrorInvalidRequest, err.Error())
		return
	}

	server.WriteString(w, proofResponse)
}

294
// /users/isAuthorized
295
296
297
298
func (s *Server) handleValidate(w http.ResponseWriter, r *http.Request) {
	// Extract username and authorization from request
	username := r.Header.Get("X-IRMA-Keyshare-Username")
	authorization := r.Header.Get("Authorization")
299
300
301
	if strings.HasPrefix(authorization, "Bearer ") {
		authorization = authorization[7:]
	}
302

303
	// Fetch user
304
305
306
307
308
309
310
	user, err := s.db.User(username)
	if err != nil {
		s.conf.Logger.WithFields(logrus.Fields{"username": username, "error": err}).Warn("Could not find user in db")
		server.WriteError(w, server.ErrorUserNotRegistered, err.Error())
		return
	}

311
	// Validate jwt
312
	err = s.core.ValidateJWT(user.Data().Coredata, authorization)
313
314
315
316
317
318
319
	if err != nil {
		server.WriteJson(w, &keyshareAuthorization{Status: "expired", Candidates: []string{"pin"}})
	} else {
		server.WriteJson(w, &keyshareAuthorization{Status: "authorized", Candidates: []string{"pin"}})
	}
}

320
// /users/verify/pin
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
func (s *Server) handleVerifyPin(w http.ResponseWriter, r *http.Request) {
	// Extract request
	body, err := ioutil.ReadAll(r.Body)
	if err != nil {
		s.conf.Logger.WithField("error", err).Info("Malformed request: could not read request body")
		server.WriteError(w, server.ErrorInvalidRequest, err.Error())
		return
	}
	var msg keysharePinMessage
	err = json.Unmarshal(body, &msg)
	if err != nil {
		s.conf.Logger.WithFields(logrus.Fields{"error": err}).Info("Malformed request: could not parse request body")
		server.WriteError(w, server.ErrorInvalidRequest, err.Error())
		return
	}

	// Fetch user
	user, err := s.db.User(msg.Username)
	if err != nil {
		s.conf.Logger.WithFields(logrus.Fields{"username": msg.Username, "error": err}).Warn("Could not find user in db")
		server.WriteError(w, server.ErrorUserNotRegistered, "")
		return
	}

345
346
	// And verify pin (checking that we are allowed to do this)
	ok, tries, wait, err := s.db.ReservePincheck(user)
347
	if err != nil {
348
349
350
351
352
		s.conf.Logger.WithField("error", err).Error("Could not reserve pin check slot")
		server.WriteError(w, server.ErrorInternal, err.Error())
		return
	}
	if !ok {
353
354
355
356
357
358
		err = s.db.AddLog(user, PinCheckRefused, nil)
		if err != nil {
			s.conf.Logger.WithField("error", err).Error("Could not add log entry for user")
			server.WriteError(w, server.ErrorInternal, err.Error())
			return
		}
359
360
361
		server.WriteJson(w, keysharePinStatus{Status: "error", Message: fmt.Sprintf("%v", wait)})
		return
	}
362
	jwtt, err := s.core.ValidatePin(user.Data().Coredata, msg.Pin, msg.Username)
363
	if err == keysharecore.ErrInvalidPin {
364
365
366
367
368
369
		err = s.db.AddLog(user, PinCheckFailed, tries)
		if err != nil {
			s.conf.Logger.WithField("error", err).Error("Could not add log entry for user")
			server.WriteError(w, server.ErrorInternal, err.Error())
			return
		}
370
		if tries == 0 {
371
372
373
374
375
376
			err = s.db.AddLog(user, PinCheckBlocked, wait)
			if err != nil {
				s.conf.Logger.WithField("error", err).Error("Could not add log entry for user")
				server.WriteError(w, server.ErrorInternal, err.Error())
				return
			}
377
378
379
380
381
382
383
			server.WriteJson(w, keysharePinStatus{Status: "error", Message: fmt.Sprintf("%v", wait)})
		} else {
			server.WriteJson(w, keysharePinStatus{Status: "failure", Message: fmt.Sprintf("%v", tries)})
		}
	} else if err != nil {
		s.conf.Logger.WithField("error", err).Error("Could not validate pin")
		server.WriteError(w, server.ErrorInternal, err.Error())
384
	} else {
385
386
387
388
389
		err = s.db.ClearPincheck(user)
		if err != nil {
			s.conf.Logger.WithField("error", err).Error("Could not reset users pin check logic")
			// Do not send to user
		}
David Venhoek's avatar
David Venhoek committed
390
391
392
393
394
395
396
397

		// Indicate activity on user account
		err = s.db.SetSeen(user)
		if err != nil {
			s.conf.Logger.WithField("error", err).Error("Could not indicate user activity")
			// Do not send to user
		}

398
		err = s.db.AddLog(user, PinCheckSuccess, nil)
399
400
401
402
403
404
		if err != nil {
			s.conf.Logger.WithField("error", err).Error("Could not add log entry for user")
			server.WriteError(w, server.ErrorInternal, err.Error())
			return
		}

405
406
407
408
		server.WriteJson(w, keysharePinStatus{Status: "success", Message: jwtt})
	}
}

409
// /users/change/pin
410
411
412
413
414
415
416
417
func (s *Server) handleChangePin(w http.ResponseWriter, r *http.Request) {
	// Extract request
	body, err := ioutil.ReadAll(r.Body)
	if err != nil {
		s.conf.Logger.WithField("error", err).Info("Malformed request: could not read request body")
		server.WriteError(w, server.ErrorInvalidRequest, "could not read request body")
		return
	}
418
	var msg keyshareChangePin
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
	err = json.Unmarshal(body, &msg)
	if err != nil {
		s.conf.Logger.WithField("error", err).Info("Malformed request: could not parse request body")
		server.WriteError(w, server.ErrorInvalidRequest, "Invalid request")
		return
	}

	// Fetch user
	user, err := s.db.User(msg.Username)
	if err != nil {
		s.conf.Logger.WithFields(logrus.Fields{"username": msg.Username, "error": err}).Warn("Could not find user in db")
		server.WriteError(w, server.ErrorUserNotRegistered, "")
		return
	}

434
435
	// And change pin, checking that we are allowed to do this
	ok, tries, wait, err := s.db.ReservePincheck(user)
436
	if err != nil {
437
438
		s.conf.Logger.WithField("error", err).Error("Could not reserve pin check slot")
		server.WriteError(w, server.ErrorInternal, err.Error())
439
440
		return
	}
441
442
443
444
	if !ok {
		server.WriteJson(w, keysharePinStatus{Status: "error", Message: fmt.Sprintf("%v", wait)})
		return
	}
445
	user.Data().Coredata, err = s.core.ChangePin(user.Data().Coredata, msg.OldPin, msg.NewPin)
446
	if err == keysharecore.ErrInvalidPin {
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
		if tries == 0 {
			server.WriteJson(w, keysharePinStatus{Status: "error", Message: fmt.Sprintf("%v", wait)})
		} else {
			server.WriteJson(w, keysharePinStatus{Status: "failure", Message: fmt.Sprintf("%v", tries)})
		}
		return
	} else if err != nil {
		s.conf.Logger.WithField("error", err).Error("Could not change pin")
		server.WriteError(w, server.ErrorInternal, err.Error())
		return
	}
	err = s.db.ClearPincheck(user)
	if err != nil {
		s.conf.Logger.WithField("error", err).Error("Could not reset users pin check logic")
		// Do not send to user
	}
463
464
465
466
467
468
469
470
471
472
473
474
475

	// Write user back
	err = s.db.UpdateUser(user)
	if err != nil {
		s.conf.Logger.WithField("error", err).Error("Could not write updated user to database")
		server.WriteError(w, server.ErrorInternal, err.Error())
		return
	}

	// And return success
	server.WriteJson(w, keysharePinStatus{Status: "success"})
}

476
// /client/register
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
func (s *Server) handleRegister(w http.ResponseWriter, r *http.Request) {
	// Extract request
	body, err := ioutil.ReadAll(r.Body)
	if err != nil {
		s.conf.Logger.WithField("error", err).Info("Malformed request: could not read request body")
		server.WriteError(w, server.ErrorInvalidRequest, "could not read request body")
		return
	}
	var msg keyshareEnrollment
	err = json.Unmarshal(body, &msg)
	if err != nil {
		s.conf.Logger.WithField("error", err).Info("Malformed request: could not parse request body")
		server.WriteError(w, server.ErrorInvalidRequest, "Invalid request")
		return
	}

	// Generate keyshare server account
	username := generateUsername()
	coredata, err := s.core.GenerateKeyshareSecret(msg.Pin)
	if err != nil {
		s.conf.Logger.WithField("error", err).Error("Could not register user")
		server.WriteError(w, server.ErrorInvalidRequest, err.Error())
		return
	}
501
	user, err := s.db.NewUser(KeyshareUserData{Username: username, Language: msg.Language, Coredata: coredata})
502
503
504
505
506
507
	if err != nil {
		s.conf.Logger.WithField("error", err).Error("Could not store new user in database")
		server.WriteError(w, server.ErrorInternal, err.Error())
		return
	}

508
	// Send email if user specified email address
509
	if msg.Email != nil && *msg.Email != "" && s.conf.EmailServer != "" {
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
		// Fetch template and configuration data for users language, falling back if needed
		template, ok := s.conf.RegistrationEmailTemplates[msg.Language]
		if !ok {
			template = s.conf.RegistrationEmailTemplates[s.conf.DefaultLanguage]
		}
		verificationBaseURL, ok := s.conf.VerificationURL[msg.Language]
		if !ok {
			verificationBaseURL = s.conf.VerificationURL[s.conf.DefaultLanguage]
		}
		subject, ok := s.conf.RegistrationEmailSubject[msg.Language]
		if !ok {
			subject = s.conf.RegistrationEmailSubject[s.conf.DefaultLanguage]
		}

		// Generate token
525
		token := common.NewSessionToken()
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

		// Add it to the database
		err = s.db.AddEmailVerification(user, *msg.Email, token)
		if err != nil {
			s.conf.Logger.WithField("error", err).Error("Could not add email verification record to user")
			server.WriteError(w, server.ErrorInternal, err.Error())
			return
		}

		// Build message
		var emsg bytes.Buffer
		err = template.Execute(&emsg, map[string]string{"VerificationURL": verificationBaseURL + token})
		if err != nil {
			s.conf.Logger.WithField("error", err).Error("Could not generate email verifcation mail")
			server.WriteError(w, server.ErrorInternal, err.Error())
			return
		}

		// And send it
		err = server.SendHTMLMail(
			s.conf.EmailServer,
			s.conf.EmailAuth,
			s.conf.EmailFrom,
			*msg.Email,
			subject,
			emsg.Bytes())
552
553
554
555
556
557

		if err != nil {
			s.conf.Logger.WithField("error", err).Error("Could not send email verifiation mail")
			server.WriteError(w, server.ErrorInternal, err.Error())
			return
		}
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
585
586
587
588
589
590
591
592
593
594
595
596
597
	// Setup and return issuance session for keyshare credential.
	request := irma.NewIssuanceRequest([]*irma.CredentialRequest{
		{
			CredentialTypeID: irma.NewCredentialTypeIdentifier(s.conf.KeyshareCredential),
			Attributes: map[string]string{
				s.conf.KeyshareAttribute: username,
			},
		}})
	sessionptr, _, err := s.sessionserver.StartSession(request, nil)
	if err != nil {
		s.conf.Logger.WithField("error", err).Error("Could not start keyshare credential issuance sessions")
		server.WriteError(w, server.ErrorInternal, err.Error())
		return
	}
	server.WriteResponse(w, sessionptr, nil)
}

// Generate a base62 "username".
//  this is a direct port of what the old java server uses.
func generateUsername() string {
	bts := make([]byte, 8)
	_, err := rand.Read(bts)
	if err != nil {
		panic(err)
	}
	raw := make([]byte, 12)
	base64.StdEncoding.Encode(raw, bts)
	return strings.ReplaceAll(
		strings.ReplaceAll(
			strings.ReplaceAll(
				string(raw),
				"+",
				""),
			"/",
			""),
		"=",
		"")
}