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

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

11
	"encoding/json"
12 13

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

19 20
// BaseRequest contains the context and nonce for an IRMA session.
type BaseRequest struct {
21 22 23
	Context *big.Int `json:"context"`
	Nonce   *big.Int `json:"nonce"`
	Type    Action   `json:"type"`
24

25 26 27
	Candidates [][]*AttributeIdentifier `json:"-"`
	Choice     *DisclosureChoice        `json:"-"`
	Ids        *IrmaIdentifierSet       `json:"-"`
28

29
	Version *ProtocolVersion `json:"protocolVersion"`
Sietse Ringers's avatar
Sietse Ringers committed
30 31
}

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

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

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

46
// ...
47
func (sr *BaseRequest) SetVersion(v *ProtocolVersion) {
48
	sr.Version = v
49 50 51
}

// ...
52
func (sr *BaseRequest) GetVersion() *ProtocolVersion {
53
	return sr.Version
54 55
}

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

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

	// Session state
68
	Timestamp *atum.Timestamp `json:"-"`
69 70
}

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

	// Derived data
	CredentialInfoList        CredentialInfoList `json:",omitempty"`
Sietse Ringers's avatar
Sietse Ringers committed
80
	RemovalCredentialInfoList CredentialInfoList
81 82
}

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

Sietse Ringers's avatar
Sietse Ringers committed
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 128 129 130 131
// 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"`
}

132 133
// SessionRequest is an IRMA session.
type SessionRequest interface {
134
	Validator
135 136 137 138
	GetNonce() *big.Int
	SetNonce(*big.Int)
	GetContext() *big.Int
	SetContext(*big.Int)
139
	GetVersion() *ProtocolVersion
140
	SetVersion(*ProtocolVersion)
141
	ToDisclose() AttributeDisjunctionList
142 143
	DisclosureChoice() *DisclosureChoice
	SetDisclosureChoice(choice *DisclosureChoice)
144
	SetCandidates(candidates [][]*AttributeIdentifier)
145 146 147
	Identifiers() *IrmaIdentifierSet
}

Sietse Ringers's avatar
Sietse Ringers committed
148 149 150
// Timestamp is a time.Time that marshals to Unix timestamps.
type Timestamp time.Time

151 152
func (cr *CredentialRequest) Info(conf *Configuration, metadataVersion byte) (*CredentialInfo, error) {
	list, err := cr.AttributeList(conf, metadataVersion)
153 154 155
	if err != nil {
		return nil, err
	}
156
	return NewCredentialInfo(list.Ints, conf), nil
157 158
}

159 160 161 162
// Validate checks that this credential request is consistent with the specified Configuration:
// the credential type is known, all required attributes are present and no unknown attributes
// are given.
func (cr *CredentialRequest) Validate(conf *Configuration) error {
163
	credtype := conf.CredentialTypes[*cr.CredentialTypeID]
Sietse Ringers's avatar
Sietse Ringers committed
164
	if credtype == nil {
165
		return errors.New("Credential request of unknown credential type")
Sietse Ringers's avatar
Sietse Ringers committed
166
	}
167 168 169 170 171 172 173 174 175 176 177 178

	// 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 {
179
			return errors.New("Credential request contaiins unknown attribute")
180
		}
Sietse Ringers's avatar
Sietse Ringers committed
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
	for _, attrtype := range credtype.Attributes {
		if _, present := cr.Attributes[attrtype.ID]; !present && attrtype.Optional != "true" {
			return errors.New("Required attribute not present in credential request")
		}
	}

	return nil
}

// AttributeList returns the list of attributes from this credential request.
func (cr *CredentialRequest) AttributeList(conf *Configuration, metadataVersion byte) (*AttributeList, error) {
	if err := cr.Validate(conf); err != nil {
		return nil, err
	}

	// Compute metadata attribute
	meta := NewMetadataAttribute(metadataVersion)
	meta.setKeyCounter(cr.KeyCounter)
	meta.setCredentialTypeIdentifier(cr.CredentialTypeID.String())
	meta.setSigningDate()
	if err := meta.setExpiryDate(cr.Validity); err != nil {
		return nil, err
	}

	// Compute other attributes
	credtype := conf.CredentialTypes[*cr.CredentialTypeID]
209
	attrs := make([]*big.Int, len(credtype.Attributes)+1)
Sietse Ringers's avatar
Sietse Ringers committed
210 211
	attrs[0] = meta.Int
	for i, attrtype := range credtype.Attributes {
212
		attrs[i+1] = new(big.Int)
Sietse Ringers's avatar
Sietse Ringers committed
213
		if str, present := cr.Attributes[attrtype.ID]; present {
214
			// Set attribute to str << 1 + 1
215
			attrs[i+1].SetBytes([]byte(str))
216 217 218 219
			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
220 221 222
		}
	}

223
	return NewAttributeListFromInts(attrs, conf), nil
Sietse Ringers's avatar
Sietse Ringers committed
224 225
}

