api.go 8.91 KB
Newer Older
1
2
3
4
// Package core is the core of the IRMA server library, allowing IRMA verifiers, issuers
// 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
// through cgo. It is used by the irmarequestor package but otherwise not meant for use in Go.
5
package core
6
7
8

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

	"github.com/Sirupsen/logrus"
	"github.com/go-errors/errors"
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
22
)

Sietse Ringers's avatar
Sietse Ringers committed
23
func Initialize(configuration *server.Configuration) error {
24
25
26
27
28
29
30
	conf = configuration

	if conf.Logger == nil {
		conf.Logger = logrus.New()
		conf.Logger.Level = logrus.DebugLevel
		conf.Logger.Formatter = &logrus.TextFormatter{}
	}
Sietse Ringers's avatar
Sietse Ringers committed
31
	server.Logger = conf.Logger
Sietse Ringers's avatar
Sietse Ringers committed
32
	irma.Logger = conf.Logger
33
34
35

	if conf.IrmaConfiguration == nil {
		var err error
36
		if conf.CachePath == "" {
37
			conf.IrmaConfiguration, err = irma.NewConfiguration(conf.IrmaConfigurationPath)
38
		} else {
39
40
41
42
			conf.IrmaConfiguration, err = irma.NewConfigurationFromAssets(
				filepath.Join(conf.CachePath, "irma_configuration"),
				conf.IrmaConfigurationPath,
			)
43
		}
44
		if err != nil {
45
			return server.LogError(err)
46
		}
47
		if err = conf.IrmaConfiguration.ParseFolder(); err != nil {
48
			return server.LogError(err)
49
50
51
52
53
		}
	}

	if len(conf.IrmaConfiguration.SchemeManagers) == 0 {
		if conf.DownloadDefaultSchemes {
54
			if err := conf.IrmaConfiguration.DownloadDefaultSchemes(); err != nil {
55
				return server.LogError(err)
56
			}
57
		} else {
58
			return server.LogError(errors.New("no schemes found in irma_configuration folder " + conf.IrmaConfiguration.Path))
59
		}
60
61
	}

Sietse Ringers's avatar
Sietse Ringers committed
62
63
64
65
	if conf.SchemeUpdateInterval != 0 {
		conf.IrmaConfiguration.AutoUpdateSchemes(uint(conf.SchemeUpdateInterval))
	}

66
67
	if conf.IssuerPrivateKeys == nil {
		conf.IssuerPrivateKeys = make(map[irma.IssuerIdentifier]*gabi.PrivateKey)
68
	}
69
70
	if conf.IssuerPrivateKeysPath != "" {
		files, err := ioutil.ReadDir(conf.IssuerPrivateKeysPath)
71
		if err != nil {
72
			return server.LogError(err)
73
74
75
76
77
		}
		for _, file := range files {
			filename := file.Name()
			issid := irma.NewIssuerIdentifier(strings.TrimSuffix(filename, filepath.Ext(filename))) // strip .xml
			if _, ok := conf.IrmaConfiguration.Issuers[issid]; !ok {
78
				return server.LogError(errors.Errorf("Private key %s belongs to an unknown issuer", filename))
79
			}
80
			sk, err := gabi.NewPrivateKeyFromFile(filepath.Join(conf.IssuerPrivateKeysPath, filename))
81
			if err != nil {
82
				return server.LogError(err)
83
			}
84
			conf.IssuerPrivateKeys[issid] = sk
85
86
		}
	}
87
	for issid, sk := range conf.IssuerPrivateKeys {
88
89
		pk, err := conf.IrmaConfiguration.PublicKey(issid, int(sk.Counter))
		if err != nil {
90
			return server.LogError(err)
91
92
		}
		if pk == nil {
93
			return server.LogError(errors.Errorf("Missing public key belonging to private key %s-%d", issid.String(), sk.Counter))
94
95
		}
		if new(big.Int).Mul(sk.P, sk.Q).Cmp(pk.N) != 0 {
96
			return server.LogError(errors.Errorf("Private key %s-%d does not belong to corresponding public key", issid.String(), sk.Counter))
97
98
99
		}
	}

100
101
102
	if conf.URL != "" {
		if !strings.HasSuffix(conf.URL, "/") {
			conf.URL = conf.URL + "/"
103
104
105
106
107
		}
	} else {
		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")
	}

108
109
110
	return nil
}

