api.go 10.7 KB
Newer Older
Sietse Ringers's avatar
Sietse Ringers committed
1
// Package servercore is the core of the IRMA server library, allowing IRMA verifiers, issuers
2
3
// or attribute-based signature applications to perform IRMA sessions with irmaclient instances
// (i.e. the IRMA app). It exposes a small interface to expose to other programming languages
Sietse Ringers's avatar
Sietse Ringers committed
4
// through cgo. It is used by the irmaserver package but otherwise not meant for use in Go.
5
package servercore
6
7
8

import (
	"encoding/json"
9
	"io/ioutil"
10
	"net/http"
11
	"path/filepath"
12
	"regexp"
13
	"strings"
14
15

	"github.com/go-errors/errors"
16
	"github.com/jasonlvhit/gocron"
17
18
	"github.com/privacybydesign/gabi"
	"github.com/privacybydesign/gabi/big"
19
	"github.com/privacybydesign/irmago"
Sietse Ringers's avatar
Sietse Ringers committed
20
	"github.com/privacybydesign/irmago/server"
21
	"github.com/sirupsen/logrus"
22
23
)

24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
type Server struct {
	conf      *server.Configuration
	sessions  sessionStore
	scheduler *gocron.Scheduler
}

func New(conf *server.Configuration) (*Server, error) {
	s := &Server{
		conf:      conf,
		scheduler: gocron.NewScheduler(),
		sessions: &memorySessionStore{
			m:    make(map[string]*session),
			conf: conf,
		},
	}
	s.scheduler.Every(10).Seconds().Do(func() {
		s.sessions.deleteExpired()
	})
	s.scheduler.Start()

	return s, s.verifyConfiguration(s.conf)
}
46

