irmaconfig.go 43 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
67
}

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

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

76
77
type SchemeManagerStatus string

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

84
85
86
87
88
89
90
const (
	SchemeManagerStatusValid               = SchemeManagerStatus("Valid")
	SchemeManagerStatusUnprocessed         = SchemeManagerStatus("Unprocessed")
	SchemeManagerStatusInvalidIndex        = SchemeManagerStatus("InvalidIndex")
	SchemeManagerStatusInvalidSignature    = SchemeManagerStatus("InvalidSignature")
	SchemeManagerStatusParsingError        = SchemeManagerStatus("ParsingError")
	SchemeManagerStatusContentParsingError = SchemeManagerStatus("ContentParsingError")
91

92
93
	pubkeyPattern  = "%s/%s/%s/PublicKeys/*.xml"
	privkeyPattern = "%s/%s/%s/PrivateKeys/*.xml"
94
95
)

96
97
98
99
func (sme SchemeManagerError) Error() string {
	return fmt.Sprintf("Error parsing scheme manager %s: %s", sme.Manager.Name(), sme.Err.Error())
}

100
// NewConfiguration returns a new configuration. After this
101
// ParseFolder() should be called to parse the specified path.
102
103
104
105
func NewConfiguration(path string) (*Configuration, error) {
	return newConfiguration(path, "")
}

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

117
118
// NewConfigurationFromAssets returns a new configuration, copying the schemes out of the assets folder to path.
// ParseFolder() should be called to parse the specified path.
119
120
121
122
123
func NewConfigurationFromAssets(path, assets string) (*Configuration, error) {
	return newConfiguration(path, assets)
}

func newConfiguration(path string, assets string) (conf *Configuration, err error) {
124
	conf = &Configuration{
Sietse Ringers's avatar
Sietse Ringers committed
125
		Path:   path,
126
		assets: assets,
127
	}
128

129
130
131
132
	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)
		}
133
	}
134
	if err = fs.EnsureDirectoryExists(conf.Path); err != nil {
135
136
		return nil, err
	}
137

138
139
140
	// Init all maps
	conf.clear()

141
142
143
	return
}

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

// 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()
161

162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
	// 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
181
	var mgrerr *SchemeManagerError
Sietse Ringers's avatar
Sietse Ringers committed
182
	err = iterateSubfolders(conf.Path, func(dir string) error {
183
184
		manager := NewSchemeManager(filepath.Base(dir))
		err := conf.ParseSchemeManagerFolder(dir, manager)
185
186
		if err == nil {
			return nil // OK, do next scheme manager folder
187
		}
188
189
190
191
		// 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 {
192
			conf.DisabledSchemeManagers[manager.Identifier()] = mgrerr
193
			return nil
194
		}
195
		return err // Not a SchemeManagerError? return it & halt parsing now
196
197
	})
	if err != nil {
198
		return
199
	}
200
	conf.initialized = true
201
202
203
	if mgrerr != nil {
		return mgrerr
	}
204
	return
205
206
}

207
208
209
210
211
212
213
// 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.
214
215
func (conf *Configuration) ParseOrRestoreFolder() error {
	err := conf.ParseFolder()
216
217
218
	// Only in case of a *SchemeManagerError might we be able to recover
	if _, isSchemeMgrErr := err.(*SchemeManagerError); !isSchemeMgrErr {
		return err
219
	}
220
221
222
	if err != nil && (conf.assets == "" || conf.readOnly) {
		return err
	}
223
224

	for id := range conf.DisabledSchemeManagers {
225
226
227
228
229
230
231
232
233
		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)
234
		}
235
	}
236

237
238
239
	return err
}

