manager.go 13 KB
Newer Older
1
2
3
package irmago

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

8
	"github.com/credentials/go-go-gadget-paillier"
Sietse Ringers's avatar
Sietse Ringers committed
9
	"github.com/go-errors/errors"
10
11
12
13
14
	"github.com/mhe/gabi"
)

// CredentialManager manages credentials.
type CredentialManager struct {
15
	secretkey        *secretKey
16
17
18
19
	storagePath      string
	attributes       map[CredentialTypeIdentifier][]*AttributeList
	credentials      map[CredentialTypeIdentifier]map[int]*credential
	keyshareServers  map[SchemeManagerIdentifier]*keyshareServer
20
	paillierKeyCache *paillierPrivateKey
Sietse Ringers's avatar
Sietse Ringers committed
21
	logs             []*LogEntry
22

23
	irmaConfigurationPath string
24
	androidStoragePath    string
25
	Store                 *ConfigurationStore
26
	updates               []update
Sietse Ringers's avatar
Sietse Ringers committed
27
28
}

29
30
31
32
type secretKey struct {
	Key *big.Int
}

33
34
35
// CredentialInfoList returns a list of information of all contained credentials.
func (cm *CredentialManager) CredentialInfoList() CredentialInfoList {
	list := CredentialInfoList([]*CredentialInfo{})
36
37
38

	for _, attrlistlist := range cm.attributes {
		for _, attrlist := range attrlistlist {
39
			list = append(list, attrlist.Info())
Sietse Ringers's avatar
Sietse Ringers committed
40
41
		}
	}
42

Sietse Ringers's avatar
Sietse Ringers committed
43
44
45
46
	sort.Sort(list)
	return list
}

47
48
49
50
51
52
func (cm *CredentialManager) generateSecretKey() (*secretKey, error) {
	key, err := gabi.RandomBigInt(gabi.DefaultSystemParameters[1024].Lm)
	if err != nil {
		return nil, err
	}
	return &secretKey{Key: key}, nil
53
54
}

Sietse Ringers's avatar
Sietse Ringers committed
55
// attrs returns cm.attributes[id], initializing it to an empty slice if neccesary
56
func (cm *CredentialManager) attrs(id CredentialTypeIdentifier) []*AttributeList {
Sietse Ringers's avatar
Sietse Ringers committed
57
58
59
60
61
62
63
64
65
	list, exists := cm.attributes[id]
	if !exists {
		list = make([]*AttributeList, 0, 1)
		cm.attributes[id] = list
	}
	return list
}

// creds returns cm.credentials[id], initializing it to an empty map if neccesary
Sietse Ringers's avatar
Sietse Ringers committed
66
func (cm *CredentialManager) creds(id CredentialTypeIdentifier) map[int]*credential {
Sietse Ringers's avatar
Sietse Ringers committed
67
68
	list, exists := cm.credentials[id]
	if !exists {
Sietse Ringers's avatar
Sietse Ringers committed
69
		list = make(map[int]*credential)
Sietse Ringers's avatar
Sietse Ringers committed
70
71
72
73
74
		cm.credentials[id] = list
	}
	return list
}

Sietse Ringers's avatar
Sietse Ringers committed
75
// Attributes returns the attribute list of the requested credential, or nil if we do not have it.
76
func (cm *CredentialManager) Attributes(id CredentialTypeIdentifier, counter int) (attributes *AttributeList) {
Sietse Ringers's avatar
Sietse Ringers committed
77
78
	list := cm.attrs(id)
	if len(list) <= counter {
Sietse Ringers's avatar
Sietse Ringers committed
79
80
81
82
83
		return
	}
	return list[counter]
}

Sietse Ringers's avatar
Sietse Ringers committed
84
85
func (cm *CredentialManager) credentialByID(id CredentialIdentifier) (cred *credential, err error) {
	return cm.credential(id.Type, id.Index)
86
87
}

