/* * Authored by Alex Hultman, 2018-2021. * Intellectual property of third-party. * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * http://www.apache.org/licenses/LICENSE-2.0 * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /* This standalone module implements deflate / inflate streams */ #ifndef UWS_PERMESSAGEDEFLATE_H #define UWS_PERMESSAGEDEFLATE_H /* We always define these options no matter if ZLIB is enabled or not */ namespace uWS { /* Compressor mode is HIGH8(windowBits), LOW8(memLevel) */ enum CompressOptions : uint32_t { DISABLED = 0, SHARED_COMPRESSOR = 1, DEDICATED_COMPRESSOR_3KB = 9 << 8 | 1, DEDICATED_COMPRESSOR_4KB = 9 << 8 | 2, DEDICATED_COMPRESSOR_8KB = 10 << 8 | 3, DEDICATED_COMPRESSOR_16KB = 11 << 8 | 4, DEDICATED_COMPRESSOR_32KB = 12 << 8 | 5, DEDICATED_COMPRESSOR_64KB = 13 << 8 | 6, DEDICATED_COMPRESSOR_128KB = 14 << 8 | 7, DEDICATED_COMPRESSOR_256KB = 15 << 8 | 8, /* Same as 256kb */ DEDICATED_COMPRESSOR = 15 << 8 | 8 }; } #ifndef UWS_NO_ZLIB #include #endif #include #include #ifdef UWS_USE_LIBDEFLATE #include "libdeflate.h" #include #endif namespace uWS { /* Do not compile this module if we don't want it */ #ifdef UWS_NO_ZLIB struct ZlibContext {}; struct InflationStream { std::optional inflate(ZlibContext *zlibContext, std::string_view compressed, size_t maxPayloadLength) { /* Anything here goes, it is never going to be called */ return std::nullopt; } }; struct DeflationStream { std::string_view deflate(ZlibContext *zlibContext, std::string_view raw, bool reset) { return raw; } DeflationStream(int compressOptions) { } }; #else #define LARGE_BUFFER_SIZE 1024 * 16 // todo: fix this struct ZlibContext { /* Any returned data is valid until next same-class call. * We need to have two classes to allow inflation followed * by many deflations without modifying the inflation */ std::string dynamicDeflationBuffer; std::string dynamicInflationBuffer; char *deflationBuffer; char *inflationBuffer; #ifdef UWS_USE_LIBDEFLATE libdeflate_decompressor *decompressor; libdeflate_compressor *compressor; #endif ZlibContext() { deflationBuffer = (char *) malloc(LARGE_BUFFER_SIZE); inflationBuffer = (char *) malloc(LARGE_BUFFER_SIZE); #ifdef UWS_USE_LIBDEFLATE decompressor = libdeflate_alloc_decompressor(); compressor = libdeflate_alloc_compressor(7); #endif } ~ZlibContext() { free(deflationBuffer); free(inflationBuffer); #ifdef UWS_USE_LIBDEFLATE libdeflate_free_decompressor(decompressor); libdeflate_free_compressor(compressor); #endif } }; struct DeflationStream { z_stream deflationStream = {}; DeflationStream(CompressOptions compressOptions) { /* Sliding inflator should be about 44kb by default, less than compressor */ /* Memory usage is given by 2 ^ (windowBits + 2) + 2 ^ (memLevel + 9) */ int windowBits = -(int) ((compressOptions & 0xFF00) >> 8), memLevel = compressOptions & 0x00FF; //printf("windowBits: %d, memLevel: %d\n", windowBits, memLevel); deflateInit2(&deflationStream, 1, Z_DEFLATED, windowBits, memLevel, Z_DEFAULT_STRATEGY); } /* Deflate and optionally reset. You must not deflate an empty string. */ std::string_view deflate(ZlibContext *zlibContext, std::string_view raw, bool reset) { #ifdef UWS_USE_LIBDEFLATE /* Run a fast path in case of shared_compressor */ if (reset) { size_t written = 0; static unsigned char buf[1024 + 1]; written = libdeflate_deflate_compress(zlibContext->compressor, raw.data(), raw.length(), buf, 1024); if (written) { memcpy(&buf[written], "\x00", 1); return std::string_view((char *) buf, written + 1); } } #endif /* Odd place to clear this one, fix */ zlibContext->dynamicDeflationBuffer.clear(); deflationStream.next_in = (Bytef *) raw.data(); deflationStream.avail_in = (unsigned int) raw.length(); /* This buffer size has to be at least 6 bytes for Z_SYNC_FLUSH to work */ const int DEFLATE_OUTPUT_CHUNK = LARGE_BUFFER_SIZE; int err; do { deflationStream.next_out = (Bytef *) zlibContext->deflationBuffer; deflationStream.avail_out = DEFLATE_OUTPUT_CHUNK; err = ::deflate(&deflationStream, Z_SYNC_FLUSH); if (Z_OK == err && deflationStream.avail_out == 0) { zlibContext->dynamicDeflationBuffer.append(zlibContext->deflationBuffer, DEFLATE_OUTPUT_CHUNK - deflationStream.avail_out); continue; } else { break; } } while (true); /* This must not change avail_out */ if (reset) { deflateReset(&deflationStream); } if (zlibContext->dynamicDeflationBuffer.length()) { zlibContext->dynamicDeflationBuffer.append(zlibContext->deflationBuffer, DEFLATE_OUTPUT_CHUNK - deflationStream.avail_out); return std::string_view((char *) zlibContext->dynamicDeflationBuffer.data(), zlibContext->dynamicDeflationBuffer.length() - 4); } /* Note: We will get an interger overflow resulting in heap buffer overflow if Z_BUF_ERROR is returned * from passing 0 as avail_in. Therefore we must not deflate an empty string */ return { zlibContext->deflationBuffer, DEFLATE_OUTPUT_CHUNK - deflationStream.avail_out - 4 }; } ~DeflationStream() { deflateEnd(&deflationStream); } }; struct InflationStream { z_stream inflationStream = {}; InflationStream() { inflateInit2(&inflationStream, -15); } ~InflationStream() { inflateEnd(&inflationStream); } /* Zero length inflates are possible and valid */ std::optional inflate(ZlibContext *zlibContext, std::string_view compressed, size_t maxPayloadLength) { #ifdef UWS_USE_LIBDEFLATE /* Try fast path first */ size_t written = 0; static char buf[1024]; /* We have to pad 9 bytes and restore those bytes when done since 9 is more than 6 of next WebSocket message */ char tmp[9]; memcpy(tmp, (char *) compressed.data() + compressed.length(), 9); memcpy((char *) compressed.data() + compressed.length(), "\x00\x00\xff\xff\x01\x00\x00\xff\xff", 9); libdeflate_result res = libdeflate_deflate_decompress(zlibContext->decompressor, compressed.data(), compressed.length() + 9, buf, 1024, &written); memcpy((char *) compressed.data() + compressed.length(), tmp, 9); if (res == 0) { /* Fast path wins */ return std::string_view(buf, written); } #endif /* We clear this one here, could be done better */ zlibContext->dynamicInflationBuffer.clear(); inflationStream.next_in = (Bytef *) compressed.data(); inflationStream.avail_in = (unsigned int) compressed.length(); int err; do { inflationStream.next_out = (Bytef *) zlibContext->inflationBuffer; inflationStream.avail_out = LARGE_BUFFER_SIZE; err = ::inflate(&inflationStream, Z_SYNC_FLUSH); if (err == Z_OK && inflationStream.avail_out) { break; } zlibContext->dynamicInflationBuffer.append(zlibContext->inflationBuffer, LARGE_BUFFER_SIZE - inflationStream.avail_out); } while (inflationStream.avail_out == 0 && zlibContext->dynamicInflationBuffer.length() <= maxPayloadLength); inflateReset(&inflationStream); if ((err != Z_BUF_ERROR && err != Z_OK) || zlibContext->dynamicInflationBuffer.length() > maxPayloadLength) { return std::nullopt; } if (zlibContext->dynamicInflationBuffer.length()) { zlibContext->dynamicInflationBuffer.append(zlibContext->inflationBuffer, LARGE_BUFFER_SIZE - inflationStream.avail_out); /* Let's be strict about the max size */ if (zlibContext->dynamicInflationBuffer.length() > maxPayloadLength) { return std::nullopt; } return std::string_view(zlibContext->dynamicInflationBuffer.data(), zlibContext->dynamicInflationBuffer.length()); } /* Let's be strict about the max size */ if ((LARGE_BUFFER_SIZE - inflationStream.avail_out) > maxPayloadLength) { return std::nullopt; } return std::string_view(zlibContext->inflationBuffer, LARGE_BUFFER_SIZE - inflationStream.avail_out); } }; #endif } #endif // UWS_PERMESSAGEDEFLATE_H