terminalwire 0.1.11 → 0.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55ab6e5d0132726c5041fce03026f14963c2de4b60a2bc92cd2560b7f14890cf
-  data.tar.gz: b2f1d360f6135fddf2ab90ca5ad992f1e313ccd4de09cd8bca9314b6af0dbaac
+  metadata.gz: 1b3e02592c8154c835d32f4dc149d47212665f5dd2974d2634746207ced582b3
+  data.tar.gz: 0a4b15090653b5b54a10a215db6a39ee5465cac9a10c4e1cd29ba7fc0622822a
 SHA512:
-  metadata.gz: 5f003df286a23cff8e92c92d5372f81dc7cc0a915b1d32a6ba8c0bd5005a54395286b9a72aad2d6cc9856d0e6ba2c1622757a6bfbf8aba343885e55b42980227
-  data.tar.gz: eb480c644c568de7b6391a4e3310219fbf64869972eaeac7f0d4a7a6365b8fb644edd0193ae3920df604b3044b14fdfc09f05aa39a491be5d634ab084d8058d3
+  metadata.gz: d74b1186e46a73eb62de35f0624f20a4f3f90aa8bf24137b772423a87a09bea920886824d7175c5b08bd18c963b3823c4cccbff0e7abd44120bfe186edda84e6
+  data.tar.gz: 9997f63145801d3ca47476ead70f49ac001f77765cb777063b44b62d96e1b3dfdf266f42897fae01eb0a9a224e8fddeb5e878533e773f11aaafe2e81512a48f4

data/LICENSE.txt

@@ -1 +1,9 @@
-Copyright (c) 2024 Brad Gessler. Email brad@terminalwire.com to discuss licensing.
+Copyright (c) 2024 Brad Gessler.
+
+License is propietary. Here's the deal:
+
+* You need to pay for Terminalwire if your organization has more than $1m in assets or makes more than $100k/year in revenue.
+* Terminalwire is free for personal use, hobbyists, or businesses that are just starting out, but server licenses still need to be registered at https://terminalwire.com/developers/licenses.
+* You can only use the Terminalwire client with licensed Terminalwire servers.
+
+This list is not exhaustive, please read the full license text at https://terminalwire.com/license.

data/lib/generators/terminalwire/install/install_generator.rb

@@ -7,6 +7,7 @@ class Terminalwire::InstallGenerator < Rails::Generators::Base
 
   def create_terminal_files
     template "application_terminal.rb.tt", Rails.root.join("app/terminal/application_terminal.rb")
+    template "main_terminal.rb", Rails.root.join("app/terminal/main_terminal.rb")
   end
 
   def create_binary_files
@@ -17,7 +18,7 @@ class Terminalwire::InstallGenerator < Rails::Generators::Base
   def add_route
     route <<~ROUTE
       match "/terminal",
-        to: Terminalwire::Server::Thor.new(ApplicationTerminal),
+        to: Terminalwire::Server::Thor.new(MainTerminal),
         via: [:get, :connect]
     ROUTE
   end

data/lib/generators/terminalwire/install/templates/application_terminal.rb.tt

@@ -1,44 +1,11 @@
 # Learn how to use Thor at http://whatisthor.com.
 class ApplicationTerminal < Thor
+  # Enables IO Streaming.
   include Terminalwire::Thor
 
+  # The name of your binary. Thor uses this for its help output.
   def self.basename = "<%= binary_name %>"
 
-  desc "hello NAME", "say hello to NAME"
-  def hello(name)
-    puts "Hello #{name}"
-  end
-
-  desc "login", "Login to your account"
-  def login
-    print "Email: "
-    email = gets.chomp
-
-    print "Password: "
-    password = getpass
-
-    if self.current_user = User.authenticate(email, password)
-      puts "Successfully logged in as #{current_user.email}."
-    else
-      puts "Could not find a user with that email and password."
-    end
-  end
-
-  desc "whoami", "Displays current user information."
-  def whoami
-    if self.current_user
-      puts "Logged in as #{current_user.email}."
-    else
-      puts "Not logged in. Run `#{self.class.basename} login` to login."
-    end
-  end
-
-  desc "logout", "Logout of your account"
-  def logout
-    session.reset
-    puts "Successfully logged out."
-  end
-
   private
 
   def current_user=(user)

data/lib/generators/terminalwire/install/templates/main_terminal.rb

