attributes.go 14.2 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

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

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

var (
	metadataVersion = []byte{0x02}

Sietse Ringers's avatar
Sietse Ringers committed
24
25
26
27
28
	versionField     = metadataField{1, 0}
	signingDateField = metadataField{3, 1}
	validityField    = metadataField{2, 4}
	keyCounterField  = metadataField{2, 6}
	credentialID     = metadataField{16, 8}
29
30
)

Sietse Ringers's avatar
Sietse Ringers committed
31
32
// metadataField contains the length and offset of a field within a metadata attribute.
type metadataField struct {
33
34
35
36
37
38
	length int
	offset int
}

// MetadataAttribute represent a metadata attribute. Contains the credential type, signing date, validity, and the public key counter.
type MetadataAttribute struct {
39
40
41
	Int  *big.Int
	pk   *gabi.PublicKey
	Conf *Configuration
42
43
}

44
45
46
// AttributeList contains attributes, excluding the secret key,
// providing convenient access to the metadata attribute.
type AttributeList struct {
47
	*MetadataAttribute `json:"-"`
48
	Ints               []*big.Int
Sietse Ringers's avatar
Sietse Ringers committed
49
	strings            []TranslatedString
50
	info               *CredentialInfo
51
	h                  string
52
53
}

54
// NewAttributeListFromInts initializes a new AttributeList from a list of bigints.
55
func NewAttributeListFromInts(ints []*big.Int, conf *Configuration) *AttributeList {
56
	return &AttributeList{
57
		Ints:              ints,
58
		MetadataAttribute: MetadataFromInt(ints[0], conf),
59
	}
60
61
}

62
63
64
65
66
67
68
69
70
71
// NewAttributeListFromInts initializes a new AttributeList from disclosed attributes of a prooflist
func NewAttributeListFromADisclosed(aResponses map[int]*big.Int, aDisclosed map[int]*big.Int, conf *Configuration) (*AttributeList, error) {
	ints, err := convertProofResponsesToInts(aResponses, aDisclosed)
	if err != nil {
		return nil, err
	}

	return NewAttributeListFromInts(ints, conf), nil
}

72
func (al *AttributeList) Info() *CredentialInfo {
73
	if al.info == nil {
74
		al.info = NewCredentialInfo(al.Ints, al.Conf)
75
	}
76
	return al.info
77
78
}

79
func (al *AttributeList) Hash() string {
80
81
82
	if al.h == "" {
		bytes := []byte{}
		for _, i := range al.Ints {
83
84
85
			if i != nil {
				bytes = append(bytes, i.Bytes()...)
			}
86
87
88
		}
		shasum := sha256.Sum256(bytes)
		al.h = hex.EncodeToString(shasum[:])
89
	}
90
	return al.h
91
92
}

93
// Strings converts the current instance to human-readable strings.
Sietse Ringers's avatar
Sietse Ringers committed
94
func (al *AttributeList) Strings() []TranslatedString {
95
	if al.strings == nil {
Sietse Ringers's avatar
Sietse Ringers committed
96
		al.strings = make([]TranslatedString, len(al.Ints)-1)
97
		for index, num := range al.Ints[1:] { // skip metadata
98
99
100
101
102
			if num == nil {
				al.strings[index] = nil
			} else {
				al.strings[index] = map[string]string{"en": string(num.Bytes()), "nl": string(num.Bytes())} // TODO
			}
103
104
105
106
		}
	}
	return al.strings
}
107

108
func (al *AttributeList) UntranslatedAttribute(identifier AttributeTypeIdentifier) string {
109
110
111
	if al.CredentialType().Identifier() != identifier.CredentialTypeIdentifier() {
		return ""
	}
112
	for i, desc := range al.CredentialType().Attributes {
113
		if desc.ID == string(identifier.Name()) {
Sietse Ringers's avatar
Sietse Ringers committed
114
			return string(al.Ints[i+1].Bytes())
115
116
117
118
119
		}
	}
	return ""
}

Sietse Ringers's avatar
Sietse Ringers committed
120
121
122
123
124
125
126
127
128
129
130
131
132
// 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
}

133
// MetadataFromInt wraps the given Int
134
135
func MetadataFromInt(i *big.Int, conf *Configuration) *MetadataAttribute {
	return &MetadataAttribute{Int: i, Conf: conf}
136
137
138
139
140
141
142
143
}

// 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 {
144
	val := MetadataAttribute{new(big.Int), nil, nil}
145
146
147
	val.setField(versionField, metadataVersion)
	val.setSigningDate()
	val.setKeyCounter(0)
148
	val.setDefaultValidityDuration()
149
150
151
152
153
154
155
156
157
158
159
160
161
162
	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.
