keyshare.go 15.3 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
	"math/big"
Sietse Ringers's avatar
Sietse Ringers committed
8
9
	"strconv"

Sietse Ringers's avatar
Sietse Ringers committed
10
	"github.com/go-errors/errors"
Sietse Ringers's avatar
Sietse Ringers committed
11
	"github.com/mhe/gabi"
12
	"github.com/privacybydesign/irmago"
13
14
)

15
16
// 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
17
// (currently only Client).
18

19
// KeysharePinRequestor is used to asking the user for his PIN.
Sietse Ringers's avatar
Sietse Ringers committed
20
type KeysharePinRequestor interface {
21
	RequestPin(remainingAttempts int, callback PinHandler)
Sietse Ringers's avatar
Sietse Ringers committed
22
23
24
}

type keyshareSessionHandler interface {
Sietse Ringers's avatar
Sietse Ringers committed
25
	KeyshareDone(message interface{})
Sietse Ringers's avatar
Sietse Ringers committed
26
	KeyshareCancelled()
27
	KeyshareBlocked(manager irma.SchemeManagerIdentifier, duration int)
Sietse Ringers's avatar
Sietse Ringers committed
28
	KeyshareEnrollmentIncomplete(manager irma.SchemeManagerIdentifier)
29
30
	// 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
31
32
	KeysharePin()
	KeysharePinOK()
Sietse Ringers's avatar
Sietse Ringers committed
33
34
35
}

type keyshareSession struct {
36
37
38
	sessionHandler  keyshareSessionHandler
	pinRequestor    KeysharePinRequestor
	builders        gabi.ProofBuilderList
39
	session         irma.IrmaSession
40
	conf            *irma.Configuration
41
	keyshareServers map[irma.SchemeManagerIdentifier]*keyshareServer
42
	keyshareServer  *keyshareServer // The one keyshare server in use in case of issuance
43
	transports      map[irma.SchemeManagerIdentifier]*irma.HTTPTransport
44
	state           *issuanceState
Sietse Ringers's avatar
Sietse Ringers committed
45
46
}

47
type keyshareServer struct {
48
49
50
51
52
53
	URL                     string              `json:"url"`
	Username                string              `json:"username"`
	Nonce                   []byte              `json:"nonce"`
	PrivateKey              *paillierPrivateKey `json:"keyPair"`
	SchemeManagerIdentifier irma.SchemeManagerIdentifier
	token                   string
54
55
}

56
type keyshareEnrollment struct {
Sietse Ringers's avatar
Sietse Ringers committed
57
58
	Username  string             `json:"username"`
	Pin       string             `json:"pin"`
Sietse Ringers's avatar
Sietse Ringers committed
59
	PublicKey *paillierPublicKey `json:"publicKey"`
60
	Email     *string            `json:"email"`
Sietse Ringers's avatar
Sietse Ringers committed
61
62
}

Sietse Ringers's avatar
Sietse Ringers committed
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
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"`
}

83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
// TODO enable this when updating protocol
//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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

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

const (
	kssUsernameHeader = "IRMA_Username"
	kssAuthHeader     = "IRMA_Authorization"
	kssAuthorized     = "authorized"
	kssTokenExpired   = "expired"
	kssPinSuccess     = "success"
	kssPinFailure     = "failure"
	kssPinError       = "error"
)

116
117
118
func newKeyshareServer(
	schemeManagerIdentifier irma.SchemeManagerIdentifier,
	privatekey *paillierPrivateKey,
119
	url string,
120
) (ks *keyshareServer, err error) {
Sietse Ringers's avatar
Sietse Ringers committed
121
	ks = &keyshareServer{
122
123
124
125
		Nonce:                   make([]byte, 32),
		URL:                     url,
		PrivateKey:              privatekey,
		SchemeManagerIdentifier: schemeManagerIdentifier,
Sietse Ringers's avatar
Sietse Ringers committed
126
	}
127
128
129
130
131
132
	_, err = rand.Read(ks.Nonce)
	return
}

func (ks *keyshareServer) HashedPin(pin string) string {
	hash := sha256.Sum256(append(ks.Nonce, []byte(pin)...))
133
134
135
136
	// 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"
137
}
Sietse Ringers's avatar
Sietse Ringers committed
138

