irmaconfig.go 46.6 KB
Newer Older
1
package irma
2
3

import (
4
	"crypto/rsa"
5
6
7
8
9
	"encoding/base64"
	"encoding/xml"
	"io/ioutil"
	"os"
	"path/filepath"
10
	"reflect"
11
	"regexp"
12
	"strconv"
13
	"time"
14

15
16
	"crypto/sha256"

17
18
19
20
	"fmt"

	"strings"

21
22
23
24
25
26
27
28
29
30
	"sort"

	"bytes"

	"encoding/hex"

	"crypto/ecdsa"
	"crypto/x509"
	"encoding/asn1"
	"encoding/pem"
31
	gobig "math/big"
32

33
	"github.com/dgrijalva/jwt-go"
34
	"github.com/go-errors/errors"
Sietse Ringers's avatar
Sietse Ringers committed
35
	"github.com/jasonlvhit/gocron"
36
37
	"github.com/privacybydesign/gabi"
	"github.com/privacybydesign/gabi/big"
38
	"github.com/privacybydesign/irmago/internal/fs"
39
40
)

41
// Configuration keeps track of scheme managers, issuers, credential types and public keys,
42
// dezerializing them from an irma_configuration folder, and downloads and saves new ones on demand.
43
type Configuration struct {
44
45
46
	SchemeManagers  map[SchemeManagerIdentifier]*SchemeManager
	Issuers         map[IssuerIdentifier]*Issuer
	CredentialTypes map[CredentialTypeIdentifier]*CredentialType
47
	AttributeTypes  map[AttributeTypeIdentifier]*AttributeType
48

Sietse Ringers's avatar
Sietse Ringers committed
49
50
51
	// Path to the irma_configuration folder that this instance represents
	Path string

52
53
54
	// DisabledSchemeManagers keeps track of scheme managers that did not parse  succesfully
	// (i.e., invalid signature, parsing error), and the problem that occurred when parsing them
	DisabledSchemeManagers map[SchemeManagerIdentifier]*SchemeManagerError
55

56
57
	Warnings []string

58
	kssPublicKeys map[SchemeManagerIdentifier]map[int]*rsa.PublicKey
59
	publicKeys    map[IssuerIdentifier]map[int]*gabi.PublicKey
60
	privateKeys   map[IssuerIdentifier]*gabi.PrivateKey
61
	reverseHashes map[string]CredentialTypeIdentifier
62
	initialized   bool
63
	assets        string
64
	readOnly      bool
Sietse Ringers's avatar
Sietse Ringers committed
65
	cronchan      chan bool
66
	scheduler     *gocron.Scheduler
67
68
}

Sietse Ringers's avatar
Sietse Ringers committed
69
70
// ConfigurationFileHash encodes the SHA256 hash of an authenticated
// file under a scheme manager within the configuration folder.
71
72
type ConfigurationFileHash []byte

Sietse Ringers's avatar
Sietse Ringers committed
73
74
// SchemeManagerIndex is a (signed) list of files under a scheme manager
// along with their SHA266 hash
75
76
type SchemeManagerIndex map[string]ConfigurationFileHash

77
78
type SchemeManagerStatus string

79
80
type SchemeManagerError struct {
	Manager SchemeManagerIdentifier
81
	Status  SchemeManagerStatus
82
83
84
	Err     error
}

85
86
87
88
89
type UnknownIdentifierError struct {
	ErrorType
	Missing *IrmaIdentifierSet
}

90
91
92
93
94
95
96
const (
	SchemeManagerStatusValid               = SchemeManagerStatus("Valid")
	SchemeManagerStatusUnprocessed         = SchemeManagerStatus("Unprocessed")
	SchemeManagerStatusInvalidIndex        = SchemeManagerStatus("InvalidIndex")
	SchemeManagerStatusInvalidSignature    = SchemeManagerStatus("InvalidSignature")
	SchemeManagerStatusParsingError        = SchemeManagerStatus("ParsingError")
	SchemeManagerStatusContentParsingError = SchemeManagerStatus("ContentParsingError")
97

98
99
	pubkeyPattern  = "%s/%s/%s/PublicKeys/*.xml"
	privkeyPattern = "%s/%s/%s/PrivateKeys/*.xml"
100
101
)

102
103
104
105
func (sme SchemeManagerError) Error() string {
	return fmt.Sprintf("Error parsing scheme manager %s: %s", sme.Manager.Name(), sme.Err.Error())
}

106
// NewConfiguration returns a new configuration. After this
107
// ParseFolder() should be called to parse the specified path.
108
109
110
111
func NewConfiguration(path string) (*Configuration, error) {
	return newConfiguration(path, "")
}

112
113
// NewConfigurationReadOnly returns a new configuration whose representation on disk
// is never altered. ParseFolder() should be called to parse the specified path.
114
115
116
117
118
119
120
121
122
func NewConfigurationReadOnly(path string) (*Configuration, error) {
	conf, err := newConfiguration(path, "")
	if err != nil {
		return nil, err
	}
	conf.readOnly = true
	return conf, nil
}

123
124
// NewConfigurationFromAssets returns a new configuration, copying the schemes out of the assets folder to path.
// ParseFolder() should be called to parse the specified path.
125
126
127
128
129
func NewConfigurationFromAssets(path, assets string) (*Configuration, error) {
	return newConfiguration(path, assets)
}