240
// ParseSchemeManagerFolder parses the entire tree of the specified scheme manager
241
// If err != nil then a problem occured
242
func (conf *Configuration) ParseSchemeManagerFolder(dir string, manager *SchemeManager) (err error) {
243
244
245
246
247
248
249
	// 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
250
251
	defer func() {
		if err != nil {
252
253
254
255
256
			err = &SchemeManagerError{
				Manager: manager.Identifier(),
				Err:     err,
				Status:  manager.Status,
			}
257
258
259
		}
	}()

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

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

288
	// Read timestamp indicating time of last modification
289
290
291
	ts, exists, err := readTimestamp(dir + "/timestamp")
	if err != nil || !exists {
		return errors.WrapPrefix(err, "Could not read scheme manager timestamp", 0)
292
	}
293
	manager.Timestamp = *ts
294

295
	// Parse contained issuers and credential types
296
	err = conf.parseIssuerFolders(manager, dir)
297
298
299
300
301
302
	if err != nil {
		manager.Status = SchemeManagerStatusContentParsingError
		return
	}
	manager.Status = SchemeManagerStatusValid
	manager.Valid = true
303
304
305
	return
}

306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
// relativePath returns, given a outer path that contains the inner path,
// the relative path between outer an inner, which is such that
// outer/returnvalue refers to inner.
func relativePath(outer string, inner string) (string, error) {
	// Take Abs() of both paths to ensure that we don't fail on e.g.
	// outer = "./foo" and inner = "foo/bar"
	outerAbs, err := filepath.Abs(outer)
	if err != nil {
		return "", err
	}
	innerAbs, err := filepath.Abs(inner)
	if err != nil {
		return "", err
	}
	if !strings.HasPrefix(innerAbs, outerAbs) {
		return "", errors.New("inner path is not contained in outer path")
	}

	return innerAbs[len(outerAbs)+1:], nil
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
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
// 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
}

370
371
// 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) {
372
373
374
375
376
377
378
379
380
381
382
	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 {
383
			return nil, err
384
385
		}
	}
386
	return conf.publicKeys[id][counter], nil
387
388
}

389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
// 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.
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
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
}

428
func (conf *Configuration) addReverseHash(credid CredentialTypeIdentifier) {
429
	hash := sha256.Sum256([]byte(credid.String()))
430
	conf.reverseHashes[base64.StdEncoding.EncodeToString(hash[:16])] = credid
431
432
}

433
434
435
func (conf *Configuration) hashToCredentialType(hash []byte) *CredentialType {
	if str, exists := conf.reverseHashes[base64.StdEncoding.EncodeToString(hash)]; exists {
		return conf.CredentialTypes[str]
436
437
438
439
	}
	return nil
}

440
// IsInitialized indicates whether this instance has successfully been initialized.
441
442
func (conf *Configuration) IsInitialized() bool {
	return conf.initialized
443
444
}

445
446
447
448
449
450
451
452
453
// 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
		}
	}
}

454
func (conf *Configuration) parseIssuerFolders(manager *SchemeManager, path string) error {
455
456
	return iterateSubfolders(path, func(dir string) error {
		issuer := &Issuer{}
457
		exists, err := conf.pathToDescription(manager, dir+"/description.xml", issuer)
458
459
460
		if err != nil {
			return err
		}
461
462
		if !exists {
			return nil
463
		}
464
465
466
		if issuer.XMLVersion < 4 {
			return errors.New("Unsupported issuer description")
		}
467

468
		if err = conf.checkIssuer(manager, issuer, dir); err != nil {
469
470
471
			return err
		}

472
		conf.Issuers[issuer.Identifier()] = issuer
473
		issuer.Valid = conf.SchemeManagers[issuer.SchemeManagerIdentifier()].Valid
474
		return conf.parseCredentialsFolder(manager, issuer, dir+"/Issues/")
475
476
477
	})
}

478
479
480
func (conf *Configuration) DeleteSchemeManager(id SchemeManagerIdentifier) error {
	delete(conf.SchemeManagers, id)
	delete(conf.DisabledSchemeManagers, id)
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
	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)
		}
	}
497
498
499
500
	if !conf.readOnly {
		return os.RemoveAll(filepath.Join(conf.Path, id.Name()))
	}
	return nil
501
502
}

