server.go 9.79 KB
Newer Older
1
// Package irmaserver is a server allowing IRMA verifiers, issuers or attribute-based signature applications (the requestor) to perform IRMA sessions with irmaclient instances (i.e. the IRMA app). It exposes a RESTful protocol with which the requestor can start and manage the session as well as HTTP endpoints for the irmaclient.
Sietse Ringers's avatar
Sietse Ringers committed
2
package irmaserver
3
4

import (
5
6
	"crypto/x509"
	"encoding/pem"
7
	"fmt"
8
9
	"io/ioutil"
	"net/http"
10
	"time"
11

12
	"github.com/dgrijalva/jwt-go"
13
	"github.com/go-chi/chi"
Sietse Ringers's avatar
Sietse Ringers committed
14
	"github.com/go-chi/cors"
15
	"github.com/privacybydesign/irmago"
Sietse Ringers's avatar
Sietse Ringers committed
16
17
	"github.com/privacybydesign/irmago/server"
	"github.com/privacybydesign/irmago/server/irmarequestor"
18
19
)

20
var (
21
22
	serv, clientserv *http.Server
	conf             *Configuration
23
)
24

25
// Start the server. If successful then it will not return until Stop() is called.
26
func Start(config *Configuration) error {
27
	if err := Initialize(config); err != nil {
28
29
30
		return err
	}

31
32
33
	// Start server(s)
	if conf.separateClientServer() {
		go startClientServer()
34
	}
35
	startRequestorServer()
36

37
	return nil
38
39
}

40
41
42
func startRequestorServer() {
	serv = &http.Server{}
	startServer(serv, Handler(), "Server", conf.ListenAddress, conf.Port)
43
44
}

45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
func startClientServer() {
	clientserv = &http.Server{}
	startServer(clientserv, ClientHandler(), "Client server", conf.ClientListenAddress, conf.ClientPort)
}

func startServer(s *http.Server, handler http.Handler, name, addr string, port int) {
	fulladdr := fmt.Sprintf("%s:%d", addr, port)
	conf.Logger.Info(name, " listening at ", fulladdr)
	s.Addr = fulladdr
	s.Handler = handler
	if err := s.ListenAndServe(); err != http.ErrServerClosed {
		_ = server.LogFatal(err)
	}
}

func Stop() error {
	var err1, err2 error

	// Even if closing serv fails, we want to try closing clientserv
	err1 = serv.Close()
	if clientserv != nil {
		err2 = clientserv.Close()
	}

	// Now check errors
70
	if err1 != nil && err1 != http.ErrServerClosed {
71
72
		return err1
	}
73
	if err2 != nil && err2 != http.ErrServerClosed {
74
75
76
77
78
79
		return err2
	}
	return nil
}

func Initialize(config *Configuration) error {
80
	conf = config
81
	if err := irmarequestor.Initialize(conf.Configuration); err != nil {
82
		return err
83
	}
84
	if err := conf.initialize(); err != nil {
85
		return err
86
	}
87
88
	return nil
}
89

90
func ClientHandler() http.Handler {
91
	router := chi.NewRouter()
Sietse Ringers's avatar
Sietse Ringers committed
92
93
94
	router.Use(cors.New(cors.Options{
		AllowedOrigins: []string{"*"},
		AllowedHeaders: []string{"Accept", "Authorization", "Content-Type"},
Sietse Ringers's avatar
Sietse Ringers committed
95
		AllowedMethods: []string{http.MethodGet, http.MethodPost, http.MethodDelete},
Sietse Ringers's avatar
Sietse Ringers committed
96
97
	}).Handler)

98
	router.Mount("/irma/", irmarequestor.HttpHandlerFunc())
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
	return router
}

// Handler returns a http.Handler that handles all IRMA requestor messages
// and IRMA client messages.
func Handler() http.Handler {
	router := chi.NewRouter()
	router.Use(cors.New(cors.Options{
		AllowedOrigins: []string{"*"},
		AllowedHeaders: []string{"Accept", "Authorization", "Content-Type"},
		AllowedMethods: []string{http.MethodGet, http.MethodPost, http.MethodDelete},
	}).Handler)

	if !conf.separateClientServer() {
		// Mount server for irmaclient
		router.Mount("/irma/", irmarequestor.HttpHandlerFunc())
	}
116

117
	// Server routes
118
	router.Post("/session", handleCreate)
119
	router.Delete("/session/{token}", handleDelete)
120
121
	router.Get("/session/{token}/status", handleStatus)
	router.Get("/session/{token}/result", handleResult)
Sietse Ringers's avatar
Sietse Ringers committed
122
123

	// Routes for getting signed JWTs containing the session result. Only work if configuration has a private key
124
125
	router.Get("/session/{token}/result-jwt", handleJwtResult)
	router.Get("/session/{token}/getproof", handleJwtProofs) // irma_api_server-compatible JWT
126

127
128
	router.Get("/publickey", handlePublicKey)

129
	return router
130
131
}

