storage.go 7.24 KB
Newer Older
1
2
3
4
5
6
7
8
9
package irmago

import (
	"encoding/json"
	"errors"
	"io/ioutil"
	"os"
	"strconv"

Sietse Ringers's avatar
Sietse Ringers committed
10
11
12
13
	"crypto/rand"
	"encoding/hex"
	"math/big"
	"path"
14
15

	"github.com/mhe/gabi"
16
17
18
19
20
21
)

// Filenames in which we store stuff
const (
	skFile         = "sk"
	attributesFile = "attrs"
22
23
	kssFile        = "kss"
	paillierFile   = "paillier"
24
	signaturesDir  = "sigs"
Sietse Ringers's avatar
Sietse Ringers committed
25
	cardemuXML     = "../cardemu.xml"
26
27
)

Sietse Ringers's avatar
Sietse Ringers committed
28
// PathExists checks if the specified path exists.
29
func PathExists(path string) (bool, error) {
30
31
32
33
34
35
36
37
38
39
	_, err := os.Stat(path)
	if err == nil {
		return true, nil
	}
	if os.IsNotExist(err) {
		return false, nil
	}
	return true, err
}

40
41
// NewCredentialManager deserializes the credentials from storage.
func NewCredentialManager(
42
43
44
	storagePath string,
	irmaConfigurationPath string,
	keyshareHandler KeyshareHandler,
45
46
47
48
49
50
51
) (*CredentialManager, error) {
	var err error
	cm := &CredentialManager{
		credentials:     make(map[CredentialTypeIdentifier]map[int]*credential),
		keyshareServers: make(map[SchemeManagerIdentifier]*keyshareServer),
	}

Sietse Ringers's avatar
Sietse Ringers committed
52
	cm.Store = NewConfigurationStore()
53
	if err = cm.Store.ParseFolder(irmaConfigurationPath); err != nil {
54
		return nil, err
55
	}
56

57
58
	cm.storagePath = storagePath
	if err = cm.ensureStorageExists(); err != nil {
59
		return nil, err
60
	}
61
	if cm.secretkey, err = cm.loadSecretKey(); err != nil {
62
		return nil, err
63
	}
64
	if cm.attributes, err = cm.loadAttributes(); err != nil {
65
		return nil, err
66
	}
67
	if cm.paillierKeyCache, err = cm.loadPaillierKeys(); err != nil {
68
		return nil, err
Sietse Ringers's avatar
Sietse Ringers committed
69
	}
70
	if cm.keyshareServers, err = cm.loadKeyshareServers(); err != nil {
71
		return nil, err
72
	}
Sietse Ringers's avatar
Sietse Ringers committed
73
74
75

	unenrolled := cm.unenrolledKeyshareServers()
	switch len(unenrolled) {
76
	case 0: // nop
Sietse Ringers's avatar
Sietse Ringers committed
77
	case 1:
Sietse Ringers's avatar
Sietse Ringers committed
78
		if keyshareHandler == nil {
79
			return nil, errors.New("Keyshare server found but no KeyshareHandler was given")
Sietse Ringers's avatar
Sietse Ringers committed
80
		}
81
		keyshareHandler.StartRegistration(unenrolled[0], func(email, pin string) {
Sietse Ringers's avatar
Sietse Ringers committed
82
83
			cm.KeyshareEnroll(unenrolled[0].Identifier(), email, pin)
		})
Sietse Ringers's avatar
Sietse Ringers committed
84
	default:
85
		return nil, errors.New("Too many keyshare servers")
Sietse Ringers's avatar
Sietse Ringers committed
86
87
	}

88
	return cm, nil
89
90
}

91
92
93
94
func (cm *CredentialManager) path(file string) string {
	return cm.storagePath + "/" + file
}

Sietse Ringers's avatar
Sietse Ringers committed
95
96
97
98
99
100
101
102
103
func (cm *CredentialManager) signatureFilename(id string, counter int) string {
	return cm.path(signaturesDir) + "/" + id + "-" + strconv.Itoa(counter)
}

// ensureStorageExists initializes the credential storage folder,
// ensuring that it is in a usable state.
// NOTE: we do not create the folder if it does not exist!
// Setting it up in a properly protected location (e.g., with automatic
// backups to iCloud/Google disabled) is the responsibility of the user.
104
func (cm *CredentialManager) ensureStorageExists() (err error) {
105
	exist, err := PathExists(cm.storagePath)
106
107
108
109
110
111
112
	if err != nil {
		return
	}
	if !exist {
		return errors.New("credential storage path does not exist")
	}

113
	exist, err = PathExists(cm.path(signaturesDir))
114
115
116
117
118
119
120
121
122
123
	if err != nil {
		return err
	}
	if !exist {
		err = os.Mkdir(cm.path(signaturesDir), 0700)
	}

	return
}

Sietse Ringers's avatar
Sietse Ringers committed
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
func (cm *CredentialManager) storeSecretKey(sk *big.Int) error {
	return ioutil.WriteFile(cm.path(skFile), sk.Bytes(), 0600)
}

// Save the filecontents at the specified path atomically:
// - first save the content in a temp file with a random filename in the same dir
// - then rename the temp file to the specified filepath, overwriting the old file
func (cm *CredentialManager) saveFile(filepath string, content []byte) (err error) {
	dir := path.Dir(filepath)

	// Read random data for filename and convert to hex
	randBytes := make([]byte, 16)
	_, err = rand.Read(randBytes)
	if err != nil {
		return
	}
	tempfilename := hex.EncodeToString(randBytes)

	// Create temp file
	err = ioutil.WriteFile(dir+"/"+tempfilename, content, 0600)
	if err != nil {
		return
	}

	// Rename, overwriting old file
	return os.Rename(dir+"/"+tempfilename, filepath)
150
151
}

