File: net-client.c

package info (click to toggle)
balsa 2.6.5-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 23,576 kB
  • sloc: ansic: 99,871; xml: 4,934; makefile: 769; sh: 185; awk: 60; python: 34
file content (705 lines) | stat: -rw-r--r-- 22,593 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
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
/* NetClient - simple line-based network client library
 *
 * Copyright (C) Albrecht Dreß <mailto:albrecht.dress@arcor.de> 2017 - 2020
 *
 * This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License along with this library. If not, see
 * <https://www.gnu.org/licenses/>.
 */

#include <string.h>
#include <stdio.h>
#include <glib/gi18n.h>
#include <gnutls/x509.h>
#include "net-client-utils.h"
#include "net-client.h"


/*
 * Stacking of the streams:
 * Input channel:
 *   GSocketClient *sock
 *      GSocketConnection *plain_conn
 *         GIOStream *tls_conn -- optional
 *            GInputStream *comp_istream -- optional
 *               GDataInputStream *istream
 *
 * Output channel:
 *   GSocketClient *sock
 *      GSocketConnection *plain_conn
 *         GIOStream *tls_conn -- optional
 *            GOutputStream *ostream -- optionally compressed
 */
typedef struct _NetClientPrivate NetClientPrivate;

struct _NetClientPrivate {
	gchar *host_and_port;
	guint16 default_port;
	gsize max_line_len;

	GSocketClient *sock;
	GSocketConnectable *remote_address;
	GSocketConnection *plain_conn;
	GIOStream *tls_conn;
	GDataInputStream *istream;
	GOutputStream *ostream;
	GTlsCertificate *certificate;

	GZlibCompressor *comp;
	GZlibDecompressor *decomp;
	GInputStream *comp_istream;
};


static guint signals[3];


G_DEFINE_TYPE_WITH_PRIVATE(NetClient, net_client, G_TYPE_OBJECT)


static void net_client_finalise(GObject *object);
static gboolean cert_accept_cb(GTlsConnection *conn, GTlsCertificate *peer_cert, GTlsCertificateFlags errors, gpointer user_data);


NetClient *
net_client_new(const gchar *host_and_port, guint16 default_port, gsize max_line_len)
{
	NetClient *client;
	NetClientPrivate *priv;

	g_return_val_if_fail(host_and_port != NULL, NULL);

	client = NET_CLIENT(g_object_new(NET_CLIENT_TYPE, NULL));
	/*lint -e{9079}		(MISRA C:2012 Rule 11.5) intended use of this function */
	priv = net_client_get_instance_private(client);

	if (priv->sock == NULL) {
		g_object_unref(client);
		client = NULL;
	} else {
		priv->host_and_port = g_strdup(host_and_port);
		priv->default_port = default_port;
		priv->max_line_len = max_line_len;
	}

	return client;
}


gboolean
net_client_configure(NetClient *client, const gchar *host_and_port, guint16 default_port, gsize max_line_len, GError **error)
{
	/*lint -e{9079}		(MISRA C:2012 Rule 11.5) intended use of this function */
	NetClientPrivate *priv = net_client_get_instance_private(client);
	gboolean result;

	g_return_val_if_fail(NET_IS_CLIENT(client) && (host_and_port != NULL), FALSE);

	if (priv->plain_conn != NULL) {
		g_set_error(error, NET_CLIENT_ERROR_QUARK, (gint) NET_CLIENT_ERROR_CONNECTED, _("network client is already connected"));
		result = FALSE;
	} else {
		g_free(priv->host_and_port);
		priv->host_and_port = g_strdup(host_and_port);
		priv->default_port = default_port;
		priv->max_line_len = max_line_len;
		result = TRUE;
	}
	return result;
}


const gchar *
net_client_get_host(NetClient *client)
{
	const gchar *result;

	if (NET_IS_CLIENT(client)) {
		const NetClientPrivate *priv;

		/*lint -e{9079}		(MISRA C:2012 Rule 11.5) intended use of this function */
		priv = net_client_get_instance_private(client);
		result = priv->host_and_port;
	} else {
		result = NULL;
	}
	return result;
}