func newConfiguration(path string, assets string) (conf *Configuration, err error) {
130
	conf = &Configuration{
Sietse Ringers's avatar
Sietse Ringers committed
131
		Path:   path,
132
		assets: assets,
133
	}
134

135
136
137
138
	if conf.assets != "" { // If an assets folder is specified, then it must exist
		if err = fs.AssertPathExists(conf.assets); err != nil {
			return nil, errors.WrapPrefix(err, "Nonexistent assets folder specified", 0)
		}
139
	}
140
	if err = fs.EnsureDirectoryExists(conf.Path); err != nil {
141
142
		return nil, err
	}
143

144
145
146
	// Init all maps
	conf.clear()

147
148
149
	return
}

150
func (conf *Configuration) clear() {
151
152
153
	conf.SchemeManagers = make(map[SchemeManagerIdentifier]*SchemeManager)
	conf.Issuers = make(map[IssuerIdentifier]*Issuer)
	conf.CredentialTypes = make(map[CredentialTypeIdentifier]*CredentialType)
154
	conf.AttributeTypes = make(map[AttributeTypeIdentifier]*AttributeType)
155
	conf.DisabledSchemeManagers = make(map[SchemeManagerIdentifier]*SchemeManagerError)
156
	conf.kssPublicKeys = make(map[SchemeManagerIdentifier]map[int]*rsa.PublicKey)
157
	conf.publicKeys = make(map[IssuerIdentifier]map[int]*gabi.PublicKey)
158
	conf.privateKeys = make(map[IssuerIdentifier]*gabi.PrivateKey)
159
	conf.reverseHashes = make(map[string]CredentialTypeIdentifier)
160
161
162
163
164
165
166
}

// ParseFolder populates the current Configuration by parsing the storage path,
// listing the containing scheme managers, issuers and credential types.
func (conf *Configuration) ParseFolder() (err error) {
	// Init all maps
	conf.clear()
167

168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
	// Copy any new or updated scheme managers out of the assets into storage
	if conf.assets != "" {
		err = iterateSubfolders(conf.assets, func(dir string) error {
			scheme := NewSchemeManagerIdentifier(filepath.Base(dir))
			uptodate, err := conf.isUpToDate(scheme)
			if err != nil {
				return err
			}
			if !uptodate {
				_, err = conf.CopyManagerFromAssets(scheme)
			}
			return err
		})
		if err != nil {
			return err
		}
	}

	// Parse scheme managers in storage
187
	var mgrerr *SchemeManagerError
Sietse Ringers's avatar
Sietse Ringers committed
188
	err = iterateSubfolders(conf.Path, func(dir string) error {
189
190
		manager := NewSchemeManager(filepath.Base(dir))
		err := conf.ParseSchemeManagerFolder(dir, manager)
191
192
		if err == nil {
			return nil // OK, do next scheme manager folder
193
		}
194
195
196
197
		// If there is an error, and it is of type SchemeManagerError, return nil
		// so as to continue parsing other managers.
		var ok bool
		if mgrerr, ok = err.(*SchemeManagerError); ok {
198
			conf.DisabledSchemeManagers[manager.Identifier()] = mgrerr
199
			return nil
200
		}
201
		return err // Not a SchemeManagerError? return it & halt parsing now
202
203
	})
	if err != nil {
204
		return
205
	}
206
	conf.initialized = true
207
208
209
	if mgrerr != nil {
		return mgrerr
	}
210
	return
211
212
}

213
214
215
216
217
218
219
// ParseOrRestoreFolder parses the irma_configuration folder, and when possible attempts to restore
// any broken scheme managers from their remote.
// Any error encountered during parsing is considered recoverable only if it is of type *SchemeManagerError;
// In this case the scheme in which it occured is downloaded from its remote and re-parsed.
// If any other error is encountered at any time, it is returned immediately.
// If no error is returned, parsing and possibly restoring has been succesfull, and there should be no
// disabled scheme managers.
220
221
func (conf *Configuration) ParseOrRestoreFolder() error {
	err := conf.ParseFolder()
222
223
224
	// Only in case of a *SchemeManagerError might we be able to recover
	if _, isSchemeMgrErr := err.(*SchemeManagerError); !isSchemeMgrErr {
		return err
225
	}
226
227
228
	if err != nil && (conf.assets == "" || conf.readOnly) {
		return err
	}
229
230

	for id := range conf.DisabledSchemeManagers {
231
232
233
234
235
236
237
238
239
		if err = conf.ReinstallSchemeManager(conf.SchemeManagers[id]); err == nil {
			continue
		}
		if _, err = conf.CopyManagerFromAssets(id); err != nil {
			return err // File system error, too serious, bail out now
		}
		name := id.String()
		if err = conf.ParseSchemeManagerFolder(filepath.Join(conf.Path, name), NewSchemeManager(name)); err == nil {
			delete(conf.DisabledSchemeManagers, id)
240
		}
241
	}
242

243
244
245
	return err
}

