configstore.go 10.8 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
package irmago

import (
	"encoding/base64"
	"encoding/xml"
	"io/ioutil"
	"os"
	"path/filepath"
	"strconv"

11
12
	"crypto/sha256"

13
14
15
16
	"fmt"

	"strings"

17
	"github.com/credentials/irmago/internal/fs"
18
	"github.com/go-errors/errors"
19
20
21
	"github.com/mhe/gabi"
)

22
23
// ConfigurationStore keeps track of scheme managers, issuers, credential types and public keys,
// dezerializing them from an irma_configuration folder, and downloads and saves new ones on demand.
24
type ConfigurationStore struct {
25
26
27
	SchemeManagers  map[SchemeManagerIdentifier]*SchemeManager
	Issuers         map[IssuerIdentifier]*Issuer
	CredentialTypes map[CredentialTypeIdentifier]*CredentialType
28

29
	publicKeys    map[IssuerIdentifier]map[int]*gabi.PublicKey
30
	reverseHashes map[string]CredentialTypeIdentifier
31
	path          string
32
	initialized   bool
33
34
}

35
36
// NewConfigurationStore returns a new configuration store. After this
// ParseFolder() should be called to parse the specified path.
37
func NewConfigurationStore(path string, assets string) (store *ConfigurationStore, err error) {
38
	store = &ConfigurationStore{
39
		path: path,
40
	}
41

42
	if err = fs.EnsureDirectoryExists(store.path); err != nil {
43
44
		return nil, err
	}
45
46
	if assets != "" {
		if err = store.Copy(assets, false); err != nil {
47
48
49
50
			return nil, err
		}
	}

51
52
53
	return
}

54
55
56
// ParseFolder populates the current store by parsing the storage path,
// listing the containing scheme managers, issuers and credential types.
func (store *ConfigurationStore) ParseFolder() error {
57
58
59
	// Init all maps
	store.SchemeManagers = make(map[SchemeManagerIdentifier]*SchemeManager)
	store.Issuers = make(map[IssuerIdentifier]*Issuer)
60
	store.CredentialTypes = make(map[CredentialTypeIdentifier]*CredentialType)
61
	store.publicKeys = make(map[IssuerIdentifier]map[int]*gabi.PublicKey)
62

63
	store.reverseHashes = make(map[string]CredentialTypeIdentifier)
64

65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
	err := iterateSubfolders(store.path, func(dir string) error {
		manager := &SchemeManager{}
		exists, err := pathToDescription(dir+"/description.xml", manager)
		if err != nil {
			return err
		}
		if exists {
			store.SchemeManagers[manager.Identifier()] = manager
			return store.parseIssuerFolders(dir)
		}
		return nil
	})
	if err != nil {
		return err
	}
	store.initialized = true
	return nil
}

84
// PublicKey returns the specified public key, or nil if not present in the ConfigurationStore.
85
86
func (store *ConfigurationStore) PublicKey(id IssuerIdentifier, counter int) (*gabi.PublicKey, error) {
	if _, contains := store.publicKeys[id]; !contains {
87
88
		store.publicKeys[id] = map[int]*gabi.PublicKey{}
		if err := store.parseKeysFolder(id); err != nil {
89
			return nil, err
90
91
		}
	}
92
	return store.publicKeys[id][counter], nil
93
94
}

95
func (store *ConfigurationStore) addReverseHash(credid CredentialTypeIdentifier) {
96
	hash := sha256.Sum256([]byte(credid.String()))
97
98
99
100
101
	store.reverseHashes[base64.StdEncoding.EncodeToString(hash[:16])] = credid
}

func (store *ConfigurationStore) hashToCredentialType(hash []byte) *CredentialType {
	if str, exists := store.reverseHashes[base64.StdEncoding.EncodeToString(hash)]; exists {
102
		return store.CredentialTypes[str]
103
104
105
106
	}
	return nil
}

107
// IsInitialized indicates whether this instance has successfully been initialized.
108
109
110
111
func (store *ConfigurationStore) IsInitialized() bool {
	return store.initialized
}

112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
func (store *ConfigurationStore) parseIssuerFolders(path string) error {
	return iterateSubfolders(path, func(dir string) error {
		issuer := &Issuer{}
		exists, err := pathToDescription(dir+"/description.xml", issuer)
		if err != nil {
			return err
		}
		if exists {
			store.Issuers[issuer.Identifier()] = issuer
			if err = store.parseCredentialsFolder(dir + "/Issues/"); err != nil {
				return err
			}
		}
		return nil
	})
}