gboolean
net_client_connect(NetClient *client, GError **error)
{
	gboolean result = FALSE;
	/*lint -e{9079}		(MISRA C:2012 Rule 11.5) intended use of this function */
	NetClientPrivate *priv = net_client_get_instance_private(client);

	g_return_val_if_fail(NET_IS_CLIENT(client), FALSE);

	if (priv->plain_conn != NULL) {
		g_set_error(error, NET_CLIENT_ERROR_QUARK, (gint) NET_CLIENT_ERROR_CONNECTED, _("network client is already connected"));
	} else {
		priv->remote_address = g_network_address_parse(priv->host_and_port, priv->default_port, error);
		if (priv->remote_address != NULL) {
			priv->plain_conn = g_socket_client_connect(priv->sock, priv->remote_address, NULL, error);
			if (priv->plain_conn != NULL) {
				g_debug("connected to %s", priv->host_and_port);
				priv->istream = g_data_input_stream_new(g_io_stream_get_input_stream(G_IO_STREAM(priv->plain_conn)));
				g_data_input_stream_set_newline_type(priv->istream, G_DATA_STREAM_NEWLINE_TYPE_CR_LF);
				priv->ostream = g_io_stream_get_output_stream(G_IO_STREAM(priv->plain_conn));
				result = TRUE;
			} else {
				g_object_unref(priv->remote_address);
				priv->remote_address = NULL;
			}
		}
	}

	return result;
}


void
net_client_shutdown(NetClient *client)
{
	if (NET_IS_CLIENT(client)) {
		NetClientPrivate *priv;

		/*lint -e{9079}		(MISRA C:2012 Rule 11.5) intended use of this function */
		priv = net_client_get_instance_private(client);

		/* Note: we must unref the GDataInputStream, but the GOutputStream only if compression is active! */
		if (priv->comp != NULL) {
			/* Note: for some strange reason, GIO decides to send a 0x03 0x00 sequence when closing a compressed connection, before
			 * sending the usual FIN, ACK TCP reply packet.  As the remote server does not expect the former (the connection has
			 * already been closed on its side), it replies with with a RST TCP packet.  Unref'ing client->priv->ostream and
			 * client->priv->comp /after/ all other components of the connection fixes the issue for unencrypted connections, but
			 * throws a critical error for TLS.  Observed with gio 2.48.2 and 2.50.3, no idea how it can be fixed.
			 * See also https://bugzilla.gnome.org/show_bug.cgi?id=795985. */
			if (priv->ostream != NULL) {
				g_object_unref(priv->ostream);
			}
			g_object_unref(priv->comp);
		}
		if (priv->decomp != NULL) {
			g_object_unref(priv->decomp);
			priv->decomp = NULL;
		}
		if (priv->comp_istream!= NULL) {
			g_object_unref(priv->comp_istream);
			priv->comp_istream = NULL;
		}
		if (priv->istream != NULL) {
			g_object_unref(priv->istream);
			priv->istream = NULL;
		}
		if (priv->tls_conn != NULL) {
			g_object_unref(priv->tls_conn);
			priv->tls_conn = NULL;
		}
		if (priv->plain_conn != NULL) {
			g_object_unref(priv->plain_conn);
			priv->plain_conn = NULL;
		}
		if (priv->remote_address != NULL) {
			g_object_unref(priv->remote_address);
			priv->remote_address = NULL;
		}
	}
}


gboolean
net_client_is_connected(NetClient *client)
{
	gboolean result;

	if (NET_IS_CLIENT(client)) {
		const NetClientPrivate *priv;

		/*lint -e{9079}		(MISRA C:2012 Rule 11.5) intended use of this function */
		priv = net_client_get_instance_private(client);
		result = (priv->plain_conn != NULL);
	} else {
		result = FALSE;
	}

	return result;
}


