irmaconfig.go 37.4 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/go-errors/errors"
34
	"github.com/mhe/gabi"
35
	"github.com/mhe/gabi/big"
36
	"github.com/privacybydesign/irmago/internal/fs"
37
38
)

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

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

50
51
52
	// 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
53

54
55
	Warnings []string

56
	kssPublicKeys map[SchemeManagerIdentifier]map[int]*rsa.PublicKey
57
	publicKeys    map[IssuerIdentifier]map[int]*gabi.PublicKey
58
	reverseHashes map[string]CredentialTypeIdentifier
59
	initialized   bool
60
	assets        string
61
62
}

Sietse Ringers's avatar
Sietse Ringers committed
63
64
// ConfigurationFileHash encodes the SHA256 hash of an authenticated
// file under a scheme manager within the configuration folder.
65
66
type ConfigurationFileHash []byte

Sietse Ringers's avatar
Sietse Ringers committed
67
68
// SchemeManagerIndex is a (signed) list of files under a scheme manager
// along with their SHA266 hash
69
70
type SchemeManagerIndex map[string]ConfigurationFileHash

71
72
type SchemeManagerStatus string

73
74
type SchemeManagerError struct {
	Manager SchemeManagerIdentifier
75
	Status  SchemeManagerStatus
76
77
78
	Err     error
}

79
80
81
82
83
84
85
const (
	SchemeManagerStatusValid               = SchemeManagerStatus("Valid")
	SchemeManagerStatusUnprocessed         = SchemeManagerStatus("Unprocessed")
	SchemeManagerStatusInvalidIndex        = SchemeManagerStatus("InvalidIndex")
	SchemeManagerStatusInvalidSignature    = SchemeManagerStatus("InvalidSignature")
	SchemeManagerStatusParsingError        = SchemeManagerStatus("ParsingError")
	SchemeManagerStatusContentParsingError = SchemeManagerStatus("ContentParsingError")
86

87
88
	pubkeyPattern  = "%s/%s/%s/PublicKeys/*.xml"
	privkeyPattern = "%s/%s/%s/PrivateKeys/*.xml"
89
90
)

91
92
93
94
func (sme SchemeManagerError) Error() string {
	return fmt.Sprintf("Error parsing scheme manager %s: %s", sme.Manager.Name(), sme.Err.Error())
}

95
// NewConfiguration returns a new configuration. After this
96
// ParseFolder() should be called to parse the specified path.
97
98
func NewConfiguration(path string, assets string) (conf *Configuration, err error) {
	conf = &Configuration{
Sietse Ringers's avatar
Sietse Ringers committed
99
		Path:   path,
100
		assets: assets,
101
	}
102

103
104
105
106
	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)
		}
107
	}
108
	if err = fs.EnsureDirectoryExists(conf.Path); err != nil {
109
110
		return nil, err
	}
111

112
113
114
	// Init all maps
	conf.clear()

115
116
117
	return
}

118
func (conf *Configuration) clear() {
119
120
121
	conf.SchemeManagers = make(map[SchemeManagerIdentifier]*SchemeManager)
	conf.Issuers = make(map[IssuerIdentifier]*Issuer)
	conf.CredentialTypes = make(map[CredentialTypeIdentifier]*CredentialType)
122
	conf.AttributeTypes = make(map[AttributeTypeIdentifier]*AttributeType)
123
	conf.DisabledSchemeManagers = make(map[SchemeManagerIdentifier]*SchemeManagerError)
124
	conf.kssPublicKeys = make(map[SchemeManagerIdentifier]map[int]*rsa.PublicKey)
125
	conf.publicKeys = make(map[IssuerIdentifier]map[int]*gabi.PublicKey)
126
	conf.reverseHashes = make(map[string]CredentialTypeIdentifier)
127
128
129
130
131
132
133
}

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

135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
	// 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
154
	var mgrerr *SchemeManagerError
Sietse Ringers's avatar
Sietse Ringers committed
155
	err = iterateSubfolders(conf.Path, func(dir string) error {
156
157
		manager := NewSchemeManager(filepath.Base(dir))
		err := conf.ParseSchemeManagerFolder(dir, manager)
158
159
		if err == nil {
			return nil // OK, do next scheme manager folder
160
		}
161
162
163
164
		// 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 {
165
			conf.DisabledSchemeManagers[manager.Identifier()] = mgrerr
166
			return nil
167
		}
168
		return err // Not a SchemeManagerError? return it & halt parsing now
169
170
	})
	if err != nil {
171
		return
172
	}
