revocation.go 12.1 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
	// (RevocationRecord instances, and IssuanceRecord instances if used by an issuer).
20 21 22
	DB struct {
		Current  revocation.Accumulator
		Updated  time.Time
23
		onChange []func(*RevocationRecord)
24
		bolt     *bolthold.Store
25
		keystore keystore
26 27 28 29 30 31 32
	}

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

33 34 35 36
	// RevocationRecord contains a signed AccumulatorUpdate and associated information and is ued
	// by clients, issuers and verifiers to update their revocation state, so that they can create
	// and verify nonrevocation proofs and witnesses.
	RevocationRecord struct {
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
		StartIndex     uint64
		EndIndex       uint64
		PublicKeyIndex uint
		Message        signed.Message // signed revocation.AccumulatorUpdate
	}

	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
	}
60 61 62

	// keystore provides support for revocation public key rollover.
	keystore func(counter uint) (*revocation.PublicKey, error)
63 64 65 66 67 68 69 70 71 72 73 74
)

const boltCurrentIndexKey = "currentIndex"

func (rdb *DB) EnableRevocation(sk *revocation.PrivateKey) error {
	msg, acc, err := revocation.NewAccumulator(sk)
	if err != nil {
		return err
	}
	if err = rdb.Add(msg, sk.Counter); err != nil {
		return err
	}
75
	rdb.Current = *acc
76
	rdb.Updated = time.Now()
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
	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.
101 102
func (rdb *DB) RevocationRecords(index int) ([]*RevocationRecord, error) {
	var records []*RevocationRecord
103 104 105 106 107 108
	if err := rdb.bolt.Find(&records, bolthold.Where(bolthold.Key).Ge(uint64(index))); err != nil {
		return nil, err
	}
	return records, nil
}

109
func (rdb *DB) LatestRecords(count int) ([]*RevocationRecord, error) {
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
	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
}

141
func (rdb *DB) AddRecords(records []*RevocationRecord) error {
142 143 144 145 146 147 148 149 150 151 152 153 154 155
	var err error
	for _, r := range records {
		if err = rdb.Add(r.Message, r.PublicKeyIndex); err != nil {
			return err
		}
	}
	rdb.Updated = time.Now() // TODO update this in add()?
	return nil
}

func (rdb *DB) Add(updateMsg signed.Message, counter uint) error {
	var err error
	var update revocation.AccumulatorUpdate

156
	pk, err := rdb.keystore(counter)
157 158 159 160 161 162 163 164 165 166 167 168 169 170 171
	if err != nil {
		return err
	}

	if err = signed.UnmarshalVerify(pk.ECDSA, updateMsg, &update); err != nil {
		return err
	}

	return rdb.bolt.Bolt().Update(func(tx *bolt.Tx) error {
		return rdb.add(update, updateMsg, counter, tx)
	})
}

func (rdb *DB) add(update revocation.AccumulatorUpdate, updateMsg signed.Message, pkCounter uint, tx *bolt.Tx) error {
	var err error
172
	record := &RevocationRecord{
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
		StartIndex:     update.StartIndex,
		EndIndex:       update.Accumulator.Index,
		PublicKeyIndex: pkCounter,
		Message:        updateMsg,
	}
	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)
	}

	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
	}

224
	var record RevocationRecord
225 226 227
	if err := rdb.bolt.Get(currentIndex.Index, &record); err != nil {
		return err
	}
228
	pk, err := rdb.keystore(record.PublicKeyIndex)
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
	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
	}
	update := revocation.AccumulatorUpdate{
		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
	}
	if err = rdb.add(update, updateMsg, sk.Counter, tx); err != nil {
		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
}

277
func (rdb *DB) OnChange(handler func(*RevocationRecord)) {
278 279 280
	rdb.onChange = append(rdb.onChange, handler)
}

281 282
func (r *RevocationRecord) UnmarshalVerify(keystore keystore) (*revocation.AccumulatorUpdate, error) {
	pk, err := keystore(r.PublicKeyIndex)
283 284 285 286 287 288 289 290 291 292 293 294 295 296
	if err != nil {
		return nil, err
	}
	msg := &revocation.AccumulatorUpdate{}
	if err := signed.UnmarshalVerify(pk.ECDSA, r.Message, msg); err != nil {
		return nil, err
	}
	if (r.StartIndex != msg.StartIndex) ||
		(r.EndIndex > 0 && r.EndIndex != msg.StartIndex+uint64(len(msg.Revoked))-1) {
		return nil, errors.New("record has invalid start or end index")
	}
	return msg, nil
}

297
func (rs *RevocationStorage) loadDB(credid CredentialTypeIdentifier) (*DB, error) {
298
	path := filepath.Join(rs.conf.RevocationPath, credid.String())
299
	keystore := rs.keystore(credid.IssuerIdentifier())
300 301 302 303 304 305 306 307

	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,
308
		Updated:  time.Unix(0, 0),
309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333
	}
	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
}

