/
device_ek.go
276 lines (236 loc) · 8.39 KB
/
device_ek.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
package ephemeral
import (
"encoding/json"
"fmt"
"github.com/keybase/client/go/kbcrypto"
"github.com/keybase/client/go/libkb"
"github.com/keybase/client/go/protocol/keybase1"
)
type DeviceEKSeed keybase1.Bytes32
func newDeviceEphemeralSeed() (seed DeviceEKSeed, err error) {
randomSeed, err := makeNewRandomSeed()
if err != nil {
return seed, err
}
return DeviceEKSeed(randomSeed), nil
}
func (s *DeviceEKSeed) DeriveDHKey() *libkb.NaclDHKeyPair {
return deriveDHKey(keybase1.Bytes32(*s), libkb.DeriveReasonDeviceEKEncryption)
}
func postNewDeviceEK(mctx libkb.MetaContext, sig string) (err error) {
defer mctx.Trace("postNewDeviceEK", &err)()
apiArg := libkb.APIArg{
Endpoint: "user/device_ek",
SessionType: libkb.APISessionTypeREQUIRED,
Args: libkb.HTTPArgs{
"sig": libkb.S{Val: sig},
"device_id": libkb.S{Val: string(mctx.ActiveDevice().DeviceID())},
},
}
_, err = mctx.G().GetAPI().Post(mctx, apiArg)
return err
}
func serverMaxDeviceEK(mctx libkb.MetaContext, merkleRoot libkb.MerkleRoot) (maxGeneration keybase1.EkGeneration, err error) {
defer mctx.Trace("serverMaxDeviceEK", &err)()
deviceEKs, err := allDeviceEKMetadataMaybeStale(mctx, merkleRoot)
if err != nil {
return maxGeneration, err
}
deviceID := mctx.ActiveDevice().DeviceID()
metadata, ok := deviceEKs[deviceID]
if ok {
return metadata.Generation, nil
}
// We may not have an EK yet, let's try with this and fail if the server
// rejects.
mctx.Debug("No deviceEK found on the server")
return 0, nil
}
func publishNewDeviceEK(mctx libkb.MetaContext, merkleRoot libkb.MerkleRoot) (metadata keybase1.DeviceEkMetadata, err error) {
defer mctx.Trace("publishNewDeviceEK", &err)()
seed, err := newDeviceEphemeralSeed()
if err != nil {
return metadata, err
}
storage := mctx.G().GetDeviceEKStorage()
generation, err := storage.MaxGeneration(mctx, true)
if err != nil || generation < 0 {
// Let's try to get the max from the server
generation, err = serverMaxDeviceEK(mctx, merkleRoot)
if err != nil {
return metadata, err
}
}
// This is our first generation
if generation < 0 {
generation = 0
}
generation++
metadata, err = signAndPostDeviceEK(mctx, generation, seed, merkleRoot)
if err != nil {
mctx.Debug("Error posting deviceEK, retrying with server maxGeneration")
// Let's retry posting with the server given max
generation, err = serverMaxDeviceEK(mctx, merkleRoot)
if err != nil {
return metadata, err
}
generation++
metadata, err = signAndPostDeviceEK(mctx, generation, seed, merkleRoot)
if err != nil {
return metadata, err
}
}
return metadata, err
}
func signAndPostDeviceEK(mctx libkb.MetaContext, generation keybase1.EkGeneration,
seed DeviceEKSeed, merkleRoot libkb.MerkleRoot) (metadata keybase1.DeviceEkMetadata, err error) {
defer mctx.Trace("signAndPostDeviceEK", &err)()
storage := mctx.G().GetDeviceEKStorage()
// Sign the statement blob with the device's long term signing key.
signingKey, err := mctx.ActiveDevice().SigningKey()
if err != nil {
return metadata, err
}
dhKeypair := seed.DeriveDHKey()
statement, signedStatement, err := signDeviceEKStatement(generation, dhKeypair, signingKey, merkleRoot)
metadata = statement.CurrentDeviceEkMetadata
// Ensure we successfully write the secret to disk before posting to the
// server since the secret never leaves the device.
if err = storage.Put(mctx, generation, keybase1.DeviceEk{
Seed: keybase1.Bytes32(seed),
Metadata: metadata,
}); err != nil {
return metadata, err
}
err = postNewDeviceEK(mctx, signedStatement)
if err != nil {
storage.ClearCache()
serr := NewDeviceEKStorage(mctx).Delete(mctx, generation, "unable to post deviceEK: %v", err)
if serr != nil {
mctx.Debug("DeviceEK deletion failed %v", err)
}
}
return metadata, err
}
func signDeviceEKStatement(generation keybase1.EkGeneration, dhKeypair *libkb.NaclDHKeyPair, signingKey libkb.GenericKey, merkleRoot libkb.MerkleRoot) (statement keybase1.DeviceEkStatement, signedStatement string, err error) {
metadata := keybase1.DeviceEkMetadata{
Kid: dhKeypair.GetKID(),
Generation: generation,
HashMeta: merkleRoot.HashMeta(),
// The ctime is derivable from the hash meta, by fetching the hashed
// root from the server, but including it saves readers a potential
// extra round trip.
Ctime: keybase1.TimeFromSeconds(merkleRoot.Ctime()),
}
statement = keybase1.DeviceEkStatement{
CurrentDeviceEkMetadata: metadata,
}
statementJSON, err := json.Marshal(statement)
if err != nil {
return statement, signedStatement, err
}
signedStatement, _, err = signingKey.SignToString(statementJSON)
return statement, signedStatement, err
}
type deviceEKStatementResponse struct {
Sigs []string `json:"sigs"`
}
func allDeviceEKMetadataMaybeStale(mctx libkb.MetaContext, merkleRoot libkb.MerkleRoot) (metadata map[keybase1.DeviceID]keybase1.DeviceEkMetadata, err error) {
defer mctx.Trace("allDeviceEKMetadataMaybeStale", &err)()
apiArg := libkb.APIArg{
Endpoint: "user/device_eks",
SessionType: libkb.APISessionTypeREQUIRED,
Args: libkb.HTTPArgs{},
}
res, err := mctx.G().GetAPI().Get(mctx, apiArg)
if err != nil {
return nil, err
}
parsedResponse := deviceEKStatementResponse{}
err = res.Body.UnmarshalAgain(&parsedResponse)
if err != nil {
return nil, err
}
// Make a map of the user's own active devices, by KID. We'll use this to
// match deviceEK sigs with the device that issued them below. (Checking
// the signing key is intentionally the only way to do this, so that we're
// forced to check authenticity.)
getDeviceKIDs := func(force bool) (map[keybase1.KID]keybase1.PublicKey, error) {
arg := libkb.NewLoadUserArgWithMetaContext(
mctx).WithUID(mctx.ActiveDevice().UID())
if force {
arg = arg.WithForceReload()
}
self, _, err := mctx.G().GetUPAKLoader().Load(arg)
if err != nil {
return nil, err
}
kidToDevice := map[keybase1.KID]keybase1.PublicKey{}
for _, device := range self.Base.DeviceKeys {
if device.IsRevoked {
continue
}
kidToDevice[device.KID] = device
}
return kidToDevice, nil
}
kidToDevice, err := getDeviceKIDs(false)
if err != nil {
return nil, err
}
if len(kidToDevice) != len(parsedResponse.Sigs) {
mctx.Debug("mismatch of active devices in UPAK to device EK sigs (%d (upak) != %d (ek sigs), attempting force reload.", len(kidToDevice), len(parsedResponse.Sigs))
// force a reload in case we are missing a device
kidToDevice, err = getDeviceKIDs(true)
if err != nil {
return nil, err
}
mctx.Debug("%d active devices found after force reload vs %d sigs.", len(kidToDevice), len(parsedResponse.Sigs))
}
// The client now needs to verify two things about these blobs its
// received: 1) Each is validly signed. 2) The signing key belongs to one
// of the current user's devices.
metadata = map[keybase1.DeviceID]keybase1.DeviceEkMetadata{}
for _, sig := range parsedResponse.Sigs {
// Verify the sig.
signerKey, payload, _, err := kbcrypto.NaclVerifyAndExtract(sig)
if err != nil {
return nil, err
}
// Find the device that matches the signing key. This checks
// authenticity.
matchingDevice, ok := kidToDevice[signerKey.GetKID()]
if !ok {
return nil, fmt.Errorf("deviceEK returned for unknown device KID %s", signerKey.GetKID())
}
// Decode the signed JSON.
var verifiedStatement keybase1.DeviceEkStatement
err = json.Unmarshal(payload, &verifiedStatement)
if err != nil {
return nil, err
}
metadata[matchingDevice.DeviceID] = verifiedStatement.CurrentDeviceEkMetadata
}
return metadata, nil
}
// allActiveDeviceEKMetadata fetches the latest deviceEK for each of your
// devices, filtering out the ones that are stale.
func allActiveDeviceEKMetadata(mctx libkb.MetaContext, merkleRoot libkb.MerkleRoot) (metadata map[keybase1.DeviceID]keybase1.DeviceEkMetadata, err error) {
defer mctx.Trace("allActiveDeviceEKMetadata", &err)()
maybeStale, err := allDeviceEKMetadataMaybeStale(mctx, merkleRoot)
if err != nil {
return nil, err
}
active := map[keybase1.DeviceID]keybase1.DeviceEkMetadata{}
for deviceID, metadata := range maybeStale {
// Check whether the key is stale. This isn't considered an error,
// since the server doesn't do this check for us. We log these cases
// and skip them.
if ctimeIsStale(metadata.Ctime.Time(), merkleRoot) {
mctx.Debug("skipping stale deviceEK %s for device KID %s", metadata.Kid, deviceID)
continue
}
active[deviceID] = metadata
}
return active, nil
}