Sietse Ringers's avatar
Sietse Ringers committed
152
func (cm *CredentialManager) storeSignature(cred *credential, counter int) (err error) {
153
154
155
156
157
158
159
160
161
162
	if cred.CredentialType() == nil {
		return errors.New("cannot add unknown credential type")
	}

	credbytes, err := json.Marshal(cred.Signature)
	if err != nil {
		return err
	}

	// TODO existence check
163
	filename := cm.signatureFilename(cred.CredentialType().Identifier().String(), counter)
164
165
166
167
168
	err = ioutil.WriteFile(filename, credbytes, 0600)
	return
}

func (cm *CredentialManager) storeAttributes() (err error) {
169
	attrbytes, err := json.Marshal(cm.attributes)
170
	if err != nil {
171
		return err
172
173
174
175
176
177
	}

	// TODO existence check
	err = ioutil.WriteFile(cm.path(attributesFile), attrbytes, 0600)
	return
}
Sietse Ringers's avatar
Sietse Ringers committed
178

179
func (cm *CredentialManager) storeKeyshareServers() (err error) {
180
	bts, err := json.Marshal(cm.keyshareServers)
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
	if err != nil {
		return
	}
	err = ioutil.WriteFile(cm.path(kssFile), bts, 0600)
	return
}

func (cm *CredentialManager) storePaillierKeys() (err error) {
	bts, err := json.Marshal(cm.paillierKeyCache)
	if err != nil {
		return
	}
	err = ioutil.WriteFile(cm.path(paillierFile), bts, 0600)
	return
}

197
func (cm *CredentialManager) loadSignature(id CredentialTypeIdentifier, counter int) (signature *gabi.CLSignature, err error) {
Sietse Ringers's avatar
Cleanup    
Sietse Ringers committed
198
199
	sigpath := cm.signatureFilename(id.String(), counter)
	exists, err := PathExists(sigpath)
200
	if err != nil {
Sietse Ringers's avatar
Sietse Ringers committed
201
202
		return
	}
203
204
205
	if !exists {
		return nil, errors.New("Signature file not found")
	}
Sietse Ringers's avatar
Cleanup    
Sietse Ringers committed
206
	bytes, err := ioutil.ReadFile(sigpath)
207
208
209
	if err != nil {
		return
	}
Sietse Ringers's avatar
Sietse Ringers committed
210
211
212
213
214
215
216
217
	signature = new(gabi.CLSignature)
	err = json.Unmarshal(bytes, signature)
	return
}

// loadSecretKey retrieves and returns the secret key from storage, or if no secret key
// was found in storage, it generates, saves, and returns a new secret key.
func (cm *CredentialManager) loadSecretKey() (*big.Int, error) {
218
	exists, err := PathExists(cm.path(skFile))
Sietse Ringers's avatar
Sietse Ringers committed
219
220
221
222
	if err != nil {
		return nil, err
	}
	if exists {
223
224
225
		var bytes []byte
		if bytes, err = ioutil.ReadFile(cm.path(skFile)); err == nil {
			return new(big.Int).SetBytes(bytes), nil
Sietse Ringers's avatar
Sietse Ringers committed
226
		}
227
		return nil, err
Sietse Ringers's avatar
Sietse Ringers committed
228
	}
229
230
231
232
233
234
235
236
237
238

	sk, err := cm.generateSecretKey()
	if err != nil {
		return nil, err
	}
	err = cm.storeSecretKey(sk)
	if err != nil {
		return nil, err
	}
	return sk, nil
Sietse Ringers's avatar
Sietse Ringers committed
239
240
}

241
242
func (cm *CredentialManager) loadAttributes() (list map[CredentialTypeIdentifier][]*AttributeList, err error) {
	list = make(map[CredentialTypeIdentifier][]*AttributeList)
243
	exists, err := PathExists(cm.path(attributesFile))
Sietse Ringers's avatar
Sietse Ringers committed
244
245
246
247
248
249
250
	if err != nil || !exists {
		return
	}
	bytes, err := ioutil.ReadFile(cm.path(attributesFile))
	if err != nil {
		return nil, err
	}
251
	err = json.Unmarshal(bytes, &list)
252
253
254
	if err != nil {
		return nil, err
	}
Sietse Ringers's avatar
Sietse Ringers committed
255

256
257
258
259
260
261
	for _, attrlistlist := range list {
		for _, attrlist := range attrlistlist {
			attrlist.MetadataAttribute.store = cm.Store
		}
	}

262
	return list, nil
Sietse Ringers's avatar
Sietse Ringers committed
263
}
264
265
266
267
268
269
270
271
272
273
274

func (cm *CredentialManager) loadKeyshareServers() (ksses map[SchemeManagerIdentifier]*keyshareServer, err error) {
	ksses = make(map[SchemeManagerIdentifier]*keyshareServer)
	exists, err := PathExists(cm.path(kssFile))
	if err != nil || !exists {
		return
	}
	bytes, err := ioutil.ReadFile(cm.path(kssFile))
	if err != nil {
		return nil, err
	}
275
	err = json.Unmarshal(bytes, &ksses)
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
	if err != nil {
		return nil, err
	}
	return
}

func (cm *CredentialManager) loadPaillierKeys() (key *paillierPrivateKey, err error) {
	exists, err := PathExists(cm.path(paillierFile))
	if err != nil || !exists {
		return
	}
	bytes, err := ioutil.ReadFile(cm.path(paillierFile))
	if err != nil {
		return nil, err
	}
	key = new(paillierPrivateKey)
	err = json.Unmarshal(bytes, key)
	if err != nil {
		return nil, err
	}
	return
}