246
// ParseSchemeManagerFolder parses the entire tree of the specified scheme manager
247
// If err != nil then a problem occured
248
func (conf *Configuration) ParseSchemeManagerFolder(dir string, manager *SchemeManager) (err error) {
249
250
251
252
253
254
255
	// From this point, keep it in our map even if it has an error. The user must check either:
	// - manager.Status == SchemeManagerStatusValid, aka "VALID"
	// - or equivalently, manager.Valid == true
	// before using any scheme manager for anything, and handle accordingly
	conf.SchemeManagers[manager.Identifier()] = manager

	// Ensure we return a SchemeManagerError when any error occurs
256
257
	defer func() {
		if err != nil {
258
259
260
261
262
			err = &SchemeManagerError{
				Manager: manager.Identifier(),
				Err:     err,
				Status:  manager.Status,
			}
263
264
265
		}
	}()

266
267
	// Verify signature and read scheme manager description
	if err = conf.VerifySignature(manager.Identifier()); err != nil {
268
269
		return
	}
270
	if manager.index, err = conf.parseIndex(filepath.Base(dir), manager); err != nil {
271
272
		manager.Status = SchemeManagerStatusInvalidIndex
		return
273
	}
274
	exists, err := conf.pathToDescription(manager, dir+"/description.xml", manager)
275
276
277
	if err != nil {
		manager.Status = SchemeManagerStatusParsingError
		return
278
	}
279
280
281
282
	if !exists {
		manager.Status = SchemeManagerStatusParsingError
		return errors.New("Scheme manager description not found")
	}
283
	if err = conf.validateScheme(manager, dir); err != nil {
284
		return
285
	}
286
287
288
289
290
291
292

	// Verify that all other files are validly signed
	err = conf.VerifySchemeManager(manager)
	if err != nil {
		manager.Status = SchemeManagerStatusInvalidSignature
		return
	}
293

294
	// Read timestamp indicating time of last modification
295
296
297
	ts, exists, err := readTimestamp(dir + "/timestamp")
	if err != nil || !exists {
		return errors.WrapPrefix(err, "Could not read scheme manager timestamp", 0)
298
	}
299
	manager.Timestamp = *ts
300

301
	// Parse contained issuers and credential types
302
	err = conf.parseIssuerFolders(manager, dir)
303
304
305
306
307
308
	if err != nil {
		manager.Status = SchemeManagerStatusContentParsingError
		return
	}
	manager.Status = SchemeManagerStatusValid
	manager.Valid = true
309
310
311
	return
}

312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
// PrivateKey returns the specified private key, or nil if not present in the Configuration.
func (conf *Configuration) PrivateKey(id IssuerIdentifier) (*gabi.PrivateKey, error) {
	if sk := conf.privateKeys[id]; sk != nil {
		return sk, nil
	}

	path := fmt.Sprintf(privkeyPattern, conf.Path, id.SchemeManagerIdentifier().Name(), id.Name())
	files, err := filepath.Glob(path)
	if err != nil {
		return nil, err
	}
	if len(files) == 0 {
		return nil, nil
	}

	// List private keys and get highest counter
	counters := make([]int, 0, len(files))
	for _, file := range files {
		filename := filepath.Base(file)
		count := filename[:len(filename)-4]
		i, err := strconv.Atoi(count)
		if err != nil {
			return nil, err
		}
		counters = append(counters, i)
	}
	sort.Ints(counters)
	counter := counters[len(counters)-1]

	// Read private key
	file := strings.Replace(path, "*", strconv.Itoa(counter), 1)
	sk, err := gabi.NewPrivateKeyFromFile(file)
	if err != nil {
		return nil, err
	}
	if int(sk.Counter) != counter {
		return nil, errors.Errorf("Private key %s of issuer %s has wrong <Counter>", file, id.String())
	}
	conf.privateKeys[id] = sk

	return sk, nil
}

355
356
// PublicKey returns the specified public key, or nil if not present in the Configuration.
func (conf *Configuration) PublicKey(id IssuerIdentifier, counter int) (*gabi.PublicKey, error) {
357
358
359
360
361
362
363
364
365
366
367
	var haveIssuer, haveKey bool
	var err error
	_, haveIssuer = conf.publicKeys[id]
	if haveIssuer {
		_, haveKey = conf.publicKeys[id][counter]
	}

	// If we have not seen this issuer or key before in conf.publicKeys,
	// try to parse the public key folder; new keys might have been put there since we last parsed it
	if !haveIssuer || !haveKey {
		if err = conf.parseKeysFolder(id); err != nil {
368
			return nil, err
369
370
		}
	}
371
	return conf.publicKeys[id][counter], nil
372
373
}

374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
// KeyshareServerKeyFunc returns a function that returns the public key with which to verify a keyshare server JWT,
// suitable for passing to jwt.Parse() and jwt.ParseWithClaims().
func (conf *Configuration) KeyshareServerKeyFunc(scheme SchemeManagerIdentifier) func(t *jwt.Token) (interface{}, error) {
	return func(t *jwt.Token) (i interface{}, e error) {
		var kid int
		if kidstr, ok := t.Header["kid"].(string); ok {
			var err error
			if kid, err = strconv.Atoi(kidstr); err != nil {
				return nil, err
			}
		}
		return conf.KeyshareServerPublicKey(scheme, kid)
	}
}

// KeyshareServerPublicKey returns the i'th public key of the specified scheme.
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
func (conf *Configuration) KeyshareServerPublicKey(scheme SchemeManagerIdentifier, i int) (*rsa.PublicKey, error) {
	if _, contains := conf.kssPublicKeys[scheme]; !contains {
		conf.kssPublicKeys[scheme] = make(map[int]*rsa.PublicKey)
	}
	if _, contains := conf.kssPublicKeys[scheme][i]; !contains {
		pkbts, err := ioutil.ReadFile(filepath.Join(conf.Path, scheme.Name(), fmt.Sprintf("kss-%d.pem", i)))
		if err != nil {
			return nil, err
		}
		pkblk, _ := pem.Decode(pkbts)
		genericPk, err := x509.ParsePKIXPublicKey(pkblk.Bytes)
		if err != nil {
			return nil, err
		}
		pk, ok := genericPk.(*rsa.PublicKey)
		if !ok {
			return nil, errors.New("Invalid keyshare server public key")
		}
		conf.kssPublicKeys[scheme][i] = pk
	}
	return conf.kssPublicKeys[scheme][i], nil
}

