sctp-socket 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 319cf8cad773727889aed0c51508d4febfa4e145f9572ef2cdc265bdfc4c6ef2
-  data.tar.gz: aa085297b675c4f8a1468d689868a25ff6e9b9f5c954324801146b3878bdb150
+  metadata.gz: 6a4c2e587ffc98a2c81d1d2a267fa4936539dc2456a9106a0146f31275e6db21
+  data.tar.gz: e5aa191fd3beb57240128ef58ef82df8f3b6beba3c25a5b357bc9b5effc7c238
 SHA512:
-  metadata.gz: a26f8069a0034447ceadd4bb5e59af079da161e4ed0d2620de9df1809e072284fa2fc7aea0799f8f1d17f2da74de744ebc4fec399f21f93e0afa713092b5e0ca
-  data.tar.gz: 5267896027a79534c91c52396528654a9f046437ccf437be392d1609fbee72980cfd18116db8e85453048976a990084321089d6159822a5453d4ba155163581f
+  metadata.gz: d023d5c17b03912812d02c8cb58279b5c874c45c481bdc1cd685dd89e8f2d62565512675d2cdc89f5e6b8107dce42634a3a1b4a063df8a6b32fed6762029adb4
+  data.tar.gz: 900e6fb83030d63453d99f9046942b2e6dfaee4340615d668669a922abc5628f58056aa464c9f36fe974ac0cccec4f3699fee7211778b6e49f49d856d7ea002d

data/.github/FUNDING.yml

@@ -0,0 +1,4 @@
+# These are supported funding model platforms
+
+github: djberg96
+open_collective: daniel-berger

data/CHANGES.md

@@ -1,3 +1,12 @@
+## 0.0.6 - 24-May-2024
+* Fixup the sendv method and add some documentation.
+* Added documentation to the get_status method.
+* Update the example server and client code, including comments for how to
+  setup multiple dummy IP addresses locally for testing.
+* Some warning cleanup and build improvements.
+* Added SCTP_BINDX constants.
+* Started adding some real specs.
+
 ## 0.0.5 - 15-Dec-2021
 * Add handling for Linux platforms that don't support the sctp_sendv function
   and/or the SCTP_SEND_FAILED_EVENT notification.

data/README.md

@@ -2,18 +2,20 @@
 
 A Ruby interface for SCTP sockets.
 
-WARNING: THIS IS CURRENTLY AN ALPHA PRODUCT. NOT RECOMMENDED FOR PRODUCTION USE AT THIS TIME.
-
 ## Prerequisites
 
 You will need the sctp development headers installed.
 
-On some systems, such as RHEL8, you may need to enable the sctp module.
+On some systems, such as RHEL8 or later, you may need to enable the sctp module.
 
 ## Installation
 
 `gem install sctp-socket`
 
+## Installing the Trusted Cert
+
+`gem cert --add <(curl -Ls https://raw.githubusercontent.com/djberg96/sctp-socket/main/certs/djberg96_pub.pem)`
+
 ## About SCTP
 
 The Stream Control Transmission Protocol (SCTP) is a message oriented, reliable
@@ -62,8 +64,7 @@ end
 Currently this has only been developed and tested on Linux. Other platforms
 will probably only be supported via community contributions.
 
-On Ubuntu 20 and possibly other Linux variants, the sendv method is not
-available. Use the sendmsg method instead.
+The sendv method is not available on some Linux variants. Use the sendmsg method instead.
 
 Please report any issues on the github project page.
 
@@ -81,7 +82,7 @@ Apache-2.0
 
 ## Copyright
 
-(C) 2020, Daniel J. Berger
+(C) 2020-2024, Daniel J. Berger
 Al Rights Reserved
 
 ## Author

data/examples/client_example.rb

@@ -1,11 +1,40 @@
 require 'socket'
 require 'sctp/socket'
 
+# Adjust as needed. Server server_example.rb for creating
+# fake network interfaces for testing.
+addresses = ['1.1.1.1', '1.1.1.2']
+
 begin
   port = 62324
   socket = SCTP::Socket.new
-  bytes_sent = socket.sendmsg(:message => "Hello World!", :addresses => ['127.0.0.1'], :port => port, :stream => 2)
-  p bytes_sent
+
+  # Optional, but could bind to a subset of available addresses
+  p socket.bind(:addresses => addresses)
+
+  # Initial connection
+  p socket.connect(:addresses => addresses, :port => port)
+
+  # Try a sendv
+  p socket.sendv(:message => ["Hello ", "World!"])
+
+  # Send messages on separate streams of the same connection
+  arr = []
+
+  0.upto(4) do |n|
+    arr << Thread.new do |t|
+      puts "Stream: #{n}"
+      bytes_sent = socket.sendmsg(
+        :message   => "Hello World: #{n+1}",
+        :addresses => addresses.shuffle,
+        :stream    => n,
+        :port      => port
+      )
+      puts "Bytes Sent: #{bytes_sent}"
+    end
+  end
+
+  arr.map(&:join)
 ensure
   socket.close if socket
 end

