attributes.go 16.5 KB
Newer Older
1
package irma
2
3
4

import (
	"crypto/sha256"
5
	"encoding/binary"
Sietse Ringers's avatar
Sietse Ringers committed
6
	"encoding/hex"
7
	"encoding/json"
8
	"math/big"
9
	"time"
10

11
	"fmt"
Sietse Ringers's avatar
Sietse Ringers committed
12
	"github.com/go-errors/errors"
13
14
15
	"github.com/mhe/gabi"
)

16
17
const (
	// ExpiryFactor is the precision for the expiry attribute. Value is one week.
18
19
	ExpiryFactor   = 60 * 60 * 24 * 7
	metadataLength = 1 + 3 + 2 + 2 + 16
20
21
)

22
23
24
25
type AttributeResultList struct {
	AttributeResults []*AttributeResult
}
type AttributeResult struct {
26
27
28
	AttributeValue       string                  `json:"value"` // Value of the disclosed attribute
	AttributeId          AttributeTypeIdentifier `json:"id"`
	AttributeProofStatus AttributeProofStatus    `json:"status"`
29
30
}

31
// AttributeProofStatus is the proof status of a single attribute
32
33
34
type AttributeProofStatus string

const (
Koen van Ingen's avatar
Koen van Ingen committed
35
36
	PRESENT       = AttributeProofStatus("PRESENT")       // Attribute is disclosed and matches the value
	EXTRA         = AttributeProofStatus("EXTRA")         // Attribute is disclosed, but wasn't requested in request
37
38
39
40
	MISSING       = AttributeProofStatus("MISSING")       // Attribute is NOT disclosed, but should be according to request
	INVALID_VALUE = AttributeProofStatus("INVALID_VALUE") // Attribute is disclosed, but has invalid value according to request
)

41
42
43
var (
	metadataVersion = []byte{0x02}

Sietse Ringers's avatar
Sietse Ringers committed
44
45
46
47
48
	versionField     = metadataField{1, 0}
	signingDateField = metadataField{3, 1}
	validityField    = metadataField{2, 4}
	keyCounterField  = metadataField{2, 6}
	credentialID     = metadataField{16, 8}
49
50
)

Sietse Ringers's avatar
Sietse Ringers committed
51
52
// metadataField contains the length and offset of a field within a metadata attribute.
type metadataField struct {
53
54
55
56
	length int
	offset int
}

57
// metadataAttribute represents a metadata attribute. Contains the credential type, signing date, validity, and the public key counter.
58
type MetadataAttribute struct {
59
60
61
	Int  *big.Int
	pk   *gabi.PublicKey
	Conf *Configuration
62
63
}

64
65
66
// AttributeList contains attributes, excluding the secret key,
// providing convenient access to the metadata attribute.
type AttributeList struct {
67
	*MetadataAttribute `json:"-"`
68
	Ints               []*big.Int
Sietse Ringers's avatar
Sietse Ringers committed
69
	strings            []TranslatedString
70
	info               *CredentialInfo
71
	h                  string
72
73
}

74
// NewAttributeListFromInts initializes a new AttributeList from a list of bigints.
75
func NewAttributeListFromInts(ints []*big.Int, conf *Configuration) *AttributeList {
76
	return &AttributeList{
77
		Ints:              ints,
78
		MetadataAttribute: MetadataFromInt(ints[0], conf),
79
	}
80
81
}

82
func (al *AttributeList) Info() *CredentialInfo {
83
	if al.info == nil {
84
		al.info = NewCredentialInfo(al.Ints, al.Conf)
85
	}
86
	return al.info
87
88
}

89
func (al *AttributeList) Hash() string {
90
91
92
	if al.h == "" {
		bytes := []byte{}
		for _, i := range al.Ints {
93
94
95
			if i != nil {
				bytes = append(bytes, i.Bytes()...)
			}
96
97
98
		}
		shasum := sha256.Sum256(bytes)
		al.h = hex.EncodeToString(shasum[:])
99
	}
100
	return al.h
101
102
}

