opal-up 0.0.2 → 0.0.4

data/ext/up_ext/WebSocketExtensions.h

@@ -0,0 +1,256 @@
+/*
+ * 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.
+ */
+
+#ifndef UWS_WEBSOCKETEXTENSIONS_H
+#define UWS_WEBSOCKETEXTENSIONS_H
+
+/* There is a new, huge bug scenario that needs to be fixed:
+ * pub/sub does not support being in DEDICATED_COMPRESSOR-mode while having
+ * some clients downgraded to SHARED_COMPRESSOR - we cannot allow the client to
+ * demand a downgrade to SHARED_COMPRESSOR (yet) until we fix that scenario in pub/sub */
+// #define UWS_ALLOW_SHARED_AND_DEDICATED_COMPRESSOR_MIX
+
+/* We forbid negotiating 8 windowBits since Zlib has a bug with this */
+// #define UWS_ALLOW_8_WINDOW_BITS
+
+#include <climits>
+#include <cctype>
+#include <string>
+#include <string_view>
+#include <tuple>
+
+namespace uWS {
+
+enum ExtensionTokens {
+    /* Standard permessage-deflate tokens */
+    TOK_PERMESSAGE_DEFLATE = 1838,
+    TOK_SERVER_NO_CONTEXT_TAKEOVER = 2807,
+    TOK_CLIENT_NO_CONTEXT_TAKEOVER = 2783,
+    TOK_SERVER_MAX_WINDOW_BITS = 2372,
+    TOK_CLIENT_MAX_WINDOW_BITS = 2348,
+    /* Non-standard alias for Safari */
+    TOK_X_WEBKIT_DEFLATE_FRAME = 2149,
+    TOK_NO_CONTEXT_TAKEOVER = 2049,
+    TOK_MAX_WINDOW_BITS = 1614
+
+};
+
+struct ExtensionsParser {
+private:
+    int *lastInteger = nullptr;
+
+public:
+    /* Standard */
+    bool perMessageDeflate = false;
+    bool serverNoContextTakeover = false;
+    bool clientNoContextTakeover = false;
+    int serverMaxWindowBits = 0;
+    int clientMaxWindowBits = 0;
+
+    /* Non-standard Safari */
+    bool xWebKitDeflateFrame = false;
+    bool noContextTakeover = false;
+    int maxWindowBits = 0;
+
+    int getToken(const char *&in, const char *stop) {
+        while (in != stop && !isalnum(*in)) {
+            in++;
+        }
+
+        /* Don't care more than this for now */
+        static_assert(SHRT_MIN > INT_MIN, "Integer overflow fix is invalid for this platform, report this as a bug!");
+
+        int hashedToken = 0;
+        while (in != stop && (isalnum(*in) || *in == '-' || *in == '_')) {
+            if (isdigit(*in)) {
+                /* This check is a quick and incorrect fix for integer overflow
+                 * in oss-fuzz but we don't care as it doesn't matter either way */
+                if (hashedToken > SHRT_MIN && hashedToken < SHRT_MAX) {
+                    hashedToken = hashedToken * 10 - (*in - '0');
+                }
+            } else {
+                hashedToken += *in;
+            }
+            in++;
+        }
+        return hashedToken;
+    }
+
+    ExtensionsParser(const char *data, size_t length) {
+        const char *stop = data + length;
+        int token = 1;
+
+        /* Ignore anything before permessage-deflate or x-webkit-deflate-frame */
+        for (; token && token != TOK_PERMESSAGE_DEFLATE && token != TOK_X_WEBKIT_DEFLATE_FRAME; token = getToken(data, stop));
+
+        /* What protocol are we going to use? */
+        perMessageDeflate = (token == TOK_PERMESSAGE_DEFLATE);
+        xWebKitDeflateFrame = (token == TOK_X_WEBKIT_DEFLATE_FRAME);
+
+        while ((token = getToken(data, stop))) {
+            switch (token) {
+            case TOK_X_WEBKIT_DEFLATE_FRAME:
+                /* Duplicates not allowed/supported */
+                return;
+            case TOK_NO_CONTEXT_TAKEOVER:
+                noContextTakeover = true;
+                break;
+            case TOK_MAX_WINDOW_BITS:
+                maxWindowBits = 1;
+                lastInteger = &maxWindowBits;
+                break;
+            case TOK_PERMESSAGE_DEFLATE:
+                /* Duplicates not allowed/supported */
+                return;
+            case TOK_SERVER_NO_CONTEXT_TAKEOVER:
+                serverNoContextTakeover = true;
+                break;
+            case TOK_CLIENT_NO_CONTEXT_TAKEOVER:
+                clientNoContextTakeover = true;
+                break;
+            case TOK_SERVER_MAX_WINDOW_BITS:
+                serverMaxWindowBits = 1;
+                lastInteger = &serverMaxWindowBits;
+                break;
+            case TOK_CLIENT_MAX_WINDOW_BITS:
+                clientMaxWindowBits = 1;
+                lastInteger = &clientMaxWindowBits;
+                break;
+            default:
+                if (token < 0 && lastInteger) {
+                    *lastInteger = -token;
+                }
+                break;
+            }
+        }
+    }
+};
+
+/* Takes what we (the server) wants, returns what we got */
+static inline std::tuple<bool, int, int, std::string_view> negotiateCompression(bool wantCompression, int wantedCompressionWindow, int wantedInflationWindow, std::string_view offer) {
+
+    /* If we don't want compression then we are done here */
+    if (!wantCompression) {
+        return {false, 0, 0, ""};
+    }
+
+    ExtensionsParser ep(offer.data(), offer.length());
+
+    static thread_local std::string response;
+    response = "";
+
+    int compressionWindow = wantedCompressionWindow;
+    int inflationWindow = wantedInflationWindow;
+    bool compression = false;
+
+    if (ep.xWebKitDeflateFrame) {
+        /* We now have compression */
+        compression = true;
+        response = "x-webkit-deflate-frame";
+
+        /* If the other peer has DEMANDED us no sliding window,
+         * we cannot compress with anything other than shared compressor */
+        if (ep.noContextTakeover) {
+            /* We must fail here right now (fix pub/sub) */
+#ifndef UWS_ALLOW_SHARED_AND_DEDICATED_COMPRESSOR_MIX
+            if (wantedCompressionWindow != 0) {
+                return {false, 0, 0, ""};
+            }
+#endif
+
+            compressionWindow = 0;
+        }
+
+        /* If the other peer has DEMANDED us to use a limited sliding window,
+         * we have to limit out compression sliding window */
+        if (ep.maxWindowBits && ep.maxWindowBits < compressionWindow) {
+            compressionWindow = ep.maxWindowBits;
+#ifndef UWS_ALLOW_8_WINDOW_BITS
+            /* We cannot really deny this, so we have to disable compression in this case */
+            if (compressionWindow == 8) {
+                return {false, 0, 0, ""};
+            }
+#endif
+        }
+
+        /* We decide our own inflation sliding window (and their compression sliding window) */
+        if (wantedInflationWindow < 15) {
+            if (!wantedInflationWindow) {
+                response += "; no_context_takeover";
+            } else {
+                response += "; max_window_bits=" + std::to_string(wantedInflationWindow);
+            }
+        }
+    } else if (ep.perMessageDeflate) {
+        /* We now have compression */
+        compression = true;
+        response = "permessage-deflate";
+
+        if (ep.clientNoContextTakeover) {
+            inflationWindow = 0;
+        } else if (ep.clientMaxWindowBits && ep.clientMaxWindowBits != 1) {
+            inflationWindow = std::min<int>(ep.clientMaxWindowBits, inflationWindow);
+        }
+
+        /* Whatever we have now, write */
+        if (inflationWindow < 15) {
+            if (!inflationWindow || !ep.clientMaxWindowBits) {
+                response += "; client_no_context_takeover";
+                inflationWindow = 0;
+            } else {
+                response += "; client_max_window_bits=" + std::to_string(inflationWindow);
+            }
+        }
+
+        /* This block basically lets the client lower it */
+        if (ep.serverNoContextTakeover) {
+        /* This is an important (temporary) fix since we haven't allowed
+         * these two modes to mix, and pub/sub will not handle this case (yet) */
+#ifdef UWS_ALLOW_SHARED_AND_DEDICATED_COMPRESSOR_MIX
+            compressionWindow = 0;
+#endif
+        } else if (ep.serverMaxWindowBits) {
+            compressionWindow = std::min<int>(ep.serverMaxWindowBits, compressionWindow);
+#ifndef UWS_ALLOW_8_WINDOW_BITS
+            /* Zlib cannot do windowBits=8, memLevel=1 so we raise it up to 9 minimum */
+            if (compressionWindow == 8) {
+                compressionWindow = 9;
+            }
+#endif
+        }
+
+        /* Whatever we have now, write */
+        if (compressionWindow < 15) {
+            if (!compressionWindow) {
+                response += "; server_no_context_takeover";
+            } else {
+                response += "; server_max_window_bits=" + std::to_string(compressionWindow);
+            }
+        }
+    }
+
+    /* A final sanity check (this check does not actually catch too high values!) */
+    if ((compressionWindow && compressionWindow < 8) || compressionWindow > 15 || (inflationWindow && inflationWindow < 8) || inflationWindow > 15) {
+        return {false, 0, 0, ""};
+    }
+
+    return {compression, compressionWindow, inflationWindow, response};
+}
+
+}
+
+#endif // UWS_WEBSOCKETEXTENSIONS_H

