keyshare.go 16.2 KB
Newer Older
1
package irmaclient
2
3
4
5
6

import (
	"crypto/rand"
	"crypto/sha256"
	"encoding/base64"
Sietse Ringers's avatar
Sietse Ringers committed
7
	"fmt"
8
	"net/http"
Sietse Ringers's avatar
Sietse Ringers committed
9
	"strconv"
Sietse Ringers's avatar
Sietse Ringers committed
10
	"strings"
11
	"time"
Sietse Ringers's avatar
Sietse Ringers committed
12

13
	"github.com/bwesterb/go-atum"
14
	"github.com/dgrijalva/jwt-go"
Sietse Ringers's avatar
Sietse Ringers committed
15
	"github.com/go-errors/errors"
16
17
	"github.com/privacybydesign/gabi"
	"github.com/privacybydesign/gabi/big"
18
	"github.com/privacybydesign/irmago"
19
20
)

21
22
// This file contains an implementation of the client side of the keyshare protocol,
// as well as the keyshareSessionHandler which is used to communicate with the user
23
// (currently only Client).
24

25
// KeysharePinRequestor is used to asking the user for his PIN.
Sietse Ringers's avatar
Sietse Ringers committed
26
type KeysharePinRequestor interface {
27
	RequestPin(remainingAttempts int, callback PinHandler)
Sietse Ringers's avatar
Sietse Ringers committed
28
29
30
}

type keyshareSessionHandler interface {
Sietse Ringers's avatar
Sietse Ringers committed
31
	KeyshareDone(message interface{})
Sietse Ringers's avatar
Sietse Ringers committed
32
	KeyshareCancelled()
33
	KeyshareBlocked(manager irma.SchemeManagerIdentifier, duration int)
Sietse Ringers's avatar
Sietse Ringers committed
34
	KeyshareEnrollmentIncomplete(manager irma.SchemeManagerIdentifier)
35
	KeyshareEnrollmentDeleted(manager irma.SchemeManagerIdentifier)
36
37
	// In errors the manager may be nil, as not all keyshare errors have a clearly associated scheme manager
	KeyshareError(manager *irma.SchemeManagerIdentifier, err error)
Sietse Ringers's avatar
Sietse Ringers committed
38
39
	KeysharePin()
	KeysharePinOK()
Sietse Ringers's avatar
Sietse Ringers committed
40
41
42
}

type keyshareSession struct {
43
44
45
46
47
48
49
50
51
	sessionHandler   keyshareSessionHandler
	pinRequestor     KeysharePinRequestor
	builders         gabi.ProofBuilderList
	session          irma.SessionRequest
	conf             *irma.Configuration
	keyshareServers  map[irma.SchemeManagerIdentifier]*keyshareServer
	keyshareServer   *keyshareServer // The one keyshare server in use in case of issuance
	transports       map[irma.SchemeManagerIdentifier]*irma.HTTPTransport
	issuerProofNonce *big.Int
52
	timestamp        *atum.Timestamp
53
	pinCheck         bool
Sietse Ringers's avatar
Sietse Ringers committed
54
55
}

56
type keyshareServer struct {
57
58
59
	URL                     string `json:"url"`
	Username                string `json:"username"`
	Nonce                   []byte `json:"nonce"`
60
61
	SchemeManagerIdentifier irma.SchemeManagerIdentifier
	token                   string
62
63
}

64
type keyshareEnrollment struct {
65
66
67
68
	Username string  `json:"username"`
	Pin      string  `json:"pin"`
	Email    *string `json:"email"`
	Language string  `json:"language"`
Sietse Ringers's avatar
Sietse Ringers committed
69
70
}

71
type keyshareChangepin struct {
72
	Username string `json:"id"`
73
74
	OldPin   string `json:"oldpin"`
	NewPin   string `json:"newpin"`
75
76
}

Sietse Ringers's avatar
Sietse Ringers committed
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
type keyshareAuthorization struct {
	Status     string   `json:"status"`
	Candidates []string `json:"candidates"`
}

type keysharePinMessage struct {
	Username string `json:"id"`
	Pin      string `json:"pin"`
}

type keysharePinStatus struct {
	Status  string `json:"status"`
	Message string `json:"message"`
}