103
// Strings converts the current instance to human-readable strings.
Sietse Ringers's avatar
Sietse Ringers committed
104
func (al *AttributeList) Strings() []TranslatedString {
105
	if al.strings == nil {
Sietse Ringers's avatar
Sietse Ringers committed
106
		al.strings = make([]TranslatedString, len(al.Ints)-1)
107
		for index, num := range al.Ints[1:] { // skip metadata
108
109
110
111
112
			if num == nil {
				al.strings[index] = nil
			} else {
				al.strings[index] = map[string]string{"en": string(num.Bytes()), "nl": string(num.Bytes())} // TODO
			}
113
114
115
116
		}
	}
	return al.strings
}
117

118
func (al *AttributeList) UntranslatedAttribute(identifier AttributeTypeIdentifier) string {
119
120
121
	if al.CredentialType().Identifier() != identifier.CredentialTypeIdentifier() {
		return ""
	}
122
	for i, desc := range al.CredentialType().Attributes {
123
		if desc.ID == string(identifier.Name()) {
Sietse Ringers's avatar
Sietse Ringers committed
124
			return string(al.Ints[i+1].Bytes())
125
126
127
128
129
		}
	}
	return ""
}

Sietse Ringers's avatar
Sietse Ringers committed
130
131
132
133
134
135
136
137
138
139
140
141
142
// Attribute returns the content of the specified attribute, or "" if not present in this attribute list.
func (al *AttributeList) Attribute(identifier AttributeTypeIdentifier) TranslatedString {
	if al.CredentialType().Identifier() != identifier.CredentialTypeIdentifier() {
		return nil
	}
	for i, desc := range al.CredentialType().Attributes {
		if desc.ID == string(identifier.Name()) {
			return al.Strings()[i]
		}
	}
	return nil
}

143
// MetadataFromInt wraps the given Int
144
145
func MetadataFromInt(i *big.Int, conf *Configuration) *MetadataAttribute {
	return &MetadataAttribute{Int: i, Conf: conf}
146
147
148
149
150
151
152
153
}

// NewMetadataAttribute constructs a new instance containing the default values:
// 0x02 as versionField
// now as signing date
// 0 as keycounter
// ValidityDefault (half a year) as default validity.
func NewMetadataAttribute() *MetadataAttribute {
154
	val := MetadataAttribute{new(big.Int), nil, nil}
155
156
157
	val.setField(versionField, metadataVersion)
	val.setSigningDate()
	val.setKeyCounter(0)
158
	val.setDefaultValidityDuration()
159
160
161
162
163
164
165
166
167
168
169
170
171
172
	return &val
}

// Bytes returns this metadata attribute as a byte slice.
func (attr *MetadataAttribute) Bytes() []byte {
	bytes := attr.Int.Bytes()
	if len(bytes) < metadataLength {
		bytes = append(bytes, make([]byte, metadataLength-len(bytes))...)
	}
	return bytes
}

// PublicKey extracts identifier of the Idemix public key with which this instance was signed,
// and returns this public key.
173
func (attr *MetadataAttribute) PublicKey() (*gabi.PublicKey, error) {
174
	if attr.pk == nil {
175
		var err error
176
		attr.pk, err = attr.Conf.PublicKey(attr.CredentialType().IssuerIdentifier(), attr.KeyCounter())
177
178
179
		if err != nil {
			return nil, err
		}
180
	}
181
	return attr.pk, nil
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
}

// Version returns the metadata version of this instance
func (attr *MetadataAttribute) Version() byte {
	return attr.field(versionField)[0]
}

// SigningDate returns the time at which this instance was signed
func (attr *MetadataAttribute) SigningDate() time.Time {
	bytes := attr.field(signingDateField)
	bytes = bytes[1:] // The signing date field is one byte too long
	timestamp := int64(binary.BigEndian.Uint16(bytes)) * ExpiryFactor
	return time.Unix(timestamp, 0)
}

func (attr *MetadataAttribute) setSigningDate() {
	attr.setField(signingDateField, shortToByte(int(time.Now().Unix()/ExpiryFactor)))
}

// KeyCounter return the public key counter of the metadata attribute
func (attr *MetadataAttribute) KeyCounter() int {
	return int(binary.BigEndian.Uint16(attr.field(keyCounterField)))
}

func (attr *MetadataAttribute) setKeyCounter(i int) {
	attr.setField(keyCounterField, shortToByte(i))
}

// ValidityDuration returns the amount of epochs during which this instance is valid
func (attr *MetadataAttribute) ValidityDuration() int {
	return int(binary.BigEndian.Uint16(attr.field(validityField)))
}