47
48
49
50
51
func (s *Server) verifyConfiguration(configuration *server.Configuration) error {
	if s.conf.Logger == nil {
		s.conf.Logger = logrus.New()
		s.conf.Logger.Level = logrus.DebugLevel
		s.conf.Logger.Formatter = &logrus.TextFormatter{}
52
	}
53
54
	server.Logger = s.conf.Logger
	irma.Logger = s.conf.Logger
55

56
	if s.conf.IrmaConfiguration == nil {
57
		var err error
58
59
		if s.conf.SchemesAssetsPath == "" {
			s.conf.IrmaConfiguration, err = irma.NewConfiguration(s.conf.SchemesPath)
60
		} else {
61
			s.conf.IrmaConfiguration, err = irma.NewConfigurationFromAssets(s.conf.SchemesPath, s.conf.SchemesAssetsPath)
62
		}
63
		if err != nil {
64
			return server.LogError(err)
65
		}
66
		if err = s.conf.IrmaConfiguration.ParseFolder(); err != nil {
67
			return server.LogError(err)
68
69
70
		}
	}

71
72
73
	if len(s.conf.IrmaConfiguration.SchemeManagers) == 0 {
		if s.conf.DownloadDefaultSchemes {
			if err := s.conf.IrmaConfiguration.DownloadDefaultSchemes(); err != nil {
74
				return server.LogError(err)
75
			}
76
		} else {
77
			return server.LogError(errors.New("no schemes found in irma_configuration folder " + s.conf.IrmaConfiguration.Path))
78
		}
79
	}
80
81
	if s.conf.SchemeUpdateInterval != 0 {
		s.conf.IrmaConfiguration.AutoUpdateSchemes(uint(s.conf.SchemeUpdateInterval))
Sietse Ringers's avatar
Sietse Ringers committed
82
83
	}

84
85
	if s.conf.IssuerPrivateKeys == nil {
		s.conf.IssuerPrivateKeys = make(map[irma.IssuerIdentifier]*gabi.PrivateKey)
86
	}
87
88
	if s.conf.IssuerPrivateKeysPath != "" {
		files, err := ioutil.ReadDir(s.conf.IssuerPrivateKeysPath)
89
		if err != nil {
90
			return server.LogError(err)
91
92
93
94
		}
		for _, file := range files {
			filename := file.Name()
			issid := irma.NewIssuerIdentifier(strings.TrimSuffix(filename, filepath.Ext(filename))) // strip .xml
95
			if _, ok := s.conf.IrmaConfiguration.Issuers[issid]; !ok {
96
				return server.LogError(errors.Errorf("Private key %s belongs to an unknown issuer", filename))
97
			}
98
			sk, err := gabi.NewPrivateKeyFromFile(filepath.Join(s.conf.IssuerPrivateKeysPath, filename))
99
			if err != nil {
100
				return server.LogError(err)
101
			}
102
			s.conf.IssuerPrivateKeys[issid] = sk
103
104
		}
	}
105
106
	for issid, sk := range s.conf.IssuerPrivateKeys {
		pk, err := s.conf.IrmaConfiguration.PublicKey(issid, int(sk.Counter))
107
		if err != nil {
108
			return server.LogError(err)
109
110
		}
		if pk == nil {
111
			return server.LogError(errors.Errorf("Missing public key belonging to private key %s-%d", issid.String(), sk.Counter))
112
113
		}
		if new(big.Int).Mul(sk.P, sk.Q).Cmp(pk.N) != 0 {
114
			return server.LogError(errors.Errorf("Private key %s-%d does not belong to corresponding public key", issid.String(), sk.Counter))
115
116
117
		}
	}

118
119
120
	if s.conf.URL != "" {
		if !strings.HasSuffix(s.conf.URL, "/") {
			s.conf.URL = s.conf.URL + "/"
121
122
		}
	} else {
123
		s.conf.Logger.Warn("No url parameter specified in configuration; unless an url is elsewhere prepended in the QR, the IRMA client will not be able to connect")
124
125
	}

Sietse Ringers's avatar
Sietse Ringers committed
126
127
128
129
130
131
132
133
134
135
136
	if s.conf.Email != "" {
		// Very basic sanity checks
		if !strings.Contains(s.conf.Email, "@") || strings.Contains(s.conf.Email, "\n") {
			return server.LogError(errors.New("Invalid email address specified"))
		}
		t := irma.NewHTTPTransport("https://metrics.privacybydesign.foundation/history/email")
		t.SetHeader("User-Agent", "irmaserver")
		var x string
		_ = t.Post("", &x, s.conf.Email)
	}

137
138
139
	return nil
}

140
func (s *Server) StartSession(req interface{}) (*irma.Qr, string, error) {
141
142
	rrequest, err := server.ParseSessionRequest(req)
	if err != nil {
143
		return nil, "", err
144
	}
145
146
147
148

	request := rrequest.SessionRequest()
	action := request.Action()
	if action == irma.ActionIssuing {
149
		if err := s.validateIssuanceRequest(request.(*irma.IssuanceRequest)); err != nil {
150
			return nil, "", err
151
152
153
		}
	}

154
155
156
157
	session := s.newSession(action, rrequest)
	s.conf.Logger.WithFields(logrus.Fields{"action": action, "session": session.token}).Infof("Session started")
	if s.conf.Logger.IsLevelEnabled(logrus.DebugLevel) {
		s.conf.Logger.WithFields(logrus.Fields{"session": session.token}).Info("Session request: ", server.ToJson(rrequest))
158
	} else {
159
		s.conf.Logger.WithFields(logrus.Fields{"session": session.token}).Info("Session request (purged of attribute values): ", server.ToJson(purgeRequest(rrequest)))
160
	}
161
162
	return &irma.Qr{
		Type: action,
163
		URL:  s.conf.URL + session.token,
164
165
166
	}, session.token, nil
}

167
168
func (s *Server) GetSessionResult(token string) *server.SessionResult {
	session := s.sessions.get(token)
169
	if session == nil {
170
		s.conf.Logger.Warn("Session result requested of unknown session ", token)
Sietse Ringers's avatar
Sietse Ringers committed
171
172
173
174
175
		return nil
	}
	return session.result
}