173
	conf.initialized = true
174
175
176
	if mgrerr != nil {
		return mgrerr
	}
177
	return
178
179
}

180
181
182
183
184
185
186
// 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.
187
188
func (conf *Configuration) ParseOrRestoreFolder() error {
	err := conf.ParseFolder()
189
190
191
	// Only in case of a *SchemeManagerError might we be able to recover
	if _, isSchemeMgrErr := err.(*SchemeManagerError); !isSchemeMgrErr {
		return err
192
	}
193
194

	for id := range conf.DisabledSchemeManagers {
195
196
197
198
199
200
201
202
203
		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)
204
		}
205
	}
206

207
208
209
	return err
}

210
// ParseSchemeManagerFolder parses the entire tree of the specified scheme manager
211
// If err != nil then a problem occured
212
func (conf *Configuration) ParseSchemeManagerFolder(dir string, manager *SchemeManager) (err error) {
213
214
215
216
217
218
219
	// 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
220
221
	defer func() {
		if err != nil {
222
223
224
225
226
			err = &SchemeManagerError{
				Manager: manager.Identifier(),
				Err:     err,
				Status:  manager.Status,
			}
227
228
229
		}
	}()

230
231
	// Verify signature and read scheme manager description
	if err = conf.VerifySignature(manager.Identifier()); err != nil {
232
233
		return
	}
234
	if manager.index, err = conf.parseIndex(filepath.Base(dir), manager); err != nil {
235
236
		manager.Status = SchemeManagerStatusInvalidIndex
		return
237
	}
238
239
240
241
242
	exists, err := conf.pathToDescription(manager, dir+"/description.xml", manager)
	if !exists {
		manager.Status = SchemeManagerStatusParsingError
		return errors.New("Scheme manager description not found")
	}
243
244
245
	if err != nil {
		manager.Status = SchemeManagerStatusParsingError
		return
246
	}
247
248
	if err = conf.checkScheme(manager, dir); err != nil {
		return
249
	}
250
251
252
253
254
255
256

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

258
	// Read timestamp indicating time of last modification
259
260
261
	ts, exists, err := readTimestamp(dir + "/timestamp")
	if err != nil || !exists {
		return errors.WrapPrefix(err, "Could not read scheme manager timestamp", 0)
262
	}
263
	manager.Timestamp = *ts
264

265
	// Parse contained issuers and credential types
266
	err = conf.parseIssuerFolders(manager, dir)
267
268
269
270
271
272
	if err != nil {
		manager.Status = SchemeManagerStatusContentParsingError
		return
	}
	manager.Status = SchemeManagerStatusValid
	manager.Valid = true
273
274
275
	return
}

276
277
278
279
func relativePath(absolute string, relative string) string {
	return relative[len(absolute)+1:]
}

280
281
282
// 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) {
	if _, contains := conf.publicKeys[id]; !contains {
283
		if err := conf.parseKeysFolder(conf.SchemeManagers[id.SchemeManagerIdentifier()], id); err != nil {
284
			return nil, err
285
286
		}
	}
287
	return conf.publicKeys[id][counter], nil
288
289
}

290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
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
}

313
func (conf *Configuration) addReverseHash(credid CredentialTypeIdentifier) {
314
	hash := sha256.Sum256([]byte(credid.String()))
315
	conf.reverseHashes[base64.StdEncoding.EncodeToString(hash[:16])] = credid
316
317
}

318
319
320
func (conf *Configuration) hashToCredentialType(hash []byte) *CredentialType {
	if str, exists := conf.reverseHashes[base64.StdEncoding.EncodeToString(hash)]; exists {
		return conf.CredentialTypes[str]
321
322
323
324
	}
	return nil
}

325
// IsInitialized indicates whether this instance has successfully been initialized.
326
327
func (conf *Configuration) IsInitialized() bool {
	return conf.initialized
328
329
}

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

