keyshare.go 14.5 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
28
29
	KeyshareBlocked(manager irma.SchemeManagerIdentifier, duration int)
	// 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
30
31
	KeysharePin()
	KeysharePinOK()
Sietse Ringers's avatar
Sietse Ringers committed
32
33
34
}

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

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

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

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

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

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"
)

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

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

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

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

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

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

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

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

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

// 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) {
220
	ks.pinRequestor.RequestPin(attempts, PinHandler(func(proceed bool, pin string) {
221
222
		if !proceed {
			ks.sessionHandler.KeyshareCancelled()
Sietse Ringers's avatar
Sietse Ringers committed
223
			return
224
		}
225
		success, attemptsRemaining, blocked, manager, err := ks.verifyPinAttempt(pin)
Sietse Ringers's avatar
Sietse Ringers committed
226
		if err != nil {
227
			ks.sessionHandler.KeyshareError(&manager, err)
Sietse Ringers's avatar
Sietse Ringers committed
228
229
230
			return
		}
		if blocked != 0 {
231
			ks.sessionHandler.KeyshareBlocked(manager, blocked)
Sietse Ringers's avatar
Sietse Ringers committed
232
233
234
			return
		}
		if success {
Sietse Ringers's avatar
Sietse Ringers committed
235
			ks.sessionHandler.KeysharePinOK()
Sietse Ringers's avatar
Sietse Ringers committed
236
237
238
239
240
			ks.GetCommitments()
			return
		}
		// Not successful but no error and not yet blocked: try again
		ks.VerifyPin(attemptsRemaining)
241
	}))
Sietse Ringers's avatar
Sietse Ringers committed
242
243
244
245
246
247
248
249
250
251
}

// 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.
252
253
254
255
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
256
257
258
			continue
		}

259
260
		kss := ks.keyshareServers[manager]
		transport := ks.transports[manager]
Sietse Ringers's avatar
Sietse Ringers committed
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
		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() {
292
	pkids := map[irma.SchemeManagerIdentifier][]*publicKeyIdentifier{}
Sietse Ringers's avatar
Sietse Ringers committed
293
294
295
296
297
298
	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()
299
		managerID := irma.NewIssuerIdentifier(pk.Issuer).SchemeManagerIdentifier()
300
		if !ks.conf.SchemeManagers[managerID].Distributed() {
Sietse Ringers's avatar
Sietse Ringers committed
301
302
			continue
		}
303
304
		if _, contains := pkids[managerID]; !contains {
			pkids[managerID] = []*publicKeyIdentifier{}
Sietse Ringers's avatar
Sietse Ringers committed
305
		}
306
		pkids[managerID] = append(pkids[managerID], &publicKeyIdentifier{Issuer: pk.Issuer, Counter: pk.Counter})
Sietse Ringers's avatar
Sietse Ringers committed
307
308
309
310
	}

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

316
		transport := ks.transports[managerID]
Sietse Ringers's avatar
Sietse Ringers committed
317
		comms := &proofPCommitmentMap{}
318
		err := transport.Post("prove/getCommitments", comms, pkids[managerID])
Sietse Ringers's avatar
Sietse Ringers committed
319
		if err != nil {
320
			ks.sessionHandler.KeyshareError(&managerID, err)
Sietse Ringers's avatar
Sietse Ringers committed
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
			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() {
346
347
	_, issig := ks.session.(*irma.SignatureRequest)
	_, issuing := ks.session.(*irma.IssuanceRequest)
348
	challenge := ks.builders.Challenge(ks.session.GetContext(), ks.session.GetNonce(), issig)
Sietse Ringers's avatar
Sietse Ringers committed
349
350
351
352
353
354
	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 {
355
			ks.sessionHandler.KeyshareError(&ks.keyshareServer.SchemeManagerIdentifier, err)
Sietse Ringers's avatar
Sietse Ringers committed
356
357
358
359
360
		}
		kssChallenge = new(big.Int).SetBytes(bytes)
	}

	// Post the challenge, obtaining JWT's containing the ProofP's
361
	responses := map[irma.SchemeManagerIdentifier]string{}
362
	for managerID := range ks.session.Identifiers().SchemeManagers {
363
		transport, distributed := ks.transports[managerID]
Sietse Ringers's avatar
Sietse Ringers committed
364
365
366
367
368
369
		if !distributed {
			continue
		}
		var jwt string
		err := transport.Post("prove/getResponse", &jwt, kssChallenge)
		if err != nil {
370
			ks.sessionHandler.KeyshareError(&managerID, err)
Sietse Ringers's avatar
Sietse Ringers committed
371
372
			return
		}
373
		responses[managerID] = jwt
Sietse Ringers's avatar
Sietse Ringers committed
374
375
376
377
378
379
380
381
	}

	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.
382
func (ks *keyshareSession) Finish(challenge *big.Int, responses map[irma.SchemeManagerIdentifier]string) {
Sietse Ringers's avatar
Sietse Ringers committed
383
	switch ks.session.(type) {
384
	case *irma.DisclosureRequest: // Can't use fallthrough in a type switch in go
385
		ks.finishDisclosureOrSigning(challenge, responses)
386
	case *irma.SignatureRequest: // So we have to do this in a separate method
387
		ks.finishDisclosureOrSigning(challenge, responses)
388
	case *irma.IssuanceRequest:
Sietse Ringers's avatar
Sietse Ringers committed
389
390
391
		// 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
392
		list, err := ks.builders.BuildDistributedProofList(challenge, nil)
Sietse Ringers's avatar
Sietse Ringers committed
393
		if err != nil {
394
			ks.sessionHandler.KeyshareError(&ks.keyshareServer.SchemeManagerIdentifier, err)
Sietse Ringers's avatar
Sietse Ringers committed
395
396
			return
		}
397
		message := &gabi.IssueCommitmentMessage{Proofs: list, Nonce2: ks.state.nonce2}
398
399
400
		for _, response := range responses {
			message.ProofPjwt = response
			break
Sietse Ringers's avatar
Sietse Ringers committed
401
		}
402
403
404
405
406
		// 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
407
408
409
410
		ks.sessionHandler.KeyshareDone(message)
	}
}

411
func (ks *keyshareSession) finishDisclosureOrSigning(challenge *big.Int, responses map[irma.SchemeManagerIdentifier]string) {
412
413
414
	proofPs := make([]*gabi.ProofP, len(ks.builders))
	for i, builder := range ks.builders {
		// Parse each received JWT
415
		managerID := irma.NewIssuerIdentifier(builder.PublicKey().Issuer).SchemeManagerIdentifier()
416
		if !ks.conf.SchemeManagers[managerID].Distributed() {
417
418
419
420
421
			continue
		}
		msg := struct {
			ProofP *gabi.ProofP
		}{}
422
		if err := irma.JwtDecode(responses[managerID], &msg); err != nil {
423
			ks.sessionHandler.KeyshareError(&managerID, err)
424
425
426
427
428
429
430
			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 {
431
			ks.sessionHandler.KeyshareError(&managerID, err)
432
433
434
435
436
437
438
439
			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 {
440
		ks.sessionHandler.KeyshareError(nil, err)
441
442
443
444
		return
	}
	ks.sessionHandler.KeyshareDone(list)
}