hubssolib 3.8.2 → 4.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b90f9617fc1a625f402510ee5497d4d357f914d7f35284e6c1e25b62ae07f4b
-  data.tar.gz: 450ead4d1423e6b42fd6a0aba65fdf043d6c5e3a6c3dc1b7b04412b2fcd4e65c
+  metadata.gz: f56f69bd23843c0ff1575651e4a01eb111f121363ad046c0e3356ec14bdb5dcf
+  data.tar.gz: f05e756267b131d91d3e3d71752781a33050cbd8b903cbe61d213614d229fe3d
 SHA512:
-  metadata.gz: 1a03c285659733df8dd98c93faaf458549229c8a096cba58c797c04139788bddf2592c2a12b99a5c87d02ffac4a936db703317d4957ec48d25790a21eb3ddadb
-  data.tar.gz: b392255f66a678625bab09ec613d69f77ab8cf60818764fcc4b2b55028e317854e24e8125a527ccac598b6845ba10f794524ffa82579a2f5ef30258fafbba887
+  metadata.gz: c3fb0fe6bd80d59959116218cddb8d328e0cfeddd1de858ad352eb7fa3bf439237510a63695a057dd5d488bfd2a8027921f683b50ea7161343daf3983cd75fa8
+  data.tar.gz: e637ddc3a7d73ad9892d8d17176d464485a501c6c60a045bb54551fb6bb2d5bc2c32dca9f80bceccba7c51b76216d664e40efcbc94a3116427f46e33f5854441

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 4.0.0, 4.0.1 and 4.0.2, 24-Jul-2026
+
+* Despite the major version bump, this is a maintenance release for client apps. Integration for all Hub features including the Hub Trust mechanism is unchanged.
+* If you do not use Hub Trust features at all, then this is also only a maintenance release for the Hub app itself and nothing more is needed to run the entire Hub assembly.
+* If you do use Hub Trust features, then note that the way in which you launch the Trust Server, which previously auto-launched with the Hub app but was prone to being killed or otherwise terminating without warning, has changed. In a manner similar to the separately-launched and reliable Session server, the Trust server must be separately launched. This is done with a Rake task so that the Trust server has full access to the Hub app environment.
+
+4.0.1 just updated Gemspec metadata without any other changes. In the spirit of "third time lucky", 4.0.2 fixes a last minute bug that crept in due to a rogue Undo.
+
 ## 3.8.2, 17-May-2025
 
 * General maintenance update.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hubssolib (3.8.2)
+    hubssolib (4.0.1)
       base64 (~> 0.2)
       drb (~> 2.2)
 
@@ -85,9 +85,9 @@ GEM
     base64 (0.3.0)
     bigdecimal (4.1.2)
     builder (3.3.0)
-    concurrent-ruby (1.3.6)
+    concurrent-ruby (1.3.8)
     connection_pool (3.0.2)
-    crass (1.0.6)
+    crass (1.0.7)
     date (3.5.1)
     debug (1.11.1)
       irb (~> 1.10)
@@ -97,11 +97,11 @@ GEM
     doggo (1.4.0)
       rspec-core (~> 3.13)
     drb (2.2.3)
-    erb (6.0.4)
+    erb (6.0.6)
     erubi (1.13.1)
-    globalid (1.3.0)
+    globalid (1.4.0)
       activesupport (>= 6.1)
-    i18n (1.14.8)
+    i18n (1.15.2)
       concurrent-ruby (~> 1.0)
     io-console (0.8.2)
     irb (1.18.0)
@@ -109,24 +109,24 @@ GEM
       prism (>= 1.3.0)
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
-    json (2.19.5)
+    json (2.21.1)
     logger (1.7.0)
-    loofah (2.25.1)
+    loofah (2.25.2)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
-    mail (2.9.0)
+    mail (2.9.1)
       logger
       mini_mime (>= 0.1.1)
       net-imap
       net-pop
       net-smtp