339
func (conf *Configuration) parseIssuerFolders(manager *SchemeManager, path string) error {
340
341
	return iterateSubfolders(path, func(dir string) error {
		issuer := &Issuer{}
342
		exists, err := conf.pathToDescription(manager, dir+"/description.xml", issuer)
343
344
345
		if err != nil {
			return err
		}
346
347
		if !exists {
			return nil
348
		}
349
350
351
		if issuer.XMLVersion < 4 {
			return errors.New("Unsupported issuer description")
		}
352

353
		if err = conf.checkIssuer(manager, issuer, dir); err != nil {
354
355
356
			return err
		}

357
		conf.Issuers[issuer.Identifier()] = issuer
358
		issuer.Valid = conf.SchemeManagers[issuer.SchemeManagerIdentifier()].Valid
359
		return conf.parseCredentialsFolder(manager, issuer, dir+"/Issues/")
360
361
362
	})
}

363
364
365
func (conf *Configuration) DeleteSchemeManager(id SchemeManagerIdentifier) error {
	delete(conf.SchemeManagers, id)
	delete(conf.DisabledSchemeManagers, id)
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
	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)
		}
	}
382
383
384
	return os.RemoveAll(filepath.Join(conf.Path, id.Name()))
}

385
// parse $schememanager/$issuer/PublicKeys/$i.xml for $i = 1, ...
386
func (conf *Configuration) parseKeysFolder(manager *SchemeManager, issuerid IssuerIdentifier) error {
387
	conf.publicKeys[issuerid] = map[int]*gabi.PublicKey{}
388
	path := fmt.Sprintf(pubkeyPattern, conf.Path, issuerid.SchemeManagerIdentifier().Name(), issuerid.Name())
389
390
391
392
393
394
395
396
397
398
	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 {
399
			return err
400
		}
Sietse Ringers's avatar
Sietse Ringers committed
401
		bts, found, err := conf.ReadAuthenticatedFile(manager, relativePath(conf.Path, file))
402
		if err != nil || !found {
403
404
405
			return err
		}
		pk, err := gabi.NewPublicKeyFromBytes(bts)
406
407
408
		if err != nil {
			return err
		}
409
410
411
		if int(pk.Counter) != i {
			return errors.Errorf("Public key %s of issuer %s has wrong <Counter>", file, issuerid.String())
		}
412
		pk.Issuer = issuerid.String()
413
		conf.publicKeys[issuerid][i] = pk
414
	}
415

416
417
418
	return nil
}

419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
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
}

441
// parse $schememanager/$issuer/Issues/*/description.xml
442
443
444
func (conf *Configuration) parseCredentialsFolder(manager *SchemeManager, issuer *Issuer, path string) error {
	var foundcred bool
	err := iterateSubfolders(path, func(dir string) error {
445
		cred := &CredentialType{}
446
		exists, err := conf.pathToDescription(manager, dir+"/description.xml", cred)
447
448
449
		if err != nil {
			return err
		}
450
451
452
		if !exists {
			return nil
		}
453
		if err = conf.checkCredentialType(manager, issuer, cred, dir); err != nil {
454
455
456
457
			return err
		}
		foundcred = true
		cred.Valid = conf.SchemeManagers[cred.SchemeManagerIdentifier()].Valid
458
		credid := cred.Identifier()
459
460
		conf.CredentialTypes[credid] = cred
		conf.addReverseHash(credid)
461
		for index, attr := range cred.AttributeTypes {
462
463
464
465
			attr.Index = index
			attr.SchemeManagerID = cred.SchemeManagerID
			attr.IssuerID = cred.IssuerID
			attr.CredentialTypeID = cred.ID
466
			conf.AttributeTypes[attr.GetAttributeTypeIdentifier()] = attr
467
		}
468
469
		return nil
	})
470
471
472
473
474
475
	if !foundcred {
		conf.Warnings = append(conf.Warnings, fmt.Sprintf("Issuer %s has no credential types", issuer.Identifier().String()))
	}
	return err
}

476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
// 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
		}
493
494
495
		if strings.HasSuffix(dir, "/.git") {
			continue
		}
496
497
498
499
500
501
502
503
504
		err = handler(dir)
		if err != nil {
			return err
		}
	}

	return nil
}

505
func (conf *Configuration) pathToDescription(manager *SchemeManager, path string, description interface{}) (bool, error) {
506
507
508
509
	if _, err := os.Stat(path); err != nil {
		return false, nil
	}

Sietse Ringers's avatar
Sietse Ringers committed
510
	bts, found, err := conf.ReadAuthenticatedFile(manager, relativePath(conf.Path, path))
511
512
513
	if !found {
		return false, nil
	}
514
515
516
517
	if err != nil {
		return true, err
	}

518
	err = xml.Unmarshal(bts, description)
519
520
521
522
523
524
	if err != nil {
		return true, err
	}

	return true, nil
}
525