@@ -0,0 +1,40 @@
+class MainTerminal < ApplicationTerminal
+  desc "hello NAME", "say hello to NAME"
+  def hello(name)
+    puts "Hello #{name}"
+  end
+
+  desc "login", "Login to your account"
+  def login
+    print "Email: "
+    email = gets.chomp
+
+    print "Password: "
+    password = getpass
+
+    # Replace this with your own authentication logic; this is an example
+    # of how you might do this with Devise.
+    user = User.find_for_authentication(email: email)
+    if user && user.valid_password?(password)
+      self.current_user = user
+      puts "Successfully logged in as #{current_user.email}."
+    else
+      puts "Could not find a user with that email and password."
+    end
+  end
+
+  desc "whoami", "Displays current user information."
+  def whoami
+    if self.current_user
+      puts "Logged in as #{current_user.email}."
+    else
+      puts "Not logged in. Run `#{self.class.basename} login` to login."
+    end
+  end
+
+  desc "logout", "Logout of your account"
+  def logout
+    session.reset
+    puts "Successfully logged out."
+  end
+end

data/lib/terminalwire/client.rb

@@ -28,13 +28,15 @@ module Terminalwire
       end
 
       def connect
-        @adapter.write(event: "initialization",
-         protocol: { version: VERSION },
-         entitlement: @entitlement.serialize,
-         program: {
-           name: @program_name,
-           arguments: @program_arguments
-         })
+        @adapter.write(
+          event: "initialization",
+          protocol: { version: VERSION },
+          entitlement: @entitlement.serialize,
+          program: {
+            name: @program_name,
+            arguments: @program_arguments
+          }
+        )
 
         loop do
           handle @adapter.read
@@ -51,20 +53,6 @@ module Terminalwire
       end
     end
 
-    def self.tcp(...)
-      socket = TCPSocket.new(...)
-      transport = Terminalwire::Transport::Socket.new(socket)
-      adapter = Terminalwire::Adapter::Socket.new(transport)
-      Terminalwire::Client::Handler.new(adapter)
-    end
-
-    def self.socket(...)
-      socket = UNIXSocket.new(...)
-      transport = Terminalwire::Transport::Socket.new(socket)
-      adapter = Terminalwire::Adapter::Socket.new(transport)
-      Terminalwire::Client::Handler.new(adapter)
-    end
-
     # Extracted from HTTP. This is so we can
     def self.authority(url)
       if url.port == url.default_port

data/lib/terminalwire/licensing.rb

