File: OpenSSL.cpp

package info (click to toggle)
storm-lang 0.7.5-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 52,028 kB
  • sloc: ansic: 261,471; cpp: 140,432; sh: 14,891; perl: 9,846; python: 2,525; lisp: 2,504; asm: 860; makefile: 678; pascal: 70; java: 52; xml: 37; awk: 12
file content (557 lines) | stat: -rw-r--r-- 15,145 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
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
70
71
72
73
74
75
76
77
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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
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
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
#include "stdafx.h"
#include "OpenSSL.h"
#include "OpenSSLError.h"
#include "ClientContext.h"
#include "ServerContext.h"

#ifdef POSIX

#include "Exception.h"
#include "OpenSSLCert.h"
#include "Core/Convert.h"
#include "RuntimeSSL.h"

#include <openssl/err.h>
#include <openssl/opensslv.h>
#include <openssl/opensslconf.h>
#include <openssl/x509v3.h>

#ifndef OPENSSL_THREADS
#error "No thread support in OpenSSL!"
#endif
#if OPENSSL_VERSION_NUMBER < 0x10100000
#error "Too old OpenSSL version, we rely on some locking support!"
#endif

namespace ssl {

	/**
	 * Initialze the library properly.
	 */
	class Initializer {
	public:
		Initializer() {
			initRuntimeSSL();

			SSL_library_init();
			SSL_load_error_strings();
			CONF_modules_load_file(NULL, NULL, 0);

			// From the headers of OpenSSL, it seems like the requirements of locking functions was
			// removed earlier. As such, we don't need to give them anymore.
		}
	};

	void init() {
		static Initializer i;
	}

	static int verifyCallback(int preverifyOk, X509_STORE_CTX *x509) {
		// This is where we would check any of our own certificates.
		// See the manpage for SSL_CTX_set_verify for an example of how to get access to some context in here.

		// 0 - fail immediately
		// 1 - continue
		if (preverifyOk != 1)
			return 0;
		return 1;
	}

#define EXCLUDE ":!aNULL:!kRSA:!PSK:!MD5";
	static const char *defaultCiphers = "DEFAULT" EXCLUDE;
	static const char *strongCiphers = "HIGH:!RC4" EXCLUDE;

	OpenSSLContext *OpenSSLContext::createClient(ClientContext *context) {
		init();
		// Note: This means SSLv3 or TLSv1.x, as available.
		OpenSSLContext *ctx = new OpenSSLContext(SSL_CTX_new(TLS_client_method()), false);

		SSL_CTX_set_verify(ctx->context, SSL_VERIFY_PEER, verifyCallback);
		SSL_CTX_set_verify_depth(ctx->context, 10); // Should be enough.

		long options = SSL_OP_NO_SSLv2;
		if (context->strongCiphers())
			options |= SSL_OP_NO_SSLv3 | SSL_OP_NO_TLSv1;
		SSL_CTX_set_options(ctx->context, options);

		// Allowed ciphers. We should probably modify this list a bit...
		if (context->strongCiphers())
			SSL_CTX_set_cipher_list(ctx->context, strongCiphers);
		else
			SSL_CTX_set_cipher_list(ctx->context, defaultCiphers);


		if (Certificate *cert = context->pinnedCertificate()) {
			// Only trust the supplied certificate:
			RefPtr<OpenSSLCert> pinned = cert->get()->openSSL();

			X509_STORE *store = X509_STORE_new();

			// Does not take ownership of the cert.
			X509_STORE_add_cert(store, pinned->data);

			// Takes ownership of "store".
			SSL_CTX_set0_verify_cert_store(ctx->context, store);
		} else {
			// Use default paths for certificates.
			SSL_CTX_set_default_verify_paths(ctx->context);
		}

		ctx->checkHostname = context->verifyHostname();

		return ctx;
	}

	OpenSSLContext *OpenSSLContext::createServer(ServerContext *context, CertificateKey *key) {
		init();

		RefPtr<OpenSSLCert> oCert = key->certificate()->get()->openSSL();
		RefPtr<OpenSSLCertKey> oKey = key->get()->openSSL();

		OpenSSLContext *ctx = new OpenSSLContext(SSL_CTX_new(TLS_server_method()), true);

		SSL_CTX_set_verify(ctx->context, SSL_VERIFY_NONE, NULL);

		long options = SSL_OP_NO_SSLv2;
		if (context->strongCiphers())
			options |= SSL_OP_NO_SSLv3 | SSL_OP_NO_TLSv1;
		SSL_CTX_set_options(ctx->context, options);

		// Allowed ciphers. We should probably modify this list a bit...
		if (context->strongCiphers())
			SSL_CTX_set_cipher_list(ctx->context, strongCiphers);
		else
			SSL_CTX_set_cipher_list(ctx->context, defaultCiphers);

		SSL_CTX_use_certificate(ctx->context, oCert->data);
		SSL_CTX_use_PrivateKey(ctx->context, oKey->data);

		return ctx;
	}