129
// parse $schememanager/$issuer/PublicKeys/$i.xml for $i = 1, ...
130
func (store *ConfigurationStore) parseKeysFolder(issuerid IssuerIdentifier) error {
131
132
133
134
135
136
137
138
139
140
141
142
	path := fmt.Sprintf("%s/%s/%s/PublicKeys/*.xml", store.path, issuerid.SchemeManagerIdentifier().Name(), issuerid.Name())
	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 {
			continue
143
144
145
146
147
		}
		pk, err := gabi.NewPublicKeyFromFile(file)
		if err != nil {
			return err
		}
148
149
		pk.Issuer = issuerid.String()
		store.publicKeys[issuerid][i] = pk
150
	}
151

152
153
154
	return nil
}

155
// parse $schememanager/$issuer/Issues/*/description.xml
156
157
158
159
160
161
162
163
164
func (store *ConfigurationStore) parseCredentialsFolder(path string) error {
	return iterateSubfolders(path, func(dir string) error {
		cred := &CredentialType{}
		exists, err := pathToDescription(dir+"/description.xml", cred)
		if err != nil {
			return err
		}
		if exists {
			credid := cred.Identifier()
165
			store.CredentialTypes[credid] = cred
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
			store.addReverseHash(credid)
		}
		return nil
	})
}

// 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
		}
		err = handler(dir)
		if err != nil {
			return err
		}
	}

	return nil
}

func pathToDescription(path string, description interface{}) (bool, error) {
	if _, err := os.Stat(path); err != nil {
		return false, nil
	}

	file, err := os.Open(path)
	if err != nil {
		return true, err
	}
	defer file.Close()

	bytes, err := ioutil.ReadAll(file)
	if err != nil {
		return true, err
	}

	err = xml.Unmarshal(bytes, description)
	if err != nil {
		return true, err
	}

	return true, nil
}
221

Sietse Ringers's avatar
Sietse Ringers committed
222
// Contains checks if the store contains the specified credential type.
223
224
225
func (store *ConfigurationStore) Contains(cred CredentialTypeIdentifier) bool {
	return store.SchemeManagers[cred.IssuerIdentifier().SchemeManagerIdentifier()] != nil &&
		store.Issuers[cred.IssuerIdentifier()] != nil &&
226
		store.CredentialTypes[cred] != nil
227
}
228

229
func (store *ConfigurationStore) Copy(source string, parse bool) error {
230
	if err := fs.EnsureDirectoryExists(store.path); err != nil {
231
232
233
		return err
	}

234
	err := filepath.Walk(source, filepath.WalkFunc(
235
236
237
238
239
240
		func(path string, info os.FileInfo, err error) error {
			if path == source {
				return nil
			}
			subpath := path[len(source):]
			if info.IsDir() {
241
				if err := fs.EnsureDirectoryExists(store.path + subpath); err != nil {
242
243
244
245
246
247
248
249
					return err
				}
			} else {
				srcfile, err := os.Open(path)
				if err != nil {
					return err
				}
				defer srcfile.Close()
Sietse Ringers's avatar
Sietse Ringers committed
250
251
252
253
				bytes, err := ioutil.ReadAll(srcfile)
				if err != nil {
					return err
				}
254
				if err := fs.SaveFile(store.path+subpath, bytes); err != nil {
255
256
257
258
259
260
					return err
				}
			}
			return nil
		}),
	)
261
262
263
264
265
266
267
268

	if err != nil {
		return err
	}
	if parse {
		return store.ParseFolder()
	}
	return nil
269
}
270

271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
func (store *ConfigurationStore) DownloadSchemeManager(url string) (*SchemeManager, error) {
	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")]
	}
	b, err := NewHTTPTransport(url).GetBytes("/description.xml")
	if err != nil {
		return nil, err
	}
	manager := &SchemeManager{}
	if err = xml.Unmarshal(b, manager); err != nil {
		return nil, err
	}

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

