zyre 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dec6f1a89c5683ac88460dc3cc156b79156e318052a7ea81494336e0686ec522
-  data.tar.gz: f1fd6cb1ba63bf1ea8054823faa26afaa0646f063da940ee3e6e1e12ead7161a
+  metadata.gz: 7b5427b9f8cbdcbec3727b0a998a82b60b70cf7a82e36f6e3a0a86e6d9aba74a
+  data.tar.gz: 898dcb7df592fc24617fedc60d8f54b9f22f421ae04459215ee3c48adc581ff0
 SHA512:
-  metadata.gz: f98b88495f675531470868a0c4e7f7ec94970fd3e9415d771a3ad0d1c27bea34c7badd3e7e3a084e147611871fc45439bbb495abda72f5a6962eaf11beeb7992
-  data.tar.gz: a442f583bd320bf642794d6b0136057473d8a9abafef5fd1570213ee4d564dc4aa1bca48c4f3d36696c534cdba51b0ba645c68926b6f2eea072bf21a0623e818
+  metadata.gz: 774f4c450b24db21b8db0d52bde9334b80edf4d196b51e5f3be468b20cba83469418862b0ad862c617d2366b39cbe003d2e6e5d518c59c8b6f09ccbf2e8253da
+  data.tar.gz: f53e49334e7b4a5dd308080addafc65a6d3dd222463651b8c038ddd2de12cf6ba2b30a3d959649ab001e44d41fbf2d41c9ac969800fdbe10d25238cfa653e24d

data/History.md

@@ -2,6 +2,17 @@
 
 ---
 
+## v0.7.0 [2025-08-05] Michael Granger <ged@faeriemud.org>
+
+Improvements:
+
+- Add ZAUTH
+
+Fixes:
+
+- Move the interface method setting to the Zyre toplevel since it's actually global
+
+
 ## v0.6.0 [2023-08-08] Michael Granger <ged@faeriemud.org>
 
 Improvements:

data/ext/zyre_ext/node.c

@@ -286,6 +286,7 @@ rzyre_node_interface_eq( VALUE self, VALUE interface )
 	zyre_t *ptr = rzyre_get_node( self );
 	const char *interface_str = StringValueCStr( interface );
 
+	rb_warn( "Setting #interface on a Node sets it globally." );
 	zyre_set_interface( ptr, interface_str );
 
 	return Qtrue;

data/ext/zyre_ext/zyre_ext.c

@@ -17,6 +17,8 @@
 
 VALUE rzyre_mZyre;
 
+static zactor_t *auth;
+
 
 /* --------------------------------------------------------------
  * Logging Functions
@@ -148,7 +150,7 @@ rzyre_make_zmsg_from( VALUE messages )
  *
  */
 static VALUE
-rzyre_s_zyre_version()
+rzyre_s_zyre_version( VALUE _mod )
 {
 	static uint64_t version;
 
@@ -293,10 +295,172 @@ rzyre_s_z85_decode( VALUE module, VALUE string )
 }
 
 