	OpenSSLContext::OpenSSLContext(SSL_CTX *ctx, bool server)
		: context(ctx), checkHostname(false), isServer(server) {

		if (!ctx)
			throw new (runtime::someEngine()) SSLError(S("Failed to create OpenSSL context."));
	}

	OpenSSLContext::~OpenSSLContext() {
		SSL_CTX_free(context);
	}

	SSLSession *OpenSSLContext::createSession() {
		if (isServer)
			return new OpenSSLServerSession(this);
		else
			return new OpenSSLClientSession(this);
	}

	/**
	 * Data structure containing GC pointers that we allocate for our BIO class.
	 */
	struct BIO_data {
		IStream *input;
		OStream *output;

		// Buffer to support "peek".
		GcArray<byte> *buffer;

		// Number of bytes we have consumed inside 'buffer'.
		Nat consumed;
	};

	// Pointer offsets in BIO_data
	static const size_t BIO_data_offsets[] = {
		OFFSET_OF(BIO_data, input),
		OFFSET_OF(BIO_data, output),
		OFFSET_OF(BIO_data, buffer),
	};

	// GCtype for the data.
	class BioType {
	public:
		BioType() {
			type = (GcType *)malloc(gcTypeSize(ARRAY_COUNT(BIO_data_offsets)));
			type->kind = GcType::tFixed;
			type->type = null;
			type->finalizer = null;
			type->stride = sizeof(BIO_data);
			type->count = ARRAY_COUNT(BIO_data_offsets);
			for (size_t i = 0; i < ARRAY_COUNT(BIO_data_offsets); i++)
				type->offset[i] = BIO_data_offsets[i];
		}
		~BioType() {
			free(type);
		}

		GcType *type;
	};

	// Allocate BIO data for streams. Ensures that this data is not moved by the GC. It still needs
	// to be kept alive somehow.
	static BIO_data *allocData(IStream *input, OStream *output) {
		static BioType t;
		BIO_data *data = (BIO_data *)runtime::allocStaticRaw(input->engine(), t.type);
		data->input = input;
		data->output = output;
		return data;
	}

	/**
	 * A BIO wrapper that forwards to/from our streams.
	 */

	// Maximum number of bytes to read/write in one go.
	static int bioWrite(BIO *bio, const char *src, int length) {
		BIO_data *data = (BIO_data *)BIO_get_data(bio);
		GcPreArray<Byte, 4096> buffer;

		size_t offset = 0;
		while (offset < size_t(length)) {
			size_t toWrite = min(buffer.count, size_t(length) - offset);
			memcpy(buffer.v, src + offset, toWrite);

			Buffer b = fullBuffer(buffer);
			b.filled(toWrite);
			data->output->write(b);

			offset += toWrite;
		}

		return length;
	}

	static int bioRead(BIO *bio, char *dest, int length) {
		BIO_data *data = (BIO_data *)BIO_get_data(bio);

		// Note: Will ensure so that 'size' is not too large.
		GcPreArray<Byte, 4096> buffer(length);

		// Note: This implementation might give to little data back, but that is fine.
		Buffer b = emptyBuffer(buffer);
		b = data->input->read(b);
		memcpy(dest, b.dataPtr(), b.filled());

		return int(b.filled());
	}

	static int bioPuts(BIO *bio, const char *buffer) {
		return bioWrite(bio, buffer, strlen(buffer));
	}

	static int bioGets(BIO *bio, char *buffer, int size) {
		// TODO: Implement this... It should work like BIO_puts()
		// I don't think it is strictly necessary though. The network BIOs do not
		// support gets, so we're probably fine.
		return 0;
	}

	static long int bioCtrl(BIO *bio, int cmd, long larg, void *parg) {
		BIO_data *data = (BIO_data *)BIO_get_data(bio);

		switch (cmd) {
		case BIO_CTRL_RESET:
			// PLN("BIO_CTRL_RESET");
			break;
		case BIO_CTRL_EOF:
			// PLN("BIO_CTRL_EOF");
			break;
		case BIO_CTRL_SET_CLOSE:
			// PLN("BIO_CTRL_SET_CLOSE");
			break;
		case BIO_CTRL_GET_CLOSE:
			// PLN("BIO_CTRL_GET_CLOSE");
			break;
		case BIO_CTRL_PENDING:
			// PLN("BIO_CTRL_PENDING");
			break;
		case BIO_CTRL_WPENDING:
			// PLN("BIO_CTRL_WPENDING");
			break;
		case BIO_CTRL_FLUSH:
			data->output->flush();
			return 1;
		case BIO_CTRL_GET_CALLBACK:
			// PLN("BIO_CTRL_GET_CALLBACK");
			break;
		case BIO_CTRL_SET_CALLBACK:
			// PLN("BIO_CTRL_SET_CALLBACK");
			break;
		}
		return 0;
	}

