requests.go 10.9 KB
Newer Older
1
package irma
2
3
4
5
6
7
8
9
10
11

import (
	"crypto/sha256"
	"encoding/asn1"
	"fmt"
	"log"
	"math/big"
	"strconv"
	"time"

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

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

	Choice *DisclosureChoice  `json:"-"`
	Ids    *IrmaIdentifierSet `json:"-"`
Sietse Ringers's avatar
Sietse Ringers committed
23
24
}

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

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

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

Sietse Ringers's avatar
Sietse Ringers committed
39
// A DisclosureRequest is a request to disclose certain attributes.
40
41
42
43
44
type DisclosureRequest struct {
	SessionRequest
	Content AttributeDisjunctionList `json:"content"`
}

Sietse Ringers's avatar
Sietse Ringers committed
45
// A SignatureRequest is a a request to sign a message with certain attributes.
46
47
48
49
50
51
type SignatureRequest struct {
	DisclosureRequest
	Message     string `json:"message"`
	MessageType string `json:"messageType"`
}

Sietse Ringers's avatar
Sietse Ringers committed
52
53
// An IssuanceRequest is a request to issue certain credentials,
// optionally also asking for certain attributes to be simultaneously disclosed.
54
55
type IssuanceRequest struct {
	SessionRequest
56
57
58
	Credentials        []*CredentialRequest     `json:"credentials"`
	Disclose           AttributeDisjunctionList `json:"disclose"`
	CredentialInfoList CredentialInfoList       `json:",omitempty"`
59
60
}

Sietse Ringers's avatar
Sietse Ringers committed
61
62
// A CredentialRequest contains the attributes and metadata of a credential
// that will be issued in an IssuanceRequest.
63
type CredentialRequest struct {
64
65
66
67
	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
68
69
}

Sietse Ringers's avatar
Sietse Ringers committed
70
71
72
73
74
75
76
77
78
79
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
// 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"`
}

110
111
112
113
114
115
// IrmaSession is an IRMA session.
type IrmaSession interface {
	GetNonce() *big.Int
	SetNonce(*big.Int)
	GetContext() *big.Int
	SetContext(*big.Int)
116
	ToDisclose() AttributeDisjunctionList
117
118
	DisclosureChoice() *DisclosureChoice
	SetDisclosureChoice(choice *DisclosureChoice)
119
	SetCandidates(candidates [][]*AttributeIdentifier)
120
121
122
	Identifiers() *IrmaIdentifierSet
}

Sietse Ringers's avatar
Sietse Ringers committed
123
124
125
// Timestamp is a time.Time that marshals to Unix timestamps.
type Timestamp time.Time

126
127
func (cr *CredentialRequest) Info(conf *Configuration) (*CredentialInfo, error) {
	list, err := cr.AttributeList(conf)
128
129
130
	if err != nil {
		return nil, err
	}
131
	return NewCredentialInfo(list.Ints, conf), nil
132
133
}

Sietse Ringers's avatar
Sietse Ringers committed
134
// AttributeList returns the list of attributes from this credential request.
135
func (cr *CredentialRequest) AttributeList(conf *Configuration) (*AttributeList, error) {
Sietse Ringers's avatar
Sietse Ringers committed
136
137
	meta := NewMetadataAttribute()
	meta.setKeyCounter(cr.KeyCounter)
138
	meta.setCredentialTypeIdentifier(cr.CredentialTypeID.String())
Sietse Ringers's avatar
Sietse Ringers committed
139
140
141
142
143
144
	meta.setSigningDate()
	err := meta.setExpiryDate(cr.Validity)
	if err != nil {
		return nil, err
	}

145
	credtype := conf.CredentialTypes[*cr.CredentialTypeID]
Sietse Ringers's avatar
Sietse Ringers committed
146
147
148
	if credtype == nil {
		return nil, errors.New("Unknown credential type")
	}
149
150
151
152
153
154
155
156
157
158
159
160
161
162

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

165
	attrs := make([]*big.Int, len(credtype.Attributes)+1)
Sietse Ringers's avatar
Sietse Ringers committed
166
167
	attrs[0] = meta.Int
	for i, attrtype := range credtype.Attributes {
168
		attrs[i+1] = new(big.Int)
Sietse Ringers's avatar
Sietse Ringers committed
169
		if str, present := cr.Attributes[attrtype.ID]; present {
170
			attrs[i+1].SetBytes([]byte(str))
Sietse Ringers's avatar
Sietse Ringers committed
171
		} else {
172
173
174
			if (attrtype.Optional != "true") {
				return nil, errors.New("Required attribute not provided")
			}
Sietse Ringers's avatar
Sietse Ringers committed
175
176
177
		}
	}

178
	return NewAttributeListFromInts(attrs, conf), nil
Sietse Ringers's avatar
Sietse Ringers committed
179
180
}