+
+/*
+ * call-seq:
+ *    Zyre.start_authenticator   -> true
+ *
+ * Start the ZAUTH authenticator actor. If it's already running, this
+ * call is silently ignored.
+ *
+ */
 static VALUE
 rzyre_s_start_authenticator( VALUE module )
 {
-	return Qnil;
+	if ( !auth ) {
+		rzyre_log_obj( rzyre_mZyre, "info", "starting up the ZAUTH actor." );
+		auth = zactor_new( zauth, NULL );
+		assert( auth );
+	}
+
+	return Qtrue;
+}
+
+
+/*
+ * call-seq:
+ *    Zyre.authenticator_started?   -> true or false
+ *
+ * Returns `true` if the ZAUTH authenticator actor is running.
+ *
+ */
+static VALUE
+rzyre_s_authenticator_started_p( VALUE module )
+{
+	if ( auth ) {
+		return Qtrue;
+	} else {
+		return Qfalse;
+	}
+}
+
+
+/*
+ * call-seq:
+ *    Zyre.stop_authenticator   -> true
+ *
+ * Stop the ZAUTH authenticator actor if it is running. If it's not running, this
+ * call is silently ignored.
+ *
+ */
+static VALUE
+rzyre_s_stop_authenticator( VALUE module )
+{
+	if ( auth ) {
+		rzyre_log_obj( rzyre_mZyre, "info", "shutting down the ZAUTH actor." );
+		zactor_destroy( &auth );
+	}
+
+	return Qtrue;
+}
+
+
+/*
+ * Async wait function; called without the GVL.
+ */
+static void *
+rzyre_wait_for_auth_without_gvl( void *_unused )
+{
+	zsock_wait( auth );
+	return NULL;
+}
+
+
+/*
+ * call-seq:
+ *    Zyre.verbose_auth!
+ *
+ * Enable the ZAUTH actor's verbose logging.
+ *
+ */
+static VALUE
+rzyre_s_verbose_auth_bang( VALUE module )
+{
+	if ( auth ) {
+		zstr_sendx( auth, "VERBOSE", NULL );
+		rb_thread_call_without_gvl2( rzyre_wait_for_auth_without_gvl, 0, RUBY_UBF_IO, 0 );
+	} else {
+		rb_raise( rb_eRuntimeError, "can't enable verbose auth: authenticator is not started." );
+	}
+
+	return Qtrue;
+}
+
+
+/*
+ * call-seq:
+ *    Zyre.enable_curve_auth( cert_dir=nil )
+ *
+ * Enable CURVE authentication, using the specified +cert_dir+ for allowed
+ * public certificates. If no +cert_dir+ is given, any connection presenting a valid CURVE
+ * certificate will be allowed.
+ *
+ */
+static VALUE
+rzyre_s_enable_curve_auth( int argc, VALUE *argv, VALUE module )
+{
+	VALUE cert_dir = Qnil;
+	char *cert_dir_s;
+
+	rb_scan_args( argc, argv, "01", &cert_dir );
+
+	if ( argc ) {
+		cert_dir_s = StringValueCStr( cert_dir );
+		zstr_sendx( auth, "CURVE", cert_dir_s, NULL );
+	} else {
+		zstr_sendx( auth, "CURVE", CURVE_ALLOW_ANY, NULL );
+	}
+
+	rb_thread_call_without_gvl2( rzyre_wait_for_auth_without_gvl, 0, RUBY_UBF_IO, 0 );
+
+	return Qtrue;
+}
+
+
+/*
+ * call-seq:
+ *    Zyre.interface   -> string
+ *
+ * Return network interface to use for broadcasts, or nil if none was set.
+ *
+ */
+static VALUE
+rzyre_s_interface( VALUE module )
+{
+	const char *interface = zsys_interface();
+
+	if ( strnlen(interface, 1) == 0 ) {
+		return Qnil;
+	}
+
+	return rb_utf8_str_new_cstr( interface );
+}
+
+
+/*
+ * call-seq:
+ *    Zyre.interface = string
+ *
+ * Set network interface name to use for broadcasts.
+ *
+ * This lets the interface be configured for test environments where required.
+ * For example, on Mac OS X, zbeacon cannot bind to 255.255.255.255 which is
+ * the default when there is no specified interface. If the environment
+ * variable ZSYS_INTERFACE is set, use that as the default interface name.
+ * Setting the interface to "*" means "use all available interfaces".
+ *
+ */
+static VALUE
+rzyre_s_interface_eq( VALUE module, VALUE new_interface )
+{
+	if ( NIL_P(new_interface) ) {
+		zsys_set_interface( "" );
+	} else {
+		const char *new_interface_s = StringValueCStr( new_interface );
+		zsys_set_interface( new_interface_s );
+	}
+
+	return Qtrue;
 }
 
 
@@ -326,15 +490,23 @@ Init_zyre_ext()
 
 	rb_define_singleton_method( rzyre_mZyre, "zyre_version", rzyre_s_zyre_version, 0 );
 	rb_define_singleton_method( rzyre_mZyre, "interfaces", rzyre_s_interfaces, 0 );
