manager.go 12.6 KB
Newer Older
1
2
3
4
5
6
package irmago

import (
	"errors"
	"math/big"

7
8
	"crypto/rand"

Sietse Ringers's avatar
Sietse Ringers committed
9
10
	"sort"

11
	"github.com/credentials/go-go-gadget-paillier"
12
13
14
15
16
	"github.com/mhe/gabi"
)

// CredentialManager manages credentials.
type CredentialManager struct {
17
	secretkey        *secretKey
18
19
20
21
	storagePath      string
	attributes       map[CredentialTypeIdentifier][]*AttributeList
	credentials      map[CredentialTypeIdentifier]map[int]*credential
	keyshareServers  map[SchemeManagerIdentifier]*keyshareServer
22
	paillierKeyCache *paillierPrivateKey
23

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

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

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

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

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

48
49
50
51
52
53
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
54
55
}

Sietse Ringers's avatar
Sietse Ringers committed
56
// attrs returns cm.attributes[id], initializing it to an empty slice if neccesary
57
func (cm *CredentialManager) attrs(id CredentialTypeIdentifier) []*AttributeList {
Sietse Ringers's avatar
Sietse Ringers committed
58
59
60
61
62
63
64
65
66
	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
67
func (cm *CredentialManager) creds(id CredentialTypeIdentifier) map[int]*credential {
Sietse Ringers's avatar
Sietse Ringers committed
68
69
	list, exists := cm.credentials[id]
	if !exists {
Sietse Ringers's avatar
Sietse Ringers committed
70
		list = make(map[int]*credential)
Sietse Ringers's avatar
Sietse Ringers committed
71
72
73
74
75
		cm.credentials[id] = list
	}
	return list
}

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

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

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

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

128
129
130
// 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) {
131
	id := cred.CredentialType().Identifier()
132
	cm.attributes[id] = append(cm.attrs(id), cred.AttributeList())
133

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

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

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

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

	return candidates
}

Sietse Ringers's avatar
Sietse Ringers committed
184
185
186
// 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
187
func (cm *CredentialManager) CheckSatisfiability(disjunctions AttributeDisjunctionList) AttributeDisjunctionList {
188
	missing := make(AttributeDisjunctionList, 0, 5)
Sietse Ringers's avatar
Sietse Ringers committed
189
	for _, disjunction := range disjunctions {
190
191
192
193
194
195
196
		if len(cm.Candidates(disjunction)) == 0 {
			missing = append(missing, disjunction)
		}
	}

	return missing
}
197

198
func (cm *CredentialManager) groupCredentials(choice *DisclosureChoice) (map[CredentialIdentifier][]int, error) {
199
200
201
202
203
204
205
206
207
	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 {
208
209
			indices := make([]int, 1, 1)
			indices[0] = 1 // Always include metadata
210
211
212
213
214
215
			grouped[ici] = indices
		}

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

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

	return grouped, nil
}

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

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

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

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

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

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

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

Sietse Ringers's avatar
Sietse Ringers committed
298
299
300
301
302
303
304
// 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
	}
305
	list := proofBuilders.BuildProofList(request.GetContext(), request.GetNonce(), false)
Sietse Ringers's avatar
Sietse Ringers committed
306
	return &gabi.IssueCommitmentMessage{Proofs: list, Nonce2: request.state.nonce2}, nil
Sietse Ringers's avatar
Sietse Ringers committed
307
308
}

Sietse Ringers's avatar
Sietse Ringers committed
309
310
// ConstructCredentials constructs and saves new credentials
// using the specified issuance signature messages.
Sietse Ringers's avatar
Sietse Ringers committed
311
312
313
314
315
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")
	}

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

331
332
333
334
335
336
	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
337
	}
338

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

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

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

371
372
// KeyshareEnroll attempts to register at the keyshare server of the specified scheme manager.
func (cm *CredentialManager) KeyshareEnroll(managerID SchemeManagerIdentifier, email, pin string) error {
373
	manager, ok := cm.Store.SchemeManagers[managerID]
Sietse Ringers's avatar
Sietse Ringers committed
374
375
376
377
378
379
380
381
382
383
384
	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)
385
	kss, err := newKeyshareServer(cm.paillierKey(true), manager.KeyshareServer, email)
Sietse Ringers's avatar
Sietse Ringers committed
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
	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
	}

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

406
// KeyshareRemove unregisters the keyshare server of the specified scheme manager.
Sietse Ringers's avatar
Sietse Ringers committed
407
408
409
410
411
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
412
413
	return cm.storeKeyshareServers()
}