iodine 0.7.17 → 0.7.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 909a4b34102fd6e636eab59eccf82deaf315bcc50131ee9f4d476f249df2fe2a
-  data.tar.gz: dded0a5249df8dcd0854198ea6df03661e40b69ddcba35d0bd693c1a6acf6cb2
+  metadata.gz: 664ebf25c0cad461467cdb2af2b789d3a0897721566c015bff60b68768a7e3ad
+  data.tar.gz: cc31d5af68fd2a59dc8fa927af51c2228082f05ca7b69c2c4b31e1d208f88337
 SHA512:
-  metadata.gz: 9cdaf95feee9f8de5daedf472a3bd5318931c1aa1b5a5ccc95178e62053ba6e97e021f856ec863e586f22d0b760dee1a66a6204c1cd71267545f164cd9ce378f
-  data.tar.gz: 24d6b5d326fd11cb69beeb215bfc80b4f062d269d3734bc78710654c5444d370346793da2f18c6dba955f53f9754063206399d9de1aef5d76d04299a8ee29aeb
+  metadata.gz: ae79cb205f288cb84b14d92f7b987f7e350f747c560e3a6e23cb3c1f1d43864234e75dd7f8b71f179f3cecfc8841c0f1da53a41995502c2c8c8c6945c248cc86
+  data.tar.gz: 705d7b0d312e1c3b7953cf503878a2c91a006cef1c7bf9612f83f8f3d97494208bdc8c2ef1a6a857839586525dcd3cbaa4e64758c597a5fd1d929a364f2b9b3c

data/CHANGELOG.md

@@ -6,6 +6,10 @@ Please notice that this change log contains changes for upcoming releases as wel
 
 ## Changes:
 
+#### Change log v.0.7.18
+
+**Fix** (`pubsub`) fixed pub/sub for longer WebSocket messages. Issue where network byte ordering wasn't always respected and integer bit size was wrong for larger payloads. Credit to Marouane Elmidaoui (@moxgeek) for exposing the issue.
+
 #### Change log v.0.7.17
 
 **Security**: (`fio`) improved security against hash flooding attacks.

data/ext/iodine/websocket_parser.h

