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

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

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

17
// This file contains most methods of the Client (c.f. session.go
Sietse Ringers's avatar
Sietse Ringers committed
18
19
20
21
22
23
24
25
26
// and updates.go).
//
// 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
27
// immediately need to be available anyway.
Sietse Ringers's avatar
Sietse Ringers committed
28
29
30
31
32
//
// - 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).

33
// Client (de)serializes credentials and keyshare server information
Sietse Ringers's avatar
Sietse Ringers committed
34
35
36
37
// 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.
38
type Client struct {
Sietse Ringers's avatar
Sietse Ringers committed
39
	// Stuff we manage on disk
40
	secretkey        *secretKey
41
42
43
	attributes       map[irma.CredentialTypeIdentifier][]*irma.AttributeList
	credentials      map[irma.CredentialTypeIdentifier]map[int]*credential
	keyshareServers  map[irma.SchemeManagerIdentifier]*keyshareServer
44
	paillierKeyCache *paillierPrivateKey
Sietse Ringers's avatar
Sietse Ringers committed
45
	logs             []*LogEntry
Sietse Ringers's avatar
Sietse Ringers committed
46
	updates          []update
47

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

	// Other state
52
	Preferences              Preferences
53
	Configuration            *irma.Configuration
54
	UnenrolledSchemeManagers []irma.SchemeManagerIdentifier
55
56
57
	irmaConfigurationPath    string
	androidStoragePath       string
	handler                  ClientHandler
58
	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 {
76
77
	EnrollmentError(manager irma.SchemeManagerIdentifier, err error)
	EnrollmentSuccess(manager irma.SchemeManagerIdentifier)
78
79
}

Sietse Ringers's avatar
Sietse Ringers committed
80
81
// ClientHandler informs the user that the configuration or the list of attributes
// that this client uses has been updated.
82
83
84
type ClientHandler interface {
	KeyshareHandler

85
	UpdateConfiguration(new *irma.IrmaIdentifierSet)
86
	UpdateAttributes()
Sietse Ringers's avatar
Sietse Ringers committed
87
88
}

89
90
91
92
type secretKey struct {
	Key *big.Int
}

93
// New creates a new Client that uses the directory
94
95
96
97
// 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),
98
// and handler is used for informing the user of new stuff, and when a
99
// enrollment to a keyshare server needs to happen.
100
// The client returned by this function has been fully deserialized
101
102
// and is ready for use.
//
Sietse Ringers's avatar
Sietse Ringers committed
103
104
// NOTE: It is the responsibility of the caller that there exists a (properly
// protected) directory at storagePath!
105
func New(
106
107
108
	storagePath string,
	irmaConfigurationPath string,
	androidStoragePath string,
109
	handler ClientHandler,
110
) (*Client, error) {
111
	var err error
112
	if err = fs.AssertPathExists(storagePath); err != nil {
113
114
		return nil, err
	}
115
	if err = fs.AssertPathExists(irmaConfigurationPath); err != nil {
116
117
118
		return nil, err
	}

119
	cm := &Client{
120
121
122
		credentials:           make(map[irma.CredentialTypeIdentifier]map[int]*credential),
		keyshareServers:       make(map[irma.SchemeManagerIdentifier]*keyshareServer),
		attributes:            make(map[irma.CredentialTypeIdentifier][]*irma.AttributeList),
123
124
		irmaConfigurationPath: irmaConfigurationPath,
		androidStoragePath:    androidStoragePath,
125
		handler:               handler,
126
127
	}

128
	cm.Configuration, err = irma.NewConfiguration(storagePath+"/irma_configuration", irmaConfigurationPath)
129
130
131
	if err != nil {
		return nil, err
	}
132
133
134
	err = cm.Configuration.ParseFolder()
	_, isSchemeMgrErr := err.(*irma.SchemeManagerError)
	if err != nil && !isSchemeMgrErr {
135
136
		return nil, err
	}
137
138

	// Ensure storage path exists, and populate it with necessary files
139
	cm.storage = storage{storagePath: storagePath, Configuration: cm.Configuration}
Sietse Ringers's avatar
Sietse Ringers committed
140
	if err = cm.storage.EnsureStorageExists(); err != nil {
141
142
143
		return nil, err
	}

144
	if cm.Preferences, err = cm.storage.LoadPreferences(); err != nil {
145
146
		return nil, err
	}
147
	cm.applyPreferences()
148

149
	// Perform new update functions from clientUpdates, if any
150
151
152
153
154
	if err = cm.update(); err != nil {
		return nil, err
	}

	// Load our stuff
Sietse Ringers's avatar
Sietse Ringers committed
155
	if cm.secretkey, err = cm.storage.LoadSecretKey(); err != nil {
156
157
		return nil, err
	}
Sietse Ringers's avatar
Sietse Ringers committed
158
	if cm.attributes, err = cm.storage.LoadAttributes(); err != nil {
159
160
		return nil, err
	}
161
	if cm.keyshareServers, err = cm.storage.LoadKeyshareServers(); err != nil {
162
163
		return nil, err
	}
164
	if cm.paillierKeyCache, err = cm.storage.LoadPaillierKeys(); err != nil {
165
166
		return nil, err
	}
167
168
169
	if cm.paillierKeyCache == nil {
		cm.paillierKey(false)
	}
170

171
172
	cm.UnenrolledSchemeManagers = cm.unenrolledSchemeManagers()
	if len(cm.UnenrolledSchemeManagers) > 1 {
173
174
175
176
177
178
		return nil, errors.New("Too many keyshare servers")
	}

	return cm, nil
}

179
// CredentialInfoList returns a list of information of all contained credentials.
180
181
func (client *Client) CredentialInfoList() irma.CredentialInfoList {
	list := irma.CredentialInfoList([]*irma.CredentialInfo{})
182

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

Sietse Ringers's avatar
Sietse Ringers committed
194
195
196
197
	sort.Sort(list)
	return list
}

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

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

	// If this is a singleton credential type, ensure we have at most one by removing any previous instance
216
	if !id.Empty() && cred.CredentialType().IsSingleton && len(client.creds(id)) > 0 {
217
		client.remove(id, 0, false) // Index is 0, because if we're here we have exactly one
218
219
220
	}

	// Append the new cred to our attributes and credentials
221
	client.attributes[id] = append(client.attrs(id), cred.AttributeList())
222
223
224
225
226
227
	if !id.Empty() {
		if _, exists := client.credentials[id]; !exists {
			client.credentials[id] = make(map[int]*credential)
		}
		counter := len(client.attributes[id]) - 1
		client.credentials[id][counter] = cred
Sietse Ringers's avatar
Sietse Ringers committed
228
229
	}

230
	if err = client.storage.StoreSignature(cred); err != nil {
Sietse Ringers's avatar
Sietse Ringers committed
231
232
233
		return
	}
	if storeAttributes {
234
		err = client.storage.StoreAttributes(client.attributes)
Sietse Ringers's avatar
Sietse Ringers committed
235
236
237
238
239
240
241
242
243
244
245
246
247
248
	}
	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

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

	// Remove credential
264
	if creds, exists := client.credentials[id]; exists {
265
		if _, exists := creds[index]; exists {
Sietse Ringers's avatar
Sietse Ringers committed
266
			delete(creds, index)
267
			client.credentials[id] = creds
268
269
270
271
		}
	}

	// Remove signature from storage
272
	if err := client.storage.DeleteSignature(attrs); err != nil {
273
274
275
		return err
	}

276
	removed := map[irma.CredentialTypeIdentifier][]irma.TranslatedString{}
277
278
279
	removed[id] = attrs.Strings()

	if storenow {
280
		return client.addLogEntry(&LogEntry{
281
			Type:    actionRemoval,
282
			Time:    irma.Timestamp(time.Now()),
283
284
285
286
			Removed: removed,
		})
	}
	return nil
287
288
}

