revocation.go 10.9 KB
Newer Older
1
2
3
4
5
6
7
8
9
package irma

import (
	"fmt"
	"path/filepath"
	"time"

	"github.com/go-errors/errors"
	"github.com/hashicorp/go-multierror"
10
	"github.com/privacybydesign/gabi/big"
11
	"github.com/privacybydesign/gabi/revocation"
12
	"github.com/privacybydesign/gabi/signed"
13
14
	"github.com/timshannon/bolthold"
	bolt "go.etcd.io/bbolt"
15
16
)

17
18
type (
	// DB is a bolthold database storing revocation state for a particular accumulator
19
	// (Record instances, and IssuanceRecord instances if used by an issuer).
20
21
22
	DB struct {
		Current  revocation.Accumulator
		Updated  time.Time
23
		onChange []func(*revocation.Record)
24
		bolt     *bolthold.Store
25
		keystore revocation.Keystore
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
	}

	RevocationStorage struct {
		dbs  map[CredentialTypeIdentifier]*DB
		conf *Configuration
	}

	TimeRecord struct {
		Index      uint64
		Start, End int64
	}

	// IssuanceRecord contains information generated during issuance, needed for later revocation.
	IssuanceRecord struct {
		Key        string
		Attr       *big.Int
		Issued     int64
		ValidUntil int64
		RevokedAt  int64 // 0 if not currently revoked
	}

	currentRecord struct {
		Index uint64
	}
)

const boltCurrentIndexKey = "currentIndex"

func (rdb *DB) EnableRevocation(sk *revocation.PrivateKey) error {
	msg, acc, err := revocation.NewAccumulator(sk)
	if err != nil {
		return err
	}
59
60
61
62
	if err = rdb.Add(&revocation.Record{
		PublicKeyIndex: sk.Counter,
		Message:        msg,
	}); err != nil {
63
64
		return err
	}
65
	rdb.Current = *acc
66
	rdb.Updated = time.Now()
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
	return nil
}

// Revoke revokes the credential specified specified by key if found within the current database,
// by updating its revocation time to now, adding its revocation attribute to the current accumulator,
// and updating the revocation database on disk.
func (rdb *DB) Revoke(sk *revocation.PrivateKey, key []byte) error {
	return rdb.bolt.Bolt().Update(func(tx *bolt.Tx) error {
		var err error
		cr := IssuanceRecord{}
		if err = rdb.bolt.TxGet(tx, key, &cr); err != nil {
			return err
		}
		cr.RevokedAt = time.Now().UnixNano()
		if err = rdb.bolt.TxUpdate(tx, key, &cr); err != nil {
			return err
		}
		return rdb.revokeAttr(sk, cr.Attr, tx)
	})
}

// Get returns all records that a client requires to update its revocation state if it is currently
// at the specified index, that is, all records whose end index is greater than or equal to
// the specified index.
91
92
func (rdb *DB) RevocationRecords(index int) ([]*revocation.Record, error) {
	var records []*revocation.Record
93
94
95
96
97
98
	if err := rdb.bolt.Find(&records, bolthold.Where(bolthold.Key).Ge(uint64(index))); err != nil {
		return nil, err
	}
	return records, nil
}

99
func (rdb *DB) LatestRecords(count int) ([]*revocation.Record, error) {
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
	c := int(rdb.Current.Index) - count + 1
	if c < 0 {
		c = 0
	}
	return rdb.RevocationRecords(c)
}

func (rdb *DB) IssuanceRecordExists(key []byte) (bool, error) {
	_, err := rdb.IssuanceRecord(key)
	switch err {
	case nil:
		return true, nil
	case bolthold.ErrNotFound:
		return false, nil
	default:
		return false, err
	}
}

func (rdb *DB) AddIssuanceRecord(r *IssuanceRecord) error {
	return rdb.bolt.Insert([]byte(r.Key), r)
}

func (rdb *DB) IssuanceRecord(key []byte) (*IssuanceRecord, error) {
	r := &IssuanceRecord{}
	if err := rdb.bolt.Get(key, r); err != nil {
		return nil, err
	}
	return r, nil
}

131
func (rdb *DB) AddRecords(records []*revocation.Record) error {
132
133
	var err error
	for _, r := range records {
134
		if err = rdb.Add(r); err != nil {
135
136
137
138
139
140
			return err
		}
	}
	return nil
}

141
142
143
144
145
func (rdb *DB) Add(record *revocation.Record) error {
	return rdb.bolt.Bolt().Update(func(tx *bolt.Tx) error {
		return rdb.add(record, tx)
	})
}
146

