keyshare.go 14.6 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
	KeyshareEnrollmentDeleted(manager irma.SchemeManagerIdentifier)
30
31
	// 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
32
33
	KeysharePin()
	KeysharePinOK()
Sietse Ringers's avatar
Sietse Ringers committed
34
35
36
}

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

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

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

63
type keyshareChangepin struct {
64
	Username string `json:"id"`
65
66
	OldPin   string `json:"oldpin"`
	NewPin   string `json:"newpin"`
67
68
}

Sietse Ringers's avatar
Sietse Ringers committed
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
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"`
}

89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
// 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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121

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

122
123
func newKeyshareServer(
	schemeManagerIdentifier irma.SchemeManagerIdentifier,
124
	url string,
125
) (ks *keyshareServer, err error) {
Sietse Ringers's avatar
Sietse Ringers committed
126
	ks = &keyshareServer{
127
128
		Nonce: make([]byte, 32),
		URL:   url,
129
		SchemeManagerIdentifier: schemeManagerIdentifier,
Sietse Ringers's avatar
Sietse Ringers committed
130
	}
131
132
133
134
135
136
	_, err = rand.Read(ks.Nonce)
	return
}

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

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

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

185
	requestPin := false
Sietse Ringers's avatar
Sietse Ringers committed
186

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

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

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

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

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

// 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.
281
282
283
284
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
285
286
287
			continue
		}

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

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

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

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

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

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

		proofPs[i] = msg.ProofP
	}

	// Create merged proofs and finish protocol
	list, err := ks.builders.BuildDistributedProofList(challenge, proofPs)
	if err != nil {
451
		ks.sessionHandler.KeyshareError(nil, err)
452
453
454
455
		return
	}
	ks.sessionHandler.KeyshareDone(list)
}