type publicKeyIdentifier struct {
	Issuer  string `json:"issuer"`
	Counter uint   `json:"counter"`
}

Sietse Ringers's avatar
Sietse Ringers committed
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
func (pki *publicKeyIdentifier) UnmarshalText(text []byte) error {
	str := string(text)
	index := strings.LastIndex(str, "-")
	if index == -1 {
		return errors.New("Invalid publicKeyIdentifier")
	}
	counter, err := strconv.Atoi(str[index+1:])
	if err != nil {
		return err
	}
	*pki = publicKeyIdentifier{Issuer: str[:index], Counter: uint(counter)}
	return nil
}

func (pki *publicKeyIdentifier) MarshalText() (text []byte, err error) {
	return []byte(fmt.Sprintf("%s-%d", pki.Issuer, pki.Counter)), nil
}
Sietse Ringers's avatar
Sietse Ringers committed
114
115
116
117
118
119

type proofPCommitmentMap struct {
	Commitments map[publicKeyIdentifier]*gabi.ProofPCommitment `json:"c"`
}

const (
Sietse Ringers's avatar
Sietse Ringers committed
120
121
122
	kssUsernameHeader = "X-IRMA-Keyshare-Username"
	kssVersionHeader  = "X-IRMA-Keyshare-ProtocolVersion"
	kssAuthHeader     = "Authorization"
Sietse Ringers's avatar
Sietse Ringers committed
123
124
125
126
127
128
129
	kssAuthorized     = "authorized"
	kssTokenExpired   = "expired"
	kssPinSuccess     = "success"
	kssPinFailure     = "failure"
	kssPinError       = "error"
)

130
131
func newKeyshareServer(
	schemeManagerIdentifier irma.SchemeManagerIdentifier,
132
	url string,
133
) (ks *keyshareServer, err error) {
Sietse Ringers's avatar
Sietse Ringers committed
134
	ks = &keyshareServer{
135
136
		Nonce: make([]byte, 32),
		URL:   url,
137
		SchemeManagerIdentifier: schemeManagerIdentifier,
Sietse Ringers's avatar
Sietse Ringers committed
138
	}
139
140
141
142
143
144
	_, err = rand.Read(ks.Nonce)
	return
}

func (ks *keyshareServer) HashedPin(pin string) string {
	hash := sha256.Sum256(append(ks.Nonce, []byte(pin)...))
145
146
147
148
	// We must be compatible with the old Android app here,
	// which uses Base64.encodeToString(hash, Base64.DEFAULT),
	// which appends a newline.
	return base64.StdEncoding.EncodeToString(hash[:]) + "\n"
149
}
Sietse Ringers's avatar
Sietse Ringers committed
150

