requests.go 11.2 KB
Newer Older
1
package irma
2 3 4 5 6 7 8

import (
	"fmt"
	"math/big"
	"strconv"
	"time"

Sietse Ringers's avatar
Sietse Ringers committed
9
	"github.com/go-errors/errors"
Sietse Ringers's avatar
Sietse Ringers committed
10
)
11

Sietse Ringers's avatar
Sietse Ringers committed
12
// SessionRequest contains the context and nonce for an IRMA session.
13
type SessionRequest struct {
14 15 16
	Context    *big.Int                 `json:"context"`
	Nonce      *big.Int                 `json:"nonce"`
	Candidates [][]*AttributeIdentifier `json:"-"`
17 18 19

	Choice *DisclosureChoice  `json:"-"`
	Ids    *IrmaIdentifierSet `json:"-"`
20 21

	version *ProtocolVersion
Sietse Ringers's avatar
Sietse Ringers committed
22 23
}

24 25 26 27
func (sr *SessionRequest) SetCandidates(candidates [][]*AttributeIdentifier) {
	sr.Candidates = candidates
}

28
// DisclosureChoice returns the attributes to be disclosed in this session.
Sietse Ringers's avatar
Sietse Ringers committed
29
func (sr *SessionRequest) DisclosureChoice() *DisclosureChoice {
30
	return sr.Choice
Sietse Ringers's avatar
Sietse Ringers committed
31 32
}

33
// SetDisclosureChoice sets the attributes to be disclosed in this session.
Sietse Ringers's avatar
Sietse Ringers committed
34
func (sr *SessionRequest) SetDisclosureChoice(choice *DisclosureChoice) {
35
	sr.Choice = choice
36 37
}

38 39 40 41 42 43 44 45 46 47
// ...
func (sr *SessionRequest) SetVersion(v *ProtocolVersion) {
	sr.version = v
}

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

Sietse Ringers's avatar
Sietse Ringers committed
48
// A DisclosureRequest is a request to disclose certain attributes.
49 50 51 52 53
type DisclosureRequest struct {
	SessionRequest
	Content AttributeDisjunctionList `json:"content"`
}

Sietse Ringers's avatar
Sietse Ringers committed
54
// A SignatureRequest is a a request to sign a message with certain attributes.
55 56
type SignatureRequest struct {
	DisclosureRequest
57
	Message string `json:"message"`
58 59
}

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

Sietse Ringers's avatar
Sietse Ringers committed
69 70
// A CredentialRequest contains the attributes and metadata of a credential
// that will be issued in an IssuanceRequest.
71
type CredentialRequest struct {
72 73 74 75
	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
76 77
}

Sietse Ringers's avatar
Sietse Ringers committed
78 79 80 81 82 83 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
// 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"`
}

118 119 120 121 122 123
// IrmaSession is an IRMA session.
type IrmaSession interface {
	GetNonce() *big.Int
	SetNonce(*big.Int)
	GetContext() *big.Int
	SetContext(*big.Int)
124
	SetVersion(*ProtocolVersion)
125
	ToDisclose() AttributeDisjunctionList
126 127
	DisclosureChoice() *DisclosureChoice
	SetDisclosureChoice(choice *DisclosureChoice)
128
	SetCandidates(candidates [][]*AttributeIdentifier)
129 130 131
	Identifiers() *IrmaIdentifierSet
}

Sietse Ringers's avatar
Sietse Ringers committed
132 133 134
// Timestamp is a time.Time that marshals to Unix timestamps.
type Timestamp time.Time

135 136
func (cr *CredentialRequest) Info(conf *Configuration, metadataVersion byte) (*CredentialInfo, error) {
	list, err := cr.AttributeList(conf, metadataVersion)
137 138 139
	if err != nil {
		return nil, err
	}
140
	return NewCredentialInfo(list.Ints, conf), nil
141 142
}

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

154
	credtype := conf.CredentialTypes[*cr.CredentialTypeID]
Sietse Ringers's avatar
Sietse Ringers committed
155 156 157
	if credtype == nil {
		return nil, errors.New("Unknown credential type")
	}
158 159 160 161 162 163 164 165 166 167 168 169 170 171

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

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

192
	return NewAttributeListFromInts(attrs, conf), nil
Sietse Ringers's avatar
Sietse Ringers committed
193 194
}

Sietse Ringers's avatar
Sietse Ringers committed
195
func (ir *IssuanceRequest) Identifiers() *IrmaIdentifierSet {
196 197
	if ir.Ids == nil {
		ir.Ids = &IrmaIdentifierSet{
198 199 200 201
			SchemeManagers:  map[SchemeManagerIdentifier]struct{}{},
			Issuers:         map[IssuerIdentifier]struct{}{},
			CredentialTypes: map[CredentialTypeIdentifier]struct{}{},
			PublicKeys:      map[IssuerIdentifier][]int{},
Sietse Ringers's avatar
Sietse Ringers committed
202 203
		}

Sietse Ringers's avatar
Sietse Ringers committed
204
		for _, credreq := range ir.Credentials {
Sietse Ringers's avatar
Sietse Ringers committed
205
			issuer := credreq.CredentialTypeID.IssuerIdentifier()
206 207 208 209 210
			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{}
211
			}
212
			ir.Ids.PublicKeys[issuer] = append(ir.Ids.PublicKeys[issuer], credreq.KeyCounter)
213 214
		}

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

Sietse Ringers's avatar
Sietse Ringers committed
232
// ToDisclose returns the attributes that must be disclosed in this issuance session.
233 234 235 236 237 238 239
func (ir *IssuanceRequest) ToDisclose() AttributeDisjunctionList {
	if ir.Disclose == nil {
		return AttributeDisjunctionList{}
	}

	return ir.Disclose
}
Sietse Ringers's avatar
Sietse Ringers committed
240 241 242 243 244 245 246 247 248 249 250 251 252

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

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

Sietse Ringers's avatar
Sietse Ringers committed
272 273
// 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
274 275 276 277 278 279 280 281 282 283 284 285 286 287 288

// 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).
289
func (sr *SignatureRequest) GetNonce() *big.Int {
290
	return ASN1ConvertSignatureNonce(sr.Message, sr.Nonce)
291 292
}

293 294 295 296 297
// 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))
}

298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313
// MarshalJSON marshals a timestamp.
func (t *Timestamp) MarshalJSON() ([]byte, error) {
	ts := time.Time(*t).Unix()
	stamp := fmt.Sprint(ts)
	return []byte(stamp), nil
}

// 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
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 342 343 344 345 346 347 348 349 350 351 352

// 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 {
353
	IrmaSession() IrmaSession
354
	Requestor() string
Sietse Ringers's avatar
Sietse Ringers committed
355 356
}

357 358
func (jwt *ServerJwt) Requestor() string { return jwt.ServerName }

Sietse Ringers's avatar
Sietse Ringers committed
359
// IrmaSession returns an IRMA session object.
360
func (jwt *ServiceProviderJwt) IrmaSession() IrmaSession { return jwt.Request.Request }
Sietse Ringers's avatar
Sietse Ringers committed
361 362

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

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