sctp-socket 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89d20d26ad8e90c5673d4d126da8daa8f69d907a54ba0ddc9caf529ef5929c6e
-  data.tar.gz: 886d28171c2e7242a7875b7a998e7073a9bec469da7da5b9205859a4e2d3e257
+  metadata.gz: 9a53fb8e5953dbf9ca5c45e273ab45d4982ade9ec4b77e44657cd826757fb8ef
+  data.tar.gz: 8d3aa7a1087c0f348cf25d8dde354fcb5bfba61b7a9c6db78cf60922496bf983
 SHA512:
-  metadata.gz: ee23fbff8da2e3efa66f87f583ba1f631d39957a6f74bff530d1b71ae1a15ab773ecb6653f34d8d5e17e034a15f6a736c90a16f3c8f3ed636734ab674dee54ca
-  data.tar.gz: 68ff54d9088bfe723f0726c3bcc41c102aab7c3f631f1156f64651bd078ffa1a852b247505a4babf36cb37c61aa11726587db407ad34171c974b6afca96283a8
+  metadata.gz: 8e23832cbb9cc0b8741ef696ed97aa494c17a12cc22bbf2b6eeaaab401cd654efb9b9966913557d2d442ae694e698c081c147d6b448d88876efecc831254c0d7
+  data.tar.gz: 17617bb21948741bc3397c9528bf283c5a07ec6bc06b57f7db17b925236025738cbe72390d7cb9ceb791d4b992ecba438d0a5ef3752baffc1d3b676fff5c719c

data/.github/workflows/ruby.yml

@@ -35,3 +35,25 @@ jobs:
         bundler-cache: true
     - name: Run Specs
       run: bundle exec rake
+  freebsd:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Test in FreeBSD
+      id: test
+      uses: vmactions/freebsd-vm@v1
+      with:
+        usesh: true
+        prepare: |
+          pkg install -y llvm ruby devel/ruby-gems sctplib git-tiny
+
+        run: |
+          git config --global --add safe.directory /home/runner/work/sctp-socket/sctp-socket
+          kldload sctp
+          ifconfig lo1 create
+          ifconfig lo1 1.1.1.1/24 up
+          ifconfig lo2 create
+          ifconfig lo2 1.1.1.2/24 up
+          gem install bundler --no-document
+          bundle install --quiet
+          bundle exec rake

data/CHANGES.md

@@ -1,3 +1,14 @@
+## 0.1.4 - 1-Feb-2025
+* Added the set_retransmission_info method.
+* Added the get_rto_info and set_rto_info aliases.
+* Added the set_association_info method.
+* Some spec updates and refactoring.
+
+## 0.1.3 - 22-Jan-2025
+* The close method now accepts an optional `linger` argument.
+* The bindx method now accepts an optional `reuse_addr` argument.
+* Fixed a bug in the bindx method for address arrays with a single element.
+
 ## 0.1.2 - 10-Jan-2025
 * Added support for BSD.
 

data/README.md

@@ -67,7 +67,7 @@ Currently this has only been developed and tested on Linux and BSD. Other
 platforms will probably only be supported via community contributions.
 
 The sendv and recvv methods may not be available. Use the sendmsg and recvmsg
-methods instead.
+methods instead if that's the case.
 
 I am currently unable to subclass the Socket class from Ruby's standard library.
 For whatever reason the call to rb_call_super works, but the fileno is always

data/Rakefile

@@ -39,13 +39,21 @@ end
 
 desc "Create dummy IP addresses to use for testing"
 task :create_dummy_links do
