omq-cli 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a68efaffe40870b21e4fa8d94fb99efb40dddc96cc68fd0ebaa232373073c35b
-  data.tar.gz: 0b817664632dbd6a83844562cf79b296493da2438526675f65801e85305add2a
+  metadata.gz: 7b1d3b2b127f70f0c59d6e008de4b4f94a0886012819953a3028ca346ecc1feb
+  data.tar.gz: a1e912d9aec54b22e4467cb7b2e24c3765333feb5b5fd83cbfc2fa27e0b6a3b9
 SHA512:
-  metadata.gz: a4c3df6862c4820561ac8f7c8c1f60d89caac4c538a9bce7cbce7daeff2abdf0e33c63520e46a36cad291a8d1255eb934516041a1a723e00893c22a2926ba0f7
-  data.tar.gz: ee47b7dc9f0becaf518532a70a724dc998a2df1a59d80bb525bf9cc597e61df2688577c2cf748b0949121e60f5544b4f0ec066f40fdb01e24eccd423a21121d4
+  metadata.gz: e773ac7df2e7aab7212491ded8c85fe7b6591ec5c4f3553efcac5f23786f54db9fc20b25af5df835e4b0ae17e1117ad63178e3429e616fc18bf00a43f2ca8eee
+  data.tar.gz: 6ef6c64204c54e18f8f3fced595ac4b0b3f36299f528cca981dc34876fa654a73c744be1324318a5fd0f2308f002d594779654facc143f5c19096d18534a39cf

data/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog
+
+## 0.2.0 — 2026-03-31
+
+### Added
+
+- **`omq keygen`** — generates a persistent CURVE keypair (Z85-encoded
+  env vars). Supports `--curve-crypto rbnacl|nuckle` and the
+  `OMQ_CURVE_CRYPTO` env var.
+- **`--curve-crypto BACKEND`** — explicit crypto backend selection for
+  CURVE encryption. Defaults to rbnacl if installed; no silent fallback
+  to nuckle.
+- **`-v` logs crypto backend** — `omq keygen -v` and socket commands
+  with `-v` log which CURVE backend was loaded.
+
+### Changed
+
+- **CURVE uses protocol-zmtp** — replaces the old omq-curve gem with
+  `Protocol::ZMTP::Mechanism::Curve` and a pluggable `crypto:` backend.
+- **`load_curve_crypto` is a CLI module method** — shared between
+  `omq keygen` and socket runners.
+
+## 0.1.0 — 2026-03-31
+
+Initial release — CLI extracted from the omq gem (v0.8.0).

data/README.md