147
148
func (rdb *DB) add(record *revocation.Record, tx *bolt.Tx) error {
	pk, err := rdb.keystore(record.PublicKeyIndex)
149
150
151
	if err != nil {
		return err
	}
152
153
	update, err := record.UnmarshalVerify(pk)
	if err != nil {
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
		return err
	}

	if err = rdb.bolt.TxInsert(tx, update.Accumulator.Index, record); err != nil {
		return err
	}

	if update.Accumulator.Index != 0 {
		var tr TimeRecord
		if err = rdb.bolt.TxGet(tx, update.Accumulator.Index-1, &tr); err == nil {
			tr.End = time.Now().UnixNano()
			if err = rdb.bolt.TxUpdate(tx, update.Accumulator.Index-1, &tr); err != nil {
				return err
			}
		}
	}
	if err = rdb.bolt.TxInsert(tx, update.Accumulator.Index, &TimeRecord{
		Index: update.Accumulator.Index,
		Start: time.Now().UnixNano(),
	}); err != nil {
		return err
	}

	if err = rdb.bolt.TxUpsert(tx, boltCurrentIndexKey, &currentRecord{update.Accumulator.Index}); err != nil {
		return err
	}

	for _, f := range rdb.onChange {
		f(record)
	}

185
	rdb.Updated = time.Now()
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
	rdb.Current = update.Accumulator
	return nil
}

func (rdb *DB) Enabled() bool {
	var currentIndex currentRecord
	err := rdb.bolt.Get(boltCurrentIndexKey, &currentIndex)
	return err == nil
}

func (rdb *DB) loadCurrent() error {
	var currentIndex currentRecord
	if err := rdb.bolt.Get(boltCurrentIndexKey, &currentIndex); err == bolthold.ErrNotFound {
		return errors.New("revocation database not initialized")
	} else if err != nil {
		return err
	}

204
	var record revocation.Record
205
206
207
	if err := rdb.bolt.Get(currentIndex.Index, &record); err != nil {
		return err
	}
208
	pk, err := rdb.keystore(record.PublicKeyIndex)
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
	if err != nil {
		return err
	}
	var u revocation.AccumulatorUpdate
	if err = signed.UnmarshalVerify(pk.ECDSA, record.Message, &u); err != nil {
		return err
	}
	rdb.Current = u.Accumulator
	return nil
}

func (rdb *DB) RevokeAttr(sk *revocation.PrivateKey, e *big.Int) error {
	return rdb.bolt.Bolt().Update(func(tx *bolt.Tx) error {
		return rdb.revokeAttr(sk, e, tx)
	})
}

func (rdb *DB) revokeAttr(sk *revocation.PrivateKey, e *big.Int, tx *bolt.Tx) error {
	// don't update rdb.Current until after all possible errors are handled
	newAcc, err := rdb.Current.Remove(sk, e)
	if err != nil {
		return err
	}
232
	update := &revocation.AccumulatorUpdate{
233
234
235
236
237
238
239
240
241
		Accumulator: *newAcc,
		StartIndex:  newAcc.Index,
		Revoked:     []*big.Int{e},
		Time:        time.Now().UnixNano(),
	}
	updateMsg, err := signed.MarshalSign(sk.ECDSA, update)
	if err != nil {
		return err
	}
242
243
244
245
246
247
	if err = rdb.add(&revocation.Record{
		StartIndex:     newAcc.Index,
		EndIndex:       newAcc.Index,
		PublicKeyIndex: sk.Counter,
		Message:        updateMsg,
	}, tx); err != nil {
248
249
250
251
252
253
254
255
256
257
258
259
260
261
		return err
	}
	rdb.Current = *newAcc
	return nil
}

func (rdb *DB) Close() error {
	rdb.onChange = nil
	if rdb.bolt != nil {
		return rdb.bolt.Close()
	}
	return nil
}

262
func (rdb *DB) OnChange(handler func(*revocation.Record)) {
263
264
265
	rdb.onChange = append(rdb.onChange, handler)
}

266
func (rs *RevocationStorage) loadDB(credid CredentialTypeIdentifier) (*DB, error) {
267
	path := filepath.Join(rs.conf.RevocationPath, credid.String())
268
	keystore := rs.Keystore(credid.IssuerIdentifier())
269
270
271
272
273
274
275
276

	b, err := bolthold.Open(path, 0600, &bolthold.Options{Options: &bolt.Options{Timeout: 1 * time.Second}})
	if err != nil {
		return nil, err
	}
	db := &DB{
		bolt:     b,
		keystore: keystore,
277
		Updated:  time.Unix(0, 0),
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
	}
	if db.Enabled() {
		if err = db.loadCurrent(); err != nil {
			_ = db.Close()
			return nil, err
		}
	}
	return db, nil
}

func (rs *RevocationStorage) PublicKey(issid IssuerIdentifier, counter uint) (*revocation.PublicKey, error) {
	pk, err := rs.conf.PublicKey(issid, int(counter))
	if err != nil {
		return nil, err
	}
	if pk == nil {
		return nil, errors.Errorf("unknown public key: %s-%d", issid, counter)
	}
	revpk, err := pk.RevocationKey()
	if err != nil {
		return nil, err
	}
	return revpk, nil
}