Sietse Ringers's avatar
Sietse Ringers committed
226
func (ir *IssuanceRequest) Identifiers() *IrmaIdentifierSet {
227 228
	if ir.Ids == nil {
		ir.Ids = &IrmaIdentifierSet{
229 230 231 232
			SchemeManagers:  map[SchemeManagerIdentifier]struct{}{},
			Issuers:         map[IssuerIdentifier]struct{}{},
			CredentialTypes: map[CredentialTypeIdentifier]struct{}{},
			PublicKeys:      map[IssuerIdentifier][]int{},
Sietse Ringers's avatar
Sietse Ringers committed
233 234
		}

Sietse Ringers's avatar
Sietse Ringers committed
235
		for _, credreq := range ir.Credentials {
Sietse Ringers's avatar
Sietse Ringers committed
236
			issuer := credreq.CredentialTypeID.IssuerIdentifier()
237 238 239 240 241
			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{}
242
			}
243
			ir.Ids.PublicKeys[issuer] = append(ir.Ids.PublicKeys[issuer], credreq.KeyCounter)
244 245
		}

Sietse Ringers's avatar
Sietse Ringers committed
246
		for _, disjunction := range ir.Disclose {
247
			for _, attr := range disjunction.Attributes {
Sietse Ringers's avatar
Sietse Ringers committed
248 249 250 251 252 253
				var cti CredentialTypeIdentifier
				if !attr.IsCredential() {
					cti = attr.CredentialTypeIdentifier()
				} else {
					cti = NewCredentialTypeIdentifier(attr.String())
				}
254 255 256
				ir.Ids.SchemeManagers[cti.IssuerIdentifier().SchemeManagerIdentifier()] = struct{}{}
				ir.Ids.Issuers[cti.IssuerIdentifier()] = struct{}{}
				ir.Ids.CredentialTypes[cti] = struct{}{}
257
			}
Sietse Ringers's avatar
Sietse Ringers committed
258 259
		}
	}
260
	return ir.Ids
Sietse Ringers's avatar
Sietse Ringers committed
261 262
}