-    marcel (1.1.0)
+    marcel (1.2.1)
     mini_mime (1.1.5)
     mini_portile2 (2.8.9)
     minitest (6.0.6)
       drb (~> 2.0)
       prism (~> 1.5)
-    net-imap (0.6.4)
+    net-imap (0.6.6)
       date
       net-protocol
     net-pop (0.1.2)
@@ -136,16 +136,13 @@ GEM
     net-smtp (0.5.1)
       net-protocol
     nio4r (2.7.5)
-    nokogiri (1.19.3)
+    nokogiri (1.19.4)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
-    pp (0.6.3)
+    pp (0.6.4)
       prettyprint
     prettyprint (0.2.0)
     prism (1.9.0)
-    psych (5.3.1)
-      date
-      stringio
     racc (1.8.1)
     rack (3.2.6)
     rack-session (2.1.2)
@@ -173,8 +170,8 @@ GEM
       activesupport (>= 5.0.0)
       minitest
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.7.0)
-      loofah (~> 2.25)
+    rails-html-sanitizer (1.7.1)
+      loofah (~> 2.25, >= 2.25.2)
       nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
     railties (8.1.3)
       actionpack (= 8.1.3)
@@ -186,9 +183,14 @@ GEM
       tsort (>= 0.2)
       zeitwerk (~> 2.6)
     rake (13.4.2)
-    rdoc (7.2.0)
+    rbs (4.0.3)
+      logger
+      prism (>= 1.6.0)
+      tsort
+    rdoc (8.0.0)
       erb
-      psych (>= 4.0.0)
+      prism (>= 1.6.0)
+      rbs (>= 4.0.0)
       tsort
     reline (0.6.3)
       io-console (~> 0.5)
@@ -212,7 +214,6 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.13.2)
     simplecov_json_formatter (0.1.4)
-    stringio (3.2.0)
     thor (1.5.0)
     timeout (0.6.1)
     tsort (0.2.0)
@@ -220,11 +221,11 @@ GEM
       concurrent-ruby (~> 1.0)
     uri (1.1.1)
     useragent (0.16.11)
-    websocket-driver (0.8.0)
+    websocket-driver (0.8.2)
       base64
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
-    zeitwerk (2.7.5)
+    zeitwerk (2.8.2)
 
 PLATFORMS
   ruby

data/README.md

@@ -30,18 +30,17 @@ Include in a project by adding this to your `Gemfile`:
 gem 'hubssolib', '~> 3.0', require: 'hub_sso_lib'
 ```
 
-### The DRb server
+### The DRb Session Server
 
-The Hub DRb server consists of a small wrapper Ruby script which does most of its work using the Hub gem. To run the server, you need to first specify a DRb connection URI in the `HUB_CONNECTION_URI` environment variable. Usually, this is a Unix domain socket and so lives in a location of your choice in the local filesystem. Run the server by running `ruby` on the `hub_sso_server.rb` file in the Hub archive. For example:
+The Hub DRb Session Server consists of a small wrapper Ruby script which does most of its work using the Hub gem. The server needs to know the DRb connection URI that works for your system. A Unix-domain socket using a socket file `~/.hub_drb` is chosen as the default, but can override this with the `HUB_CONNECTION_URI` environment variable. If you specify a custom URI, note that it _MUST_ start with `drbunix:`; the Session Server must not be run on an IP port for security reasons.
+
+The server Ruby script has its own `Gemfile`, so after a `bundle install` inside the folder where `hub_sso_server.rb` lives, run with something like this:
 
 ```sh