Sietse Ringers's avatar
Sietse Ringers committed
88
89
// credential returns the requested credential, or nil if we do not have it.
func (cm *CredentialManager) credential(id CredentialTypeIdentifier, counter int) (cred *credential, err error) {
Sietse Ringers's avatar
Sietse Ringers committed
90
	// If the requested credential is not in credential map, we check if its attributes were
91
	// deserialized during NewCredentialManager(). If so, there should be a corresponding signature file,
Sietse Ringers's avatar
Sietse Ringers committed
92
	// so we read that, construct the credential, and add it to the credential map
Sietse Ringers's avatar
Sietse Ringers committed
93
	if _, exists := cm.creds(id)[counter]; !exists {
Sietse Ringers's avatar
Sietse Ringers committed
94
95
96
97
		attrs := cm.Attributes(id, counter)
		if attrs == nil { // We do not have the requested cred
			return
		}
98
		sig, err := cm.loadSignature(attrs)
Sietse Ringers's avatar
Sietse Ringers committed
99
100
101
102
103
104
105
		if err != nil {
			return nil, err
		}
		if sig == nil {
			err = errors.New("signature file not found")
			return nil, err
		}
106
		pk, err := attrs.PublicKey()
107
108
109
		if err != nil {
			return nil, err
		}
110
111
112
		if pk == nil {
			return nil, errors.New("unknown public key")
		}
113
		cred, err := newCredential(&gabi.Credential{
114
			Attributes: append([]*big.Int{cm.secretkey.Key}, attrs.Ints...),
115
			Signature:  sig,
116
			Pk:         pk,
117
		}, cm.Store)
118
119
120
		if err != nil {
			return nil, err
		}
Sietse Ringers's avatar
Sietse Ringers committed
121
122
123
124
		cm.credentials[id][counter] = cred
	}

	return cm.credentials[id][counter], nil
125
126
}

127
128
129
// addCredential adds the specified credential to the CredentialManager, saving its signature
// imediately, and optionally cm.attributes as well.
func (cm *CredentialManager) addCredential(cred *credential, storeAttributes bool) (err error) {
130
	id := cred.CredentialType().Identifier()
131
	cm.attributes[id] = append(cm.attrs(id), cred.AttributeList())
132

133
	if _, exists := cm.credentials[id]; !exists {
Sietse Ringers's avatar
Sietse Ringers committed
134
		cm.credentials[id] = make(map[int]*credential)
135
	}
Sietse Ringers's avatar
Sietse Ringers committed
136
137
	counter := len(cm.attributes[id]) - 1
	cm.credentials[id][counter] = cred
138

139
	if err = cm.storeSignature(cred, counter); err != nil {
140
141
		return
	}
142
143
144
	if storeAttributes {
		err = cm.storeAttributes()
	}
145
146
	return
}
147

Sietse Ringers's avatar
Sietse Ringers committed
148
149
// Candidates returns a list of attributes present in this credential manager
// that satisfy the specified attribute disjunction.
150
func (cm *CredentialManager) Candidates(disjunction *AttributeDisjunction) []*AttributeIdentifier {
151
	candidates := make([]*AttributeIdentifier, 0, 10)
152
153

	for _, attribute := range disjunction.Attributes {
Sietse Ringers's avatar
Sietse Ringers committed
154
		credID := attribute.CredentialTypeIdentifier()
155
		if !cm.Store.Contains(credID) {
156
157
			continue
		}
Sietse Ringers's avatar
Sietse Ringers committed
158
		creds := cm.credentials[credID]
159
160
161
162
163
164
165
166
167
		count := len(creds)
		if count == 0 {
			continue
		}
		for i, cred := range creds {
			id := &AttributeIdentifier{Type: attribute, Index: i, Count: count}
			if attribute.IsCredential() {
				candidates = append(candidates, id)
			} else {
168
				attrs := cred.AttributeList()
169
				val := attrs.Attribute(attribute)
170
				if val == "" { // This won't handle empty attributes correctly
171
172
173
174
175
176
177
178
179
180
181
182
					continue
				}
				if !disjunction.HasValues() || val == disjunction.Values[attribute] {
					candidates = append(candidates, id)
				}
			}
		}
	}

	return candidates
}