111
112
113
func StartSession(req interface{}) (*irma.Qr, string, error) {
	rrequest, err := server.ParseSessionRequest(req)
	if err != nil {
114
		return nil, "", server.LogError(err)
115
	}
116
117
118
119

	request := rrequest.SessionRequest()
	action := request.Action()
	if action == irma.ActionIssuing {
120
		if err := validateIssuanceRequest(request.(*irma.IssuanceRequest)); err != nil {
121
			return nil, "", server.LogError(err)
122
123
124
		}
	}

125
	session := newSession(action, rrequest)
126
	conf.Logger.Infof("%s session started, token %s", action, session.token)
127
	if conf.Logger.IsLevelEnabled(logrus.DebugLevel) {
128
		conf.Logger.Debug("Session request: ", server.ToJson(rrequest))
129
	} else {
130
		logPurgedRequest(rrequest)
131
	}
132
133
	return &irma.Qr{
		Type: action,
134
		URL:  conf.URL + session.token,
135
136
137
	}, session.token, nil
}

Sietse Ringers's avatar
Sietse Ringers committed
138
func GetSessionResult(token string) *server.SessionResult {
Sietse Ringers's avatar
Sietse Ringers committed
139
	session := sessions.get(token)
140
	if session == nil {
141
		conf.Logger.Warn("Session result requested of unknown session ", token)
Sietse Ringers's avatar
Sietse Ringers committed
142
143
144
145
146
		return nil
	}
	return session.result
}

147
148
149
150
151
152
153
154
155
func GetRequest(token string) irma.RequestorRequest {
	session := sessions.get(token)
	if session == nil {
		conf.Logger.Warn("Session request requested of unknown session ", token)
		return nil
	}
	return session.rrequest
}

156
157
158
func CancelSession(token string) error {
	session := sessions.get(token)
	if session == nil {
159
		return server.LogError(errors.Errorf("can't cancel unknown session %s", token))
160
161
162
163
164
	}
	session.handleDelete()
	return nil
}

165
166
167
168
169
func HandleProtocolMessage(
	path string,
	method string,
	headers map[string][]string,
	message []byte,
Sietse Ringers's avatar
Sietse Ringers committed
170
) (status int, output []byte, result *server.SessionResult) {
171
172
173
174
175
176
177
178
179
	// 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]
		}
	}
180

181
	conf.Logger.Debugf("Routing protocol message: %s %s", method, path)
182
183
184
185
	if len(message) > 0 {
		conf.Logger.Trace("POST body: ", string(message))
	}
	conf.Logger.Trace("HTTP headers: ", server.ToJson(headers))
186
	pattern := regexp.MustCompile("(\\w+)/?(|commitments|proofs|status)$")
187
188
189
	matches := pattern.FindStringSubmatch(path)
	if len(matches) != 3 {
		conf.Logger.Warnf("Invalid URL: %s", path)
Sietse Ringers's avatar
Sietse Ringers committed
190
		status, output = server.JsonResponse(nil, server.RemoteError(server.ErrorInvalidRequest, ""))
191
		return
192
193
	}

Sietse Ringers's avatar
Sietse Ringers committed
194
	// Fetch the session
195
	token := matches[1]
196
	noun := matches[2]
197
198
199
	session := sessions.get(token)
	if session == nil {
		conf.Logger.Warnf("Session not found: %s", token)
Sietse Ringers's avatar
Sietse Ringers committed
200
		status, output = server.JsonResponse(nil, server.RemoteError(server.ErrorSessionUnknown, ""))
201
		return
202
	}
203
204
	session.Lock()
	defer session.Unlock()
205

206
	// However we return, if the session has been finished or cancelled by any of the handlers
207
208
	// then we should inform the user by returning a SessionResult - but only if we have not
	// already done this in the past, e.g. by a previous HTTP call handled by this function