gboolean
net_client_is_encrypted(NetClient *client)
{
	gboolean result;

	if (net_client_is_connected(client)) {
		const NetClientPrivate *priv;

		/*lint -e{9079}		(MISRA C:2012 Rule 11.5) intended use of this function */
		priv = net_client_get_instance_private(client);
		result = (priv->tls_conn != NULL);
	} else {
		result = FALSE;
	}

	return result;
}


gboolean
net_client_read_line(NetClient *client, gchar **recv_line, GError **error)
{
	/*lint -e{9079}		(MISRA C:2012 Rule 11.5) intended use of this function */
	const NetClientPrivate *priv = net_client_get_instance_private(client);
	gboolean result = FALSE;

	g_return_val_if_fail(NET_IS_CLIENT(client), FALSE);

	if (priv->istream == NULL) {
		g_set_error(error, NET_CLIENT_ERROR_QUARK, (gint) NET_CLIENT_ERROR_NOT_CONNECTED, _("network client is not connected"));
	} else {
		gchar *line_buf;
		gsize length;
		GError *read_err = NULL;

		line_buf = g_data_input_stream_read_line(priv->istream, &length, NULL, &read_err);
		if (line_buf != NULL) {
			/* check that the protocol-specific maximum line length is not exceeded */
			if ((priv->max_line_len > 0U) && (length > priv->max_line_len)) {
				g_set_error(error, NET_CLIENT_ERROR_QUARK, (gint) NET_CLIENT_ERROR_LINE_TOO_LONG,
					_("reply length %lu exceeds the maximum allowed length %lu"),
					(unsigned long) length, (unsigned long) priv->max_line_len);
				g_free(line_buf);
			} else {
				g_debug("R '%s'", line_buf);
				result = TRUE;
				if (recv_line != NULL) {
					*recv_line = line_buf;
				} else {
					g_free(line_buf);
				}
			}
		} else {
			if (read_err != NULL) {
				g_propagate_error(error, read_err);
			} else {
				g_set_error(error, NET_CLIENT_ERROR_QUARK, (gint) NET_CLIENT_ERROR_CONNECTION_LOST, _("connection lost"));
			}
		}
	}

	return result;
}


gboolean
net_client_write_buffer(NetClient *client, const gchar *buffer, gsize count, GError **error)
{
	/*lint -e{9079}		(MISRA C:2012 Rule 11.5) intended use of this function */
	const NetClientPrivate *priv = net_client_get_instance_private(client);
	gboolean result;

	g_return_val_if_fail(NET_IS_CLIENT(client) && (buffer != NULL) && (count > 0UL), FALSE);

	if (priv->ostream == NULL) {
		g_set_error(error, NET_CLIENT_ERROR_QUARK, (gint) NET_CLIENT_ERROR_NOT_CONNECTED, _("network client is not connected"));
		result = FALSE;
	} else {
		gsize bytes_written;

		if ((count >= 2U) && (buffer[count - 1U] == '\n')) {
			g_debug("W '%.*s'", (int) count - 2, buffer);
		} else {
			g_debug("W '%.*s'", (int) count, buffer);
		}
		result = g_output_stream_write_all(priv->ostream, buffer, count, &bytes_written, NULL, error);
		if (result) {
			result = g_output_stream_flush(priv->ostream, NULL, error);
		}
	}

	return result;
}