data/examples/server_example.rb

@@ -1,11 +1,31 @@
 require 'sctp/socket'
 
+# rake compile + ruby -Ilib to run local version
+puts "VERSION: #{SCTP::Socket::VERSION}"
+
+# To test multiple IP addresses locally:
+#
+# sudo apt install iproute2
+# Add 'dummy' to /etc/modules
+#
+# sudo ip link add dummy1 type dummy
+# sudo ip link add dummy2 type dummy
+#
+# sudo ip addr add 1.1.1.1/24 dev dummy1
+# sudo ip addr add 1.1.1.2/24 dev dummy2
+#
+# sudo ip link set dummy1 up
+# sudo ip link set dummy2 up
+
 # Adjust IP addresses as needed
+addresses = ['1.1.1.1', '1.1.1.2']
+
 begin
   port = 62324
   socket = SCTP::Socket.new
-  socket.bind(:port => port, :addresses => ['10.0.5.5', '10.0.6.5'])
+  socket.bind(:port => port, :addresses => addresses)
   socket.set_initmsg(:output_streams => 5, :input_streams => 5, :max_attempts => 4)
+  socket.subscribe(:data_io => true, :shutdown => true, :send_failure => true, :partial_delivery => true)
   socket.listen
 
   while true

data/ext/sctp/extconf.rb

@@ -1,6 +1,29 @@
 require 'mkmf'
 
-have_header('netinet/sctp.h')
+dir_config('sctp')
+
+unless have_header('netinet/sctp.h')
+  os = IO.readlines('/etc/os-release').first.split('=').last
+  msg = "\nSCTP HEADERS NOT FOUND. PLEASE INSTALL THEM FIRST LIKE SO:\n\n"
+
+  if os =~ /red|fedora|centos/i
+    msg << "#####################################################################################\n"
+    msg << "# dnf install lksctp-tools                                                          #\n"
+    msg << "# dnf install kernel-modules-extra                                                  #\n"
+    msg << "#                                                                                   #\n"
+    msg << "# sed -e '/blacklist sctp/s/^b/#b/g' -i /etc/modprobe.d/sctp-blacklist.conf         #\n"
+    msg << "# sed -e '/blacklist sctp/s/^b/#b/g' -i /etc/modprobe.d/sctp_diag-blacklist.conf    #\n"
+    msg << "#                                                                                   #\n"
+    msg << "# sudo systemctl restart systemd-modules-load.service                               #\n"
+    msg << "#####################################################################################\n"
+  else
+    msg << "sudo apt-get install libsctp-dev lksctp-tools\n\n"
+  end
+
+  warn msg
+  exit
+end
+
 have_library('sctp')
 have_func('sctp_sendv', 'netinet/sctp.h')
 have_struct_member('struct sctp_event_subscribe', 'sctp_send_failure_event', 'netinet/sctp.h')

data/ext/sctp/socket.c

@@ -26,27 +26,10 @@ VALUE v_sctp_default_send_params_struct;
 #if defined(_SC_IOV_MAX)
 #define IOV_MAX (sysconf(_SC_IOV_MAX))
 #else
-// Assume infinity, or let the syscall return with error
 #define IOV_MAX INT_MAX
 #endif
 #endif
 
-#define ARY2IOVEC(iov,ary) \
-   do { \
-      VALUE *cur; \
-      struct iovec *tmp; \
-      long n; \
-      cur = RARRAY_PTR(ary); \
-      n = RARRAY_LEN(ary); \
-      iov = tmp = alloca(sizeof(struct iovec) * n); \
-      for (; --n >= 0; tmp++, cur++) { \
-         if (TYPE(*cur) != T_STRING) \
-            rb_raise(rb_eArgError, "must be an array of strings"); \
-         tmp->iov_base = RSTRING_PTR(*cur); \
-         tmp->iov_len = RSTRING_LEN(*cur); \
-      } \
-   } while (0)
-
 // TODO: Yes, I know I need to update the signature.
 VALUE convert_sockaddr_in_to_struct(struct sockaddr_in* addr){
   char ipbuf[INET6_ADDRSTRLEN];
@@ -202,6 +185,8 @@ static VALUE rsctp_bind(int argc, VALUE* argv, VALUE self){
     port = sin.sin_port;
   }
 
+  rb_iv_set(self, "@port", INT2NUM(port));
+
   return INT2NUM(port);
 }
 