413
func (conf *Configuration) addReverseHash(credid CredentialTypeIdentifier) {
414
	hash := sha256.Sum256([]byte(credid.String()))
415
	conf.reverseHashes[base64.StdEncoding.EncodeToString(hash[:16])] = credid
416
417
}

418
419
420
func (conf *Configuration) hashToCredentialType(hash []byte) *CredentialType {
	if str, exists := conf.reverseHashes[base64.StdEncoding.EncodeToString(hash)]; exists {
		return conf.CredentialTypes[str]
421
422
423
424
	}
	return nil
}

425
// IsInitialized indicates whether this instance has successfully been initialized.
426
427
func (conf *Configuration) IsInitialized() bool {
	return conf.initialized
428
429
}

430
431
432
433
434
435
436
437
438
// Prune removes any invalid scheme managers and everything they own from this Configuration
func (conf *Configuration) Prune() {
	for _, manager := range conf.SchemeManagers {
		if !manager.Valid {
			_ = conf.RemoveSchemeManager(manager.Identifier(), false) // does not return errors
		}
	}
}

439
func (conf *Configuration) parseIssuerFolders(manager *SchemeManager, path string) error {
440
441
	return iterateSubfolders(path, func(dir string) error {
		issuer := &Issuer{}
442
		exists, err := conf.pathToDescription(manager, dir+"/description.xml", issuer)
443
444
445
		if err != nil {
			return err
		}
446
447
		if !exists {
			return nil
448
		}
449
450
451
		if issuer.XMLVersion < 4 {
			return errors.New("Unsupported issuer description")
		}
452

453
		if err = conf.validateIssuer(manager, issuer, dir); err != nil {
454
455
456
			return err
		}

457
		conf.Issuers[issuer.Identifier()] = issuer
458
		issuer.Valid = conf.SchemeManagers[issuer.SchemeManagerIdentifier()].Valid
459
		return conf.parseCredentialsFolder(manager, issuer, dir+"/Issues/")
460
461
462
	})
}

463
464
465
func (conf *Configuration) DeleteSchemeManager(id SchemeManagerIdentifier) error {
	delete(conf.SchemeManagers, id)
	delete(conf.DisabledSchemeManagers, id)
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
	name := id.String()
	for iss := range conf.Issuers {
		if iss.Root() == name {
			delete(conf.Issuers, iss)
		}
	}
	for iss := range conf.publicKeys {
		if iss.Root() == name {
			delete(conf.publicKeys, iss)
		}
	}
	for cred := range conf.CredentialTypes {
		if cred.Root() == name {
			delete(conf.CredentialTypes, cred)
		}
	}
482
483
484
485
	if !conf.readOnly {
		return os.RemoveAll(filepath.Join(conf.Path, id.Name()))
	}
	return nil
486
487
}

488
// parse $schememanager/$issuer/PublicKeys/$i.xml for $i = 1, ...
489
490
func (conf *Configuration) parseKeysFolder(issuerid IssuerIdentifier) error {
	manager := conf.SchemeManagers[issuerid.SchemeManagerIdentifier()]
491
	conf.publicKeys[issuerid] = map[int]*gabi.PublicKey{}
492
	path := fmt.Sprintf(pubkeyPattern, conf.Path, issuerid.SchemeManagerIdentifier().Name(), issuerid.Name())
493
494
495
496
497
498
499
500
501
502
	files, err := filepath.Glob(path)
	if err != nil {
		return err
	}

	for _, file := range files {
		filename := filepath.Base(file)
		count := filename[:len(filename)-4]
		i, err := strconv.Atoi(count)
		if err != nil {
503
			return err
504
		}
505
		relativepath, err := filepath.Rel(conf.Path, file)
506
507
508
509
		if err != nil {
			return err
		}
		bts, found, err := conf.ReadAuthenticatedFile(manager, relativepath)
510
		if err != nil || !found {
511
512
513
			return err
		}
		pk, err := gabi.NewPublicKeyFromBytes(bts)
514
515
516
		if err != nil {
			return err
		}
517
518
519
		if int(pk.Counter) != i {
			return errors.Errorf("Public key %s of issuer %s has wrong <Counter>", file, issuerid.String())
		}
520
		pk.Issuer = issuerid.String()
521
		conf.publicKeys[issuerid][i] = pk
522
	}
523

524
525
526
	return nil
}

527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
func (conf *Configuration) PublicKeyIndices(issuerid IssuerIdentifier) (i []int, err error) {
	return conf.matchKeyPattern(issuerid, pubkeyPattern)
}

func (conf *Configuration) matchKeyPattern(issuerid IssuerIdentifier, pattern string) (i []int, err error) {
	pkpath := fmt.Sprintf(pattern, conf.Path, issuerid.SchemeManagerIdentifier().Name(), issuerid.Name())
	files, err := filepath.Glob(pkpath)
	if err != nil {
		return
	}
	for _, file := range files {
		var count int
		base := filepath.Base(file)
		if count, err = strconv.Atoi(base[:len(base)-4]); err != nil {
			return
		}
		i = append(i, count)
	}
	sort.Ints(i)
	return
}

