updates.go 5.64 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
38
	func(client *Client) error {
		conf := client.Configuration
39
40
41
		if len(conf.DisabledSchemeManagers) > 0 {
			return conf.CopyFromAssets(true)
		}
42
43
44
		for manager := range conf.SchemeManagers {
			valid, err := conf.VerifySignature(manager)
			if err != nil || !valid {
45
				return conf.CopyFromAssets(true)
46
47
48
49
			}
		}
		return nil
	},
50
51

	// Rename config -> preferences
52
53
54
55
56
	func(client *Client) (err error) {
		exists, err := fs.PathExists(client.storage.path("config"))
		if !exists || err != nil {
			return
		}
57
58
59
60
		oldStruct := &struct {
			SendCrashReports bool
		}{}
		// Load old file, convert to new struct, and save
61
		err = client.storage.load(oldStruct, "config")
62
63
64
65
66
67
68
69
		if err != nil {
			return err
		}
		client.Preferences = Preferences{
			EnableCrashReporting: oldStruct.SendCrashReports,
		}
		return client.storage.StorePreferences(client.Preferences)
	},
70
}
71

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

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

103
104
105
106
107
	storeErr := client.storage.StoreUpdates(client.updates)
	if storeErr != nil {
		return storeErr
	}
	return err
108
109
}

Sietse Ringers's avatar
Sietse Ringers committed
110
111
112
113
// 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.
114
115
func (client *Client) ParseAndroidStorage() (present bool, err error) {
	if client.androidStoragePath == "" {
116
117
118
		return false, nil
	}

119
	cardemuXML := client.androidStoragePath + "/shared_prefs/cardemu.xml"
120
	present, err = fs.PathExists(cardemuXML)
121
	if err != nil || !present {
Sietse Ringers's avatar
Sietse Ringers committed
122
123
		return
	}
124
	present = true
Sietse Ringers's avatar
Sietse Ringers committed
125

126
	bytes, err := ioutil.ReadFile(cardemuXML)
Sietse Ringers's avatar
Sietse Ringers committed
127
128
129
130
131
132
133
134
135
	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
136
137
138
	if err = xml.Unmarshal(bytes, &parsedxml); err != nil {
		return
	}
Sietse Ringers's avatar
Sietse Ringers committed
139
140
141
142
143
144
145

	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"`
	})
146
	client.keyshareServers = make(map[irma.SchemeManagerIdentifier]*keyshareServer)
Sietse Ringers's avatar
Sietse Ringers committed
147
148
149
150
151
152
153
154
155
	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)
156
			if err = json.Unmarshal([]byte(jsontag), &client.keyshareServers); err != nil {
Sietse Ringers's avatar
Sietse Ringers committed
157
158
159
160
161
162
163
164
165
				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
			}
166
			client.paillierKeyCache = keys[0]
Sietse Ringers's avatar
Sietse Ringers committed
167
168
169
170
		}
	}

	for _, list := range parsedjson {
171
		client.secretkey = &secretKey{Key: list[0].Attributes[0]}
Sietse Ringers's avatar
Sietse Ringers committed
172
173
174
175
176
177
178
179
		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]
			}
180
			var cred *credential
181
			if cred, err = newCredential(gabicred, client.Configuration); err != nil {
182
				return
183
			}
Sietse Ringers's avatar
Sietse Ringers committed
184
			if cred.CredentialType() == nil {
185
186
				err = errors.New("cannot add unknown credential type")
				return
Sietse Ringers's avatar
Sietse Ringers committed
187
188
			}

189
			if err = client.addCredential(cred, false); err != nil {
190
				return
Sietse Ringers's avatar
Sietse Ringers committed
191
192
193
194
			}
		}
	}

195
196
	if len(client.credentials) > 0 {
		if err = client.storage.StoreAttributes(client.attributes); err != nil {
197
			return
Sietse Ringers's avatar
Sietse Ringers committed
198
		}
199
		if err = client.storage.StoreSecretKey(client.secretkey); err != nil {
200
			return
Sietse Ringers's avatar
Sietse Ringers committed
201
202
203
		}
	}

204
205
	if len(client.keyshareServers) > 0 {
		if err = client.storage.StoreKeyshareServers(client.keyshareServers); err != nil {
206
			return
Sietse Ringers's avatar
Sietse Ringers committed
207
208
		}
	}
209
	client.UnenrolledSchemeManagers = client.unenrolledSchemeManagers()
Sietse Ringers's avatar
Sietse Ringers committed
210

211
	if err = client.storage.StorePaillierKeys(client.paillierKeyCache); err != nil {
212
		return
Sietse Ringers's avatar
Sietse Ringers committed
213
	}
214
215
	if client.paillierKeyCache == nil {
		client.paillierKey(false) // trigger calculating a new one
Sietse Ringers's avatar
Sietse Ringers committed
216
	}
217
	return
Sietse Ringers's avatar
Sietse Ringers committed
218
}