data/ext/up_ext/WebSocketHandshake.h

@@ -0,0 +1,145 @@
+/*
+ * Authored by Alex Hultman, 2018-2020.
+ * 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.
+*/
+
+#ifndef UWS_WEBSOCKETHANDSHAKE_H
+#define UWS_WEBSOCKETHANDSHAKE_H
+
+#include <cstdint>
+#include <cstddef>
+
+namespace uWS {
+
+struct WebSocketHandshake {
+    template <int N, typename T>
+    struct static_for {
+        void operator()(uint32_t *a, uint32_t *b) {
+            static_for<N - 1, T>()(a, b);
+            T::template f<N - 1>(a, b);
+        }
+    };
+
+    template <typename T>
+    struct static_for<0, T> {
+        void operator()(uint32_t */*a*/, uint32_t */*hash*/) {}
+    };
+
+    static inline uint32_t rol(uint32_t value, size_t bits) {return (value << bits) | (value >> (32 - bits));}
+    static inline uint32_t blk(uint32_t b[16], size_t i) {
+        return rol(b[(i + 13) & 15] ^ b[(i + 8) & 15] ^ b[(i + 2) & 15] ^ b[i], 1);
+    }
+
+    struct Sha1Loop1 {
+        template <int i>
+        static inline void f(uint32_t *a, uint32_t *b) {
+            a[i % 5] += ((a[(3 + i) % 5] & (a[(2 + i) % 5] ^ a[(1 + i) % 5])) ^ a[(1 + i) % 5]) + b[i] + 0x5a827999 + rol(a[(4 + i) % 5], 5);
+            a[(3 + i) % 5] = rol(a[(3 + i) % 5], 30);
+        }
+    };
+    struct Sha1Loop2 {
+        template <int i>
+        static inline void f(uint32_t *a, uint32_t *b) {
+            b[i] = blk(b, i);
+            a[(1 + i) % 5] += ((a[(4 + i) % 5] & (a[(3 + i) % 5] ^ a[(2 + i) % 5])) ^ a[(2 + i) % 5]) + b[i] + 0x5a827999 + rol(a[(5 + i) % 5], 5);
+            a[(4 + i) % 5] = rol(a[(4 + i) % 5], 30);
+        }
+    };
+    struct Sha1Loop3 {
+        template <int i>
+        static inline void f(uint32_t *a, uint32_t *b) {
+            b[(i + 4) % 16] = blk(b, (i + 4) % 16);
+            a[i % 5] += (a[(3 + i) % 5] ^ a[(2 + i) % 5] ^ a[(1 + i) % 5]) + b[(i + 4) % 16] + 0x6ed9eba1 + rol(a[(4 + i) % 5], 5);
+            a[(3 + i) % 5] = rol(a[(3 + i) % 5], 30);
+        }
+    };
+    struct Sha1Loop4 {
+        template <int i>
+        static inline void f(uint32_t *a, uint32_t *b) {
+            b[(i + 8) % 16] = blk(b, (i + 8) % 16);
+            a[i % 5] += (((a[(3 + i) % 5] | a[(2 + i) % 5]) & a[(1 + i) % 5]) | (a[(3 + i) % 5] & a[(2 + i) % 5])) + b[(i + 8) % 16] + 0x8f1bbcdc + rol(a[(4 + i) % 5], 5);
+            a[(3 + i) % 5] = rol(a[(3 + i) % 5], 30);
+        }
+    };
+    struct Sha1Loop5 {
+        template <int i>
+        static inline void f(uint32_t *a, uint32_t *b) {
+            b[(i + 12) % 16] = blk(b, (i + 12) % 16);
+            a[i % 5] += (a[(3 + i) % 5] ^ a[(2 + i) % 5] ^ a[(1 + i) % 5]) + b[(i + 12) % 16] + 0xca62c1d6 + rol(a[(4 + i) % 5], 5);
+            a[(3 + i) % 5] = rol(a[(3 + i) % 5], 30);
+        }
+    };
+    struct Sha1Loop6 {
+        template <int i>
+        static inline void f(uint32_t *a, uint32_t *b) {
+            b[i] += a[4 - i];
+        }
+    };
+
+    static inline void sha1(uint32_t hash[5], uint32_t b[16]) {
+        uint32_t a[5] = {hash[4], hash[3], hash[2], hash[1], hash[0]};
+        static_for<16, Sha1Loop1>()(a, b);
+        static_for<4, Sha1Loop2>()(a, b);
+        static_for<20, Sha1Loop3>()(a, b);
+        static_for<20, Sha1Loop4>()(a, b);
+        static_for<20, Sha1Loop5>()(a, b);
+        static_for<5, Sha1Loop6>()(a, hash);
+    }
+
+    static inline void base64(unsigned char *src, char *dst) {
+        const char *b64 = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
+        for (int i = 0; i < 18; i += 3) {
+            *dst++ = b64[(src[i] >> 2) & 63];
+            *dst++ = b64[((src[i] & 3) << 4) | ((src[i + 1] & 240) >> 4)];
+            *dst++ = b64[((src[i + 1] & 15) << 2) | ((src[i + 2] & 192) >> 6)];
+            *dst++ = b64[src[i + 2] & 63];
+        }
+        *dst++ = b64[(src[18] >> 2) & 63];
+        *dst++ = b64[((src[18] & 3) << 4) | ((src[19] & 240) >> 4)];
+        *dst++ = b64[((src[19] & 15) << 2)];
+        *dst++ = '=';
+    }
+
+public:
+    static inline void generate(const char input[24], char output[28]) {
+        uint32_t b_output[5] = {
+            0x67452301, 0xefcdab89, 0x98badcfe, 0x10325476, 0xc3d2e1f0
+        };
+        uint32_t b_input[16] = {
+            0, 0, 0, 0, 0, 0, 0x32353845, 0x41464135, 0x2d453931, 0x342d3437, 0x44412d39,
+            0x3543412d, 0x43354142, 0x30444338, 0x35423131, 0x80000000
+        };
+
+        for (int i = 0; i < 6; i++) {
+            b_input[i] = (uint32_t) ((input[4 * i + 3] & 0xff) | (input[4 * i + 2] & 0xff) << 8 | (input[4 * i + 1] & 0xff) << 16 | (input[4 * i + 0] & 0xff) << 24);
+        }
+        sha1(b_output, b_input);
+        uint32_t last_b[16] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 480};
+        sha1(b_output, last_b);
+        for (int i = 0; i < 5; i++) {
+            uint32_t tmp = b_output[i];
+            char *bytes = (char *) &b_output[i];
+            bytes[3] = (char) (tmp & 0xff);
+            bytes[2] = (char) ((tmp >> 8) & 0xff);
+            bytes[1] = (char) ((tmp >> 16) & 0xff);
+            bytes[0] = (char) ((tmp >> 24) & 0xff);
+        }
+        base64((unsigned char *) b_output, output);
+    }
+};
+
+}
+
+#endif // UWS_WEBSOCKETHANDSHAKE_H