-	rb_define_singleton_method( rzyre_mZyre, "disable_zsys_handler", rzyre_s_disable_zsys_handler, 0 );
+	rb_define_singleton_method( rzyre_mZyre, "disable_zsys_handler",
+		rzyre_s_disable_zsys_handler, 0 );
 
 	rb_define_singleton_method( rzyre_mZyre, "z85_encode", rzyre_s_z85_encode, 1 );
 	rb_define_singleton_method( rzyre_mZyre, "z85_decode", rzyre_s_z85_decode, 1 );
 
-	// :TODO: Allow for startup of the zauth agent. This will require enough of a
-	// subset of CZMQ that I hesitate to do it in Zyre. Maybe better to just write a
-	// decent CZMQ library instead?
-	rb_define_singleton_method( rzyre_mZyre, "start_authenticator", rzyre_s_start_authenticator, 0 );
+	rb_define_singleton_method( rzyre_mZyre, "start_authenticator",
+		rzyre_s_start_authenticator, 0 );
+	rb_define_singleton_method( rzyre_mZyre, "authenticator_started?",
+		rzyre_s_authenticator_started_p, 0 );
+	rb_define_singleton_method( rzyre_mZyre, "stop_authenticator", rzyre_s_stop_authenticator, 0 );
+
+	rb_define_singleton_method( rzyre_mZyre, "verbose_auth!", rzyre_s_verbose_auth_bang, 0 );
+	rb_define_singleton_method( rzyre_mZyre, "enable_curve_auth", rzyre_s_enable_curve_auth, -1 );
+
+	rb_define_singleton_method( rzyre_mZyre, "interface", rzyre_s_interface, 0 );
+	rb_define_singleton_method( rzyre_mZyre, "interface=", rzyre_s_interface_eq, 1 );
 
 	// :TODO: set up zsys_set_logsender()
 

data/lib/zyre.rb

@@ -13,7 +13,7 @@ module Zyre
 
 
 	# Gem version (semver)
-	VERSION = '0.6.0'
+	VERSION = '0.7.0'
 
 	# Set up a logger for Zyre classes
 	log_as :zyre

data/spec/zyre/cert_spec.rb

@@ -46,7 +46,7 @@ RSpec.describe( Zyre::Cert ) do
 
 		expect( result ).to be_a( described_class )
 		expect( result.public_key ).to eq( cert.public_key )
-		expect( result.secret_key ).to eq( Zyre::Cert::EMPTY_KEY )
+		expect( result.secret_key ).to eq( described_class::EMPTY_KEY )
 	end
 
 
@@ -197,7 +197,7 @@ RSpec.describe( Zyre::Cert ) do
 
 	it "can be applied to a Zyre node", :draft_apis do
 		node = instance_double( Zyre::Node )
-		cert = Zyre::Cert.new
+		cert = described_class.new
 
 		expect( node ).to receive( :zcert= ).with( cert )
 		cert.apply( node )
@@ -212,6 +212,8 @@ RSpec.describe( Zyre::Cert ) do
 		other = cert.dup
 
 		expect( other.object_id ).not_to eq( cert.object_id )
+		expect( other[:node_id] ).to eq( cert[:node_id] )
+		expect( other[:node_order] ).to eq( cert[:node_order] )
 	end
 
 

data/spec/zyre/node_spec.rb

@@ -26,6 +26,14 @@ RSpec.describe( Zyre::Node ) do
 	TEST_BINARY_STRING = TEST_BINARY_STRING_PARTS.join( '' )
 
 
+	before( :each ) do
+		@interface = Zyre.interface
+	end
+	after( :each ) do
+		Zyre.interface = @interface
+	end
+
+
 	it "can be created anonymously" do
 		node = described_class.new
 
@@ -108,11 +116,11 @@ RSpec.describe( Zyre::Node ) do
 	end
 
 
