revocation.go 15.7 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
func (rs *RevocationStorage) EnableRevocation(typ CredentialTypeIdentifier, sk *revocation.PrivateKey) error {
108 109 110 111 112 113 114 115
	hasRecords, err := rs.db.HasRecords(typ, (*RevocationRecord)(nil))
	if err != nil {
		return err
	}
	if hasRecords {
		return errors.New("revocation record table not empty")
	}

116 117 118 119
	msg, acc, err := revocation.NewAccumulator(sk)
	if err != nil {
		return err
	}
120 121
	r := &RevocationRecord{
		Record: revocation.Record{
122 123 124
			Message:    msg,
			StartIndex: acc.Index,
			EndIndex:   acc.Index,
125
		},
126 127
		PublicKeyIndex: sk.Counter,
		CredType:       typ,
128 129 130
	}

	if err = rs.AddRevocationRecord(r); err != nil {
131 132 133 134 135
		return err
	}
	return nil
}

Sietse Ringers's avatar
Sietse Ringers committed
136 137 138 139 140 141 142 143 144 145 146
// 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
147 148
// at the specified index, that is, all records whose end index is greater than or equal to
// the specified index.
149 150 151
func (rs *RevocationStorage) RevocationRecords(typ CredentialTypeIdentifier, index uint64) ([]*RevocationRecord, error) {
	var records []*RevocationRecord
	return records, rs.db.From(typ, "end_index", index, &records)
152 153
}

154 155 156 157 158 159 160 161
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)
162
	}
163 164
	if len(records) == 0 {
		return nil, gorm.ErrRecordNotFound
165
	}
166
	return records, nil
167 168
}

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

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

182 183 184
	return nil
}

185
func (rs *RevocationStorage) AddRevocationRecord(record *RevocationRecord) error {
186
	return rs.addRevocationRecord(rs.db, record, true)
187
}
188

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

200 201 202 203
	// Save record
	if rs.sqlMode {
		if err = tx.Insert(record); err != nil {
			return err
204
		}
205 206
	} else {
		rs.memdb.Insert(record)
207 208
	}

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

	return nil
}
218

219 220 221 222
// Issuance records

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

225 226
func (rs *RevocationStorage) AddIssuanceRecord(r *IssuanceRecord) error {
	return rs.db.Insert(r)
227 228
}

229 230 231 232 233
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
234
	}
235 236
	return &r, nil
}
237

238 239
// Revocation methods

Sietse Ringers's avatar
Sietse Ringers committed
240 241
// 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,
242
// and updating the revocation database on disk.
243
func (rs *RevocationStorage) Revoke(typ CredentialTypeIdentifier, key string, sk *revocation.PrivateKey) error {
Sietse Ringers's avatar
Sietse Ringers committed
244 245
	if rs.getSettings(typ).Mode != RevocationModeServer {
		return errors.Errorf("cannot revoke %s", typ)
246
	}
247

248 249 250 251 252 253 254 255 256 257
	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
		}
258
		return rs.revokeAttr(tx, typ, sk, cr.Attr)
259 260 261
	})
}

262 263 264 265 266 267 268 269 270 271
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)
272 273 274
	if err != nil {
		return err
	}
275
	update := &revocation.AccumulatorUpdate{
276 277 278 279 280 281 282 283 284
		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
	}
285 286
	record := &RevocationRecord{
		Record: revocation.Record{
287 288 289
			StartIndex: newAcc.Index,
			EndIndex:   newAcc.Index,
			Message:    updateMsg,
290
		},
291 292
		PublicKeyIndex: sk.Counter,
		CredType:       typ,
293
	}
294
	if err = rs.addRevocationRecord(tx, record, true); err != nil {
295 296 297 298 299
		return err
	}
	return nil
}

300
// Accumulator methods
301

302 303
func (rs *RevocationStorage) CurrentAccumulator(typ CredentialTypeIdentifier) (*revocation.Accumulator, error) {
	return rs.currentAccumulator(rs.db, typ)
304 305
}

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

309 310 311 312 313
	if rs.sqlMode {
		if err := tx.Last(typ, record); err != nil {
			if gorm.IsRecordNotFoundError(err) {
				return nil, nil
			}
314 315
			return nil, err
		}
316 317 318 319 320 321 322
	} else {
		var r []*RevocationRecord
		rs.memdb.Latest(typ, 1, &r)
		if len(r) == 0 {
			return nil, nil
		}
		record = r[0]
323 324
	}

325
	pk, err := rs.Keys.PublicKey(typ.IssuerIdentifier(), record.PublicKeyIndex)
326 327 328
	if err != nil {
		return nil, err
	}
329 330
	var u revocation.AccumulatorUpdate
	if err = signed.UnmarshalVerify(pk.ECDSA, record.Message, &u); err != nil {
331 332
		return nil, err
	}