503
// parse $schememanager/$issuer/PublicKeys/$i.xml for $i = 1, ...
504
505
func (conf *Configuration) parseKeysFolder(issuerid IssuerIdentifier) error {
	manager := conf.SchemeManagers[issuerid.SchemeManagerIdentifier()]
506
	conf.publicKeys[issuerid] = map[int]*gabi.PublicKey{}
507
	path := fmt.Sprintf(pubkeyPattern, conf.Path, issuerid.SchemeManagerIdentifier().Name(), issuerid.Name())
508
509
510
511
512
513
514
515
516
517
	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 {
518
			return err
519
		}
520
521
522
523
524
		relativepath, err := relativePath(conf.Path, file)
		if err != nil {
			return err
		}
		bts, found, err := conf.ReadAuthenticatedFile(manager, relativepath)
525
		if err != nil || !found {
526
527
528
			return err
		}
		pk, err := gabi.NewPublicKeyFromBytes(bts)
529
530
531
		if err != nil {
			return err
		}
532
533
534
		if int(pk.Counter) != i {
			return errors.Errorf("Public key %s of issuer %s has wrong <Counter>", file, issuerid.String())
		}
535
		pk.Issuer = issuerid.String()
536
		conf.publicKeys[issuerid][i] = pk
537
	}
538

539
540
541
	return nil
}

542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
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
}

564
// parse $schememanager/$issuer/Issues/*/description.xml
565
566
567
func (conf *Configuration) parseCredentialsFolder(manager *SchemeManager, issuer *Issuer, path string) error {
	var foundcred bool
	err := iterateSubfolders(path, func(dir string) error {
568
		cred := &CredentialType{}
569
		exists, err := conf.pathToDescription(manager, dir+"/description.xml", cred)
570
571
572
		if err != nil {
			return err
		}
573
574
575
		if !exists {
			return nil
		}
576
		if err = conf.checkCredentialType(manager, issuer, cred, dir); err != nil {
577
578
579
580
			return err
		}
		foundcred = true
		cred.Valid = conf.SchemeManagers[cred.SchemeManagerIdentifier()].Valid
581
		credid := cred.Identifier()
582
583
		conf.CredentialTypes[credid] = cred
		conf.addReverseHash(credid)
584
		for index, attr := range cred.AttributeTypes {
585
586
587
588
			attr.Index = index
			attr.SchemeManagerID = cred.SchemeManagerID
			attr.IssuerID = cred.IssuerID
			attr.CredentialTypeID = cred.ID
589
			conf.AttributeTypes[attr.GetAttributeTypeIdentifier()] = attr
590
		}
591
592
		return nil
	})
593
594
595
596
597
598
	if !foundcred {
		conf.Warnings = append(conf.Warnings, fmt.Sprintf("Issuer %s has no credential types", issuer.Identifier().String()))
	}
	return err
}

599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
// 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
		}
616
617
618
		if strings.HasSuffix(dir, "/.git") {
			continue
		}
619
620
621
622
623
624
625
626
627
		err = handler(dir)
		if err != nil {
			return err
		}
	}

	return nil
}

628
func (conf *Configuration) pathToDescription(manager *SchemeManager, path string, description interface{}) (bool, error) {
629
630
631
632
	if _, err := os.Stat(path); err != nil {
		return false, nil
	}

633
634
635
636
637
	relativepath, err := relativePath(conf.Path, path)
	if err != nil {
		return false, err
	}
	bts, found, err := conf.ReadAuthenticatedFile(manager, relativepath)
638
639
640
	if !found {
		return false, nil
	}
641
642
643
644
	if err != nil {
		return true, err
	}

645
	err = xml.Unmarshal(bts, description)
646
647
648
649
650
651
	if err != nil {
		return true, err
	}

	return true, nil
}
652

653
654
655
656
657
// Contains checks if the configuration contains the specified credential type.
func (conf *Configuration) Contains(cred CredentialTypeIdentifier) bool {
	return conf.SchemeManagers[cred.IssuerIdentifier().SchemeManagerIdentifier()] != nil &&
		conf.Issuers[cred.IssuerIdentifier()] != nil &&
		conf.CredentialTypes[cred] != nil
658
}
659

660
func (conf *Configuration) isUpToDate(scheme SchemeManagerIdentifier) (bool, error) {
661
	if conf.assets == "" || conf.readOnly {
662
663
		return true, nil
	}
664
665
666
667
	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)
668
	}
669
670
671
672
	// 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
673
	}
674
	return exists && !newTime.After(*oldTime), nil
675
676
}

