requests.go 14.3 KB
Newer Older
1
package irma
2 3 4

import (
	"fmt"
5
	"io/ioutil"
6 7 8 9
	"math/big"
	"strconv"
	"time"

10
	"encoding/json"
11 12

	"github.com/bwesterb/go-atum"
Sietse Ringers's avatar
Sietse Ringers committed
13
	"github.com/go-errors/errors"
14
	"github.com/mhe/gabi"
15
	"github.com/privacybydesign/irmago/internal/fs"
Sietse Ringers's avatar
Sietse Ringers committed
16
)
17

18 19
// BaseRequest contains the context and nonce for an IRMA session.
type BaseRequest struct {
20 21 22
	Context    *big.Int                 `json:"context"`
	Nonce      *big.Int                 `json:"nonce"`
	Candidates [][]*AttributeIdentifier `json:"-"`
23 24 25

	Choice *DisclosureChoice  `json:"-"`
	Ids    *IrmaIdentifierSet `json:"-"`
26 27

	version *ProtocolVersion
Sietse Ringers's avatar
Sietse Ringers committed
28 29
}

30
func (sr *BaseRequest) SetCandidates(candidates [][]*AttributeIdentifier) {
31 32 33
	sr.Candidates = candidates
}

34
// DisclosureChoice returns the attributes to be disclosed in this session.
35
func (sr *BaseRequest) DisclosureChoice() *DisclosureChoice {
36
	return sr.Choice
Sietse Ringers's avatar
Sietse Ringers committed
37 38
}

39
// SetDisclosureChoice sets the attributes to be disclosed in this session.
40
func (sr *BaseRequest) SetDisclosureChoice(choice *DisclosureChoice) {
41
	sr.Choice = choice
42 43
}

44
// ...
45
func (sr *BaseRequest) SetVersion(v *ProtocolVersion) {
46 47 48 49
	sr.version = v
}

// ...
50
func (sr *BaseRequest) GetVersion() *ProtocolVersion {
51 52 53
	return sr.version
}

Sietse Ringers's avatar
Sietse Ringers committed
54
// A DisclosureRequest is a request to disclose certain attributes.
55
type DisclosureRequest struct {
56
	BaseRequest
57 58 59
	Content AttributeDisjunctionList `json:"content"`
}

Sietse Ringers's avatar
Sietse Ringers committed
60
// A SignatureRequest is a a request to sign a message with certain attributes.
61 62
type SignatureRequest struct {
	DisclosureRequest
63 64
	Message   string          `json:"message"`
	Timestamp *atum.Timestamp `json:"-"`
65 66
}

Sietse Ringers's avatar
Sietse Ringers committed
67 68
// An IssuanceRequest is a request to issue certain credentials,
// optionally also asking for certain attributes to be simultaneously disclosed.
69
type IssuanceRequest struct {
70
	BaseRequest
Tomas's avatar
Tomas committed
71 72 73 74 75
	Credentials []*CredentialRequest     `json:"credentials"`
	Disclose    AttributeDisjunctionList `json:"disclose"`

	// Derived data
	CredentialInfoList        CredentialInfoList `json:",omitempty"`
Sietse Ringers's avatar
Sietse Ringers committed
76
	RemovalCredentialInfoList CredentialInfoList
77 78
}

Sietse Ringers's avatar
Sietse Ringers committed
79 80
// A CredentialRequest contains the attributes and metadata of a credential
// that will be issued in an IssuanceRequest.
81
type CredentialRequest struct {
82 83 84 85
	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
86 87
}

Sietse Ringers's avatar
Sietse Ringers committed
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 120 121 122 123 124 125 126 127
// 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"`
}

128 129
// SessionRequest is an IRMA session.
type SessionRequest interface {
130 131 132 133
	GetNonce() *big.Int
	SetNonce(*big.Int)
	GetContext() *big.Int
	SetContext(*big.Int)
134
	SetVersion(*ProtocolVersion)
135
	ToDisclose() AttributeDisjunctionList
136 137
	DisclosureChoice() *DisclosureChoice
	SetDisclosureChoice(choice *DisclosureChoice)
138
	SetCandidates(candidates [][]*AttributeIdentifier)
139 140 141
	Identifiers() *IrmaIdentifierSet
}

Sietse Ringers's avatar
Sietse Ringers committed
142 143 144
// Timestamp is a time.Time that marshals to Unix timestamps.
type Timestamp time.Time

145 146
func (cr *CredentialRequest) Info(conf *Configuration, metadataVersion byte) (*CredentialInfo, error) {
	list, err := cr.AttributeList(conf, metadataVersion)
147 148 149
	if err != nil {
		return nil, err
	}
150
	return NewCredentialInfo(list.Ints, conf), nil
151 152
}

