requests.go 13.9 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

Sietse Ringers's avatar
Sietse Ringers committed
18
// SessionRequest contains the context and nonce for an IRMA session.
19
type SessionRequest 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 31 32 33
func (sr *SessionRequest) SetCandidates(candidates [][]*AttributeIdentifier) {
	sr.Candidates = candidates
}

34
// DisclosureChoice returns the attributes to be disclosed in this session.
Sietse Ringers's avatar
Sietse Ringers committed
35
func (sr *SessionRequest) 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.
Sietse Ringers's avatar
Sietse Ringers committed
40
func (sr *SessionRequest) SetDisclosureChoice(choice *DisclosureChoice) {
41
	sr.Choice = choice
42 43
}

44 45 46 47 48 49 50 51 52 53
// ...
func (sr *SessionRequest) SetVersion(v *ProtocolVersion) {
	sr.version = v
}

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

Sietse Ringers's avatar
Sietse Ringers committed
54
// A DisclosureRequest is a request to disclose certain attributes.
55 56 57 58 59
type DisclosureRequest struct {
	SessionRequest
	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 70
type IssuanceRequest struct {
	SessionRequest
71 72 73
	Credentials               []*CredentialRequest     `json:"credentials"`
	Disclose                  AttributeDisjunctionList `json:"disclose"`
	CredentialInfoList        CredentialInfoList       `json:",omitempty"`
Sietse Ringers's avatar
Sietse Ringers committed
74
	RemovalCredentialInfoList CredentialInfoList
75 76
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	return ir.Disclose
}
Sietse Ringers's avatar
Sietse Ringers committed
248 249 250 251 252 253 254 255 256 257 258 259 260

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

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

Sietse Ringers's avatar
Sietse Ringers committed
280 281
// 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
282 283 284 285 286 287 288 289 290 291 292 293 294 295 296

// 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).
297
func (sr *SignatureRequest) GetNonce() *big.Int {
298
	return ASN1ConvertSignatureNonce(sr.Message, sr.Nonce, sr.Timestamp)
299 300
}

301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326
// 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
327 328 329
	if err != nil {
		return err
	}
330 331

	var result SignatureRequestTemp
Koen van Ingen's avatar
Koen van Ingen committed
332 333 334 335
	err = json.Unmarshal(fixedRequest, &result)
	if err != nil {
		return err
	}
336 337 338 339 340 341 342

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

	return err
}

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

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

	return &IrmaSignedMessage{
351
		Signature: signature,
352 353 354
		Nonce:     sr.Nonce,
		Context:   sr.Context,
		Message:   sr.Message,
355
		Timestamp: sr.Timestamp,
356 357 358
	}, nil
}

359 360 361 362 363
// 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))
}

364 365 366 367
func (t Timestamp) After(u Timestamp) bool {
	return time.Time(t).After(time.Time(u))
}

368 369
// MarshalJSON marshals a timestamp.
func (t *Timestamp) MarshalJSON() ([]byte, error) {
370
	return []byte(t.String()), nil
371 372 373 374 375 376 377 378 379 380 381
}

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

383 384 385 386 387
// Timestamp implements Stringer.
func (t *Timestamp) String() string {
	return fmt.Sprint(time.Time(*t).Unix())
}

388 389 390 391 392 393 394 395
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
	}
396 397
	bts, err := ioutil.ReadFile(path)
	if err != nil {
398
		return nil, true, errors.New("Could not read scheme manager timestamp")
399
	}
400 401
	ts, err := parseTimestamp(bts)
	return ts, true, err
402 403
}

404
func parseTimestamp(bts []byte) (*Timestamp, error) {
405 406 407 408 409 410
	// 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)
411
	if err != nil {
412
		return nil, err
413
	}
414 415
	ts := Timestamp(time.Unix(str, 0))
	return &ts, nil
416 417
}

Sietse Ringers's avatar
Sietse Ringers committed
418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455
// 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 {
456
	IrmaSession() IrmaSession
457
	Requestor() string
Sietse Ringers's avatar
Sietse Ringers committed
458 459
}

460 461
func (jwt *ServerJwt) Requestor() string { return jwt.ServerName }

Sietse Ringers's avatar
Sietse Ringers committed
462
// IrmaSession returns an IRMA session object.
463
func (jwt *ServiceProviderJwt) IrmaSession() IrmaSession { return jwt.Request.Request }
Sietse Ringers's avatar
Sietse Ringers committed
464 465

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

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