Sietse Ringers's avatar
Sietse Ringers committed
181
func (ir *IssuanceRequest) Identifiers() *IrmaIdentifierSet {
182
183
	if ir.Ids == nil {
		ir.Ids = &IrmaIdentifierSet{
184
185
186
187
			SchemeManagers:  map[SchemeManagerIdentifier]struct{}{},
			Issuers:         map[IssuerIdentifier]struct{}{},
			CredentialTypes: map[CredentialTypeIdentifier]struct{}{},
			PublicKeys:      map[IssuerIdentifier][]int{},
Sietse Ringers's avatar
Sietse Ringers committed
188
189
		}

Sietse Ringers's avatar
Sietse Ringers committed
190
		for _, credreq := range ir.Credentials {
Sietse Ringers's avatar
Sietse Ringers committed
191
			issuer := credreq.CredentialTypeID.IssuerIdentifier()
192
193
194
195
196
			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{}
197
			}
198
			ir.Ids.PublicKeys[issuer] = append(ir.Ids.PublicKeys[issuer], credreq.KeyCounter)
199
200
		}

Sietse Ringers's avatar
Sietse Ringers committed
201
		for _, disjunction := range ir.Disclose {
202
			for _, attr := range disjunction.Attributes {
Sietse Ringers's avatar
Sietse Ringers committed
203
204
205
206
207
208
				var cti CredentialTypeIdentifier
				if !attr.IsCredential() {
					cti = attr.CredentialTypeIdentifier()
				} else {
					cti = NewCredentialTypeIdentifier(attr.String())
				}
209
210
211
				ir.Ids.SchemeManagers[cti.IssuerIdentifier().SchemeManagerIdentifier()] = struct{}{}
				ir.Ids.Issuers[cti.IssuerIdentifier()] = struct{}{}
				ir.Ids.CredentialTypes[cti] = struct{}{}
212
			}
Sietse Ringers's avatar
Sietse Ringers committed
213
214
		}
	}
215
	return ir.Ids
Sietse Ringers's avatar
Sietse Ringers committed
216
217
}

Sietse Ringers's avatar
Sietse Ringers committed
218
// ToDisclose returns the attributes that must be disclosed in this issuance session.
219
220
221
222
223
224
225
func (ir *IssuanceRequest) ToDisclose() AttributeDisjunctionList {
	if ir.Disclose == nil {
		return AttributeDisjunctionList{}
	}

	return ir.Disclose
}
Sietse Ringers's avatar
Sietse Ringers committed
226
227
228
229
230
231
232
233
234
235
236
237
238

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

239
func (dr *DisclosureRequest) Identifiers() *IrmaIdentifierSet {
240
241
	if dr.Ids == nil {
		dr.Ids = &IrmaIdentifierSet{
242
243
244
245
			SchemeManagers:  map[SchemeManagerIdentifier]struct{}{},
			Issuers:         map[IssuerIdentifier]struct{}{},
			CredentialTypes: map[CredentialTypeIdentifier]struct{}{},
			PublicKeys:      map[IssuerIdentifier][]int{},
Sietse Ringers's avatar
Sietse Ringers committed
246
		}
247
248
		for _, disjunction := range dr.Content {
			for _, attr := range disjunction.Attributes {
249
250
251
				dr.Ids.SchemeManagers[attr.CredentialTypeIdentifier().IssuerIdentifier().SchemeManagerIdentifier()] = struct{}{}
				dr.Ids.Issuers[attr.CredentialTypeIdentifier().IssuerIdentifier()] = struct{}{}
				dr.Ids.CredentialTypes[attr.CredentialTypeIdentifier()] = struct{}{}
252
			}
Sietse Ringers's avatar
Sietse Ringers committed
253
254
		}
	}
255
	return dr.Ids
Sietse Ringers's avatar
Sietse Ringers committed
256
257
}

Sietse Ringers's avatar
Sietse Ringers committed
258
259
// 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
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274

// 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).
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
300
301
302
func (sr *SignatureRequest) GetNonce() *big.Int {
	hashbytes := sha256.Sum256([]byte(sr.Message))
	hashint := new(big.Int).SetBytes(hashbytes[:])
	// TODO the 2 should be abstracted away
	asn1bytes, err := asn1.Marshal([]interface{}{big.NewInt(2), sr.Nonce, hashint})
	if err != nil {
		log.Print(err) // TODO? does this happen?
	}
	asn1hash := sha256.Sum256(asn1bytes)
	return new(big.Int).SetBytes(asn1hash[:])
}

// 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
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
329
330
331
332
333
334
335
336
337
338
339
340
341

// 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 {
342
	IrmaSession() IrmaSession
343
	Requestor() string
Sietse Ringers's avatar
Sietse Ringers committed
344
345
}

346
347
func (jwt *ServerJwt) Requestor() string { return jwt.ServerName }

Sietse Ringers's avatar
Sietse Ringers committed
348
// IrmaSession returns an IRMA session object.
349
func (jwt *ServiceProviderJwt) IrmaSession() IrmaSession { return jwt.Request.Request }
Sietse Ringers's avatar
Sietse Ringers committed
350
351

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

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