677
func (conf *Configuration) CopyManagerFromAssets(scheme SchemeManagerIdentifier) (bool, error) {
678
	if conf.assets == "" || conf.readOnly {
679
		return false, nil
680
	}
681
682
683
684
685
	// 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
686
	}
687
688
689
	return true, fs.CopyDirectory(
		filepath.Join(conf.assets, name),
		filepath.Join(conf.Path, name),
690
691
692
	)
}

693
694
// DownloadSchemeManager downloads and returns a scheme manager description.xml file
// from the specified URL.
695
func DownloadSchemeManager(url string) (*SchemeManager, error) {
696
697
698
699
700
701
702
703
704
	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")]
	}
705
	b, err := NewHTTPTransport(url).GetBytes("description.xml")
706
707
708
	if err != nil {
		return nil, err
	}
709
	manager := NewSchemeManager("")
710
711
712
713
714
715
716
717
	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
718
719
// RemoveSchemeManager removes the specified scheme manager and all associated issuers,
// public keys and credential types from this Configuration.
720
func (conf *Configuration) RemoveSchemeManager(id SchemeManagerIdentifier, fromStorage bool) error {
721
	// Remove everything falling under the manager's responsibility
722
	for credid := range conf.CredentialTypes {
723
		if credid.IssuerIdentifier().SchemeManagerIdentifier() == id {
724
			delete(conf.CredentialTypes, credid)
725
726
		}
	}
727
	for issid := range conf.Issuers {
728
		if issid.SchemeManagerIdentifier() == id {
729
			delete(conf.Issuers, issid)
730
731
		}
	}
732
	for issid := range conf.publicKeys {
733
		if issid.SchemeManagerIdentifier() == id {
734
			delete(conf.publicKeys, issid)
735
736
		}
	}
737
	delete(conf.SchemeManagers, id)
738

739
	if fromStorage || !conf.readOnly {
Sietse Ringers's avatar
Sietse Ringers committed
740
		return os.RemoveAll(fmt.Sprintf("%s/%s", conf.Path, id.String()))
741
742
	}
	return nil
743
744
}

745
func (conf *Configuration) ReinstallSchemeManager(manager *SchemeManager) (err error) {
746
747
748
749
	if conf.readOnly {
		return errors.New("cannot install scheme into a read-only configuration")
	}

750
751
752
753
754
755
756
757
758
	// 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
	}
759
	err = conf.InstallSchemeManager(manager, nil)
760
761
762
	return
}

763
// InstallSchemeManager downloads and adds the specified scheme manager to this Configuration,
Sietse Ringers's avatar
Sietse Ringers committed
764
// provided its signature is valid.
765
func (conf *Configuration) InstallSchemeManager(manager *SchemeManager, publickey []byte) error {
766
767
768
769
	if conf.readOnly {
		return errors.New("cannot install scheme into a read-only configuration")
	}

770
	name := manager.ID
771
	if err := fs.EnsureDirectoryExists(filepath.Join(conf.Path, name)); err != nil {
772
773
		return err
	}
774
775

	t := NewHTTPTransport(manager.URL)
Sietse Ringers's avatar
Sietse Ringers committed
776
	path := fmt.Sprintf("%s/%s", conf.Path, name)
777
778
779
	if err := t.GetFile("description.xml", path+"/description.xml"); err != nil {
		return err
	}
780
781
782
783
784
785
786
787
	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
		}
788
	}
789
	if err := conf.DownloadSchemeManagerSignature(manager); err != nil {
790
791
		return err
	}
792
793
794
795
	conf.SchemeManagers[manager.Identifier()] = manager
	if err := conf.UpdateSchemeManager(manager.Identifier(), nil); err != nil {
		return err
	}
796

797
	return conf.ParseSchemeManagerFolder(filepath.Join(conf.Path, name), manager)
798
799
800
801
802
}

// 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) {
803
804
805
806
	if conf.readOnly {
		return errors.New("cannot download into a read-only configuration")
	}

807
	t := NewHTTPTransport(manager.URL)
Sietse Ringers's avatar
Sietse Ringers committed
808
	path := fmt.Sprintf("%s/%s", conf.Path, manager.ID)