Sietse Ringers's avatar
Sietse Ringers committed
289
// RemoveCredential removes the specified credential.
290
func (client *Client) RemoveCredential(id irma.CredentialTypeIdentifier, index int) error {
291
	return client.remove(id, index, true)
292
293
}

Sietse Ringers's avatar
Sietse Ringers committed
294
// RemoveCredentialByHash removes the specified credential.
295
296
func (client *Client) RemoveCredentialByHash(hash string) error {
	cred, index, err := client.credentialByHash(hash)
297
298
299
	if err != nil {
		return err
	}
300
	return client.RemoveCredential(cred.CredentialType().Identifier(), index)
301
302
}

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

	logentry := &LogEntry{
		Type:    actionRemoval,
321
		Time:    irma.Timestamp(time.Now()),
322
323
		Removed: removed,
	}
324
	if err := client.addLogEntry(logentry); err != nil {
325
326
		return err
	}
327
	return client.storage.StoreLogs(client.logs)
328
329
}

330
// Attribute and credential getter methods
Sietse Ringers's avatar
Sietse Ringers committed
331

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

// creds returns cm.credentials[id], initializing it to an empty map if neccesary
343
func (client *Client) creds(id irma.CredentialTypeIdentifier) map[int]*credential {
344
	list, exists := client.credentials[id]
Sietse Ringers's avatar
Sietse Ringers committed
345
	if !exists {
Sietse Ringers's avatar
Sietse Ringers committed
346
		list = make(map[int]*credential)
347
		client.credentials[id] = list
Sietse Ringers's avatar
Sietse Ringers committed
348
349
350
351
	}
	return list
}

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