209
	defer func() {
210
211
		if session.finished() && !session.returned {
			session.returned = true
212
			result = session.result
213
			conf.Logger.Infof("Session %s done, status %s", session.token, session.result.Status)
214
		}
215
		sessions.update(token, session)
216
217
	}()

218
	// Route to handler
219
	switch len(noun) {
220
	case 0:
221
		if method == http.MethodDelete {
222
223
224
			session.handleDelete()
			status = http.StatusOK
			return
225
		}
226
		if method == http.MethodGet {
227
228
229
230
			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
231
				status, output = server.JsonResponse(nil, session.fail(server.ErrorMalformedInput, err.Error()))
232
				return
233
234
			}
			if err := json.Unmarshal([]byte(h.Get(irma.MaxVersionHeader)), max); err != nil {
Sietse Ringers's avatar
Sietse Ringers committed
235
				status, output = server.JsonResponse(nil, session.fail(server.ErrorMalformedInput, err.Error()))
236
				return
237
			}
Sietse Ringers's avatar
Sietse Ringers committed
238
			status, output = server.JsonResponse(session.handleGetRequest(min, max))
239
			return
240
		}
Sietse Ringers's avatar
Sietse Ringers committed
241
		status, output = server.JsonResponse(nil, session.fail(server.ErrorInvalidRequest, ""))
242
		return
243
	default:
244
245
		if method == http.MethodGet && noun == "status" {
			status, output = server.JsonResponse(session.handleGetStatus())
Sietse Ringers's avatar
Sietse Ringers committed
246
			return
247
248
249
		}

		// Below are only POST enpoints
250
		if method != http.MethodPost {
Sietse Ringers's avatar
Sietse Ringers committed
251
			status, output = server.JsonResponse(nil, session.fail(server.ErrorInvalidRequest, ""))
Sietse Ringers's avatar
Sietse Ringers committed
252
253
254
			return
		}

255
		if noun == "commitments" && session.action == irma.ActionIssuing {
Sietse Ringers's avatar
Sietse Ringers committed
256
			commitments := &irma.IssueCommitmentMessage{}
Sietse Ringers's avatar
Sietse Ringers committed
257
			if err := irma.UnmarshalValidate(message, commitments); err != nil {
Sietse Ringers's avatar
Sietse Ringers committed
258
				status, output = server.JsonResponse(nil, session.fail(server.ErrorMalformedInput, ""))
259
				return
260
			}
Sietse Ringers's avatar
Sietse Ringers committed
261
			status, output = server.JsonResponse(session.handlePostCommitments(commitments))
Sietse Ringers's avatar
Sietse Ringers committed
262
263
			return
		}
264
		if noun == "proofs" && session.action == irma.ActionDisclosing {
Sietse Ringers's avatar
Sietse Ringers committed
265
266
			disclosure := irma.Disclosure{}
			if err := irma.UnmarshalValidate(message, &disclosure); err != nil {
Sietse Ringers's avatar
Sietse Ringers committed
267
				status, output = server.JsonResponse(nil, session.fail(server.ErrorMalformedInput, ""))
268
				return
269
			}
Sietse Ringers's avatar
Sietse Ringers committed
270
			status, output = server.JsonResponse(session.handlePostDisclosure(disclosure))
Sietse Ringers's avatar
Sietse Ringers committed
271
272
			return
		}
273
		if noun == "proofs" && session.action == irma.ActionSigning {
Sietse Ringers's avatar
Sietse Ringers committed
274
275
			signature := &irma.SignedMessage{}
			if err := irma.UnmarshalValidate(message, signature); err != nil {
Sietse Ringers's avatar
Sietse Ringers committed
276
				status, output = server.JsonResponse(nil, session.fail(server.ErrorMalformedInput, ""))
277
				return
278
			}
Sietse Ringers's avatar
Sietse Ringers committed
279
			status, output = server.JsonResponse(session.handlePostSignature(signature))
280
			return
281
		}
Sietse Ringers's avatar
Sietse Ringers committed
282

Sietse Ringers's avatar
Sietse Ringers committed
283
		status, output = server.JsonResponse(nil, session.fail(server.ErrorInvalidRequest, ""))
284
		return
285
286
	}
}