549
// parse $schememanager/$issuer/Issues/*/description.xml
550
551
552
func (conf *Configuration) parseCredentialsFolder(manager *SchemeManager, issuer *Issuer, path string) error {
	var foundcred bool
	err := iterateSubfolders(path, func(dir string) error {
553
		cred := &CredentialType{}
554
		exists, err := conf.pathToDescription(manager, dir+"/description.xml", cred)
555
556
557
		if err != nil {
			return err
		}
558
559
560
		if !exists {
			return nil
		}
561
		if err = conf.validateCredentialType(manager, issuer, cred, dir); err != nil {
562
563
564
565
			return err
		}
		foundcred = true
		cred.Valid = conf.SchemeManagers[cred.SchemeManagerIdentifier()].Valid
566
		credid := cred.Identifier()
567
568
		conf.CredentialTypes[credid] = cred
		conf.addReverseHash(credid)
569
		for index, attr := range cred.AttributeTypes {
570
571
572
573
			attr.Index = index
			attr.SchemeManagerID = cred.SchemeManagerID
			attr.IssuerID = cred.IssuerID
			attr.CredentialTypeID = cred.ID
574
			conf.AttributeTypes[attr.GetAttributeTypeIdentifier()] = attr
575
		}
576
577
		return nil
	})
578
579
580
581
582
583
	if !foundcred {
		conf.Warnings = append(conf.Warnings, fmt.Sprintf("Issuer %s has no credential types", issuer.Identifier().String()))
	}
	return err
}

584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
// iterateSubfolders iterates over the subfolders of the specified path,
// calling the specified handler each time. If anything goes wrong, or
// if the caller returns a non-nil error, an error is immediately returned.
func iterateSubfolders(path string, handler func(string) error) error {
	dirs, err := filepath.Glob(path + "/*")
	if err != nil {
		return err
	}

	for _, dir := range dirs {
		stat, err := os.Stat(dir)
		if err != nil {
			return err
		}
		if !stat.IsDir() {
			continue
		}
601
602
603
		if strings.HasSuffix(dir, "/.git") {
			continue
		}
604
605
606
607
608
609
610
611
612
		err = handler(dir)
		if err != nil {
			return err
		}
	}

	return nil
}

613
func (conf *Configuration) pathToDescription(manager *SchemeManager, path string, description interface{}) (bool, error) {
614
615
616
617
	if _, err := os.Stat(path); err != nil {
		return false, nil
	}

618
	relativepath, err := filepath.Rel(conf.Path, path)
619
620
621
622
	if err != nil {
		return false, err
	}
	bts, found, err := conf.ReadAuthenticatedFile(manager, relativepath)
623
	if !found {
624
625
		if manager.index.Scheme() != manager.Identifier() {
			return false, errors.Errorf("Folder must be called %s, not %s", manager.index.Scheme(), manager.ID)
626
		}
627
		return false, errors.Errorf("File %s not present in scheme index", relativepath)
628
	}
629
630
631
632
	if err != nil {
		return true, err
	}

633
	err = xml.Unmarshal(bts, description)
634
635
636
637
638
639
	if err != nil {
		return true, err
	}

	return true, nil
}
640

641
642
// ContainsCredentialType checks if the configuration contains the specified credential type.
func (conf *Configuration) ContainsCredentialType(cred CredentialTypeIdentifier) bool {
643
644
645
	return conf.SchemeManagers[cred.IssuerIdentifier().SchemeManagerIdentifier()] != nil &&
		conf.Issuers[cred.IssuerIdentifier()] != nil &&
		conf.CredentialTypes[cred] != nil
646
}
647

648
649
650
651
652
func (conf *Configuration) ContainsAttributeType(attr AttributeTypeIdentifier) bool {
	_, contains := conf.AttributeTypes[attr]
	return contains && conf.ContainsCredentialType(attr.CredentialTypeIdentifier())
}

653
func (conf *Configuration) isUpToDate(scheme SchemeManagerIdentifier) (bool, error) {
654
	if conf.assets == "" || conf.readOnly {
655
656
		return true, nil
	}
657
658
659
660
	name := scheme.String()
	newTime, exists, err := readTimestamp(filepath.Join(conf.assets, name, "timestamp"))
	if err != nil || !exists {
		return true, errors.WrapPrefix(err, "Could not read asset timestamp of scheme "+name, 0)
661
	}
662
663
664
665
	// The storage version of the manager does not need to have a timestamp. If it does not, it is outdated.
	oldTime, exists, err := readTimestamp(filepath.Join(conf.Path, name, "timestamp"))
	if err != nil {
		return true, err
666
	}
667
	return exists && !newTime.After(*oldTime), nil
668
669
}

670
func (conf *Configuration) CopyManagerFromAssets(scheme SchemeManagerIdentifier) (bool, error) {
671
	if conf.assets == "" || conf.readOnly {
672
		return false, nil
673
	}
674
675
676
677
678
	// Remove old version; we want an exact copy of the assets version
	// not a merge of the assets version and the storage version
	name := scheme.String()
	if err := os.RemoveAll(filepath.Join(conf.Path, name)); err != nil {
		return false, err
679
	}
680
681
682
	return true, fs.CopyDirectory(
		filepath.Join(conf.assets, name),
		filepath.Join(conf.Path, name),
683
684
685
	)
}