303
304
func (rs *RevocationStorage) GetUpdates(credid CredentialTypeIdentifier, index uint64) ([]*revocation.Record, error) {
	var records []*revocation.Record
305
	err := NewHTTPTransport(rs.conf.CredentialTypes[credid].RevocationServer).
306
307
308
309
310
311
312
		Get(fmt.Sprintf("-/revocation/records/%s/%d", credid, index), &records)
	if err != nil {
		return nil, err
	}
	return records, nil
}

313
func (rs *RevocationStorage) UpdateAll() error {
314
	var err error
315
	for credid := range rs.dbs {
316
		if err = rs.UpdateDB(credid); err != nil {
317
318
319
320
321
322
			return err
		}
	}
	return nil
}

323
func (rs *RevocationStorage) SetRecords(b *BaseRequest) error {
324
325
326
	if len(b.Revocation) == 0 {
		return nil
	}
327
	b.RevocationUpdates = make(map[CredentialTypeIdentifier][]*revocation.Record, len(b.Revocation))
328
	for _, credid := range b.Revocation {
329
		db, err := rs.DB(credid)
330
331
332
		if err != nil {
			return err
		}
333
		if err = rs.updateDelayed(credid, db); err != nil {
334
335
336
337
338
339
340
341
342
343
			return err
		}
		b.RevocationUpdates[credid], err = db.LatestRecords(revocationUpdateCount)
		if err != nil {
			return err
		}
	}
	return nil
}

344
345
func (rs *RevocationStorage) UpdateDB(credid CredentialTypeIdentifier) error {
	db, err := rs.DB(credid)
346
347
348
349
350
351
352
	if err != nil {
		return err
	}
	var index uint64
	if db.Enabled() {
		index = db.Current.Index + 1
	}
353
	records, err := rs.GetUpdates(credid, index)
354
355
356
357
358
359
	if err != nil {
		return err
	}
	return db.AddRecords(records)
}

360
func (rs *RevocationStorage) DB(credid CredentialTypeIdentifier) (*DB, error) {
361
	if _, known := rs.conf.CredentialTypes[credid]; !known {
362
363
		return nil, errors.New("unknown credential type")
	}
364
365
	if rs.dbs == nil {
		rs.dbs = make(map[CredentialTypeIdentifier]*DB)
366
	}
367
	if rs.dbs[credid] == nil {
368
		var err error
369
		db, err := rs.loadDB(credid)
370
371
372
		if err != nil {
			return nil, err
		}
373
		rs.dbs[credid] = db
374
	}
375
	return rs.dbs[credid], nil
376
377
}

378
func (rs *RevocationStorage) updateDelayed(credid CredentialTypeIdentifier, db *DB) error {
379
	if db.Updated.Before(time.Now().Add(-5 * time.Minute)) {
380
		if err := rs.UpdateDB(credid); err != nil {
381
382
383
384
385
386
			return err
		}
	}
	return nil
}

387
func (rs *RevocationStorage) SendIssuanceRecord(cred CredentialTypeIdentifier, rec *IssuanceRecord) error {
388
	credtype := rs.conf.CredentialTypes[cred]
389
390
391
392
393
394
	if credtype == nil {
		return errors.New("unknown credential type")
	}
	if credtype.RevocationServer == "" {
		return errors.New("credential type has no revocation server")
	}
395
	sk, err := rs.conf.PrivateKey(cred.IssuerIdentifier())
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
	if err != nil {
		return err
	}
	if sk == nil {
		return errors.New("private key not found")
	}
	revsk, err := sk.RevocationKey()
	if err != nil {
		return err
	}

	message, err := signed.MarshalSign(revsk.ECDSA, rec)
	if err != nil {
		return err
	}
	return NewHTTPTransport(credtype.RevocationServer).Post(
		fmt.Sprintf("-/revocation/issuancerecord/%s/%d", cred, sk.Counter), nil, []byte(message),
	)
}

416
417
func (rs *RevocationStorage) Revoke(credid CredentialTypeIdentifier, key string) error {
	sk, err := rs.conf.PrivateKey(credid.IssuerIdentifier())
418
419
420
421
422
423
424
425
426
427
428
	if err != nil {
		return err
	}
	if sk == nil {
		return errors.New("private key not found")
	}
	rsk, err := sk.RevocationKey()
	if err != nil {
		return err
	}

429
	db, err := rs.DB(credid)
430
431
432
433
434
435
	if err != nil {
		return err
	}
	return db.Revoke(rsk, []byte(key))
}

436
func (rs *RevocationStorage) Close() error {
437
438
	merr := &multierror.Error{}
	var err error
439
	for _, db := range rs.dbs {
440
441
442
443
		if err = db.Close(); err != nil {
			merr = multierror.Append(merr, err)
		}
	}
444
	rs.dbs = nil
445
446
	return merr.ErrorOrNil()
}
447

448
func (rs *RevocationStorage) Keystore(issuerid IssuerIdentifier) revocation.Keystore {
449
	return func(counter uint) (*revocation.PublicKey, error) {
450
		return rs.PublicKey(issuerid, counter)
451
452
	}
}