nanokvm 0.1.0

data/lib/nanokvm/client.rb

@@ -0,0 +1,373 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "uri"
+require "json"
+require "openssl"
+require "base64"
+require "digest/md5"
+require "open3"
+require "cgi"
+
+module NanoKVM
+  class Client
+    attr_reader :host, :username
+    attr_accessor :token, :debug
+    
+    def initialize(options = {})
+      @host = options[:host] || NanoKVM.configuration.default_host
+      @username = options[:username] || NanoKVM.configuration.default_username
+      @password = options[:password] || NanoKVM.configuration.default_password
+      @token = options[:token]
+      @debug = options[:debug]
+      @secret_key = options[:secret_key] || NanoKVM::DEFAULT_SECRET_KEY
+      
+      raise ArgumentError, "Host is required" unless @host
+    end
+    
+    def login
+      puts "Attempting to authenticate with NanoKVM..." if @debug
+      
+      # Encrypt and encode password
+      puts "Encrypting password..." if @debug
+      obfuscated_password = obfuscate_password(@password)
+      puts "Obfuscated password: #{obfuscated_password}" if @debug
+      
+      # Create the JSON payload - the password is already URI encoded
+      payload = { username: @username, password: obfuscated_password }.to_json
+      puts "Login payload: #{payload}" if @debug
+      
+      # Send the request
+      response = post("/api/auth/login", payload)
+      @token = response.dig("data", "token")
+      
+      raise AuthenticationError, "Failed to authenticate" unless @token
+      
+      puts "Authentication successful, token: #{@token}" if @debug
+      @token
+    end
+    
+    def get_device_info
+      get("/api/vm/info")
+    end
+    
+    def get_gpio_state
+      get("/api/vm/gpio")
+    end
+    
+    def power_button(duration = 800)
+      payload = {
+        type: "power",
+        duration: duration
+      }.to_json
+      
+      post("/api/vm/gpio", payload)
+    end
+    
+    def reset_button(duration = 200)
+      payload = {
+        type: "reset",
+        duration: duration
+      }.to_json
+      
+      post("/api/vm/gpio", payload)
+    end
+    
+    def get_available_images
+      get("/api/storage/image")
+    end
+    
+    def get_mounted_image
+      get("/api/storage/image/mounted")
+    end
+    
+    def mount_image(file_path)
+      payload = {
+        file: file_path
+      }.to_json
+      
+      post("/api/storage/image/mount", payload)
+    end
+    
+    def get_virtual_device_status
+      get("/api/vm/device/virtual")
+    end
+    
+    def toggle_virtual_device(device)
+      payload = {
+        device: device
+      }.to_json
+      
+      post("/api/vm/device/virtual", payload)
+    end
+    
+    def send_text(content)
+      payload = {
+        content: content
+      }.to_json
+      
+      post("/api/hid/paste", payload)
+    end
+    
+    def reset_hid
+      post("/api/hid/reset", "{}")
+    end
+    
+    def get_account_info
+      get("/api/auth/account")
+    end
+    
+    def get_network_info
+      get("/api/network/wifi")
+    end
+    
+    def get_app_version
+      get("/api/application/version")
+    end
+    
+    def system_reboot
+      post("/api/vm/system/reboot", "{}")
+    end
+    
+    def reset_hdmi
+      post("/api/vm/hdmi/reset", "{}")
+    end
+    
+    def is_password_updated
+      get("/api/auth/password")
+    end
+    
+    def get_tailscale_status
+      get("/api/extensions/tailscale/status")
+    end
+    
+    def is_download_image_enabled
+      get("/api/download/image/enabled")
+    end
+    
+    def get_download_image_status
+      get("/api/download/image/status")
+    end
+    
+    def download_image(url)
+      payload = {
+        file: url
+      }.to_json
+      
+      post("/api/download/image", payload)
+    end
+    
+    def get_hardware_info
+      get("/api/vm/hardware")
+    end
+    
+    def get_script_info
+      get("/api/vm/script")
+    end
+    
+    def get_memory_limit
+      get("/api/vm/memory/limit")
+    end
+    
+    def set_memory_limit(enabled, limit_mb)
+      payload = {
+        enabled: enabled,
+        limit: limit_mb
+      }.to_json
+      
+      post("/api/vm/memory/limit", payload)
+    end
+    
+    def get_oled_info
+      get("/api/vm/oled")
+    end
+    
+    def set_oled_sleep(sleep_seconds)
+      payload = {
+        sleep: sleep_seconds
+      }.to_json
+      
+      post("/api/vm/oled", payload)
+    end
+    
+    def get_ssh_status
+      get("/api/vm/ssh")
+    end
+    
+    def get_mdns_status
+      get("/api/vm/mdns")
+    end
+    
+    def get_cdrom_info
+      get("/api/storage/cdrom")
+    end
+    
+    def get_wol_mac
+      get("/api/network/wol/mac")
+    end
+    
+    def get_hid_mode
+      get("/api/hid/mode")
+    end
+    
+    def set_hid_mode(mode)
+      payload = {
+        mode: mode
+      }.to_json
+      
+      post("/api/hid/mode", payload)
+    end
+    
+    def get_preview_state
+      get("/api/application/preview")
+    end
+    
+    def set_preview_state(enable)
+      payload = {
+        enable: enable
+      }.to_json
+      
+      post("/api/application/preview", payload)
+    end
+    
+    def get_interface_status
+      # Collect information from multiple endpoints
+      data = {}
+      
+      # Get virtual device status for ethernet
+      begin
+        virtual_devices = get_virtual_device_status["data"]
+        data["eth_status"] = virtual_devices["network"] ? "CONNECTED" : "DISCONNECTED" if virtual_devices.key?("network")
+      rescue => e
+        # Ignore errors
+      end
+      
+      # Get HID mode
+      begin
+        hid_info = get_hid_mode["data"]
+        data["hid_mode"] = hid_info["mode"] if hid_info.key?("mode")
+        data["hid_status"] = "CONNECTED" # Assume connected if we can get mode
+      rescue => e
+        # Ignore errors
+      end
+      
+      # Get GPIO status for LEDs
+      begin
+        gpio = get_gpio_state["data"]
+        # Map LED states to status
+        data["pwr_led"] = gpio["pwr"] ? "ON" : "OFF" if gpio.key?("pwr")
+        data["hdd_led"] = gpio["hdd"] ? "ON" : "OFF" if gpio.key?("hdd")
+      rescue => e
+        # Ignore errors
+      end
+      
+      # Get device info for any additional information
+      begin
+        info = get_device_info["data"]
+        data["device_ip"] = info["ip"] if info.key?("ip")
+        data["application_version"] = info["application"] if info.key?("application")
+      rescue => e
+        # Ignore errors
+      end
+      
+      # Get hardware info
+      begin
+        hardware = get_hardware_info["data"]
+        # Add hardware info
+        hardware.each do |key, value|
+          data[key] = value
+        end
+      rescue => e
+        # Ignore errors
+      end
+      
+      # Note about HDMI status
+      data["hdmi_status"] = "NOT AVAILABLE VIA API" # The API doesn't provide HDMI status
+      data["hdmi_note"] = "HDMI status only visible on device screen"
+      
+      # Return all collected data
+      { "code" => 0, "msg" => "success", "data" => data }
+    end
+    
+    private
+    
+    # Key derivation
+    def derive_encryption_keys(password, salt, key_len: 32, iv_len: 16)
+      derived = ""
+      block = ""
+      
+      while derived.length < (key_len + iv_len)
+        block = OpenSSL::Digest::MD5.digest(block + password + salt)
+        derived += block
+      end
+      
+      [derived[0, key_len], derived[key_len, iv_len]]
+    end
+    
+    # Encryption
+    def encrypt_with_aes(plaintext, password)
+      salt = OpenSSL::Random.random_bytes(8)
+      key, iv = derive_encryption_keys(password, salt)
+      
+      cipher = OpenSSL::Cipher.new('AES-256-CBC')
+      cipher.encrypt
+      cipher.key = key
+      cipher.iv = iv
+      
+      encrypted = cipher.update(plaintext) + cipher.final
+      
+      "Salted__" + salt + encrypted
+    end
+    
+    # Password obfuscation
+    def obfuscate_password(password)
+      encrypted = encrypt_with_aes(password, @secret_key)
+      encoded = Base64.strict_encode64(encrypted)
+      URI.encode_www_form_component(encoded)
+    end
+    
+    def get(path)
+      uri = URI.parse("http://#{@host}#{path}")
+      request = Net::HTTP::Get.new(uri)
+      request["Cookie"] = "nano-kvm-token=#{@token}" if @token
+      
+      handle_response(uri, request)
+    end
+    
+    def post(path, payload)
+      uri = URI.parse("http://#{@host}#{path}")
+      request = Net::HTTP::Post.new(uri)
+      request.content_type = "application/json"
+      request["Cookie"] = "nano-kvm-token=#{@token}" if @token
+      request.body = payload
+      
+      puts "POST to #{uri} with body: #{payload}" if @debug
+      
+      handle_response(uri, request)
+    end
+    
+    def handle_response(uri, request)
+      response = Net::HTTP.start(uri.hostname, uri.port) do |http|
+        http.request(request)
+      end
+      
+      puts "Response body: #{response.body}" if @debug
+      
+      if response.body.to_s.strip.empty? || response.body.include?("page not found")
+        raise ApiError, "Invalid endpoint or empty response: #{uri.path}"
+      end
+      
+      body = JSON.parse(response.body)
+      
+      if body["code"] != 0
+        raise ApiError, "API Error: #{body['msg']}"
+      end
+      
+      body
+    rescue JSON::ParserError => e
+      raise ApiError, "Invalid JSON response: #{e.message}. Response: #{response.body}"
+    rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH, SocketError => e
+      raise ConnectionError, "Could not connect to NanoKVM: #{e.message}"
+    end
+  end
+end 

