manager.go 12.3 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
18
19
20
21
22
23
	secretkey       *big.Int
	storagePath     string
	attributes      map[CredentialTypeIdentifier][]*AttributeList
	credentials     map[CredentialTypeIdentifier]map[int]*credential
	keyshareServers map[SchemeManagerIdentifier]*keyshareServer

	paillierKeyCache *paillierPrivateKey
24
25
}

26
// CredentialList returns a list of information of all contained credentials.
Sietse Ringers's avatar
Sietse Ringers committed
27
28
func (cm *CredentialManager) CredentialList() CredentialList {
	list := CredentialList([]*Credential{})
29
30
31

	for _, attrlistlist := range cm.attributes {
		for _, attrlist := range attrlistlist {
32
			list = append(list, attrlist.Info())
Sietse Ringers's avatar
Sietse Ringers committed
33
34
		}
	}
35

Sietse Ringers's avatar
Sietse Ringers committed
36
37
38
39
	sort.Sort(list)
	return list
}

Sietse Ringers's avatar
Sietse Ringers committed
40
41
func (cm *CredentialManager) generateSecretKey() (sk *big.Int, err error) {
	return gabi.RandomBigInt(gabi.DefaultSystemParameters[1024].Lm)
42
43
}

Sietse Ringers's avatar
Sietse Ringers committed
44
// attrs returns cm.attributes[id], initializing it to an empty slice if neccesary
45
func (cm *CredentialManager) attrs(id CredentialTypeIdentifier) []*AttributeList {
Sietse Ringers's avatar
Sietse Ringers committed
46
47
48
49
50
51
52
53
54
	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
55
func (cm *CredentialManager) creds(id CredentialTypeIdentifier) map[int]*credential {
Sietse Ringers's avatar
Sietse Ringers committed
56
57
	list, exists := cm.credentials[id]
	if !exists {
Sietse Ringers's avatar
Sietse Ringers committed
58
		list = make(map[int]*credential)
Sietse Ringers's avatar
Sietse Ringers committed
59
60
61
62
63
		cm.credentials[id] = list
	}
	return list
}

Sietse Ringers's avatar
Sietse Ringers committed
64
// Attributes returns the attribute list of the requested credential, or nil if we do not have it.
65
func (cm *CredentialManager) Attributes(id CredentialTypeIdentifier, counter int) (attributes *AttributeList) {
Sietse Ringers's avatar
Sietse Ringers committed
66
67
	list := cm.attrs(id)
	if len(list) <= counter {
Sietse Ringers's avatar
Sietse Ringers committed
68
69
70
71
72
		return
	}
	return list[counter]
}

Sietse Ringers's avatar
Sietse Ringers committed
73
74
func (cm *CredentialManager) credentialByID(id CredentialIdentifier) (cred *credential, err error) {
	return cm.credential(id.Type, id.Index)
75
76
}

Sietse Ringers's avatar
Sietse Ringers committed
77
78
// 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
79
	// If the requested credential is not in credential map, we check if its attributes were
80
	// deserialized during NewCredentialManager(). If so, there should be a corresponding signature file,
Sietse Ringers's avatar
Sietse Ringers committed
81
	// so we read that, construct the credential, and add it to the credential map
Sietse Ringers's avatar
Sietse Ringers committed
82
	if _, exists := cm.creds(id)[counter]; !exists {
Sietse Ringers's avatar
Sietse Ringers committed
83
84
85
86
87
88
89
90
91
92
93
94
95
		attrs := cm.Attributes(id, counter)
		if attrs == nil { // We do not have the requested cred
			return
		}
		ints := append([]*big.Int{cm.secretkey}, attrs.Ints...)
		sig, err := cm.loadSignature(id, counter)
		if err != nil {
			return nil, err
		}
		if sig == nil {
			err = errors.New("signature file not found")
			return nil, err
		}
96
97
98
99
100
		meta := MetadataFromInt(ints[1])
		pk := meta.PublicKey()
		if pk == nil {
			return nil, errors.New("unknown public key")
		}
101
102
103
		cred := newCredential(&gabi.Credential{
			Attributes: ints,
			Signature:  sig,
104
			Pk:         pk,
105
		})
Sietse Ringers's avatar
Sietse Ringers committed
106
107
108
109
		cm.credentials[id][counter] = cred
	}

	return cm.credentials[id][counter], nil
110
111
}

