requests.go 12.8 KB
Newer Older
1
package irma
2
3
4
5
6
7
8

import (
	"fmt"
	"math/big"
	"strconv"
	"time"

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

Sietse Ringers's avatar
Sietse Ringers committed
14
// SessionRequest contains the context and nonce for an IRMA session.
15
type SessionRequest struct {
16
17
18
	Context    *big.Int                 `json:"context"`
	Nonce      *big.Int                 `json:"nonce"`
	Candidates [][]*AttributeIdentifier `json:"-"`
19
20
21

	Choice *DisclosureChoice  `json:"-"`
	Ids    *IrmaIdentifierSet `json:"-"`
22
23

	version *ProtocolVersion
Sietse Ringers's avatar
Sietse Ringers committed
24
25
}

26
27
28
29
func (sr *SessionRequest) SetCandidates(candidates [][]*AttributeIdentifier) {
	sr.Candidates = candidates
}

30
// DisclosureChoice returns the attributes to be disclosed in this session.
Sietse Ringers's avatar
Sietse Ringers committed
31
func (sr *SessionRequest) DisclosureChoice() *DisclosureChoice {
32
	return sr.Choice
Sietse Ringers's avatar
Sietse Ringers committed
33
34
}

35
// SetDisclosureChoice sets the attributes to be disclosed in this session.
Sietse Ringers's avatar
Sietse Ringers committed
36
func (sr *SessionRequest) SetDisclosureChoice(choice *DisclosureChoice) {
37
	sr.Choice = choice
38
39
}

40
41
42
43
44
45
46
47
48
49
// ...
func (sr *SessionRequest) SetVersion(v *ProtocolVersion) {
	sr.version = v
}

// ...
func (sr *SessionRequest) GetVersion() *ProtocolVersion {
	return sr.version
}

Sietse Ringers's avatar
Sietse Ringers committed
50
// A DisclosureRequest is a request to disclose certain attributes.
51
52
53
54
55
type DisclosureRequest struct {
	SessionRequest
	Content AttributeDisjunctionList `json:"content"`
}

Sietse Ringers's avatar
Sietse Ringers committed
56
// A SignatureRequest is a a request to sign a message with certain attributes.
57
58
type SignatureRequest struct {
	DisclosureRequest
59
	Message string `json:"message"`
60
61
}

Sietse Ringers's avatar
Sietse Ringers committed
62
63
// An IssuanceRequest is a request to issue certain credentials,
// optionally also asking for certain attributes to be simultaneously disclosed.
64
65
type IssuanceRequest struct {
	SessionRequest
66
67
68
	Credentials        []*CredentialRequest     `json:"credentials"`
	Disclose           AttributeDisjunctionList `json:"disclose"`
	CredentialInfoList CredentialInfoList       `json:",omitempty"`
69
70
}

Sietse Ringers's avatar
Sietse Ringers committed
71
72
// A CredentialRequest contains the attributes and metadata of a credential
// that will be issued in an IssuanceRequest.
73
type CredentialRequest struct {
74
75
76
77
	Validity         *Timestamp                `json:"validity"`
	KeyCounter       int                       `json:"keyCounter"`
	CredentialTypeID *CredentialTypeIdentifier `json:"credential"`
	Attributes       map[string]string         `json:"attributes"`
Sietse Ringers's avatar
Sietse Ringers committed
78
79
}

Sietse Ringers's avatar
Sietse Ringers committed
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
// ServerJwt contains standard JWT fields.
type ServerJwt struct {
	Type       string    `json:"sub"`
	ServerName string    `json:"iss"`
	IssuedAt   Timestamp `json:"iat"`
}

// A ServiceProviderRequest contains a disclosure request.
type ServiceProviderRequest struct {
	Request *DisclosureRequest `json:"request"`
}

// A SignatureRequestorRequest contains a signing request.
type SignatureRequestorRequest struct {
	Request *SignatureRequest `json:"request"`
}

// An IdentityProviderRequest contains an issuance request.
type IdentityProviderRequest struct {
	Request *IssuanceRequest `json:"request"`
}

// ServiceProviderJwt is a requestor JWT for a disclosure session.
type ServiceProviderJwt struct {
	ServerJwt
	Request ServiceProviderRequest `json:"sprequest"`
}

// SignatureRequestorJwt is a requestor JWT for a signing session.
type SignatureRequestorJwt struct {
	ServerJwt
	Request SignatureRequestorRequest `json:"absrequest"`
}

// IdentityProviderJwt is a requestor JWT for issuance session.
type IdentityProviderJwt struct {
	ServerJwt
	Request IdentityProviderRequest `json:"iprequest"`
}

120
121
122
123
124
125
// IrmaSession is an IRMA session.
type IrmaSession interface {
	GetNonce() *big.Int
	SetNonce(*big.Int)
	GetContext() *big.Int
	SetContext(*big.Int)
126
	SetVersion(*ProtocolVersion)
127
	ToDisclose() AttributeDisjunctionList
128
129
	DisclosureChoice() *DisclosureChoice
	SetDisclosureChoice(choice *DisclosureChoice)
130
	SetCandidates(candidates [][]*AttributeIdentifier)
131
132
133
	Identifiers() *IrmaIdentifierSet
}

Sietse Ringers's avatar
Sietse Ringers committed
134
135
136
// Timestamp is a time.Time that marshals to Unix timestamps.
type Timestamp time.Time

137
138
func (cr *CredentialRequest) Info(conf *Configuration, metadataVersion byte) (*CredentialInfo, error) {
	list, err := cr.AttributeList(conf, metadataVersion)
139
140
141
	if err != nil {
		return nil, err
	}
142
	return NewCredentialInfo(list.Ints, conf), nil
143
144
}

Sietse Ringers's avatar
Sietse Ringers committed
145
// AttributeList returns the list of attributes from this credential request.
146
147
func (cr *CredentialRequest) AttributeList(conf *Configuration, metadataVersion byte) (*AttributeList, error) {
	meta := NewMetadataAttribute(metadataVersion)
Sietse Ringers's avatar
Sietse Ringers committed
148
	meta.setKeyCounter(cr.KeyCounter)
149
	meta.setCredentialTypeIdentifier(cr.CredentialTypeID.String())
Sietse Ringers's avatar
Sietse Ringers committed
150
151
152
153
154
155
	meta.setSigningDate()
	err := meta.setExpiryDate(cr.Validity)
	if err != nil {
		return nil, err
	}

156
	credtype := conf.CredentialTypes[*cr.CredentialTypeID]
Sietse Ringers's avatar
Sietse Ringers committed
157
158
159
	if credtype == nil {
		return nil, errors.New("Unknown credential type")
	}
160
161
162
163
164
165
166
167
168
169
170
171
172
173

	// Check that there are no attributes in the credential request that aren't
	// in the credential descriptor.
	for crName := range cr.Attributes {
		found := false
		for _, ad := range credtype.Attributes {
			if ad.ID == crName {
				found = true
				break
			}
		}
		if !found {
			return nil, errors.New("Unknown CR attribute")
		}
Sietse Ringers's avatar
Sietse Ringers committed
174
175
	}

176
	attrs := make([]*big.Int, len(credtype.Attributes)+1)
Sietse Ringers's avatar
Sietse Ringers committed
177
178
	attrs[0] = meta.Int
	for i, attrtype := range credtype.Attributes {
179
		attrs[i+1] = new(big.Int)
Sietse Ringers's avatar
Sietse Ringers committed
180
		if str, present := cr.Attributes[attrtype.ID]; present {
181
			// Set attribute to str << 1 + 1
182
			attrs[i+1].SetBytes([]byte(str))
183
184
185
186
			if meta.Version() >= 0x03 {
				attrs[i+1].Lsh(attrs[i+1], 1)             // attr <<= 1
				attrs[i+1].Add(attrs[i+1], big.NewInt(1)) // attr += 1
			}
Sietse Ringers's avatar
Sietse Ringers committed
187
		} else {
188
			if attrtype.Optional != "true" {
189
190
				return nil, errors.New("Required attribute not provided")
			}
Sietse Ringers's avatar
Sietse Ringers committed
191
192
193
		}
	}

194
	return NewAttributeListFromInts(attrs, conf), nil
Sietse Ringers's avatar
Sietse Ringers committed
195
196
}

Sietse Ringers's avatar
Sietse Ringers committed
197
func (ir *IssuanceRequest) Identifiers() *IrmaIdentifierSet {
198
199
	if ir.Ids == nil {
		ir.Ids = &IrmaIdentifierSet{
200
201
202
203
			SchemeManagers:  map[SchemeManagerIdentifier]struct{}{},
			Issuers:         map[IssuerIdentifier]struct{}{},
			CredentialTypes: map[CredentialTypeIdentifier]struct{}{},
			PublicKeys:      map[IssuerIdentifier][]int{},
Sietse Ringers's avatar
Sietse Ringers committed
204
205
		}

Sietse Ringers's avatar
Sietse Ringers committed
206
		for _, credreq := range ir.Credentials {
Sietse Ringers's avatar
Sietse Ringers committed
207
			issuer := credreq.CredentialTypeID.IssuerIdentifier()
208
209
210
211
212
			ir.Ids.SchemeManagers[issuer.SchemeManagerIdentifier()] = struct{}{}
			ir.Ids.Issuers[issuer] = struct{}{}
			ir.Ids.CredentialTypes[*credreq.CredentialTypeID] = struct{}{}
			if ir.Ids.PublicKeys[issuer] == nil {
				ir.Ids.PublicKeys[issuer] = []int{}
213
			}
214
			ir.Ids.PublicKeys[issuer] = append(ir.Ids.PublicKeys[issuer], credreq.KeyCounter)
215
216
		}

Sietse Ringers's avatar
Sietse Ringers committed
217
		for _, disjunction := range ir.Disclose {
218
			for _, attr := range disjunction.Attributes {
Sietse Ringers's avatar
Sietse Ringers committed
219
220
221
222
223
224
				var cti CredentialTypeIdentifier
				if !attr.IsCredential() {
					cti = attr.CredentialTypeIdentifier()
				} else {
					cti = NewCredentialTypeIdentifier(attr.String())
				}
225
226
227
				ir.Ids.SchemeManagers[cti.IssuerIdentifier().SchemeManagerIdentifier()] = struct{}{}
				ir.Ids.Issuers[cti.IssuerIdentifier()] = struct{}{}
				ir.Ids.CredentialTypes[cti] = struct{}{}
228
			}
Sietse Ringers's avatar
Sietse Ringers committed
229
230
		}
	}
231
	return ir.Ids
Sietse Ringers's avatar
Sietse Ringers committed
232
233
}

Sietse Ringers's avatar
Sietse Ringers committed
234
// ToDisclose returns the attributes that must be disclosed in this issuance session.
235
236
237
238
239
240
241
func (ir *IssuanceRequest) ToDisclose() AttributeDisjunctionList {
	if ir.Disclose == nil {
		return AttributeDisjunctionList{}
	}

	return ir.Disclose
}
Sietse Ringers's avatar
Sietse Ringers committed
242
243
244
245
246
247
248
249
250
251
252
253
254

// GetContext returns the context of this session.
func (ir *IssuanceRequest) GetContext() *big.Int { return ir.Context }

// SetContext sets the context of this session.
func (ir *IssuanceRequest) SetContext(context *big.Int) { ir.Context = context }

// GetNonce returns the nonce of this session.
func (ir *IssuanceRequest) GetNonce() *big.Int { return ir.Nonce }

// SetNonce sets the nonce of this session.
func (ir *IssuanceRequest) SetNonce(nonce *big.Int) { ir.Nonce = nonce }

255
func (dr *DisclosureRequest) Identifiers() *IrmaIdentifierSet {
256
257
	if dr.Ids == nil {
		dr.Ids = &IrmaIdentifierSet{
258
259
260
261
			SchemeManagers:  map[SchemeManagerIdentifier]struct{}{},
			Issuers:         map[IssuerIdentifier]struct{}{},
			CredentialTypes: map[CredentialTypeIdentifier]struct{}{},
			PublicKeys:      map[IssuerIdentifier][]int{},
Sietse Ringers's avatar
Sietse Ringers committed
262
		}
263
264
		for _, disjunction := range dr.Content {
			for _, attr := range disjunction.Attributes {
265
266
267
				dr.Ids.SchemeManagers[attr.CredentialTypeIdentifier().IssuerIdentifier().SchemeManagerIdentifier()] = struct{}{}
				dr.Ids.Issuers[attr.CredentialTypeIdentifier().IssuerIdentifier()] = struct{}{}
				dr.Ids.CredentialTypes[attr.CredentialTypeIdentifier()] = struct{}{}
268
			}
Sietse Ringers's avatar
Sietse Ringers committed
269
270
		}
	}
271
	return dr.Ids
Sietse Ringers's avatar
Sietse Ringers committed
272
273
}

Sietse Ringers's avatar
Sietse Ringers committed
274
275
// ToDisclose returns the attributes to be disclosed in this session.
func (dr *DisclosureRequest) ToDisclose() AttributeDisjunctionList { return dr.Content }
Sietse Ringers's avatar
Sietse Ringers committed
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290

// GetContext returns the context of this session.
func (dr *DisclosureRequest) GetContext() *big.Int { return dr.Context }

// SetContext sets the context of this session.
func (dr *DisclosureRequest) SetContext(context *big.Int) { dr.Context = context }

// GetNonce returns the nonce of this session.
func (dr *DisclosureRequest) GetNonce() *big.Int { return dr.Nonce }

// SetNonce sets the nonce of this session.
func (dr *DisclosureRequest) SetNonce(nonce *big.Int) { dr.Nonce = nonce }

// GetNonce returns the nonce of this signature session
// (with the message already hashed into it).
291
func (sr *SignatureRequest) GetNonce() *big.Int {
292
	return ASN1ConvertSignatureNonce(sr.Message, sr.Nonce)
293
294
}

295
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
// Convert fields in JSON string to BigInterger if they are string
// Supply fieldnames as a slice as second argument
func convertFieldsToBigInt(jsonString []byte, fieldNames []string) ([]byte, error) {
	var rawRequest map[string]interface{}

	err := json.Unmarshal(jsonString, &rawRequest)
	if err != nil {
		return nil, err
	}

	for _, fieldName := range fieldNames {
		field := new(big.Int)
		fieldString := fmt.Sprintf("%v", rawRequest[fieldName])
		field.SetString(fieldString, 10)
		rawRequest[fieldName] = field
	}

	return json.Marshal(rawRequest)
}

// Custom Unmarshalling to support both json with string and int fields for nonce and context
// i.e. {"nonce": "42", "context": "1337", ... } and {"nonce": 42, "context": 1337, ... }
func (sr *SignatureRequest) UnmarshalJSON(b []byte) error {
	type SignatureRequestTemp SignatureRequest // To avoid 'recursive unmarshalling'

	fixedRequest, err := convertFieldsToBigInt(b, []string{"nonce", "context"})
Koen van Ingen's avatar
Koen van Ingen committed
321
322
323
	if err != nil {
		return err
	}
324
325

	var result SignatureRequestTemp
Koen van Ingen's avatar
Koen van Ingen committed
326
327
328
329
	err = json.Unmarshal(fixedRequest, &result)
	if err != nil {
		return err
	}
330
331
332
333
334
335
336

	sr.DisclosureRequest = result.DisclosureRequest
	sr.Message = result.Message

	return err
}

337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
func (sr *SignatureRequest) SignatureFromMessage(message interface{}) (*IrmaSignedMessage, error) {
	signature, ok := message.(gabi.ProofList)

	if !ok {
		return nil, errors.Errorf("Type assertion failed")
	}

	return &IrmaSignedMessage{
		Signature: &signature,
		Nonce:     sr.Nonce,
		Context:   sr.Context,
		Message:   sr.Message,
	}, nil
}

352
353
354
355
356
// Check if Timestamp is before other Timestamp. Used for checking expiry of attributes
func (t Timestamp) Before(u Timestamp) bool {
	return time.Time(t).Before(time.Time(u))
}

357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
// MarshalJSON marshals a timestamp.
func (t *Timestamp) MarshalJSON() ([]byte, error) {
	ts := time.Time(*t).Unix()
	stamp := fmt.Sprint(ts)
	return []byte(stamp), nil
}

// UnmarshalJSON unmarshals a timestamp.
func (t *Timestamp) UnmarshalJSON(b []byte) error {
	ts, err := strconv.Atoi(string(b))
	if err != nil {
		return err
	}
	*t = Timestamp(time.Unix(int64(ts), 0))
	return nil
}
Sietse Ringers's avatar
Sietse Ringers committed
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

// NewServiceProviderJwt returns a new ServiceProviderJwt.
func NewServiceProviderJwt(servername string, dr *DisclosureRequest) *ServiceProviderJwt {
	return &ServiceProviderJwt{
		ServerJwt: ServerJwt{
			ServerName: servername,
			IssuedAt:   Timestamp(time.Now()),
			Type:       "verification_request",
		},
		Request: ServiceProviderRequest{Request: dr},
	}
}

// NewSignatureRequestorJwt returns a new SignatureRequestorJwt.
func NewSignatureRequestorJwt(servername string, sr *SignatureRequest) *SignatureRequestorJwt {
	return &SignatureRequestorJwt{
		ServerJwt: ServerJwt{
			ServerName: servername,
			IssuedAt:   Timestamp(time.Now()),
			Type:       "signature_request",
		},
		Request: SignatureRequestorRequest{Request: sr},
	}
}

// NewIdentityProviderJwt returns a new IdentityProviderJwt.
func NewIdentityProviderJwt(servername string, ir *IssuanceRequest) *IdentityProviderJwt {
	return &IdentityProviderJwt{
		ServerJwt: ServerJwt{
			ServerName: servername,
			IssuedAt:   Timestamp(time.Now()),
			Type:       "issue_request",
		},
		Request: IdentityProviderRequest{Request: ir},
	}
}

// A RequestorJwt contains an IRMA session object.
type RequestorJwt interface {
412
	IrmaSession() IrmaSession
413
	Requestor() string
Sietse Ringers's avatar
Sietse Ringers committed
414
415
}

416
417
func (jwt *ServerJwt) Requestor() string { return jwt.ServerName }

Sietse Ringers's avatar
Sietse Ringers committed
418
// IrmaSession returns an IRMA session object.
419
func (jwt *ServiceProviderJwt) IrmaSession() IrmaSession { return jwt.Request.Request }
Sietse Ringers's avatar
Sietse Ringers committed
420
421

// IrmaSession returns an IRMA session object.
422
func (jwt *SignatureRequestorJwt) IrmaSession() IrmaSession { return jwt.Request.Request }
Sietse Ringers's avatar
Sietse Ringers committed
423
424

// IrmaSession returns an IRMA session object.
425
func (jwt *IdentityProviderJwt) IrmaSession() IrmaSession { return jwt.Request.Request }