updates.go 5.92 KB
Newer Older
1
package irmaclient
Sietse Ringers's avatar
Sietse Ringers committed
2
3
4
5
6
7
8

import (
	"encoding/json"
	"encoding/xml"
	"html"
	"io/ioutil"
	"math/big"
9
	"time"
Sietse Ringers's avatar
Sietse Ringers committed
10

Sietse Ringers's avatar
Sietse Ringers committed
11
	"github.com/go-errors/errors"
Sietse Ringers's avatar
Sietse Ringers committed
12
	"github.com/mhe/gabi"
13
14
	"github.com/privacybydesign/irmago"
	"github.com/privacybydesign/irmago/internal/fs"
Sietse Ringers's avatar
Sietse Ringers committed
15
16
)

17
// This file contains the update mechanism for Client
Sietse Ringers's avatar
Sietse Ringers committed
18
19
// as well as updates themselves.

20
type update struct {
21
	When    irma.Timestamp
22
23
24
	Number  int
	Success bool
	Error   *string
25
26
}

27
var clientUpdates = []func(client *Client) error{
28
	// Convert old cardemu.xml Android storage to our own storage format
29
30
	func(client *Client) error {
		_, err := client.ParseAndroidStorage()
31
32
		return err
	},
33
34
35
36

	// Adding scheme manager index, signature and public key
	// Check the signatures of all scheme managers, if any is not ok,
	// copy the entire irma_configuration folder from assets
37
	nil, // made irrelevant by irma_configuration-autocopying
38
39

	// Rename config -> preferences
40
41
42
43
44
	func(client *Client) (err error) {
		exists, err := fs.PathExists(client.storage.path("config"))
		if !exists || err != nil {
			return
		}
45
46
47
48
		oldStruct := &struct {
			SendCrashReports bool
		}{}
		// Load old file, convert to new struct, and save
49
		err = client.storage.load(oldStruct, "config")
50
51
52
53
54
55
56
57
		if err != nil {
			return err
		}
		client.Preferences = Preferences{
			EnableCrashReporting: oldStruct.SendCrashReports,
		}
		return client.storage.StorePreferences(client.Preferences)
	},
58
59

	// Copy new irma_configuration out of assets
60
	nil, // made irrelevant by irma_configuration-autocopying
61

62
63
	// For each keyshare server, include in its struct the identifier of its scheme manager
	func(client *Client) (err error) {
64
65
66
67
68
		keyshareServers, err := client.storage.LoadKeyshareServers()
		if err != nil {
			return err
		}
		for smi, kss := range keyshareServers {
69
70
			kss.SchemeManagerIdentifier = smi
		}
71
		return client.storage.StoreKeyshareServers(keyshareServers)
72
	},
73

74
75
	// Remove the test scheme manager which was erroneously included in a production build
	nil, // No longer necessary, also broke many unit tests
76
}
77

78
// update performs any function from clientUpdates that has not
79
80
// already been executed in the past, keeping track of previously executed updates
// in the file at updatesFile.
81
func (client *Client) update() error {
82
83
	// Load and parse file containing info about already performed updates
	var err error
84
	if client.updates, err = client.storage.LoadUpdates(); err != nil {
85
86
87
88
		return err
	}

	// Perform all new updates
89
	for i := len(client.updates); i < len(clientUpdates); i++ {
90
91
92
		err = nil
		if clientUpdates[i] != nil {
			err = clientUpdates[i](client)
93
		}
Sietse Ringers's avatar
Sietse Ringers committed
94
		u := update{
95
			When:    irma.Timestamp(time.Now()),
96
97
98
99
100
			Number:  i,
			Success: err == nil,
		}
		if err != nil {
			str := err.Error()
Sietse Ringers's avatar
Sietse Ringers committed
101
			u.Error = &str
102
		}
103
		client.updates = append(client.updates, u)
104
105
106
		if err != nil {
			break
		}
107
108
	}

109
110
111
112
113
	storeErr := client.storage.StoreUpdates(client.updates)
	if storeErr != nil {
		return storeErr
	}
	return err
114
115
}