Sietse Ringers's avatar
Sietse Ringers committed
151
152
153
154
155
156
157
158
// startKeyshareSession starts and completes the entire keyshare protocol with all involved keyshare servers
// for the specified session, merging the keyshare proofs into the specified ProofBuilder's.
// The user's pin is retrieved using the KeysharePinRequestor, repeatedly, until either it is correct; or the
// user cancels; or one of the keyshare servers blocks us.
// Error, blocked or success of the keyshare session is reported back to the keyshareSessionHandler.
func startKeyshareSession(
	sessionHandler keyshareSessionHandler,
	pin KeysharePinRequestor,
159
	builders gabi.ProofBuilderList,
160
	session irma.SessionRequest,
161
	conf *irma.Configuration,
162
	keyshareServers map[irma.SchemeManagerIdentifier]*keyshareServer,
163
	issuerProofNonce *big.Int,
164
	timestamp *atum.Timestamp,
Sietse Ringers's avatar
Sietse Ringers committed
165
166
) {
	ksscount := 0
167
	for managerID := range session.Identifiers().SchemeManagers {
168
		if conf.SchemeManagers[managerID].Distributed() {
Sietse Ringers's avatar
Sietse Ringers committed
169
			ksscount++
170
171
			if _, enrolled := keyshareServers[managerID]; !enrolled {
				err := errors.New("Not enrolled to keyshare server of scheme manager " + managerID.String())
172
				sessionHandler.KeyshareError(&managerID, err)
Sietse Ringers's avatar
Sietse Ringers committed
173
174
175
176
				return
			}
		}
	}
177
	if _, issuing := session.(*irma.IssuanceRequest); issuing && ksscount > 1 {
Sietse Ringers's avatar
Sietse Ringers committed
178
		err := errors.New("Issuance session involving more than one keyshare servers are not supported")
179
		sessionHandler.KeyshareError(nil, err)
Sietse Ringers's avatar
Sietse Ringers committed
180
181
182
183
		return
	}

	ks := &keyshareSession{
184
185
186
187
188
189
190
191
		session:          session,
		builders:         builders,
		sessionHandler:   sessionHandler,
		transports:       map[irma.SchemeManagerIdentifier]*irma.HTTPTransport{},
		pinRequestor:     pin,
		conf:             conf,
		keyshareServers:  keyshareServers,
		issuerProofNonce: issuerProofNonce,
192
		timestamp:        timestamp,
193
		pinCheck:         false,
Sietse Ringers's avatar
Sietse Ringers committed
194
195
	}

196
	for managerID := range session.Identifiers().SchemeManagers {
197
		if !ks.conf.SchemeManagers[managerID].Distributed() {
Sietse Ringers's avatar
Sietse Ringers committed
198
199
200
			continue
		}

201
		ks.keyshareServer = ks.keyshareServers[managerID]
202
		transport := irma.NewHTTPTransport(ks.keyshareServer.URL)
Sietse Ringers's avatar
Sietse Ringers committed
203
		transport.SetHeader(kssUsernameHeader, ks.keyshareServer.Username)
Sietse Ringers's avatar
Sietse Ringers committed
204
205
		transport.SetHeader(kssAuthHeader, "Bearer "+ks.keyshareServer.token)
		transport.SetHeader(kssVersionHeader, "2")
206
		ks.transports[managerID] = transport
Sietse Ringers's avatar
Sietse Ringers committed
207

208
		// Try to parse token as a jwt to see if it is still valid; if so we don't need to ask for the PIN
209
210
211
212
213
		parser := new(jwt.Parser)
		parser.SkipClaimsValidation = true // We want to verify expiry on our own below so we can add leeway
		claims := jwt.StandardClaims{}
		_, err := parser.ParseWithClaims(ks.keyshareServer.token, &claims, ks.conf.KeyshareServerKeyFunc(managerID))
		if err != nil {
214
215
			irma.Logger.Info("Keyshare server token invalid, asking for PIN")
			irma.Logger.Debug("Token: ", ks.keyshareServer.token)
216
			ks.pinCheck = true
217
			continue
Sietse Ringers's avatar
Sietse Ringers committed
218
		}
219
220
		// Add a minute of leeway for possible clockdrift with the server,
		// and for the rest of the protocol to take place with this token
221
222
223
		if !claims.VerifyExpiresAt(time.Now().Add(1*time.Minute).Unix(), true) {
			irma.Logger.Info("Keyshare server token expires too soon, asking for PIN")
			irma.Logger.Debug("Token: ", ks.keyshareServer.token)
224
			ks.pinCheck = true
Sietse Ringers's avatar
Sietse Ringers committed
225
226
227
		}
	}

228
	if ks.pinCheck {
Sietse Ringers's avatar
Sietse Ringers committed
229
		ks.sessionHandler.KeysharePin()
Sietse Ringers's avatar
Sietse Ringers committed
230
		ks.VerifyPin(-1)
231
232
	} else {
		ks.GetCommitments()
Sietse Ringers's avatar
Sietse Ringers committed
233
234
235
	}
}

