revocation.go 15.9 KB
Newer Older
1 2 3 4 5 6 7
package irma

import (
	"fmt"
	"time"

	"github.com/go-errors/errors"
8 9
	"github.com/jinzhu/gorm"
	_ "github.com/jinzhu/gorm/dialects/postgres"
10
	"github.com/privacybydesign/gabi/big"
11
	"github.com/privacybydesign/gabi/revocation"
12
	"github.com/privacybydesign/gabi/signed"
13 14
)

15
type (
Sietse Ringers's avatar
Sietse Ringers committed
16 17 18
	// RevocationStorage stores and retrieves revocation-related data from and to a SQL database,
	// and offers a revocation API for all other irmago code, including a Revoke() method that
	// revokes an earlier issued credential.
19 20 21 22 23 24 25 26 27
	RevocationStorage struct {
		conf     *Configuration
		db       revStorage
		memdb    memRevStorage
		sqlMode  bool
		settings map[CredentialTypeIdentifier]*RevocationSetting

		Keys   RevocationKeys
		client RevocationClient
28 29
	}

Sietse Ringers's avatar
Sietse Ringers committed
30
	// RevocationClient offers an HTTP client to the revocation server endpoints.
31 32 33 34
	RevocationClient struct {
		Conf *Configuration
	}

Sietse Ringers's avatar
Sietse Ringers committed
35 36
	// RevocationKeys contains helper functions for retrieving revocation private and public keys
	// from an irma.Configuration instance.
37 38 39 40
	RevocationKeys struct {
		Conf *Configuration
	}

Sietse Ringers's avatar
Sietse Ringers committed
41
	// RevocationSetting contains revocation settings for a given credential type.
42 43 44 45 46 47
	RevocationSetting struct {
		Mode     RevocationMode `json:"mode"`
		PostURLs []string       `json:"post_urls" mapstructure:"post_urls"`
		updated  time.Time
	}

Sietse Ringers's avatar
Sietse Ringers committed
48 49
	// RevocationMode specifies for a given credential type what revocation operations are
	// supported, and how the associated data is stored (SQL or memory).
50
	RevocationMode string
51

Sietse Ringers's avatar
Sietse Ringers committed
52 53 54
	// RevocationRecord contains a signed AccumulatorUpdate and associated information and is used
	// by clients, issuers and verifiers to update their revocation state, so that they can create
	// and verify nonrevocation proofs and witnesses.
55 56
	RevocationRecord struct {
		revocation.Record `gorm:"embedded"`
57
		PublicKeyIndex    uint
58
		CredType          CredentialTypeIdentifier `gorm:"primary_key"`
59 60 61 62 63 64 65 66 67
	}

	TimeRecord struct {
		Index      uint64
		Start, End int64
	}

	// IssuanceRecord contains information generated during issuance, needed for later revocation.
	IssuanceRecord struct {
68 69
		CredType   CredentialTypeIdentifier `gorm:"primary_key"`
		Key        string                   `gorm:"primary_key"`
70 71 72 73 74
		Attr       *big.Int
		Issued     int64
		ValidUntil int64
		RevokedAt  int64 // 0 if not currently revoked
	}
75
)
76

77
const (
Sietse Ringers's avatar
Sietse Ringers committed
78 79
	// RevocationModeRequestor is the default revocation mode in which only RevocationRecord instances
	// are consumed for issuance or verification. Uses an in-memory store.
80
	RevocationModeRequestor RevocationMode = ""
Sietse Ringers's avatar
Sietse Ringers committed
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99

	// RevocationModeProxy indicates that this server
	// (1) allows fetching of RevocationRecord instances from its database,
	// (2) relays all RevocationRecord instances it receives to the URLs configured in the containing
	// RevocationSetting struct.
	// Requires a SQL server to store and retrieve RevocationRecord instances from.
	RevocationModeProxy RevocationMode = "proxy"

	// RevocationModeServer indicates that this is the revocation server for a credential type,
	// to which the credential type's RevocationServer URL should point.
	// IssuanceRecord instances are sent to this server, as well as revocation commands, through
	// revocation sessions or through the RevocationStorage.Revoke() method.
	// Requires a SQL server to store and retrieve all records from and requires the issuer's
	// private key to be accessible, in order to revoke and to sign new revocation records.
	RevocationModeServer RevocationMode = "server"

	// revocationUpdateCount specifies how many revocation records are attached to session requests
	// for the client to update its revocation state.
	revocationUpdateCount = 5
100 101
)

