revocation.go 13.3 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 (
16 17 18 19 20 21 22 23 24
	RevocationStorage struct {
		conf     *Configuration
		db       revStorage
		memdb    memRevStorage
		sqlMode  bool
		settings map[CredentialTypeIdentifier]*RevocationSetting

		Keys   RevocationKeys
		client RevocationClient
25 26
	}

27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45
	RevocationClient struct {
		Conf *Configuration
	}

	RevocationKeys struct {
		Conf *Configuration
	}

	RevocationSetting struct {
		Mode     RevocationMode `json:"mode"`
		PostURLs []string       `json:"post_urls" mapstructure:"post_urls"`
		updated  time.Time
	}

	RevocationMode int

	RevocationRecord struct {
		revocation.Record `gorm:"embedded"`
		CredType          CredentialTypeIdentifier `gorm:"primary_key"`
46 47 48 49 50 51 52 53 54
	}

	TimeRecord struct {
		Index      uint64
		Start, End int64
	}

	// IssuanceRecord contains information generated during issuance, needed for later revocation.
	IssuanceRecord struct {
55 56
		CredType   CredentialTypeIdentifier `gorm:"primary_key"`
		Key        string                   `gorm:"primary_key"`
57 58 59 60 61
		Attr       *big.Int
		Issued     int64
		ValidUntil int64
		RevokedAt  int64 // 0 if not currently revoked
	}
62
)
63

64 65 66 67
const (
	RevocationModeRequestor RevocationMode = iota
	RevocationModeProxy
	RevocationModeServer
68 69
)

70
// Revocation record methods
71

72 73 74 75 76 77 78 79 80 81 82 83 84
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
	}
85 86 87 88
	msg, acc, err := revocation.NewAccumulator(sk)
	if err != nil {
		return err
	}
89 90 91 92 93 94 95 96 97 98 99
	r := &RevocationRecord{
		Record: revocation.Record{
			PublicKeyIndex: sk.Counter,
			Message:        msg,
			StartIndex:     acc.Index,
			EndIndex:       acc.Index,
		},
		CredType: typ,
	}

	if err = rs.AddRevocationRecord(r); err != nil {
100 101 102 103 104 105 106 107
		return err
	}
	return nil
}

// 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.
108 109 110
func (rs *RevocationStorage) RevocationRecords(typ CredentialTypeIdentifier, index uint64) ([]*RevocationRecord, error) {
	var records []*RevocationRecord
	return records, rs.db.From(typ, "end_index", index, &records)
111 112
}

113 114 115 116 117 118 119 120
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)
121
	}
122 123
	if len(records) == 0 {
		return nil, gorm.ErrRecordNotFound
124
	}
125
	return records, nil
126 127
}

128
func (rs *RevocationStorage) AddRevocationRecords(records []*RevocationRecord) error {
129 130
	var err error
	for _, r := range records {
131
		if err = rs.addRevocationRecord(rs.db, r, false); err != nil {
132 133 134
			return err
		}
	}
135 136 137 138 139 140

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

141 142 143
	return nil
}

144
func (rs *RevocationStorage) AddRevocationRecord(record *RevocationRecord) error {
145
	return rs.addRevocationRecord(rs.db, record, true)
146
}
147

148
func (rs *RevocationStorage) addRevocationRecord(tx revStorage, record *RevocationRecord, post bool) error {
149 150
	// Unmarshal and verify the record against the appropriate public key
	pk, err := rs.Keys.PublicKey(record.CredType.IssuerIdentifier(), record.PublicKeyIndex)
151 152 153
	if err != nil {
		return err
	}
154
	_, err = record.UnmarshalVerify(pk)
155
	if err != nil {
156 157 158
		return err
	}

159 160 161 162
	// Save record
	if rs.sqlMode {
		if err = tx.Insert(record); err != nil {
			return err
163
		}
164 165
	} else {
		rs.memdb.Insert(record)
166 167
	}

168 169
	s := rs.getSettings(record.CredType)
	s.updated = time.Now()
170 171 172 173
	if post {
		// POST record to listeners, if any, asynchroniously
		go rs.client.PostRevocationRecords(s.PostURLs, []*RevocationRecord{record})
	}
174 175 176

	return nil
}
177

178 179 180 181 182 183 184
// 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
185
	}
186
}
187

188 189 190 191
// Issuance records

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

194 195
func (rs *RevocationStorage) AddIssuanceRecord(r *IssuanceRecord) error {
	return rs.db.Insert(r)
196 197
}

198 199 200 201 202
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
203
	}
204 205
	return &r, nil
}
206

207 208 209 210 211 212 213
// Revocation methods

// 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 (rs *RevocationStorage) Revoke(typ CredentialTypeIdentifier, key string) error {
	sk, err := rs.conf.PrivateKey(typ.IssuerIdentifier())
214 215 216
	if err != nil {
		return err
	}
217 218 219 220 221
	if sk == nil {
		return errors.New("private key not found")
	}
	rsk, err := sk.RevocationKey()
	if err != nil {
222 223 224
		return err
	}

225 226 227 228 229 230 231 232 233 234 235
	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)
236 237 238
	})
}

239 240 241 242 243 244 245 246 247 248
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)
249 250 251
	if err != nil {
		return err
	}
252
	update := &revocation.AccumulatorUpdate{
253 254 255 256 257 258 259 260 261
		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
	}
262 263 264 265 266 267 268 269 270
	record := &RevocationRecord{
		Record: revocation.Record{
			StartIndex:     newAcc.Index,
			EndIndex:       newAcc.Index,
			PublicKeyIndex: sk.Counter,
			Message:        updateMsg,
		},
		CredType: typ,
	}