686
687
// DownloadSchemeManager downloads and returns a scheme manager description.xml file
// from the specified URL.
688
func DownloadSchemeManager(url string) (*SchemeManager, error) {
689
690
691
692
693
694
695
696
697
	if !strings.HasPrefix(url, "http://") && !strings.HasPrefix(url, "https://") {
		url = "https://" + url
	}
	if url[len(url)-1] == '/' {
		url = url[:len(url)-1]
	}
	if strings.HasSuffix(url, "/description.xml") {
		url = url[:len(url)-len("/description.xml")]
	}
698
	b, err := NewHTTPTransport(url).GetBytes("description.xml")
699
700
701
	if err != nil {
		return nil, err
	}
702
	manager := NewSchemeManager("")
703
704
705
706
707
708
709
710
	if err = xml.Unmarshal(b, manager); err != nil {
		return nil, err
	}

	manager.URL = url // TODO?
	return manager, nil
}

Sietse Ringers's avatar
Sietse Ringers committed
711
712
// RemoveSchemeManager removes the specified scheme manager and all associated issuers,
// public keys and credential types from this Configuration.
713
func (conf *Configuration) RemoveSchemeManager(id SchemeManagerIdentifier, fromStorage bool) error {
714
	// Remove everything falling under the manager's responsibility
715
	for credid := range conf.CredentialTypes {
716
		if credid.IssuerIdentifier().SchemeManagerIdentifier() == id {
717
			delete(conf.CredentialTypes, credid)
718
719
		}
	}
720
	for issid := range conf.Issuers {
721
		if issid.SchemeManagerIdentifier() == id {
722
			delete(conf.Issuers, issid)
723
724
		}
	}
725
	for issid := range conf.publicKeys {
726
		if issid.SchemeManagerIdentifier() == id {
727
			delete(conf.publicKeys, issid)
728
729
		}
	}
730
	delete(conf.SchemeManagers, id)
731

732
	if fromStorage || !conf.readOnly {
Sietse Ringers's avatar
Sietse Ringers committed
733
		return os.RemoveAll(fmt.Sprintf("%s/%s", conf.Path, id.String()))
734
735
	}
	return nil
736
737
}

738
func (conf *Configuration) ReinstallSchemeManager(manager *SchemeManager) (err error) {
739
740
741
742
	if conf.readOnly {
		return errors.New("cannot install scheme into a read-only configuration")
	}

743
744
745
746
747
748
749
750
751
	// Check if downloading stuff from the remote works before we uninstall the specified manager:
	// If we can't download anything we should keep the broken version
	manager, err = DownloadSchemeManager(manager.URL)
	if err != nil {
		return
	}
	if err = conf.DeleteSchemeManager(manager.Identifier()); err != nil {
		return
	}
752
	err = conf.InstallSchemeManager(manager, nil)
753
754
755
	return
}

756
// InstallSchemeManager downloads and adds the specified scheme manager to this Configuration,
Sietse Ringers's avatar
Sietse Ringers committed
757
// provided its signature is valid.
758
func (conf *Configuration) InstallSchemeManager(manager *SchemeManager, publickey []byte) error {
759
760
761
762
	if conf.readOnly {
		return errors.New("cannot install scheme into a read-only configuration")
	}

763
	name := manager.ID
764
	if err := fs.EnsureDirectoryExists(filepath.Join(conf.Path, name)); err != nil {
765
766
		return err
	}
767
768

	t := NewHTTPTransport(manager.URL)
Sietse Ringers's avatar
Sietse Ringers committed
769
	path := fmt.Sprintf("%s/%s", conf.Path, name)
770
771
772
	if err := t.GetFile("description.xml", path+"/description.xml"); err != nil {
		return err
	}
773
774
775
776
777
778
779
780
	if publickey != nil {
		if err := fs.SaveFile(path+"/pk.pem", publickey); err != nil {
			return err
		}
	} else {
		if err := t.GetFile("pk.pem", path+"/pk.pem"); err != nil {
			return err
		}
781
	}
782
	if err := conf.DownloadSchemeManagerSignature(manager); err != nil {
783
784
		return err
	}
785
786
787
788
	conf.SchemeManagers[manager.Identifier()] = manager
	if err := conf.UpdateSchemeManager(manager.Identifier(), nil); err != nil {
		return err
	}
789

790
	return conf.ParseSchemeManagerFolder(filepath.Join(conf.Path, name), manager)
791
792
793
794
795
}

// DownloadSchemeManagerSignature downloads, stores and verifies the latest version
// of the index file and signature of the specified manager.
func (conf *Configuration) DownloadSchemeManagerSignature(manager *SchemeManager) (err error) {
796
797
798
799
	if conf.readOnly {
		return errors.New("cannot download into a read-only configuration")
	}

800
	t := NewHTTPTransport(manager.URL)
Sietse Ringers's avatar
Sietse Ringers committed
801
	path := fmt.Sprintf("%s/%s", conf.Path, manager.ID)
802
803
804
805
	index := filepath.Join(path, "index")
	sig := filepath.Join(path, "index.sig")

	if err = t.GetFile("index", index); err != nil {
806
		return
807
808
	}
	if err = t.GetFile("index.sig", sig); err != nil {
809
		return
810
	}
811
	err = conf.VerifySignature(manager.Identifier())
812
	return
813
}
814