102
// Revocation record methods
103

Sietse Ringers's avatar
Sietse Ringers committed
104 105 106
// EnableRevocation creates an initial accumulator for a given credential type. This function is the
// only way to create such an initial accumulator and it must be called before anyone can use
// revocation for this credential type. Requires the issuer private key.
107 108 109 110 111 112 113 114 115 116 117 118 119
func (rs *RevocationStorage) EnableRevocation(typ CredentialTypeIdentifier) error {
	hasRecords, err := rs.db.HasRecords(typ, (*RevocationRecord)(nil))
	if err != nil {
		return err
	}
	if hasRecords {
		return errors.New("revocation record table not empty")
	}

	sk, err := rs.Keys.PrivateKey(typ.IssuerIdentifier())
	if err != nil {
		return err
	}
120 121 122 123
	msg, acc, err := revocation.NewAccumulator(sk)
	if err != nil {
		return err
	}
124 125
	r := &RevocationRecord{
		Record: revocation.Record{
126 127 128
			Message:    msg,
			StartIndex: acc.Index,
			EndIndex:   acc.Index,
129
		},
130 131
		PublicKeyIndex: sk.Counter,
		CredType:       typ,
132 133 134
	}

	if err = rs.AddRevocationRecord(r); err != nil {
135 136 137 138 139
		return err
	}
	return nil
}

Sietse Ringers's avatar
Sietse Ringers committed
140 141 142 143 144 145 146 147 148 149 150
// RevocationEnabled returns whether or not revocation is enabled for the given credential type,
// by checking if any revocation record exists in the database.
func (rs *RevocationStorage) RevocationEnabled(typ CredentialTypeIdentifier) (bool, error) {
	if rs.sqlMode {
		return rs.db.HasRecords(typ, (*RevocationRecord)(nil))
	} else {
		return rs.memdb.HasRecords(typ), nil
	}
}

// RevocationRecords returns all records that a client requires to update its revocation state if it is currently
151 152
// at the specified index, that is, all records whose end index is greater than or equal to
// the specified index.
153 154 155
func (rs *RevocationStorage) RevocationRecords(typ CredentialTypeIdentifier, index uint64) ([]*RevocationRecord, error) {
	var records []*RevocationRecord
	return records, rs.db.From(typ, "end_index", index, &records)
156 157
}

158 159 160 161 162 163 164 165
func (rs *RevocationStorage) LatestRevocationRecords(typ CredentialTypeIdentifier, count uint64) ([]*RevocationRecord, error) {
	var records []*RevocationRecord
	if rs.sqlMode {
		if err := rs.db.Latest(typ, "end_index", count, &records); err != nil {
			return nil, err
		}
	} else {
		rs.memdb.Latest(typ, count, &records)
166
	}
167 168
	if len(records) == 0 {
		return nil, gorm.ErrRecordNotFound
169
	}
170
	return records, nil
171 172
}

173
func (rs *RevocationStorage) AddRevocationRecords(records []*RevocationRecord) error {
174 175
	var err error
	for _, r := range records {
176
		if err = rs.addRevocationRecord(rs.db, r, false); err != nil {
177 178 179
			return err
		}
	}
180 181 182 183 184 185

	if len(records) > 0 {
		// POST record to listeners, if any, asynchroniously
		go rs.client.PostRevocationRecords(rs.getSettings(records[0].CredType).PostURLs, records)
	}

186 187 188
	return nil
}

189
func (rs *RevocationStorage) AddRevocationRecord(record *RevocationRecord) error {
190
	return rs.addRevocationRecord(rs.db, record, true)
191
}
192