	static long int bioCtrlCb(BIO *bio, int cmd, BIO_info_cb *cb) {
		// PVAR(cmd);
		return 0;
	}

	class StormBioMethod {
	public:
		StormBioMethod() {
			int type = BIO_get_new_index();
			method = BIO_meth_new(BIO_TYPE_SOURCE_SINK | type, "STORM I/O");

			// We could call BIO_meth_free() at shutdown...

			// Note: There are *_ex versions of read and write. Maybe we should use them instead?
			BIO_meth_set_write(method, bioWrite);
			BIO_meth_set_read(method, bioRead);
			BIO_meth_set_puts(method, bioPuts);
			BIO_meth_set_gets(method, bioGets);
			BIO_meth_set_ctrl(method, bioCtrl);
			BIO_meth_set_callback_ctrl(method, bioCtrlCb);
			// There are create and destroy as well, but I don't think we need them.
		}

		~StormBioMethod() {
			BIO_meth_free(method);
		}

		BIO_METHOD *method;
	};

	// Create a BIO that wraps a Storm istream and an ostream.
	// Assumes that "data" is kept alive by storing a reference to it somewhere else.
	static BIO *BIO_new_storm(BIO_data *data) {
		static StormBioMethod m;
		BIO *bio = BIO_new(m.method);
		BIO_set_data(bio, data);
		return bio;
	}

	// We can chain BIOs using:
	// con = BIO_new(stormBio)
	// ssl = BIO_new_ssl(ctx, 1) // 1 is for clients
	// result = BIO_push(ssl, con)

	OpenSSLSession::OpenSSLSession(OpenSSLContext *ctx) : context(ctx), connection(null), eof(false) {
		context->ref();
	}

	OpenSSLSession::~OpenSSLSession() {
		context->unref();
	}

	Bool OpenSSLSession::more(void *data) {
		os::Lock::L z(lock);
		BIO_data *d = (BIO_data *)data;

		if (d->buffer != null && d->consumed < d->buffer->filled)
			return true;

		return !eof;
	}

	void OpenSSLSession::read(Buffer &to, void *data) {
		os::Lock::L z(lock);
		BIO_data *d = (BIO_data *)data;

		if (d->buffer != null && d->consumed < d->buffer->filled) {
			// Read data from the buffer first.
			Nat copy = min(to.free(), Nat(d->buffer->filled) - d->consumed);
			memcpy(to.dataPtr() + to.filled(), d->buffer->v + d->consumed, copy);
			to.filled(to.filled() + copy);
			d->consumed += copy;

			if (d->consumed >= d->buffer->filled) {
				// We don't need the buffer anymore. Free it.
				d->consumed = 0;
				d->buffer = null;
			}
		}

		// Still more to read?
		if (to.free() > 0) {
			Nat bytes = readIntoBuffer(to.dataPtr() + to.filled(), to.free(), data);
			to.filled(to.filled() + bytes);
		}
	}

	void OpenSSLSession::peek(Buffer &to, void *data) {
		os::Lock::L z(lock);
		BIO_data *d = (BIO_data *)data;

		if (d->buffer == null || d->buffer->filled - d->consumed < to.free()) {
			fillBuffer(to.free(), data);
		}

		Nat copy = min(to.free(), Nat(d->buffer->filled) - d->consumed);
		memcpy(to.dataPtr() + to.filled(), d->buffer->v + d->consumed, copy);
		to.filled(to.filled() + copy);
	}

	void OpenSSLSession::fillBuffer(Nat bytes, void *data) {
		BIO_data *d = (BIO_data *)data;
		Engine &e = d->input->engine();

		if (d->buffer == null) {
			d->buffer = runtime::allocArray<byte>(e, &byteArrayType, bytes);
			d->consumed = 0;
		} else if (d->buffer->count < bytes) {
			GcArray<byte> *b = runtime::allocArray<byte>(e, &byteArrayType, bytes);
			memcpy(b->v, d->buffer->v + d->consumed, d->buffer->filled - d->consumed);
			b->filled = d->buffer->filled - d->consumed;
			d->consumed = 0;
			d->buffer = b;
		} else {
			memmove(d->buffer->v, d->buffer->v + d->consumed, d->buffer->filled - d->consumed);
			d->buffer->filled -= d->consumed;
			d->consumed = 0;
		}

		// Now, we have enough free space!
		// Note: "consumed" is zero by now.
		if (bytes > d->buffer->filled) {
			Nat read = readIntoBuffer(d->buffer->v + d->buffer->filled, bytes - d->buffer->filled, data);
			d->buffer->filled += read;
		}
	}