@@ -338,6 +338,20 @@ omq push -c tcp://remote:5557 -z < data.txt
 omq pull -b tcp://:5557 -z
 ```
 
+## Key generation
+
+Generate a persistent CURVE keypair:
+
+```sh
+omq keygen
+# OMQ_SERVER_PUBLIC='...'
+# OMQ_SERVER_SECRET='...'
+
+omq keygen --curve-crypto nuckle   # pure Ruby backend
+```
+
+Export the vars, then use `--curve-server` (server) or `--curve-server-key` (client).
+
 ## CURVE encryption
 
 End-to-end encryption using CurveZMQ. Requires a crypto backend:

data/lib/omq/cli/base_runner.rb

@@ -157,7 +157,7 @@ module OMQ
 
         return unless server_key_z85 || server_mode
 
-        crypto = load_curve_crypto(config.curve_crypto || ENV["OMQ_CURVE_CRYPTO"])
+        crypto = CLI.load_curve_crypto(config.curve_crypto || ENV["OMQ_CURVE_CRYPTO"], verbose: config.verbose)
         require "protocol/zmtp/mechanism/curve"
 
         if server_key_z85
@@ -184,27 +184,6 @@ module OMQ
       end
 
 
-      def load_curve_crypto(name)
-        case name&.downcase
-        when "rbnacl" then require "rbnacl"; RbNaCl
-        when "nuckle" then require "nuckle"; Nuckle
-        when nil
-          begin
-            require "rbnacl"; RbNaCl
-          rescue LoadError
-            abort "CURVE requires a crypto backend. Install rbnacl (recommended):\n" \
-                  "  gem install rbnacl    # requires system libsodium\n" \
-                  "Or use pure Ruby (not audited):\n" \
-                  "  --curve-crypto nuckle\n" \
-                  "  # or: OMQ_CURVE_CRYPTO=nuckle"
-          end
-        else
-          abort "Unknown CURVE crypto backend: #{name}. Use 'rbnacl' or 'nuckle'."
-        end
-      rescue LoadError
-        abort "Could not load #{name} gem: gem install #{name}"
-      end
-
       # ── Shared loop bodies ──────────────────────────────────────────
 
 

data/lib/omq/cli/version.rb

@@ -2,6 +2,6 @@
 
 module OMQ
   module CLI
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/omq/cli.rb

@@ -267,10 +267,88 @@ module OMQ
     end
 
 
+    def run(argv = ARGV)
+      case argv.first
+      when "keygen"
+        argv.shift
+        run_keygen(argv)
+      else
+        run_socket(argv)
+      end
+    end
+
+
+    # Generates a persistent CURVE keypair and prints it as
+    # Z85-encoded env vars.
+    #
+    def run_keygen(argv)
+      crypto_name = nil
+      verbose     = false
+      while (arg = argv.shift)
+        case arg
+        when "--curve-crypto"
+          crypto_name = argv.shift
+        when "-v", "--verbose"
+          verbose = true
+        when "-h", "--help"
+          puts "Usage: omq keygen [--curve-crypto rbnacl|nuckle] [-v]\n\n" \
+               "Generates a CURVE keypair for persistent server identity.\n" \
+               "Output: Z85-encoded env vars for use with --curve-server."
+          exit
+        else
+          abort "omq keygen: unknown option: #{arg}"
+        end
+      end
+      crypto_name ||= ENV["OMQ_CURVE_CRYPTO"]
+
+      crypto = load_curve_crypto(crypto_name, verbose: verbose)
+      require "protocol/zmtp/mechanism/curve"
+      require "protocol/zmtp/z85"
+
+      key = crypto::PrivateKey.generate
+      puts "OMQ_SERVER_PUBLIC='#{Protocol::ZMTP::Z85.encode(key.public_key.to_s)}'"
+      puts "OMQ_SERVER_SECRET='#{Protocol::ZMTP::Z85.encode(key.to_s)}'"
+    end
+
+
+    # Loads the named NaCl-compatible crypto backend.
+    #
+    # @param name [String, nil] "rbnacl", "nuckle", or nil (auto-detect rbnacl)
+    # @param verbose [Boolean] log which backend was loaded to stderr
+    # @return [Module] RbNaCl or Nuckle
+    #
+    def load_curve_crypto(name, verbose: false)
+      crypto = case name&.downcase
+      when "rbnacl"
+        require "rbnacl"
+        RbNaCl
+      when "nuckle"
+        require "nuckle"
+        Nuckle
+      when nil
+        begin
+          require "rbnacl"; RbNaCl
+        rescue LoadError
+          abort "CURVE requires a crypto backend. Install rbnacl (recommended):\n" \
+                "  gem install rbnacl    # requires system libsodium\n" \
+                "Or use pure Ruby (not audited):\n" \
+                "  --curve-crypto nuckle\n" \
+                "  # or: OMQ_CURVE_CRYPTO=nuckle"
+        end
+      else
+        abort "Unknown CURVE crypto backend: #{name}. Use 'rbnacl' or 'nuckle'."
+      end
+      $stderr.puts "omq: CURVE crypto backend: #{crypto.name}" if verbose
+      crypto
+    rescue LoadError
+      abort "Could not load #{name} gem: gem install #{name}"
+    end
+
+
     # Parses CLI arguments, validates options, and runs the main
     # event loop inside an Async reactor.
     #
-    def run(argv = ARGV)
+    def run_socket(argv)
       config = build_config(argv)
 
       require "omq"
@@ -454,7 +532,15 @@ module OMQ
         o.on("-v", "--verbose",     "Print connection events to stderr") { opts[:verbose] = true }
         o.on("-q", "--quiet",       "Suppress message output")          { opts[:quiet] = true }
         o.on(      "--transient",   "Exit when all peers disconnect")   { opts[:transient] = true }
-        o.on("-V", "--version")     { require "omq"; puts "omq-cli #{OMQ::CLI::VERSION} (omq #{OMQ::VERSION})"; exit }
+        o.on("-V", "--version") {
+          if ENV["OMQ_DEV"]
+            require_relative "../../../omq/lib/omq/version"
+          else
+            require "omq/version"
+          end
+          puts "omq-cli #{OMQ::CLI::VERSION} (omq #{OMQ::VERSION})"
+          exit
+        }
         o.on("-h")                  { puts o; exit }
         o.on(      "--help")        { page "#{o}\n#{EXAMPLES}"; exit }
         o.on(      "--examples")    { page EXAMPLES; exit }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omq-cli
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Patrik Wenger
@@ -35,6 +35,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE
 - README.md
 - exe/omq