193
func (rs *RevocationStorage) addRevocationRecord(tx revStorage, record *RevocationRecord, post bool) error {
194 195
	// Unmarshal and verify the record against the appropriate public key
	pk, err := rs.Keys.PublicKey(record.CredType.IssuerIdentifier(), record.PublicKeyIndex)
196 197 198
	if err != nil {
		return err
	}
199
	_, err = record.UnmarshalVerify(pk)
200
	if err != nil {
201 202 203
		return err
	}

204 205 206 207
	// Save record
	if rs.sqlMode {
		if err = tx.Insert(record); err != nil {
			return err
208
		}
209 210
	} else {
		rs.memdb.Insert(record)
211 212
	}

213 214
	s := rs.getSettings(record.CredType)
	s.updated = time.Now()
215 216 217 218
	if post {
		// POST record to listeners, if any, asynchroniously
		go rs.client.PostRevocationRecords(s.PostURLs, []*RevocationRecord{record})
	}
219 220 221

	return nil
}
222

223 224 225 226
// Issuance records

func (rs *RevocationStorage) IssuanceRecordExists(typ CredentialTypeIdentifier, key []byte) (bool, error) {
	return rs.db.Exists(typ, "key", key, &IssuanceRecord{})
227 228
}

229 230
func (rs *RevocationStorage) AddIssuanceRecord(r *IssuanceRecord) error {
	return rs.db.Insert(r)
231 232
}

233 234 235 236 237
func (rs *RevocationStorage) IssuanceRecord(typ CredentialTypeIdentifier, key []byte) (*IssuanceRecord, error) {
	var r IssuanceRecord
	err := rs.db.Get(typ, "key", key, &r)
	if err != nil {
		return nil, err
238
	}
239 240
	return &r, nil
}
241

242 243
// Revocation methods

Sietse Ringers's avatar
Sietse Ringers committed
244 245
// Revoke revokes the credential specified by key if found within the current database,
// by updating its revocation time to now, removing its revocation attribute from the current accumulator,
246 247
// and updating the revocation database on disk.
func (rs *RevocationStorage) Revoke(typ CredentialTypeIdentifier, key string) error {
Sietse Ringers's avatar
Sietse Ringers committed
248 249
	if rs.getSettings(typ).Mode != RevocationModeServer {
		return errors.Errorf("cannot revoke %s", typ)
250
	}
Sietse Ringers's avatar
Sietse Ringers committed
251
	rsk, err := rs.Keys.PrivateKey(typ.IssuerIdentifier())
252
	if err != nil {
253 254 255
		return err
	}

256 257 258 259 260 261 262 263 264 265 266
	return rs.db.Transaction(func(tx revStorage) error {
		var err error
		cr := IssuanceRecord{}
		if err = tx.Get(typ, "key", key, &cr); err != nil {
			return err
		}
		cr.RevokedAt = time.Now().UnixNano()
		if err = tx.Save(&cr); err != nil {
			return err
		}
		return rs.revokeAttr(tx, typ, rsk, cr.Attr)
267 268 269
	})
}

270 271 272 273 274 275 276 277 278 279
func (rs *RevocationStorage) revokeAttr(tx revStorage, typ CredentialTypeIdentifier, sk *revocation.PrivateKey, e *big.Int) error {
	cur, err := rs.currentAccumulator(tx, typ)
	if err != nil {
		return err
	}
	if cur == nil {
		return errors.Errorf("cannot revoke for type %s, not enabled yet", typ)
	}

	newAcc, err := cur.Remove(sk, e)
280 281 282
	if err != nil {
		return err
	}
283
	update := &revocation.AccumulatorUpdate{
284 285 286 287 288 289 290 291 292
		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
	}
293 294
	record := &RevocationRecord{
		Record: revocation.Record{
295 296 297
			StartIndex: newAcc.Index,
			EndIndex:   newAcc.Index,
			Message:    updateMsg,
298
		},
299 300
		PublicKeyIndex: sk.Counter,
		CredType:       typ,
301
	}
302
	if err = rs.addRevocationRecord(tx, record, true); err != nil {
303 304 305 306 307
		return err
	}
	return nil
}

308
// Accumulator methods
309

310 311
func (rs *RevocationStorage) CurrentAccumulator(typ CredentialTypeIdentifier) (*revocation.Accumulator, error) {
	return rs.currentAccumulator(rs.db, typ)
312 313
}