-  system('sudo ip link add dummy1 type dummy')
-  system('sudo ip link add dummy2 type dummy')
-  system('sudo ip addr add 1.1.1.1/24 dev dummy1')
-  system('sudo ip addr add 1.1.1.2/24 dev dummy2')
-  system('sudo ip link set dummy1 up')
-  system('sudo ip link set dummy2 up')
-  system('ip link show')
+  if RbConfig::CONFIG['host_os'] =~ /linux/i
+    system('sudo ip link add dummy1 type dummy')
+    system('sudo ip link add dummy2 type dummy')
+    system('sudo ip addr add 1.1.1.1/24 dev dummy1')
+    system('sudo ip addr add 1.1.1.2/24 dev dummy2')
+    system('sudo ip link set dummy1 up')
+    system('sudo ip link set dummy2 up')
+    system('ip link show')
+  else
+    system("sudo ifconfig lo1 create")
+    system("sudo ifconfig lo1 1.1.1.1/24 up")
+    system("sudo ifconfig lo2 create")
+    system("sudo ifconfig lo2 1.1.1.2/24 up")
+    system("sudo ifconfig -a")
+  end
 end
 
 RSpec::Core::RakeTask.new

data/examples/client_example.rb

@@ -10,7 +10,7 @@ begin
   socket = SCTP::Socket.new
 
   # Optional, but could bind to a subset of available addresses
-  p socket.bindx(:addresses => addresses)
+  # p socket.bindx(:addresses => addresses)
 
   # Initial connection
   p socket.connectx(:addresses => addresses, :port => port)

data/examples/server_example.rb

@@ -30,6 +30,7 @@ begin
 
   while true
     info = socket.recvmsg
+    # info = socket.recvv # Or this
     p info
   end
 ensure

data/ext/sctp/socket.c