gboolean
net_client_vwrite_line(NetClient *client, const gchar *format, va_list args, GError **error)
{
	/*lint -e{9079}		(MISRA C:2012 Rule 11.5) intended use of this function */
	const NetClientPrivate *priv = net_client_get_instance_private(client);
	gboolean result;
	GString *buffer;

	g_return_val_if_fail(NET_IS_CLIENT(client) && (format != NULL), FALSE);

	buffer = g_string_new(NULL);
	g_string_vprintf(buffer, format, args);
	if ((priv->max_line_len > 0U) && (buffer->len > priv->max_line_len)) {
		g_set_error(error, NET_CLIENT_ERROR_QUARK, (gint) NET_CLIENT_ERROR_LINE_TOO_LONG, _("line too long"));
		result = FALSE;
	} else {
		buffer = g_string_append(buffer, "\r\n");
		result = net_client_write_buffer(client, buffer->str, buffer->len, error);
	}
	(void) g_string_free(buffer, TRUE);

	return result;
}


gboolean
net_client_write_line(NetClient *client, const gchar *format, GError **error, ...)
{
	va_list args;
	gboolean result;

	va_start(args, error);
	result = net_client_vwrite_line(client, format, args, error);
	va_end(args);

	return result;
}


gboolean
net_client_execute(NetClient *client, gchar **response, const gchar *request_fmt, GError **error, ...)
{
	va_list args;
	gboolean result;

	va_start(args, error);
	result = net_client_vwrite_line(client, request_fmt, args, error);
	va_end(args);
	if (result) {
		result = net_client_read_line(client, response, error);
	}

	return result;
}


/* Note: I have no idea how I can load a PEM with an encrypted key into a GTlsCertificate using g_tls_certificate_new_from_file()
 * or g_tls_certificate_new_from_pem(), as this will always fail with a GnuTLS error "ASN1 parser: Error in DER parsing".  There
 * /might/ be a solution with GTlsInteraction and GTlsPassword, though.  Please enlighten me if you know more...
 *
 * This function uses "raw" GnuTLS calls and will emit the cert-pass signal if necessary.
 *
 * See also <https://mail.gnome.org/archives/gtk-list/2016-May/msg00027.html>.
 */