func (attr *MetadataAttribute) setValidityDuration(weeks int) {
	attr.setField(validityField, shortToByte(weeks))
}

219
220
221
222
func (attr *MetadataAttribute) setDefaultValidityDuration() {
	attr.setExpiryDate(nil)
}

Sietse Ringers's avatar
Sietse Ringers committed
223
func (attr *MetadataAttribute) setExpiryDate(timestamp *Timestamp) error {
224
	var expiry int64
Sietse Ringers's avatar
Sietse Ringers committed
225
	if timestamp == nil {
226
		expiry = time.Now().AddDate(0, 6, 0).Unix()
227
228
	} else {
		expiry = time.Time(*timestamp).Unix()
Sietse Ringers's avatar
Sietse Ringers committed
229
	}
Sietse Ringers's avatar
Sietse Ringers committed
230
231
232
233
234
	signing := attr.SigningDate().Unix()
	attr.setValidityDuration(int((expiry - signing) / ExpiryFactor))
	return nil
}

235
// CredentialType returns the credential type of the current instance
236
// using the Configuration.
237
func (attr *MetadataAttribute) CredentialType() *CredentialType {
238
	return attr.Conf.hashToCredentialType(attr.field(credentialID))
239
240
}

241
func (attr *MetadataAttribute) setCredentialTypeIdentifier(id string) {
242
243
244
245
	bytes := sha256.Sum256([]byte(id))
	attr.setField(credentialID, bytes[:16])
}

246
247
248
249
func (attr *MetadataAttribute) CredentialTypeHash() []byte {
	return attr.field(credentialID)
}

250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
// Expiry returns the expiry date of this instance
func (attr *MetadataAttribute) Expiry() time.Time {
	expiry := attr.SigningDate().Unix() + int64(attr.ValidityDuration()*ExpiryFactor)
	return time.Unix(expiry, 0)
}

// IsValidOn returns whether this instance is still valid at the given time
func (attr *MetadataAttribute) IsValidOn(t time.Time) bool {
	return attr.Expiry().After(t)
}

// IsValid returns whether this instance is valid.
func (attr *MetadataAttribute) IsValid() bool {
	return attr.IsValidOn(time.Now())
}

Sietse Ringers's avatar
Sietse Ringers committed
266
func (attr *MetadataAttribute) field(field metadataField) []byte {
267
268
269
	return attr.Bytes()[field.offset : field.offset+field.length]
}

Sietse Ringers's avatar
Sietse Ringers committed
270
func (attr *MetadataAttribute) setField(field metadataField, value []byte) {
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
	if len(value) > field.length {
		panic("Specified metadata field too large")
	}

	bytes := attr.Bytes()

	// Push the value to the right within the field. Graphical representation:
	// --xxxXXX----
	// "-" indicates a byte of another field
	// "X" is a byte of the value and "x" of our field
	// In this example, our field has offset 2, length 6,
	// but the specified value is only 3 bytes long.
	startindex := field.length - len(value)
	for i := 0; i < field.length; i++ {
		if i < startindex {
			bytes[i+field.offset] = 0
		} else {
			bytes[i+field.offset] = value[i-startindex]
		}
	}

	attr.Int.SetBytes(bytes)
}

func shortToByte(x int) []byte {
	bytes := make([]byte, 2)
	binary.BigEndian.PutUint16(bytes, uint16(x))
	return bytes
}
300

301
302
303
304
305
// A DisclosureChoice contains the attributes chosen to be disclosed.
type DisclosureChoice struct {
	Attributes []*AttributeIdentifier
}

306
307
308
309
310
311
312
313
314
315
// An AttributeDisjunction encapsulates a list of possible attributes, one
// of which should be disclosed.
type AttributeDisjunction struct {
	Label      string
	Attributes []AttributeTypeIdentifier
	Values     map[AttributeTypeIdentifier]string

	selected *AttributeTypeIdentifier
}

Koen van Ingen's avatar
Koen van Ingen committed
316
// AttributeDisjunction with the disclosed value that is used to satisfy the disjunction
317
318
319
320
321
322
323
324
type DisclosedAttributeDisjunction struct {
	AttributeDisjunction

	DisclosedValue string
	DisclosedId    AttributeTypeIdentifier
	ProofStatus    AttributeProofStatus
}