361
362
func (client *Client) credentialByHash(hash string) (*credential, int, error) {
	for _, attrlistlist := range client.attributes {
363
		for index, attrs := range attrlistlist {
364
			if attrs.Hash() == hash {
365
				cred, err := client.credential(attrs.CredentialType().Identifier(), index)
366
367
368
369
370
371
372
				return cred, index, err
			}
		}
	}
	return nil, 0, nil
}

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

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

421
	return client.credentials[id][counter], nil
422
423
}

Sietse Ringers's avatar
Sietse Ringers committed
424
// Methods used in the IRMA protocol
425

426
// Candidates returns a list of attributes present in this client
Sietse Ringers's avatar
Sietse Ringers committed
427
// that satisfy the specified attribute disjunction.
428
429
func (client *Client) Candidates(disjunction *irma.AttributeDisjunction) []*irma.AttributeIdentifier {
	candidates := make([]*irma.AttributeIdentifier, 0, 10)
430
431

	for _, attribute := range disjunction.Attributes {
Sietse Ringers's avatar
Sietse Ringers committed
432
		credID := attribute.CredentialTypeIdentifier()
433
		if !client.Configuration.Contains(credID) {
434
435
			continue
		}
436
		creds := client.attributes[credID]
437
438
439
440
		count := len(creds)
		if count == 0 {
			continue
		}
441
		for _, attrs := range creds {
442
			id := &irma.AttributeIdentifier{Type: attribute, Hash: attrs.Hash()}
443
444
445
			if attribute.IsCredential() {
				candidates = append(candidates, id)
			} else {
446
				val := attrs.UntranslatedAttribute(attribute)
447
				if val == "" { // This won't handle empty attributes correctly
448
449
450
451
452
453
454
455
456
457
458
459
					continue
				}
				if !disjunction.HasValues() || val == disjunction.Values[attribute] {
					candidates = append(candidates, id)
				}
			}
		}
	}

	return candidates
}

460
// CheckSatisfiability checks if this client has the required attributes
Sietse Ringers's avatar
Sietse Ringers committed
461
462
// to satisfy the specifed disjunction list. If not, the unsatisfiable disjunctions
// are returned.
463
func (client *Client) CheckSatisfiability(
464
465
466
467
	disjunctions irma.AttributeDisjunctionList,
) ([][]*irma.AttributeIdentifier, irma.AttributeDisjunctionList) {
	candidates := [][]*irma.AttributeIdentifier{}
	missing := irma.AttributeDisjunctionList{}
468
	for i, disjunction := range disjunctions {
469
		candidates = append(candidates, []*irma.AttributeIdentifier{})
470
		candidates[i] = client.Candidates(disjunction)
471
		if len(candidates[i]) == 0 {
472
473
474
			missing = append(missing, disjunction)
		}
	}
475
	return candidates, missing
476
}
477

478
479
func (client *Client) groupCredentials(choice *irma.DisclosureChoice) (map[irma.CredentialIdentifier][]int, error) {
	grouped := make(map[irma.CredentialIdentifier][]int)
480
481
482
	if choice == nil || choice.Attributes == nil {
		return grouped, nil
	}
483
484
485
486
487
488
489
490

	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 {
491
492
			indices := make([]int, 1, 1)
			indices[0] = 1 // Always include metadata
493
494
495
496
497
498
			grouped[ici] = indices
		}

		if identifier.IsCredential() {
			continue // In this case we only disclose the metadata attribute, which is already handled
		}
499
		index, err := client.Configuration.CredentialTypes[identifier.CredentialTypeIdentifier()].IndexOf(identifier)
500
501
502
503
		if err != nil {
			return nil, err
		}

Sietse Ringers's avatar
Sietse Ringers committed
504
		// These indices will be used in the []*big.Int at gabi.credential.Attributes,
505
		// which doesn't know about the secret key and metadata attribute, so +2
506
		grouped[ici] = append(grouped[ici], index+2)
507
508
509
510
511
	}

	return grouped, nil
}