236
237
238
func (ks *keyshareSession) fail(manager irma.SchemeManagerIdentifier, err error) {
	serr, ok := err.(*irma.SessionError)
	if ok {
Tomas's avatar
Tomas committed
239
240
		if serr.RemoteError != nil && len(serr.RemoteError.ErrorName) > 0 {
			switch serr.RemoteError.ErrorName {
241
242
			case "USER_NOT_FOUND":
				ks.sessionHandler.KeyshareEnrollmentDeleted(manager)
243
			case "USER_NOT_REGISTERED":
Sietse Ringers's avatar
Sietse Ringers committed
244
				ks.sessionHandler.KeyshareEnrollmentIncomplete(manager)
245
			case "USER_BLOCKED":
Tomas's avatar
Tomas committed
246
				duration, err := strconv.Atoi(serr.RemoteError.Message)
247
248
249
250
251
252
253
254
255
256
257
258
259
				if err != nil { // Not really clear what to do with duration, but should never happen anyway
					duration = -1
				}
				ks.sessionHandler.KeyshareBlocked(manager, duration)
			default:
				ks.sessionHandler.KeyshareError(&manager, err)
			}
		}
	} else {
		ks.sessionHandler.KeyshareError(&manager, err)
	}
}

Sietse Ringers's avatar
Sietse Ringers committed
260
261
262
// Ask for a pin, repeatedly if necessary, and either continue the keyshare protocol
// with authorization, or stop the keyshare protocol and inform of failure.
func (ks *keyshareSession) VerifyPin(attempts int) {
263
	ks.pinRequestor.RequestPin(attempts, PinHandler(func(proceed bool, pin string) {
264
265
		if !proceed {
			ks.sessionHandler.KeyshareCancelled()
Sietse Ringers's avatar
Sietse Ringers committed
266
			return
267
		}
268
		success, attemptsRemaining, blocked, manager, err := ks.verifyPinAttempt(pin)
Sietse Ringers's avatar
Sietse Ringers committed
269
		if err != nil {
270
			ks.sessionHandler.KeyshareError(&manager, err)
Sietse Ringers's avatar
Sietse Ringers committed
271
272
273
			return
		}
		if blocked != 0 {
274
			ks.sessionHandler.KeyshareBlocked(manager, blocked)
Sietse Ringers's avatar
Sietse Ringers committed
275
276
277
			return
		}
		if success {
Sietse Ringers's avatar
Sietse Ringers committed
278
			ks.sessionHandler.KeysharePinOK()
Sietse Ringers's avatar
Sietse Ringers committed
279
280
281
282
283
			ks.GetCommitments()
			return
		}
		// Not successful but no error and not yet blocked: try again
		ks.VerifyPin(attemptsRemaining)
284
	}))
Sietse Ringers's avatar
Sietse Ringers committed
285
286
}

287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
func verifyPinWorker(pin string, kss *keyshareServer, transport *irma.HTTPTransport) (
	success bool, tries int, blocked int, err error) {
	pinmsg := keysharePinMessage{Username: kss.Username, Pin: kss.HashedPin(pin)}
	pinresult := &keysharePinStatus{}
	err = transport.Post("users/verify/pin", pinresult, pinmsg)
	if err != nil {
		return
	}

	switch pinresult.Status {
	case kssPinSuccess:
		success = true
		kss.token = pinresult.Message
		transport.SetHeader(kssAuthHeader, kss.token)
		return
	case kssPinFailure:
		tries, err = strconv.Atoi(pinresult.Message)
		return
	case kssPinError:
		blocked, err = strconv.Atoi(pinresult.Message)
		return
	default:
309
310
311
312
313
		err = &irma.SessionError{
			Err:       errors.New("Keyshare server returned unrecognized PIN status"),
			ErrorType: irma.ErrorServerResponse,
			Info:      "Keyshare server returned unrecognized PIN status",
		}
314
315
316
317
		return
	}
}

Sietse Ringers's avatar
Sietse Ringers committed
318
319
320
321
322
323
324
325
// Verify the specified pin at each of the keyshare servers involved in the specified session.
// - If the pin did not verify at one of the keyshare servers but there are attempts remaining,
// the amount of remaining attempts is returned as the second return value.
// - If the pin did not verify at one of the keyshare servers and there are no attempts remaining,
// the amount of time for which we are blocked at the keyshare server is returned as the third
// parameter.
// - If this or anything else (specified in err) goes wrong, success will be false.
// If all is ok, success will be true.
326
327
328
329
func (ks *keyshareSession) verifyPinAttempt(pin string) (
	success bool, tries int, blocked int, manager irma.SchemeManagerIdentifier, err error) {
	for manager = range ks.session.Identifiers().SchemeManagers {
		if !ks.conf.SchemeManagers[manager].Distributed() {
Sietse Ringers's avatar
Sietse Ringers committed
330
331
332
			continue
		}

333
334
		kss := ks.keyshareServers[manager]
		transport := ks.transports[manager]
335
336
		success, tries, blocked, err = verifyPinWorker(pin, kss, transport)
		if !success {
Sietse Ringers's avatar
Sietse Ringers committed
337
338
339
340
341
342
343
344
345
346
			return
		}
	}
	return
}