809
810
811
812
	index := filepath.Join(path, "index")
	sig := filepath.Join(path, "index.sig")

	if err = t.GetFile("index", index); err != nil {
813
		return
814
815
	}
	if err = t.GetFile("index.sig", sig); err != nil {
816
		return
817
	}
818
	err = conf.VerifySignature(manager.Identifier())
819
	return
820
}
821

Sietse Ringers's avatar
Sietse Ringers committed
822
823
824
// 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.
825
func (conf *Configuration) Download(session SessionRequest) (downloaded *IrmaIdentifierSet, err error) {
826
827
828
	if conf.readOnly {
		return nil, errors.New("cannot download into a read-only configuration")
	}
829
	managers := make(map[string]struct{}) // Managers that we must update
830
	downloaded = &IrmaIdentifierSet{
831
832
833
834
		SchemeManagers:  map[SchemeManagerIdentifier]struct{}{},
		Issuers:         map[IssuerIdentifier]struct{}{},
		CredentialTypes: map[CredentialTypeIdentifier]struct{}{},
	}
835

836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
	// Calculate which scheme managers must be updated
	if err = conf.checkIssuers(session.Identifiers(), managers); err != nil {
		return
	}
	if err = conf.checkCredentialTypes(session, managers); err != nil {
		return
	}

	// Update the scheme managers found above and parse them, if necessary
	for id := range managers {
		if err = conf.UpdateSchemeManager(NewSchemeManagerIdentifier(id), downloaded); err != nil {
			return
		}
	}
	if !downloaded.Empty() {
		return downloaded, conf.ParseFolder()
	}
	return
}

856
func (conf *Configuration) checkCredentialTypes(session SessionRequest, managers map[string]struct{}) error {
857
858
859
860
861
862
863
864
	var disjunctions AttributeDisjunctionList
	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
865
			typ, contains = conf.CredentialTypes[credreq.CredentialTypeID]
866
867
868
869
870
871
872
873
874
875
			if !contains {
				managers[credreq.CredentialTypeID.Root()] = struct{}{}
				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
876
			for _, attrtyp := range typ.AttributeTypes {
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
				_, contains = newAttrs[attrtyp.ID]
				if !contains && !attrtyp.IsOptional() {
					managers[credreq.CredentialTypeID.Root()] = struct{}{}
					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 {
				managers[credreq.CredentialTypeID.Root()] = struct{}{}
			}
		}
		disjunctions = s.Disclose
	case *DisclosureRequest:
		disjunctions = s.Content
	case *SignatureRequest:
		disjunctions = s.Content
	}

	for _, disjunction := range disjunctions {
		for _, attrid := range disjunction.Attributes {
			credid := attrid.CredentialTypeIdentifier()
			if typ, contains = conf.CredentialTypes[credid]; !contains {
				managers[credid.Root()] = struct{}{}
901
				continue
902
			}
Sietse Ringers's avatar
Sietse Ringers committed
903
			if !attrid.IsCredential() && !typ.ContainsAttribute(attrid) {
904
905
906
907
908
909
910
911
912
				managers[credid.Root()] = struct{}{}
			}
		}
	}

	return nil
}

func (conf *Configuration) checkIssuers(set *IrmaIdentifierSet, managers map[string]struct{}) error {
913
	for issid := range set.Issuers {
914
		if _, contains := conf.Issuers[issid]; !contains {
915
			managers[issid.Root()] = struct{}{}
916
		}
Sietse Ringers's avatar
Sietse Ringers committed
917
	}
918
919
920
	for issid, keyids := range set.PublicKeys {
		for _, keyid := range keyids {
			pk, err := conf.PublicKey(issid, keyid)
Sietse Ringers's avatar
Sietse Ringers committed
921
			if err != nil {
922
				return err
Sietse Ringers's avatar
Sietse Ringers committed
923
924
			}
			if pk == nil {
925
				managers[issid.Root()] = struct{}{}
926
927
928
			}
		}
	}
929
	return nil
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
}

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
951
// FromString populates this index by parsing the specified string.
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
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
}