815
816
817
818
func (e *UnknownIdentifierError) Error() string {
	return "unknown identifiers: " + e.Missing.String()
}

Sietse Ringers's avatar
Sietse Ringers committed
819
820
821
// Download downloads the issuers, credential types and public keys specified in set
// if the current Configuration does not already have them,  and checks their authenticity
// using the scheme manager index.
822
func (conf *Configuration) Download(session SessionRequest) (downloaded *IrmaIdentifierSet, err error) {
823
824
825
	if conf.readOnly {
		return nil, errors.New("cannot download into a read-only configuration")
	}
826

827
828
829
	missing, err := conf.checkIdentifiers(session)
	if err != nil {
		return nil, err
830
	}
831
832
	if len(missing.SchemeManagers) > 0 {
		return nil, &UnknownIdentifierError{ErrorUnknownSchemeManager, missing}
833
834
	}

835
836
837
838
	// Update the scheme  found above and parse them, if necessary
	downloaded = newIrmaIdentifierSet()
	for id := range missing.allSchemes() {
		if err = conf.UpdateSchemeManager(id, downloaded); err != nil {
839
840
841
			return
		}
	}
842

843
	if !downloaded.Empty() {
844
845
846
		if err = conf.ParseFolder(); err != nil {
			return nil, err
		}
847
	}
848
849
850
851
852
853
854
855
856

	// Check again if all identifiers are known in the Configuration
	if missing, err = conf.checkIdentifiers(session); err != nil {
		return nil, err
	}
	if !missing.Empty() {
		return nil, &UnknownIdentifierError{ErrorUnknownIdentifier, missing}
	}

857
858
859
	return
}

860
func (conf *Configuration) checkCredentialTypes(session SessionRequest, missing *IrmaIdentifierSet) {
861
862
863
864
865
866
867
	var typ *CredentialType
	var contains bool

	switch s := session.(type) {
	case *IssuanceRequest:
		for _, credreq := range s.Credentials {
			// First check if we have this credential type
868
			typ, contains = conf.CredentialTypes[credreq.CredentialTypeID]
869
			if !contains {
870
				missing.CredentialTypes[credreq.CredentialTypeID] = struct{}{}
871
872
873
874
875
876
877
878
				continue
			}
			newAttrs := make(map[string]string)
			for k, v := range credreq.Attributes {
				newAttrs[k] = v
			}
			// For each of the attributes in the credentialtype, see if it is present; if so remove it from newAttrs
			// If not, check that it is optional; if not the credentialtype must be updated
879
			for _, attrtyp := range typ.AttributeTypes {
880
881
				_, contains = newAttrs[attrtyp.ID]
				if !contains && !attrtyp.IsOptional() {
882
					missing.CredentialTypes[credreq.CredentialTypeID] = struct{}{}
883
884
885
886
887
888
					break
				}
				delete(newAttrs, attrtyp.ID)
			}
			// If there is anything left in newAttrs, then these are attributes that are not in the credentialtype
			if len(newAttrs) > 0 {
889
				missing.CredentialTypes[credreq.CredentialTypeID] = struct{}{}
890
891
892
893
			}
		}
	}

894
895
896
	_ = session.Disclosure().Disclose.Iterate(func(attr *AttributeRequest) error {
		credid := attr.Type.CredentialTypeIdentifier()
		if typ, contains = conf.CredentialTypes[credid]; !contains {
897
			missing.CredentialTypes[credid] = struct{}{}
898
			return nil
899
		}
900
		if !attr.Type.IsCredential() && !typ.ContainsAttribute(attr.Type) {
901
			missing.CredentialTypes[credid] = struct{}{}
902
903
904
		}
		return nil
	})
905

906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
	return
}

func (conf *Configuration) checkIdentifiers(session SessionRequest) (*IrmaIdentifierSet, error) {
	missing := newIrmaIdentifierSet()
	conf.checkSchemes(session, missing)
	if err := conf.checkIssuers(session.Identifiers(), missing); err != nil {
		return nil, err
	}
	conf.checkCredentialTypes(session, missing)
	return missing, nil
}

// CheckSchemes verifies that all schemes occuring in the specified session request occur in this
// instance.
func (conf *Configuration) checkSchemes(session SessionRequest, missing *IrmaIdentifierSet) {
	for id := range session.Identifiers().SchemeManagers {
		scheme, contains := conf.SchemeManagers[id]
		if !contains || !scheme.Valid {
			missing.SchemeManagers[id] = struct{}{}
		}
	}
928
929
}

930
func (conf *Configuration) checkIssuers(set *IrmaIdentifierSet, missing *IrmaIdentifierSet) error {
931
	for issid := range set.Issuers {
932
		if _, contains := conf.Issuers[issid]; !contains {
933
			missing.Issuers[issid] = struct{}{}
934
		}
Sietse Ringers's avatar
Sietse Ringers committed
935
	}
936
937
938
	for issid, keyids := range set.PublicKeys {
		for _, keyid := range keyids {
			pk, err := conf.PublicKey(issid, keyid)
Sietse Ringers's avatar
Sietse Ringers committed
939
			if err != nil {
940
				return err
Sietse Ringers's avatar
Sietse Ringers committed
941
942
			}
			if pk == nil {
943
				missing.PublicKeys[issid] = append(missing.PublicKeys[issid], keyid)
944
945
946
			}
		}
	}
947
	return nil
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
}