176
177
func (s *Server) GetRequest(token string) irma.RequestorRequest {
	session := s.sessions.get(token)
178
	if session == nil {
179
		s.conf.Logger.Warn("Session request requested of unknown session ", token)
180
181
182
183
184
		return nil
	}
	return session.rrequest
}

185
186
func (s *Server) CancelSession(token string) error {
	session := s.sessions.get(token)
187
	if session == nil {
188
		return server.LogError(errors.Errorf("can't cancel unknown session %s", token))
189
190
191
192
193
	}
	session.handleDelete()
	return nil
}

194
195
196
197
198
199
200
201
202
func ParsePath(path string) (string, string, error) {
	pattern := regexp.MustCompile("(\\w+)/?(|commitments|proofs|status|statusevents)$")
	matches := pattern.FindStringSubmatch(path)
	if len(matches) != 3 {
		return "", "", server.LogWarning(errors.Errorf("Invalid URL: %s", path))
	}
	return matches[1], matches[2], nil
}

203
204
func (s *Server) SubscribeServerSentEvents(w http.ResponseWriter, r *http.Request, token string) error {
	session := s.sessions.get(token)
205
206
207
208
209
210
211
212
213
214
215
216
217
	if session == nil {
		return server.LogError(errors.Errorf("can't subscribe to server sent events of unknown session %s", token))
	}
	if session.status.Finished() {
		return server.LogError(errors.Errorf("can't subscribe to server sent events of finished session %s", token))
	}

	session.Lock()
	defer session.Unlock()
	session.eventSource().ServeHTTP(w, r)
	return nil
}

