sctp-socket 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30d42e64586703d527155f2fb7582e165ce6662fa3ddecec417b9905479454ca
-  data.tar.gz: ad2fce717f7d4c42a83db6524e7323c92b1b1edf1b73058757e6689a638cc3ce
+  metadata.gz: 319cf8cad773727889aed0c51508d4febfa4e145f9572ef2cdc265bdfc4c6ef2
+  data.tar.gz: aa085297b675c4f8a1468d689868a25ff6e9b9f5c954324801146b3878bdb150
 SHA512:
-  metadata.gz: 94b319f18b44be59f7b5434ccbd9c4e2b4b1e948d9dfcf155c29c497e13059a6016a945aca04712b0b1afaa6801043450268533c758491ce118dc615d1209c4b
-  data.tar.gz: f77fd5430cc646354117a27c3a5a2064b8af11cdc7019c7400286300065eea6b107b6b7bb7796408de0f5998661c652eb16b07460b54ef25defca5a231ffa731
+  metadata.gz: a26f8069a0034447ceadd4bb5e59af079da161e4ed0d2620de9df1809e072284fa2fc7aea0799f8f1d17f2da74de744ebc4fec399f21f93e0afa713092b5e0ca
+  data.tar.gz: 5267896027a79534c91c52396528654a9f046437ccf437be392d1609fbee72980cfd18116db8e85453048976a990084321089d6159822a5453d4ba155163581f

data/.gitignore

@@ -3,3 +3,4 @@
 *.log
 *.lock
 Makefile
+tmp/

data/CHANGES.md

@@ -1,3 +1,8 @@
+## 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.
+* Some minor updates to Rakefile and Gemfile.
+
 ## 0.0.4 - 3-Dec-2020
 * Added the send method. Use this when you already have a connection.
 * Fixed a flags bug in the sendmsg method.

data/Gemfile

@@ -1,10 +1,2 @@
-source 'https://rubygems.org' do
-  group 'test' do
-    gem 'rake'
-    gem 'rspec', '~> 3.9'
-  end
-
-  group 'development' do
-    gem 'rake-compiler', '~> 1.1'
-  end
-end
+source 'https://rubygems.org'
+gemspec

data/README.md

@@ -12,7 +12,7 @@ On some systems, such as RHEL8, you may need to enable the sctp module.
 
 ## Installation
 
-  `gem install sctp-socket`
+`gem install sctp-socket`
 
 ## About SCTP
 
@@ -30,7 +30,7 @@ is applied to correct loss or corruption of data.
 
 ## Synopsis
 
-```
+```ruby
 # sample_server.rb
 require 'sctp/socket'
 
@@ -62,10 +62,19 @@ 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.
+
 Please report any issues on the github project page.
 
   https://github.com/djberg96/sctp-socket
 
+## More Information on SCTP
+
+* https://www.linuxjournal.com/article/9748
+* https://www.linuxjournal.com/article/9749
+* https://www.linuxjournal.com/article/9784
+
 ## License
 
 Apache-2.0

data/Rakefile

@@ -6,20 +6,21 @@ require 'rake/extensiontask'
 include RbConfig
 
 CLEAN.include(
-  '**/*.gem',               # Gem files
-  '**/*.rbc',               # Rubinius
-  '**/*.o',                 # C object file
-  '**/*.log',               # Ruby extension build log
-  '**/Makefile',            # C Makefile
-  '**/conftest.dSYM',       # OS X build directory
-  "**/*.#{CONFIG['DLEXT']}" # C shared object
+  '**/*.gem',                # Gem files
+  '**/*.rbc',                # Rubinius
+  '**/*.o',                  # C object file
+  '**/*.log',                # Ruby extension build log
+  '**/Makefile',             # C Makefile
+  '**/conftest.dSYM',        # OS X build directory
+  "**/*.#{CONFIG['DLEXT']}", # C shared object
+  'tmp'                      # Rake compiler
 )
 
 namespace :gem do
   desc "Create the sys-uname gem"
   task :create => [:clean] do
     require 'rubygems/package'
-    spec = eval(IO.read('sctp-socket.gemspec'))
+    spec = Gem::Specification.load('sctp-socket.gemspec')
     spec.signing_key = File.join(Dir.home, '.ssh', 'gem-private_key.pem')
     Gem::Package.build(spec)
   end