@@ -221,82 +221,40 @@ void websocket_xmask(void *msg, uint64_t len, uint32_t mask) {
 Message wrapping
 ***************************************************************************** */
 
-// clang-format off
-#if !defined(__BIG_ENDIAN__) && !defined(__LITTLE_ENDIAN__)
-#   if defined(__has_include)
-#     if __has_include(<endian.h>)
-#      include <endian.h>
-#     elif __has_include(<sys/endian.h>)
-#      include <sys/endian.h>
-#     endif
-#   endif
-#   if !defined(__BIG_ENDIAN__) && !defined(__LITTLE_ENDIAN__) && \
-                __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
-#      define __BIG_ENDIAN__
-#   endif
-#endif
-// clang-format on
-
-#ifdef __BIG_ENDIAN__
-/** stub byte swap 64 bit integer from pointer */
-static inline uint64_t netpiswap64(uint8_t *i) {
-  uint64_t ret = 0;
-  uint8_t *const pret = (uint8_t *)&ret;
-  pret[7] = i[7];
-  pret[6] = i[6];
-  pret[5] = i[5];
-  pret[4] = i[4];
-  pret[3] = i[3];
-  pret[2] = i[2];
-  pret[1] = i[1];
-  pret[0] = i[0];
-  return ret;
-}
-/** stub byte swap 16 bit integer from pointer */
-static inline uint16_t netpiswap16(uint8_t *i) {
-  uint16_t ret = 0;
-  uint8_t *const pret = (uint8_t *)&ret;
-  pret[1] = i[1];
-  pret[0] = i[0];
-  return ret;
-}
-#define netiswap64(i) (i)
-#define netiswap16(i) (i)
-
-#else
-// TODO: check for __builtin_bswap64
-/** byte swap 64 bit integer */
-#define netiswap64(i)                                                          \
-  ((((i)&0xFFULL) << 56) | (((i)&0xFF00ULL) << 40) |                           \
-   (((i)&0xFF0000ULL) << 24) | (((i)&0xFF000000ULL) << 8) |                    \
-   (((i)&0xFF00000000ULL) >> 8) | (((i)&0xFF0000000000ULL) >> 24) |            \
-   (((i)&0xFF000000000000ULL) >> 40) | (((i)&0xFF00000000000000ULL) >> 56))
-/** byte swap 16 bit integer */
-#define netiswap16(i) ((((i)&0x00ff) << 8) | (((i)&0xff00) >> 8))
-/** byte swap 64 bit integer from pointer */
-static inline uint64_t netpiswap64(uint8_t *i) {
-  uint64_t ret = 0;
-  uint8_t *const pret = (uint8_t *)&ret;
-  pret[0] = i[7];
-  pret[1] = i[6];
-  pret[2] = i[5];
-  pret[3] = i[4];
-  pret[4] = i[3];
-  pret[5] = i[2];
-  pret[6] = i[1];
-  pret[7] = i[0];
-  return ret;
-}
-/** byte swap 16 bit integer from pointer */
-static inline uint16_t netpiswap16(uint8_t *i) {
-  uint16_t ret = 0;
-  uint8_t *const pret = (uint8_t *)&ret;
-  pret[0] = i[1];
-  pret[1] = i[0];
-  return ret;
-}
-
-#endif
+/** Converts an unaligned network ordered byte stream to a 16 bit number. */
+#define websocket_str2u16(c)                                                   \
+  ((uint16_t)(((uint16_t)(((uint8_t *)(c))[0]) << 8) |                         \
+              (uint16_t)(((uint8_t *)(c))[1])))
+
+/** Converts an unaligned network ordered byte stream to a 64 bit number. */
+#define websocket_str2u64(c)                                                   \
+  ((uint64_t)((((uint64_t)((uint8_t *)(c))[0]) << 56) |                        \
+              (((uint64_t)((uint8_t *)(c))[1]) << 48) |                        \
+              (((uint64_t)((uint8_t *)(c))[2]) << 40) |                        \
+              (((uint64_t)((uint8_t *)(c))[3]) << 32) |                        \
+              (((uint64_t)((uint8_t *)(c))[4]) << 24) |                        \
+              (((uint64_t)((uint8_t *)(c))[5]) << 16) |                        \
+              (((uint64_t)((uint8_t *)(c))[6]) << 8) | (((uint8_t *)(c))[7])))
+
+/** Writes a local 16 bit number to an unaligned buffer in network order. */
+#define websocket_u2str16(buffer, i)                                           \
+  do {                                                                         \
+    ((uint8_t *)(buffer))[0] = ((uint16_t)(i) >> 8) & 0xFF;                    \
+    ((uint8_t *)(buffer))[1] = ((uint16_t)(i)) & 0xFF;                         \
+  } while (0);
+
+/** Writes a local 64 bit number to an unaligned buffer in network order. */
+#define websocket_u2str64(buffer, i)                                           \
+  do {                                                                         \
+    ((uint8_t *)(buffer))[0] = ((uint64_t)(i) >> 56) & 0xFF;                   \
+    ((uint8_t *)(buffer))[1] = ((uint64_t)(i) >> 48) & 0xFF;                   \
+    ((uint8_t *)(buffer))[2] = ((uint64_t)(i) >> 40) & 0xFF;                   \
+    ((uint8_t *)(buffer))[3] = ((uint64_t)(i) >> 32) & 0xFF;                   \
+    ((uint8_t *)(buffer))[4] = ((uint64_t)(i) >> 24) & 0xFF;                   \
+    ((uint8_t *)(buffer))[5] = ((uint64_t)(i) >> 16) & 0xFF;                   \
+    ((uint8_t *)(buffer))[6] = ((uint64_t)(i) >> 8) & 0xFF;                    \
+    ((uint8_t *)(buffer))[7] = ((uint64_t)(i)) & 0xFF;                         \
+  } while (0);
 
 /** returns the length of the buffer required to wrap a message `len` long */
 static inline uint64_t websocket_wrapped_len(uint64_t len) {
@@ -346,23 +304,13 @@ static uint64_t websocket_server_wrap(void *target, void *msg, uint64_t len,
   } else if (len < (1UL << 16)) {
     /* head is 4 bytes */
     ((uint8_t *)target)[1] = 126;
-    const uint16_t net_len = netiswap16(len);
-    ((uint8_t *)target)[2] = ((uint8_t *)(&net_len))[0];
-    ((uint8_t *)target)[3] = ((uint8_t *)(&net_len))[1];
+    websocket_u2str16(((uint8_t *)target + 2), len);
     memcpy((uint8_t *)target + 4, msg, len);
     return len + 4;
   }
   /* Really Long Message  */
   ((uint8_t *)target)[1] = 127;
-  const uint64_t net_len = netiswap16(len);
-  ((uint8_t *)target)[2] = ((uint8_t *)(&net_len))[0];
-  ((uint8_t *)target)[3] = ((uint8_t *)(&net_len))[1];
-  ((uint8_t *)target)[4] = ((uint8_t *)(&net_len))[2];
-  ((uint8_t *)target)[5] = ((uint8_t *)(&net_len))[3];
-  ((uint8_t *)target)[6] = ((uint8_t *)(&net_len))[4];
-  ((uint8_t *)target)[7] = ((uint8_t *)(&net_len))[5];
-  ((uint8_t *)target)[8] = ((uint8_t *)(&net_len))[6];
-  ((uint8_t *)target)[9] = ((uint8_t *)(&net_len))[7];
+  websocket_u2str64(((uint8_t *)target + 2), len);
   memcpy((uint8_t *)target + 10, msg, len);
   return len + 10;
 }
@@ -402,9 +350,7 @@ static uint64_t websocket_client_wrap(void *target, void *msg, uint64_t len,
   } else if (len < (1UL << 16)) {
     /* head is 4 bytes */
     ((uint8_t *)target)[1] = 126 | 128;
-    const uint16_t net_len = netiswap16(len);
-    ((uint8_t *)target)[2] = ((uint8_t *)(&net_len))[0];
-    ((uint8_t *)target)[3] = ((uint8_t *)(&net_len))[1];
+    websocket_u2str16(((uint8_t *)target + 2), len);
     ((uint8_t *)target)[4] = ((uint8_t *)(&mask))[0];
     ((uint8_t *)target)[5] = ((uint8_t *)(&mask))[1];
     ((uint8_t *)target)[6] = ((uint8_t *)(&mask))[2];
@@ -415,15 +361,7 @@ static uint64_t websocket_client_wrap(void *target, void *msg, uint64_t len,
   }
   /* Really Long Message  */
   ((uint8_t *)target)[1] = 255;
-  const uint64_t net_len = netiswap16(len);
-  ((uint8_t *)target)[2] = ((uint8_t *)(&net_len))[0];
-  ((uint8_t *)target)[3] = ((uint8_t *)(&net_len))[1];
-  ((uint8_t *)target)[4] = ((uint8_t *)(&net_len))[2];
-  ((uint8_t *)target)[5] = ((uint8_t *)(&net_len))[3];
-  ((uint8_t *)target)[6] = ((uint8_t *)(&net_len))[4];
-  ((uint8_t *)target)[7] = ((uint8_t *)(&net_len))[5];
-  ((uint8_t *)target)[8] = ((uint8_t *)(&net_len))[6];
-  ((uint8_t *)target)[9] = ((uint8_t *)(&net_len))[7];
+  websocket_u2str64(((uint8_t *)target + 2), len);
   ((uint8_t *)target)[10] = ((uint8_t *)(&mask))[0];
   ((uint8_t *)target)[11] = ((uint8_t *)(&mask))[1];
   ((uint8_t *)target)[12] = ((uint8_t *)(&mask))[2];
@@ -460,14 +398,15 @@ websocket_buffer_peek(void *buffer, uint64_t len) {
     if (len < 4)
       return (struct websocket_packet_info_s){0, (uint8_t)(4 + mask_l), mask_f};
     return (struct websocket_packet_info_s){
-        (uint64_t)netpiswap16(((uint8_t *)buffer) + 2), (uint8_t)(4 + mask_l),
-        mask_f};
+        (uint64_t)websocket_str2u16(((uint8_t *)buffer + 2)),
+        (uint8_t)(4 + mask_l), mask_f};
   case 127:
     if (len < 10)
       return (struct websocket_packet_info_s){0, (uint8_t)(10 + mask_l),
                                               mask_f};
     return (struct websocket_packet_info_s){
-        netpiswap64(((uint8_t *)buffer) + 2), (uint8_t)(10 + mask_l), mask_f};
+        websocket_str2u64(((uint8_t *)buffer + 2)), (uint8_t)(10 + mask_l),
+        mask_f};
   default:
     return (struct websocket_packet_info_s){len_indicator,
                                             (uint8_t)(2 + mask_l), mask_f};

data/ext/iodine/websockets.c

@@ -542,29 +542,34 @@ static inline void websocket_on_pubsub_message_direct_internal(fio_msg_s *msg,
   }
   FIOBJ message = FIOBJ_INVALID;
   FIOBJ pre_wrapped = FIOBJ_INVALID;
-  switch (txt) {
-  case 0:
-    pre_wrapped =
-        (FIOBJ)fio_message_metadata(msg, WEBSOCKET_OPTIMIZE_PUBSUB_BINARY);
-    break;
-  case 1:
-    pre_wrapped =
-        (FIOBJ)fio_message_metadata(msg, WEBSOCKET_OPTIMIZE_PUBSUB_TEXT);
-    break;
-  case 2:
-    pre_wrapped = (FIOBJ)fio_message_metadata(msg, WEBSOCKET_OPTIMIZE_PUBSUB);
-    break;
-  default:
-    break;
-  }
-  if (pre_wrapped) {
-    fiobj_send_free((intptr_t)msg->udata1, fiobj_dup(pre_wrapped));
-    goto finish;
+  if (!((ws_s *)pr)->is_client) {
+    /* pre-wrapping is only for client data */
+    switch (txt) {
+    case 0:
+      pre_wrapped =
+          (FIOBJ)fio_message_metadata(msg, WEBSOCKET_OPTIMIZE_PUBSUB_BINARY);
+      break;
+    case 1:
+      pre_wrapped =
+          (FIOBJ)fio_message_metadata(msg, WEBSOCKET_OPTIMIZE_PUBSUB_TEXT);
+      break;
+    case 2:
+      pre_wrapped = (FIOBJ)fio_message_metadata(msg, WEBSOCKET_OPTIMIZE_PUBSUB);
+      break;
+    default:
+      break;
+    }
+    if (pre_wrapped) {
+      // FIO_LOG_DEBUG(
+      //     "pub/sub WebSocket optimization route for pre-wrapped message.");
+      fiobj_send_free((intptr_t)msg->udata1, fiobj_dup(pre_wrapped));
+      goto finish;
+    }
   }
   if (txt == 2) {
     /* unknown text state */
     fio_str_s tmp =
-        FIO_STR_INIT_EXISTING(msg->msg.data, msg->msg.len, 0); // don't free
+        FIO_STR_INIT_STATIC2(msg->msg.data, msg->msg.len); // don't free
     txt = (tmp.len >= (2 << 14) ? 0 : fio_str_utf8_valid(&tmp));
   }
   websocket_write((ws_s *)pr, msg->msg, txt & 1);

data/lib/iodine/version.rb

@@ -1,3 +1,3 @@
 module Iodine
-  VERSION = '0.7.17'.freeze
+  VERSION = '0.7.18'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iodine
 version: !ruby/object:Gem::Version
-  version: 0.7.17
+  version: 0.7.18
 platform: ruby
 authors:
 - Boaz Segev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-17 00:00:00.000000000 Z
+date: 2019-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -220,7 +220,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 'Thank you for installing Iodine 0.7.17.
+post_install_message: 'Thank you for installing Iodine 0.7.18.
 
 '
 rdoc_options: []