132
133
134
func handleCreate(w http.ResponseWriter, r *http.Request) {
	body, err := ioutil.ReadAll(r.Body)
	if err != nil {
135
136
		conf.Logger.Error("Could not read session request HTTP POST body")
		_ = server.LogError(err)
Sietse Ringers's avatar
Sietse Ringers committed
137
		server.WriteError(w, server.ErrorInvalidRequest, err.Error())
138
139
		return
	}
140

Sietse Ringers's avatar
Sietse Ringers committed
141
142
143
	// Authenticate request: check if the requestor is known and allowed to submit requests.
	// We do this by feeding the HTTP POST details to all known authenticators, and see if
	// one of them is applicable and able to authenticate the request.
144
	var (
145
		rrequest  irma.RequestorRequest
146
147
148
149
150
151
		request   irma.SessionRequest
		requestor string
		rerr      *irma.RemoteError
		applies   bool
	)
	for _, authenticator := range authenticators {
152
		applies, rrequest, requestor, rerr = authenticator.Authenticate(r.Header, body)
153
154
155
156
157
		if applies || rerr != nil {
			break
		}
	}
	if rerr != nil {
158
		_ = server.LogError(rerr)
159
160
161
162
		server.WriteResponse(w, nil, rerr)
		return
	}
	if !applies {
163
164
		conf.Logger.Warnf("Session request uses unknown authentication method, HTTP headers: %s, HTTP POST body: %s",
			server.ToJson(r.Header), string(body))
Sietse Ringers's avatar
Sietse Ringers committed
165
		server.WriteError(w, server.ErrorInvalidRequest, "Request could not be authorized")
166
167
168
		return
	}

169
170
	// Authorize request: check if the requestor is allowed to verify or issue
	// the requested attributes or credentials
171
	request = rrequest.SessionRequest()
172
173
174
	if request.Action() == irma.ActionIssuing {
		allowed, reason := conf.CanIssue(requestor, request.(*irma.IssuanceRequest).Credentials)
		if !allowed {
175
176
			conf.Logger.Warn("Requestor %s tried to issue credential %s but it is not authorized to; full request: %s",
				requestor, reason, server.ToJson(request))
177
178
179
180
			server.WriteError(w, server.ErrorUnauthorized, reason)
			return
		}
	}
Sietse Ringers's avatar
Sietse Ringers committed
181
	disjunctions := request.ToDisclose()
182
183
184
	if len(disjunctions) > 0 {
		allowed, reason := conf.CanVerifyOrSign(requestor, request.Action(), disjunctions)
		if !allowed {
185
186
			conf.Logger.Warn("Requestor %s tried to verify attribute %s but it is not authorized to; full request: %s",
				requestor, reason, server.ToJson(request))
187
188
189
190
191
192
			server.WriteError(w, server.ErrorUnauthorized, reason)
			return
		}
	}

	// Everything is authenticated and parsed, we're good to go!
193
	qr, _, err := irmarequestor.StartSession(rrequest, nil)
194
	if err != nil {
Sietse Ringers's avatar
Sietse Ringers committed
195
		server.WriteError(w, server.ErrorInvalidRequest, err.Error())
196
197
198
		return
	}

Sietse Ringers's avatar
Sietse Ringers committed
199
	server.WriteJson(w, qr)
200
201
202
203
204
}

func handleStatus(w http.ResponseWriter, r *http.Request) {
	res := irmarequestor.GetSessionResult(chi.URLParam(r, "token"))
	if res == nil {
Sietse Ringers's avatar
Sietse Ringers committed
205
		server.WriteError(w, server.ErrorSessionUnknown, "")
206
207
		return
	}
Sietse Ringers's avatar
Sietse Ringers committed
208
	server.WriteJson(w, res.Status)
209
210
}

211
212
213
214
215
216
217
func handleDelete(w http.ResponseWriter, r *http.Request) {
	err := irmarequestor.CancelSession(chi.URLParam(r, "token"))
	if err != nil {
		server.WriteError(w, server.ErrorSessionUnknown, "")
	}
}

218
219
220
func handleResult(w http.ResponseWriter, r *http.Request) {
	res := irmarequestor.GetSessionResult(chi.URLParam(r, "token"))
	if res == nil {
Sietse Ringers's avatar
Sietse Ringers committed
221
		server.WriteError(w, server.ErrorSessionUnknown, "")
222
223
		return
	}
Sietse Ringers's avatar
Sietse Ringers committed
224
	server.WriteJson(w, res)
225
226
}