333
	return &u.Accumulator, nil
334 335
}

336 337 338 339
// Methods to update from remote revocation server

func (rs *RevocationStorage) UpdateDB(typ CredentialTypeIdentifier) error {
	records, err := rs.client.FetchLatestRevocationRecords(typ, revocationUpdateCount)
340
	if err != nil {
341
		return err
342
	}
343
	return rs.AddRevocationRecords(records)
344 345
}

Sietse Ringers's avatar
Sietse Ringers committed
346
func (rs *RevocationStorage) UpdateIfOld(typ CredentialTypeIdentifier) error {
347 348
	if rs.getSettings(typ).updated.Before(time.Now().Add(-5 * time.Minute)) {
		if err := rs.UpdateDB(typ); err != nil {
349 350 351 352 353 354
			return err
		}
	}
	return nil
}

355 356 357 358 359 360 361 362
// 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)
363 364
	}

365 366 367 368 369 370 371 372 373
	// 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())
374 375 376
	if err != nil {
		return err
	}
377
	message, err := signed.MarshalSign(sk.ECDSA, rec)
378 379 380
	if err != nil {
		return err
	}
381 382

	return rs.client.PostIssuanceRecord(typ, sk.Counter, message)
383 384
}

385 386 387
// Misscelaneous methods

func (rs *RevocationStorage) Load(debug bool, connstr string, settings map[CredentialTypeIdentifier]*RevocationSetting) error {
388 389 390 391 392 393 394 395
	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)
396
		}
397
	}
398 399 400
	if t != nil && connstr == "" {
		return errors.Errorf("revocation mode for %s requires SQL database but no connection string given", *t)
	}
401 402 403 404 405 406 407 408

	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)
409
		if err != nil {
410
			return err
411
		}
412 413
		rs.db = db
		rs.sqlMode = true
414
	}
415 416 417 418 419 420 421 422
	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
423 424
}

425 426 427
func (rs *RevocationStorage) Close() error {
	if rs.db != nil {
		return rs.db.Close()
428 429 430 431
	}
	return nil
}

432 433 434 435 436 437
// 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
438
	}
439 440 441
	var err error
	b.RevocationUpdates = make(map[CredentialTypeIdentifier][]*RevocationRecord, len(b.Revocation))
	for _, credid := range b.Revocation {
Sietse Ringers's avatar
Sietse Ringers committed
442
		if err = rs.UpdateIfOld(credid); err != nil {
443 444 445 446 447 448
			return err
		}
		b.RevocationUpdates[credid], err = rs.LatestRevocationRecords(credid, revocationUpdateCount)
		if err != nil {
			return err
		}
449
	}
450 451 452 453 454 455
	return nil
}

func (rs *RevocationStorage) getSettings(typ CredentialTypeIdentifier) *RevocationSetting {
	if rs.settings[typ] == nil {
		rs.settings[typ] = &RevocationSetting{}
456
	}
457 458 459
	return rs.settings[typ]
}

460
func (RevocationClient) PostRevocationRecords(urls []string, records []*RevocationRecord) {
461
	transport := NewHTTPTransport("")
462 463
	for _, url := range urls {
		if err := transport.Post(url+"/-/revocation/records", nil, &records); err != nil {
464 465
			Logger.Warn("error sending revocation update", err)
		}
466
	}
467 468 469 470 471 472 473 474 475 476 477 478 479
}

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)
480
	if err != nil {
481
		return nil, err
482
	}
483 484
	return records, nil
}
485

486 487 488 489
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)
490
	if err != nil {
491
		return nil, err
492
	}
493
	return records, nil
494 495
}

496 497
func (rs RevocationKeys) PrivateKey(issid IssuerIdentifier) (*revocation.PrivateKey, error) {
	sk, err := rs.Conf.PrivateKey(issid)
498
	if err != nil {
499
		return nil, err
500 501
	}
	if sk == nil {
502
		return nil, errors.Errorf("unknown private key: %s", issid)
503
	}
504
	revsk, err := sk.RevocationKey()
505
	if err != nil {
506
		return nil, err
507
	}
508 509
	return revsk, nil
}
510

511 512
func (rs RevocationKeys) PublicKey(issid IssuerIdentifier, counter uint) (*revocation.PublicKey, error) {
	pk, err := rs.Conf.PublicKey(issid, int(counter))
513
	if err != nil {
514
		return nil, err
515
	}
516 517
	if pk == nil {
		return nil, errors.Errorf("unknown public key: %s-%d", issid, counter)
518
	}
519 520 521
	revpk, err := pk.RevocationKey()
	if err != nil {
		return nil, err
522
	}
523
	return revpk, nil
524
}