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
119
120
func newKeyshareServer(
	schemeManagerIdentifier irma.SchemeManagerIdentifier,
	privatekey *paillierPrivateKey,
	url, email string,
) (ks *keyshareServer, err error) {
Sietse Ringers's avatar
Sietse Ringers committed
121
	ks = &keyshareServer{
122
123
124
125
126
		Nonce:                   make([]byte, 32),
		URL:                     url,
		Username:                email,
		PrivateKey:              privatekey,
		SchemeManagerIdentifier: schemeManagerIdentifier,
Sietse Ringers's avatar
Sietse Ringers committed
127
	}
128
129
130
131
132
133
	_, err = rand.Read(ks.Nonce)
	return
}

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

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

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

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

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

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

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

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

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

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

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

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

340
		transport := ks.transports[managerID]
Sietse Ringers's avatar
Sietse Ringers committed
341
		comms := &proofPCommitmentMap{}
342
		err := transport.Post("prove/getCommitments", comms, pkids[managerID])
Sietse Ringers's avatar
Sietse Ringers committed
343
		if err != nil {
344
			ks.sessionHandler.KeyshareError(&managerID, err)
Sietse Ringers's avatar
Sietse Ringers committed
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
			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() {
370
371
	_, issig := ks.session.(*irma.SignatureRequest)
	_, issuing := ks.session.(*irma.IssuanceRequest)
372
	challenge := ks.builders.Challenge(ks.session.GetContext(), ks.session.GetNonce(), issig)
Sietse Ringers's avatar
Sietse Ringers committed
373
374
375
376
377
378
	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 {
379
			ks.sessionHandler.KeyshareError(&ks.keyshareServer.SchemeManagerIdentifier, err)
Sietse Ringers's avatar
Sietse Ringers committed
380
381
382
383
384
		}
		kssChallenge = new(big.Int).SetBytes(bytes)
	}

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

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

435
func (ks *keyshareSession) finishDisclosureOrSigning(challenge *big.Int, responses map[irma.SchemeManagerIdentifier]string) {
436
437
438
	proofPs := make([]*gabi.ProofP, len(ks.builders))
	for i, builder := range ks.builders {
		// Parse each received JWT
439
		managerID := irma.NewIssuerIdentifier(builder.PublicKey().Issuer).SchemeManagerIdentifier()
440
		if !ks.conf.SchemeManagers[managerID].Distributed() {
441
442
443
444
445
			continue
		}
		msg := struct {
			ProofP *gabi.ProofP
		}{}
446
		if err := irma.JwtDecode(responses[managerID], &msg); err != nil {
447
			ks.sessionHandler.KeyshareError(&managerID, err)
448
449
450
451
452
453
454
			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 {
455
			ks.sessionHandler.KeyshareError(&managerID, err)
456
457
458
459
460
461
462
463
			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 {
464
		ks.sessionHandler.KeyshareError(nil, err)
465
466
467
468
		return
	}
	ks.sessionHandler.KeyshareDone(list)
}