storage.go 4.83 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
22
)

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

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

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

Sietse Ringers's avatar
Sietse Ringers committed
42
43
44
45
46
47
48
49
50
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.
51
func (cm *CredentialManager) ensureStorageExists() (err error) {
52
	exist, err := PathExists(cm.storagePath)
53
54
55
56
57
58
59
	if err != nil {
		return
	}
	if !exist {
		return errors.New("credential storage path does not exist")
	}

60
	exist, err = PathExists(cm.path(signaturesDir))
61
62
63
64
65
66
67
68
69
70
	if err != nil {
		return err
	}
	if !exist {
		err = os.Mkdir(cm.path(signaturesDir), 0700)
	}

	return
}

Sietse Ringers's avatar
Sietse Ringers committed
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
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)
97
98
}

Sietse Ringers's avatar
Sietse Ringers committed
99
func (cm *CredentialManager) storeSignature(cred *credential, counter int) (err error) {
100
101
102
103
104
105
106
107
108
109
	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
110
	filename := cm.signatureFilename(cred.CredentialType().Identifier().String(), counter)
111
112
113
114
115
	err = ioutil.WriteFile(filename, credbytes, 0600)
	return
}

func (cm *CredentialManager) storeAttributes() (err error) {
116
	// Unfortunately, the type of cm.attributes (map[CredentialTypeIdentifier][]*AttributeList)
117
118
119
120
121
122
	// cannot be passed directly to json.Marshal(), so we copy it into a temp list.
	temp := make(map[string][]*AttributeList)
	for credid, list := range cm.attributes {
		temp[credid.String()] = list
	}
	attrbytes, err := json.Marshal(temp)
123
	if err != nil {
124
		return err
125
126
127
128
129
130
	}

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

132
func (cm *CredentialManager) loadSignature(id CredentialTypeIdentifier, counter int) (signature *gabi.CLSignature, err error) {
Sietse Ringers's avatar
Cleanup    
Sietse Ringers committed
133
134
	sigpath := cm.signatureFilename(id.String(), counter)
	exists, err := PathExists(sigpath)
Sietse Ringers's avatar
Sietse Ringers committed
135
136
137
	if err != nil || !exists {
		return
	}
Sietse Ringers's avatar
Cleanup    
Sietse Ringers committed
138
	bytes, err := ioutil.ReadFile(sigpath)
139
140
141
	if err != nil {
		return
	}
Sietse Ringers's avatar
Sietse Ringers committed
142
143
144
145
146
147
148
149
	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) {
150
	exists, err := PathExists(cm.path(skFile))
Sietse Ringers's avatar
Sietse Ringers committed
151
152
153
154
	if err != nil {
		return nil, err
	}
	if exists {
155
156
157
		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
158
		}
159
		return nil, err
Sietse Ringers's avatar
Sietse Ringers committed
160
	}
161
162
163
164
165
166
167
168
169
170

	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
171
172
}

173
174
func (cm *CredentialManager) loadAttributes() (list map[CredentialTypeIdentifier][]*AttributeList, err error) {
	list = make(map[CredentialTypeIdentifier][]*AttributeList)
175
	temp := make(map[string][]*AttributeList)
Sietse Ringers's avatar
Sietse Ringers committed
176

177
	exists, err := PathExists(cm.path(attributesFile))
Sietse Ringers's avatar
Sietse Ringers committed
178
179
180
181
182
183
184
185
	if err != nil || !exists {
		return
	}

	bytes, err := ioutil.ReadFile(cm.path(attributesFile))
	if err != nil {
		return nil, err
	}
186
187
188
189
	err = json.Unmarshal(bytes, &temp)
	if err != nil {
		return nil, err
	}
Sietse Ringers's avatar
Sietse Ringers committed
190

191
	for credid, attrs := range temp {
192
		list[NewCredentialTypeIdentifier(credid)] = attrs
193
194
	}
	return list, nil
Sietse Ringers's avatar
Sietse Ringers committed
195
}