@@ -0,0 +1,183 @@
+require "msgpack"
+require "openssl"
+require "base64"
+require "uri"
+
+module Terminalwire::Licensing
+  PRIVATE_KEY_LENGTH = 2048
+
+  def self.generate_private_key
+    OpenSSL::PKey::RSA.new(PRIVATE_KEY_LENGTH)
+  end
+
+  def self.generate_private_pem
+    generate_private_key.to_pem
+  end
+
+  # Handles encoding data into a license key with prefixes that can be packed and unpacked.
+  module Key
+    # Mix into classes that need to generate or read keys
+    module Serialization
+      # This is called when the module is included in a class
+      def self.included(base)
+        # Extend the class with the class methods when the module is included
+        base.extend(ClassMethods)
+      end
+
+      def serialize(...)
+        self.class.serialize(...)
+      end
+
+      # Define the class methods that will be available on the including class
+      module ClassMethods
+        def serializer
+          Key::Serializer.new(prefix: self::PREFIX)
+        end
+
+        def serialize(...)
+          serializer.serialize(...)
+        end
+
+        def deserialize(...)
+          serializer.deserialize(...)
+        end
+      end
+    end
+
+    class Serializer
+      attr_reader :prefix
+
+      def initialize(prefix:)
+        @prefix = prefix
+      end
+
+      def serialize(data)
+        prepend_prefix Base64.urlsafe_encode64 MessagePack.pack data
+      end
+
+      def deserialize(data)
+        MessagePack.unpack Base64.urlsafe_decode64 unshift_prefix data
+      end
+
+      protected
+
+      def prepend_prefix(key)
+        [prefix, key].join
+      end
+
+      def unshift_prefix(key)
+        head, prefix, tail = key.partition(@prefix)
+        # Check if partition successfully split the string with the correct prefix
+        raise RuntimeError, "Expected prefix #{@prefix.inspect} on #{key.inspect}" if prefix.empty?
+        tail
+      end
+    end
+  end
+
+  # This code all runs on Terminalwire servers.
+  module Issuer
+    # Generates license keys that developers use to activate their software.
+    class ServerKeyGenerator
+      include Key::Serialization
+
+      PREFIX = "server_key_".freeze
+
+      VERSION = "1.0".freeze
+
+      def initialize(public_key:, license_url:)
+        @public_key = public_key
+        @license_url = URI(license_url)
+        @generated_at = Time.now.utc
+      end
+
+      def to_h
+        {
+          version: VERSION,
+          generated_at: @generated_at.iso8601,
+          public_key: @public_key.to_pem,
+          license_url: @license_url.to_s
+        }
+      end
+
+      def server_key
+        serialize to_h
+      end
+      alias :to_s :server_key
+    end
+
+    class ClientKeyVerifier
+      # Time variance the server will tolerate from the client.
+      DRIFT_SECONDS = 600 # 600 seconds, or 10 minutes.
+
+      # This means the server will tolerate a 10 minute drift in the generated_at time.
+      def self.drift
+        now = Time.now.utc
+        (now - DRIFT_SECONDS)...(now + DRIFT_SECONDS)
+      end
+
+      def initialize(client_key:, private_key:, drift: self.class.drift)
+        @data = Server::ClientKeyGenerator.deserialize client_key
+        @private_key = private_key
+        @drift = drift
+      end
+
+      def server_attestation
+        @server_attestation ||= decrypt @data.fetch("server_attestation")
+      end
+
+      def decrypt(data)
+        MessagePack.unpack @private_key.private_decrypt Base64.urlsafe_decode64 data
+      end
+
+      def generated_at
+        @generated_at ||= Time.parse(server_attestation.fetch("generated_at"))
+      end
+
+      def valid?
+        @drift.include? generated_at
+      end
+    end
+  end
+
+  # Those code runs on customer servers
+  module Server
+    class ClientKeyGenerator
+      VERSION = "1.0".freeze
+
+      include Key::Serialization
+      PREFIX = "client_key_".freeze
+
+      def initialize(server_key:)
+        @data = Issuer::ServerKeyGenerator.deserialize server_key
+        @generated_at = Time.now.utc
+        @license_url = URI(@data.fetch("license_url"))
+      end
+
+      def to_h
+        {
+          version: VERSION,
+          license_url: @license_url.to_s,
+          server_attestation: attest(
+            version: VERSION,
+            generated_at: @generated_at.iso8601,
+          )
+        }
+      end
+
+      def client_key
+        serialize to_h
+      end
+      alias :to_s :client_key
+
+      protected
+
+      def attest(data)
+        Base64.urlsafe_encode64 public_key.public_encrypt MessagePack.pack data
+      end
+
+      def public_key
+        @public_key ||= OpenSSL::PKey::RSA.new(@data.fetch("public_key"))
+      end
+    end
+  end
+end

data/lib/terminalwire/logging.rb

@@ -2,7 +2,7 @@ require 'logger'
 
 module Terminalwire
   module Logging
-    DEVICE = Logger.new($stdout, level: ENV.fetch("LOG_LEVEL", "info"))
+    DEVICE = Logger.new($stdout, level: ENV.fetch("TERMINALWIRE_LOG_LEVEL", "info"))
     def logger = DEVICE
   end
 end

data/lib/terminalwire/server.rb

@@ -2,57 +2,16 @@ require "thor"
 
 module Terminalwire
   module Server
-    class MyCLI < ::Thor
-      include Terminalwire::Thor
-
-      desc "greet NAME", "Greet a person"
-      def greet(name)
-        name = ask "What's your name?"
-        say "Hello, #{name}!"
-      end
-    end
-
-    class Socket
-      include Logging
-
-      def initialize(server_socket)
-        @server_socket = server_socket
-      end
-
-      def listen
-        logger.info "Socket: Listening..."
-        loop do
-          client_socket = @server_socket.accept
-          logger.debug "Socket: Client #{client_socket.inspect} connected"
-          handle_client(client_socket)
-        end
-      end
-
-      private
-
-      def handle_client(socket)
-        transport = Transport::Socket.new(socket)
-        adapter = Adapter.new(transport)
-
-        Thread.new do
-          handler = Handler.new(adapter)
-          handler.run
-        end
-      end
-    end
-
     class WebSocket
       include Logging
 
       def call(env)
         Async::WebSocket::Adapters::Rack.open(env, protocols: ['ws']) do |connection|
-          run(Adapter::Socket.new(Terminalwire::Transport::WebSocket.new(connection)))
+          handle(Adapter::Socket.new(Terminalwire::Transport::WebSocket.new(connection)))
         end or [200, { "Content-Type" => "text/plain" }, ["Connect via WebSockets"]]
       end
 
-      private
-
-      def run(adapter)
+      def handle(adapter)
         while message = adapter.read
           puts message
         end
@@ -76,7 +35,7 @@ module Terminalwire
         "An error occurred. Please try again."
       end
 