// GetCommitments gets the commitments (first message in Schnorr zero-knowledge protocol)
// of all keyshare servers of their part of the private key, and merges these commitments
// in our own proof builders.
func (ks *keyshareSession) GetCommitments() {
347
	pkids := map[irma.SchemeManagerIdentifier][]*publicKeyIdentifier{}
Sietse Ringers's avatar
Sietse Ringers committed
348
349
350
351
352
353
	commitments := map[publicKeyIdentifier]*gabi.ProofPCommitment{}

	// For each scheme manager, build a list of public keys under this manager
	// that we will use in the keyshare protocol with the keyshare server of this manager
	for _, builder := range ks.builders {
		pk := builder.PublicKey()
354
		managerID := irma.NewIssuerIdentifier(pk.Issuer).SchemeManagerIdentifier()
355
		if !ks.conf.SchemeManagers[managerID].Distributed() {
Sietse Ringers's avatar
Sietse Ringers committed
356
357
			continue
		}
358
359
		if _, contains := pkids[managerID]; !contains {
			pkids[managerID] = []*publicKeyIdentifier{}
Sietse Ringers's avatar
Sietse Ringers committed
360
		}
361
		pkids[managerID] = append(pkids[managerID], &publicKeyIdentifier{Issuer: pk.Issuer, Counter: pk.Counter})
Sietse Ringers's avatar
Sietse Ringers committed
362
363
364
365
	}

	// Now inform each keyshare server of with respect to which public keys
	// we want them to send us commitments
366
	for managerID := range ks.session.Identifiers().SchemeManagers {
367
		if !ks.conf.SchemeManagers[managerID].Distributed() {
Sietse Ringers's avatar
Sietse Ringers committed
368
369
370
			continue
		}

371
		transport := ks.transports[managerID]
Sietse Ringers's avatar
Sietse Ringers committed
372
		comms := &proofPCommitmentMap{}
373
		err := transport.Post("prove/getCommitments", comms, pkids[managerID])
Sietse Ringers's avatar
Sietse Ringers committed
374
		if err != nil {
375
376
377
378
379
380
381
382
			if err.(*irma.SessionError).RemoteError.Status == http.StatusForbidden && !ks.pinCheck {
				// JWT may be out of date due to clock drift; request pin and try again
				// (but only if we did not ask for a PIN earlier)
				ks.pinCheck = false
				ks.sessionHandler.KeysharePin()
				ks.VerifyPin(-1)
				return
			}
383
			ks.sessionHandler.KeyshareError(&managerID, err)
Sietse Ringers's avatar
Sietse Ringers committed
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
			return
		}
		for pki, c := range comms.Commitments {
			commitments[pki] = c
		}
	}

	// Merge in the commitments
	for _, builder := range ks.builders {
		pk := builder.PublicKey()
		pki := publicKeyIdentifier{Issuer: pk.Issuer, Counter: pk.Counter}
		comm, distributed := commitments[pki]
		if !distributed {
			continue
		}
		builder.MergeProofPCommitment(comm)
	}

	ks.GetProofPs()
}