func (store *ConfigurationStore) RemoveSchemeManager(id SchemeManagerIdentifier) error {
	// Remove everything falling under the manager's responsibility
296
	for credid := range store.CredentialTypes {
297
		if credid.IssuerIdentifier().SchemeManagerIdentifier() == id {
298
			delete(store.CredentialTypes, credid)
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
		}
	}
	for issid := range store.Issuers {
		if issid.SchemeManagerIdentifier() == id {
			delete(store.Issuers, issid)
		}
	}
	for issid := range store.publicKeys {
		if issid.SchemeManagerIdentifier() == id {
			delete(store.publicKeys, issid)
		}
	}
	// Remove from storage
	return os.RemoveAll(fmt.Sprintf("%s/%s", store.path, id.String()))
	// or, remove above iterations and call .ParseFolder()?
}

func (store *ConfigurationStore) AddSchemeManager(manager *SchemeManager) error {
	name := manager.ID
318
	if err := fs.EnsureDirectoryExists(fmt.Sprintf("%s/%s", store.path, name)); err != nil {
319
320
321
322
323
324
		return err
	}
	b, err := xml.Marshal(manager)
	if err != nil {
		return err
	}
325
	if err := fs.SaveFile(fmt.Sprintf("%s/%s/description.xml", store.path, name), b); err != nil {
326
327
328
		return err
	}
	store.SchemeManagers[NewSchemeManagerIdentifier(name)] = manager
329
330
	return nil
}
331

332
func (store *ConfigurationStore) Download(set *IrmaIdentifierSet) (*IrmaIdentifierSet, error) {
333
	var contains bool
334
335
336
337
338
339
340
	var err error
	downloaded := &IrmaIdentifierSet{
		SchemeManagers:  map[SchemeManagerIdentifier]struct{}{},
		Issuers:         map[IssuerIdentifier]struct{}{},
		CredentialTypes: map[CredentialTypeIdentifier]struct{}{},
	}

341
342
	for manid := range set.SchemeManagers {
		if _, contains = store.SchemeManagers[manid]; !contains {
343
			return nil, errors.Errorf("Unknown scheme manager: %s", manid)
344
345
346
347
348
349
350
351
		}
	}

	transport := NewHTTPTransport("")
	for issid := range set.Issuers {
		if _, contains = store.Issuers[issid]; !contains {
			url := store.SchemeManagers[issid.SchemeManagerIdentifier()].URL + "/" + issid.Name()
			path := fmt.Sprintf("%s/%s/%s", store.path, issid.SchemeManagerIdentifier().String(), issid.Name())
352
353
354
355
356
357
358
			if err = transport.GetFile(url+"/description.xml", path+"/description.xml"); err != nil {
				return nil, err
			}
			if transport.GetFile(url+"/logo.png", path+"/logo.png"); err != nil {
				return nil, err
			}
			downloaded.Issuers[issid] = struct{}{}
359
		}
Sietse Ringers's avatar
Sietse Ringers committed
360
361
362
363
364
365
366
367
368
369
370
371
	}
	for issid, list := range set.PublicKeys {
		for _, count := range list {
			pk, err := store.PublicKey(issid, count)
			if err != nil {
				return nil, err
			}
			if pk == nil {
				manager := issid.SchemeManagerIdentifier()
				suffix := fmt.Sprintf("/%s/PublicKeys/%d.xml", issid.Name(), count)
				path := fmt.Sprintf("%s/%s/%s", store.path, manager.String(), suffix)
				if transport.GetFile(store.SchemeManagers[manager].URL+suffix, path); err != nil {
372
					return nil, err
373
				}
374
375
376
377
			}
		}
	}
	for credid := range set.CredentialTypes {
378
		if _, contains := store.CredentialTypes[credid]; !contains {
379
380
381
			issuer := credid.IssuerIdentifier()
			manager := issuer.SchemeManagerIdentifier()
			local := fmt.Sprintf("%s/%s/%s/Issues", store.path, manager.Name(), issuer.Name())
382
			if err := fs.EnsureDirectoryExists(local); err != nil {
383
				return nil, err
384
			}
385
			if transport.GetFile(
386
387
388
				fmt.Sprintf("%s/%s/Issues/%s/description.xml",
					store.SchemeManagers[manager].URL, issuer.Name(), credid.Name()),
				fmt.Sprintf("%s/%s/description.xml", local, credid.Name()),
389
390
391
392
			); err != nil {
				return nil, err
			}
			downloaded.CredentialTypes[credid] = struct{}{}
393
394
395
		}
	}

396
	return downloaded, store.ParseFolder()
397
}