session.go 9.21 KB
Newer Older
Sietse Ringers's avatar
Sietse Ringers committed
1
package irmago
2
3

import (
Sietse Ringers's avatar
Sietse Ringers committed
4
5
	"fmt"
	"sort"
6
	"strconv"
7
8
	"strings"

9
	"github.com/go-errors/errors"
10
	"github.com/mhe/gabi"
11
12
)

Sietse Ringers's avatar
Sietse Ringers committed
13
14
15
// This file contains the client side of the IRMA protocol, as well as the Handler interface
// which is used to communicate session info with the user.

Sietse Ringers's avatar
Sietse Ringers committed
16
17
// PermissionHandler is a callback for providing permission for an IRMA session
// and specifying the attributes to be disclosed.
Sietse Ringers's avatar
Sietse Ringers committed
18
type PermissionHandler func(proceed bool, choice *DisclosureChoice)
19
20
21
22
23
24

// A Handler contains callbacks for communication to the user.
type Handler interface {
	StatusUpdate(action Action, status Status)
	Success(action Action)
	Cancelled(action Action)
Tomas's avatar
Tomas committed
25
	Failure(action Action, err *SessionError)
Sietse Ringers's avatar
Sietse Ringers committed
26
	UnsatisfiableRequest(action Action, missing AttributeDisjunctionList)
27

28
29
30
	RequestIssuancePermission(request IssuanceRequest, ServerName string, callback PermissionHandler)
	RequestVerificationPermission(request DisclosureRequest, ServerName string, callback PermissionHandler)
	RequestSignaturePermission(request SignatureRequest, ServerName string, callback PermissionHandler)
Sietse Ringers's avatar
Sietse Ringers committed
31

32
	RequestPin(remainingAttempts int, callback func(proceed bool, pin string))
33
34
}

Sietse Ringers's avatar
Sietse Ringers committed
35
36
// A session is an IRMA session.
type session struct {
37
38
39
40
41
	Action    Action
	Version   Version
	ServerURL string
	Handler   Handler

Sietse Ringers's avatar
Sietse Ringers committed
42
	info        *SessionInfo
43
	credManager *CredentialManager
Sietse Ringers's avatar
Sietse Ringers committed
44
	jwt         RequestorJwt
45
	irmaSession IrmaSession
Sietse Ringers's avatar
Sietse Ringers committed
46
47
	transport   *HTTPTransport
	choice      *DisclosureChoice
48
49
}

50
51
52
// We implement the handler for the keyshare protocol
var _ keyshareSessionHandler = (*session)(nil)

53
54
// Supported protocol versions. Minor version numbers should be reverse sorted.
var supportedVersions = map[int][]int{
55
	2: {2, 1},
56
57
58
59
}

func calcVersion(qr *Qr) (string, error) {
	// Parse range supported by server
60
61
62
63
64
65
66
67
68
69
70
71
	var minmajor, minminor, maxmajor, maxminor int
	var err error
	if minmajor, err = strconv.Atoi(string(qr.ProtocolVersion[0])); err != nil {
		return "", err
	}
	if minminor, err = strconv.Atoi(string(qr.ProtocolVersion[2])); err != nil {
		return "", err
	}
	if maxmajor, err = strconv.Atoi(string(qr.ProtocolMaxVersion[0])); err != nil {
		return "", err
	}
	if maxminor, err = strconv.Atoi(string(qr.ProtocolMaxVersion[2])); err != nil {
72
73
74
75
76
		return "", err
	}

	// Iterate supportedVersions in reverse sorted order (i.e. biggest major number first)
	keys := make([]int, 0, len(supportedVersions))
77
	for k := range supportedVersions {
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
		keys = append(keys, k)
	}
	sort.Sort(sort.Reverse(sort.IntSlice(keys)))
	for _, major := range keys {
		for _, minor := range supportedVersions[major] {
			aboveMinimum := major > minmajor || (major == minmajor && minor >= minminor)
			underMaximum := major < maxmajor || (major == maxmajor && minor <= maxminor)
			if aboveMinimum && underMaximum {
				return fmt.Sprintf("%d.%d", major, minor), nil
			}
		}
	}
	return "", fmt.Errorf("No supported protocol version between %s and %s", qr.ProtocolVersion, qr.ProtocolMaxVersion)
}