// GetProofPs uses the combined commitments of all keyshare servers and ourself
// to calculate the challenge, which is sent to the keyshare servers in order to
// receive their responses (2nd and 3rd message in Schnorr zero-knowledge protocol).
func (ks *keyshareSession) GetProofPs() {
409
	_, issig := ks.session.(*irma.SignatureRequest)
410
	challenge := ks.builders.Challenge(ks.session.Base().GetContext(), ks.session.GetNonce(ks.timestamp), issig)
Sietse Ringers's avatar
Sietse Ringers committed
411
412

	// Post the challenge, obtaining JWT's containing the ProofP's
413
	responses := map[irma.SchemeManagerIdentifier]string{}
414
	for managerID := range ks.session.Identifiers().SchemeManagers {
415
		transport, distributed := ks.transports[managerID]
Sietse Ringers's avatar
Sietse Ringers committed
416
417
418
		if !distributed {
			continue
		}
419
420
		var j string
		err := transport.Post("prove/getResponse", &j, challenge)
Sietse Ringers's avatar
Sietse Ringers committed
421
		if err != nil {
422
			ks.sessionHandler.KeyshareError(&managerID, err)
Sietse Ringers's avatar
Sietse Ringers committed
423
424
			return
		}
425
		responses[managerID] = j
Sietse Ringers's avatar
Sietse Ringers committed
426
427
428
429
430
431
432
433
	}

	ks.Finish(challenge, responses)
}

// Finish the keyshare protocol: in case of issuance, put the keyshare jwt in the
// IssueCommitmentMessage; in case of disclosure and signing, parse each keyshare jwt,
// merge in the received ProofP's, and finish.
434
func (ks *keyshareSession) Finish(challenge *big.Int, responses map[irma.SchemeManagerIdentifier]string) {
Sietse Ringers's avatar
Sietse Ringers committed
435
	switch ks.session.(type) {
436
	case *irma.DisclosureRequest: // Can't use fallthrough in a type switch in go
437
		ks.finishDisclosureOrSigning(challenge, responses)
438
	case *irma.SignatureRequest: // So we have to do this in a separate method
439
		ks.finishDisclosureOrSigning(challenge, responses)
440
	case *irma.IssuanceRequest:
Sietse Ringers's avatar
Sietse Ringers committed
441
442
443
		// Calculate IssueCommitmentMessage, without merging in any of the received ProofP's:
		// instead, include the keyshare server's JWT in the IssueCommitmentMessage for the
		// issuance server to verify
444
		list, err := ks.builders.BuildDistributedProofList(challenge, nil)
Sietse Ringers's avatar
Sietse Ringers committed
445
		if err != nil {
446
			ks.sessionHandler.KeyshareError(&ks.keyshareServer.SchemeManagerIdentifier, err)
Sietse Ringers's avatar
Sietse Ringers committed
447
448
			return
		}
449
		message := &gabi.IssueCommitmentMessage{Proofs: list, Nonce2: ks.issuerProofNonce}
Sietse Ringers's avatar
Sietse Ringers committed
450
451
452
		message.ProofPjwts = map[string]string{}
		for manager, response := range responses {
			message.ProofPjwts[manager.String()] = response
Sietse Ringers's avatar
Sietse Ringers committed
453
454
455
456
457
		}
		ks.sessionHandler.KeyshareDone(message)
	}
}

458
func (ks *keyshareSession) finishDisclosureOrSigning(challenge *big.Int, responses map[irma.SchemeManagerIdentifier]string) {
459
460
461
	proofPs := make([]*gabi.ProofP, len(ks.builders))
	for i, builder := range ks.builders {
		// Parse each received JWT
462
		managerID := irma.NewIssuerIdentifier(builder.PublicKey().Issuer).SchemeManagerIdentifier()
463
		if !ks.conf.SchemeManagers[managerID].Distributed() {
464
465
			continue
		}
466
467
		claims := struct {
			jwt.StandardClaims
468
469
			ProofP *gabi.ProofP
		}{}
470
471
472
		parser := new(jwt.Parser)
		parser.SkipClaimsValidation = true // no need to abort due to clock drift issues
		if _, err := parser.ParseWithClaims(responses[managerID], &claims, ks.conf.KeyshareServerKeyFunc(managerID)); err != nil {
473
			ks.sessionHandler.KeyshareError(&managerID, err)
474
475
			return
		}
476
		proofPs[i] = claims.ProofP
477
478
479
480
481
	}

	// Create merged proofs and finish protocol
	list, err := ks.builders.BuildDistributedProofList(challenge, proofPs)
	if err != nil {
482
		ks.sessionHandler.KeyshareError(nil, err)
483
484
485
486
		return
	}
	ks.sessionHandler.KeyshareDone(list)
}