218
func (s *Server) HandleProtocolMessage(
219
220
221
222
	path string,
	method string,
	headers map[string][]string,
	message []byte,
Sietse Ringers's avatar
Sietse Ringers committed
223
) (status int, output []byte, result *server.SessionResult) {
224
225
226
227
228
229
230
231
232
	// Parse path into session and action
	if len(path) > 0 { // Remove any starting and trailing slash
		if path[0] == '/' {
			path = path[1:]
		}
		if path[len(path)-1] == '/' {
			path = path[:len(path)-1]
		}
	}
233

234
	s.conf.Logger.WithFields(logrus.Fields{"method": method, "path": path}).Debugf("Routing protocol message")
235
	if len(message) > 0 {
236
		s.conf.Logger.Trace("POST body: ", string(message))
237
	}
238
	s.conf.Logger.Trace("HTTP headers: ", server.ToJson(headers))
239
240
241
	token, noun, err := ParsePath(path)
	if err != nil {
		status, output = server.JsonResponse(nil, server.RemoteError(server.ErrorUnsupported, ""))
242
		return
243
244
	}

Sietse Ringers's avatar
Sietse Ringers committed
245
	// Fetch the session
246
	session := s.sessions.get(token)
247
	if session == nil {
248
		s.conf.Logger.Warnf("Session not found: %s", token)
Sietse Ringers's avatar
Sietse Ringers committed
249
		status, output = server.JsonResponse(nil, server.RemoteError(server.ErrorSessionUnknown, ""))
250
		return
251
	}
252
253
	session.Lock()
	defer session.Unlock()
254

255
256
	// However we return, if the session status has been updated
	// then we should inform the user by returning a SessionResult
257
	defer func() {
258
259
		if session.status != session.prevStatus {
			session.prevStatus = session.status
260
261
262
263
			result = session.result
		}
	}()

264
	// Route to handler
265
	switch len(noun) {
266
	case 0:
267
		if method == http.MethodDelete {
268
269
270
			session.handleDelete()
			status = http.StatusOK
			return
271
		}
272
		if method == http.MethodGet {
273
274
275
276
			h := http.Header(headers)
			min := &irma.ProtocolVersion{}
			max := &irma.ProtocolVersion{}
			if err := json.Unmarshal([]byte(h.Get(irma.MinVersionHeader)), min); err != nil {
Sietse Ringers's avatar
Sietse Ringers committed
277
				status, output = server.JsonResponse(nil, session.fail(server.ErrorMalformedInput, err.Error()))
278
				return
279
280
			}
			if err := json.Unmarshal([]byte(h.Get(irma.MaxVersionHeader)), max); err != nil {
Sietse Ringers's avatar
Sietse Ringers committed
281
				status, output = server.JsonResponse(nil, session.fail(server.ErrorMalformedInput, err.Error()))
282
				return
283
			}
Sietse Ringers's avatar
Sietse Ringers committed
284
			status, output = server.JsonResponse(session.handleGetRequest(min, max))
285
			return
286
		}
Sietse Ringers's avatar
Sietse Ringers committed
287
		status, output = server.JsonResponse(nil, session.fail(server.ErrorInvalidRequest, ""))
288
		return
289
	default:
290
291
292
293
294
295
		if noun == "statusevents" {
			err := server.RemoteError(server.ErrorInvalidRequest, "server sent events not supported by this server")
			status, output = server.JsonResponse(nil, err)
			return
		}

296
297
		if method == http.MethodGet && noun == "status" {
			status, output = server.JsonResponse(session.handleGetStatus())
Sietse Ringers's avatar
Sietse Ringers committed
298
			return
299
300
301
		}

		// Below are only POST enpoints
302
		if method != http.MethodPost {
Sietse Ringers's avatar
Sietse Ringers committed
303
			status, output = server.JsonResponse(nil, session.fail(server.ErrorInvalidRequest, ""))
Sietse Ringers's avatar
Sietse Ringers committed
304
305
306
			return
		}

307
		if noun == "commitments" && session.action == irma.ActionIssuing {
Sietse Ringers's avatar
Sietse Ringers committed
308
			commitments := &irma.IssueCommitmentMessage{}
Sietse Ringers's avatar
Sietse Ringers committed
309
			if err := irma.UnmarshalValidate(message, commitments); err != nil {
Sietse Ringers's avatar
Sietse Ringers committed
310
				status, output = server.JsonResponse(nil, session.fail(server.ErrorMalformedInput, ""))
311
				return
312
			}
Sietse Ringers's avatar
Sietse Ringers committed
313
			status, output = server.JsonResponse(session.handlePostCommitments(commitments))
Sietse Ringers's avatar
Sietse Ringers committed
314
315
			return
		}
316
		if noun == "proofs" && session.action == irma.ActionDisclosing {
Sietse Ringers's avatar
Sietse Ringers committed
317
318
			disclosure := irma.Disclosure{}
			if err := irma.UnmarshalValidate(message, &disclosure); err != nil {
Sietse Ringers's avatar
Sietse Ringers committed
319
				status, output = server.JsonResponse(nil, session.fail(server.ErrorMalformedInput, ""))
320
				return
321
			}
Sietse Ringers's avatar
Sietse Ringers committed
322
			status, output = server.JsonResponse(session.handlePostDisclosure(disclosure))
Sietse Ringers's avatar
Sietse Ringers committed
323
324
			return
		}
325
		if noun == "proofs" && session.action == irma.ActionSigning {
Sietse Ringers's avatar
Sietse Ringers committed
326
327
			signature := &irma.SignedMessage{}
			if err := irma.UnmarshalValidate(message, signature); err != nil {
Sietse Ringers's avatar
Sietse Ringers committed
328
				status, output = server.JsonResponse(nil, session.fail(server.ErrorMalformedInput, ""))
329
				return
330
			}
Sietse Ringers's avatar
Sietse Ringers committed
331
			status, output = server.JsonResponse(session.handlePostSignature(signature))
332
			return
333
		}
Sietse Ringers's avatar
Sietse Ringers committed
334

Sietse Ringers's avatar
Sietse Ringers committed
335
		status, output = server.JsonResponse(nil, session.fail(server.ErrorInvalidRequest, ""))
336
		return
337
338
	}
}