93
// NewSession creates and starts a new IRMA session.
94
func (cm *CredentialManager) NewSession(qr *Qr, handler Handler) {
Sietse Ringers's avatar
Sietse Ringers committed
95
	session := &session{
96
97
98
99
		Action:      Action(qr.Type),
		ServerURL:   qr.URL,
		Handler:     handler,
		transport:   NewHTTPTransport(qr.URL),
100
		credManager: cm,
101
	}
102
103
	version, err := calcVersion(qr)
	if err != nil {
Tomas's avatar
Tomas committed
104
		session.fail(&SessionError{ErrorType: ErrorProtocolVersionNotSupported, Err: err})
105
106
107
		return
	}
	session.Version = Version(version)
108
109
110
111
112
113
114
115
116

	// Check if the action is one of the supported types
	switch session.Action {
	case ActionDisclosing: // nop
	case ActionSigning: // nop
	case ActionIssuing: // nop
	case ActionUnknown:
		fallthrough
	default:
Tomas's avatar
Tomas committed
117
		session.fail(&SessionError{ErrorType: ErrorUnknownAction, Info: string(session.Action)})
Sietse Ringers's avatar
Sietse Ringers committed
118
		return
119
120
121
122
123
124
125
126
	}

	if !strings.HasSuffix(session.ServerURL, "/") {
		session.ServerURL += "/"
	}

	go session.start()

Sietse Ringers's avatar
Sietse Ringers committed
127
	return
128
129
}

Tomas's avatar
Tomas committed
130
func (session *session) fail(err *SessionError) {
131
132
133
134
135
	session.transport.Delete()
	err.Err = errors.Wrap(err.Err, 0)
	session.Handler.Failure(session.Action, err)
}

136
137
// start retrieves the first message in the IRMA protocol, checks if we can perform
// the request, and informs the user of the outcome.
Sietse Ringers's avatar
Sietse Ringers committed
138
func (session *session) start() {
139
140
	session.Handler.StatusUpdate(session.Action, StatusCommunicating)

Sietse Ringers's avatar
Sietse Ringers committed
141
	// Get the first IRMA protocol message and parse it
Sietse Ringers's avatar
Sietse Ringers committed
142
143
	session.info = &SessionInfo{}
	Err := session.transport.Get("jwt", session.info)
Sietse Ringers's avatar
Sietse Ringers committed
144
	if Err != nil {
Tomas's avatar
Tomas committed
145
		session.fail(Err.(*SessionError))
146
147
148
		return
	}

Sietse Ringers's avatar
Sietse Ringers committed
149
150
151
	var server string
	var err error
	session.jwt, server, err = parseRequestorJwt(session.Action, session.info.Jwt)
Sietse Ringers's avatar
Sietse Ringers committed
152
	if err != nil {
Tomas's avatar
Tomas committed
153
		session.fail(&SessionError{ErrorType: ErrorInvalidJWT, Err: err})
Sietse Ringers's avatar
Sietse Ringers committed
154
155
		return
	}
Sietse Ringers's avatar
Sietse Ringers committed
156
	session.irmaSession = session.jwt.IrmaSession()
Sietse Ringers's avatar
Sietse Ringers committed
157
158
	session.irmaSession.SetContext(session.info.Context)
	session.irmaSession.SetNonce(session.info.Nonce)
159
	if session.Action == ActionIssuing {
160
		ir := session.irmaSession.(*IssuanceRequest)
161
		// Store which public keys the server will use
162
		for _, credreq := range ir.Credentials {
163
			credreq.KeyCounter = session.info.Keys[credreq.CredentialTypeID.IssuerIdentifier()]
164
165
166
167
168
169
			info, err := credreq.Info(session.credManager.ConfigurationStore)
			if err != nil {
				session.fail(&SessionError{ErrorType: ErrorUnknownCredentialType, Err: err})
				return
			}
			ir.CredentialInfoList = append(ir.CredentialInfoList, info)
170
171
172
		}
	}

Sietse Ringers's avatar
Sietse Ringers committed
173
	missing := session.credManager.CheckSatisfiability(session.irmaSession.ToDisclose())
174
175
	if len(missing) > 0 {
		session.Handler.UnsatisfiableRequest(session.Action, missing)
176
		// TODO: session.transport.Delete() on dialog cancel
177
178
179
		return
	}

Sietse Ringers's avatar
Sietse Ringers committed
180
	// Ask for permission to execute the session
Sietse Ringers's avatar
Sietse Ringers committed
181
	callback := PermissionHandler(func(proceed bool, choice *DisclosureChoice) {
Sietse Ringers's avatar
Sietse Ringers committed
182
183
184
		session.choice = choice
		session.irmaSession.SetDisclosureChoice(choice)
		go session.do(proceed)
185
186
187
188
	})
	session.Handler.StatusUpdate(session.Action, StatusConnected)
	switch session.Action {
	case ActionDisclosing:
189
		session.Handler.RequestVerificationPermission(*session.irmaSession.(*DisclosureRequest), server, callback)
190
	case ActionSigning:
191
		session.Handler.RequestSignaturePermission(*session.irmaSession.(*SignatureRequest), server, callback)
192
	case ActionIssuing:
193
		session.Handler.RequestIssuancePermission(*session.irmaSession.(*IssuanceRequest), server, callback)
194
195
196
197
198
	default:
		panic("Invalid session type") // does not happen, session.Action has been checked earlier
	}
}

