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

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

9
	"github.com/bwesterb/go-atum"
Sietse Ringers's avatar
Sietse Ringers committed
10
	"github.com/go-errors/errors"
11
	"github.com/mhe/gabi"
12
	"github.com/mhe/gabi/big"
13
	"github.com/privacybydesign/irmago/internal/fs"
Sietse Ringers's avatar
Sietse Ringers committed
14
)
15

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

22 23 24
	Candidates [][]*AttributeIdentifier `json:"-"`
	Choice     *DisclosureChoice        `json:"-"`
	Ids        *IrmaIdentifierSet       `json:"-"`
25

26
	Version *ProtocolVersion `json:"protocolVersion"`
Sietse Ringers's avatar
Sietse Ringers committed
27 28
}

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

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

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

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

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

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

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

	// Session state
65
	Timestamp *atum.Timestamp `json:"-"`
66 67
}

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

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

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

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

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

Sietse Ringers's avatar
Sietse Ringers committed
145 146 147
// Timestamp is a time.Time that marshals to Unix timestamps.
type Timestamp time.Time

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

156 157 158 159
// 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 {
160
	credtype := conf.CredentialTypes[cr.CredentialTypeID]
Sietse Ringers's avatar
Sietse Ringers committed
161
	if credtype == nil {
162
		return errors.New("Credential request of unknown credential type")
Sietse Ringers's avatar
Sietse Ringers committed
163
	}
164 165 166 167 168 169 170 171 172 173 174 175

	// 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 {
176
			return errors.New("Credential request contaiins unknown attribute")
177
		}
Sietse Ringers's avatar
Sietse Ringers committed
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
	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
205
	credtype := conf.CredentialTypes[cr.CredentialTypeID]
206
	attrs := make([]*big.Int, len(credtype.Attributes)+1)
Sietse Ringers's avatar
Sietse Ringers committed
207 208
	attrs[0] = meta.Int
	for i, attrtype := range credtype.Attributes {
209
		attrs[i+1] = new(big.Int)
Sietse Ringers's avatar
Sietse Ringers committed
210
		if str, present := cr.Attributes[attrtype.ID]; present {
211
			// Set attribute to str << 1 + 1
212
			attrs[i+1].SetBytes([]byte(str))
213 214 215 216
			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
217 218 219
		}
	}

220
	return NewAttributeListFromInts(attrs, conf), nil
Sietse Ringers's avatar
Sietse Ringers committed
221 222
}

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

Sietse Ringers's avatar
Sietse Ringers committed
232
		for _, credreq := range ir.Credentials {
Sietse Ringers's avatar
Sietse Ringers committed
233
			issuer := credreq.CredentialTypeID.IssuerIdentifier()
234 235
			ir.Ids.SchemeManagers[issuer.SchemeManagerIdentifier()] = struct{}{}
			ir.Ids.Issuers[issuer] = struct{}{}
236
			ir.Ids.CredentialTypes[credreq.CredentialTypeID] = struct{}{}
237 238
			if ir.Ids.PublicKeys[issuer] == nil {
				ir.Ids.PublicKeys[issuer] = []int{}
239
			}
240
			ir.Ids.PublicKeys[issuer] = append(ir.Ids.PublicKeys[issuer], credreq.KeyCounter)
241 242
		}

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

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

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

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

294 295 296 297 298 299 300 301 302 303
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
}

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

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

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

338 339 340 341 342 343 344 345 346 347 348 349 350 351 352
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
353 354
// GetNonce returns the nonce of this signature session
// (with the message already hashed into it).
355
func (sr *SignatureRequest) GetNonce() *big.Int {
356
	return ASN1ConvertSignatureNonce(sr.Message, sr.Nonce, sr.Timestamp)
357 358
}

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

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

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

375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392
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
}

393 394 395 396 397
// 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))
}

398 399 400 401
func (t Timestamp) After(u Timestamp) bool {
	return time.Time(t).After(time.Time(u))
}

402 403
// MarshalJSON marshals a timestamp.
func (t *Timestamp) MarshalJSON() ([]byte, error) {
404
	return []byte(t.String()), nil
405 406 407 408 409 410 411 412 413 414 415
}

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

417 418 419 420 421
// Timestamp implements Stringer.
func (t *Timestamp) String() string {
	return fmt.Sprint(time.Time(*t).Unix())
}

422 423 424 425 426 427 428 429
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
	}
430 431
	bts, err := ioutil.ReadFile(path)
	if err != nil {
432
		return nil, true, errors.New("Could not read scheme manager timestamp")
433
	}
434 435
	ts, err := parseTimestamp(bts)
	return ts, true, err
436 437
}

438
func parseTimestamp(bts []byte) (*Timestamp, error) {
439 440 441 442 443 444
	// 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)
445
	if err != nil {
446
		return nil, err
447
	}
448 449
	ts := Timestamp(time.Unix(str, 0))
	return &ts, nil
450 451
}

Sietse Ringers's avatar
Sietse Ringers committed
452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489
// 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 {
490
	Action() Action
491
	SessionRequest() SessionRequest
492
	Requestor() string
493
	Valid() error
Sietse Ringers's avatar
Sietse Ringers committed
494 495
}

496 497
func (jwt *ServerJwt) Requestor() string { return jwt.ServerName }

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

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

504 505
// SessionRequest returns an IRMA session object.
func (jwt *IdentityProviderJwt) SessionRequest() SessionRequest { return jwt.Request.Request }
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 533 534 535 536 537 538 539 540 541

func (jwt *ServiceProviderJwt) Valid() error {
	if jwt.Type != "verification_request" {
		return errors.New("Verification jwt has invalid subject")
	}
	if time.Time(jwt.IssuedAt).After(time.Now()) {
		return errors.New("Verification jwt not yet valid")
	}
	return nil
}

func (jwt *SignatureRequestorJwt) Valid() error {
	if jwt.Type != "signature_request" {
		return errors.New("Signature jwt has invalid subject")
	}
	if time.Time(jwt.IssuedAt).After(time.Now()) {
		return errors.New("Signature jwt not yet valid")
	}
	return nil
}

func (jwt *IdentityProviderJwt) Valid() error {
	if jwt.Type != "issue_request" {
		return errors.New("Issuance jwt has invalid subject")
	}
	if time.Time(jwt.IssuedAt).After(time.Now()) {
		return errors.New("Issuance jwt not yet valid")
	}
	return nil
}

func (jwt *ServiceProviderJwt) Action() Action { return ActionDisclosing }

func (jwt *SignatureRequestorJwt) Action() Action { return ActionSigning }

func (jwt *IdentityProviderJwt) Action() Action { return ActionIssuing }