Sietse Ringers's avatar
Sietse Ringers committed
139
140
141
142
143
144
145
146
// 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,
147
	builders gabi.ProofBuilderList,
148
	session irma.IrmaSession,
149
	conf *irma.Configuration,
150
	keyshareServers map[irma.SchemeManagerIdentifier]*keyshareServer,
151
	state *issuanceState,
Sietse Ringers's avatar
Sietse Ringers committed
152
153
) {
	ksscount := 0
154
	for managerID := range session.Identifiers().SchemeManagers {
155
		if conf.SchemeManagers[managerID].Distributed() {
Sietse Ringers's avatar
Sietse Ringers committed
156
			ksscount++
157
158
			if _, enrolled := keyshareServers[managerID]; !enrolled {
				err := errors.New("Not enrolled to keyshare server of scheme manager " + managerID.String())
159
				sessionHandler.KeyshareError(&managerID, err)
Sietse Ringers's avatar
Sietse Ringers committed
160
161
162
163
				return
			}
		}
	}
164
	if _, issuing := session.(*irma.IssuanceRequest); issuing && ksscount > 1 {
Sietse Ringers's avatar
Sietse Ringers committed
165
		err := errors.New("Issuance session involving more than one keyshare servers are not supported")
166
		sessionHandler.KeyshareError(nil, err)
Sietse Ringers's avatar
Sietse Ringers committed
167
168
169
170
		return
	}

	ks := &keyshareSession{
171
172
173
		session:         session,
		builders:        builders,
		sessionHandler:  sessionHandler,
174
		transports:      map[irma.SchemeManagerIdentifier]*irma.HTTPTransport{},
175
		pinRequestor:    pin,
176
		conf:            conf,
177
		keyshareServers: keyshareServers,
178
		state:           state,
Sietse Ringers's avatar
Sietse Ringers committed
179
180
	}

181
	requestPin := false
Sietse Ringers's avatar
Sietse Ringers committed
182

183
	for managerID := range session.Identifiers().SchemeManagers {
184
		if !ks.conf.SchemeManagers[managerID].Distributed() {
Sietse Ringers's avatar
Sietse Ringers committed
185
186
187
			continue
		}

188
		ks.keyshareServer = ks.keyshareServers[managerID]
189
		transport := irma.NewHTTPTransport(ks.keyshareServer.URL)
Sietse Ringers's avatar
Sietse Ringers committed
190
191
		transport.SetHeader(kssUsernameHeader, ks.keyshareServer.Username)
		transport.SetHeader(kssAuthHeader, ks.keyshareServer.token)
192
		ks.transports[managerID] = transport
Sietse Ringers's avatar
Sietse Ringers committed
193
194
195
196

		authstatus := &keyshareAuthorization{}
		err := transport.Post("users/isAuthorized", authstatus, "")
		if err != nil {
197
			ks.fail(managerID, err)
Sietse Ringers's avatar
Sietse Ringers committed
198
199
200
201
202
			return
		}
		switch authstatus.Status {
		case kssAuthorized: // nop
		case kssTokenExpired:
203
			requestPin = true
Sietse Ringers's avatar
Sietse Ringers committed
204
		default:
205
			ks.sessionHandler.KeyshareError(&managerID, errors.New("Keyshare server returned unrecognized authorization status"))
Sietse Ringers's avatar
Sietse Ringers committed
206
207
208
209
			return
		}
	}

210
	if requestPin {
Sietse Ringers's avatar
Sietse Ringers committed
211
		ks.sessionHandler.KeysharePin()
Sietse Ringers's avatar
Sietse Ringers committed
212
		ks.VerifyPin(-1)
213
214
	} else {
		ks.GetCommitments()
Sietse Ringers's avatar
Sietse Ringers committed
215
216
217
	}
}