314 315
func (rs *RevocationStorage) currentAccumulator(tx revStorage, typ CredentialTypeIdentifier) (rec *revocation.Accumulator, err error) {
	record := &RevocationRecord{}
316

317 318 319 320 321
	if rs.sqlMode {
		if err := tx.Last(typ, record); err != nil {
			if gorm.IsRecordNotFoundError(err) {
				return nil, nil
			}
322 323
			return nil, err
		}
324 325 326 327 328 329 330
	} else {
		var r []*RevocationRecord
		rs.memdb.Latest(typ, 1, &r)
		if len(r) == 0 {
			return nil, nil
		}
		record = r[0]
331 332
	}

333
	pk, err := rs.Keys.PublicKey(typ.IssuerIdentifier(), record.PublicKeyIndex)
334 335 336
	if err != nil {
		return nil, err
	}
337 338
	var u revocation.AccumulatorUpdate
	if err = signed.UnmarshalVerify(pk.ECDSA, record.Message, &u); err != nil {
339 340
		return nil, err
	}
341
	return &u.Accumulator, nil
342 343
}

344 345 346 347
// Methods to update from remote revocation server

func (rs *RevocationStorage) UpdateDB(typ CredentialTypeIdentifier) error {
	records, err := rs.client.FetchLatestRevocationRecords(typ, revocationUpdateCount)
348
	if err != nil {
349
		return err
350
	}
351
	return rs.AddRevocationRecords(records)
352 353
}

Sietse Ringers's avatar
Sietse Ringers committed
354
func (rs *RevocationStorage) UpdateIfOld(typ CredentialTypeIdentifier) error {
355 356
	if rs.getSettings(typ).updated.Before(time.Now().Add(-5 * time.Minute)) {
		if err := rs.UpdateDB(typ); err != nil {
357 358 359 360 361 362
			return err
		}
	}
	return nil
}

363 364 365 366 367 368 369 370
// SaveIssuanceRecord either stores the issuance record locally, if we are the revocation server of
// the crecential type, or it signs and sends it to the remote revocation server.
func (rs *RevocationStorage) SaveIssuanceRecord(typ CredentialTypeIdentifier, rec *IssuanceRecord) error {
	// TODO store locally if appropriate?

	// Just store it if we are the revocation server for this credential type
	if rs.getSettings(typ).Mode == RevocationModeServer {
		return rs.AddIssuanceRecord(rec)
371 372
	}

373 374 375 376 377 378 379 380 381
	// We have to send it, sign it first
	credtype := rs.conf.CredentialTypes[typ]
	if credtype == nil {
		return errors.New("unknown credential type")
	}
	if credtype.RevocationServer == "" {
		return errors.New("credential type has no revocation server")
	}
	sk, err := rs.Keys.PrivateKey(typ.IssuerIdentifier())
382 383 384
	if err != nil {
		return err
	}
385
	message, err := signed.MarshalSign(sk.ECDSA, rec)
386 387 388
	if err != nil {
		return err
	}
389 390

	return rs.client.PostIssuanceRecord(typ, sk.Counter, message)
391 392
}

393 394 395
// Misscelaneous methods

func (rs *RevocationStorage) Load(debug bool, connstr string, settings map[CredentialTypeIdentifier]*RevocationSetting) error {
396 397 398 399 400 401 402 403
	var t *CredentialTypeIdentifier
	for typ, s := range settings {
		switch s.Mode {
		case RevocationModeServer, RevocationModeProxy:
			t = &typ
		default:
			return errors.Errorf("invalid revocation mode '%s' for %s (supported: %s, %s)",
				s.Mode, typ, RevocationModeServer, RevocationModeProxy)
404
		}
405
	}
406 407 408
	if t != nil && connstr == "" {
		return errors.Errorf("revocation mode for %s requires SQL database but no connection string given", *t)
	}
409 410 411 412 413 414 415 416

	if connstr == "" {
		Logger.Trace("Using memory revocation database")
		rs.memdb = newMemStorage()
		rs.sqlMode = false
	} else {
		Logger.Trace("Connecting to revocation SQL database")
		db, err := newSqlStorage(debug, connstr)
417
		if err != nil {
418
			return err
419
		}
420 421
		rs.db = db
		rs.sqlMode = true
422
	}
423 424 425 426 427 428 429 430
	if settings != nil {
		rs.settings = settings
	} else {
		rs.settings = map[CredentialTypeIdentifier]*RevocationSetting{}
	}
	rs.client = RevocationClient{Conf: rs.conf}
	rs.Keys = RevocationKeys{Conf: rs.conf}
	return nil
431 432
}