325
326
327
// An AttributeDisjunctionList is a list of AttributeDisjunctions.
type AttributeDisjunctionList []*AttributeDisjunction

328
329
330
331
332
333
334
335
336
func NewDisclosedDisjunctionFromList(ad *AttributeDisjunction, ar *AttributeResult) *DisclosedAttributeDisjunction {
	return &DisclosedAttributeDisjunction{
		AttributeDisjunction: *ad,
		DisclosedValue:       ar.AttributeValue,
		DisclosedId:          ar.AttributeId,
		ProofStatus:          ar.AttributeProofStatus,
	}
}

337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
// HasValues indicates if the attributes of this disjunction have values
// that should be satisfied.
func (disjunction *AttributeDisjunction) HasValues() bool {
	return disjunction.Values != nil && len(disjunction.Values) != 0
}

// Satisfied indicates if this disjunction has a valid chosen attribute
// to be disclosed.
func (disjunction *AttributeDisjunction) Satisfied() bool {
	if disjunction.selected == nil {
		return false
	}
	for _, attr := range disjunction.Attributes {
		if *disjunction.selected == attr {
			return true
		}
	}
	return false
}

357
358
359
// Helper function to check if an attribute is satisfied against a list of disclosed attributes
// This is the case if:
// attribute is contained in disclosed AND if a value is present: equal to that value
360
// al can be nil if you don't want to include attribute status for proof
361
362
363
364
365
func isAttributeSatisfied(attributeId AttributeTypeIdentifier, requestedValue string, disclosed []*DisclosedCredential) (bool, *AttributeResult) {
	ar := AttributeResult{
		AttributeId: attributeId,
	}

366
	for _, cred := range disclosed {
367
		disclosedAttributeValue := cred.GetAttributeValue(attributeId)
368

369
370
		// Continue to next credential if requested attribute isn't disclosed in this credential
		if disclosedAttributeValue == "" {
371
372
373
			continue
		}

374
		// If this is the disclosed attribute, check if value matches
375
		// Attribute is satisfied if:
376
377
		// - Attribute is disclosed (i.e. not nil)
		// - Value is empty OR value equal to disclosedValue
378
379
380
381
382
383
384
385
386
		ar.AttributeValue = disclosedAttributeValue

		if requestedValue == "" || disclosedAttributeValue == requestedValue {
			ar.AttributeProofStatus = PRESENT
			return true, &ar
		} else {
			// If attribute is disclosed and present, but not equal to required value, mark it as invalid_value
			// We won't return true and continue searching in other disclosed attributes
			ar.AttributeProofStatus = INVALID_VALUE
387
388
		}
	}
389
390
391
392
393
394

	// If there is never a value assigned, then this attribute isn't disclosed, and thus missing
	if ar.AttributeValue == "" {
		ar.AttributeProofStatus = MISSING
	}
	return false, &ar
395
396
397
398
}

// Check whether specified attributedisjunction satisfy a list of disclosed attributes
// We return true if one of the attributes in the disjunction is satisfied
399
400
func (disjunction *AttributeDisjunction) SatisfyDisclosed(disclosed []*DisclosedCredential, conf *Configuration) (bool, *DisclosedAttributeDisjunction) {
	var attributeResult *AttributeResult
401
	for _, attr := range disjunction.Attributes {
402
		requestedValue := disjunction.Values[attr]
403

404
405
		var isSatisfied bool
		isSatisfied, attributeResult = isAttributeSatisfied(attr, requestedValue, disclosed)
406

407
408
		if isSatisfied {
			return true, NewDisclosedDisjunctionFromList(disjunction, attributeResult)
409
410
411
		}
	}

412
413
414
	// Nothing satisfied, attributeResult will contain the last attribute of the original request
	// TODO: do we want this?
	return false, NewDisclosedDisjunctionFromList(disjunction, attributeResult)
415
416
}

417
418
419
// MatchesConfig returns true if all attributes contained in the disjunction are
// present in the specified configuration.
func (disjunction *AttributeDisjunction) MatchesConfig(conf *Configuration) bool {
420
	for ai := range disjunction.Values {
421
		creddescription, exists := conf.CredentialTypes[ai.CredentialTypeIdentifier()]
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
		if !exists {
			return false
		}
		if !creddescription.ContainsAttribute(ai) {
			return false
		}
	}
	return true
}