512
// ProofBuilders constructs a list of proof builders for the specified attribute choice.
513
func (client *Client) ProofBuilders(choice *irma.DisclosureChoice) (gabi.ProofBuilderList, error) {
514
	todisclose, err := client.groupCredentials(choice)
515
516
517
518
	if err != nil {
		return nil, err
	}

519
	builders := gabi.ProofBuilderList([]gabi.ProofBuilder{})
520
	for id, list := range todisclose {
521
		cred, err := client.credentialByID(id)
522
523
524
525
526
		if err != nil {
			return nil, err
		}
		builders = append(builders, cred.Credential.CreateDisclosureProofBuilder(list))
	}
Sietse Ringers's avatar
Sietse Ringers committed
527
	return builders, nil
528
}
Sietse Ringers's avatar
Sietse Ringers committed
529

Sietse Ringers's avatar
Sietse Ringers committed
530
// Proofs computes disclosure proofs containing the attributes specified by choice.
531
func (client *Client) Proofs(choice *irma.DisclosureChoice, request irma.IrmaSession, issig bool) (gabi.ProofList, error) {
532
	builders, err := client.ProofBuilders(choice)
Sietse Ringers's avatar
Sietse Ringers committed
533
534
535
	if err != nil {
		return nil, err
	}
536
	return builders.BuildProofList(request.GetContext(), request.GetNonce(), issig), nil
Sietse Ringers's avatar
Sietse Ringers committed
537
538
}

539
540
// IssuanceProofBuilders constructs a list of proof builders in the issuance protocol
// for the future credentials as well as possibly any disclosed attributes.
541
func (client *Client) IssuanceProofBuilders(request *irma.IssuanceRequest) (gabi.ProofBuilderList, error) {
Sietse Ringers's avatar
Cleanup    
Sietse Ringers committed
542
	state, err := newIssuanceState()
Sietse Ringers's avatar
Sietse Ringers committed
543
544
545
	if err != nil {
		return nil, err
	}
546
	client.state = state
Sietse Ringers's avatar
Sietse Ringers committed
547

548
	proofBuilders := gabi.ProofBuilderList([]gabi.ProofBuilder{})
Sietse Ringers's avatar
Sietse Ringers committed
549
	for _, futurecred := range request.Credentials {
Sietse Ringers's avatar
Sietse Ringers committed
550
		var pk *gabi.PublicKey
551
		pk, err = client.Configuration.PublicKey(futurecred.CredentialTypeID.IssuerIdentifier(), futurecred.KeyCounter)
552
553
554
		if err != nil {
			return nil, err
		}
555
		credBuilder := gabi.NewCredentialBuilder(
556
			pk, request.GetContext(), client.secretkey.Key, state.nonce2)
557
		state.builders = append(state.builders, credBuilder)
Sietse Ringers's avatar
Sietse Ringers committed
558
559
		proofBuilders = append(proofBuilders, credBuilder)
	}
Sietse Ringers's avatar
Sietse Ringers committed
560

561
	disclosures, err := client.ProofBuilders(request.Choice)
Sietse Ringers's avatar
Sietse Ringers committed
562
563
564
	if err != nil {
		return nil, err
	}
Sietse Ringers's avatar
Sietse Ringers committed
565
	proofBuilders = append(disclosures, proofBuilders...)
Sietse Ringers's avatar
Sietse Ringers committed
566
567
	return proofBuilders, nil
}
Sietse Ringers's avatar
Sietse Ringers committed
568

Sietse Ringers's avatar
Sietse Ringers committed
569
570
// IssueCommitments computes issuance commitments, along with disclosure proofs
// specified by choice.
571
func (client *Client) IssueCommitments(request *irma.IssuanceRequest) (*gabi.IssueCommitmentMessage, error) {
572
	proofBuilders, err := client.IssuanceProofBuilders(request)
Sietse Ringers's avatar
Sietse Ringers committed
573
574
575
	if err != nil {
		return nil, err
	}
576
	list := proofBuilders.BuildProofList(request.GetContext(), request.GetNonce(), false)
577
	return &gabi.IssueCommitmentMessage{Proofs: list, Nonce2: client.state.nonce2}, nil
Sietse Ringers's avatar
Sietse Ringers committed
578
579
}

