-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathPermessageDeflate.hpp
878 lines (778 loc) · 29.7 KB
/
PermessageDeflate.hpp
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
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
#pragma once
#include <expected>
#include <iostream>
#include <memory>
#include <sstream>
#include <format>
#include <charconv>
#include <cstdint>
#include <span>
#include <map>
#if WS_CLIENT_USE_ZLIB_NG > 0
#include <zlib-ng.h>
#define WS_CLIENT_USE_ZLIB_NG_BOOL true
#define z_stream zng_stream
#define inflateInit2(_strm, _windowBits) zng_inflateInit2(_strm, _windowBits)
#define inflate(_strm, __flush) zng_inflate(_strm, __flush)
#define inflateEnd(_strm) zng_inflateEnd(_strm)
#define inflateReset(_strm) zng_inflateReset(_strm)
#define deflateInit2(_strm, _level, _method, _windowBits, _memLevel, _strategy) \
zng_deflateInit2(_strm, _level, _method, _windowBits, _memLevel, _strategy)
#define deflateEnd(_strm) zng_deflateEnd(_strm)
#define deflateReset(_strm) zng_deflateReset(_strm)
#define deflate(_strm, _flush) zng_deflate(_strm, _flush)
#else
#define WS_CLIENT_USE_ZLIB_NG_BOOL false
#include <zlib.h>
#endif
#include "ws_client/errors.hpp"
#include "ws_client/utils/string.hpp"
#include "ws_client/log.hpp"
#include "ws_client/HttpHeader.hpp"
#include "ws_client/Frame.hpp"
#include "ws_client/Buffer.hpp"
namespace ws_client
{
using std::string;
using std::byte;
using std::span;
using std::map;
/**
* Permessage-deflate extension, as defined in RFC 7692.
*
* https://datatracker.ietf.org/doc/rfc7692/
*/
template <typename TLogger>
struct PermessageDeflate
{
static constexpr bool zlib_ng = WS_CLIENT_USE_ZLIB_NG_BOOL;
static constexpr uint8_t default_client_max_window_bits = 15;
static constexpr uint8_t default_server_max_window_bits = 15;
TLogger* logger;
/**
* Maximum size of the server’s LZ77 sliding window in bits, between 8 and 15.
* 0 = not set.
*
* Default: 15
*/
uint8_t server_max_window_bits{default_server_max_window_bits};
/**
* Maximum size of the client’s LZ77 sliding window in bits, between 8 and 15.
* 0 = not set.
*
* Default: 15
*/
uint8_t client_max_window_bits{default_client_max_window_bits};
/**
* If true, the server will not reuse LZ77 contexts, and will compress all messages
* independent of the previous message.
*
* Default: false
*/
bool server_no_context_takeover{false};
/**
* If true, the client will not reuse LZ77 contexts, and will compress all messages
* independent of the previous message.
*
* Default: false
*/
bool client_no_context_takeover{false};
/**
* Maximum allowed size of decompression buffer.
* Default: 100 KiB
*/
size_t decompress_buffer_size{100 * 1024};
/**
* Maximum allowed size of compression buffer.
*
* Default: 100 KiB
*/
size_t compress_buffer_size{100 * 1024};
/**
* Decompression (deflate) memory level.
* The trade-off is between memory usage and compression speed.
*
* Valid values: 1-9
* Default: 8
*/
int deflate_memory_level{8};
/**
* Compression (deflate) level.
* The trade-off is between compression speed and compression ratio.
*
* Valid values: 0-9
* Default: zlib library default (Z_DEFAULT_COMPRESSION), currently 6.
*/
int deflate_compression_level{Z_DEFAULT_COMPRESSION};
/**
* Process the HTTP response headers and adjust the configuration if needed.
* The server might not respond with the exact configuration requested, so we need to
* adjust the configuration accordingly.
*/
[[nodiscard]] expected<bool, WSError> negotiate(const HttpResponseHeader& response)
{
#if WS_CLIENT_LOG_COMPRESSION > 0
logger->template log<LogLevel::D, LogTopic::Compression>(
this->zlib_ng ? "Using zlib-ng compression library"
: "Using standard zlib compression library"
);
#endif
auto h_ext = response.fields.get_first("Sec-WebSocket-Extensions");
if (h_ext == std::nullopt)
{
#if WS_CLIENT_LOG_HANDSHAKE > 0
logger->template log<LogLevel::W, LogTopic::Handshake>(
"HTTP response without 'Sec-WebSocket-Extensions' header, disabling "
"permessage-deflate extension."
);
#endif
return false;
}
map<string, string> extensions = parse_WebSocketExtensions(*h_ext);
// verify permessage-deflate exists
if (extensions.find("permessage-deflate") == extensions.end())
{
#if WS_CLIENT_LOG_HANDSHAKE > 0
logger->template log<LogLevel::W, LogTopic::Handshake>(
"permessage-deflate extension not in 'Sec-WebSocket-Extensions' header, "
"disabling extension."
);
#endif
return false;
}
WS_TRY(res1, this->negotiate_server_no_context_takeover(extensions));
WS_TRY(res2, this->negotiate_client_no_context_takeover(extensions));
WS_TRY(res3, this->negotiate_server_max_window_bits(extensions));
WS_TRY(res4, this->negotiate_client_max_window_bits(extensions));
#if WS_CLIENT_LOG_HANDSHAKE > 0
if (logger->template is_enabled<LogLevel::D, LogTopic::Handshake>()) [[unlikely]]
{
logger->template log<LogLevel::D, LogTopic::Handshake>(std::format(
"Negotiated permessage-deflate parameters:\n"
" - server_max_window_bits: {}\n"
" - client_max_window_bits: {}\n"
" - server_no_context_takeover: {:d}\n"
" - client_no_context_takeover: {:d}",
this->server_max_window_bits,
this->client_max_window_bits,
this->server_no_context_takeover,
this->client_no_context_takeover
));
}
#endif
return true;
}
[[nodiscard]] expected<void, WSError> negotiate_server_no_context_takeover(
map<string, string>& extensions
)
{
// verify/adjust server_no_context_takeover
//
// Requested Response Result
// --------- -------- ------
// False False False
// False True True
// True False True -> adjust configured value!
// True True True
if (this->server_no_context_takeover)
{
if (extensions.find("server_no_context_takeover") == extensions.end())
{
this->server_no_context_takeover = false; // adjust configured value!
#if WS_CLIENT_LOG_HANDSHAKE > 0
if (logger->template is_enabled<LogLevel::D, LogTopic::Handshake>()) [[unlikely]]
{
logger->template log<LogLevel::D, LogTopic::Handshake>(std::format(
"server_no_context_takeover adjusted from {:d} to 0",
this->server_no_context_takeover
));
}
#endif
}
}
else if (extensions.find("server_no_context_takeover") != extensions.end())
{
#if WS_CLIENT_LOG_HANDSHAKE > 0
if (logger->template is_enabled<LogLevel::D, LogTopic::Handshake>()) [[unlikely]]
{
logger->template log<LogLevel::D, LogTopic::Handshake>(std::format(
"server_no_context_takeover adjusted from {:d} to 1",
this->server_no_context_takeover
));
}
#endif
this->server_no_context_takeover = true;
}
return {};
}
[[nodiscard]] expected<void, WSError> negotiate_client_no_context_takeover(
map<string, string>& extensions
)
{
// verify/adjust client_no_context_takeover
//
// Requested Response Result (client behavior)
// --------- -------- -----------------------
// False False Client may use context takeover
// False True Client may use context takeover
// True False Client must not use context takeover
// True True Client must not use context takeover
if (this->client_no_context_takeover)
{
// indepent of the response, the client must not use context takeover
}
else if (extensions.find("client_no_context_takeover") != extensions.end())
{
#if WS_CLIENT_LOG_HANDSHAKE > 0
if (logger->template is_enabled<LogLevel::D, LogTopic::Handshake>()) [[unlikely]]
{
logger->template log<LogLevel::D, LogTopic::Handshake>(std::format(
"client_no_context_takeover adjusted from {:d} to 1",
this->client_no_context_takeover
));
}
#endif
this->client_no_context_takeover = true;
}
return {};
}
[[nodiscard]] expected<void, WSError> negotiate_server_max_window_bits(
map<string, string>& extensions
)
{
// verify server_max_window_bits
//
// Requested Response Result
// --------- -------- ------
// None None None
// None [8,15] Use response value
// [8,15] None Use default value of 15
// [8,15] 8 ≤ M ≤ N Use response value if M ≤ N, otherwise ERROR!
if (this->server_max_window_bits > 0)
{
if (extensions.find("server_max_window_bits") == extensions.end())
{
#if WS_CLIENT_LOG_HANDSHAKE > 0
if (logger->template is_enabled<LogLevel::D, LogTopic::Handshake>()) [[unlikely]]
{
logger->template log<LogLevel::D, LogTopic::Handshake>(std::format(
"server_max_window_bits={} not acknowledged by server, use default value "
"{}",
this->server_max_window_bits,
default_server_max_window_bits
));
}
#endif
this->server_max_window_bits = default_server_max_window_bits;
}
else
{
WS_TRY(res, parse_window_bits(extensions["server_max_window_bits"]));
uint8_t res_value = *res;
if (res_value < 8 || res_value > 15)
{
return WS_ERROR(
protocol_error,
std::format(
"Invalid server_max_window_bits value received. Expected: 8-15, got: "
"{}",
res_value
),
close_code::not_set
);
}
if (res_value > this->server_max_window_bits)
{
return WS_ERROR(
protocol_error,
std::format(
"Received server_max_window_bits {} greater than requested value of {}",
res_value,
this->server_max_window_bits
),
close_code::not_set
);
}
if (this->server_max_window_bits != res_value)
{
#if WS_CLIENT_LOG_HANDSHAKE > 0
if (logger->template is_enabled<LogLevel::D, LogTopic::Handshake>())
{
logger->template log<LogLevel::D, LogTopic::Handshake>(std::format(
"server_max_window_bits adjusted from {} to {}",
this->server_max_window_bits,
res_value
));
}
#endif
this->server_max_window_bits = res_value;
}
}
}
else if (extensions.find("server_max_window_bits") != extensions.end())
{
WS_TRY(res, parse_window_bits(extensions["server_max_window_bits"]));
uint8_t res_value = *res;
if (res_value < 8 || res_value > 15)
{
return WS_ERROR(
protocol_error,
std::format(
"Invalid server_max_window_bits value received. Expected: 8-15, got: {}",
res_value
),
close_code::not_set
);
}
this->server_max_window_bits = res_value;
#if WS_CLIENT_LOG_HANDSHAKE > 0
if (logger->template is_enabled<LogLevel::D, LogTopic::Handshake>())
{
logger->template log<LogLevel::D, LogTopic::Handshake>(std::format(
"server_max_window_bits adjusted from {} to {}",
this->server_max_window_bits,
res_value
));
}
#endif
}
else
{
this->server_max_window_bits = default_server_max_window_bits;
#if WS_CLIENT_LOG_HANDSHAKE > 0
if (logger->template is_enabled<LogLevel::I, LogTopic::Handshake>())
{
logger->template log<LogLevel::I, LogTopic::Handshake>(std::format(
"Using default server_max_window_bits: {}", this->server_max_window_bits
));
}
#endif
}
return {};
}
[[nodiscard]] expected<void, WSError> negotiate_client_max_window_bits(
map<string, string>& extensions
)
{
// verify client_max_window_bits
//
// Requested Response Result
// --------- -------- ------
// None None None
// None [8,15] ERROR!
// [8,15] None Use default value of 15
// [8,15] 8 ≤ M ≤ N Use response value if M ≤ N, otherwise ERROR!
if (this->client_max_window_bits > 0)
{
if (extensions.find("client_max_window_bits") == extensions.end())
{
#if WS_CLIENT_LOG_HANDSHAKE > 0
if (logger->template is_enabled<LogLevel::D, LogTopic::Handshake>())
{
logger->template log<LogLevel::D, LogTopic::Handshake>(std::format(
"client_max_window_bits={} not acknowledged by server, use default value "
"{}",
this->client_max_window_bits,
default_client_max_window_bits
));
}
#endif
this->client_max_window_bits = default_client_max_window_bits;
}
else
{
WS_TRY(res, parse_window_bits(extensions["client_max_window_bits"]));
uint8_t res_value = *res;
if (res_value < 8 || res_value > 15)
{
return WS_ERROR(
protocol_error,
std::format(
"Invalid client_max_window_bits value received. Expected: 8-15, got: "
"{}",
res_value
),
close_code::not_set
);
}
if (res_value > this->client_max_window_bits)
{
return WS_ERROR(
protocol_error,
std::format(
"Received client_max_window_bits {} greater than requested value of {}",
res_value,
this->client_max_window_bits
),
close_code::not_set
);
}
if (this->client_max_window_bits != res_value)
{
#if WS_CLIENT_LOG_HANDSHAKE > 0
if (logger->template is_enabled<LogLevel::D, LogTopic::Handshake>())
{
logger->template log<LogLevel::D, LogTopic::Handshake>(std::format(
"client_max_window_bits adjusted from {} to {}",
this->client_max_window_bits,
res_value
));
}
#endif
this->client_max_window_bits = res_value;
}
}
}
else if (extensions.find("client_max_window_bits") != extensions.end())
{
string client_max_window_bits_str = extensions.find("client_max_window_bits")->second;
int client_max_window_bits_parsed;
auto const res = std::from_chars(
client_max_window_bits_str.data(),
client_max_window_bits_str.data() + client_max_window_bits_str.size(),
client_max_window_bits_parsed
);
if (res.ec != std::errc{})
{
return WS_ERROR(
protocol_error,
std::format(
"Failed to parse client_max_window_bits from server: {}",
client_max_window_bits_str
),
close_code::not_set
);
}
if (client_max_window_bits_parsed < 8 || client_max_window_bits_parsed > 15)
{
return WS_ERROR(
protocol_error,
std::format(
"Invalid client_max_window_bits value received. Expected: 8-15, got: {}",
client_max_window_bits_parsed
),
close_code::not_set
);
}
this->client_max_window_bits = static_cast<uint8_t>(client_max_window_bits_parsed);
}
else
{
this->client_max_window_bits = default_client_max_window_bits;
#if WS_CLIENT_LOG_HANDSHAKE > 0
if (logger->template is_enabled<LogLevel::I, LogTopic::Handshake>())
{
logger->template log<LogLevel::I, LogTopic::Handshake>(std::format(
"Using default client_max_window_bits: {}", this->client_max_window_bits
));
}
#endif
}
return {};
}
string get_SecWebSocketExtensions_value() const
{
string result = "permessage-deflate";
if (this->server_max_window_bits > 0)
{
result += "; server_max_window_bits=";
result += std::to_string(this->server_max_window_bits);
}
if (this->client_max_window_bits > 0)
{
result += "; client_max_window_bits=";
result += std::to_string(this->client_max_window_bits);
}
if (this->server_no_context_takeover)
result += "; server_no_context_takeover";
if (this->client_no_context_takeover)
result += "; client_no_context_takeover";
return result;
}
map<string, string> parse_WebSocketExtensions(const string& header)
{
map<string, string> extensions;
std::istringstream stream(header);
string extension;
while (std::getline(stream, extension, ';'))
{
extension.erase(
std::remove_if(extension.begin(), extension.end(), ::isspace), extension.end()
);
std::istringstream extStream(extension);
string key, value;
if (std::getline(std::getline(extStream, key, '='), value))
{
key.erase(std::remove_if(key.begin(), key.end(), ::isspace), key.end());
value.erase(std::remove_if(value.begin(), value.end(), ::isspace), value.end());
extensions[key] = value;
}
else
extensions[extension] = "";
}
return extensions;
}
[[nodiscard]] expected<uint8_t, WSError> parse_window_bits(const string bits_string) const
{
int result;
auto const res = std::from_chars(
bits_string.data(), bits_string.data() + bits_string.size(), result
);
if (res.ec != std::errc{})
{
return WS_ERROR(
protocol_error,
std::format(
"Invalid window bits value received. Expected: 8-15, got: {}", bits_string
),
close_code::not_set
);
}
return static_cast<uint8_t>(result);
}
};
template <typename TLogger>
class PermessageDeflateContext
{
private:
TLogger* logger_;
PermessageDeflate<TLogger> def_;
z_stream* istate_;
z_stream* ostate_;
std::unique_ptr<Buffer> decompress_buffer_;
std::unique_ptr<Buffer> compress_buffer_;
public:
explicit PermessageDeflateContext(
TLogger* logger, const PermessageDeflate<TLogger> permessage_deflate
) noexcept
: logger_(logger),
def_(std::move(permessage_deflate)),
istate_(nullptr),
ostate_(nullptr),
decompress_buffer_(nullptr),
compress_buffer_(nullptr)
{
}
~PermessageDeflateContext() noexcept
{
if (istate_ != nullptr)
{
inflateEnd(istate_);
deflateEnd(ostate_);
delete istate_;
delete ostate_;
}
}
// disable copy
PermessageDeflateContext(const PermessageDeflateContext&) = delete;
PermessageDeflateContext& operator=(PermessageDeflateContext const&) = delete;
// enable move
PermessageDeflateContext(PermessageDeflateContext&& other) noexcept
: logger_(other.logger_),
def_(std::move(other.def_)),
istate_(other.istate_),
ostate_(other.ostate_),
decompress_buffer_(std::move(other.decompress_buffer_)),
compress_buffer_(std::move(other.compress_buffer_))
{
other.istate_ = nullptr;
other.ostate_ = nullptr;
other.decompress_buffer_ = nullptr;
other.compress_buffer_ = nullptr;
}
PermessageDeflateContext& operator=(PermessageDeflateContext&& other) noexcept
{
if (this != &other)
{
// clean up current resources
if (istate_ != nullptr)
{
inflateEnd(istate_);
deflateEnd(ostate_);
delete istate_;
delete ostate_;
}
// move resources from other
logger_ = other.logger_;
def_ = std::move(other.def_);
istate_ = other.istate_;
ostate_ = other.ostate_;
decompress_buffer_ = std::move(other.decompress_buffer_);
compress_buffer_ = std::move(other.compress_buffer_);
// reset other's pointers
other.logger_ = nullptr;
other.istate_ = nullptr;
other.ostate_ = nullptr;
}
return *this;
}
Buffer& compress_buffer() noexcept
{
return *compress_buffer_;
}
Buffer& decompress_buffer() noexcept
{
return *decompress_buffer_;
}
/**
* Initialize the permessage-deflate context.
* This is called after the WebSocket handshake is completed
* by the client internally.
*/
[[nodiscard]] expected<void, WSError> init() noexcept
{
// create decompression buffer
size_t decom_init_size = 1024;
if (def_.decompress_buffer_size < decom_init_size)
decom_init_size = def_.decompress_buffer_size;
WS_TRY(decompress_buffer, Buffer::create(decom_init_size, def_.decompress_buffer_size));
decompress_buffer_ = std::make_unique<Buffer>(std::move(decompress_buffer.value()));
// create compression buffer
size_t comp_init_size = 1024;
if (def_.compress_buffer_size < comp_init_size)
comp_init_size = def_.compress_buffer_size;
WS_TRY(compress_buffer, Buffer::create(comp_init_size, def_.compress_buffer_size));
compress_buffer_ = std::make_unique<Buffer>(std::move(compress_buffer.value()));
// initialize zlib decompressor
istate_ = new z_stream();
istate_->zalloc = Z_NULL;
istate_->zfree = Z_NULL;
istate_->opaque = Z_NULL;
istate_->avail_in = 0;
istate_->next_in = Z_NULL;
auto ret = inflateInit2(istate_, -1 * def_.server_max_window_bits);
if (ret != Z_OK)
return make_error("inflateInit2", istate_->msg);
// initialize zlib compressor
ostate_ = new z_stream();
ostate_->zalloc = Z_NULL;
ostate_->zfree = Z_NULL;
ostate_->opaque = Z_NULL;
ostate_->avail_in = 0;
ostate_->next_in = Z_NULL;
ret = deflateInit2(
ostate_,
def_.deflate_compression_level,
Z_DEFLATED,
-1 * def_.client_max_window_bits,
def_.deflate_memory_level,
Z_DEFAULT_STRATEGY
);
if (ret != Z_OK)
return make_error("deflateInit2", ostate_->msg);
return {};
}
[[nodiscard]] expected<size_t, WSError> decompress(Buffer& output) noexcept
{
span<byte> input = decompress_buffer().data();
// set zlib input buffer to frame payload
istate_->next_in = reinterpret_cast<Bytef*>(input.data());
istate_->avail_in = static_cast<unsigned int>(input.size());
size_t buffer_pos = output.size();
size_t size = 0;
do
{
// extend output buffer if required.
// assumes average compression ratio of 5:1.
// if more than 5x the input size is required, the buffer will be extended again.
WS_TRY(alloc_res, output.append(std::max(64U, istate_->avail_in * 5)));
span<byte> avail = *alloc_res;
// set zlib output buffer
istate_->next_out = reinterpret_cast<Bytef*>(avail.data());
istate_->avail_out = static_cast<unsigned int>(avail.size());
// decompress using zlib inflate
int ret = inflate(istate_, Z_SYNC_FLUSH);
if (ret != Z_OK && ret != Z_STREAM_END && ret != Z_BUF_ERROR)
return make_error("inflate", istate_->msg);
size += avail.size() - istate_->avail_out;
} while (istate_->avail_out == 0);
#if WS_CLIENT_LOG_COMPRESSION > 0
if (logger_->template is_enabled<LogLevel::D, LogTopic::Compression>())
{
logger_->template log<LogLevel::D, LogTopic::Compression>(
std::format("compression ratio: {:.3f}", static_cast<double>(size) / input.size())
);
}
#endif
// resize output buffer
output.discard_end(output.size() - buffer_pos - size);
if (def_.server_no_context_takeover)
{
// reset inflate state (discard LZ77 sliding window, no context takeover)
if (Z_OK != inflateEnd(istate_))
return make_error("inflateEnd", istate_->msg);
if (Z_OK != inflateInit2(istate_, -1 * def_.server_max_window_bits))
return make_error("inflateInit2", istate_->msg);
}
else
{
// reset inflate state (preserve LZ77 sliding window)
if (Z_OK != inflateReset(istate_))
return make_error("inflateReset", istate_->msg);
}
return size;
}
[[nodiscard]] expected<span<byte>, WSError> compress(span<byte> input) noexcept
{
auto& output = compress_buffer();
// handle empty payload case
if (input.size() == 0) [[unlikely]]
{
constexpr byte buf[] = {
byte(0x02), byte(0x00), byte(0x00), byte(0x00), byte(0xff), byte(0xff)
};
WS_TRYV(output.append(6));
std::memcpy(output.data().data(), buf, sizeof(buf));
return output.data().subspan(0, 6);
}
// set zlib input buffer to frame payload
ostate_->next_in = reinterpret_cast<Bytef*>(input.data());
ostate_->avail_in = static_cast<unsigned int>(input.size());
// zlib flush mode (preserve LZ77 sliding window or not)
int client_flush_mode = def_.client_no_context_takeover //
? Z_FULL_FLUSH
: Z_SYNC_FLUSH;
size_t size = 0;
do
{
// extend output buffer if required, usually over-allocates.
WS_TRY(alloc_res, output.append(std::max(64U, ostate_->avail_in)));
span<byte> avail = *alloc_res;
// set zlib output buffer
ostate_->next_out = reinterpret_cast<Bytef*>(avail.data());
ostate_->avail_out = static_cast<unsigned int>(avail.size());
int ret = deflate(ostate_, client_flush_mode);
if (ret != Z_OK && ret != Z_STREAM_END && ret != Z_BUF_ERROR)
return make_error("deflate", ostate_->msg);
size += avail.size() - ostate_->avail_out;
output.discard_end(ostate_->avail_out);
} while (ostate_->avail_out == 0);
#if WS_CLIENT_LOG_COMPRESSION > 0
if (logger_->template is_enabled<LogLevel::D, LogTopic::Compression>())
{
logger_->template log<LogLevel::D, LogTopic::Compression>(
std::format("compression ratio: {:.3f}", static_cast<double>(input.size()) / size)
);
}
#endif
// reset deflate state depending on negotiated configuration
if (def_.client_no_context_takeover)
{
if (Z_OK != deflateReset(ostate_))
return make_error("deflateReset", ostate_->msg);
}
// remove trailer bytes (0x00 0x00 0xff 0xff)
if (size >= 4)
size -= 4;
return output.data().subspan(0, size);
}
[[nodiscard]] static auto make_error(string_view desc, const char* msg) noexcept
{
return WS_ERROR(
compression_error,
std::format("zlib [{}] failed: {}", desc, msg ? msg : "N/A"),
close_code::not_set
);
}
};
} // namespace ws_client