Sietse Ringers's avatar
Sietse Ringers committed
199
func (session *session) do(proceed bool) {
200
	if !proceed {
201
		session.transport.Delete()
202
203
204
205
		session.Handler.Cancelled(session.Action)
		return
	}
	session.Handler.StatusUpdate(session.Action, StatusCommunicating)
206

207
	if !session.irmaSession.Distributed(session.credManager.ConfigurationStore) {
Sietse Ringers's avatar
Sietse Ringers committed
208
209
210
211
		var message interface{}
		var err error
		switch session.Action {
		case ActionSigning:
212
			message, err = session.credManager.Proofs(session.choice, session.irmaSession, true)
Sietse Ringers's avatar
Sietse Ringers committed
213
		case ActionDisclosing:
214
			message, err = session.credManager.Proofs(session.choice, session.irmaSession, false)
Sietse Ringers's avatar
Sietse Ringers committed
215
		case ActionIssuing:
216
			message, err = session.credManager.IssueCommitments(session.irmaSession.(*IssuanceRequest))
Sietse Ringers's avatar
Sietse Ringers committed
217
218
		}
		if err != nil {
Tomas's avatar
Tomas committed
219
			session.fail(&SessionError{ErrorType: ErrorCrypto, Err: err})
Sietse Ringers's avatar
Sietse Ringers committed
220
221
222
223
			return
		}
		session.sendResponse(message)
	} else {
224
		var builders gabi.ProofBuilderList
Sietse Ringers's avatar
Sietse Ringers committed
225
226
227
228
229
		var err error
		switch session.Action {
		case ActionSigning:
			fallthrough
		case ActionDisclosing:
230
			builders, err = session.credManager.ProofBuilders(session.choice)
Sietse Ringers's avatar
Sietse Ringers committed
231
		case ActionIssuing:
232
			builders, err = session.credManager.IssuanceProofBuilders(session.irmaSession.(*IssuanceRequest))
Sietse Ringers's avatar
Sietse Ringers committed
233
234
		}
		if err != nil {
Tomas's avatar
Tomas committed
235
			session.fail(&SessionError{ErrorType: ErrorCrypto, Err: err})
Sietse Ringers's avatar
Sietse Ringers committed
236
237
		}

238
239
240
241
242
243
244
245
		startKeyshareSession(
			session,
			session.Handler,
			builders,
			session.irmaSession,
			session.credManager.ConfigurationStore,
			session.credManager.keyshareServers,
		)
246
	}
Sietse Ringers's avatar
Sietse Ringers committed
247
}
248