@@ -335,11 +335,28 @@ static VALUE rsctp_init(int argc, VALUE* argv, VALUE self){
  *
  * Bind a subset of IP addresses associated with the host system on the
  * given port, or a port assigned by the operating system if none is provided.
+ * You may bind a maximum of eight IP addresses.
  *
  * Note that you can both add or remove an address to or from the socket
  * using the SCTP_BINDX_ADD_ADDR (default) or SCTP_BINDX_REM_ADDR constants,
  * respectively.
  *
+ * Possible options:
+ *
+ * * addresses - Array of IP addresses to bind to. If none are specified then
+ *     INADDR_ANY is used.
+ *
+ * * port - The port to bind to. If none is specified then 0 is used, i.e. the
+ *     OS will select one for you.
+ *
+ * * flags - Flags to pass to the underlying sctp_bindx function. In practice
+ *     there are only two options: BINDX_ADD_ADDR and BINDX_REM_ADDR. By
+ *     default a flag of BINDX_ADD_ADDR is assumed.
+ *
+ * * reuse_addr - If set to true, then the SO_REUSEADDR flag will be applied to
+ *     the socket before the bind call. This will allow other sockets to reuse
+ *     the addresses that are currently bound to the socket.
+ *
  * Example:
  *
  *   socket = SCTP::Socket.new
@@ -357,8 +374,8 @@ static VALUE rsctp_init(int argc, VALUE* argv, VALUE self){
  */
 static VALUE rsctp_bindx(int argc, VALUE* argv, VALUE self){
   struct sockaddr_in addrs[8];
-  int i, fileno, num_ip, flags, domain, port;
-  VALUE v_addresses, v_port, v_flags, v_address, v_options;
+  int i, fileno, num_ip, flags, domain, port, on;
+  VALUE v_addresses, v_port, v_flags, v_address, v_reuse_addr, v_options;
 
   rb_scan_args(argc, argv, "01", &v_options);
 
@@ -370,6 +387,7 @@ static VALUE rsctp_bindx(int argc, VALUE* argv, VALUE self){
   v_addresses = rb_hash_aref2(v_options, "addresses");
   v_flags = rb_hash_aref2(v_options, "flags");
   v_port = rb_hash_aref2(v_options, "port");
+  v_reuse_addr = rb_hash_aref2(v_options, "reuse_addr");
 
   if(NIL_P(v_port))
     port = 0;
@@ -386,10 +404,13 @@ static VALUE rsctp_bindx(int argc, VALUE* argv, VALUE self){
   else
     num_ip = (int)RARRAY_LEN(v_addresses);
 
+  if(num_ip > 8)
+    rb_raise(rb_eArgError, "too many IP addresses to bind, maximum is eight");
+
   domain = NUM2INT(rb_iv_get(self, "@domain"));
   fileno = NUM2INT(rb_iv_get(self, "@fileno"));
 
-  if(num_ip > 1){
+  if(!NIL_P(v_addresses)){
     for(i = 0; i < num_ip; i++){
       v_address = RARRAY_PTR(v_addresses)[i];
       addrs[i].sin_family = domain;
@@ -409,6 +430,12 @@ static VALUE rsctp_bindx(int argc, VALUE* argv, VALUE self){
 #endif
   }
 
+  if(v_reuse_addr == Qtrue){
+    on = 1;
+    if(setsockopt(fileno, SOL_SOCKET, SO_REUSEADDR, &on, sizeof(on)) < 0)
+      rb_raise(rb_eSystemCallError, "setsockopt: %s", strerror(errno));
+  }
+
   if(sctp_bindx(fileno, (struct sockaddr *) addrs, num_ip, flags) != 0)
     rb_raise(rb_eSystemCallError, "sctp_bindx: %s", strerror(errno));
 
@@ -497,15 +524,46 @@ static VALUE rsctp_connectx(int argc, VALUE* argv, VALUE self){
  *
  * Close the socket. You should always do this.
  *
+ * By default the underlying close operation is non-blocking. This means that the
+ * bound IP addresses may not be available right away after closing. You may
+ * optionally control this behavior with the +linger+ option.
+ *
+ *
+ * * linger - If present, this should be set to a numeric value, in seconds.
+ *     The value will cause the close operation to block for that number of
+ *     seconds, after which it will return (i.e. return to non-blocking).
+ *
  * Example:
  *
  *   socket = SCTP::Socket.new
- *   socket.close
+ *   socket.close # or
+ *   socket.close(linger: 5)
  */
-static VALUE rsctp_close(VALUE self){
-  VALUE v_fileno = rb_iv_get(self, "@fileno");
+static VALUE rsctp_close(int argc, VALUE* argv, VALUE self){
+  VALUE v_options, v_linger;
+  int fileno;
 
-  if(close(NUM2INT(v_fileno)))
+  rb_scan_args(argc, argv, "01", &v_options);
+
+  if(NIL_P(v_options))
+    v_options = rb_hash_new();
+
+  Check_Type(v_options, T_HASH);
+
+  v_linger = rb_hash_aref2(v_options, "linger");
+
+  fileno = NUM2INT(rb_iv_get(self, "@fileno"));
+
+  if(!NIL_P(v_linger)){
+    struct linger lin;
+    lin.l_onoff = 1;
+    lin.l_linger = NUM2INT(v_linger);
+
+    if(setsockopt(fileno, SOL_SOCKET, SO_LINGER, &lin, sizeof(struct linger)) < 0)
+      rb_raise(rb_eSystemCallError, "setsockopt: %s", strerror(errno));
+  }
+
+  if(close(fileno))
     rb_raise(rb_eSystemCallError, "close: %s", strerror(errno));
 
   return self;
@@ -695,6 +753,7 @@ static VALUE rsctp_sendv(VALUE self, VALUE v_options){
     rb_raise(rb_eArgError, "Array size is greater than IOV_MAX");
 
   // TODO: Make this configurable
+  spa.sendv_flags = SCTP_SEND_SNDINFO_VALID;
   spa.sendv_sndinfo.snd_flags = SCTP_UNORDERED;
   spa.sendv_sndinfo.snd_assoc_id = NUM2INT(rb_iv_get(self, "@association_id"));
 
@@ -1469,6 +1528,75 @@ static VALUE rsctp_get_association_info(VALUE self){
   );
 }
 
+/*
+ * call-seq:
+ *    SCTP::Socket#set_association_info(options)
+ *
+ * Sets the association specific parameters. The +options+ parameter
+ * is a hash that accepts the following keywords:
+ *
+ *  * association_id
+ *  * max_retransmission_count
+ *  * number_peer_destinations
+ *  * peer_receive_window
+ *  * local_receive_window
+ *  * cookie_life
+ *
+ *  All values that refer to time values are measured in milliseconds.
+ */
+static VALUE rsctp_set_association_info(VALUE self, VALUE v_options){
+  VALUE v_assoc_id, v_max_rxt, v_nbr_peer, v_peer_rw, v_local_rw, v_cookie;
+  int fileno;
+  sctp_assoc_t assoc_id;
+  struct sctp_assocparams assoc;
+
+  bzero(&assoc, sizeof(assoc));
+
+  fileno = NUM2INT(rb_iv_get(self, "@fileno"));
+
+  v_assoc_id = rb_hash_aref2(v_options, "association_id");
+  v_max_rxt  = rb_hash_aref2(v_options, "max_retransmission_count");
+  v_nbr_peer = rb_hash_aref2(v_options, "number_peer_destinations");
+  v_peer_rw  = rb_hash_aref2(v_options, "peer_receive_window");
+  v_local_rw = rb_hash_aref2(v_options, "local_receive_window");
+  v_cookie   = rb_hash_aref2(v_options, "cookie_life");
+
+  if(NIL_P(v_assoc_id))
+    assoc_id = NUM2INT(rb_iv_get(self, "@association_id"));
+  else
+    assoc_id = NUM2INT(v_assoc_id);
+
+  assoc.sasoc_assoc_id = assoc_id;
+
+  if(!NIL_P(v_max_rxt))
+    assoc.sasoc_asocmaxrxt = NUM2INT(v_max_rxt);
+
+  if(!NIL_P(v_nbr_peer))
+    assoc.sasoc_number_peer_destinations = NUM2INT(v_nbr_peer);
+
+  if(!NIL_P(v_peer_rw))
+    assoc.sasoc_peer_rwnd = NUM2INT(v_peer_rw);
+
+  if(!NIL_P(v_local_rw))
+    assoc.sasoc_local_rwnd = NUM2INT(v_local_rw);
+
+  if(!NIL_P(v_cookie))
+    assoc.sasoc_cookie_life = NUM2INT(v_cookie);
+
+  if(setsockopt(fileno, IPPROTO_SCTP, SCTP_ASSOCINFO, &assoc, sizeof(assoc)) < 0)
+    rb_raise(rb_eSystemCallError, "setsockopt: %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)
+  );
+}
+
 /*
  * call-seq:
  *    SCTP::Socket#shutdown
@@ -1543,6 +1671,64 @@ static VALUE rsctp_get_retransmission_info(VALUE self){
   );
 }
 
+/*
+ * call-seq:
+ *    SCTP::Socket#set_retransmission_info(options)
+ *
+ * Sets the protocol parameters that are used to initialize and bind the
+ * retransmission timeout (RTO) tunable. The method accepts a hash with
+ * the following possible keys:
+ *
+ *  * association_id
+ *  * initial
+ *  * max
+ *  * min
+ *
+ *  The +initial+, +max+ and +min+ options default to zero (unchanged).
+ */
+static VALUE rsctp_set_retransmission_info(VALUE self, VALUE v_options){
+  VALUE v_assoc_id, v_initial, v_max, v_min;
+  int fileno;
+  sctp_assoc_t assoc_id;
+  struct sctp_rtoinfo rto;
+
+  bzero(&rto, sizeof(rto));
+
+  fileno = NUM2INT(rb_iv_get(self, "@fileno"));
+
+  v_assoc_id = rb_hash_aref2(v_options, "association_id");
+  v_initial = rb_hash_aref2(v_options, "initial");
+  v_max = rb_hash_aref2(v_options, "max");
+  v_min = rb_hash_aref2(v_options, "min");
+
+  if(NIL_P(v_assoc_id))
+    v_assoc_id = rb_iv_get(self, "@association_id");
+
+  assoc_id = NUM2INT(v_assoc_id);
+
+  rto.srto_assoc_id = assoc_id;
+
+  if(!NIL_P(v_initial))
+    rto.srto_initial = NUM2INT(v_initial);
+
+  if(!NIL_P(v_max))
+    rto.srto_max = NUM2INT(v_max);
+
+  if(!NIL_P(v_min))
+    rto.srto_min = NUM2INT(v_min);
+
+  if(setsockopt(fileno, IPPROTO_SCTP, SCTP_RTOINFO, &rto, sizeof(rto)) < 0)
+    rb_raise(rb_eSystemCallError, "setsockopt: %s", strerror(errno));
+
+  return rb_struct_new(
+    v_sctp_rtoinfo_struct,
+    v_assoc_id,
+    v_initial,
+    v_max,
+    v_min
+  );
+}
+
 /*
  * call-seq:
  *    SCTP::Socket#get_status
@@ -2298,7 +2484,7 @@ void Init_socket(void){
 
   rb_define_method(cSocket, "autoclose=", rsctp_set_autoclose, 1);
   rb_define_method(cSocket, "bindx", rsctp_bindx, -1);
-  rb_define_method(cSocket, "close", rsctp_close, 0);
+  rb_define_method(cSocket, "close", rsctp_close, -1);
   rb_define_method(cSocket, "connectx", rsctp_connectx, -1);
   rb_define_method(cSocket, "delete_shared_key", rsctp_delete_shared_key, -1);
   rb_define_method(cSocket, "disable_fragments=", rsctp_disable_fragments, 1);
@@ -2332,20 +2518,24 @@ void Init_socket(void){
 
   rb_define_method(cSocket, "sendmsg", rsctp_sendmsg, 1);
   rb_define_method(cSocket, "set_active_shared_key", rsctp_set_active_shared_key, -1);
+  rb_define_method(cSocket, "set_association_info", rsctp_set_association_info, 1);
   rb_define_method(cSocket, "set_initmsg", rsctp_set_initmsg, 1);
-  //rb_define_method(cSocket, "set_retransmission_info", rsctp_set_retransmission_info, -1);
+  rb_define_method(cSocket, "set_retransmission_info", rsctp_set_retransmission_info, 1);
   rb_define_method(cSocket, "set_shared_key", rsctp_set_shared_key, -1);
   rb_define_method(cSocket, "shutdown", rsctp_shutdown, -1);
   rb_define_method(cSocket, "subscribe", rsctp_subscribe, 1);
 
+  rb_define_alias(cSocket, "get_rto_info", "get_retransmission_info");
+  rb_define_alias(cSocket, "set_rto_info", "set_retransmission_info");
+
   rb_define_attr(cSocket, "domain", 1, 1);
   rb_define_attr(cSocket, "type", 1, 1);
   rb_define_attr(cSocket, "fileno", 1, 1);
   rb_define_attr(cSocket, "association_id", 1, 1);
   rb_define_attr(cSocket, "port", 1, 1);
 
-  /* 0.1.2: The version of this library */
-  rb_define_const(cSocket, "VERSION", rb_str_new2("0.1.2"));
+  /* 0.1.4: The version of this library */
+  rb_define_const(cSocket, "VERSION", rb_str_new2("0.1.4"));
 
   /* send flags */
 

data/sctp-socket.gemspec

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

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: sctp-socket
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Daniel Berger
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain:
 - |
@@ -35,7 +35,7 @@ cert_chain:
   ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
   WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
   -----END CERTIFICATE-----
-date: 2025-01-10 00:00:00.000000000 Z
+date: 2025-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -133,7 +133,7 @@ metadata:
   wiki_uri: https://github.com/djberg96/sctp-socket/wiki
   rubygems_mfa_required: 'true'
   funding_uri: https://github.com/sponsors/djberg96
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -149,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.5.22
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Ruby bindings for SCTP sockets
 test_files: []