	Nat OpenSSLSession::readIntoBuffer(void *buffer, Nat bytes, void *gcData) {
		int result = BIO_read(connection, buffer, bytes);
		if (result > 0) {
			// All is well!
			return Nat(result);
		} else if (result == 0) {
			// Either eof or a timeout when reading from the underlying stream.
			SSL *ssl = null;
			BIO_get_ssl(connection, &ssl);
			if (ssl && SSL_get_shutdown(ssl) == SSL_RECEIVED_SHUTDOWN) {
				// If we got a shutdown, OpenSSL will not (necessarily) have read far enough in the
				// stream to cause it to realize that it is at the end of the stream, so we can not
				// look at the stream for that. If we got a shutdown, we won't receive any more data
				// anyway, so set eof.
				eof = true;
			} else {
				// If we did not get a shutdown, then OpenSSL has read from the stream, so we can
				// ask the underlying stream if it is at eof or not.
				BIO_data *d = (BIO_data *)gcData;
				eof = !d->input->more();
			}
			return Nat(0);
		} else {
			// Error.
			checkError();
			return Nat(0);
		}
	}

	Nat OpenSSLSession::write(const Buffer &from, Nat offset, void *) {
		os::Lock::L z(lock);

		int r = BIO_write(connection, from.dataPtr() + offset, from.filled() - offset);
		if (r >= 0)
			return Nat(r);
		else
			return 0;
	}

	Bool OpenSSLSession::flush(void *) {
		os::Lock::L z(lock);

		BIO_flush(connection);

		return true;
	}

	void OpenSSLSession::shutdown(void *gcData) {
		os::Lock::L z(lock);

		SSL *ssl = null;
		BIO_get_ssl(connection, &ssl);
		SSL_shutdown(ssl);

		// Note: We might get more data from the remote peer. This only shuts down our end essentially.
	}

	void OpenSSLSession::close(void *gcData) {
		os::Lock::L z(lock);

		// TODO: We could do this through the BIO interface.
		BIO_data *data = (BIO_data *)gcData;
		data->input->close();
		data->output->close();
	}


	/**
	 * Client session.
	 */

	OpenSSLClientSession::OpenSSLClientSession(OpenSSLContext *c) : OpenSSLSession(c) {}

	void *OpenSSLClientSession::connect(IStream *input, OStream *output, Str *host) {
		os::Lock::L z(lock);

		BIO_data *data = allocData(input, output);
		BIO *io = BIO_new_storm(data);
		BIO *sslBio = BIO_new_ssl(context->context, 1); // 1 means "client".
		// According to what OpenSSL is doing, we don't need to free "io" manually. The docs are a
		// bit unclear about that though (at least the "BIO_push" manpage).
		connection = BIO_push(sslBio, io);

		SSL *ssl = null;
		BIO_get_ssl(connection, &ssl);

		const char *utf8Host = host->utf8_str();

		if (context->checkHostname) {
			X509_VERIFY_PARAM *param = SSL_get0_param(ssl);
			X509_VERIFY_PARAM_set_hostflags(param, X509_CHECK_FLAG_NO_PARTIAL_WILDCARDS);
			X509_VERIFY_PARAM_set1_host(param, utf8Host, 0);
		}

		SSL_set_tlsext_host_name(ssl, utf8Host);
		checkError();

		// Do the handshake!
		if (BIO_do_handshake(connection) != 1) {
			checkError();
		}

		X509 *cert = SSL_get_peer_certificate(ssl);
		if (!cert)
			throw new (input) SSLError(S("The remote host did not present a certificate!"));
		X509_free(cert);

		long certOk = SSL_get_verify_result(ssl);
		if (certOk != X509_V_OK) {
			// TODO: We might want to get more descriptive errors here.
			throw new (input) SSLError(TO_S(input, S("Failed to verify the remote peer: ") << certError(certOk)));
		}

		return data;
	}


	/**
	 * Server session.
	 */

	OpenSSLServerSession::OpenSSLServerSession(OpenSSLContext *c) : OpenSSLSession(c) {}

	void *OpenSSLServerSession::connect(IStream *input, OStream *output, Str *host) {
		os::Lock::L z(lock);

		BIO_data *data = allocData(input, output);
		BIO *io = BIO_new_storm(data);
		BIO *sslBio = BIO_new_ssl(context->context, 0); // 0 means "server".
		// According to what OpenSSL is doing, we don't need to free "io" manually. The docs are a
		// bit unclear about that though (at least the "BIO_push" manpage).
		connection = BIO_push(sslBio, io);

		checkError();

		// Do the handshake!
		if (BIO_do_handshake(connection) != 1) {
			checkError();
		}

		return data;
	}

}

#endif