Sietse Ringers's avatar
Sietse Ringers committed
183
184
185
// CheckSatisfiability checks if this credential manager has the required attributes
// to satisfy the specifed disjunction list. If not, the unsatisfiable disjunctions
// are returned.
Sietse Ringers's avatar
Sietse Ringers committed
186
func (cm *CredentialManager) CheckSatisfiability(disjunctions AttributeDisjunctionList) AttributeDisjunctionList {
187
	missing := make(AttributeDisjunctionList, 0, 5)
Sietse Ringers's avatar
Sietse Ringers committed
188
	for _, disjunction := range disjunctions {
189
190
191
192
193
194
195
		if len(cm.Candidates(disjunction)) == 0 {
			missing = append(missing, disjunction)
		}
	}

	return missing
}
196

197
func (cm *CredentialManager) groupCredentials(choice *DisclosureChoice) (map[CredentialIdentifier][]int, error) {
198
199
200
201
202
203
204
205
206
	grouped := make(map[CredentialIdentifier][]int)

	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 {
207
208
			indices := make([]int, 1, 1)
			indices[0] = 1 // Always include metadata
209
210
211
212
213
214
			grouped[ici] = indices
		}

		if identifier.IsCredential() {
			continue // In this case we only disclose the metadata attribute, which is already handled
		}
215
		index, err := cm.Store.Credentials[identifier.CredentialTypeIdentifier()].IndexOf(identifier)
216
217
218
219
		if err != nil {
			return nil, err
		}

Sietse Ringers's avatar
Sietse Ringers committed
220
		// These indices will be used in the []*big.Int at gabi.credential.Attributes,
221
		// which doesn't know about the secret key and metadata attribute, so +2
222
		grouped[ici] = append(grouped[ici], index+2)
223
224
225
226
227
	}

	return grouped, nil
}

228
229
// IrmaSession is an IRMA session.
type IrmaSession interface {
230
	GetNonce() *big.Int
Sietse Ringers's avatar
Sietse Ringers committed
231
	SetNonce(*big.Int)
232
	GetContext() *big.Int
Sietse Ringers's avatar
Sietse Ringers committed
233
234
	SetContext(*big.Int)
	DisjunctionList() AttributeDisjunctionList
Sietse Ringers's avatar
Sietse Ringers committed
235
236
	DisclosureChoice() *DisclosureChoice
	SetDisclosureChoice(choice *DisclosureChoice)
237
	Distributed(store *ConfigurationStore) bool
Sietse Ringers's avatar
Sietse Ringers committed
238
	SchemeManagers() []SchemeManagerIdentifier
239
240
}

241
// ProofBuilders constructs a list of proof builders for the specified attribute choice.
242
func (cm *CredentialManager) ProofBuilders(choice *DisclosureChoice) (gabi.ProofBuilderList, error) {
243
244
245
246
247
	todisclose, err := cm.groupCredentials(choice)
	if err != nil {
		return nil, err
	}

248
	builders := gabi.ProofBuilderList([]gabi.ProofBuilder{})
249
	for id, list := range todisclose {
Sietse Ringers's avatar
Sietse Ringers committed
250
		cred, err := cm.credentialByID(id)
251
252
253
254
255
		if err != nil {
			return nil, err
		}
		builders = append(builders, cred.Credential.CreateDisclosureProofBuilder(list))
	}
Sietse Ringers's avatar
Sietse Ringers committed
256
	return builders, nil
257
}
Sietse Ringers's avatar
Sietse Ringers committed
258

Sietse Ringers's avatar
Sietse Ringers committed
259
// Proofs computes disclosure proofs containing the attributes specified by choice.
260
func (cm *CredentialManager) Proofs(choice *DisclosureChoice, request IrmaSession, issig bool) (gabi.ProofList, error) {
Sietse Ringers's avatar
Sietse Ringers committed
261
	builders, err := cm.ProofBuilders(choice)
Sietse Ringers's avatar
Sietse Ringers committed
262
263
264
	if err != nil {
		return nil, err
	}
265
	return builders.BuildProofList(request.GetContext(), request.GetNonce(), issig), nil
Sietse Ringers's avatar
Sietse Ringers committed
266
267
}