@@ -39,4 +40,4 @@ end
 RSpec::Core::RakeTask.new
 
 task :spec => :compile
-task :default => :spec
+task :default => [:clean, :spec]

data/ext/sctp/extconf.rb

@@ -2,4 +2,6 @@ require 'mkmf'
 
 have_header('netinet/sctp.h')
 have_library('sctp')
+have_func('sctp_sendv', 'netinet/sctp.h')
+have_struct_member('struct sctp_event_subscribe', 'sctp_send_failure_event', 'netinet/sctp.h')
 create_makefile('sctp/socket')

data/ext/sctp/socket.c

@@ -17,11 +17,44 @@ VALUE v_adaptation_event_struct;
 VALUE v_partial_delivery_event_struct;
 VALUE v_auth_event_struct;
 VALUE v_sockaddr_in_struct;
-
+VALUE v_sctp_status_struct;
+VALUE v_sctp_rtoinfo_struct;
+VALUE v_sctp_associnfo_struct;
+VALUE v_sctp_default_send_params_struct;
+
+#if !defined(IOV_MAX)
+#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[16];
+  char ipbuf[INET6_ADDRSTRLEN];
 
-  inet_ntop(addr->sin_family, &(((struct sockaddr_in *)addr)->sin_addr), ipbuf, sizeof(ipbuf));
+  if(addr->sin_family == AF_INET6)
+    inet_ntop(addr->sin_family, &(((struct sockaddr_in6 *)addr)->sin6_addr), ipbuf, sizeof(ipbuf));
+  else
+    inet_ntop(addr->sin_family, &(((struct sockaddr_in *)addr)->sin_addr), ipbuf, sizeof(ipbuf));
 
   return rb_struct_new(v_sockaddr_in_struct,
     INT2NUM(addr->sin_family),
@@ -316,6 +349,51 @@ static VALUE rsctp_getlocalnames(VALUE self){
   return v_array;
 }
 
+#ifdef HAVE_SCTP_SENDV
+static VALUE rsctp_sendv(VALUE self, VALUE v_messages){
+  struct iovec* iov;
+  struct sockaddr* addrs[8];
+  struct sctp_sndinfo info;
+  int sock_fd, num_bytes, size;
+
+  Check_Type(v_messages, T_ARRAY);
+  bzero(&addrs, sizeof(addrs));
+
+  sock_fd = NUM2INT(rb_iv_get(self, "@sock_fd"));
+
+  Check_Type(v_messages, T_ARRAY);
+  size = RARRAY_LEN(v_messages);
+
+  if(!size)
+    rb_raise(rb_eArgError, "Must contain at least one message");
+
+  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"));
+
+  num_bytes = sctp_sendv(
+    sock_fd,
+    iov,
+    size,
+    NULL,
+    0,
+    &info,
+    sizeof(info),
+    SCTP_SENDV_SNDINFO,
+    0
+  );
+
+  if(num_bytes < 0)
+    rb_raise(rb_eSystemCallError, "sctp_sendv: %s", strerror(errno));
+
+  return INT2NUM(num_bytes);
+}
+#endif
+
 /*
  * Send a message on an already-connected socket to a specific association.
  *
@@ -678,6 +756,7 @@ static VALUE rsctp_recvmsg(int argc, VALUE* argv, VALUE self){
           rb_ary_new4(snp->sn_remote_error.sre_length, v_temp)
         );
         break;
+#ifdef SCTP_SEND_FAILED_EVENT
       case SCTP_SEND_FAILED_EVENT:
         v_temp = ALLOCA_N(VALUE, snp->sn_send_failed_event.ssf_length);
 
@@ -700,6 +779,24 @@ static VALUE rsctp_recvmsg(int argc, VALUE* argv, VALUE self){
           rb_ary_new4(snp->sn_send_failed_event.ssf_length, v_temp)
         );
         break;
+#else
+      case SCTP_SEND_FAILED:
+        v_temp = ALLOCA_N(VALUE, snp->sn_send_failed.ssf_length);
+
+        for(i = 0; i < snp->sn_send_failed.ssf_length; i++){
+          v_temp[i] = UINT2NUM(snp->sn_send_failed.ssf_data[i]);
+        }
+
+        v_notification = rb_struct_new(v_send_failed_event_struct,
+          UINT2NUM(snp->sn_send_failed.ssf_type),
+          UINT2NUM(snp->sn_send_failed.ssf_length),
+          UINT2NUM(snp->sn_send_failed.ssf_error),
+          Qnil,
+          UINT2NUM(snp->sn_send_failed.ssf_assoc_id),
+          rb_ary_new4(snp->sn_send_failed.ssf_length, v_temp)
+        );
+        break;
+#endif
       case SCTP_SHUTDOWN_EVENT:
         v_notification = rb_struct_new(v_shutdown_event_struct,
           UINT2NUM(snp->sn_shutdown_event.sse_type),
@@ -860,9 +957,12 @@ static VALUE rsctp_subscribe(VALUE self, VALUE v_options){
   if(RTEST(rb_hash_aref2(v_options, "address")))
     events.sctp_address_event = 1;
 
-  // Use the new version
   if(RTEST(rb_hash_aref2(v_options, "send_failure")))
+#ifdef HAVE_STRUCT_SCTP_EVENT_SUBSCRIBE_SCTP_SEND_FAILURE_EVENT
+    events.sctp_send_failure_event = 1;
+#else
     events.sctp_send_failure_event_event = 1;
+#endif
 
   if(RTEST(rb_hash_aref2(v_options, "peer_error")))
     events.sctp_peer_error_event = 1;
@@ -942,6 +1042,61 @@ static VALUE rsctp_peeloff(VALUE self, VALUE v_assoc_id){
   return self;
 }
 
+static VALUE rsctp_get_default_send_params(VALUE self){
+  int sock_fd;
+  socklen_t size;
+  sctp_assoc_t assoc_id;
+  struct sctp_sndrcvinfo sndrcv;
+
+  bzero(&sndrcv, sizeof(sndrcv));
+
+  sock_fd = NUM2INT(rb_iv_get(self, "@sock_fd"));
+  assoc_id = NUM2INT(rb_iv_get(self, "@association_id"));
+  size = sizeof(struct sctp_sndrcvinfo);
+
+  if(sctp_opt_info(sock_fd, assoc_id, SCTP_DEFAULT_SEND_PARAM, (void*)&sndrcv, &size) < 0)
+    rb_raise(rb_eSystemCallError, "sctp_opt_info: %s", strerror(errno));
+
+  return rb_struct_new(
+    v_sctp_default_send_params_struct,
+    INT2NUM(sndrcv.sinfo_stream),
+    INT2NUM(sndrcv.sinfo_ssn),
+    INT2NUM(sndrcv.sinfo_flags),
+    INT2NUM(sndrcv.sinfo_ppid),
+    INT2NUM(sndrcv.sinfo_context),
+    INT2NUM(sndrcv.sinfo_timetolive),
+    INT2NUM(sndrcv.sinfo_tsn),
+    INT2NUM(sndrcv.sinfo_cumtsn),
+    INT2NUM(sndrcv.sinfo_assoc_id)
+  );
+}
+
+static VALUE rsctp_get_association_info(VALUE self){
+  int sock_fd;
+  socklen_t size;
+  sctp_assoc_t assoc_id;
+  struct sctp_assocparams assoc;
+
+  bzero(&assoc, sizeof(assoc));
+
+  sock_fd = NUM2INT(rb_iv_get(self, "@sock_fd"));
+  assoc_id = NUM2INT(rb_iv_get(self, "@association_id"));
+  size = sizeof(struct sctp_assocparams);
+
+  if(sctp_opt_info(sock_fd, assoc_id, SCTP_ASSOCINFO, (void*)&assoc, &size) < 0)
+    rb_raise(rb_eSystemCallError, "sctp_opt_info: %s", strerror(errno));
+
+  return rb_struct_new(
+    v_sctp_associnfo_struct,
+    INT2NUM(assoc.sasoc_assoc_id),
+    INT2NUM(assoc.sasoc_asocmaxrxt),
+    INT2NUM(assoc.sasoc_number_peer_destinations),
+    INT2NUM(assoc.sasoc_peer_rwnd),
+    INT2NUM(assoc.sasoc_local_rwnd),
+    INT2NUM(assoc.sasoc_cookie_life)
+  );
+}
+
 static VALUE rsctp_shutdown(int argc, VALUE* argv, VALUE self){
   int how, sock_fd;
   VALUE v_how;
@@ -964,6 +1119,73 @@ static VALUE rsctp_shutdown(int argc, VALUE* argv, VALUE self){
   return self;
 }
 
+static VALUE rsctp_get_retransmission_info(VALUE self){
+  int sock_fd;
+  socklen_t size;
+  sctp_assoc_t assoc_id;
+  struct sctp_rtoinfo rto;
+
+  bzero(&rto, sizeof(rto));
+
+  sock_fd = NUM2INT(rb_iv_get(self, "@sock_fd"));
+  assoc_id = NUM2INT(rb_iv_get(self, "@association_id"));
+  size = sizeof(struct sctp_rtoinfo);
+
+  if(sctp_opt_info(sock_fd, assoc_id, SCTP_RTOINFO, (void*)&rto, &size) < 0)
+    rb_raise(rb_eSystemCallError, "sctp_opt_info: %s", strerror(errno));
+
+  return rb_struct_new(
+    v_sctp_rtoinfo_struct,
+    INT2NUM(rto.srto_assoc_id),
+    INT2NUM(rto.srto_initial),
+    INT2NUM(rto.srto_max),
+    INT2NUM(rto.srto_min)
+  );
+}
+
+static VALUE rsctp_get_status(VALUE self){
+  int sock_fd;
+  socklen_t size;
+  sctp_assoc_t assoc_id;
+  struct sctp_status status;
+  struct sctp_paddrinfo* spinfo;
+  char tmpname[INET_ADDRSTRLEN];
+
+  bzero(&status, sizeof(status));
+
+  sock_fd = NUM2INT(rb_iv_get(self, "@sock_fd"));
+  assoc_id = NUM2INT(rb_iv_get(self, "@association_id"));
+  size = sizeof(struct sctp_status);
+
+  if(sctp_opt_info(sock_fd, assoc_id, SCTP_STATUS, (void*)&status, &size) < 0)
+    rb_raise(rb_eSystemCallError, "sctp_opt_info: %s", strerror(errno));
+
+  spinfo = &status.sstat_primary;
+
+  if (spinfo->spinfo_address.ss_family == AF_INET6) {
+		struct sockaddr_in6 *sin6;
+		sin6 = (struct sockaddr_in6 *)&spinfo->spinfo_address;
+		inet_ntop(AF_INET6, &sin6->sin6_addr, tmpname, sizeof (tmpname));
+	}
+  else {
+		struct sockaddr_in *sin;
+		sin = (struct sockaddr_in *)&spinfo->spinfo_address;
+		inet_ntop(AF_INET, &sin->sin_addr, tmpname, sizeof (tmpname));
+  }
+
+  return rb_struct_new(v_sctp_status_struct,
+    INT2NUM(status.sstat_assoc_id),
+    INT2NUM(status.sstat_state),
+    INT2NUM(status.sstat_rwnd),
+    INT2NUM(status.sstat_unackdata),
+    INT2NUM(status.sstat_penddata),
+    INT2NUM(status.sstat_instrms),
+    INT2NUM(status.sstat_outstrms),
+    INT2NUM(status.sstat_fragmentation_point),
+    rb_str_new2(tmpname)
+  );
+}
+
 void Init_socket(){
   mSCTP   = rb_define_module("SCTP");
   cSocket = rb_define_class_under(mSCTP, "Socket", rb_cObject);
@@ -1016,6 +1238,26 @@ void Init_socket(){
     "SockAddrIn", "family", "port", "address", NULL
   );
 
+  v_sctp_status_struct = rb_struct_define(
+    "Status", "association_id", "state", "receive_window", "unacknowledged_data",
+    "pending_data", "inbound_streams", "outbound_streams", "fragmentation_point", "primary", NULL
+  );
+
+  v_sctp_rtoinfo_struct = rb_struct_define(
+    "RetransmissionInfo", "association_id", "initial", "max", "min", NULL
+  );
+
+  v_sctp_associnfo_struct = rb_struct_define(
+    "AssociationInfo", "association_id", "max_retransmission_count",
+    "number_peer_destinations", "peer_receive_window", "local_receive_window",
+    "cookie_life", NULL
+  );
+
+  v_sctp_default_send_params_struct = rb_struct_define(
+    "DefaultSendParams", "stream", "ssn", "flags", "ppid", "context",
+    "ttl", "tsn", "cumtsn", "association_id", NULL
+  );
+
   rb_define_method(cSocket, "initialize", rsctp_init, -1);
 
   rb_define_method(cSocket, "bind", rsctp_bind, -1);
@@ -1023,10 +1265,19 @@ void Init_socket(){
   rb_define_method(cSocket, "connect", rsctp_connect, -1);
   rb_define_method(cSocket, "getpeernames", rsctp_getpeernames, 0);
   rb_define_method(cSocket, "getlocalnames", rsctp_getlocalnames, 0);
+  rb_define_method(cSocket, "get_status", rsctp_get_status, 0);
+  rb_define_method(cSocket, "get_default_send_params", rsctp_get_default_send_params, 0);
+  rb_define_method(cSocket, "get_retransmission_info", rsctp_get_retransmission_info, 0);
+  rb_define_method(cSocket, "get_association_info", rsctp_get_association_info, 0);
   rb_define_method(cSocket, "listen", rsctp_listen, -1);
   rb_define_method(cSocket, "peeloff!", rsctp_peeloff, 1);
   rb_define_method(cSocket, "recvmsg", rsctp_recvmsg, -1);
   rb_define_method(cSocket, "send", rsctp_send, 1);
+
+#ifdef HAVE_SCTP_SENDV
+  rb_define_method(cSocket, "sendv", rsctp_sendv, 1);
+#endif
+
   rb_define_method(cSocket, "sendmsg", rsctp_sendmsg, 1);
   rb_define_method(cSocket, "set_initmsg", rsctp_set_initmsg, 1);
   rb_define_method(cSocket, "shutdown", rsctp_shutdown, -1);
@@ -1038,8 +1289,8 @@ void Init_socket(){
   rb_define_attr(cSocket, "association_id", 1, 1);
   rb_define_attr(cSocket, "port", 1, 1);
 
-  /* 0.0.4: The version of this library */
-  rb_define_const(cSocket, "VERSION", rb_str_new2("0.0.4"));
+  /* 0.0.5: The version of this library */
+  rb_define_const(cSocket, "VERSION", rb_str_new2("0.0.5"));
 
   /* send flags */
 
@@ -1059,4 +1310,16 @@ void Init_socket(){
   rb_define_const(cSocket, "SCTP_SENDALL", INT2NUM(SCTP_SENDALL));
 
   rb_define_const(cSocket, "MSG_NOTIFICATION", INT2NUM(MSG_NOTIFICATION));
+
+  // ASSOCIATION STATES //
+
+  rb_define_const(cSocket, "SCTP_EMPTY", INT2NUM(SCTP_EMPTY));
+  rb_define_const(cSocket, "SCTP_CLOSED", INT2NUM(SCTP_CLOSED));
+  rb_define_const(cSocket, "SCTP_COOKIE_WAIT", INT2NUM(SCTP_COOKIE_WAIT));
+  rb_define_const(cSocket, "SCTP_COOKIE_ECHOED", INT2NUM(SCTP_COOKIE_ECHOED));
+  rb_define_const(cSocket, "SCTP_ESTABLISHED", INT2NUM(SCTP_ESTABLISHED));
+  rb_define_const(cSocket, "SCTP_SHUTDOWN_PENDING", INT2NUM(SCTP_SHUTDOWN_PENDING));
+  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));
 }

data/sctp-socket.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name        = 'sctp-socket'
-  spec.version     = '0.0.4'
+  spec.version     = '0.0.5'
   spec.author      = 'Daniel Berger'
   spec.email       = 'djberg96@gmail.com'
   spec.summary     = 'Ruby bindings for SCTP sockets'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sctp-socket
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Daniel Berger
@@ -35,7 +35,7 @@ cert_chain:
   ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
   WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
   -----END CERTIFICATE-----
-date: 2020-12-03 00:00:00.000000000 Z
+date: 2021-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -138,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.2.25
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for SCTP sockets