218
219
220
func (ks *keyshareSession) fail(manager irma.SchemeManagerIdentifier, err error) {
	serr, ok := err.(*irma.SessionError)
	if ok {
Tomas's avatar
Tomas committed
221
222
		if serr.RemoteError != nil && len(serr.RemoteError.ErrorName) > 0 {
			switch serr.RemoteError.ErrorName {
223
			case "USER_NOT_REGISTERED":
Sietse Ringers's avatar
Sietse Ringers committed
224
				ks.sessionHandler.KeyshareEnrollmentIncomplete(manager)
225
			case "USER_BLOCKED":
Tomas's avatar
Tomas committed
226
				duration, err := strconv.Atoi(serr.RemoteError.Message)
227
228
229
230
231
232
233
234
235
236
237
238
239
				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
240
241
242
// 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) {
243
	ks.pinRequestor.RequestPin(attempts, PinHandler(func(proceed bool, pin string) {
244
245
		if !proceed {
			ks.sessionHandler.KeyshareCancelled()
Sietse Ringers's avatar
Sietse Ringers committed
246
			return
247
		}
248
		success, attemptsRemaining, blocked, manager, err := ks.verifyPinAttempt(pin)
Sietse Ringers's avatar
Sietse Ringers committed
249
		if err != nil {
250
			ks.sessionHandler.KeyshareError(&manager, err)
Sietse Ringers's avatar
Sietse Ringers committed
251
252
253
			return
		}
		if blocked != 0 {
254
			ks.sessionHandler.KeyshareBlocked(manager, blocked)
Sietse Ringers's avatar
Sietse Ringers committed
255
256
257
			return
		}
		if success {
Sietse Ringers's avatar
Sietse Ringers committed
258
			ks.sessionHandler.KeysharePinOK()
Sietse Ringers's avatar
Sietse Ringers committed
259
260
261
262
263
			ks.GetCommitments()
			return
		}
		// Not successful but no error and not yet blocked: try again
		ks.VerifyPin(attemptsRemaining)
264
	}))
Sietse Ringers's avatar
Sietse Ringers committed
265
266
267
268
269
270
271
272
273
274
}

// 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.
275
276
277
278
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
279
280
281
			continue
		}

282
283
		kss := ks.keyshareServers[manager]
		transport := ks.transports[manager]
Sietse Ringers's avatar
Sietse Ringers committed
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
		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:
			kss.token = pinresult.Message
			transport.SetHeader(kssAuthHeader, kss.token)
		case kssPinFailure:
			tries, err = strconv.Atoi(pinresult.Message)
			return
		case kssPinError:
			blocked, err = strconv.Atoi(pinresult.Message)
			return
		default:
			err = errors.New("Keyshare server returned unrecognized PIN status")
			return
		}
	}

	success = true
	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() {
315
	pkids := map[irma.SchemeManagerIdentifier][]*publicKeyIdentifier{}
Sietse Ringers's avatar
Sietse Ringers committed
316
317
318
319
320
321
	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()
322
		managerID := irma.NewIssuerIdentifier(pk.Issuer).SchemeManagerIdentifier()
323
		if !ks.conf.SchemeManagers[managerID].Distributed() {
Sietse Ringers's avatar
Sietse Ringers committed
324
325
			continue
		}
326
327
		if _, contains := pkids[managerID]; !contains {
			pkids[managerID] = []*publicKeyIdentifier{}
Sietse Ringers's avatar
Sietse Ringers committed
328
		}
329
		pkids[managerID] = append(pkids[managerID], &publicKeyIdentifier{Issuer: pk.Issuer, Counter: pk.Counter})
Sietse Ringers's avatar
Sietse Ringers committed
330
331
332
333
	}

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

339
		transport := ks.transports[managerID]
Sietse Ringers's avatar
Sietse Ringers committed
340
		comms := &proofPCommitmentMap{}
341
		err := transport.Post("prove/getCommitments", comms, pkids[managerID])