526
527
528
529
530
// 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
531
}
532

533
func (conf *Configuration) isUpToDate(scheme SchemeManagerIdentifier) (bool, error) {
534
535
536
	if conf.assets == "" {
		return true, nil
	}
537
538
539
540
	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)
541
	}
542
543
544
545
	// 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
546
	}
547
	return exists && !newTime.After(*oldTime), nil
548
549
}

550
func (conf *Configuration) CopyManagerFromAssets(scheme SchemeManagerIdentifier) (bool, error) {
551
	if conf.assets == "" {
552
		return false, nil
553
	}
554
555
556
557
558
	// 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
559
	}
560
561
562
	return true, fs.CopyDirectory(
		filepath.Join(conf.assets, name),
		filepath.Join(conf.Path, name),
563
564
565
	)
}

566
567
// DownloadSchemeManager downloads and returns a scheme manager description.xml file
// from the specified URL.
568
func DownloadSchemeManager(url string) (*SchemeManager, error) {
569
570
571
572
573
574
575
576
577
	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")]
	}
578
	b, err := NewHTTPTransport(url).GetBytes("description.xml")
579
580
581
	if err != nil {
		return nil, err
	}
582
	manager := NewSchemeManager("")
583
584
585
586
587
588
589
590
	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
591
592
// RemoveSchemeManager removes the specified scheme manager and all associated issuers,
// public keys and credential types from this Configuration.
593
func (conf *Configuration) RemoveSchemeManager(id SchemeManagerIdentifier, fromStorage bool) error {
594
	// Remove everything falling under the manager's responsibility
595
	for credid := range conf.CredentialTypes {
596
		if credid.IssuerIdentifier().SchemeManagerIdentifier() == id {
597
			delete(conf.CredentialTypes, credid)
598
599
		}
	}
600
	for issid := range conf.Issuers {
601
		if issid.SchemeManagerIdentifier() == id {
602
			delete(conf.Issuers, issid)
603
604
		}
	}
605
	for issid := range conf.publicKeys {
606
		if issid.SchemeManagerIdentifier() == id {
607
			delete(conf.publicKeys, issid)
608
609
		}
	}
610
	delete(conf.SchemeManagers, id)
611
612

	if fromStorage {
Sietse Ringers's avatar
Sietse Ringers committed
613
		return os.RemoveAll(fmt.Sprintf("%s/%s", conf.Path, id.String()))
614
615
	}
	return nil
616
617
}

618
619
620
621
622
623
624
625
626
627
628
629
630
631
func (conf *Configuration) ReinstallSchemeManager(manager *SchemeManager) (err error) {
	// 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
	}
	err = conf.InstallSchemeManager(manager)
	return
}

632
// InstallSchemeManager downloads and adds the specified scheme manager to this Configuration,
Sietse Ringers's avatar
Sietse Ringers committed
633
// provided its signature is valid.
634
func (conf *Configuration) InstallSchemeManager(manager *SchemeManager) error {
635
	name := manager.ID
636
	if err := fs.EnsureDirectoryExists(filepath.Join(conf.Path, name)); err != nil {
637
638
		return err
	}
639
640

	t := NewHTTPTransport(manager.URL)
Sietse Ringers's avatar
Sietse Ringers committed
641
	path := fmt.Sprintf("%s/%s", conf.Path, name)
642
643
644
	if err := t.GetFile("description.xml", path+"/description.xml"); err != nil {
		return err
	}
645
	if err := t.GetFile("pk.pem", path+"/pk.pem"); err != nil {
646
647
		return err
	}
648
	if err := conf.DownloadSchemeManagerSignature(manager); err != nil {
649
650
		return err
	}
651
652
653
654
	conf.SchemeManagers[manager.Identifier()] = manager
	if err := conf.UpdateSchemeManager(manager.Identifier(), nil); err != nil {
		return err
	}
655

656
	return conf.ParseSchemeManagerFolder(filepath.Join(conf.Path, name), manager)
657
658
659
660
661
662
}

// 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) {
	t := NewHTTPTransport(manager.URL)
Sietse Ringers's avatar
Sietse Ringers committed
663
	path := fmt.Sprintf("%s/%s", conf.Path, manager.ID)
664
665
666
667
	index := filepath.Join(path, "index")
	sig := filepath.Join(path, "index.sig")

	if err = t.GetFile("index", index); err != nil {
668
		return
669
670
	}
	if err = t.GetFile("index.sig", sig); err != nil {
671
		return
672
	}