112
113
114
// 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) {
115
116
117
118
	attrs, err := NewAttributeListFromInts(cred.Attributes[1:])
	if err != nil {
		return err
	}
119
	id := cred.CredentialType().Identifier()
120
	cm.attributes[id] = append(cm.attrs(id), attrs)
121

122
	if _, exists := cm.credentials[id]; !exists {
Sietse Ringers's avatar
Sietse Ringers committed
123
		cm.credentials[id] = make(map[int]*credential)
124
	}
Sietse Ringers's avatar
Sietse Ringers committed
125
126
	counter := len(cm.attributes[id]) - 1
	cm.credentials[id][counter] = cred
127

128
	if err = cm.storeSignature(cred, counter); err != nil {
129
130
		return
	}
131
132
133
	if storeAttributes {
		err = cm.storeAttributes()
	}
134
135
	return
}
136

Sietse Ringers's avatar
Sietse Ringers committed
137
138
// Candidates returns a list of attributes present in this credential manager
// that satisfy the specified attribute disjunction.
139
func (cm *CredentialManager) Candidates(disjunction *AttributeDisjunction) []*AttributeIdentifier {
140
	candidates := make([]*AttributeIdentifier, 0, 10)
141
142

	for _, attribute := range disjunction.Attributes {
Sietse Ringers's avatar
Sietse Ringers committed
143
144
		credID := attribute.CredentialTypeIdentifier()
		if !MetaStore.Contains(credID) {
145
146
			continue
		}
Sietse Ringers's avatar
Sietse Ringers committed
147
		creds := cm.credentials[credID]
148
149
150
151
152
153
154
155
156
		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 {
157
158
				// Ignoring error of unknown credential type, would have happened during initialization
				attrs, _ := NewAttributeListFromInts(cred.Attributes[1:])
159
				val := attrs.Attribute(attribute)
160
				if val == "" { // This won't handle empty attributes correctly
161
162
163
164
165
166
167
168
169
170
171
172
					continue
				}
				if !disjunction.HasValues() || val == disjunction.Values[attribute] {
					candidates = append(candidates, id)
				}
			}
		}
	}

	return candidates
}

Sietse Ringers's avatar
Sietse Ringers committed
173
174
175
// 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
176
func (cm *CredentialManager) CheckSatisfiability(disjunctions AttributeDisjunctionList) AttributeDisjunctionList {
177
	missing := make(AttributeDisjunctionList, 0, 5)
Sietse Ringers's avatar
Sietse Ringers committed
178
	for _, disjunction := range disjunctions {
179
180
181
182
183
184
185
		if len(cm.Candidates(disjunction)) == 0 {
			missing = append(missing, disjunction)
		}
	}

	return missing
}
186

187
func (cm *CredentialManager) groupCredentials(choice *DisclosureChoice) (map[CredentialIdentifier][]int, error) {
188
189
190
191
192
193
194
195
196
	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 {
197
198
			indices := make([]int, 1, 1)
			indices[0] = 1 // Always include metadata
199
200
201
202
203
204
205
206
207
208
209
			grouped[ici] = indices
		}

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

Sietse Ringers's avatar
Sietse Ringers committed
210
		// These indices will be used in the []*big.Int at gabi.credential.Attributes,
211
		// which doesn't know about the secret key and metadata attribute, so +2
212
		grouped[ici] = append(grouped[ici], index+2)
213
214
215
216
217
	}

	return grouped, nil
}