-	it "can be set to communicate on a particular network interface" do
+	it "has a backward-compatible method for setting the interface on a Node" do
 		node = described_class.new
 		expect {
 			node.interface = 'lo0'
-		}.to_not raise_error
+		}.to change { Zyre.interface }.to( 'lo0' )
 	end
 
 

data/spec/zyre_spec.rb

@@ -7,6 +7,14 @@ require 'zyre'
 
 RSpec.describe( Zyre ) do
 
+	before( :each ) do
+		@interface = described_class.interface
+	end
+	after( :each ) do
+		described_class.interface = @interface
+		described_class.stop_authenticator
+	end
+
 
 	# Pattern for matching IPv4 addresses
 	IPV4_ADDRESS = /^((?:(?:^|\.)(?:\d|[1-9]\d|1\d{2}|2[0-4]\d|25[0-5])){4})$/
@@ -64,6 +72,21 @@ RSpec.describe( Zyre ) do
 	end
 
 
+	it "can set the interface used by all nodes" do
+		expect {
+			described_class.interface = 'LENNY'
+		}.to change { described_class.interface }.to( 'LENNY' )
+	end
+
+
+	it "clears the interface setting if set to `nil`" do
+		described_class.interface = "eth0"
+		expect {
+			described_class.interface = nil
+		}.to change { described_class.interface }.to( nil )
+	end
+
+
 	describe "Z85 encoding/decoding" do
 
 		# From the 32/Z85 reference code:
@@ -126,5 +149,95 @@ RSpec.describe( Zyre ) do
 
 	end
 
+
+	describe "ZAUTH authenticator" do
+
+		it "can be started" do
+			expect {
+				described_class.start_authenticator
+			}.to change { described_class.authenticator_started? }.to( true )
+		end
+
+
+		it "ignores call to start if it's already started" do
+			described_class.start_authenticator
+
+			expect {
+				described_class.start_authenticator
+			}.not_to raise_error
+		end
+
+
+		it "can be stopped" do
+			described_class.start_authenticator
+
+			expect {
+				described_class.stop_authenticator
+			}.to change { described_class.authenticator_started? }.to( false )
+		end
+
+
+		it "ignores calls to stop if it's not started" do
+			expect {
+				described_class.stop_authenticator
+			}.not_to raise_error
+		end
+
+
+		it "can enable verbose auth logging" do
+			described_class.start_authenticator
+			expect {
+				described_class.verbose_auth!
+			}.not_to raise_error
+		end
+
+
+		it "raises an error if verbose auth logging is enabled before the authenticator is started" do
+			expect {
+				described_class.verbose_auth!
+			}.to raise_error( /authenticator is not started/i )
+		end
+
+
+		it "supports any-cert style authentication" do
+			described_class.start_authenticator
+			# described_class.verbose_auth!
+			described_class.enable_curve_auth
+
+			server_cert = Zyre::Cert.new
+			server = Zyre::Node.new( 'server' )
+			# server.verbose!
+			server.zap_domain = 'TEST'
+			server.zcert = server_cert
+			server.set_header( 'X-PUBLICKEY', server_cert.public_txt )
+			server.join( 'TEST' )
+			server.start
+
+			client_cert = Zyre::Cert.new
+			authed_client = Zyre::Node.new( 'authed_client' )
+			# authed_client.verbose!
+			authed_client.zap_domain = 'TEST'
+			authed_client.zcert = client_cert
+			authed_client.set_header( 'X-PUBLICKEY', client_cert.public_txt )
+			authed_client.join( 'TEST' )
+			authed_client.start
+			authed_client.shout( 'TEST', 'authed_client hello' )
+
+			result = server.wait_for( :JOIN, timeout: 0.2 )
+			expect( result ).to be_a( Zyre::Event::Join )
+
+			noauth_client = Zyre::Node.new( 'noauth_client' )
+			# noauth_client.verbose!
+			noauth_client.zap_domain = 'TEST'
+			noauth_client.join( 'TEST' )
+			noauth_client.start
+			noauth_client.shout( 'TEST', 'noauth_client hello' )
+
+			result = server.wait_for( :JOIN, timeout: 0.2 )
+			expect( result ).to be_nil
+		end
+
+	end
+
 end
 