Sietse Ringers's avatar
Sietse Ringers committed
580
581
// ConstructCredentials constructs and saves new credentials
// using the specified issuance signature messages.
582
func (client *Client) ConstructCredentials(msg []*gabi.IssueSignatureMessage, request *irma.IssuanceRequest) error {
583
	if len(msg) != len(client.state.builders) {
Sietse Ringers's avatar
Sietse Ringers committed
584
585
586
		return errors.New("Received unexpected amount of signatures")
	}

587
588
	// 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
589
	gabicreds := []*gabi.Credential{}
Sietse Ringers's avatar
Sietse Ringers committed
590
	for i, sig := range msg {
591
		attrs, err := request.Credentials[i].AttributeList(client.Configuration)
Sietse Ringers's avatar
Sietse Ringers committed
592
593
594
		if err != nil {
			return err
		}
595
		cred, err := client.state.builders[i].ConstructCredential(sig, attrs.Ints)
Sietse Ringers's avatar
Sietse Ringers committed
596
597
598
		if err != nil {
			return err
		}
599
		gabicreds = append(gabicreds, cred)
Sietse Ringers's avatar
Sietse Ringers committed
600
601
	}

602
	for _, gabicred := range gabicreds {
603
		newcred, err := newCredential(gabicred, client.Configuration)
604
605
606
		if err != nil {
			return err
		}
607
		if err = client.addCredential(newcred, true); err != nil {
Sietse Ringers's avatar
Sietse Ringers committed
608
609
			return err
		}
Sietse Ringers's avatar
Sietse Ringers committed
610
	}
611

Sietse Ringers's avatar
Sietse Ringers committed
612
	return nil
Sietse Ringers's avatar
Sietse Ringers committed
613
}
614

Sietse Ringers's avatar
Sietse Ringers committed
615
616
// Keyshare server handling

617
// PaillierKey returns a new Paillier key (and generates a new one in a goroutine).
618
619
func (client *Client) paillierKey(wait bool) *paillierPrivateKey {
	cached := client.paillierKeyCache
Sietse Ringers's avatar
Sietse Ringers committed
620
	ch := make(chan bool)
621

622
623
	// Would just write client.paillierKeyCache instead of cached here, but the worker
	// modifies client.paillierKeyCache, and we must be sure that the boolean here and
624
	// the if-clause below match.
625
	go client.paillierKeyWorker(cached == nil && wait, ch)
626
	if cached == nil && wait {
Sietse Ringers's avatar
Sietse Ringers committed
627
		<-ch
628
		// generate yet another one for future calls, but no need to wait now
629
		go client.paillierKeyWorker(false, ch)
Sietse Ringers's avatar
Sietse Ringers committed
630
	}
631
	return client.paillierKeyCache
632
}
Sietse Ringers's avatar
Sietse Ringers committed
633

634
func (client *Client) paillierKeyWorker(wait bool, ch chan bool) {
635
	newkey, _ := paillier.GenerateKey(rand.Reader, 2048)
636
637
	client.paillierKeyCache = (*paillierPrivateKey)(newkey)
	client.storage.StorePaillierKeys(client.paillierKeyCache)
638
639
640
641
642
	if wait {
		ch <- true
	}
}

643
644
func (client *Client) unenrolledSchemeManagers() []irma.SchemeManagerIdentifier {
	list := []irma.SchemeManagerIdentifier{}
645
	for name, manager := range client.Configuration.SchemeManagers {
646
		if _, contains := client.keyshareServers[name]; manager.Distributed() && !contains {
Sietse Ringers's avatar
Sietse Ringers committed
647
			list = append(list, manager.Identifier())
Sietse Ringers's avatar
Sietse Ringers committed
648
649
650
651
		}
	}
	return list
}
Sietse Ringers's avatar
Sietse Ringers committed
652