268
269
// IssuanceProofBuilders constructs a list of proof builders in the issuance protocol
// for the future credentials as well as possibly any disclosed attributes.
270
func (cm *CredentialManager) IssuanceProofBuilders(request *IssuanceRequest) (gabi.ProofBuilderList, error) {
Sietse Ringers's avatar
Cleanup    
Sietse Ringers committed
271
	state, err := newIssuanceState()
Sietse Ringers's avatar
Sietse Ringers committed
272
273
274
275
276
	if err != nil {
		return nil, err
	}
	request.state = state

277
	proofBuilders := gabi.ProofBuilderList([]gabi.ProofBuilder{})
Sietse Ringers's avatar
Sietse Ringers committed
278
	for _, futurecred := range request.Credentials {
279
280
281
282
		pk, err := cm.Store.PublicKey(futurecred.Credential.IssuerIdentifier(), futurecred.KeyCounter)
		if err != nil {
			return nil, err
		}
283
284
		credBuilder := gabi.NewCredentialBuilder(
			pk, request.GetContext(), cm.secretkey.Key, state.nonce2)
Sietse Ringers's avatar
Sietse Ringers committed
285
286
287
		request.state.builders = append(request.state.builders, credBuilder)
		proofBuilders = append(proofBuilders, credBuilder)
	}
Sietse Ringers's avatar
Sietse Ringers committed
288

Sietse Ringers's avatar
Sietse Ringers committed
289
	disclosures, err := cm.ProofBuilders(request.choice)
Sietse Ringers's avatar
Sietse Ringers committed
290
291
292
	if err != nil {
		return nil, err
	}
Sietse Ringers's avatar
Sietse Ringers committed
293
	proofBuilders = append(disclosures, proofBuilders...)
Sietse Ringers's avatar
Sietse Ringers committed
294
295
	return proofBuilders, nil
}
Sietse Ringers's avatar
Sietse Ringers committed
296

Sietse Ringers's avatar
Sietse Ringers committed
297
298
299
300
301
302
303
// IssueCommitments computes issuance commitments, along with disclosure proofs
// specified by choice.
func (cm *CredentialManager) IssueCommitments(request *IssuanceRequest) (*gabi.IssueCommitmentMessage, error) {
	proofBuilders, err := cm.IssuanceProofBuilders(request)
	if err != nil {
		return nil, err
	}
304
	list := proofBuilders.BuildProofList(request.GetContext(), request.GetNonce(), false)
Sietse Ringers's avatar
Sietse Ringers committed
305
	return &gabi.IssueCommitmentMessage{Proofs: list, Nonce2: request.state.nonce2}, nil
Sietse Ringers's avatar
Sietse Ringers committed
306
307
}

Sietse Ringers's avatar
Sietse Ringers committed
308
309
// ConstructCredentials constructs and saves new credentials
// using the specified issuance signature messages.
Sietse Ringers's avatar
Sietse Ringers committed
310
311
312
313
314
func (cm *CredentialManager) ConstructCredentials(msg []*gabi.IssueSignatureMessage, request *IssuanceRequest) error {
	if len(msg) != len(request.state.builders) {
		return errors.New("Received unexpected amount of signatures")
	}

315
316
	// 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
317
	gabicreds := []*gabi.Credential{}
Sietse Ringers's avatar
Sietse Ringers committed
318
	for i, sig := range msg {
319
		attrs, err := request.Credentials[i].AttributeList(cm.Store)
Sietse Ringers's avatar
Sietse Ringers committed
320
321
322
323
324
325
326
		if err != nil {
			return err
		}
		cred, err := request.state.builders[i].ConstructCredential(sig, attrs.Ints)
		if err != nil {
			return err
		}
327
		gabicreds = append(gabicreds, cred)
Sietse Ringers's avatar
Sietse Ringers committed
328
329
	}

330
331
332
333
334
335
	for _, gabicred := range gabicreds {
		newcred, err := newCredential(gabicred, cm.Store)
		if err != nil {
			return err
		}
		cm.addCredential(newcred, true)
Sietse Ringers's avatar
Sietse Ringers committed
336
	}
337

Sietse Ringers's avatar
Sietse Ringers committed
338
	return nil
Sietse Ringers's avatar
Sietse Ringers committed
339
}
340
341