Sietse Ringers's avatar
Sietse Ringers committed
153
// AttributeList returns the list of attributes from this credential request.
154 155
func (cr *CredentialRequest) AttributeList(conf *Configuration, metadataVersion byte) (*AttributeList, error) {
	meta := NewMetadataAttribute(metadataVersion)
Sietse Ringers's avatar
Sietse Ringers committed
156
	meta.setKeyCounter(cr.KeyCounter)
157
	meta.setCredentialTypeIdentifier(cr.CredentialTypeID.String())
Sietse Ringers's avatar
Sietse Ringers committed
158 159 160 161 162 163
	meta.setSigningDate()
	err := meta.setExpiryDate(cr.Validity)
	if err != nil {
		return nil, err
	}

164
	credtype := conf.CredentialTypes[*cr.CredentialTypeID]
Sietse Ringers's avatar
Sietse Ringers committed
165 166 167
	if credtype == nil {
		return nil, errors.New("Unknown credential type")
	}
168 169 170 171 172 173 174 175 176 177 178 179 180 181

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

184
	attrs := make([]*big.Int, len(credtype.Attributes)+1)
Sietse Ringers's avatar
Sietse Ringers committed
185 186
	attrs[0] = meta.Int
	for i, attrtype := range credtype.Attributes {
187
		attrs[i+1] = new(big.Int)
Sietse Ringers's avatar
Sietse Ringers committed
188
		if str, present := cr.Attributes[attrtype.ID]; present {
189
			// Set attribute to str << 1 + 1
190
			attrs[i+1].SetBytes([]byte(str))
191 192 193 194
			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
195
		} else {
196
			if attrtype.Optional != "true" {
197 198
				return nil, errors.New("Required attribute not provided")
			}
Sietse Ringers's avatar
Sietse Ringers committed
199 200 201
		}
	}

202
	return NewAttributeListFromInts(attrs, conf), nil
Sietse Ringers's avatar
Sietse Ringers committed
203 204
}

Sietse Ringers's avatar
Sietse Ringers committed
205
func (ir *IssuanceRequest) Identifiers() *IrmaIdentifierSet {
206 207
	if ir.Ids == nil {
		ir.Ids = &IrmaIdentifierSet{
208 209 210 211
			SchemeManagers:  map[SchemeManagerIdentifier]struct{}{},
			Issuers:         map[IssuerIdentifier]struct{}{},
			CredentialTypes: map[CredentialTypeIdentifier]struct{}{},
			PublicKeys:      map[IssuerIdentifier][]int{},
Sietse Ringers's avatar
Sietse Ringers committed
212 213
		}

Sietse Ringers's avatar
Sietse Ringers committed
214
		for _, credreq := range ir.Credentials {
Sietse Ringers's avatar
Sietse Ringers committed
215
			issuer := credreq.CredentialTypeID.IssuerIdentifier()
216 217 218 219 220
			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{}
221
			}
222
			ir.Ids.PublicKeys[issuer] = append(ir.Ids.PublicKeys[issuer], credreq.KeyCounter)
223 224
		}

Sietse Ringers's avatar
Sietse Ringers committed
225
		for _, disjunction := range ir.Disclose {
226
			for _, attr := range disjunction.Attributes {
Sietse Ringers's avatar
Sietse Ringers committed
227 228 229 230 231 232
				var cti CredentialTypeIdentifier
				if !attr.IsCredential() {
					cti = attr.CredentialTypeIdentifier()
				} else {
					cti = NewCredentialTypeIdentifier(attr.String())
				}
233 234 235
				ir.Ids.SchemeManagers[cti.IssuerIdentifier().SchemeManagerIdentifier()] = struct{}{}
				ir.Ids.Issuers[cti.IssuerIdentifier()] = struct{}{}
				ir.Ids.CredentialTypes[cti] = struct{}{}
236
			}
Sietse Ringers's avatar
Sietse Ringers committed
237 238
		}
	}
239
	return ir.Ids
Sietse Ringers's avatar
Sietse Ringers committed
240 241
}

Sietse Ringers's avatar
Sietse Ringers committed
242
// ToDisclose returns the attributes that must be disclosed in this issuance session.
243 244 245 246 247 248 249
func (ir *IssuanceRequest) ToDisclose() AttributeDisjunctionList {
	if ir.Disclose == nil {
		return AttributeDisjunctionList{}
	}

	return ir.Disclose
}
Sietse Ringers's avatar
Sietse Ringers committed
250

Tomas's avatar
Tomas committed
251 252 253 254 255 256 257 258 259 260 261 262 263
func (ir *IssuanceRequest) GetCredentialInfoList(conf *Configuration, version *ProtocolVersion) (CredentialInfoList, error) {
	if ir.CredentialInfoList == nil {
		for _, credreq := range ir.Credentials {
			info, err := credreq.Info(conf, GetMetadataVersion(version))
			if err != nil {
				return nil, err
			}
			ir.CredentialInfoList = append(ir.CredentialInfoList, info)
		}
	}
	return ir.CredentialInfoList, nil
}

Sietse Ringers's avatar
Sietse Ringers committed
264 265 266 267 268 269 270 271 272 273 274 275
// 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 }