218
219
// IrmaSession is an IRMA session.
type IrmaSession interface {
220
	GetNonce() *big.Int
Sietse Ringers's avatar
Sietse Ringers committed
221
	SetNonce(*big.Int)
222
	GetContext() *big.Int
Sietse Ringers's avatar
Sietse Ringers committed
223
224
	SetContext(*big.Int)
	DisjunctionList() AttributeDisjunctionList
Sietse Ringers's avatar
Sietse Ringers committed
225
226
227
228
	DisclosureChoice() *DisclosureChoice
	SetDisclosureChoice(choice *DisclosureChoice)
	Distributed() bool
	SchemeManagers() []SchemeManagerIdentifier
229
230
}

231
// ProofBuilders constructs a list of proof builders for the specified attribute choice.
232
func (cm *CredentialManager) ProofBuilders(choice *DisclosureChoice) (gabi.ProofBuilderList, error) {
233
234
235
236
237
	todisclose, err := cm.groupCredentials(choice)
	if err != nil {
		return nil, err
	}

238
	builders := gabi.ProofBuilderList([]gabi.ProofBuilder{})
239
	for id, list := range todisclose {
Sietse Ringers's avatar
Sietse Ringers committed
240
		cred, err := cm.credentialByID(id)
241
242
243
244
245
		if err != nil {
			return nil, err
		}
		builders = append(builders, cred.Credential.CreateDisclosureProofBuilder(list))
	}
Sietse Ringers's avatar
Sietse Ringers committed
246
	return builders, nil
247
}
Sietse Ringers's avatar
Sietse Ringers committed
248

Sietse Ringers's avatar
Sietse Ringers committed
249
// Proofs computes disclosure proofs containing the attributes specified by choice.
250
func (cm *CredentialManager) Proofs(choice *DisclosureChoice, request IrmaSession, issig bool) (gabi.ProofList, error) {
Sietse Ringers's avatar
Sietse Ringers committed
251
	builders, err := cm.ProofBuilders(choice)
Sietse Ringers's avatar
Sietse Ringers committed
252
253
254
	if err != nil {
		return nil, err
	}
255
	return builders.BuildProofList(request.GetContext(), request.GetNonce(), issig), nil
Sietse Ringers's avatar
Sietse Ringers committed
256
257
}

258
259
// IssuanceProofBuilders constructs a list of proof builders in the issuance protocol
// for the future credentials as well as possibly any disclosed attributes.
260
func (cm *CredentialManager) IssuanceProofBuilders(request *IssuanceRequest) (gabi.ProofBuilderList, error) {
Sietse Ringers's avatar
Cleanup    
Sietse Ringers committed
261
	state, err := newIssuanceState()
Sietse Ringers's avatar
Sietse Ringers committed
262
263
264
265
266
	if err != nil {
		return nil, err
	}
	request.state = state

267
	proofBuilders := gabi.ProofBuilderList([]gabi.ProofBuilder{})
Sietse Ringers's avatar
Sietse Ringers committed
268
269
270
271
272
273
	for _, futurecred := range request.Credentials {
		pk := MetaStore.PublicKey(futurecred.Credential.IssuerIdentifier(), futurecred.KeyCounter)
		credBuilder := gabi.NewCredentialBuilder(pk, request.GetContext(), cm.secretkey, state.nonce2)
		request.state.builders = append(request.state.builders, credBuilder)
		proofBuilders = append(proofBuilders, credBuilder)
	}
Sietse Ringers's avatar
Sietse Ringers committed
274

Sietse Ringers's avatar
Sietse Ringers committed
275
	disclosures, err := cm.ProofBuilders(request.choice)
Sietse Ringers's avatar
Sietse Ringers committed
276
277
278
	if err != nil {
		return nil, err
	}
Sietse Ringers's avatar
Sietse Ringers committed
279
	proofBuilders = append(disclosures, proofBuilders...)
Sietse Ringers's avatar
Sietse Ringers committed
280
281
	return proofBuilders, nil
}
Sietse Ringers's avatar
Sietse Ringers committed
282