673
	err = conf.VerifySignature(manager.Identifier())
674
	return
675
}
676

Sietse Ringers's avatar
Sietse Ringers committed
677
678
679
// 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.
680
func (conf *Configuration) Download(session SessionRequest) (downloaded *IrmaIdentifierSet, err error) {
681
	managers := make(map[string]struct{}) // Managers that we must update
682
	downloaded = &IrmaIdentifierSet{
683
684
685
686
		SchemeManagers:  map[SchemeManagerIdentifier]struct{}{},
		Issuers:         map[IssuerIdentifier]struct{}{},
		CredentialTypes: map[CredentialTypeIdentifier]struct{}{},
	}
687

688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
	// 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
}

708
func (conf *Configuration) checkCredentialTypes(session SessionRequest, managers map[string]struct{}) error {
709
710
711
712
713
714
715
716
	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
717
			typ, contains = conf.CredentialTypes[credreq.CredentialTypeID]
718
719
720
721
722
723
724
725
726
727
			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
728
			for _, attrtyp := range typ.AttributeTypes {
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
				_, 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{}{}
			}
Sietse Ringers's avatar
Sietse Ringers committed
754
			if !attrid.IsCredential() && !typ.ContainsAttribute(attrid) {
755
756
757
758
759
760
761
762
763
				managers[credid.Root()] = struct{}{}
			}
		}
	}

	return nil
}

func (conf *Configuration) checkIssuers(set *IrmaIdentifierSet, managers map[string]struct{}) error {
764
	for issid := range set.Issuers {
765
		if _, contains := conf.Issuers[issid]; !contains {
766
			managers[issid.Root()] = struct{}{}
767
		}
Sietse Ringers's avatar
Sietse Ringers committed
768
	}
769
770
771
	for issid, keyids := range set.PublicKeys {
		for _, keyid := range keyids {
			pk, err := conf.PublicKey(issid, keyid)
Sietse Ringers's avatar
Sietse Ringers committed
772
			if err != nil {
773
				return err
Sietse Ringers's avatar
Sietse Ringers committed
774
775
			}
			if pk == nil {
776
				managers[issid.Root()] = struct{}{}
777
778
779
			}
		}
	}
780
	return nil
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
}

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
802
// FromString populates this index by parsing the specified string.
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
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
}

822
// parseIndex parses the index file of the specified manager.
823
func (conf *Configuration) parseIndex(name string, manager *SchemeManager) (SchemeManagerIndex, error) {
Sietse Ringers's avatar
Sietse Ringers committed
824
	path := filepath.Join(conf.Path, name, "index")
Sietse Ringers's avatar
Sietse Ringers committed
825
	if err := fs.AssertPathExists(path); err != nil {
826
		return nil, fmt.Errorf("Missing scheme manager index file; tried %s", path)
827
	}
Sietse Ringers's avatar
Sietse Ringers committed
828
	indexbts, err := ioutil.ReadFile(path)
829
	if err != nil {
830
		return nil, err
831
	}
832
833
	index := SchemeManagerIndex(make(map[string]ConfigurationFileHash))
	return index, index.FromString(string(indexbts))
834
835
}

836
func (conf *Configuration) VerifySchemeManager(manager *SchemeManager) error {
837
	err := conf.VerifySignature(manager.Identifier())
838
839
840
841
	if err != nil {
		return err
	}

842
	var exists bool
843
	for file := range manager.index {
844
		exists, err = fs.PathExists(filepath.Join(conf.Path, file))
845
846
847
848
849
850
		if err != nil {
			return err
		}
		if !exists {
			continue
		}
851
		// Don't care about the actual bytes
852
		if _, _, err = conf.ReadAuthenticatedFile(manager, file); err != nil {
853
854
855
856
857
858
859
			return err
		}
	}

	return nil
}

860
861
862
// 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.
863
func (conf *Configuration) ReadAuthenticatedFile(manager *SchemeManager, path string) ([]byte, bool, error) {
864
	signedHash, ok := manager.index[filepath.ToSlash(path)]
865
	if !ok {
866
		return nil, false, nil
867
868
	}

Sietse Ringers's avatar
Sietse Ringers committed
869
	bts, err := ioutil.ReadFile(filepath.Join(conf.Path, path))
870
	if err != nil {
871
		return nil, true, err
872
873
874
875
	}
	computedHash := sha256.Sum256(bts)

	if !bytes.Equal(computedHash[:], signedHash) {
876
		return nil, true, errors.Errorf("Hash of %s does not match scheme manager index", path)
877
	}
878
	return bts, true, nil
879
880
881
882
883
}

