client.go 25 KB
Newer Older
1
package irmaclient
2
3

import (
Sietse Ringers's avatar
Sietse Ringers committed
4
	"math/big"
Sietse Ringers's avatar
Sietse Ringers committed
5
	"sort"
6
	"strconv"
7
	"time"
Sietse Ringers's avatar
Sietse Ringers committed
8

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

16
// This file contains most methods of the Client (c.f. session.go
Sietse Ringers's avatar
Sietse Ringers committed
17
18
// and updates.go).
//
Sietse Ringers's avatar
Sietse Ringers committed
19
20
21
22
23
24
25
26
// Clients are the main entry point into this package for the user of this package.
// The Client struct:
// - (De)serializes credentials and keyshare server information
// from storage, as well as logs of earlier IRMA sessions
// - it provides access to the attributes and all related information of its credentials,
// - it is the starting point for new IRMA sessions;
// - and it computes some of the messages in the client side of the IRMA protocol.
//
Sietse Ringers's avatar
Sietse Ringers committed
27
28
29
30
31
32
33
// The storage of credentials is split up in several parts:
//
// - The CL-signature of each credential is stored separately, so that we can
// load it on demand (i.e., during an IRMA session), instead of immediately
// at initialization.
//
// - The attributes of all credentials are stored together, as they all
34
// immediately need to be available anyway.
Sietse Ringers's avatar
Sietse Ringers committed
35
36
37
38
39
//
// - The secret key (the zeroth attribute of every credential), being the same
// across all credentials, is stored only once in a separate file (storing this
// in multiple places would be bad).

40
type Client struct {
Sietse Ringers's avatar
Sietse Ringers committed
41
	// Stuff we manage on disk
42
	secretkey        *secretKey
43
	attributes       map[irma.CredentialTypeIdentifier][]*irma.AttributeList
44
	credentialsCache map[irma.CredentialTypeIdentifier]map[int]*credential
45
	keyshareServers  map[irma.SchemeManagerIdentifier]*keyshareServer
Sietse Ringers's avatar
Sietse Ringers committed
46
	logs             []*LogEntry
Sietse Ringers's avatar
Sietse Ringers committed
47
	updates          []update
48

Sietse Ringers's avatar
Sietse Ringers committed
49
50
51
52
	// Where we store/load it to/from
	storage storage

	// Other state
53
54
55
56
57
58
	Preferences           Preferences
	Configuration         *irma.Configuration
	irmaConfigurationPath string
	androidStoragePath    string
	handler               ClientHandler
	state                 *issuanceState
59
60
}

61
62
63
64
// SentryDSN should be set in the init() function
// Setting it to an empty string means no crash reports
var SentryDSN = ""

65
66
type Preferences struct {
	EnableCrashReporting bool
67
68
}

69
var defaultPreferences = Preferences{
70
	EnableCrashReporting: true,
71
72
}

73
// KeyshareHandler is used for asking the user for his email address and PIN,
74
// for enrolling at a keyshare server.
75
type KeyshareHandler interface {
Tomas's avatar
Tomas committed
76
	EnrollmentFailure(manager irma.SchemeManagerIdentifier, err error)
77
	EnrollmentSuccess(manager irma.SchemeManagerIdentifier)
78
79
}

80
81
82
type ChangePinHandler interface {
	ChangePinFailure(manager irma.SchemeManagerIdentifier, err error)
	ChangePinSuccess(manager irma.SchemeManagerIdentifier)
83
84
	ChangePinIncorrect(manager irma.SchemeManagerIdentifier, attempts int)
	ChangePinBlocked(manager irma.SchemeManagerIdentifier, timeout int)
85
86
}

Sietse Ringers's avatar
Sietse Ringers committed
87
88
// ClientHandler informs the user that the configuration or the list of attributes
// that this client uses has been updated.
89
90
type ClientHandler interface {
	KeyshareHandler
91
	ChangePinHandler
92

93
	UpdateConfiguration(new *irma.IrmaIdentifierSet)
94
	UpdateAttributes()
Sietse Ringers's avatar
Sietse Ringers committed
95
96
}

97
98
99
100
type secretKey struct {
	Key *big.Int
}

101
// New creates a new Client that uses the directory
102
103
104
105
// specified by storagePath for (de)serializing itself. irmaConfigurationPath
// is the path to a (possibly readonly) folder containing irma_configuration;
// androidStoragePath is an optional path to the files of the old android app
// (specify "" if you do not want to parse the old android app files),
106
// and handler is used for informing the user of new stuff, and when a
107
// enrollment to a keyshare server needs to happen.
108
// The client returned by this function has been fully deserialized
109
110
// and is ready for use.
//
Sietse Ringers's avatar
Sietse Ringers committed
111
112
// NOTE: It is the responsibility of the caller that there exists a (properly
// protected) directory at storagePath!
113
func New(
114
115
116
	storagePath string,
	irmaConfigurationPath string,
	androidStoragePath string,
117
	handler ClientHandler,
118
) (*Client, error) {
119
	var err error
120
	if err = fs.AssertPathExists(storagePath); err != nil {
121
122
		return nil, err
	}
123
	if err = fs.AssertPathExists(irmaConfigurationPath); err != nil {
124
125
126
		return nil, err
	}

127
	cm := &Client{
128
		credentialsCache:      make(map[irma.CredentialTypeIdentifier]map[int]*credential),
129
130
		keyshareServers:       make(map[irma.SchemeManagerIdentifier]*keyshareServer),
		attributes:            make(map[irma.CredentialTypeIdentifier][]*irma.AttributeList),
131
132
		irmaConfigurationPath: irmaConfigurationPath,
		androidStoragePath:    androidStoragePath,
133
		handler:               handler,
134
135
	}

136
	cm.Configuration, err = irma.NewConfiguration(storagePath+"/irma_configuration", irmaConfigurationPath)
137
138
139
	if err != nil {
		return nil, err
	}
140

141
	schemeMgrErr := cm.Configuration.ParseOrRestoreFolder()
142
143
144
145
146
	// If schemMgrErr is of type SchemeManagerError, we continue and
	// return it at the end; otherwise bail out now
	_, isSchemeMgrErr := schemeMgrErr.(*irma.SchemeManagerError)
	if schemeMgrErr != nil && !isSchemeMgrErr {
		return nil, schemeMgrErr
147
	}
148
149

	// Ensure storage path exists, and populate it with necessary files
150
	cm.storage = storage{storagePath: storagePath, Configuration: cm.Configuration}
Sietse Ringers's avatar
Sietse Ringers committed
151
	if err = cm.storage.EnsureStorageExists(); err != nil {
152
153
154
		return nil, err
	}

155
	if cm.Preferences, err = cm.storage.LoadPreferences(); err != nil {
156
157
		return nil, err
	}
158
	cm.applyPreferences()
159

160
	// Perform new update functions from clientUpdates, if any
161
162
163
164
165
	if err = cm.update(); err != nil {
		return nil, err
	}

	// Load our stuff
Sietse Ringers's avatar
Sietse Ringers committed
166
	if cm.secretkey, err = cm.storage.LoadSecretKey(); err != nil {
167
168
		return nil, err
	}
Sietse Ringers's avatar
Sietse Ringers committed
169
	if cm.attributes, err = cm.storage.LoadAttributes(); err != nil {
170
171
		return nil, err
	}
172
	if cm.keyshareServers, err = cm.storage.LoadKeyshareServers(); err != nil {
173
174
175
		return nil, err
	}

176
	if len(cm.UnenrolledSchemeManagers()) > 1 {
177
178
179
		return nil, errors.New("Too many keyshare servers")
	}

180
	return cm, schemeMgrErr
181
182
}

183
// CredentialInfoList returns a list of information of all contained credentials.
184
185
func (client *Client) CredentialInfoList() irma.CredentialInfoList {
	list := irma.CredentialInfoList([]*irma.CredentialInfo{})
186

187
	for _, attrlistlist := range client.attributes {
188
189
		for index, attrlist := range attrlistlist {
			info := attrlist.Info()
190
191
192
			if info == nil {
				continue
			}
193
			info.Index = index
194
			list = append(list, info)
Sietse Ringers's avatar
Sietse Ringers committed
195
196
		}
	}
197

Sietse Ringers's avatar
Sietse Ringers committed
198
199
200
201
	sort.Sort(list)
	return list
}

202
// addCredential adds the specified credential to the Client, saving its signature
Sietse Ringers's avatar
Sietse Ringers committed
203
// imediately, and optionally cm.attributes as well.
204
func (client *Client) addCredential(cred *credential, storeAttributes bool) (err error) {
205
206
207
208
	id := irma.NewCredentialTypeIdentifier("")
	if cred.CredentialType() != nil {
		id = cred.CredentialType().Identifier()
	}
Sietse Ringers's avatar
Sietse Ringers committed
209

210
	// Don't add duplicate creds
211
	for _, attrlistlist := range client.attributes {
212
		for _, attrs := range attrlistlist {
213
			if attrs.Hash() == cred.AttributeList().Hash() {
214
215
216
217
218
219
				return nil
			}
		}
	}

	// If this is a singleton credential type, ensure we have at most one by removing any previous instance
220
221
222
223
	if !id.Empty() && cred.CredentialType().IsSingleton {
		for len(client.attrs(id)) != 0 {
			client.remove(id, 0, false)
		}
224
225
226
	}

	// Append the new cred to our attributes and credentials
227
	client.attributes[id] = append(client.attrs(id), cred.AttributeList())
228
	if !id.Empty() {
229
230
		if _, exists := client.credentialsCache[id]; !exists {
			client.credentialsCache[id] = make(map[int]*credential)
231
232
		}
		counter := len(client.attributes[id]) - 1
233
		client.credentialsCache[id][counter] = cred
Sietse Ringers's avatar
Sietse Ringers committed
234
235
	}

236
	if err = client.storage.StoreSignature(cred); err != nil {
Sietse Ringers's avatar
Sietse Ringers committed
237
238
239
		return
	}
	if storeAttributes {
240
		err = client.storage.StoreAttributes(client.attributes)
Sietse Ringers's avatar
Sietse Ringers committed
241
242
243
244
245
246
247
248
249
250
251
252
253
254
	}
	return
}

func generateSecretKey() (*secretKey, error) {
	key, err := gabi.RandomBigInt(gabi.DefaultSystemParameters[1024].Lm)
	if err != nil {
		return nil, err
	}
	return &secretKey{Key: key}, nil
}

// Removal methods

255
func (client *Client) remove(id irma.CredentialTypeIdentifier, index int, storenow bool) error {
256
	// Remove attributes
257
	list, exists := client.attributes[id]
258
259
260
261
	if !exists || index >= len(list) {
		return errors.Errorf("Can't remove credential %s-%d: no such credential", id.String(), index)
	}
	attrs := list[index]
262
	client.attributes[id] = append(list[:index], list[index+1:]...)
263
	if storenow {
264
		if err := client.storage.StoreAttributes(client.attributes); err != nil {
Sietse Ringers's avatar
Sietse Ringers committed
265
266
			return err
		}
267
268
269
	}

	// Remove credential
270
	if creds, exists := client.credentialsCache[id]; exists {
271
		if _, exists := creds[index]; exists {
Sietse Ringers's avatar
Sietse Ringers committed
272
			delete(creds, index)
273
			client.credentialsCache[id] = creds
274
275
276
277
		}
	}

	// Remove signature from storage
278
	if err := client.storage.DeleteSignature(attrs); err != nil {
279
280
281
		return err
	}

282
	removed := map[irma.CredentialTypeIdentifier][]irma.TranslatedString{}
283
284
285
	removed[id] = attrs.Strings()

	if storenow {
286
		return client.addLogEntry(&LogEntry{
287
			Type:    actionRemoval,
288
			Time:    irma.Timestamp(time.Now()),
289
290
291
292
			Removed: removed,
		})
	}
	return nil
293
294
}

Sietse Ringers's avatar
Sietse Ringers committed
295
// RemoveCredential removes the specified credential.
296
func (client *Client) RemoveCredential(id irma.CredentialTypeIdentifier, index int) error {
297
	return client.remove(id, index, true)
298
299
}

Sietse Ringers's avatar
Sietse Ringers committed
300
// RemoveCredentialByHash removes the specified credential.
301
302
func (client *Client) RemoveCredentialByHash(hash string) error {
	cred, index, err := client.credentialByHash(hash)
303
304
305
	if err != nil {
		return err
	}
306
	return client.RemoveCredential(cred.CredentialType().Identifier(), index)
307
308
}

Sietse Ringers's avatar
Sietse Ringers committed
309
// RemoveAllCredentials removes all credentials.
310
func (client *Client) RemoveAllCredentials() error {
311
	removed := map[irma.CredentialTypeIdentifier][]irma.TranslatedString{}
312
	for _, attrlistlist := range client.attributes {
Sietse Ringers's avatar
Sietse Ringers committed
313
314
315
316
		for _, attrs := range attrlistlist {
			if attrs.CredentialType() != nil {
				removed[attrs.CredentialType().Identifier()] = attrs.Strings()
			}
317
			client.storage.DeleteSignature(attrs)
318
319
		}
	}
320
	client.attributes = map[irma.CredentialTypeIdentifier][]*irma.AttributeList{}
321
	if err := client.storage.StoreAttributes(client.attributes); err != nil {
322
323
		return err
	}
324
325
326

	logentry := &LogEntry{
		Type:    actionRemoval,
327
		Time:    irma.Timestamp(time.Now()),
328
329
		Removed: removed,
	}
330
	if err := client.addLogEntry(logentry); err != nil {
331
332
		return err
	}
333
	return client.storage.StoreLogs(client.logs)
334
335
}

336
// Attribute and credential getter methods
Sietse Ringers's avatar
Sietse Ringers committed
337

Sietse Ringers's avatar
Sietse Ringers committed
338
// attrs returns cm.attributes[id], initializing it to an empty slice if neccesary
339
func (client *Client) attrs(id irma.CredentialTypeIdentifier) []*irma.AttributeList {
340
	list, exists := client.attributes[id]
Sietse Ringers's avatar
Sietse Ringers committed
341
	if !exists {
342
		list = make([]*irma.AttributeList, 0, 1)
343
		client.attributes[id] = list
Sietse Ringers's avatar
Sietse Ringers committed
344
345
346
347
348
	}
	return list
}

// creds returns cm.credentials[id], initializing it to an empty map if neccesary
349
func (client *Client) creds(id irma.CredentialTypeIdentifier) map[int]*credential {
350
	list, exists := client.credentialsCache[id]
Sietse Ringers's avatar
Sietse Ringers committed
351
	if !exists {
Sietse Ringers's avatar
Sietse Ringers committed
352
		list = make(map[int]*credential)
353
		client.credentialsCache[id] = list
Sietse Ringers's avatar
Sietse Ringers committed
354
355
356
357
	}
	return list
}

Sietse Ringers's avatar
Sietse Ringers committed
358
// Attributes returns the attribute list of the requested credential, or nil if we do not have it.
359
func (client *Client) Attributes(id irma.CredentialTypeIdentifier, counter int) (attributes *irma.AttributeList) {
360
	list := client.attrs(id)
Sietse Ringers's avatar
Sietse Ringers committed
361
	if len(list) <= counter {
Sietse Ringers's avatar
Sietse Ringers committed
362
363
364
365
366
		return
	}
	return list[counter]
}

367
368
func (client *Client) credentialByHash(hash string) (*credential, int, error) {
	for _, attrlistlist := range client.attributes {
369
		for index, attrs := range attrlistlist {
370
			if attrs.Hash() == hash {
371
				cred, err := client.credential(attrs.CredentialType().Identifier(), index)
372
373
374
375
376
377
378
				return cred, index, err
			}
		}
	}
	return nil, 0, nil
}

379
func (client *Client) credentialByID(id irma.CredentialIdentifier) (*credential, error) {
380
	if _, exists := client.attributes[id.Type]; !exists {
Sietse Ringers's avatar
Sietse Ringers committed
381
382
		return nil, nil
	}
383
	for index, attrs := range client.attributes[id.Type] {
384
		if attrs.Hash() == id.Hash {
385
			return client.credential(attrs.CredentialType().Identifier(), index)
Sietse Ringers's avatar
Sietse Ringers committed
386
387
388
		}
	}
	return nil, nil
389
390
}

Sietse Ringers's avatar
Sietse Ringers committed
391
// credential returns the requested credential, or nil if we do not have it.
392
func (client *Client) credential(id irma.CredentialTypeIdentifier, counter int) (cred *credential, err error) {
Sietse Ringers's avatar
Sietse Ringers committed
393
	// If the requested credential is not in credential map, we check if its attributes were
394
	// deserialized during New(). If so, there should be a corresponding signature file,
Sietse Ringers's avatar
Sietse Ringers committed
395
	// so we read that, construct the credential, and add it to the credential map
396
397
	if _, exists := client.creds(id)[counter]; !exists {
		attrs := client.Attributes(id, counter)
Sietse Ringers's avatar
Sietse Ringers committed
398
399
400
		if attrs == nil { // We do not have the requested cred
			return
		}
401
		sig, err := client.storage.LoadSignature(attrs)
Sietse Ringers's avatar
Sietse Ringers committed
402
403
404
405
406
407
408
		if err != nil {
			return nil, err
		}
		if sig == nil {
			err = errors.New("signature file not found")
			return nil, err
		}
409
		pk, err := attrs.PublicKey()
410
411
412
		if err != nil {
			return nil, err
		}
413
414
415
		if pk == nil {
			return nil, errors.New("unknown public key")
		}
416
		cred, err := newCredential(&gabi.Credential{
417
			Attributes: append([]*big.Int{client.secretkey.Key}, attrs.Ints...),
418
			Signature:  sig,
419
			Pk:         pk,
420
		}, client.Configuration)
421
422
423
		if err != nil {
			return nil, err
		}
424
		client.credentialsCache[id][counter] = cred
Sietse Ringers's avatar
Sietse Ringers committed
425
426
	}

427
	return client.credentialsCache[id][counter], nil
428
429
}

Sietse Ringers's avatar
Sietse Ringers committed
430
// Methods used in the IRMA protocol
431

432
// Candidates returns a list of attributes present in this client
Sietse Ringers's avatar
Sietse Ringers committed
433
// that satisfy the specified attribute disjunction.
434
435
func (client *Client) Candidates(disjunction *irma.AttributeDisjunction) []*irma.AttributeIdentifier {
	candidates := make([]*irma.AttributeIdentifier, 0, 10)
436
437

	for _, attribute := range disjunction.Attributes {
Sietse Ringers's avatar
Sietse Ringers committed
438
		credID := attribute.CredentialTypeIdentifier()
439
		if !client.Configuration.Contains(credID) {
440
441
			continue
		}
442
		creds := client.attributes[credID]
443
444
445
446
		count := len(creds)
		if count == 0 {
			continue
		}
447
		for _, attrs := range creds {
448
449
450
			if !attrs.IsValid() {
				continue
			}
451
			id := &irma.AttributeIdentifier{Type: attribute, CredentialHash: attrs.Hash()}
452
453
454
			if attribute.IsCredential() {
				candidates = append(candidates, id)
			} else {
455
				val := attrs.UntranslatedAttribute(attribute)
456
				if val == nil {
457
458
					continue
				}
459
				if !disjunction.HasValues() {
460
					candidates = append(candidates, id)
461
462
463
464
465
				} else {
					requiredValue, present := disjunction.Values[attribute]
					if !present || requiredValue == nil || *val == *requiredValue {
						candidates = append(candidates, id)
					}
466
467
468
469
470
471
472
473
				}
			}
		}
	}

	return candidates
}

474
// CheckSatisfiability checks if this client has the required attributes
Sietse Ringers's avatar
Sietse Ringers committed
475
476
// to satisfy the specifed disjunction list. If not, the unsatisfiable disjunctions
// are returned.
477
func (client *Client) CheckSatisfiability(
478
479
480
481
	disjunctions irma.AttributeDisjunctionList,
) ([][]*irma.AttributeIdentifier, irma.AttributeDisjunctionList) {
	candidates := [][]*irma.AttributeIdentifier{}
	missing := irma.AttributeDisjunctionList{}
482
	for i, disjunction := range disjunctions {
483
		candidates = append(candidates, []*irma.AttributeIdentifier{})
484
		candidates[i] = client.Candidates(disjunction)
485
		if len(candidates[i]) == 0 {
486
487
488
			missing = append(missing, disjunction)
		}
	}
489
	return candidates, missing
490
}
491

492
493
func (client *Client) groupCredentials(choice *irma.DisclosureChoice) (map[irma.CredentialIdentifier][]int, error) {
	grouped := make(map[irma.CredentialIdentifier][]int)
494
495
496
	if choice == nil || choice.Attributes == nil {
		return grouped, nil
	}
497
498
499
500
501
502
503
504

	for _, attribute := range choice.Attributes {
		identifier := attribute.Type
		ici := attribute.CredentialIdentifier()

		// If this is the first attribute of its credential type that we encounter
		// in the disclosure choice, then there is no slice yet at grouped[ici]
		if _, present := grouped[ici]; !present {
505
506
			indices := make([]int, 1, 1)
			indices[0] = 1 // Always include metadata
507
508
509
510
511
512
			grouped[ici] = indices
		}

		if identifier.IsCredential() {
			continue // In this case we only disclose the metadata attribute, which is already handled
		}
513
		index, err := client.Configuration.CredentialTypes[identifier.CredentialTypeIdentifier()].IndexOf(identifier)
514
515
516
517
		if err != nil {
			return nil, err
		}

Sietse Ringers's avatar
Sietse Ringers committed
518
		// These indices will be used in the []*big.Int at gabi.credential.Attributes,
519
		// which doesn't know about the secret key and metadata attribute, so +2
520
		grouped[ici] = append(grouped[ici], index+2)
521
522
523
524
525
	}

	return grouped, nil
}

526
// ProofBuilders constructs a list of proof builders for the specified attribute choice.
527
func (client *Client) ProofBuilders(choice *irma.DisclosureChoice, request irma.IrmaSession, issig bool) (gabi.ProofBuilderList, error) {
528
	todisclose, err := client.groupCredentials(choice)
529
530
531
532
	if err != nil {
		return nil, err
	}

533
	builders := gabi.ProofBuilderList([]gabi.ProofBuilder{})
534
	for id, list := range todisclose {
535
		cred, err := client.credentialByID(id)
536
537
538
539
540
		if err != nil {
			return nil, err
		}
		builders = append(builders, cred.Credential.CreateDisclosureProofBuilder(list))
	}
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558

	if issig {
		var sigs []*big.Int
		var disclosed [][]*big.Int
		var s *big.Int
		var d []*big.Int
		for _, builder := range builders {
			s, d = builder.(*gabi.DisclosureProofBuilder).TimestampRequestContributions()
			sigs = append(sigs, s)
			disclosed = append(disclosed, d)
		}
		r := request.(*irma.SignatureRequest)
		r.Timestamp, err = irma.GetTimestamp(r.Message, sigs, disclosed)
		if err != nil {
			return nil, err
		}
	}

559
560
561
562
563
564
565
566
567
568
	return builders, nil
}

// Proofs computes disclosure proofs containing the attributes specified by choice.
func (client *Client) Proofs(choice *irma.DisclosureChoice, request irma.IrmaSession, issig bool) (gabi.ProofList, error) {
	builders, err := client.ProofBuilders(choice, request, issig)
	if err != nil {
		return nil, err
	}

569
	return builders.BuildProofList(request.GetContext(), request.GetNonce(), issig), nil
Sietse Ringers's avatar
Sietse Ringers committed
570
571
}

572
573
// IssuanceProofBuilders constructs a list of proof builders in the issuance protocol
// for the future credentials as well as possibly any disclosed attributes.
574
func (client *Client) IssuanceProofBuilders(request *irma.IssuanceRequest) (gabi.ProofBuilderList, error) {
Sietse Ringers's avatar
Cleanup    
Sietse Ringers committed
575
	state, err := newIssuanceState()
Sietse Ringers's avatar
Sietse Ringers committed
576
577
578
	if err != nil {
		return nil, err
	}
579
	client.state = state
Sietse Ringers's avatar
Sietse Ringers committed
580

581
	proofBuilders := gabi.ProofBuilderList([]gabi.ProofBuilder{})
Sietse Ringers's avatar
Sietse Ringers committed
582
	for _, futurecred := range request.Credentials {
Sietse Ringers's avatar
Sietse Ringers committed
583
		var pk *gabi.PublicKey
584
		pk, err = client.Configuration.PublicKey(futurecred.CredentialTypeID.IssuerIdentifier(), futurecred.KeyCounter)
585
586
587
		if err != nil {
			return nil, err
		}
588
		credBuilder := gabi.NewCredentialBuilder(
589
			pk, request.GetContext(), client.secretkey.Key, state.nonce2)
590
		state.builders = append(state.builders, credBuilder)
Sietse Ringers's avatar
Sietse Ringers committed
591
592
		proofBuilders = append(proofBuilders, credBuilder)
	}
Sietse Ringers's avatar
Sietse Ringers committed
593

594
	disclosures, err := client.ProofBuilders(request.Choice, request, false)
Sietse Ringers's avatar
Sietse Ringers committed
595
596
597
	if err != nil {
		return nil, err
	}
Sietse Ringers's avatar
Sietse Ringers committed
598
	proofBuilders = append(disclosures, proofBuilders...)
Sietse Ringers's avatar
Sietse Ringers committed
599
600
	return proofBuilders, nil
}
Sietse Ringers's avatar
Sietse Ringers committed
601

Sietse Ringers's avatar
Sietse Ringers committed
602
603
// IssueCommitments computes issuance commitments, along with disclosure proofs
// specified by choice.
604
func (client *Client) IssueCommitments(request *irma.IssuanceRequest) (*gabi.IssueCommitmentMessage, error) {
605
	proofBuilders, err := client.IssuanceProofBuilders(request)
Sietse Ringers's avatar
Sietse Ringers committed
606
607
608
	if err != nil {
		return nil, err
	}
609
	list := proofBuilders.BuildProofList(request.GetContext(), request.GetNonce(), false)
610
	return &gabi.IssueCommitmentMessage{Proofs: list, Nonce2: client.state.nonce2}, nil
Sietse Ringers's avatar
Sietse Ringers committed
611
612
}

Sietse Ringers's avatar
Sietse Ringers committed
613
614
// ConstructCredentials constructs and saves new credentials
// using the specified issuance signature messages.
615
func (client *Client) ConstructCredentials(msg []*gabi.IssueSignatureMessage, request *irma.IssuanceRequest) error {
616
	if len(msg) != len(client.state.builders) {
Sietse Ringers's avatar
Sietse Ringers committed
617
618
619
		return errors.New("Received unexpected amount of signatures")
	}

620
621
	// First collect all credentials in a slice, so that if one of them induces an error,
	// we save none of them to fail the session cleanly
622
	gabicreds := []*gabi.Credential{}
Sietse Ringers's avatar
Sietse Ringers committed
623
	for i, sig := range msg {
624
		attrs, err := request.Credentials[i].AttributeList(client.Configuration, getMetadataVersion(request.GetVersion()))
Sietse Ringers's avatar
Sietse Ringers committed
625
626
627
		if err != nil {
			return err
		}
628
		cred, err := client.state.builders[i].ConstructCredential(sig, attrs.Ints)
Sietse Ringers's avatar
Sietse Ringers committed
629
630
631
		if err != nil {
			return err
		}
632
		gabicreds = append(gabicreds, cred)
Sietse Ringers's avatar
Sietse Ringers committed
633
634
	}

635
	for _, gabicred := range gabicreds {
636
		newcred, err := newCredential(gabicred, client.Configuration)
637
638
639
		if err != nil {
			return err
		}
640
		if err = client.addCredential(newcred, true); err != nil {
Sietse Ringers's avatar
Sietse Ringers committed
641
642
			return err
		}
Sietse Ringers's avatar
Sietse Ringers committed
643
	}
644

Sietse Ringers's avatar
Sietse Ringers committed
645
	return nil
Sietse Ringers's avatar
Sietse Ringers committed
646
}
647

Sietse Ringers's avatar
Sietse Ringers committed
648
649
// Keyshare server handling

650
func (client *Client) genSchemeManagersList(enrolled bool) []irma.SchemeManagerIdentifier {
651
	list := []irma.SchemeManagerIdentifier{}
652
	for name, manager := range client.Configuration.SchemeManagers {
653
		if _, contains := client.keyshareServers[name]; manager.Distributed() && contains == enrolled {
Sietse Ringers's avatar
Sietse Ringers committed
654
			list = append(list, manager.Identifier())
Sietse Ringers's avatar
Sietse Ringers committed
655
656
657
658
		}
	}
	return list
}
Sietse Ringers's avatar
Sietse Ringers committed
659

660
661
662
663
func (client *Client) UnenrolledSchemeManagers() []irma.SchemeManagerIdentifier {
	return client.genSchemeManagersList(false)
}

664
func (client *Client) EnrolledSchemeManagers() []irma.SchemeManagerIdentifier {
665
	return client.genSchemeManagersList(true)
666
667
}

668
// KeyshareEnroll attempts to enroll at the keyshare server of the specified scheme manager.
669
func (client *Client) KeyshareEnroll(manager irma.SchemeManagerIdentifier, email *string, pin string, lang string) {
Sietse Ringers's avatar
Sietse Ringers committed
670
	go func() {
671
		err := client.keyshareEnrollWorker(manager, email, pin, lang)
Sietse Ringers's avatar
Sietse Ringers committed
672
		if err != nil {
Tomas's avatar
Tomas committed
673
			client.handler.EnrollmentFailure(manager, err)
Sietse Ringers's avatar
Sietse Ringers committed
674
675
		}
	}()
676
677
}

678
func (client *Client) keyshareEnrollWorker(managerID irma.SchemeManagerIdentifier, email *string, pin string, lang string) error {
679
	manager, ok := client.Configuration.SchemeManagers[managerID]
Sietse Ringers's avatar
Sietse Ringers committed
680
681
682
683
684
685
686
687
688
689
	if !ok {
		return errors.New("Unknown scheme manager")
	}
	if len(manager.KeyshareServer) == 0 {
		return errors.New("Scheme manager has no keyshare server")
	}
	if len(pin) < 5 {
		return errors.New("PIN too short, must be at least 5 characters")
	}

690
	transport := irma.NewHTTPTransport(manager.KeyshareServer)
691
	kss, err := newKeyshareServer(managerID, manager.KeyshareServer)
Sietse Ringers's avatar
Sietse Ringers committed
692
693
694
	if err != nil {
		return err
	}
695
	message := keyshareEnrollment{
696
697
698
		Email:    email,
		Pin:      kss.HashedPin(pin),
		Language: lang,
Sietse Ringers's avatar
Sietse Ringers committed
699
700
	}

701
702
	qr := &irma.Qr{}
	err = transport.Post("client/register", qr, message)
Sietse Ringers's avatar
Sietse Ringers committed
703
704
705
706
	if err != nil {
		return err
	}

707
708
709
710
711
	// We add the new keyshare server to the client here, without saving it to disk,
	// and start the issuance session for the keyshare server login attribute -
	// keyshare.go needs the relevant keyshare server to be present in the client.
	// If the session succeeds or fails, the keyshare server is stored to disk or
	// removed from the client by the keyshareEnrollmentHandler.
712
	client.keyshareServers[managerID] = kss
713
714
715
716
717
718
719
	client.NewSession(qr, &keyshareEnrollmentHandler{
		client: client,
		pin:    pin,
		kss:    kss,
	})

	return nil
Sietse Ringers's avatar
Sietse Ringers committed
720
721
}

722
func (client *Client) KeyshareChangePin(manager irma.SchemeManagerIdentifier, oldPin string, newPin string) {
723
	go func() {
724
		err := client.keyshareChangePinWorker(manager, oldPin, newPin)
725
		if err != nil {
726
			client.handler.ChangePinFailure(manager, err)
727
728
729
730
		}
	}()
}

731
func (client *Client) keyshareChangePinWorker(managerID irma.SchemeManagerIdentifier, oldPin string, newPin string) error {
732
733
734
735
736
737
	kss, ok := client.keyshareServers[managerID]
	if !ok {
		return errors.New("Unknown keyshare server")
	}

	transport := irma.NewHTTPTransport(kss.URL)
738
	message := keyshareChangepin{
739
		Username: kss.Username,
740
741
		OldPin:   kss.HashedPin(oldPin),
		NewPin:   kss.HashedPin(newPin),
742
743
744
745
746
747
748
	}

	res := &keysharePinStatus{}
	err := transport.Post("users/change/pin", res, message)
	if err != nil {
		return err
	}
749

750
751
	switch res.Status {
	case kssPinSuccess:
752
		client.handler.ChangePinSuccess(managerID)
753
	case kssPinFailure:
754
755
756
757
758
		attempts, err := strconv.Atoi(res.Message)
		if err != nil {
			return err
		}
		client.handler.ChangePinIncorrect(managerID, attempts)
759
	case kssPinError:
760
761
762
763
764
		timeout, err := strconv.Atoi(res.Message)
		if err != nil {
			return err
		}
		client.handler.ChangePinBlocked(managerID, timeout)
765
766
	default:
		return errors.New("Unknown keyshare response")
767
	}
768

769
770
771
	return nil
}

772
// KeyshareRemove unenrolls the keyshare server of the specified scheme manager.
773
func (client *Client) KeyshareRemove(manager irma.SchemeManagerIdentifier) error {
774
	if _, contains := client.keyshareServers[manager]; !contains {
Sietse Ringers's avatar
Sietse Ringers committed
775
776
		return errors.New("Can't uninstall unknown keyshare server")
	}
777
778
	delete(client.keyshareServers, manager)
	return client.storage.StoreKeyshareServers(client.keyshareServers)
Sietse Ringers's avatar
Sietse Ringers committed
779
}
Sietse Ringers's avatar
Sietse Ringers committed
780

Sietse Ringers's avatar
Sietse Ringers committed
781
// KeyshareRemoveAll removes all keyshare server registrations.
782
func (client *Client) KeyshareRemoveAll() error {
783
	client.keyshareServers = map[irma.SchemeManagerIdentifier]*keyshareServer{}
784
	return client.storage.StoreKeyshareServers(client.keyshareServers)
785
786
}

Sietse Ringers's avatar
Sietse Ringers committed
787
788
// Add, load and store log entries

789
790
791
func (client *Client) addLogEntry(entry *LogEntry) error {
	client.logs = append(client.logs, entry)
	return client.storage.StoreLogs(client.logs)
Sietse Ringers's avatar
Sietse Ringers committed
792
793
}

Sietse Ringers's avatar
Sietse Ringers committed
794
// Logs returns the log entries of past events.
795
796
func (client *Client) Logs() ([]*LogEntry, error) {
	if client.logs == nil || len(client.logs) == 0 {
Sietse Ringers's avatar
Sietse Ringers committed
797
		var err error
798
		client.logs, err = client.storage.LoadLogs()
Sietse Ringers's avatar
Sietse Ringers committed
799
800
801
802
		if err != nil {
			return nil, err
		}
	}
803
	return client.logs, nil
Sietse Ringers's avatar
Sietse Ringers committed
804
}
805

806
// SetCrashReportingPreference toggles whether or not crash reports should be sent to Sentry.
Sietse Ringers's avatar
Sietse Ringers committed
807
// Has effect only after restarting.
808
809
810
811
func (client *Client) SetCrashReportingPreference(enable bool) {
	client.Preferences.EnableCrashReporting = enable
	_ = client.storage.StorePreferences(client.Preferences)
	client.applyPreferences()
812
813
}

814
815
func (client *Client) applyPreferences() {
	if client.Preferences.EnableCrashReporting {
816
		raven.SetDSN(SentryDSN)
817
818
	} else {
		raven.SetDSN("")
819
820
	}
}