276
func (dr *DisclosureRequest) Identifiers() *IrmaIdentifierSet {
277 278
	if dr.Ids == nil {
		dr.Ids = &IrmaIdentifierSet{
279 280 281 282
			SchemeManagers:  map[SchemeManagerIdentifier]struct{}{},
			Issuers:         map[IssuerIdentifier]struct{}{},
			CredentialTypes: map[CredentialTypeIdentifier]struct{}{},
			PublicKeys:      map[IssuerIdentifier][]int{},
Sietse Ringers's avatar
Sietse Ringers committed
283
		}
284 285
		for _, disjunction := range dr.Content {
			for _, attr := range disjunction.Attributes {
286 287 288
				dr.Ids.SchemeManagers[attr.CredentialTypeIdentifier().IssuerIdentifier().SchemeManagerIdentifier()] = struct{}{}
				dr.Ids.Issuers[attr.CredentialTypeIdentifier().IssuerIdentifier()] = struct{}{}
				dr.Ids.CredentialTypes[attr.CredentialTypeIdentifier()] = struct{}{}
289
			}
Sietse Ringers's avatar
Sietse Ringers committed
290 291
		}
	}
292
	return dr.Ids
Sietse Ringers's avatar
Sietse Ringers committed
293 294
}

Sietse Ringers's avatar
Sietse Ringers committed
295 296
// 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
297 298 299 300 301 302 303 304 305 306 307 308 309 310 311

// 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).
312
func (sr *SignatureRequest) GetNonce() *big.Int {
313
	return ASN1ConvertSignatureNonce(sr.Message, sr.Nonce, sr.Timestamp)
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
// 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
342 343 344
	if err != nil {
		return err
	}
345 346

	var result SignatureRequestTemp
Koen van Ingen's avatar
Koen van Ingen committed
347 348 349 350
	err = json.Unmarshal(fixedRequest, &result)
	if err != nil {
		return err
	}
351 352 353 354 355 356 357

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

	return err
}

358 359 360 361 362 363 364 365
func (sr *SignatureRequest) SignatureFromMessage(message interface{}) (*IrmaSignedMessage, error) {
	signature, ok := message.(gabi.ProofList)

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

	return &IrmaSignedMessage{
366
		Signature: signature,
367 368 369
		Nonce:     sr.Nonce,
		Context:   sr.Context,
		Message:   sr.Message,
370
		Timestamp: sr.Timestamp,
371 372 373
	}, nil
}

374 375 376 377 378
// 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))
}

379 380 381 382
func (t Timestamp) After(u Timestamp) bool {
	return time.Time(t).After(time.Time(u))
}

383 384
// MarshalJSON marshals a timestamp.
func (t *Timestamp) MarshalJSON() ([]byte, error) {
385
	return []byte(t.String()), nil
386 387 388 389 390 391 392 393 394 395 396
}

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

398 399 400 401 402
// Timestamp implements Stringer.
func (t *Timestamp) String() string {
	return fmt.Sprint(time.Time(*t).Unix())
}

403 404 405 406 407 408 409 410
func readTimestamp(path string) (*Timestamp, bool, error) {
	exists, err := fs.PathExists(path)
	if err != nil {
		return nil, false, err
	}
	if !exists {
		return nil, false, nil
	}
411 412
	bts, err := ioutil.ReadFile(path)
	if err != nil {
413
		return nil, true, errors.New("Could not read scheme manager timestamp")
414
	}
415 416
	ts, err := parseTimestamp(bts)
	return ts, true, err
417 418
}

419
func parseTimestamp(bts []byte) (*Timestamp, error) {
420 421 422 423 424 425
	// Remove final character \n if present
	if bts[len(bts)-1] == '\n' {
		bts = bts[:len(bts)-1]
	}
	// convert from byte slice to string; parse as int
	str, err := strconv.ParseInt(string(bts), 10, 64)
426
	if err != nil {
427
		return nil, err
428
	}
429 430
	ts := Timestamp(time.Unix(str, 0))
	return &ts, nil
431 432
}

Sietse Ringers's avatar
Sietse Ringers committed
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
// 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 {
471
	SessionRequest() SessionRequest
472
	Requestor() string
Sietse Ringers's avatar
Sietse Ringers committed
473 474
}

475 476
func (jwt *ServerJwt) Requestor() string { return jwt.ServerName }

477 478
// SessionRequest returns an IRMA session object.
func (jwt *ServiceProviderJwt) SessionRequest() SessionRequest { return jwt.Request.Request }
Sietse Ringers's avatar
Sietse Ringers committed
479

480 481
// SessionRequest returns an IRMA session object.
func (jwt *SignatureRequestorJwt) SessionRequest() SessionRequest { return jwt.Request.Request }
Sietse Ringers's avatar
Sietse Ringers committed
482

483 484
// SessionRequest returns an IRMA session object.
func (jwt *IdentityProviderJwt) SessionRequest() SessionRequest { return jwt.Request.Request }