// 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).
884
func (conf *Configuration) VerifySignature(id SchemeManagerIdentifier) (err error) {
885
886
887
888
889
890
891
892
893
894
	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
895
	dir := filepath.Join(conf.Path, id.String())
896
	if err := fs.AssertPathExists(dir+"/index", dir+"/index.sig", dir+"/pk.pem"); err != nil {
897
		return errors.New("Missing scheme manager index file, signature, or public key")
898
899
900
901
902
	}

	// Read and hash index file
	indexbts, err := ioutil.ReadFile(dir + "/index")
	if err != nil {
903
		return err
904
905
906
907
908
909
	}
	indexhash := sha256.Sum256(indexbts)

	// Read and parse scheme manager public key
	pkbts, err := ioutil.ReadFile(dir + "/pk.pem")
	if err != nil {
910
		return err
911
912
913
914
	}
	pkblk, _ := pem.Decode(pkbts)
	genericPk, err := x509.ParsePKIXPublicKey(pkblk.Bytes)
	if err != nil {
915
		return err
916
917
918
	}
	pk, ok := genericPk.(*ecdsa.PublicKey)
	if !ok {
919
		return errors.New("Invalid scheme manager public key")
920
921
922
923
924
	}

	// Read and parse signature
	sig, err := ioutil.ReadFile(dir + "/index.sig")
	if err != nil {
925
		return err
926
	}
927
	ints := make([]*gobig.Int, 0, 2)
928
929
930
	_, err = asn1.Unmarshal(sig, &ints)

	// Verify signature
931
932
933
934
	if !ecdsa.Verify(pk, indexhash[:], ints[0], ints[1]) {
		return errors.New("Scheme manager signature was invalid")
	}
	return nil
935
}
936
937
938
939

func (hash ConfigurationFileHash) String() string {
	return hex.EncodeToString(hash)
}
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955

func (hash ConfigurationFileHash) Equal(other ConfigurationFileHash) bool {
	return bytes.Equal(hash, other)
}

// UpdateSchemeManager syncs the stored version within the irma_configuration directory
// with the remote version at the scheme manager's URL, downloading and storing
// new and modified files, according to the index files of both versions.
// It stores the identifiers of new or updated credential types or issuers in the second parameter.
// Note: any newly downloaded files are not yet parsed and inserted into conf.
func (conf *Configuration) UpdateSchemeManager(id SchemeManagerIdentifier, downloaded *IrmaIdentifierSet) (err error) {
	manager, contains := conf.SchemeManagers[id]
	if !contains {
		return errors.Errorf("Cannot update unknown scheme manager %s", id)
	}

956
957
958
959
960
961
962
963
964
965
	// Check remote timestamp and see if we have to do anything
	transport := NewHTTPTransport(manager.URL + "/")
	timestampBts, err := transport.GetBytes("timestamp")
	if err != nil {
		return err
	}
	timestamp, err := parseTimestamp(timestampBts)
	if err != nil {
		return err
	}
966
	if !manager.Timestamp.Before(*timestamp) {
967
968
969
		return nil
	}

970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
	// Download the new index and its signature, and check that the new index
	// is validly signed by the new signature
	// By aborting immediately in case of error, and restoring backup versions
	// of the index and signature, we leave our stored copy of the scheme manager
	// intact.
	if err = conf.DownloadSchemeManagerSignature(manager); err != nil {
		return
	}
	newIndex, err := conf.parseIndex(manager.ID, manager)
	if err != nil {
		return
	}

	issPattern := regexp.MustCompile("(.+)/(.+)/description\\.xml")
	credPattern := regexp.MustCompile("(.+)/(.+)/Issues/(.+)/description\\.xml")

	// TODO: how to recover/fix local copy if err != nil below?
	for filename, newHash := range newIndex {
988
		path := filepath.Join(conf.Path, filename)
989
		oldHash, known := manager.index[filename]
990
991
992
993
994
995
		var have bool
		have, err = fs.PathExists(path)
		if err != nil {
			return err
		}
		if known && have && oldHash.Equal(newHash) {
996
997
998
999
1000
1001
1002
1003
			continue // nothing to do, we already have this file
		}
		// Ensure that the folder in which to write the file exists
		if err = os.MkdirAll(filepath.Dir(path), 0700); err != nil {
			return err
		}
		stripped := filename[len(manager.ID)+1:] // Scheme manager URL already ends with its name
		// Download the new file, store it in our own irma_configuration folder
1004
		if err = transport.GetSignedFile(stripped, path, newHash); err != nil {
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
			return
		}
		// See if the file is a credential type or issuer, and add it to the downloaded set if so
		if downloaded == nil {
			continue
		}
		var matches []string
		matches = issPattern.FindStringSubmatch(filename)
		if len(matches) == 3 {
			issid := NewIssuerIdentifier(fmt.Sprintf("%s.%s", matches[1], matches[2]))
			downloaded.Issuers[issid] = struct{}{}
		}
		matches = credPattern.FindStringSubmatch(filename)
		if len(matches) == 4 {
			credid := NewCredentialTypeIdentifier(fmt.Sprintf("%s.%s.%s", matches[1], matches[2], matches[3]))
			downloaded.CredentialTypes[credid] = struct{}{}
		}
	}

	manager.index = newIndex
	return
}
1027
1028
1029
1030
1031