// Satisfied indicates whether each contained attribute disjunction has a chosen attribute.
func (dl AttributeDisjunctionList) Satisfied() bool {
	for _, disjunction := range dl {
		if !disjunction.Satisfied() {
			return false
		}
	}
	return true
}

// Find searches for and returns the disjunction that contains the specified attribute identifier, or nil if not found.
func (dl AttributeDisjunctionList) Find(ai AttributeTypeIdentifier) *AttributeDisjunction {
	for _, disjunction := range dl {
		for _, attr := range disjunction.Attributes {
			if attr == ai {
				return disjunction
			}
		}
	}
	return nil
}

// MarshalJSON marshals the disjunction to JSON.
func (disjunction *AttributeDisjunction) MarshalJSON() ([]byte, error) {
	if !disjunction.HasValues() {
		temp := struct {
			Label      string                    `json:"label"`
			Attributes []AttributeTypeIdentifier `json:"attributes"`
		}{
			Label:      disjunction.Label,
			Attributes: disjunction.Attributes,
		}
		return json.Marshal(temp)
	}

	temp := struct {
		Label      string                             `json:"label"`
		Attributes map[AttributeTypeIdentifier]string `json:"attributes"`
	}{
		Label:      disjunction.Label,
		Attributes: disjunction.Values,
	}
	return json.Marshal(temp)
}

// UnmarshalJSON unmarshals an attribute disjunction from JSON.
func (disjunction *AttributeDisjunction) UnmarshalJSON(bytes []byte) error {
	if disjunction.Values == nil {
		disjunction.Values = make(map[AttributeTypeIdentifier]string)
	}
	if disjunction.Attributes == nil {
		disjunction.Attributes = make([]AttributeTypeIdentifier, 0, 3)
	}

	// We don't know if the json element "attributes" is a list, or a map.
	// So we unmarshal it into a temporary struct that has interface{} as the
	// type of "attributes", so that we can check which of the two it is.
	temp := struct {
		Label      string      `json:"label"`
		Attributes interface{} `json:"attributes"`
	}{}
Sietse Ringers's avatar
Sietse Ringers committed
493
494
495
	if err := json.Unmarshal(bytes, &temp); err != nil {
		return err
	}
496
497
498
499
500
501
502
503
	disjunction.Label = temp.Label

	switch temp.Attributes.(type) {
	case map[string]interface{}:
		temp := struct {
			Label      string            `json:"label"`
			Attributes map[string]string `json:"attributes"`
		}{}
Sietse Ringers's avatar
Sietse Ringers committed
504
505
506
		if err := json.Unmarshal(bytes, &temp); err != nil {
			return err
		}
507
508
509
510
511
512
513
514
515
516
		for str, value := range temp.Attributes {
			id := NewAttributeTypeIdentifier(str)
			disjunction.Attributes = append(disjunction.Attributes, id)
			disjunction.Values[id] = value
		}
	case []interface{}:
		temp := struct {
			Label      string   `json:"label"`
			Attributes []string `json:"attributes"`
		}{}
Sietse Ringers's avatar
Sietse Ringers committed
517
518
519
		if err := json.Unmarshal(bytes, &temp); err != nil {
			return err
		}
520
521
522
523
524
525
526
527
528
		for _, str := range temp.Attributes {
			disjunction.Attributes = append(disjunction.Attributes, NewAttributeTypeIdentifier(str))
		}
	default:
		return errors.New("could not parse attribute disjunction: element 'attributes' was incorrect")
	}

	return nil
}
529

530
531
func (al *AttributeResultList) Append(result *AttributeResult) {
	al.AttributeResults = append(al.AttributeResults, result)
532
533
534
535
536
537
538
539
540
541
542
543
544
545
}

func (al *AttributeResultList) String() string {
	// TODO: pretty print?
	str := "Attribute --- Value --- ProofStatus:"
	for _, v := range al.AttributeResults {
		str = str + "\n" + v.String()
	}
	return str
}

func (ar *AttributeResult) String() string {
	return fmt.Sprintf("%v --- %v --- %v",
		ar.AttributeId,
546
		ar.AttributeValue,
547
548
		ar.AttributeProofStatus)
}