-HUB_CONNECTION_URI="drbunix:/home/username/sockets/.hub_drb"
-export HUB_CONNECTION_URI
-ruby /home/username/hubssolib/hub_sso_server.rb &
+HUB_CONNECTION_URI="drbunix:/home/username/sockets/.hub_drb" \
+bundle exec ruby /home/username/hubssolib/server/hub_sso_server.rb &
 ```
 
-The default is to use a file `.hub_drb` in the root of the current user's home directory. If you specify a custom URI, note that it _MUST_ start with `drbunix:`; the hub server must not be run on an IP port for security reasons.
-
 ### The Hub application
 
 Finally you can install the Hub application using whatever mechanism you prefer to application installation. See ample documentation elsewhere on the Web for information on installing Ruby On Rails applications — Hub itself contains the default rails README file with quite a lot of information in it.
@@ -472,16 +471,24 @@ $ bundle exec rails c
 
 The trust mechanism involves a fair amount of effort on the integrating app's side but it can be very useful if you have a site where, despite your best efforts, sometimes spam/bot accounts manage to get inside and try to flood the system with spam. It's just one of many different potential protection and mitigation mechanisms that your site might choose to employ.
 
-**SERVER NOTE:** The Trust DRb server runs inside the Hub application, which runs using Puma as a server by default. The Trust server is started within the Hub application's `puma.rb` configuration file, because it needs to make sure it runs once, after booting, and is not destroyed by worker fork teardown/standup. If you aren't going to use Puma, you'll need to find a way to set this up; you'll want code akin to this in `app/hub/config/application.rb`:
+### The DRb Trust Server
 
-```ruby
-if defined? Rails::Server
-  Rails::Application::Finisher.initializer 'uk.org.pond.hubssolib.trustserver' do
-    Thread.new do
-      HubSsoLib::Trust.launch_server()
-    end
-  end
-end
+In a similar fashion to the DRb Session Server, there is a Trust Server which must be launched so that applications using the mechanism describe above have something to "talk" to (with the underlying mechanics taken care of by the Hub gem). In Hub v3, this was managed by the Hub app itself but process management and lifecycles can be complex in a Rails app and the approach was unreliable. Since Hub v4 there is a much more reliable, separately-launched command, just like with the Session Server.
+
+Untrusted action data is stored in the Hub app database and the Hub app will send notification e-mails out to moderators for each untrusted action event, so the DRb Trust Server is run via a Rake task that's part of the Hub app and uses its configured environment. The same environment variables that you pass to launch the Hub application should therefore be passed to the Rake task. As a bare minimum, make sure that `HUB_PATH_PREFIX` is set to the full URL needed to access the root path of the Hub application's web interface, as this is used when generating URLs in notification e-mails.
+
+The default location of the Unix-domain DRb server socket is `~/.hub_trust_drb` but you can override it with `HUB_TRUST_CONNECTION_URI`. As with the Session Server, if you specify a custom URI, note that it _MUST_ start with `drbunix:`; the Trust Server must not be run on an IP port for security reasons.
+
+```sh
+HUB_TRUST_CONNECTION_URI="drbunix:/home/username/sockets/.hub_trust_drb" \
+HUB_PATH_PREFIX="https://www.example.com/hub" \
+bundle exec bin/rails hub_trust:server &
 ```
 
-...but that only works if the code would be run once and never torn down (a one-process server setup). There are many different Ruby web server approaches and it's not possible to be more specific; you just need to read the documentation about lifecycles and callbacks for the server you choose.
+You can silence `$stdout` with `HUB_QUIET_SERVER=yes`, or if wishing to instead capture output to log files, the Rails `log` folder is a good place to put them:
+
+```sh
+HUB_TRUST_CONNECTION_URI="drbunix:/home/username/sockets/.hub_trust_drb" \
+HUB_PATH_PREFIX="https://www.example.com/hub" \
+bundle exec bin/rails hub_trust:server 1>> "log/trust_server_stdout.log" 2>> "logs/trust_server_stderr.log" &
+```

data/hubssolib.gemspec

@@ -4,13 +4,15 @@ spec = Gem::Specification.new do |s|
   s.platform = Gem::Platform::RUBY
   s.name     = 'hubssolib'
 
-  s.version  = '3.8.2'
+  s.version  = '4.0.2'
   s.author   = 'Andrew Hodgkinson and others'
   s.email    = 'ahodgkin@rowing.org.uk'
   s.homepage = 'http://pond.org.uk/'
   s.summary  = 'Cross-application single sign-on support library.'
   s.license  = 'MIT'
 
