sctp-socket 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd42fc7e43b41e85d64c8a82f258add07ead601ff3f12bac22bf818e9ecb0162
-  data.tar.gz: bb950e7a673d6aeee90fed9435e0162d02b09e29df5a8abe35451fcc6823dddd
+  metadata.gz: d41294806b8cc4ed6b74131f494a4a4309cac02ba490e3bbe20ef0f2cb89a09e
+  data.tar.gz: 3a8d7207263715d37f7a42986ee734dd225af23e3e071daefcb35f0c53786cfe
 SHA512:
-  metadata.gz: dab10bca673f2330c376686c53b6b5de62089be1b127252cf8ba8c5b46af2c7e1a409995b5b054bbf53702d47dc6c7b7b57660a624edbefeec566b8dff9aaaad
-  data.tar.gz: 28e75fa2e02f5388736d8515ace3497bfc7e907ffa0bae5131d14f89374c2045d800603a5a126e84bc5a2b2e36145a9887e0838b6c82aa1f869cea7463aa511b
+  metadata.gz: 60fa99a73f494affaf1b6f68ce35178e64642e4c26feff61f349db97bec4f0240c268ef406150e0bc78fb78a6634ec7d5876490b722d84aef858f9e030085a0f
+  data.tar.gz: '0925c76359dd0f1168c08556673a4f4d5db03bc891699042458e69f10509baf242ed95084ba97722f6a4ba24e5f88e43be39c1f9bb21a22fd6fbf8801f3446b9'

data/CHANGES.md

@@ -1,3 +1,12 @@
+## 0.2.1 - 17-Aug-2025
+* Several auth related methods were fixed.
+* The recvv and recvmsg methods now allow for an optional buffer size argument.
+* Several methods now explictly check for closed sockets internally.
+* The specs that were previously all lumped together have been split out
+  for individual methods (or related methods) for ease of maintenance and
+  generally easier debugging.
+* In the process of splitting out the specs, many were heavily refactored.
+
 ## 0.2.0 - 3-Aug-2025
 * Added an SCTP::Server class, generally modelled on the TCPServer class.
 * Added the map_ipv4? method to query IPv4 mapping status.

data/Rakefile

@@ -56,7 +56,9 @@ task :create_dummy_links do
   end
 end
 
-RSpec::Core::RakeTask.new
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = '-f documentation'
+end
 
 task :spec => :compile
 task :default => [:clean, :spec]

data/ext/sctp/socket.c