func (i SchemeManagerIndex) String() string {
	var paths []string
	var b bytes.Buffer

	for path := range i {
		paths = append(paths, path)
	}
	sort.Strings(paths)

	for _, path := range paths {
		b.WriteString(hex.EncodeToString(i[path]))
		b.WriteString(" ")
		b.WriteString(path)
		b.WriteString("\n")
	}

	return b.String()
}

Sietse Ringers's avatar
Sietse Ringers committed
969
// FromString populates this index by parsing the specified string.
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
func (i SchemeManagerIndex) FromString(s string) error {
	for j, line := range strings.Split(s, "\n") {
		if len(line) == 0 {
			continue
		}
		parts := strings.Split(line, " ")
		if len(parts) != 2 {
			return errors.Errorf("Scheme manager index line %d has incorrect amount of parts", j)
		}
		hash, err := hex.DecodeString(parts[0])
		if err != nil {
			return err
		}
		i[parts[1]] = hash
	}

	return nil
}

989
990
991
992
993
994
995
func (i SchemeManagerIndex) Scheme() SchemeManagerIdentifier {
	for p := range i {
		return NewSchemeManagerIdentifier(p[0:strings.Index(p, "/")])
	}
	return NewSchemeManagerIdentifier("")
}

996
// parseIndex parses the index file of the specified manager.
997
func (conf *Configuration) parseIndex(name string, manager *SchemeManager) (SchemeManagerIndex, error) {
Sietse Ringers's avatar
Sietse Ringers committed
998
	path := filepath.Join(conf.Path, name, "index")
Sietse Ringers's avatar
Sietse Ringers committed
999
	if err := fs.AssertPathExists(path); err != nil {
1000
		return nil, fmt.Errorf("Missing scheme manager index file; tried %s", path)
1001
	}
Sietse Ringers's avatar
Sietse Ringers committed
1002
	indexbts, err := ioutil.ReadFile(path)
1003
	if err != nil {
1004
		return nil, err
1005
	}
1006
	index := SchemeManagerIndex(make(map[string]ConfigurationFileHash))
1007
1008
1009
1010
1011
1012
1013
1014
1015
	if err = index.FromString(string(indexbts)); err != nil {
		return nil, err
	}

	return index, conf.checkUnsignedFiles(name, index)
}

func (conf *Configuration) checkUnsignedFiles(name string, index SchemeManagerIndex) error {
	return filepath.Walk(filepath.Join(conf.Path, name), func(path string, info os.FileInfo, err error) error {
1016
		relpath, err := filepath.Rel(conf.Path, path)
1017
1018
1019
1020
		if err != nil {
			return err
		}
		for _, ex := range sigExceptions {
1021
			if ex.MatchString(filepath.ToSlash(relpath)) {
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
				return nil
			}
		}

		if info.IsDir() {
			if !dirInScheme(index, relpath) {
				conf.Warnings = append(conf.Warnings, "Ignored dir: "+relpath)
			}
		} else {
			if _, ok := index[relpath]; !ok {
				conf.Warnings = append(conf.Warnings, "Ignored file: "+relpath)
			}
		}

		return nil
	})
}

func dirInScheme(index SchemeManagerIndex, dir string) bool {
	for indexpath := range index {
		if strings.HasPrefix(indexpath, dir) {
			return true
		}
	}
	return false
}

// These files never occur in a scheme's index
var sigExceptions = []*regexp.Regexp{
	regexp.MustCompile(`/.git(/.*)?`),
	regexp.MustCompile(`^.*?/pk\.pem$`),
	regexp.MustCompile(`^.*?/sk\.pem$`),
	regexp.MustCompile(`^.*?/index`),
	regexp.MustCompile(`^.*?/index\.sig`),
	regexp.MustCompile(`^.*?/AUTHORS$`),
	regexp.MustCompile(`^.*?/LICENSE$`),
	regexp.MustCompile(`^.*?/README\.md$`),
	regexp.MustCompile(`^.*?/.*?/PrivateKeys$`),
	regexp.MustCompile(`^.*?/.*?/PrivateKeys/\d+.xml$`),
	regexp.MustCompile(`\.DS_Store$`),
1062
1063
}

1064
func (conf *Configuration) VerifySchemeManager(manager *SchemeManager) error {
1065
	err := conf.VerifySignature(manager.Identifier())
1066
1067
1068
1069
	if err != nil {
		return err
	}

1070
	var exists bool
1071
	for file := range manager.index {
1072
		exists, err = fs.PathExists(filepath.Join(conf.Path, file))
1073
1074
1075
1076
1077
1078
		if err != nil {
			return err
		}
		if !exists {
			continue
		}
1079
		// Don't care about the actual bytes
1080
		if _, _, err = conf.ReadAuthenticatedFile(manager, file); err != nil {
1081
1082
1083
1084
1085
1086
1087
			return err
		}
	}

	return nil
}

1088
1089
1090
// ReadAuthenticatedFile reads the file at the specified path
// and verifies its authenticity by checking that the file hash
// is present in the (signed) scheme manager index file.
1091
func (conf *Configuration) ReadAuthenticatedFile(manager *SchemeManager, path string) ([]byte, bool, error) {
1092
	signedHash, ok := manager.index[filepath.ToSlash(path)]
1093
	if !ok {
1094
		return nil, false, nil
1095
1096
	}