227
func handleJwtResult(w http.ResponseWriter, r *http.Request) {
228
	if conf.jwtPrivateKey == nil {
229
		conf.Logger.Warn("Session result JWT requested but no JWT private key is configured")
230
231
		server.WriteError(w, server.ErrorUnknown, "JWT signing not supported")
		return
232
	}
233

234
235
	sessiontoken := chi.URLParam(r, "token")
	res := irmarequestor.GetSessionResult(sessiontoken)
236
237
238
	if res == nil {
		server.WriteError(w, server.ErrorSessionUnknown, "")
		return
239
	}
240
241
242
243
244
245
246
247
248
249

	claims := struct {
		jwt.StandardClaims
		*server.SessionResult
	}{
		SessionResult: res,
	}
	claims.Issuer = conf.JwtIssuer
	claims.IssuedAt = time.Now().Unix()
	claims.Subject = string(res.Type) + "_result"
250
251
252
253
	validity := irmarequestor.GetRequest(sessiontoken).Base().ResultJwtValidity
	if validity != 0 {
		claims.ExpiresAt = time.Now().Unix() + int64(validity)
	}
254
255
256

	// Sign the jwt and return it
	token := jwt.NewWithClaims(jwt.SigningMethodRS256, claims)
257
	resultJwt, err := token.SignedString(conf.jwtPrivateKey)
258
	if err != nil {
259
260
		conf.Logger.Error("Failed to sign session result JWT")
		_ = server.LogError(err)
261
262
263
264
265
266
267
		server.WriteError(w, server.ErrorUnknown, err.Error())
		return
	}
	server.WriteString(w, resultJwt)
}

func handleJwtProofs(w http.ResponseWriter, r *http.Request) {
268
	if conf.jwtPrivateKey == nil {
269
		conf.Logger.Warn("Session result JWT requested but no JWT private key is configured")
270
271
272
273
		server.WriteError(w, server.ErrorUnknown, "JWT signing not supported")
		return
	}

274
275
	sessiontoken := chi.URLParam(r, "token")
	res := irmarequestor.GetSessionResult(sessiontoken)
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
	if res == nil {
		server.WriteError(w, server.ErrorSessionUnknown, "")
		return
	}

	claims := jwt.MapClaims{}

	// Fill standard claims
	switch res.Type {
	case irma.ActionDisclosing:
		claims["subject"] = "verification_result"
	case irma.ActionSigning:
		claims["subject"] = "abs_result"
	default:
		if res == nil {
			server.WriteError(w, server.ErrorInvalidRequest, "")
			return
		}
	}
	claims["iat"] = time.Now().Unix()
	if conf.JwtIssuer != "" {
		claims["iss"] = conf.JwtIssuer
	}
	claims["status"] = res.Status
300
301
302
303
	validity := irmarequestor.GetRequest(sessiontoken).Base().ResultJwtValidity
	if validity != 0 {
		claims["exp"] = time.Now().Unix() + int64(validity)
	}
304
305
306
307
308
309
310
311
312
313
314
315
316

	// Disclosed credentials and possibly signature
	m := make(map[irma.AttributeTypeIdentifier]string, len(res.Disclosed))
	for _, attr := range res.Disclosed {
		m[attr.Identifier] = attr.Value[""]
	}
	claims["attributes"] = m
	if res.Signature != nil {
		claims["signature"] = res.Signature
	}

	// Sign the jwt and return it
	token := jwt.NewWithClaims(jwt.SigningMethodRS256, claims)
317
	resultJwt, err := token.SignedString(conf.jwtPrivateKey)
318
	if err != nil {
319
320
		conf.Logger.Error("Failed to sign session result JWT")
		_ = server.LogError(err)
321
322
		server.WriteError(w, server.ErrorUnknown, err.Error())
		return
323
	}
324
	server.WriteString(w, resultJwt)
325
}
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343

func handlePublicKey(w http.ResponseWriter, r *http.Request) {
	if conf.jwtPrivateKey == nil {
		server.WriteError(w, server.ErrorUnsupported, "")
		return
	}

	bts, err := x509.MarshalPKIXPublicKey(&conf.jwtPrivateKey.PublicKey)
	if err != nil {
		server.WriteError(w, server.ErrorUnknown, err.Error())
		return
	}
	pubBytes := pem.EncodeToMemory(&pem.Block{
		Type:  "PUBLIC KEY",
		Bytes: bts,
	})
	_, _ = w.Write(pubBytes)
}