@@ -851,6 +851,8 @@ static VALUE rsctp_sendv(VALUE self, VALUE v_options){
 
   Check_Type(v_message, T_ARRAY);
 
+  CHECK_SOCKET_CLOSED(self);
+
   if(!NIL_P(v_addresses)){
     Check_Type(v_addresses, T_ARRAY);
     num_ip = (int)RARRAY_LEN(v_addresses);
@@ -925,24 +927,48 @@ static VALUE rsctp_sendv(VALUE self, VALUE v_options){
 #endif
 
 #ifdef HAVE_SCTP_RECVV
+/*
+ * call-seq:
+ *    SCTP::Socket#recvv(flags=0, buffer_size=1024)
+ *
+ * Receive a message using sctp_recvv from another SCTP endpoint.
+ *
+ * The optional buffer_size parameter specifies the size of the receive buffer
+ * in bytes. Defaults to 1024 bytes if not specified.
+ *
+ * Example:
+ *
+ *   begin
+ *     socket = SCTP::Socket.new
+ *     socket.bind(:port => 62534, :addresses => ['10.0.4.5', '10.0.5.5'])
+ *     socket.listen
+ *
+ *     while true
+ *       info = socket.recvv
+ *       puts "Received message: #{info.message}"
+ *
+ *       # Or with custom buffer size
+ *       info = socket.recvv(0, 4096)
+ *       puts "Received message: #{info.message}"
+ *     end
+ *   ensure
+ *     socket.close
+ *   end
+ */
 static VALUE rsctp_recvv(int argc, VALUE* argv, VALUE self){
-  VALUE v_flags;
-  int fileno, flags, on;
+  VALUE v_flags, v_buffer_size;
+  int fileno, flags, on, buffer_size;
   ssize_t bytes;
   uint infotype;
   socklen_t infolen;
   struct iovec iov[1];
   struct sctp_rcvinfo info;
-  char buffer[1024];
+  char *buffer;
 
   bzero(&iov, sizeof(iov));
   bzero(&info, sizeof(info));
-  bzero(&buffer, sizeof(buffer));
-
-	iov->iov_base = buffer;
-	iov->iov_len = sizeof(buffer);
 
-  rb_scan_args(argc, argv, "01", &v_flags);
+  rb_scan_args(argc, argv, "02", &v_flags, &v_buffer_size);
 
   fileno = NUM2INT(rb_iv_get(self, "@fileno"));
 
@@ -951,9 +977,28 @@ static VALUE rsctp_recvv(int argc, VALUE* argv, VALUE self){
   else
     flags = NUM2INT(v_flags);
 
+  if(NIL_P(v_buffer_size))
+    buffer_size = 1024;
+  else
+    buffer_size = NUM2INT(v_buffer_size);
+
+  if(buffer_size <= 0)
+    rb_raise(rb_eArgError, "buffer size must be positive");
+
+  buffer = (char*)malloc(buffer_size);
+  if(buffer == NULL)
+    rb_raise(rb_eNoMemError, "failed to allocate buffer");
+
+  bzero(buffer, buffer_size);
+
+	iov->iov_base = buffer;
+	iov->iov_len = buffer_size;
+
   on = 1;
-  if(setsockopt(fileno, IPPROTO_SCTP, SCTP_RECVRCVINFO, &on, sizeof(on)) < 0)
+  if(setsockopt(fileno, IPPROTO_SCTP, SCTP_RECVRCVINFO, &on, sizeof(on)) < 0){
+    free(buffer);
     rb_raise(rb_eSystemCallError, "setsockopt: %s", strerror(errno));
+  }
 
   infolen = sizeof(struct sctp_rcvinfo);
   infotype = 0;
@@ -970,16 +1015,19 @@ static VALUE rsctp_recvv(int argc, VALUE* argv, VALUE self){
     &flags
   );
 
-  if(bytes < 0)
+  if(bytes < 0){
+    free(buffer);
     rb_raise(rb_eSystemCallError, "sctp_recvv: %s", strerror(errno));
+  }
 
   if(infotype != SCTP_RECVV_RCVINFO){
+    free(buffer);
     return Qnil;
   }
   else{
-    return rb_struct_new(
+    VALUE result = rb_struct_new(
       v_sctp_receive_info_struct,
-      rb_str_new2(iov->iov_base),
+      rb_str_new(iov->iov_base, bytes),
       UINT2NUM(info.rcv_sid),
       UINT2NUM(info.rcv_ssn),
       UINT2NUM(info.rcv_flags),
@@ -989,6 +1037,8 @@ static VALUE rsctp_recvv(int argc, VALUE* argv, VALUE self){
       UINT2NUM(info.rcv_context),
       UINT2NUM(info.rcv_assoc_id)
     );
+    free(buffer);
+    return result;
   }
 }
 #endif
@@ -1264,10 +1314,13 @@ static VALUE rsctp_sendmsg(VALUE self, VALUE v_options){
 
 /*
  * call-seq:
- *    SCTP::Socket#recvmsg(flags=0)
+ *    SCTP::Socket#recvmsg(flags=0, buffer_size=1024)
  *
  * Receive a message from another SCTP endpoint.
  *
+ * The optional buffer_size parameter specifies the size of the receive buffer
+ * in bytes. Defaults to 1024 bytes if not specified.
+ *
  * Example:
  *
  *   begin
@@ -1279,46 +1332,64 @@ static VALUE rsctp_sendmsg(VALUE self, VALUE v_options){
  *     while true
  *       info = socket.recvmsg
  *       puts "Received message: #{info.message}"
+ *
+ *       # Or with custom buffer size
+ *       info = socket.recvmsg(0, 4096)
+ *       puts "Received message: #{info.message}"
  *     end
  *   ensure
  *     socket.close
  *   end
  */
 static VALUE rsctp_recvmsg(int argc, VALUE* argv, VALUE self){
-  VALUE v_flags, v_notification, v_message;
+  VALUE v_flags, v_buffer_size, v_notification, v_message;
   struct sctp_sndrcvinfo sndrcvinfo;
   struct sockaddr_in clientaddr;
-  int flags, fileno;
+  int flags, fileno, buffer_size;
   ssize_t bytes;
-  char buffer[1024]; // TODO: Let this be configurable?
+  char *buffer;
   socklen_t length;
 
-  rb_scan_args(argc, argv, "01", &v_flags);
+  rb_scan_args(argc, argv, "02", &v_flags, &v_buffer_size);
 
   if(NIL_P(v_flags))
     flags = 0;
   else
     flags = NUM2INT(v_flags);
 
+  if(NIL_P(v_buffer_size))
+    buffer_size = 1024;
+  else
+    buffer_size = NUM2INT(v_buffer_size);
+
+  if(buffer_size <= 0)
+    rb_raise(rb_eArgError, "buffer size must be positive");
+
+  buffer = (char*)malloc(buffer_size);
+  if(buffer == NULL)
+    rb_raise(rb_eNoMemError, "failed to allocate buffer");
+
   fileno = NUM2INT(rb_iv_get(self, "@fileno"));
   length = sizeof(struct sockaddr_in);
 
-  bzero(buffer, sizeof(buffer));
+  bzero(buffer, buffer_size);
   bzero(&clientaddr, sizeof(clientaddr));
   bzero(&sndrcvinfo, sizeof(sndrcvinfo));
 
   bytes = (ssize_t)sctp_recvmsg(
     fileno,
     buffer,
-    sizeof(buffer),
+    buffer_size,
     (struct sockaddr*)&clientaddr,
     &length,
     &sndrcvinfo,
     &flags
   );
 
-  if(bytes < 0)
+  if(bytes < 0){
+    free(buffer);
     rb_raise(rb_eSystemCallError, "sctp_recvmsg: %s", strerror(errno));
+  }
 
   v_notification = Qnil;
 
@@ -1330,6 +1401,8 @@ static VALUE rsctp_recvmsg(int argc, VALUE* argv, VALUE self){
   else
     v_message = Qnil;
 
+  free(buffer);
+
   return rb_struct_new(v_sndrcv_struct,
     v_message,
     UINT2NUM(sndrcvinfo.sinfo_stream),
@@ -2239,6 +2312,8 @@ static VALUE rsctp_enable_auth_support(int argc, VALUE* argv, VALUE self){
 
   rb_scan_args(argc, argv, "01", &v_assoc_id);
 
+  CHECK_SOCKET_CLOSED(self);
+
   fileno = NUM2INT(rb_iv_get(self, "@fileno"));
   size = sizeof(struct sctp_assoc_value);
 
@@ -2250,8 +2325,8 @@ static VALUE rsctp_enable_auth_support(int argc, VALUE* argv, VALUE self){
   assoc_value.assoc_id = assoc_id;
   assoc_value.assoc_value = 1;
 
-  if(sctp_opt_info(fileno, assoc_id, SCTP_AUTH_SUPPORTED, (void*)&assoc_value, &size) < 0)
-    rb_raise(rb_eSystemCallError, "sctp_opt_info: %s", strerror(errno));
+  if(setsockopt(fileno, IPPROTO_SCTP, SCTP_AUTH_SUPPORTED, (void*)&assoc_value, size) < 0)
+    rb_raise(rb_eSystemCallError, "setsockopt: %s", strerror(errno));
 
   return self;
 }
@@ -2295,7 +2370,7 @@ static VALUE rsctp_get_auth_support(int argc, VALUE* argv, VALUE self){
 
 /*
  * call-seq:
- *    SCTP::Socket#set_shared_key(key, keynum, association_id=nil)
+ *    SCTP::Socket#set_shared_key(key, keynum=1, association_id=nil)
  *
  *  This option will set a shared secret key which is used to build an
  *  association shared key.
@@ -2331,18 +2406,11 @@ static VALUE rsctp_set_shared_key(int argc, VALUE* argv, VALUE self){
 
   rb_scan_args(argc, argv, "12", &v_key, &v_keynumber, &v_assoc_id);
 
+  CHECK_SOCKET_CLOSED(self);
+
   fileno = NUM2INT(rb_iv_get(self, "@fileno"));
   key = StringValuePtr(v_key);
-  len = strlen(key);
-  unsigned char byte_array[len+1];
-
-  for(size_t i = 0; i < len; i++)
-    byte_array[i] = key[i];
-
-  byte_array[len] = '\0';
-
-  auth_key = malloc(sizeof(auth_key) + sizeof(char[strlen(key)+1]));
-  size = sizeof(auth_key);
+  len = RSTRING_LEN(v_key); // Use Ruby's string length, not strlen
 
   if(NIL_P(v_assoc_id))
     assoc_id = NUM2INT(rb_iv_get(self, "@association_id"));
@@ -2354,14 +2422,25 @@ static VALUE rsctp_set_shared_key(int argc, VALUE* argv, VALUE self){
   else
     keynum = NUM2INT(v_keynumber);
 
+  // Allocate the structure with space for the key
+  size = sizeof(struct sctp_authkey) + len;
+  auth_key = malloc(size);
+
+  if (auth_key == NULL)
+    rb_raise(rb_eNoMemError, "Failed to allocate memory for auth key");
+
   auth_key->sca_assoc_id = assoc_id;
   auth_key->sca_keynumber = keynum;
-  auth_key->sca_keylength = strlen(key);
-  memcpy(auth_key->sca_key, byte_array, sizeof(byte_array));
+  auth_key->sca_keylength = len;
+  memcpy(auth_key->sca_key, key, len);
 
-  if(sctp_opt_info(fileno, assoc_id, SCTP_AUTH_KEY, (void*)auth_key, &size) < 0)
-    rb_raise(rb_eSystemCallError, "sctp_opt_info: %s", strerror(errno));
+  if(setsockopt(fileno, IPPROTO_SCTP, SCTP_AUTH_KEY, (void*)auth_key, size) < 0) {
+    int err = errno;
+    free(auth_key);
+    rb_raise(rb_eSystemCallError, "setsockopt: %s", strerror(err));
+  }
 
+  free(auth_key);
   return self;
 }
 
@@ -2377,14 +2456,19 @@ static VALUE rsctp_get_active_shared_key(int argc, VALUE* argv, VALUE self){
   struct sctp_authkeyid authkey;
   sctp_assoc_t assoc_id;
   VALUE v_assoc_id, v_keynum;
-  uint keynum;
+  int keynum;
 
   rb_scan_args(argc, argv, "11", &v_keynum, &v_assoc_id);
 
   bzero(&authkey, sizeof(authkey));
 
+  // Cast it later, we want to force a validity check.
+  keynum = FIX2INT(v_keynum);
+
+  if(keynum < 0)
+    rb_raise(rb_eArgError, "invalid keynum value");
+
   fileno = NUM2INT(rb_iv_get(self, "@fileno"));
-  keynum = NUM2UINT(v_keynum);
 
   if(NIL_P(v_assoc_id))
     assoc_id = NUM2INT(rb_iv_get(self, "@association_id"));
@@ -2392,7 +2476,7 @@ static VALUE rsctp_get_active_shared_key(int argc, VALUE* argv, VALUE self){
     assoc_id = NUM2INT(v_assoc_id);
 
   authkey.scact_assoc_id = assoc_id;
-  authkey.scact_keynumber = keynum;
+  authkey.scact_keynumber = (uint)keynum;
 
   size = sizeof(struct sctp_authkeyid);
 
@@ -2413,7 +2497,7 @@ static VALUE rsctp_get_active_shared_key(int argc, VALUE* argv, VALUE self){
  * authenticated chunks. The key identifier MUST correspond to an existing
  * shared key. Note that shared key identifier '0' defaults to a null key.
  *
- * The association_idparameter, if non-zero, indicates what association that
+ * The association_id parameter, if non-zero, indicates what association that
  * the shared key identifier is being set active upon. If this element contains
  * zero, then the activation applies to the endpoint and all future
  * associations will use the specified shared key identifier.
@@ -2430,11 +2514,15 @@ static VALUE rsctp_set_active_shared_key(int argc, VALUE* argv, VALUE self){
   struct sctp_authkeyid authkey;
   sctp_assoc_t assoc_id;
   VALUE v_assoc_id, v_keynum;
-  uint keynum;
+  int keynum;
 
   rb_scan_args(argc, argv, "11", &v_keynum, &v_assoc_id);
 
-  keynum = NUM2UINT(v_keynum);
+  keynum = FIX2INT(v_keynum);
+
+  if(keynum < 0)
+    rb_raise(rb_eArgError, "invalid keynum value");
+
   fileno = NUM2INT(rb_iv_get(self, "@fileno"));
 
   if(NIL_P(v_assoc_id))
@@ -2443,11 +2531,11 @@ static VALUE rsctp_set_active_shared_key(int argc, VALUE* argv, VALUE self){
     assoc_id = NUM2INT(v_assoc_id);
 
   authkey.scact_assoc_id = assoc_id;
-  authkey.scact_keynumber = keynum;
+  authkey.scact_keynumber = (uint)keynum;
   size = sizeof(struct sctp_authkeyid);
 
-  if(sctp_opt_info(fileno, assoc_id, SCTP_AUTH_ACTIVE_KEY, (void*)&authkey, &size) < 0)
-    rb_raise(rb_eSystemCallError, "sctp_opt_info: %s", strerror(errno));
+  if(setsockopt(fileno, IPPROTO_SCTP, SCTP_AUTH_ACTIVE_KEY, (void*)&authkey, size) < 0)
+    rb_raise(rb_eSystemCallError, "setsockopt: %s", strerror(errno));
 
   return self;
 }
@@ -2487,6 +2575,8 @@ static VALUE rsctp_delete_shared_key(int argc, VALUE* argv, VALUE self){
 
   rb_scan_args(argc, argv, "11", &v_keynum, &v_assoc_id);
 
+  CHECK_SOCKET_CLOSED(self);
+
   bzero(&authkey, sizeof(authkey));
 
   fileno = NUM2INT(rb_iv_get(self, "@fileno"));
@@ -2502,8 +2592,8 @@ static VALUE rsctp_delete_shared_key(int argc, VALUE* argv, VALUE self){
 
   size = sizeof(struct sctp_authkeyid);
 
-  if(sctp_opt_info(fileno, assoc_id, SCTP_AUTH_DELETE_KEY, (void*)&authkey, &size) < 0)
-    rb_raise(rb_eSystemCallError, "sctp_opt_info: %s", strerror(errno));
+  if(setsockopt(fileno, IPPROTO_SCTP, SCTP_AUTH_DELETE_KEY, (void*)&authkey, size) < 0)
+    rb_raise(rb_eSystemCallError, "setsockopt: %s", strerror(errno));
 
   return INT2NUM(authkey.scact_keynumber);
 }
@@ -2512,10 +2602,14 @@ static VALUE rsctp_delete_shared_key(int argc, VALUE* argv, VALUE self){
  * call-seq:
  *    SCTP::Socket#map_ipv4=(bool)
  *
- * If set to true and the socket is type PF_INET6, then IPv4 addresses will be
+ * If set to true and the socket is type xF_INET6, then IPv4 addresses will be
  * mapped to V6 representation. If set to false (the default), then no mapping
- * will be done of V4 addresses and a user will receive both PF_INET6 and
- * PF_INET type addresses on the socket.
+ * will be done of V4 addresses and a user will receive both xF_INET6 and
+ * xF_INET type addresses on the socket.
+ *
+ * Note that setting this to true on a socket that is not type xF_INET6 is
+ * undefined behavior, and may raise an error on your platform. Otherwise it's
+ * a no-op.
  */
 static VALUE rsctp_map_ipv4(VALUE self, VALUE v_bool){
   int fileno, boolean;
@@ -2899,8 +2993,8 @@ void Init_socket(void){
   rb_define_attr(cSocket, "association_id", 1, 1);
   rb_define_attr(cSocket, "port", 1, 1);
 
-  /* 0.1.4: The version of this library */
-  rb_define_const(cSocket, "VERSION", rb_str_new2("0.2.0"));
+  /* 0.2.0: The version of this library */
+  rb_define_const(cSocket, "VERSION", rb_str_new2("0.2.1"));
 
   /* send flags */
 

data/sctp-socket.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name        = 'sctp-socket'
-  spec.version     = '0.2.0'
+  spec.version     = '0.2.1'
   spec.author      = 'Daniel Berger'
   spec.email       = 'djberg96@gmail.com'
   spec.summary     = 'Ruby bindings for SCTP sockets'
@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.cert_chain  = ['certs/djberg96_pub.pem']
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
+    f.match(%r{^(test|spec|features|.github)/})
   end
 
   spec.extensions = ['ext/sctp/extconf.rb']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sctp-socket
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Daniel Berger
@@ -35,7 +35,7 @@ cert_chain:
   ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
   WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
   -----END CERTIFICATE-----
-date: 2025-08-04 00:00:00.000000000 Z
+date: 2025-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -103,8 +103,6 @@ extensions:
 - ext/sctp/extconf.rb
 extra_rdoc_files: []
 files:
-- ".github/FUNDING.yml"
-- ".github/workflows/ruby.yml"
 - ".gitignore"
 - CHANGES.md
 - Gemfile

data/.github/FUNDING.yml

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

data/.github/workflows/ruby.yml

@@ -1,59 +0,0 @@
-name: Ruby
-
-on:
-  push:
-    branches: [ main ]
-    paths-ignore:
-      - '**/*.md'
-  pull_request:
-    branches: [ main ]
-    paths-ignore:
-      - '**/*.md'
-  workflow_dispatch:
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        ruby-version: ['3.2', '3.3', '3.4']
-    steps:
-    - uses: actions/checkout@v4
-    - name: Install SCTP headers
-      run: |
-          sudo apt-get install libsctp-dev lksctp-tools
-          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
-    - name: Setup Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby-version }}
-        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