163
func (attr *MetadataAttribute) PublicKey() (*gabi.PublicKey, error) {
164
	if attr.pk == nil {
165
		var err error
166
		attr.pk, err = attr.Conf.PublicKey(attr.CredentialType().IssuerIdentifier(), attr.KeyCounter())
167
168
169
		if err != nil {
			return nil, err
		}
170
	}
171
	return attr.pk, nil
172
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
}

// 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))
}

209
210
211
212
func (attr *MetadataAttribute) setDefaultValidityDuration() {
	attr.setExpiryDate(nil)
}

Sietse Ringers's avatar
Sietse Ringers committed
213
func (attr *MetadataAttribute) setExpiryDate(timestamp *Timestamp) error {
214
	var expiry int64
Sietse Ringers's avatar
Sietse Ringers committed
215
	if timestamp == nil {
216
		expiry = time.Now().AddDate(0, 6, 0).Unix()
217
218
	} else {
		expiry = time.Time(*timestamp).Unix()
Sietse Ringers's avatar
Sietse Ringers committed
219
	}
Sietse Ringers's avatar
Sietse Ringers committed
220
221
222
223
224
	signing := attr.SigningDate().Unix()
	attr.setValidityDuration(int((expiry - signing) / ExpiryFactor))
	return nil
}

225
// CredentialType returns the credential type of the current instance
226
// using the Configuration.
227
func (attr *MetadataAttribute) CredentialType() *CredentialType {
228
	return attr.Conf.hashToCredentialType(attr.field(credentialID))
229
230
}

231
func (attr *MetadataAttribute) setCredentialTypeIdentifier(id string) {
232
233
234
235
	bytes := sha256.Sum256([]byte(id))
	attr.setField(credentialID, bytes[:16])
}

236
237
238
239
func (attr *MetadataAttribute) CredentialTypeHash() []byte {
	return attr.field(credentialID)
}

240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
// 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
256
func (attr *MetadataAttribute) field(field metadataField) []byte {
257
258
259
	return attr.Bytes()[field.offset : field.offset+field.length]
}

Sietse Ringers's avatar
Sietse Ringers committed
260
func (attr *MetadataAttribute) setField(field metadataField, value []byte) {
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
	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
}
290

291
292
293
294
295
// A DisclosureChoice contains the attributes chosen to be disclosed.
type DisclosureChoice struct {
	Attributes []*AttributeIdentifier
}

296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
// 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
}

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

// 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
}

329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
// 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
func isAttributeSatisfied(attribute AttributeTypeIdentifier, value string, disclosed []*CredentialInfo, conf *Configuration) bool {
	for _, cred := range disclosed {
		credentialType := cred.GetCredentialType(conf)
		index, err := credentialType.IndexOf(attribute)

		if err != nil {
			// Specified credential does not contain this attribute, move to next cred in list of disclosed credentials
			continue
		}

		disclosedAttributeValue := cred.Attributes[index]
		// If it contains this attribute, check if value match (it must be disclosed (i.e. not nil) and match the value)
		// Attribute is Statiisfied if:
		// - Attribute is disclosed (i.e. not nil)
		// - Value is empty OR value equal to disclosedValue
		if disclosedAttributeValue != nil && (value == "" || disclosedAttributeValue["en"] == value) { // TODO: fix translation/attr typing
			return true
		}
	}
	return false
}

// Check whether specified attributedisjunction satisfy a list of disclosed attributes
// We return true if one of the attributes in the disjunction is satisfied
func (disjunction *AttributeDisjunction) SatisfyDisclosed(disclosed []*CredentialInfo, conf *Configuration) bool {
	for _, attr := range disjunction.Attributes {
		value := disjunction.Values[attr]

		if isAttributeSatisfied(attr, value, disclosed, conf) {
			return true
		}
	}

	return false
}

368
369
370
// MatchesConfig returns true if all attributes contained in the disjunction are
// present in the specified configuration.
func (disjunction *AttributeDisjunction) MatchesConfig(conf *Configuration) bool {
371
	for ai := range disjunction.Values {
372
		creddescription, exists := conf.CredentialTypes[ai.CredentialTypeIdentifier()]
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
		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
444
445
446
	if err := json.Unmarshal(bytes, &temp); err != nil {
		return err
	}
447
448
449
450
451
452
453
454
	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
455
456
457
		if err := json.Unmarshal(bytes, &temp); err != nil {
			return err
		}
458
459
460
461
462
463
464
465
466
467
		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
468
469
470
		if err := json.Unmarshal(bytes, &temp); err != nil {
			return err
		}
471
472
473
474
475
476
477
478
479
		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
}