Sietse Ringers's avatar
Sietse Ringers committed
249
250
251
252
func (session *session) KeyshareDone(message interface{}) {
	session.sendResponse(message)
}

Sietse Ringers's avatar
Sietse Ringers committed
253
func (session *session) KeyshareCancelled() {
254
	session.transport.Delete()
Sietse Ringers's avatar
Sietse Ringers committed
255
256
257
	session.Handler.Cancelled(session.Action)
}

Sietse Ringers's avatar
Sietse Ringers committed
258
func (session *session) KeyshareBlocked(duration int) {
Tomas's avatar
Tomas committed
259
	session.fail(&SessionError{ErrorType: ErrorKeyshareBlocked, Info: strconv.Itoa(duration)})
Sietse Ringers's avatar
Sietse Ringers committed
260
261
262
}

func (session *session) KeyshareError(err error) {
Tomas's avatar
Tomas committed
263
	session.fail(&SessionError{ErrorType: ErrorKeyshare, Err: err})
Sietse Ringers's avatar
Sietse Ringers committed
264
265
}

Sietse Ringers's avatar
Sietse Ringers committed
266
267
type disclosureResponse string

Sietse Ringers's avatar
Sietse Ringers committed
268
func (session *session) sendResponse(message interface{}) {
Sietse Ringers's avatar
Sietse Ringers committed
269
	var log *LogEntry
Sietse Ringers's avatar
Sietse Ringers committed
270
	var err error
Sietse Ringers's avatar
Sietse Ringers committed
271

Sietse Ringers's avatar
Sietse Ringers committed
272
273
274
275
	switch session.Action {
	case ActionSigning:
		fallthrough
	case ActionDisclosing:
Sietse Ringers's avatar
Sietse Ringers committed
276
		var response disclosureResponse
Sietse Ringers's avatar
Sietse Ringers committed
277
		if err = session.transport.Post("proofs", &response, message); err != nil {
Tomas's avatar
Tomas committed
278
			session.fail(err.(*SessionError))
Sietse Ringers's avatar
Sietse Ringers committed
279
280
281
			return
		}
		if response != "VALID" {
Tomas's avatar
Tomas committed
282
			session.fail(&SessionError{ErrorType: ErrorRejected, Info: string(response)})
Sietse Ringers's avatar
Sietse Ringers committed
283
284
			return
		}
Sietse Ringers's avatar
Sietse Ringers committed
285
		log, _ = session.createLogEntry(message.(gabi.ProofList)) // TODO err
Sietse Ringers's avatar
Sietse Ringers committed
286
287
	case ActionIssuing:
		response := []*gabi.IssueSignatureMessage{}
Sietse Ringers's avatar
Sietse Ringers committed
288
		if err = session.transport.Post("commitments", &response, message); err != nil {
Tomas's avatar
Tomas committed
289
			session.fail(err.(*SessionError))
Sietse Ringers's avatar
Sietse Ringers committed
290
291
			return
		}
292
		if err = session.credManager.ConstructCredentials(response, session.irmaSession.(*IssuanceRequest)); err != nil {
Tomas's avatar
Tomas committed
293
			session.fail(&SessionError{ErrorType: ErrorCrypto, Err: err})
Sietse Ringers's avatar
Sietse Ringers committed
294
295
			return
		}
Sietse Ringers's avatar
Sietse Ringers committed
296
		log, _ = session.createLogEntry(message) // TODO err
297
298
	}

299
	_ = session.credManager.addLogEntry(log) // TODO err
300
	session.Handler.Success(session.Action)
301
}