Sietse Ringers's avatar
Sietse Ringers committed
283
284
285
286
287
288
289
// 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
	}
290
	list := proofBuilders.BuildProofList(request.GetContext(), request.GetNonce(), false)
Sietse Ringers's avatar
Sietse Ringers committed
291
	return &gabi.IssueCommitmentMessage{Proofs: list, Nonce2: request.state.nonce2}, nil
Sietse Ringers's avatar
Sietse Ringers committed
292
293
}

Sietse Ringers's avatar
Sietse Ringers committed
294
295
// ConstructCredentials constructs and saves new credentials
// using the specified issuance signature messages.
Sietse Ringers's avatar
Sietse Ringers committed
296
297
298
299
300
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")
	}

301
302
	// 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
Sietse Ringers's avatar
Sietse Ringers committed
303
304
305
306
307
308
309
310
311
312
313
314
315
316
	creds := []*gabi.Credential{}
	for i, sig := range msg {
		attrs, err := request.Credentials[i].AttributeList()
		if err != nil {
			return err
		}
		cred, err := request.state.builders[i].ConstructCredential(sig, attrs.Ints)
		if err != nil {
			return err
		}
		creds = append(creds, cred)
	}

	for _, cred := range creds {
317
		cm.addCredential(newCredential(cred), true)
Sietse Ringers's avatar
Sietse Ringers committed
318
	}
319

Sietse Ringers's avatar
Sietse Ringers committed
320
	return nil
Sietse Ringers's avatar
Sietse Ringers committed
321
}
322
323

// PaillierKey returns a new Paillier key (and generates a new one in a goroutine).
Sietse Ringers's avatar
Sietse Ringers committed
324
func (cm *CredentialManager) paillierKey(wait bool) *paillierPrivateKey {
325
	retval := cm.paillierKeyCache
Sietse Ringers's avatar
Sietse Ringers committed
326
	ch := make(chan bool)
327
328
329
330
	go func() {
		newkey, _ := paillier.GenerateKey(rand.Reader, 2048)
		converted := paillierPrivateKey(*newkey)
		cm.paillierKeyCache = &converted
Sietse Ringers's avatar
Sietse Ringers committed
331
332
333
		if wait && retval == nil {
			ch <- true
		}
334
	}()
Sietse Ringers's avatar
Sietse Ringers committed
335
336
337
338
	if wait && retval == nil {
		<-ch
		return cm.paillierKeyCache
	}
339
340
	return retval
}
Sietse Ringers's avatar
Sietse Ringers committed
341
342
343
344
345
346
347
348
349
350

func (cm *CredentialManager) unenrolledKeyshareServers() []*SchemeManager {
	list := []*SchemeManager{}
	for name, manager := range MetaStore.SchemeManagers {
		if _, contains := cm.keyshareServers[name]; len(manager.KeyshareServer) > 0 && !contains {
			list = append(list, manager)
		}
	}
	return list
}
Sietse Ringers's avatar
Sietse Ringers committed
351

352
353
354
// KeyshareEnroll attempts to register at the keyshare server of the specified scheme manager.
func (cm *CredentialManager) KeyshareEnroll(managerID SchemeManagerIdentifier, email, pin string) error {
	manager, ok := MetaStore.SchemeManagers[managerID]
Sietse Ringers's avatar
Sietse Ringers committed
355
356
357
358
359
360
361
362
363
364
365
	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)
366
	kss, err := newKeyshareServer(cm.paillierKey(true), manager.KeyshareServer, email)
Sietse Ringers's avatar
Sietse Ringers committed
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
	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
	}

383
	cm.keyshareServers[managerID] = kss
Sietse Ringers's avatar
Sietse Ringers committed
384
385
386
	return cm.storeKeyshareServers()
}

387
// KeyshareRemove unregisters the keyshare server of the specified scheme manager.
Sietse Ringers's avatar
Sietse Ringers committed
388
389
390
391
392
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
393
394
	return cm.storeKeyshareServers()
}