metadata

@@ -1,39 +1,40 @@
 --- !ruby/object:Gem::Specification
 name: zyre
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Michael Granger
-autorequire:
 bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIID+DCCAmCgAwIBAgIBBTANBgkqhkiG9w0BAQsFADAiMSAwHgYDVQQDDBdnZWQv
-  REM9RmFlcmllTVVEL0RDPW9yZzAeFw0yMzAxMTYxNzE2MDlaFw0yNDAxMTYxNzE2
-  MDlaMCIxIDAeBgNVBAMMF2dlZC9EQz1GYWVyaWVNVUQvREM9b3JnMIIBojANBgkq
-  hkiG9w0BAQEFAAOCAY8AMIIBigKCAYEAvyVhkRzvlEs0fe7145BYLfN6njX9ih5H
-  L60U0p0euIurpv84op9CNKF9tx+1WKwyQvQP7qFGuZxkSUuWcP/sFhDXL1lWUuIl
-  M4uHbGCRmOshDrF4dgnBeOvkHr1fIhPlJm5FO+Vew8tSQmlDsosxLUx+VB7DrVFO
-  5PU2AEbf04GGSrmqADGWXeaslaoRdb1fu/0M5qfPTRn5V39sWD9umuDAF9qqil/x
-  Sl6phTvgBrG8GExHbNZpLARd3xrBYLEFsX7RvBn2UPfgsrtvpdXjsHGfpT3IPN+B
-  vQ66lts4alKC69TE5cuKasWBm+16A4aEe3XdZBRNmtOu/g81gvwA7fkJHKllJuaI
-  dXzdHqq+zbGZVSQ7pRYHYomD0IiDe1DbIouFnPWmagaBnGHwXkDT2bKKP+s2v21m
-  ozilJg4aar2okb/RA6VS87o+d7g6LpDDMMQjH4G9OPnJENLdhu8KnPw/ivSVvQw7
-  N2I4L/ZOIe2DIVuYH7aLHfjZDQv/mNgpAgMBAAGjOTA3MAkGA1UdEwQCMAAwCwYD
-  VR0PBAQDAgSwMB0GA1UdDgQWBBRyjf55EbrHagiRLqt5YAd3yb8k4DANBgkqhkiG
-  9w0BAQsFAAOCAYEARYCeUVBWARNKqF0cvNnLJvFf4hdW2+Rtc7NfC5jQvX9a1oom
-  sfVvS96eER/9cbrphu+vc59EELw4zT+RY3/IesnoE7CaX6zIOFmSmG7K61OHsSLR
-  KqMygcWwyuPXT2JG7JsGHuxbzgaRWe29HbSjBbLYxiMH8Zxh4tKutxzKF7jb0Ggq
-  KAf9MH5LwG8IHVIfV5drT14PvgR3tcvmrn1timPyJl+eZ3LNnm9ofOCweuZCq1cy
-  4Q8LV3vP2Cofy9q+az3DHdaUGlmMiZZZqKixDr1KSS9nvh0ZrKMOUL1sWj/IaxrQ
-  RV3y6td14q49t+xnbj00hPlbW7uE2nLJLt2NAoXiE1Nonndz1seB2c6HL79W9fps
-  E/O12pQjCp/aPUZMt8/8tKW31RIy/KP8XO6OTJNWA8A/oNEI0g5p/LmmEtJKWYr1
-  WmEdESlpWhzFECctefIF2lsN9vaOuof57RM77t2otrtcscDtNarIqjZsIyqtDvtL
-  DttITiit0Vwz7bY0
+  MIIEbDCCAtSgAwIBAgIBATANBgkqhkiG9w0BAQsFADA+MQwwCgYDVQQDDANnZWQx
+  GTAXBgoJkiaJk/IsZAEZFglGYWVyaWVNVUQxEzARBgoJkiaJk/IsZAEZFgNvcmcw
+  HhcNMjUwMTAxMDMzMTA5WhcNMjYwMTAxMDMzMTA5WjA+MQwwCgYDVQQDDANnZWQx
+  GTAXBgoJkiaJk/IsZAEZFglGYWVyaWVNVUQxEzARBgoJkiaJk/IsZAEZFgNvcmcw
+  ggGiMA0GCSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQC/JWGRHO+USzR97vXjkFgt
+  83qeNf2KHkcvrRTSnR64i6um/ziin0I0oX23H7VYrDJC9A/uoUa5nGRJS5Zw/+wW
+  ENcvWVZS4iUzi4dsYJGY6yEOsXh2CcF46+QevV8iE+UmbkU75V7Dy1JCaUOyizEt
+  TH5UHsOtUU7k9TYARt/TgYZKuaoAMZZd5qyVqhF1vV+7/Qzmp89NGflXf2xYP26a
+  4MAX2qqKX/FKXqmFO+AGsbwYTEds1mksBF3fGsFgsQWxftG8GfZQ9+Cyu2+l1eOw
+  cZ+lPcg834G9DrqW2zhqUoLr1MTly4pqxYGb7XoDhoR7dd1kFE2a067+DzWC/ADt
+  +QkcqWUm5oh1fN0eqr7NsZlVJDulFgdiiYPQiIN7UNsii4Wc9aZqBoGcYfBeQNPZ
+  soo/6za/bWajOKUmDhpqvaiRv9EDpVLzuj53uDoukMMwxCMfgb04+ckQ0t2G7wqc
+  /D+K9JW9DDs3Yjgv9k4h7YMhW5gftosd+NkNC/+Y2CkCAwEAAaN1MHMwCQYDVR0T
+  BAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFHKN/nkRusdqCJEuq3lgB3fJvyTg
+  MBwGA1UdEQQVMBOBEWdlZEBGYWVyaWVNVUQub3JnMBwGA1UdEgQVMBOBEWdlZEBG
+  YWVyaWVNVUQub3JnMA0GCSqGSIb3DQEBCwUAA4IBgQBjrBzCKWzXFigswYSPzGO8
+  9atBtY/eQdcN6KCL+PTzQBD9yePGF7H/xsww3awRauP+D1VUjCFbiiC3Qb0Ww0Qd
+  OVA0s10T9KpZ8nb2XyKocSK7TfgDhcyr0V4H2MPxwK9SWYjGGh8z9z9HmT0i3PyX
+  fXOSzzEoG6u26HIOg0nxSpitEjiAHBekQxy9ka5NuQbxoxMg+eIHU4rU9IUhu0Rf
+  wl4wuvPVE3UQK0v0uqT6rJukEKQ1iNgK5R8klgEIv79XhQPgTkMt31FGfrwOp6HB
+  OE0HMwOwY9B0w3aOxxdMQyyRxaZVv3eWE5RimQI7T0TUaxPngtS33ByMZjTeidxi
+  ESIUEPVXoBCkFgLW1EVlBb+rG7WLYod4eVll4tKA42Bi2Ju90tqiJ1YQiyuRfCnp
+  8qAqdfV+4u6Huu1KzAuDQCheyEyISsLST37sU/irV3czV6BiFipWag1XiJciRT3A
+  wZqCfTNVHTdtsCbfdA1DsA3RdG2iEH3TOHzv1Rqzqh4=
   -----END CERTIFICATE-----
-date: 2023-08-08 00:00:00.000000000 Z
+date: 2025-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: loggability
@@ -207,7 +208,6 @@ metadata:
   documentation_uri: https://deveiate.org/code/zyre
   changelog_uri: https://deveiate.org/code/zyre/History_md.html
   source_uri: https://gitlab.com/ravngroup/open-source/ruby-zyre/-/tree/master
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -222,8 +222,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A ZRE library for Ruby.
 test_files: []