271
	if err = rs.addRevocationRecord(tx, record, true); err != nil {
272 273 274 275 276
		return err
	}
	return nil
}

277
// Accumulator methods
278

279 280
func (rs *RevocationStorage) CurrentAccumulator(typ CredentialTypeIdentifier) (*revocation.Accumulator, error) {
	return rs.currentAccumulator(rs.db, typ)
281 282
}

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

286 287 288 289 290
	if rs.sqlMode {
		if err := tx.Last(typ, record); err != nil {
			if gorm.IsRecordNotFoundError(err) {
				return nil, nil
			}
291 292
			return nil, err
		}
293 294 295 296 297 298 299
	} else {
		var r []*RevocationRecord
		rs.memdb.Latest(typ, 1, &r)
		if len(r) == 0 {
			return nil, nil
		}
		record = r[0]
300 301
	}

302
	pk, err := rs.Keys.PublicKey(typ.IssuerIdentifier(), record.PublicKeyIndex)
303 304 305
	if err != nil {
		return nil, err
	}
306 307
	var u revocation.AccumulatorUpdate
	if err = signed.UnmarshalVerify(pk.ECDSA, record.Message, &u); err != nil {
308 309
		return nil, err
	}
310
	return &u.Accumulator, nil
311 312
}

313 314 315 316
// Methods to update from remote revocation server

func (rs *RevocationStorage) UpdateDB(typ CredentialTypeIdentifier) error {
	records, err := rs.client.FetchLatestRevocationRecords(typ, revocationUpdateCount)
317
	if err != nil {
318
		return err
319
	}
320
	return rs.AddRevocationRecords(records)
321 322
}

323 324 325
func (rs *RevocationStorage) updateIfOld(typ CredentialTypeIdentifier) error {
	if rs.getSettings(typ).updated.Before(time.Now().Add(-5 * time.Minute)) {
		if err := rs.UpdateDB(typ); err != nil {
326 327 328 329 330 331
			return err
		}
	}
	return nil
}

332 333 334 335 336 337 338 339
// 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)
340 341
	}

342 343 344 345 346 347 348 349 350
	// 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())
351 352 353
	if err != nil {
		return err
	}
354
	message, err := signed.MarshalSign(sk.ECDSA, rec)
355 356 357
	if err != nil {
		return err
	}
358 359

	return rs.client.PostIssuanceRecord(typ, sk.Counter, message)
360 361
}

362 363 364 365 366 367 368 369 370
// Misscelaneous methods

func (rs *RevocationStorage) Load(debug bool, connstr string, settings map[CredentialTypeIdentifier]*RevocationSetting) error {
	if connstr == "" {
		for typ, s := range settings {
			if s.Mode != RevocationModeRequestor {
				return errors.Errorf("revocation mode for %s requires SQL database but no connection string given", typ)
			}
		}
371
	}
372 373 374 375 376 377 378 379

	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)
380
		if err != nil {
381
			return err
382
		}
383 384
		rs.db = db
		rs.sqlMode = true
385
	}
386 387 388 389 390 391 392 393
	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
394 395
}

396 397 398
func (rs *RevocationStorage) Close() error {
	if rs.db != nil {
		return rs.db.Close()
399 400 401 402
	}
	return nil
}

403 404 405 406 407 408
// 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
409
	}
410 411 412 413 414 415 416 417 418 419
	var err error
	b.RevocationUpdates = make(map[CredentialTypeIdentifier][]*RevocationRecord, len(b.Revocation))
	for _, credid := range b.Revocation {
		if err = rs.updateIfOld(credid); err != nil {
			return err
		}
		b.RevocationUpdates[credid], err = rs.LatestRevocationRecords(credid, revocationUpdateCount)
		if err != nil {
			return err
		}
420
	}
421 422 423 424 425 426
	return nil
}

func (rs *RevocationStorage) getSettings(typ CredentialTypeIdentifier) *RevocationSetting {
	if rs.settings[typ] == nil {
		rs.settings[typ] = &RevocationSetting{}
427
	}
428 429 430
	return rs.settings[typ]
}

431
func (RevocationClient) PostRevocationRecords(urls []string, records []*RevocationRecord) {
432
	transport := NewHTTPTransport("")
433 434
	for _, url := range urls {
		if err := transport.Post(url+"/-/revocation/records", nil, &records); err != nil {
435 436
			Logger.Warn("error sending revocation update", err)
		}
437
	}
438 439 440 441 442 443 444 445 446 447 448 449 450
}

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)
451
	if err != nil {
452
		return nil, err
453
	}
454 455
	return records, nil
}
456

457 458 459 460
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)
461
	if err != nil {
462
		return nil, err
463
	}
464
	return records, nil
465 466
}

467 468
func (rs RevocationKeys) PrivateKey(issid IssuerIdentifier) (*revocation.PrivateKey, error) {
	sk, err := rs.Conf.PrivateKey(issid)
469
	if err != nil {
470
		return nil, err
471 472
	}
	if sk == nil {
473
		return nil, errors.Errorf("unknown private key: %s", issid)
474
	}
475
	revsk, err := sk.RevocationKey()
476
	if err != nil {
477
		return nil, err
478
	}
479 480
	return revsk, nil
}
481

482 483
func (rs RevocationKeys) PublicKey(issid IssuerIdentifier, counter uint) (*revocation.PublicKey, error) {
	pk, err := rs.Conf.PublicKey(issid, int(counter))
484
	if err != nil {
485
		return nil, err
486
	}
487 488
	if pk == nil {
		return nil, errors.Errorf("unknown public key: %s-%d", issid, counter)
489
	}
490 491 492
	revpk, err := pk.RevocationKey()
	if err != nil {
		return nil, err
493
	}
494
	return revpk, nil
495
}