-      def run(adapter)
+      def handle(adapter)
         logger.info "ThorServer: Running #{@cli_class.inspect}"
         while message = adapter.read
           case message
@@ -100,38 +59,5 @@ module Terminalwire
         end
       end
     end
-
-    class Handler
-      include Logging
-
-      def initialize(adapter)
-        @adapter = adapter
-      end
-
-      def run
-        logger.info "Server Handler: Running"
-        loop do
-          message = @adapter.read
-          case message
-          in { event: "initialization", protocol:, program: { arguments: }, entitlement: }
-            Context.new(adapter: @adapter) do |context|
-              MyCLI.start(arguments, context:)
-            end
-          end
-        end
-      rescue EOFError, Errno::ECONNRESET
-        logger.info "Server Handler: Client disconnected"
-      ensure
-        @adapter.close
-      end
-    end
-
-    def self.tcp(...)
-      Server::Socket.new(TCPServer.new(...))
-    end
-
-    def self.socket(...)
-      Server::Socket.new(UNIXServer.new(...))
-    end
   end
 end

data/lib/terminalwire/transport.rb

@@ -1,5 +1,4 @@
 require 'uri'
-require 'socket'
 require 'async/websocket/client'
 
 module Terminalwire
@@ -26,70 +25,6 @@ module Terminalwire
       end
     end
 
-    class TCP < Base
-      def self.connect(url)
-        uri = URI(url)
-        new(TCPSocket.new(uri.host, uri.port))
-      end
-
-      def self.listen(url)
-        uri = URI(url)
-        new(TCPServer.new(uri.host, uri.port))
-      end
-
-      def initialize(socket)
-        @socket = socket
-      end
-
-      def read
-        length = @socket.read(4)
-        return nil if length.nil?
-        length = length.unpack('L>')[0]
-        @socket.read(length)
-      end
-
-      def write(data)
-        length = [data.bytesize].pack('L>')
-        @socket.write(length + data)
-      end
-
-      def close
-        @socket.close
-      end
-    end
-
-    class Unix < Base
-      def self.connect(url)
-        uri = URI(url)
-        new(UNIXSocket.new(uri.path))
-      end
-
-      def self.listen(url)
-        uri = URI(url)
-        new(UNIXServer.new(uri.path))
-      end
-
-      def initialize(socket)
-        @socket = socket
-      end
-
-      def read
-        length = @socket.read(4)
-        return nil if length.nil?
-        length = length.unpack('L>')[0]
-        @socket.read(length)
-      end
-
-      def write(data)
-        length = [data.bytesize].pack('L>')
-        @socket.write(length + data)
-      end
-
-      def close
-        @socket.close
-      end
-    end
-
     class WebSocket < Base
       def self.connect(url)
         uri = URI(url)

data/lib/terminalwire/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Terminalwire
-  VERSION = "0.1.11"
+  VERSION = "0.1.13"
 end

data/lib/terminalwire.rb

@@ -2,7 +2,6 @@
 
 require_relative "terminalwire/version"
 
-require 'socket'
 require 'forwardable'
 require 'uri'
 require 'zeitwerk'
@@ -40,10 +39,6 @@ module Terminalwire
         respond(status: "success", response:, **data)
       end
 
-      def self.protocol_key
-        name.split("::").last.downcase
-      end
-
       private
 
       def respond(**response)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: terminalwire
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.13
 platform: ruby
 authors:
 - Brad Gessler
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-02 00:00:00.000000000 Z
+date: 2024-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-websocket
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.25'
+        version: '0.30'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.25'
+        version: '0.30'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -158,12 +158,14 @@ files:
 - lib/generators/terminalwire/install/install_generator.rb
 - lib/generators/terminalwire/install/templates/application_terminal.rb.tt
 - lib/generators/terminalwire/install/templates/bin/terminalwire
+- lib/generators/terminalwire/install/templates/main_terminal.rb
 - lib/terminalwire.rb
 - lib/terminalwire/adapter.rb
 - lib/terminalwire/client.rb
 - lib/terminalwire/client/entitlement.rb
 - lib/terminalwire/client/exec.rb
 - lib/terminalwire/client/resource.rb
+- lib/terminalwire/licensing.rb
 - lib/terminalwire/logging.rb
 - lib/terminalwire/rails.rb
 - lib/terminalwire/server.rb
@@ -175,7 +177,7 @@ files:
 - sig/terminalwire.rbs
 homepage: https://terminalwire.com/ruby
 licenses:
-- Proprietary
+- Proprietary (https://terminalwire.com/license)
 metadata:
   allowed_push_host: https://rubygems.org/
   homepage_uri: https://terminalwire.com/ruby