Sietse Ringers's avatar
Sietse Ringers committed
342
		if err != nil {
343
			ks.sessionHandler.KeyshareError(&managerID, err)
Sietse Ringers's avatar
Sietse Ringers committed
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
			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() {
369
370
	_, issig := ks.session.(*irma.SignatureRequest)
	_, issuing := ks.session.(*irma.IssuanceRequest)
371
	challenge := ks.builders.Challenge(ks.session.GetContext(), ks.session.GetNonce(), issig)
Sietse Ringers's avatar
Sietse Ringers committed
372
373
374
375
376
377
	kssChallenge := challenge

	// In disclosure or signature sessions the challenge is Paillier encrypted.
	if !issuing {
		bytes, err := ks.keyshareServer.PrivateKey.Encrypt(challenge.Bytes())
		if err != nil {
378
			ks.sessionHandler.KeyshareError(&ks.keyshareServer.SchemeManagerIdentifier, err)
Sietse Ringers's avatar
Sietse Ringers committed
379
380
381
382
383
		}
		kssChallenge = new(big.Int).SetBytes(bytes)
	}

	// Post the challenge, obtaining JWT's containing the ProofP's
384
	responses := map[irma.SchemeManagerIdentifier]string{}
385
	for managerID := range ks.session.Identifiers().SchemeManagers {
386
		transport, distributed := ks.transports[managerID]
Sietse Ringers's avatar
Sietse Ringers committed
387
388
389
390
391
392
		if !distributed {
			continue
		}
		var jwt string
		err := transport.Post("prove/getResponse", &jwt, kssChallenge)
		if err != nil {
393
			ks.sessionHandler.KeyshareError(&managerID, err)
Sietse Ringers's avatar
Sietse Ringers committed
394
395
			return
		}
396
		responses[managerID] = jwt
Sietse Ringers's avatar
Sietse Ringers committed
397
398
399
400
401
402
403
404
	}

	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.
405
func (ks *keyshareSession) Finish(challenge *big.Int, responses map[irma.SchemeManagerIdentifier]string) {
Sietse Ringers's avatar
Sietse Ringers committed
406
	switch ks.session.(type) {
407
	case *irma.DisclosureRequest: // Can't use fallthrough in a type switch in go
408
		ks.finishDisclosureOrSigning(challenge, responses)
409
	case *irma.SignatureRequest: // So we have to do this in a separate method
410
		ks.finishDisclosureOrSigning(challenge, responses)
411
	case *irma.IssuanceRequest:
Sietse Ringers's avatar
Sietse Ringers committed
412
413
414
		// 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
415
		list, err := ks.builders.BuildDistributedProofList(challenge, nil)
Sietse Ringers's avatar
Sietse Ringers committed
416
		if err != nil {
417
			ks.sessionHandler.KeyshareError(&ks.keyshareServer.SchemeManagerIdentifier, err)
Sietse Ringers's avatar
Sietse Ringers committed
418
419
			return
		}
420
		message := &gabi.IssueCommitmentMessage{Proofs: list, Nonce2: ks.state.nonce2}
421
422
423
		for _, response := range responses {
			message.ProofPjwt = response
			break
Sietse Ringers's avatar
Sietse Ringers committed
424
		}
425
426
427
428
429
		// TODO for new protocol version
		//message.ProofPjwts = map[string]string{}
		//for manager, response := range responses {
		//	message.ProofPjwts[manager.String()] = response
		//}
Sietse Ringers's avatar
Sietse Ringers committed
430
431
432
433
		ks.sessionHandler.KeyshareDone(message)
	}
}

434
func (ks *keyshareSession) finishDisclosureOrSigning(challenge *big.Int, responses map[irma.SchemeManagerIdentifier]string) {
435
436
437
	proofPs := make([]*gabi.ProofP, len(ks.builders))
	for i, builder := range ks.builders {
		// Parse each received JWT
438
		managerID := irma.NewIssuerIdentifier(builder.PublicKey().Issuer).SchemeManagerIdentifier()
439
		if !ks.conf.SchemeManagers[managerID].Distributed() {
440
441
442
443
444
			continue
		}
		msg := struct {
			ProofP *gabi.ProofP
		}{}
445
		if err := irma.JwtDecode(responses[managerID], &msg); err != nil {
446
			ks.sessionHandler.KeyshareError(&managerID, err)
447
448
449
450
451
452
453
			return
		}

		// Decrypt the responses and populate a slice of ProofP's
		proofPs[i] = msg.ProofP
		bytes, err := ks.keyshareServer.PrivateKey.Decrypt(proofPs[i].SResponse.Bytes())
		if err != nil {
454
			ks.sessionHandler.KeyshareError(&managerID, err)
455
456
457
458
459
460
461
462
			return
		}
		proofPs[i].SResponse = new(big.Int).SetBytes(bytes)
	}

	// Create merged proofs and finish protocol
	list, err := ks.builders.BuildDistributedProofList(challenge, proofPs)
	if err != nil {
463
		ks.sessionHandler.KeyshareError(nil, err)
464
465
466
467
		return
	}
	ks.sessionHandler.KeyshareDone(list)
}