+  s.metadata["source_code_uri"] = "https://gitlab.riscosopen.org/website/hubssolib"
+
   s.description = <<-EOF
     The Hub SSO Library supports single sign-on across multiple Rails
     applications on the same host. The Hub application provides account

data/lib/hub_sso_lib.rb

@@ -927,37 +927,12 @@ module HubSsoLib
       return File.exist?(path)
     end
 
-    # Start the trust server. This should only ever be called by the Hub Rails
-    # application, which implements HubSsoLib::Trust::Server.
-    #
-    def self.launch_server
-      uri             = self.get_trust_server_connection_uri()
-      already_running = self.already_running?
-
-      unless ENV['HUB_QUIET_SERVER'] == 'yes'
-        message = unless already_running
-          "Trust server: Starting at #{ uri }"
-        else
-          "Trust server: Already running at at #{ uri }"
-        end
-
-        puts message
-      end
-
-      unless already_running
-        loop do
-          DRb.start_service(uri, ::HubSsoLib::Trust::Server.new)
-          DRb.thread.join # Keep the thread alive...
-        end               # ...but auto-restart if e.g. DRb.stop_service() is invoked
-      end
-    end
-
     # Obtain a connection to the trust server. This is called by any client
     # code that needs to talk to the server which must, at the time called, be
     # running via startup within the Hub Rails application.
     #
-    # The returned object is an instance of ::HubSsoLib::Trust::Server, which
-    # is defined inside the Hub Rails application. See there for details.
+    # The returned object is an instance of ::HubSsoLib::Trust::ActionManager,
+    # which is defined inside the Hub Rails application. See there for details.
     #
     def self.get_trust_object
       HUB_MUTEX.synchronize do
@@ -972,6 +947,57 @@ module HubSsoLib
 
       return @@trust_object
     end
+
+    module Server
+      def hubssolib_launch_trust_server
+        ::HubSsoLib::Trust::Server::Runner.run
+      end
+
+      class Runner
+        QUEUE = ::Queue.new
+
+        def self.run
+          uri             = ::HubSsoLib::Trust.get_trust_server_connection_uri()
+          already_running = ::HubSsoLib::Trust.already_running?
+
+          unless ENV['HUB_QUIET_SERVER'] == 'yes'
+            message = unless already_running
+              "Trust server: Starting at #{ uri }"
+            else
+              "Trust server: Already running at at #{ uri }"
+            end
+
+            puts message
+          end
+
+          Signal.trap('INT' ) { QUEUE << :INT  }
+          Signal.trap('TERM') { QUEUE << :TERM }
+
+          DRb.start_service(uri, ::HubApp::Trust::ActionManager.new, { :safe_level => 1 })
+
+          QUEUE.pop
+
+          self.shutdown()
+          exit
+
+        rescue => e
+          Sentry.capture_exception(e) if defined?(Sentry) && Sentry.respond_to?(:capture_exception)
+          raise
+        end
+
+        def self.shutdown
+          unless ENV['HUB_QUIET_SERVER'] == 'yes'
+            puts "Server: Graceful shutdown..."
+          end
+
+          DRb.stop_service
+
+          unless ENV['HUB_QUIET_SERVER'] == 'yes'
+            puts "Server: ...completed."
+          end
+        end
+      end # Runner class
+    end # Server module
   end
 
   #######################################################################

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hubssolib
 version: !ruby/object:Gem::Version
-  version: 3.8.2
+  version: 4.0.2
 platform: ruby
 authors:
 - Andrew Hodgkinson and others
@@ -143,7 +143,8 @@ files:
 homepage: http://pond.org.uk/
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://gitlab.riscosopen.org/website/hubssolib
 rdoc_options: []
 require_paths:
 - lib
@@ -158,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.16
 specification_version: 4
 summary: Cross-application single sign-on support library.
 test_files: []