requests.go 13.5 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"
Sietse Ringers's avatar
Sietse Ringers committed
15
)
16

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

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

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

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

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

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

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

Sietse Ringers's avatar
Sietse Ringers committed
53
// A DisclosureRequest is a request to disclose certain attributes.
54 55 56 57 58
type DisclosureRequest struct {
	SessionRequest
	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
	Message   string          `json:"message"`
	Timestamp *atum.Timestamp `json:"-"`
64 65
}

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

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

Sietse Ringers's avatar
Sietse Ringers committed
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 110 111 112 113 114 115 116 117 118 119 120 121 122 123
// 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"`
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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
// 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
325 326 327
	if err != nil {
		return err
	}
328 329

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

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

	return err
}

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

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

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

357 358 359 360 361
// 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))
}

362 363
// MarshalJSON marshals a timestamp.
func (t *Timestamp) MarshalJSON() ([]byte, error) {
364
	return []byte(t.String()), nil
365 366 367 368 369 370 371 372 373 374 375
}

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

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

func readTimestamp(path string) (Timestamp, error) {
	bts, err := ioutil.ReadFile(path)
	if err != nil {
		return Timestamp(time.Unix(0, 0)), errors.New("Could not read scheme manager timestamp")
	}

388 389 390 391
	return parseTimestamp(bts)
}

func parseTimestamp(bts []byte) (Timestamp, error) {
392 393
	// Remove final character which is \n; convert from byte slice to string; parse as int
	str, err := strconv.ParseInt(string(bts[:len(bts)-1]), 10, 64)
394 395 396
	if err != nil {
		return Timestamp(time.Unix(0, 0)), err
	}
397 398 399
	return Timestamp(time.Unix(str, 0)), nil
}

Sietse Ringers's avatar
Sietse Ringers committed
400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437
// 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 {
438
	IrmaSession() IrmaSession
439
	Requestor() string
Sietse Ringers's avatar
Sietse Ringers committed
440 441
}

442 443
func (jwt *ServerJwt) Requestor() string { return jwt.ServerName }

Sietse Ringers's avatar
Sietse Ringers committed
444
// IrmaSession returns an IRMA session object.
445
func (jwt *ServiceProviderJwt) IrmaSession() IrmaSession { return jwt.Request.Request }
Sietse Ringers's avatar
Sietse Ringers committed
446 447

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

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