gboolean
net_client_set_cert_from_pem(NetClient *client, const gchar *pem_data, GError **error)
{
	/*lint -e{9079}		(MISRA C:2012 Rule 11.5) intended use of this function */
	NetClientPrivate *priv = net_client_get_instance_private(client);
	gboolean result = FALSE;
	gnutls_x509_crt_t cert;
	int res;

	g_return_val_if_fail(NET_IS_CLIENT(client) && (pem_data != NULL), FALSE);

	/* always free any existing certificate */
	if (priv->certificate != NULL) {
		g_object_unref(priv->certificate);
		priv->certificate = NULL;
	}

	/* load the certificate */
	res = gnutls_x509_crt_init(&cert);
	if (res != GNUTLS_E_SUCCESS) {
		g_set_error(error, NET_CLIENT_ERROR_QUARK, (gint) NET_CLIENT_ERROR_GNUTLS, _("error initializing certificate: %s"),
			gnutls_strerror(res));
	} else {
		gnutls_datum_t data;

		/*lint -e9005	cast'ing away the const is safe as gnutls treats data as const */
		data.data = (unsigned char *) pem_data;
		data.size = strlen(pem_data);
		res = gnutls_x509_crt_import(cert, &data, GNUTLS_X509_FMT_PEM);
		if (res != GNUTLS_E_SUCCESS) {
			g_set_error(error, NET_CLIENT_ERROR_QUARK, (gint) NET_CLIENT_ERROR_GNUTLS, _("error loading certificate: %s"),
				gnutls_strerror(res));
		} else {
			gnutls_x509_privkey_t key;

			/* try to load the key, emit cert-pass signal if gnutls says the key is encrypted */
			res = gnutls_x509_privkey_init(&key);
			if (res != GNUTLS_E_SUCCESS) {
				g_set_error(error, NET_CLIENT_ERROR_QUARK, (gint) NET_CLIENT_ERROR_GNUTLS, _("error initializing key: %s"),
					gnutls_strerror(res));
			} else {
				res = gnutls_x509_privkey_import2(key, &data, GNUTLS_X509_FMT_PEM, NULL, 0);
				if (res == GNUTLS_E_DECRYPTION_FAILED) {
					size_t dn_size;
					gchar *dn_str;

					/* determine dn string buffer size requirements */
					dn_size = 0U;
					(void) gnutls_x509_crt_get_dn(cert, NULL, &dn_size);
					dn_str = g_malloc0(dn_size + 1U);		/*lint !e9079 (MISRA C:2012 Rule 11.5) */

					res = gnutls_x509_crt_get_dn(cert, dn_str, &dn_size);
					if (res == GNUTLS_E_SUCCESS) {
						gchar *key_pass = NULL;

						if (!g_utf8_validate(dn_str, -1, NULL)) {
							gchar *buf;

							buf = g_locale_to_utf8(dn_str, -1, NULL, NULL, NULL);
							g_free(dn_str);
							dn_str = buf;
						}
						g_debug("emit 'cert-pass' signal for client %p", client);
						g_signal_emit(client, signals[2], 0, dn_str, &key_pass);
						if (key_pass != NULL) {
							res = gnutls_x509_privkey_import2(key, &data, GNUTLS_X509_FMT_PEM, key_pass, 0);
							net_client_free_authstr(key_pass);
						}
					}
					g_free(dn_str);
				}

				/* on success, set the certificate using the unencrypted key */
				if (res == GNUTLS_E_SUCCESS) {
					gchar *pem_buf;
					size_t key_buf_size = 0;
					size_t crt_buf_size = 0;

					/* determine buffer size requirements */
					(void) gnutls_x509_privkey_export(key, GNUTLS_X509_FMT_PEM, NULL, &key_buf_size);
					(void) gnutls_x509_crt_export(cert, GNUTLS_X509_FMT_PEM, NULL, &crt_buf_size);
					pem_buf = g_malloc(key_buf_size + crt_buf_size);		/*lint !e9079 (MISRA C:2012 Rule 11.5) */
					res = gnutls_x509_privkey_export(key, GNUTLS_X509_FMT_PEM, pem_buf, &key_buf_size);
					if (res == GNUTLS_E_SUCCESS) {
						res = gnutls_x509_crt_export(cert, GNUTLS_X509_FMT_PEM, &pem_buf[key_buf_size], &crt_buf_size);
					}

					if (res == GNUTLS_E_SUCCESS) {
						priv->certificate = g_tls_certificate_new_from_pem(pem_buf, -1, error);
						if (priv->certificate != NULL) {
							result = TRUE;
						}
					}
					g_free(pem_buf);
				}
				gnutls_x509_privkey_deinit(key);

				if (res != GNUTLS_E_SUCCESS) {
					g_set_error(error, NET_CLIENT_ERROR_QUARK, (gint) NET_CLIENT_ERROR_CERT_KEY_PASS, _("error loading key: %s"),
						gnutls_strerror(res));
				}
			}
		}
		gnutls_x509_crt_deinit(cert);
	}

	return result;
}


gboolean
net_client_set_cert_from_file(NetClient *client, const gchar *pem_path, GError **error)
{
	gboolean result;
	GFile *pem_file;
	gchar *pem_buf;

	g_return_val_if_fail(pem_path != NULL, FALSE);

	pem_file = g_file_new_for_path(pem_path);
	result = g_file_load_contents(pem_file, NULL, &pem_buf, NULL, NULL, error);
	if (result) {
		result = net_client_set_cert_from_pem(client, pem_buf, error);
		g_free(pem_buf);
	}
	g_object_unref(pem_file);
	return result;
}