Sietse Ringers's avatar
Sietse Ringers committed
116
117
118
119
// ParseAndroidStorage parses an Android cardemu.xml shared preferences file
// from the old Android IRMA app, parsing its credentials into the current instance,
// and saving them to storage.
// CAREFUL: this method overwrites any existing secret keys and attributes on storage.
120
121
func (client *Client) ParseAndroidStorage() (present bool, err error) {
	if client.androidStoragePath == "" {
122
123
124
		return false, nil
	}

125
	cardemuXML := client.androidStoragePath + "/shared_prefs/cardemu.xml"
126
	present, err = fs.PathExists(cardemuXML)
127
	if err != nil || !present {
Sietse Ringers's avatar
Sietse Ringers committed
128
129
		return
	}
130
	present = true
Sietse Ringers's avatar
Sietse Ringers committed
131

132
	bytes, err := ioutil.ReadFile(cardemuXML)
Sietse Ringers's avatar
Sietse Ringers committed
133
134
135
136
137
138
139
140
141
	if err != nil {
		return
	}
	parsedxml := struct {
		Strings []struct {
			Name    string `xml:"name,attr"`
			Content string `xml:",chardata"`
		} `xml:"string"`
	}{}
Sietse Ringers's avatar
Sietse Ringers committed
142
143
144
	if err = xml.Unmarshal(bytes, &parsedxml); err != nil {
		return
	}
Sietse Ringers's avatar
Sietse Ringers committed
145
146
147
148
149
150
151

	parsedjson := make(map[string][]*struct {
		Signature    *gabi.CLSignature `json:"signature"`
		Pk           *gabi.PublicKey   `json:"-"`
		Attributes   []*big.Int        `json:"attributes"`
		SharedPoints []*big.Int        `json:"public_sks"`
	})
152
	client.keyshareServers = make(map[irma.SchemeManagerIdentifier]*keyshareServer)
Sietse Ringers's avatar
Sietse Ringers committed
153
154
155
156
157
158
159
160
161
	for _, xmltag := range parsedxml.Strings {
		if xmltag.Name == "credentials" {
			jsontag := html.UnescapeString(xmltag.Content)
			if err = json.Unmarshal([]byte(jsontag), &parsedjson); err != nil {
				return
			}
		}
		if xmltag.Name == "keyshare" {
			jsontag := html.UnescapeString(xmltag.Content)
162
			if err = json.Unmarshal([]byte(jsontag), &client.keyshareServers); err != nil {
Sietse Ringers's avatar
Sietse Ringers committed
163
164
165
166
167
168
169
170
171
				return
			}
		}
		if xmltag.Name == "KeyshareKeypairs" {
			jsontag := html.UnescapeString(xmltag.Content)
			keys := make([]*paillierPrivateKey, 0, 3)
			if err = json.Unmarshal([]byte(jsontag), &keys); err != nil {
				return
			}
172
			client.paillierKeyCache = keys[0]
Sietse Ringers's avatar
Sietse Ringers committed
173
174
175
176
		}
	}

	for _, list := range parsedjson {
177
		client.secretkey = &secretKey{Key: list[0].Attributes[0]}
Sietse Ringers's avatar
Sietse Ringers committed
178
179
180
181
182
183
184
185
		for _, oldcred := range list {
			gabicred := &gabi.Credential{
				Attributes: oldcred.Attributes,
				Signature:  oldcred.Signature,
			}
			if oldcred.SharedPoints != nil && len(oldcred.SharedPoints) > 0 {
				gabicred.Signature.KeyshareP = oldcred.SharedPoints[0]
			}
186
			var cred *credential
187
			if cred, err = newCredential(gabicred, client.Configuration); err != nil {
188
				return
189
			}
Sietse Ringers's avatar
Sietse Ringers committed
190
			if cred.CredentialType() == nil {
191
192
				err = errors.New("cannot add unknown credential type")
				return
Sietse Ringers's avatar
Sietse Ringers committed
193
194
			}

195
			if err = client.addCredential(cred, false); err != nil {
196
				return
Sietse Ringers's avatar
Sietse Ringers committed
197
198
199
200
			}
		}
	}

201
202
	if len(client.credentials) > 0 {
		if err = client.storage.StoreAttributes(client.attributes); err != nil {
203
			return
Sietse Ringers's avatar
Sietse Ringers committed
204
		}
205
		if err = client.storage.StoreSecretKey(client.secretkey); err != nil {
206
			return
Sietse Ringers's avatar
Sietse Ringers committed
207
208
209
		}
	}

210
211
	if len(client.keyshareServers) > 0 {
		if err = client.storage.StoreKeyshareServers(client.keyshareServers); err != nil {
212
			return
Sietse Ringers's avatar
Sietse Ringers committed
213
214
215
		}
	}

216
	if err = client.storage.StorePaillierKeys(client.paillierKeyCache); err != nil {
217
		return
Sietse Ringers's avatar
Sietse Ringers committed
218
	}
219
220
	if client.paillierKeyCache == nil {
		client.paillierKey(false) // trigger calculating a new one
Sietse Ringers's avatar
Sietse Ringers committed
221
	}
222
	return
Sietse Ringers's avatar
Sietse Ringers committed
223
}