-
Notifications
You must be signed in to change notification settings - Fork 15
/
boltuserdb.go
331 lines (278 loc) · 7.2 KB
/
boltuserdb.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
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
// boltuserdb.go - BoltDB backed Katzenpost server user database.
// Copyright (C) 2017 Yawning Angel.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
// Package boltuserdb implements the Katzenpost server user database with a
// simple boltdb based backend.
package boltuserdb
import (
"crypto/subtle"
"errors"
"fmt"
"sync"
bolt "go.etcd.io/bbolt"
"github.com/katzenpost/hpqc/kem"
"github.com/katzenpost/hpqc/kem/pem"
"github.com/katzenpost/katzenpost/server/userdb"
)
const (
usersBucket = "users"
identitiesBucket = "identities"
)
type BoltUserDBOption func(*boltUserDB)
func WithTrustOnFirstUse() BoltUserDBOption {
return func(db *boltUserDB) {
db.trustOnFirstUse = true
}
}
type boltUserDB struct {
sync.RWMutex
db *bolt.DB
userCache map[[userdb.MaxUsernameSize]byte]bool
trustOnFirstUse bool
scheme kem.Scheme
}
func (d *boltUserDB) Exists(u []byte) bool {
if !userOk(u) {
return false
}
k := userToCacheKey(u)
d.RLock()
defer d.RUnlock()
return d.userCache[k]
}
func (d *boltUserDB) IsValid(u []byte, k kem.PublicKey) bool {
if !userOk(u) {
return false
}
// Query the database to see if the user is present, and if the public
// keys match.
isValid := false
tofuUser := false
if err := d.db.View(func(tx *bolt.Tx) error {
bkt := tx.Bucket([]byte(usersBucket))
// If the user exists in the `users` bucket, then compare public keys.
rawPubKey := bkt.Get(u)
if rawPubKey == nil {
if d.trustOnFirstUse == true {
tofuUser = true
} else {
return errors.New("user does not exist")
}
} else {
kblob, err := k.MarshalBinary()
if err != nil {
panic(err)
}
isValid = subtle.ConstantTimeCompare(rawPubKey, kblob) == 1
if isValid {
return nil
} else {
return errors.New("public keys don't match")
}
}
return nil
}); err != nil {
return false
}
if tofuUser {
if err := d.Add(u, k, false); err != nil {
return false
}
}
return true
}
func (d *boltUserDB) Add(u []byte, k kem.PublicKey, update bool) error {
if !userOk(u) {
return fmt.Errorf("userdb: invalid username: `%v`", u)
}
if k == nil {
return fmt.Errorf("userdb: must provide a public key")
}
switch d.Exists(u) {
case true:
if !update {
return fmt.Errorf("userdb: user already exists")
}
case false:
if update {
return userdb.ErrNoSuchUser
}
}
kblob, err := k.MarshalBinary()
if err != nil {
return err
}
err = d.db.Update(func(tx *bolt.Tx) error {
bkt := tx.Bucket([]byte(usersBucket))
return bkt.Put(u, kblob)
})
if err == nil {
k := userToCacheKey(u)
d.Lock()
defer d.Unlock()
d.userCache[k] = true
}
return err
}
func (d *boltUserDB) SetIdentity(u []byte, k kem.PublicKey) error {
if !userOk(u) {
return fmt.Errorf("userdb: invalid username: `%v`", u)
}
return d.db.Update(func(tx *bolt.Tx) error {
uBkt := tx.Bucket([]byte(usersBucket))
if uEnt := uBkt.Get(u); uEnt == nil {
return userdb.ErrNoSuchUser
}
iBkt := tx.Bucket([]byte(identitiesBucket))
if k == nil {
return iBkt.Delete(u)
}
kblob, err := k.MarshalBinary()
if err != nil {
return err
}
return iBkt.Put(u, kblob)
})
}
func (d *boltUserDB) Link(u []byte) (kem.PublicKey, error) {
if !userOk(u) {
return nil, fmt.Errorf("userdb: invalid username: `%v`", u)
}
if !d.Exists(u) {
return nil, fmt.Errorf("userdb: user does not exist")
}
var pubKey kem.PublicKey
err := d.db.View(func(tx *bolt.Tx) error {
bkt := tx.Bucket([]byte(usersBucket))
rawPubKey := bkt.Get(u)
if rawPubKey == nil {
return fmt.Errorf("userdb: user %s does not have a link key", u)
}
var err error
pubKey, err = d.scheme.UnmarshalBinaryPublicKey(rawPubKey)
return err
})
return pubKey, err
}
func (d *boltUserDB) Identity(u []byte) (kem.PublicKey, error) {
if !userOk(u) {
return nil, fmt.Errorf("userdb: invalid username: `%v`", u)
}
pubKey, _, err := d.scheme.GenerateKeyPair()
if err != nil {
return nil, err
}
err = d.db.View(func(tx *bolt.Tx) error {
uBkt := tx.Bucket([]byte(usersBucket))
if uEnt := uBkt.Get(u); uEnt == nil {
return userdb.ErrNoSuchUser
}
iBkt := tx.Bucket([]byte(identitiesBucket))
rawPubKey := iBkt.Get(u)
if rawPubKey == nil {
return userdb.ErrNoIdentity
}
pubKey, err = pem.FromPublicPEMString(string(rawPubKey), d.scheme)
return err
})
return pubKey, err
}
func (d *boltUserDB) Remove(u []byte) error {
if !userOk(u) {
return fmt.Errorf("userdb: invalid username: `%v`", u)
}
err := d.db.Update(func(tx *bolt.Tx) error {
bkt := tx.Bucket([]byte(usersBucket))
// Delete the user's entry iff it exists.
if ent := bkt.Get(u); ent == nil {
return userdb.ErrNoSuchUser
}
return bkt.Delete(u)
})
if err == nil {
k := userToCacheKey(u)
d.Lock()
defer d.Unlock()
delete(d.userCache, k)
}
return err
}
func (d *boltUserDB) Close() {
d.db.Sync()
d.db.Close()
}
// New creates (or loads) a user database with the given file name f.
func New(f string, kemscheme kem.Scheme, opts ...BoltUserDBOption) (userdb.UserDB, error) {
const (
metadataBucket = "metadata"
versionKey = "version"
)
var err error
d := new(boltUserDB)
for _, opt := range opts {
opt(d)
}
d.scheme = kemscheme
d.db, err = bolt.Open(f, 0600, nil)
if err != nil {
return nil, err
}
d.userCache = make(map[[userdb.MaxUsernameSize]byte]bool)
if err = d.db.Update(func(tx *bolt.Tx) error {
// Ensure that all the buckets exists, and grab the metadata bucket.
bkt, err := tx.CreateBucketIfNotExists([]byte(metadataBucket))
if err != nil {
return err
}
uBkt, err := tx.CreateBucketIfNotExists([]byte(usersBucket))
if err != nil {
return err
}
if _, err = tx.CreateBucketIfNotExists([]byte(identitiesBucket)); err != nil {
return err
}
if b := bkt.Get([]byte(versionKey)); b != nil {
// Well it looks like we loaded as opposed to created.
if len(b) != 1 || b[0] != 0 {
return fmt.Errorf("userdb: incompatible version: %d", uint(b[0]))
}
// Populate the user cache.
uBkt.ForEach(func(k, v []byte) error {
u := userToCacheKey(k)
d.userCache[u] = true
return nil
})
return nil
}
// We created a new database, so populate the new `metadata` bucket.
return bkt.Put([]byte(versionKey), []byte{0})
}); err != nil {
// The struct isn't getting returned so clean up the database.
err2 := d.db.Close()
if err2 != nil {
return nil, fmt.Errorf("when closing db after %v: %v", err, err2)
}
return nil, err
}
return d, nil
}
func userToCacheKey(u []byte) [userdb.MaxUsernameSize]byte {
var k [userdb.MaxUsernameSize]byte
copy(k[:], u)
return k
}
func userOk(u []byte) bool {
return len(u) > 0 || len(u) <= userdb.MaxUsernameSize
}