334 335
func (rs *RevocationStorage) GetUpdates(credid CredentialTypeIdentifier, index uint64) ([]*RevocationRecord, error) {
	var records []*RevocationRecord
336
	err := NewHTTPTransport(rs.conf.CredentialTypes[credid].RevocationServer).
337 338 339 340 341 342 343
		Get(fmt.Sprintf("-/revocation/records/%s/%d", credid, index), &records)
	if err != nil {
		return nil, err
	}
	return records, nil
}

344
func (rs *RevocationStorage) UpdateAll() error {
345
	var err error
346
	for credid := range rs.dbs {
347
		if err = rs.UpdateDB(credid); err != nil {
348 349 350 351 352 353
			return err
		}
	}
	return nil
}

354
func (rs *RevocationStorage) SetRecords(b *BaseRequest) error {
355 356 357
	if len(b.Revocation) == 0 {
		return nil
	}
358
	b.RevocationUpdates = make(map[CredentialTypeIdentifier][]*RevocationRecord, len(b.Revocation))
359
	for _, credid := range b.Revocation {
360
		db, err := rs.DB(credid)
361 362 363
		if err != nil {
			return err
		}
364
		if err = rs.updateDelayed(credid, db); err != nil {
365 366 367 368 369 370 371 372 373 374
			return err
		}
		b.RevocationUpdates[credid], err = db.LatestRecords(revocationUpdateCount)
		if err != nil {
			return err
		}
	}
	return nil
}

375 376
func (rs *RevocationStorage) UpdateDB(credid CredentialTypeIdentifier) error {
	db, err := rs.DB(credid)
377 378 379 380 381 382 383
	if err != nil {
		return err
	}
	var index uint64
	if db.Enabled() {
		index = db.Current.Index + 1
	}
384
	records, err := rs.GetUpdates(credid, index)
385 386 387 388 389 390
	if err != nil {
		return err
	}
	return db.AddRecords(records)
}

391
func (rs *RevocationStorage) DB(credid CredentialTypeIdentifier) (*DB, error) {
392
	if _, known := rs.conf.CredentialTypes[credid]; !known {
393 394
		return nil, errors.New("unknown credential type")
	}
395 396
	if rs.dbs == nil {
		rs.dbs = make(map[CredentialTypeIdentifier]*DB)
397
	}
398
	if rs.dbs[credid] == nil {
399
		var err error
400
		db, err := rs.loadDB(credid)
401 402 403
		if err != nil {
			return nil, err
		}
404
		rs.dbs[credid] = db
405
	}
406
	return rs.dbs[credid], nil
407 408
}

409
func (rs *RevocationStorage) updateDelayed(credid CredentialTypeIdentifier, db *DB) error {
410
	if db.Updated.Before(time.Now().Add(-5 * time.Minute)) {
411
		if err := rs.UpdateDB(credid); err != nil {
412 413 414 415 416 417
			return err
		}
	}
	return nil
}

418
func (rs *RevocationStorage) SendIssuanceRecord(cred CredentialTypeIdentifier, rec *IssuanceRecord) error {
419
	credtype := rs.conf.CredentialTypes[cred]
420 421 422 423 424 425
	if credtype == nil {
		return errors.New("unknown credential type")
	}
	if credtype.RevocationServer == "" {
		return errors.New("credential type has no revocation server")
	}
426
	sk, err := rs.conf.PrivateKey(cred.IssuerIdentifier())
427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446
	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),
	)
}

447 448
func (rs *RevocationStorage) Revoke(credid CredentialTypeIdentifier, key string) error {
	sk, err := rs.conf.PrivateKey(credid.IssuerIdentifier())
449 450 451 452 453 454 455 456 457 458 459
	if err != nil {
		return err
	}
	if sk == nil {
		return errors.New("private key not found")
	}
	rsk, err := sk.RevocationKey()
	if err != nil {
		return err
	}

460
	db, err := rs.DB(credid)
461 462 463 464 465 466
	if err != nil {
		return err
	}
	return db.Revoke(rsk, []byte(key))
}

467
func (rs *RevocationStorage) Close() error {
468 469
	merr := &multierror.Error{}
	var err error
470
	for _, db := range rs.dbs {
471 472 473 474
		if err = db.Close(); err != nil {
			merr = multierror.Append(merr, err)
		}
	}
475
	rs.dbs = nil
476 477
	return merr.ErrorOrNil()
}
478 479 480

func (rs *RevocationStorage) keystore(issuerid IssuerIdentifier) keystore {
	return func(counter uint) (*revocation.PublicKey, error) {
481
		return rs.PublicKey(issuerid, counter)
482 483
	}
}