// Methods containing consistency checks on irma_configuration

func (conf *Configuration) checkIssuer(manager *SchemeManager, issuer *Issuer, dir string) error {
	issuerid := issuer.Identifier()
1032
1033
	conf.checkTranslations(fmt.Sprintf("Issuer %s", issuerid.String()), issuer)
	// Check that the issuer has public keys
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
	pkpath := fmt.Sprintf(pubkeyPattern, conf.Path, issuerid.SchemeManagerIdentifier().Name(), issuerid.Name())
	files, err := filepath.Glob(pkpath)
	if err != nil {
		return err
	}
	if len(files) == 0 {
		conf.Warnings = append(conf.Warnings, fmt.Sprintf("Issuer %s has no public keys", issuerid.String()))
	}

	if filepath.Base(dir) != issuer.ID {
		return errors.Errorf("Issuer %s has wrong directory name %s", issuerid.String(), filepath.Base(dir))
	}
	if manager.ID != issuer.SchemeManagerID {
		return errors.Errorf("Issuer %s has wrong SchemeManager %s", issuerid.String(), issuer.SchemeManagerID)
	}
	if err = fs.AssertPathExists(dir + "/logo.png"); err != nil {
		conf.Warnings = append(conf.Warnings, fmt.Sprintf("Issuer %s has no logo.png", issuerid.String()))
	}
	return nil
}

func (conf *Configuration) checkCredentialType(manager *SchemeManager, issuer *Issuer, cred *CredentialType, dir string) error {
	credid := cred.Identifier()
1057
	conf.checkTranslations(fmt.Sprintf("Credential type %s", credid.String()), cred)
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
	if cred.XMLVersion < 4 {
		return errors.New("Unsupported credential type description")
	}
	if cred.ID != filepath.Base(dir) {
		return errors.Errorf("Credential type %s has wrong directory name %s", credid.String(), filepath.Base(dir))
	}
	if cred.IssuerID != issuer.ID {
		return errors.Errorf("Credential type %s has wrong IssuerID %s", credid.String(), cred.IssuerID)
	}
	if cred.SchemeManagerID != manager.ID {
		return errors.Errorf("Credential type %s has wrong SchemeManager %s", credid.String(), cred.SchemeManagerID)
	}
	if err := fs.AssertPathExists(dir + "/logo.png"); err != nil {
		conf.Warnings = append(conf.Warnings, fmt.Sprintf("Credential type %s has no logo.png", credid.String()))
	}
	return conf.checkAttributes(cred)
}

func (conf *Configuration) checkAttributes(cred *CredentialType) error {
	name := cred.Identifier().String()
	indices := make(map[int]struct{})
1079
	count := len(cred.AttributeTypes)
1080
1081
1082
	if count == 0 {
		return errors.Errorf("Credenial type %s has no attributes", name)
	}
1083
	for i, attr := range cred.AttributeTypes {
1084
		conf.checkTranslations(fmt.Sprintf("Attribute %s of credential type %s", attr.ID, cred.Identifier().String()), attr)
1085
		index := i
1086
1087
		if attr.DisplayIndex != nil {
			index = *attr.DisplayIndex
1088
1089