gboolean
net_client_start_tls(NetClient *client, GError **error)
{
	/*lint -e{9079}		(MISRA C:2012 Rule 11.5) intended use of this function */
	NetClientPrivate *priv = net_client_get_instance_private(client);
	gboolean result = FALSE;

	g_return_val_if_fail(NET_IS_CLIENT(client), FALSE);

	if (priv->plain_conn == NULL) {
		g_set_error(error, NET_CLIENT_ERROR_QUARK, (gint) NET_CLIENT_ERROR_NOT_CONNECTED, _("not connected"));
	} else if (priv->tls_conn != NULL) {
		g_set_error(error, NET_CLIENT_ERROR_QUARK, (gint) NET_CLIENT_ERROR_TLS_ACTIVE, _("connection is already encrypted"));
	} else {
		priv->tls_conn = g_tls_client_connection_new(G_IO_STREAM(priv->plain_conn), priv->remote_address, error);
		if (priv->tls_conn != NULL) {
			if (priv->certificate != NULL) {
				g_tls_connection_set_certificate(G_TLS_CONNECTION(priv->tls_conn), priv->certificate);
			}
			(void) g_signal_connect(priv->tls_conn, "accept-certificate", G_CALLBACK(cert_accept_cb), client);
			result = g_tls_connection_handshake(G_TLS_CONNECTION(priv->tls_conn), NULL, error);
			if (result) {
				g_filter_input_stream_set_close_base_stream(G_FILTER_INPUT_STREAM(priv->istream), FALSE);
				g_object_unref(priv->istream);		/* unref the plain connection's stream */
				priv->istream = g_data_input_stream_new(g_io_stream_get_input_stream(G_IO_STREAM(priv->tls_conn)));
				g_data_input_stream_set_newline_type(priv->istream, G_DATA_STREAM_NEWLINE_TYPE_CR_LF);
				priv->ostream = g_io_stream_get_output_stream(G_IO_STREAM(priv->tls_conn));
				g_debug("connection is encrypted");
			} else {
				g_object_unref(priv->tls_conn);
				priv->tls_conn = NULL;
			}
		}
	}

	return result;
}


gboolean
net_client_start_compression(NetClient *client, GError **error)
{
	/*lint -e{9079}		(MISRA C:2012 Rule 11.5) intended use of this function */
	NetClientPrivate *priv = net_client_get_instance_private(client);
	gboolean result = FALSE;

	g_return_val_if_fail(NET_IS_CLIENT(client), FALSE);

	if (priv->plain_conn == NULL) {
		g_set_error(error, NET_CLIENT_ERROR_QUARK, (gint) NET_CLIENT_ERROR_NOT_CONNECTED, _("not connected"));
	} else if (priv->comp != NULL) {
		g_set_error(error, NET_CLIENT_ERROR_QUARK, (gint) NET_CLIENT_ERROR_COMP_ACTIVE, _("connection is already compressed"));
	} else {
		priv->comp = g_zlib_compressor_new(G_ZLIB_COMPRESSOR_FORMAT_RAW, -1);
		priv->decomp = g_zlib_decompressor_new(G_ZLIB_COMPRESSOR_FORMAT_RAW);

		g_filter_input_stream_set_close_base_stream(G_FILTER_INPUT_STREAM(priv->istream), FALSE);
		g_object_unref(priv->istream);

		if (priv->tls_conn != NULL) {
			priv->comp_istream =
				g_converter_input_stream_new(g_io_stream_get_input_stream(G_IO_STREAM(priv->tls_conn)),
					G_CONVERTER(priv->decomp));
		} else {
			priv->comp_istream =
				g_converter_input_stream_new(g_io_stream_get_input_stream(G_IO_STREAM(priv->plain_conn)),
					G_CONVERTER(priv->decomp));
		}
		priv->istream = g_data_input_stream_new(priv->comp_istream);
		g_data_input_stream_set_newline_type(priv->istream, G_DATA_STREAM_NEWLINE_TYPE_CR_LF);

		priv->ostream = g_converter_output_stream_new(priv->ostream, G_CONVERTER(priv->comp));
		result = TRUE;
		g_debug("connection is compressed");
	}

	return result;
}