@@ -350,19 +335,58 @@ static VALUE rsctp_getlocalnames(VALUE self){
 }
 
 #ifdef HAVE_SCTP_SENDV
-static VALUE rsctp_sendv(VALUE self, VALUE v_messages){
-  struct iovec* iov;
-  struct sockaddr* addrs[8];
+/*
+ * Transmit a message to an SCTP endpoint using a gather-write. The following
+ * hash of options is permitted:
+ *
+ *  * message   - An array of strings that will be joined into a single message.
+ *  * addresses - An array of IP addresses to setup an association to send the message.
+ *  * info_type - The type of information provided. The default is SCTP_SENDV_SNDINFO.
+ *
+ *  Example:
+ *
+ *    socket = SCTP::Socket.new
+ *
+ *    socket.sendv
+ *      :message   => ['Hello ', 'World.'],
+ *      :addresses => ['10.0.5.4', '10.0.6.4'],
+ *      :info_type => SCTP::Socket:::SCTP_SENDV_SNDINFO
+ *    )
+ *
+ *  CAVEAT: Currently addresses does not work, and info_type is not yet supported.
+ *
+ *  Returns the number of bytes sent.
+ */
+static VALUE rsctp_sendv(VALUE self, VALUE v_options){
+  VALUE v_msg, v_message, v_addresses;
+  struct iovec iov[IOV_MAX];
+  struct sockaddr_in* addrs;
   struct sctp_sndinfo info;
-  int sock_fd, num_bytes, size;
+  int i, sock_fd, num_bytes, size, num_ip;
 
-  Check_Type(v_messages, T_ARRAY);
-  bzero(&addrs, sizeof(addrs));
+  Check_Type(v_options, T_HASH);
 
-  sock_fd = NUM2INT(rb_iv_get(self, "@sock_fd"));
+  bzero(&iov, sizeof(iov));
+  bzero(&info, sizeof(info));
+
+  v_message   = rb_hash_aref2(v_options, "message");
+  v_addresses = rb_hash_aref2(v_options, "addresses");
+
+  if(!NIL_P(v_message))
+    Check_Type(v_message, T_ARRAY);
+
+  if(!NIL_P(v_addresses)){
+    Check_Type(v_addresses, T_ARRAY);
+    num_ip = RARRAY_LEN(v_addresses);
+    addrs = (struct sockaddr_in*)alloca(sizeof(struct sockaddr_in) * num_ip);
+  }
+  else{
+    addrs = NULL;
+    num_ip = 0;
+  }
 
-  Check_Type(v_messages, T_ARRAY);
-  size = RARRAY_LEN(v_messages);
+  sock_fd = NUM2INT(rb_iv_get(self, "@sock_fd"));
+  size = RARRAY_LEN(v_message);
 
   if(!size)
     rb_raise(rb_eArgError, "Must contain at least one message");
@@ -370,17 +394,41 @@ static VALUE rsctp_sendv(VALUE self, VALUE v_messages){
   if(size > IOV_MAX)
     rb_raise(rb_eArgError, "Array size is greater than IOV_MAX");
 
-  ARY2IOVEC(iov, v_messages);
-
   info.snd_flags = SCTP_UNORDERED;
   info.snd_assoc_id = NUM2INT(rb_iv_get(self, "@association_id"));
 
+  if(!NIL_P(v_addresses)){
+    int i, port;
+    VALUE v_address, v_port;
+
+    v_port = NUM2INT(rb_iv_get(self, "@port"));
+
+    if(NIL_P(v_port))
+      port = 0;
+    else
+      port = NUM2INT(v_port);
+
+    for(i = 0; i < num_ip; i++){
+      v_address = RARRAY_PTR(v_addresses)[i];
+      addrs->sin_family = NUM2INT(rb_iv_get(self, "@domain"));
+      addrs->sin_port = htons(port);
+      addrs->sin_addr.s_addr = inet_addr(StringValueCStr(v_address));
+      addrs += sizeof(struct sockaddr_in);
+    }
+  }
+
+  for(i = 0; i < size; i++){
+    v_msg = RARRAY_PTR(v_message)[i];
+    iov[i].iov_base = StringValueCStr(v_msg);
+    iov[i].iov_len = RSTRING_LEN(v_msg);
+  }
+
   num_bytes = sctp_sendv(
     sock_fd,
     iov,
     size,
-    NULL,
-    0,
+    (struct sockaddr*)addrs,
+    num_ip,
     &info,
     sizeof(info),
     SCTP_SENDV_SNDINFO,
@@ -491,14 +539,14 @@ static VALUE rsctp_send(VALUE self, VALUE v_options){
  * Transmit a message to an SCTP endpoint. The following hash of options
  * is permitted:
  *
- *  :message -> The message to send to the endpoint. Mandatory.
- *  :stream  -> The SCTP stream number you wish to send the message on.
- *  :to      -> An array of addresses to send the message to.
- *  :context -> The default context used for the sendmsg call if the send fails.
- *  :ppid    -> The payload protocol identifier that is passed to the peer endpoint. 
- *  :flags   -> A bitwise integer that contain one or more values that control behavior.
+ *  :message   -> The message to send to the endpoint. Mandatory.
+ *  :stream    -> The SCTP stream number you wish to send the message on.
+ *  :addresses -> An array of addresses to send the message to.
+ *  :context   -> The default context used for the sendmsg call if the send fails.
+ *  :ppid      -> The payload protocol identifier that is passed to the peer endpoint. 
+ *  :flags     -> A bitwise integer that contain one or more values that control behavior.
  *
- *  Note that the :to option is not mandatory in a one-to-one (SOCK_STREAM)
+ *  Note that the :addresses option is not mandatory in a one-to-one (SOCK_STREAM)
  *  socket connection. However, it must have been set previously via the
  *  connect method.
  *
@@ -507,12 +555,14 @@ static VALUE rsctp_send(VALUE self, VALUE v_options){
  *    socket = SCTP::Socket.new
  *
  *    socket.sendmsg(
- *      :message => "Hello World!",
- *      :stream  => 3,
- *      :flags   => SCTP::Socket::SCTP_UNORDERED | SCTP::Socket::SCTP_SENDALL,
- *      :ttl     => 100,
- *      :to      => ['10.0.5.4', '10.0.6.4']
+ *      :message   => "Hello World!",
+ *      :stream    => 3,
+ *      :flags     => SCTP::Socket::SCTP_UNORDERED | SCTP::Socket::SCTP_SENDALL,
+ *      :ttl       => 100,
+ *      :addresses => ['10.0.5.4', '10.0.6.4']
  *    )
+ *
+ *  Returns the number of bytes sent.
  */
 static VALUE rsctp_sendmsg(VALUE self, VALUE v_options){
   VALUE v_msg, v_ppid, v_flags, v_stream, v_ttl, v_context, v_addresses;
@@ -644,7 +694,10 @@ static VALUE rsctp_recvmsg(int argc, VALUE* argv, VALUE self){
 
   sock_fd = NUM2INT(rb_iv_get(self, "@sock_fd"));
   length = sizeof(struct sockaddr_in);
+
   bzero(buffer, sizeof(buffer));
+  bzero(&clientaddr, sizeof(clientaddr));
+  bzero(&sndrcvinfo, sizeof(sndrcvinfo));
 
   bytes = sctp_recvmsg(
     sock_fd,
@@ -919,7 +972,7 @@ static VALUE rsctp_set_initmsg(VALUE self, VALUE v_options){
  *   - The peer has sent a shutdown to the local endpoint.
  *
  *   :data_io
- *   - Message data was received. On by default.
+ *   - Message data was received. You will want to subscribe to this in most cases.
  *
  *   Others:
  *
@@ -932,14 +985,12 @@ static VALUE rsctp_set_initmsg(VALUE self, VALUE v_options){
  *   :sender_dry
  *   :peer_error
  *
- * By default only data_io is subscribed to.
- *
  * Example:
  * 
  *   socket = SCTP::Socket.new
  *
  *   socket.bind(:port => port, :addresses => ['127.0.0.1'])
- *   socket.subscribe(:shutdown => true, :send_failure => true)
+ *   socket.subscribe(:data_io => true, :shutdown => true, :send_failure => true)
  */
 static VALUE rsctp_subscribe(VALUE self, VALUE v_options){
   int sock_fd;
@@ -1016,7 +1067,7 @@ static VALUE rsctp_listen(int argc, VALUE* argv, VALUE self){
   sock_fd = NUM2INT(rb_iv_get(self, "@sock_fd"));
 
   if(listen(sock_fd, backlog) < 0)
-    rb_raise(rb_eSystemCallError, "setsockopt: %s", strerror(errno));
+    rb_raise(rb_eSystemCallError, "listen: %s", strerror(errno));
   
   return self;
 }
@@ -1143,6 +1194,27 @@ static VALUE rsctp_get_retransmission_info(VALUE self){
   );
 }
 
+/*
+ * Get the status of a connected socket.
+ *
+ * Example:
+ *
+ *   socket = SCTP::Socket.new
+ *   socket.connect(...)
+ *   socket.get_status
+ *
+ * Returns a Struct::Status object, which contains the following fields:
+ *
+ *  * association_id
+ *  * state
+ *  * receive_window
+ *  * unacknowledged_data
+ *  * pending_data
+ *  * inbound_streams
+ *  * outbound_streams
+ *  * fragmentation_point
+ *  * primary (IP)
+ */
 static VALUE rsctp_get_status(VALUE self){
   int sock_fd;
   socklen_t size;
@@ -1186,7 +1258,7 @@ static VALUE rsctp_get_status(VALUE self){
   );
 }
 
-void Init_socket(){
+void Init_socket(void){
   mSCTP   = rb_define_module("SCTP");
   cSocket = rb_define_class_under(mSCTP, "Socket", rb_cObject);
 
@@ -1289,8 +1361,8 @@ void Init_socket(){
   rb_define_attr(cSocket, "association_id", 1, 1);
   rb_define_attr(cSocket, "port", 1, 1);
 
-  /* 0.0.5: The version of this library */
-  rb_define_const(cSocket, "VERSION", rb_str_new2("0.0.5"));
+  /* 0.0.6: The version of this library */
+  rb_define_const(cSocket, "VERSION", rb_str_new2("0.0.6"));
 
   /* send flags */
 
@@ -1322,4 +1394,9 @@ void Init_socket(){
   rb_define_const(cSocket, "SCTP_SHUTDOWN_SENT", INT2NUM(SCTP_SHUTDOWN_SENT));
   rb_define_const(cSocket, "SCTP_SHUTDOWN_RECEIVED", INT2NUM(SCTP_SHUTDOWN_RECEIVED));
   rb_define_const(cSocket, "SCTP_SHUTDOWN_ACK_SENT", INT2NUM(SCTP_SHUTDOWN_ACK_SENT));
+
+  // BINDING //
+
+  rb_define_const(cSocket, "SCTP_BINDX_ADD_ADDR", INT2NUM(SCTP_BINDX_ADD_ADDR));
+  rb_define_const(cSocket, "SCTP_BINDX_REM_ADDR", INT2NUM(SCTP_BINDX_REM_ADDR));
 }

data/sctp-socket.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name        = 'sctp-socket'
-  spec.version     = '0.0.5'
+  spec.version     = '0.0.6'
   spec.author      = 'Daniel Berger'
   spec.email       = 'djberg96@gmail.com'
   spec.summary     = 'Ruby bindings for SCTP sockets'
@@ -19,6 +19,16 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake-compiler', '~> 1.1'
   spec.add_development_dependency 'rspec', '~> 3.9'
 
+  spec.metadata = {
+    'homepage_uri'          => 'https://github.com/djberg96/sctp-socket',
+    'bug_tracker_uri'       => 'https://github.com/djberg96/sctp-socket/issues',
+    'changelog_uri'         => 'https://github.com/djberg96/sctp-socket/blob/main/CHANGES.md',
+    'documentation_uri'     => 'https://github.com/djberg96/sctp-socket/wiki',
+    'source_code_uri'       => 'https://github.com/djberg96/sctp-socket',
+    'wiki_uri'              => 'https://github.com/djberg96/sctp-socket/wiki',
+    'rubygems_mfa_required' => 'true'
+  }
+
   spec.description = <<-EOF
     The sctp-socket library provides Ruby bindings for SCTP sockets. is a
     message oriented, reliable transport protocol with direct support for

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sctp-socket
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Daniel Berger
@@ -35,7 +35,7 @@ cert_chain:
   ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
   WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
   -----END CERTIFICATE-----
-date: 2021-12-15 00:00:00.000000000 Z
+date: 2024-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -103,6 +103,7 @@ extensions:
 - ext/sctp/extconf.rb
 extra_rdoc_files: []
 files:
+- ".github/FUNDING.yml"
 - ".gitignore"
 - CHANGES.md
 - Gemfile
@@ -122,7 +123,14 @@ files:
 homepage: https://github.com/djberg96/sctp-socket
 licenses:
 - Apache-2.0
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/djberg96/sctp-socket
+  bug_tracker_uri: https://github.com/djberg96/sctp-socket/issues
+  changelog_uri: https://github.com/djberg96/sctp-socket/blob/main/CHANGES.md
+  documentation_uri: https://github.com/djberg96/sctp-socket/wiki
+  source_code_uri: https://github.com/djberg96/sctp-socket
+  wiki_uri: https://github.com/djberg96/sctp-socket/wiki
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -138,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.25
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for SCTP sockets