Sietse Ringers's avatar
Sietse Ringers committed
263
// ToDisclose returns the attributes that must be disclosed in this issuance session.
264 265 266 267 268 269 270
func (ir *IssuanceRequest) ToDisclose() AttributeDisjunctionList {
	if ir.Disclose == nil {
		return AttributeDisjunctionList{}
	}

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

Tomas's avatar
Tomas committed
272 273 274 275 276 277 278 279 280 281 282 283 284
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
285 286 287 288 289 290 291 292 293 294 295 296
// 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 }

297 298 299 300 301 302 303 304 305 306
func (ir *IssuanceRequest) Validate() error {
	if ir.Type != ActionIssuing {
		return errors.New("Not an issuance request")
	}
	if len(ir.Credentials) == 0 {
		return errors.New("Empty issuance request")
	}
	return nil
}

307
func (dr *DisclosureRequest) Identifiers() *IrmaIdentifierSet {
308 309
	if dr.Ids == nil {
		dr.Ids = &IrmaIdentifierSet{
310 311 312 313
			SchemeManagers:  map[SchemeManagerIdentifier]struct{}{},
			Issuers:         map[IssuerIdentifier]struct{}{},
			CredentialTypes: map[CredentialTypeIdentifier]struct{}{},
			PublicKeys:      map[IssuerIdentifier][]int{},
Sietse Ringers's avatar
Sietse Ringers committed
314
		}
315 316
		for _, disjunction := range dr.Content {
			for _, attr := range disjunction.Attributes {
317 318 319
				dr.Ids.SchemeManagers[attr.CredentialTypeIdentifier().IssuerIdentifier().SchemeManagerIdentifier()] = struct{}{}
				dr.Ids.Issuers[attr.CredentialTypeIdentifier().IssuerIdentifier()] = struct{}{}
				dr.Ids.CredentialTypes[attr.CredentialTypeIdentifier()] = struct{}{}
320
			}
Sietse Ringers's avatar
Sietse Ringers committed
321 322
		}
	}
323
	return dr.Ids
Sietse Ringers's avatar
Sietse Ringers committed
324 325
}

Sietse Ringers's avatar
Sietse Ringers committed
326 327
// 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
328 329 330 331 332 333 334 335 336 337 338 339 340

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

341 342 343 344 345 346 347 348 349 350 351 352 353 354 355
func (dr *DisclosureRequest) Validate() error {
	if dr.Type != ActionDisclosing {
		return errors.New("Not a disclosure request")
	}
	if len(dr.Content) == 0 {
		return errors.New("Disclosure request had no attributes")
	}
	for _, disjunction := range dr.Content {
		if len(disjunction.Attributes) == 0 {
			return errors.New("Disclosure request had an empty disjunction")
		}
	}
	return nil
}

Sietse Ringers's avatar
Sietse Ringers committed
356 357
// GetNonce returns the nonce of this signature session
// (with the message already hashed into it).
358
func (sr *SignatureRequest) GetNonce() *big.Int {
359
	return ASN1ConvertSignatureNonce(sr.Message, sr.Nonce, sr.Timestamp)
360 361
}

362 363 364
// 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) {
365
	var rawRequest map[string]json.RawMessage
366 367 368 369 370 371 372

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

	for _, fieldName := range fieldNames {
373 374
		fieldString := string(rawRequest[fieldName])
		rawRequest[fieldName] = []byte(strings.Trim(fieldString, "\""))
375 376 377 378 379 380 381 382
	}

	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 {
383
	type signatureRequestTemp SignatureRequest // To avoid 'recursive unmarshalling'
384 385

	fixedRequest, err := convertFieldsToBigInt(b, []string{"nonce", "context"})
Koen van Ingen's avatar
Koen van Ingen committed
386 387 388
	if err != nil {
		return err
	}
389

390
	var result signatureRequestTemp
Koen van Ingen's avatar
Koen van Ingen committed
391 392 393 394
	err = json.Unmarshal(fixedRequest, &result)
	if err != nil {
		return err
	}
395 396 397 398 399 400 401

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

	return err
}

402
func (sr *SignatureRequest) SignatureFromMessage(message interface{}) (*SignedMessage, error) {
403 404 405 406 407 408
	signature, ok := message.(gabi.ProofList)

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

409
	return &SignedMessage{
410
		Signature: signature,
411 412 413
		Nonce:     sr.Nonce,
		Context:   sr.Context,
		Message:   sr.Message,
414
		Timestamp: sr.Timestamp,
415 416 417
	}, nil
}

418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435
func (sr *SignatureRequest) Validate() error {
	if sr.Type != ActionSigning {
		return errors.New("Not a signature request")
	}
	if sr.Message == "" {
		return errors.New("Signature request had empty message")
	}
	if len(sr.Content) == 0 {
		return errors.New("Disclosure request had no attributes")
	}
	for _, disjunction := range sr.Content {
		if len(disjunction.Attributes) == 0 {
			return errors.New("Disclosure request had an empty disjunction")
		}
	}
	return nil
}

436 437 438 439 440
// 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))
}

441 442 443 444
func (t Timestamp) After(u Timestamp) bool {
	return time.Time(t).After(time.Time(u))
}

445 446
// MarshalJSON marshals a timestamp.
func (t *Timestamp) MarshalJSON() ([]byte, error) {
447
	return []byte(t.String()), nil
448 449 450 451 452 453 454 455 456 457 458
}

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

460 461 462 463 464
// Timestamp implements Stringer.
func (t *Timestamp) String() string {
	return fmt.Sprint(time.Time(*t).Unix())
}

465 466 467 468 469 470 471 472
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
	}
473 474
	bts, err := ioutil.ReadFile(path)
	if err != nil {
475
		return nil, true, errors.New("Could not read scheme manager timestamp")
476
	}
477 478
	ts, err := parseTimestamp(bts)
	return ts, true, err
479 480
}

481
func parseTimestamp(bts []byte) (*Timestamp, error) {
482 483 484 485 486 487
	// 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)
488
	if err != nil {
489
		return nil, err
490
	}
491 492
	ts := Timestamp(time.Unix(str, 0))
	return &ts, nil
493 494
}

Sietse Ringers's avatar
Sietse Ringers committed
495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532
// 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 {
533
	SessionRequest() SessionRequest
534
	Requestor() string
Sietse Ringers's avatar
Sietse Ringers committed
535 536
}

537 538
func (jwt *ServerJwt) Requestor() string { return jwt.ServerName }

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

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

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