gboolean
net_client_set_timeout(NetClient *client, guint timeout_secs)
{
	/*lint -e{9079}		(MISRA C:2012 Rule 11.5) intended use of this function */
	const NetClientPrivate *priv = net_client_get_instance_private(client);

	g_return_val_if_fail(NET_IS_CLIENT(client), FALSE);

	g_socket_client_set_timeout(priv->sock, timeout_secs);
	return TRUE;
}


GSocket *
net_client_get_socket(NetClient *client)
{
	/*lint -e{9079}		(MISRA C:2012 Rule 11.5) intended use of this function */
	const NetClientPrivate *priv = net_client_get_instance_private(client);

	g_return_val_if_fail(NET_IS_CLIENT(client) && (priv->plain_conn != NULL), NULL);

	return g_socket_connection_get_socket(priv->plain_conn);
}


gboolean
net_client_can_read(NetClient *client)
{
	/*lint -e{9079}		(MISRA C:2012 Rule 11.5) intended use of this function */
	const NetClientPrivate *priv = net_client_get_instance_private(client);

	g_return_val_if_fail(NET_IS_CLIENT(client) && (priv->plain_conn != NULL) && (priv->istream != NULL), FALSE);

	return (g_socket_condition_check(g_socket_connection_get_socket(priv->plain_conn), G_IO_IN) != 0) ||
		(g_buffered_input_stream_get_available(G_BUFFERED_INPUT_STREAM(priv->istream)) > 0U);
}


/* == local functions =========================================================================================================== */

static void
net_client_class_init(NetClientClass *klass)
{
	GObjectClass *gobject_class = G_OBJECT_CLASS(klass);

	gobject_class->finalize = net_client_finalise;
	signals[0] = g_signal_new("cert-check", NET_CLIENT_TYPE, G_SIGNAL_RUN_LAST, 0U, NULL, NULL, NULL, G_TYPE_BOOLEAN, 2U,
		G_TYPE_TLS_CERTIFICATE, G_TYPE_TLS_CERTIFICATE_FLAGS);
	signals[1] = g_signal_new("auth", NET_CLIENT_TYPE, G_SIGNAL_RUN_LAST, 0U, NULL, NULL, NULL, G_TYPE_STRV, 1U, G_TYPE_INT);
	signals[2] = g_signal_new("cert-pass", NET_CLIENT_TYPE, G_SIGNAL_RUN_LAST, 0U, NULL, NULL, NULL, G_TYPE_STRING, 1U,
		G_TYPE_STRING);
}


static void
net_client_init(NetClient *self)
{
	/*lint -e{9079}		(MISRA C:2012 Rule 11.5) intended use of this function */
	NetClientPrivate *priv = net_client_get_instance_private(self);

	priv->sock = g_socket_client_new();
	if (priv->sock != NULL) {
		g_socket_client_set_timeout(priv->sock, 180U);
	}
}


static void
net_client_finalise(GObject *object)
{
	NetClient *client = NET_CLIENT(object);
	/*lint -e{9079}		(MISRA C:2012 Rule 11.5) intended use of this function */
	NetClientPrivate *priv = net_client_get_instance_private(client);
	const GObjectClass *parent_class = G_OBJECT_CLASS(net_client_parent_class);

	net_client_shutdown(client);
	if (priv->sock != NULL) {
		g_object_unref(priv->sock);
		priv->sock = NULL;
	}
	if (priv->certificate != NULL) {
		g_object_unref(priv->certificate);
		priv->certificate = NULL;
	}
	g_debug("finalised connection to %s", priv->host_and_port);
	g_free(priv->host_and_port);
	(*parent_class->finalize)(object);
}


/*lint -e{715,818} */
static gboolean
cert_accept_cb(G_GNUC_UNUSED GTlsConnection *conn, GTlsCertificate *peer_cert, GTlsCertificateFlags errors, gpointer user_data)
{
	NetClient *client = NET_CLIENT(user_data);
	gboolean result;

	g_debug("emit 'cert-check' signal for client %p", client);
	g_signal_emit(client, signals[0], 0, peer_cert, errors, &result);
	return result;
}