data/lib/nanokvm/errors.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module NanoKVM
+  class Error < StandardError; end
+  class AuthenticationError < Error; end
+  class ConnectionError < Error; end
+  class ApiError < Error; end
+end 

data/lib/nanokvm/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module NanoKVM
+  VERSION = "0.1.0"
+end 

data/lib/nanokvm.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "nanokvm/version"
+require_relative "nanokvm/client"
+require_relative "nanokvm/errors"
+require_relative "nanokvm/cli"
+
+module NanoKVM
+  # Module constants
+  DEFAULT_SECRET_KEY = "nanokvm-sipeed-2024"
+  DEFAULT_USERNAME = "admin"
+  DEFAULT_PASSWORD = "admin"
+  
+  class << self
+    attr_accessor :configuration
+
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration) if block_given?
+    end
+  end
+
+  class Configuration
+    attr_accessor :default_host, :default_username, :default_password, :default_secret_key
+
+    def initialize
+      @default_host = nil
+      @default_username = DEFAULT_USERNAME
+      @default_password = DEFAULT_PASSWORD
+      @default_secret_key = DEFAULT_SECRET_KEY
+    end
+  end
+
+  # Initialize with defaults
+  configure
+end 

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: nanokvm
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jonathan Siegel
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cgi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Ruby client library and CLI for controlling NanoKVM devices via their
+  REST API
+email:
+- "<248302+usiegj00@users.noreply.github.com>"
+executables:
+- nanokvm
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- README.md
+- bin/nanokvm
+- lib/nanokvm.rb
+- lib/nanokvm/cli.rb
+- lib/nanokvm/client.rb
+- lib/nanokvm/errors.rb
+- lib/nanokvm/version.rb
+homepage: https://github.com/usiegj00/nanokvm
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/usiegj00/nanokvm
+  source_code_uri: https://github.com/usiegj00/nanokvm
+  changelog_uri: https://github.com/usiegj00/nanokvm/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: Ruby client for controlling NanoKVM devices
+test_files: []