433 434 435
func (rs *RevocationStorage) Close() error {
	if rs.db != nil {
		return rs.db.Close()
436 437 438 439
	}
	return nil
}

440 441 442 443 444 445
// SetRevocationRecords retrieves the latest revocation records from the database, and attaches
// them to the request, for each credential type for which a nonrevocation proof is requested in
// b.Revocation.
func (rs *RevocationStorage) SetRevocationRecords(b *BaseRequest) error {
	if len(b.Revocation) == 0 {
		return nil
446
	}
447 448 449
	var err error
	b.RevocationUpdates = make(map[CredentialTypeIdentifier][]*RevocationRecord, len(b.Revocation))
	for _, credid := range b.Revocation {
Sietse Ringers's avatar
Sietse Ringers committed
450
		if err = rs.UpdateIfOld(credid); err != nil {
451 452 453 454 455 456
			return err
		}
		b.RevocationUpdates[credid], err = rs.LatestRevocationRecords(credid, revocationUpdateCount)
		if err != nil {
			return err
		}
457
	}
458 459 460 461 462 463
	return nil
}

func (rs *RevocationStorage) getSettings(typ CredentialTypeIdentifier) *RevocationSetting {
	if rs.settings[typ] == nil {
		rs.settings[typ] = &RevocationSetting{}
464
	}
465 466 467
	return rs.settings[typ]
}

468
func (RevocationClient) PostRevocationRecords(urls []string, records []*RevocationRecord) {
469
	transport := NewHTTPTransport("")
470 471
	for _, url := range urls {
		if err := transport.Post(url+"/-/revocation/records", nil, &records); err != nil {
472 473
			Logger.Warn("error sending revocation update", err)
		}
474
	}
475 476 477 478 479 480 481 482 483 484 485 486 487
}

func (client RevocationClient) PostIssuanceRecord(typ CredentialTypeIdentifier, counter uint, message signed.Message) error {
	return NewHTTPTransport(client.Conf.CredentialTypes[typ].RevocationServer).Post(
		fmt.Sprintf("-/revocation/issuancerecord/%s/%d", typ, counter), nil, []byte(message),
	)
}

// FetchRevocationRecords gets revocation update messages from the revocation server, of the specified index and greater.
func (client RevocationClient) FetchRevocationRecords(typ CredentialTypeIdentifier, index uint64) ([]*RevocationRecord, error) {
	var records []*RevocationRecord
	err := NewHTTPTransport(client.Conf.CredentialTypes[typ].RevocationServer).
		Get(fmt.Sprintf("-/revocation/records/%s/%d", typ, index), &records)
488
	if err != nil {
489
		return nil, err
490
	}
491 492
	return records, nil
}
493

494 495 496 497
func (client RevocationClient) FetchLatestRevocationRecords(typ CredentialTypeIdentifier, count uint64) ([]*RevocationRecord, error) {
	var records []*RevocationRecord
	err := NewHTTPTransport(client.Conf.CredentialTypes[typ].RevocationServer).
		Get(fmt.Sprintf("-/revocation/latestrecords/%s/%d", typ, count), &records)
498
	if err != nil {
499
		return nil, err
500
	}
501
	return records, nil
502 503
}

504 505
func (rs RevocationKeys) PrivateKey(issid IssuerIdentifier) (*revocation.PrivateKey, error) {
	sk, err := rs.Conf.PrivateKey(issid)
506
	if err != nil {
507
		return nil, err
508 509
	}
	if sk == nil {
510
		return nil, errors.Errorf("unknown private key: %s", issid)
511
	}
512
	revsk, err := sk.RevocationKey()
513
	if err != nil {
514
		return nil, err
515
	}
516 517
	return revsk, nil
}
518

519 520
func (rs RevocationKeys) PublicKey(issid IssuerIdentifier, counter uint) (*revocation.PublicKey, error) {
	pk, err := rs.Conf.PublicKey(issid, int(counter))
521
	if err != nil {
522
		return nil, err
523
	}
524 525
	if pk == nil {
		return nil, errors.Errorf("unknown public key: %s-%d", issid, counter)
526
	}
527 528 529
	revpk, err := pk.RevocationKey()
	if err != nil {
		return nil, err
530
	}
531
	return revpk, nil
532
}