653
// KeyshareEnroll attempts to enroll at the keyshare server of the specified scheme manager.
654
func (client *Client) KeyshareEnroll(manager irma.SchemeManagerIdentifier, email, pin string) {
Sietse Ringers's avatar
Sietse Ringers committed
655
	go func() {
656
		defer func() {
657
			if e := recover(); e != nil {
658
				if client.handler != nil {
659
					client.handler.EnrollmentError(manager, panicToError(e))
660
				}
661
			}
662
663
		}()

664
665
		err := client.keyshareEnrollWorker(manager, email, pin)
		client.UnenrolledSchemeManagers = client.unenrolledSchemeManagers()
Sietse Ringers's avatar
Sietse Ringers committed
666
		if err != nil {
667
			client.handler.EnrollmentError(manager, err)
Sietse Ringers's avatar
Sietse Ringers committed
668
		} else {
669
			client.handler.EnrollmentSuccess(manager)
Sietse Ringers's avatar
Sietse Ringers committed
670
671
		}
	}()
672

673
674
}

675
func (client *Client) keyshareEnrollWorker(managerID irma.SchemeManagerIdentifier, email, pin string) error {
676
	manager, ok := client.Configuration.SchemeManagers[managerID]
Sietse Ringers's avatar
Sietse Ringers committed
677
678
679
680
681
682
683
684
685
686
	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")
	}

687
	transport := irma.NewHTTPTransport(manager.KeyshareServer)
688
	kss, err := newKeyshareServer(client.paillierKey(true), manager.KeyshareServer, email)
Sietse Ringers's avatar
Sietse Ringers committed
689
690
691
	if err != nil {
		return err
	}
692
	message := keyshareEnrollment{
Sietse Ringers's avatar
Sietse Ringers committed
693
694
695
696
697
698
699
700
701
702
703
		Username:  email,
		Pin:       kss.HashedPin(pin),
		PublicKey: (*paillierPublicKey)(&kss.PrivateKey.PublicKey),
	}

	result := &struct{}{}
	err = transport.Post("web/users/selfenroll", result, message)
	if err != nil {
		return err
	}

704
705
	client.keyshareServers[managerID] = kss
	return client.storage.StoreKeyshareServers(client.keyshareServers)
Sietse Ringers's avatar
Sietse Ringers committed
706
707
}

708
// KeyshareRemove unenrolls the keyshare server of the specified scheme manager.
709
func (client *Client) KeyshareRemove(manager irma.SchemeManagerIdentifier) error {
710
	if _, contains := client.keyshareServers[manager]; !contains {
Sietse Ringers's avatar
Sietse Ringers committed
711
712
		return errors.New("Can't uninstall unknown keyshare server")
	}
713
714
	delete(client.keyshareServers, manager)
	return client.storage.StoreKeyshareServers(client.keyshareServers)
Sietse Ringers's avatar
Sietse Ringers committed
715
}
Sietse Ringers's avatar
Sietse Ringers committed
716

Sietse Ringers's avatar
Sietse Ringers committed
717
// KeyshareRemoveAll removes all keyshare server registrations.
718
func (client *Client) KeyshareRemoveAll() error {
719
	client.keyshareServers = map[irma.SchemeManagerIdentifier]*keyshareServer{}
720
721
	client.UnenrolledSchemeManagers = client.unenrolledSchemeManagers()
	return client.storage.StoreKeyshareServers(client.keyshareServers)
722
723
}

Sietse Ringers's avatar
Sietse Ringers committed
724
725
// Add, load and store log entries

726
727
728
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
729
730
}

Sietse Ringers's avatar
Sietse Ringers committed
731
// Logs returns the log entries of past events.
732
733
func (client *Client) Logs() ([]*LogEntry, error) {
	if client.logs == nil || len(client.logs) == 0 {
Sietse Ringers's avatar
Sietse Ringers committed
734
		var err error
735
		client.logs, err = client.storage.LoadLogs()
Sietse Ringers's avatar
Sietse Ringers committed
736
737
738
739
		if err != nil {
			return nil, err
		}
	}
740
	return client.logs, nil
Sietse Ringers's avatar
Sietse Ringers committed
741
}
742

743
// SetCrashReportingPreference toggles whether or not crash reports should be sent to Sentry.
Sietse Ringers's avatar
Sietse Ringers committed
744
// Has effect only after restarting.
745
746
747
748
func (client *Client) SetCrashReportingPreference(enable bool) {
	client.Preferences.EnableCrashReporting = enable
	_ = client.storage.StorePreferences(client.Preferences)
	client.applyPreferences()
749
750
}

751
752
func (client *Client) applyPreferences() {
	if client.Preferences.EnableCrashReporting {
753
		raven.SetDSN(SentryDSN)
754
755
	} else {
		raven.SetDSN("")
756
757
	}
}