// PaillierKey returns a new Paillier key (and generates a new one in a goroutine).
Sietse Ringers's avatar
Sietse Ringers committed
342
func (cm *CredentialManager) paillierKey(wait bool) *paillierPrivateKey {
343
	retval := cm.paillierKeyCache
Sietse Ringers's avatar
Sietse Ringers committed
344
	ch := make(chan bool)
345
346
347
348
	go func() {
		newkey, _ := paillier.GenerateKey(rand.Reader, 2048)
		converted := paillierPrivateKey(*newkey)
		cm.paillierKeyCache = &converted
Sietse Ringers's avatar
Sietse Ringers committed
349
350
351
		if wait && retval == nil {
			ch <- true
		}
352
	}()
Sietse Ringers's avatar
Sietse Ringers committed
353
354
355
356
	if wait && retval == nil {
		<-ch
		return cm.paillierKeyCache
	}
357
358
	return retval
}
Sietse Ringers's avatar
Sietse Ringers committed
359
360
361

func (cm *CredentialManager) unenrolledKeyshareServers() []*SchemeManager {
	list := []*SchemeManager{}
362
	for name, manager := range cm.Store.SchemeManagers {
Sietse Ringers's avatar
Sietse Ringers committed
363
364
365
366
367
368
		if _, contains := cm.keyshareServers[name]; len(manager.KeyshareServer) > 0 && !contains {
			list = append(list, manager)
		}
	}
	return list
}
Sietse Ringers's avatar
Sietse Ringers committed
369

370
371
// KeyshareEnroll attempts to register at the keyshare server of the specified scheme manager.
func (cm *CredentialManager) KeyshareEnroll(managerID SchemeManagerIdentifier, email, pin string) error {
372
	manager, ok := cm.Store.SchemeManagers[managerID]
Sietse Ringers's avatar
Sietse Ringers committed
373
374
375
376
377
378
379
380
381
382
383
	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")
	}

	transport := NewHTTPTransport(manager.KeyshareServer)
384
	kss, err := newKeyshareServer(cm.paillierKey(true), manager.KeyshareServer, email)
Sietse Ringers's avatar
Sietse Ringers committed
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
	if err != nil {
		return err
	}
	message := keyshareRegistration{
		Username:  email,
		Pin:       kss.HashedPin(pin),
		PublicKey: (*paillierPublicKey)(&kss.PrivateKey.PublicKey),
	}

	// TODO: examine error returned by Post() to see if it tells us that the email address is already in use
	result := &struct{}{}
	err = transport.Post("web/users/selfenroll", result, message)
	if err != nil {
		return err
	}

401
	cm.keyshareServers[managerID] = kss
Sietse Ringers's avatar
Sietse Ringers committed
402
403
404
	return cm.storeKeyshareServers()
}

405
// KeyshareRemove unregisters the keyshare server of the specified scheme manager.
Sietse Ringers's avatar
Sietse Ringers committed
406
407
408
409
410
func (cm *CredentialManager) KeyshareRemove(manager SchemeManagerIdentifier) error {
	if _, contains := cm.keyshareServers[manager]; !contains {
		return errors.New("Can't uninstall unknown keyshare server")
	}
	delete(cm.keyshareServers, manager)
Sietse Ringers's avatar
Sietse Ringers committed
411
412
	return cm.storeKeyshareServers()
}
Sietse Ringers's avatar
Sietse Ringers committed
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428

func (cm *CredentialManager) addLogEntry(entry *LogEntry) error {
	cm.logs = append(cm.logs, entry)
	return cm.storeLogs()
}

func (cm *CredentialManager) Logs() ([]*LogEntry, error) {
	if cm.logs == nil || len(cm.logs) == 0 {
		var err error
		cm.logs, err = cm.loadLogs()
		if err != nil {
			return nil, err
		}
	}
	return cm.logs, nil
}