971
// parseIndex parses the index file of the specified manager.
972
func (conf *Configuration) parseIndex(name string, manager *SchemeManager) (SchemeManagerIndex, error) {
Sietse Ringers's avatar
Sietse Ringers committed
973
	path := filepath.Join(conf.Path, name, "index")
Sietse Ringers's avatar
Sietse Ringers committed
974
	if err := fs.AssertPathExists(path); err != nil {
975
		return nil, fmt.Errorf("Missing scheme manager index file; tried %s", path)
976
	}
Sietse Ringers's avatar
Sietse Ringers committed
977
	indexbts, err := ioutil.ReadFile(path)
978
	if err != nil {
979
		return nil, err
980
	}
981
982
	index := SchemeManagerIndex(make(map[string]ConfigurationFileHash))
	return index, index.FromString(string(indexbts))
983
984
}

985
func (conf *Configuration) VerifySchemeManager(manager *SchemeManager) error {
986
	err := conf.VerifySignature(manager.Identifier())
987
988
989
990
	if err != nil {
		return err
	}

991
	var exists bool
992
	for file := range manager.index {
993
		exists, err = fs.PathExists(filepath.Join(conf.Path, file))
994
995
996
997
998
999
		if err != nil {
			return err
		}
		if !exists {
			continue
		}
1000
		// Don't care about the actual bytes
1001
		if _, _, err = conf.ReadAuthenticatedFile(manager, file); err != nil {
1002
1003
1004
1005
1006
1007
1008
			return err
		}
	}

	return nil
}

1009
1010
1011
// 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.
1012
func (conf *Configuration) ReadAuthenticatedFile(manager *SchemeManager, path string) ([]byte, bool, error) {
1013
	signedHash, ok := manager.index[filepath.ToSlash(path)]
1014
	if !ok {
1015
		return nil, false, nil
1016
1017
	}

Sietse Ringers's avatar
Sietse Ringers committed
1018
	bts, err := ioutil.ReadFile(filepath.Join(conf.Path, path))
1019
	if err != nil {
1020
		return nil, true, err
1021
1022
1023
1024
	}
	computedHash := sha256.Sum256(bts)

	if !bytes.Equal(computedHash[:], signedHash) {
1025
		return nil, true, errors.Errorf("Hash of %s does not match scheme manager index", path)
1026
	}
1027
	return bts, true, nil
1028
1029
1030
1031
1032
}

// VerifySignature verifies the signature on the scheme manager index file
// (which contains the SHA256 hashes of all files under this scheme manager,
// which are used for verifying file authenticity).
1033
func (conf *Configuration) VerifySignature(id SchemeManagerIdentifier) (err error) {
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
	defer func() {
		if r := recover(); r != nil {
			if e, ok := r.(error); ok {
				err = errors.Errorf("Scheme manager index signature failed to verify: %s", e.Error())
			} else {
				err = errors.New("Scheme manager index signature failed to verify")
			}
		}
	}()

Sietse Ringers's avatar
Sietse Ringers committed
1044
	dir := filepath.Join(conf.Path, id.String())
1045
	if err := fs.AssertPathExists(dir+"/index", dir+"/index.sig", dir+"/pk.pem"); err != nil {
1046
		return errors.New("Missing scheme manager index file, signature, or public key")
1047
1048
1049
1050
1051
	}

	// Read and hash index file
	indexbts, err := ioutil.ReadFile(dir + "/index")
	if err != nil {
1052
		return err
1053
1054
1055
1056
1057
1058
	}
	indexhash := sha256.Sum256(indexbts)

	// Read and parse scheme manager public key
	pkbts, err := ioutil.ReadFile(dir + "/pk.pem")
	if err != nil {
1059
		return err
1060
	}
1061
	pk, err := ParsePemEcdsaPublicKey(pkbts)
1062
	if err != nil {
1063
		return err
1064
1065
1066
1067
1068
	}

	// Read and parse signature
	sig, err := ioutil.ReadFile(dir + "/index.sig")
	if err != nil {
1069
		return err
1070
	}
1071
	ints := make([]*gobig.Int, 0, 2)
1072
1073
1074
	_, err = asn1.Unmarshal(sig, &ints)

	// Verify signature
1075
1076
1077
1078
	if !ecdsa.Verify(pk, indexhash[:], ints[0], ints[1]) {
		return errors.New("Scheme manager signature was invalid")
	}
	return nil
1079
}
1080

1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091