opnsense_api 0.1.0

data/lib/opnsense_api/core/traffic_shaping/settings.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class TrafficShaping
+      # @see https://docs.opnsense.org/development/api/core/trafficshaper.html#id2
+      class Settings
+        include OPNsenseAPI::Core
+
+        BASE_PATH = '/trafficshaper/settings'
+
+        def add_pipe(body = {})
+          @client.post("#{BASE_PATH}/addPipe", body)
+        end
+
+        def add_queue(body = {})
+          @client.post("#{BASE_PATH}/addQueue", body)
+        end
+
+        def add_rule(body = {})
+          @client.post("#{BASE_PATH}/addRule", body)
+        end
+
+        def del_pipe(body = {}, uuid:)
+          @client.post("#{BASE_PATH}/delPipe/#{uuid}", body)
+        end
+
+        def del_queue(body = {}, uuid:)
+          @client.post("#{BASE_PATH}/delQueue/#{uuid}", body)
+        end
+
+        def del_rule(body = {}, uuid:)
+          @client.post("#{BASE_PATH}/delRule/#{uuid}", body)
+        end
+
+        def get(params = {})
+          @client.get("#{BASE_PATH}/get", params)
+        end
+
+        def get_pipe(params = {}, uuid: nil)
+          @client.get("#{BASE_PATH}/getPipe/#{uuid}", params)
+        end
+
+        def get_queue(params = {}, uuid: nil)
+          @client.get("#{BASE_PATH}/getQueue/#{uuid}", params)
+        end
+
+        def get_rule(params = {}, uuid: nil)
+          @client.get("#{BASE_PATH}/getRule/#{uuid}", params)
+        end
+
+        def search_pipes(body = {})
+          @client.post("#{BASE_PATH}/searchPipes", body)
+        end
+
+        def search_queues(body = {})
+          @client.post("#{BASE_PATH}/searchQueues", body)
+        end
+
+        def search_rules(body = {})
+          @client.post("#{BASE_PATH}/searchRules", body)
+        end
+
+        def set(body = {})
+          @client.post("#{BASE_PATH}/set", body)
+        end
+
+        def set_pipe(body = {}, uuid:)
+          @client.post("#{BASE_PATH}/setPipe/#{uuid}", body)
+        end
+
+        def set_queue(body = {}, uuid:)
+          @client.post("#{BASE_PATH}/setQueue/#{uuid}", body)
+        end
+
+        def set_rule(body = {}, uuid:)
+          @client.post("#{BASE_PATH}/setRule/#{uuid}", body)
+        end
+
+        def toggle_pipe(body = {}, uuid:, enabled: nil)
+          @client.post("#{BASE_PATH}/togglePipe/#{uuid}/#{enabled}", body)
+        end
+
+        def toggle_queue(body = {}, uuid:, enabled: nil)
+          @client.post("#{BASE_PATH}/toggleQueue/#{uuid}/#{enabled}", body)
+        end
+
+        def toggle_rule(body = {}, uuid:, enabled: nil)
+          @client.post("#{BASE_PATH}/toggleRule/#{uuid}/#{enabled}", body)
+        end
+      end
+    end
+  end
+end

data/lib/opnsense_api/core/traffic_shaping.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    # @see https://docs.opnsense.org/development/api/core/trafficshaper.html
+    class TrafficShaping
+      autoload :Service, 'opnsense_api/core/traffic_shaping/service'
+      autoload :Settings, 'opnsense_api/core/traffic_shaping/settings'
+
+      include OPNsenseAPI::Core
+
+      def service
+        Service.new(@client)
+      end
+
+      def settings
+        Settings.new(@client)
+      end
+    end
+  end
+end

data/lib/opnsense_api/core/unbound/diagnostics.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class Unbound
+      # @see https://docs.opnsense.org/development/api/core/unbound.html#id1
+      class Diagnostics
+        include OPNsenseAPI::Core
+
+        BASE_PATH = '/unbound/diagnostics'
+
+        def dump_cache(params = {})
+          @client.get("#{BASE_PATH}/dumpcache", params)
+        end
+
+        def dump_infra(params = {})
+          @client.get("#{BASE_PATH}/dumpinfra", params)
+        end
+
+        def list_insecure(params = {})
+          @client.get("#{BASE_PATH}/listinsecure", params)
+        end
+
+        def list_local_data(params = {})
+          @client.get("#{BASE_PATH}/listlocaldata", params)
+        end
+
+        def list_local_zones(params = {})
+          @client.get("#{BASE_PATH}/listlocalzones", params)
+        end
+
+        def stats(params = {})
+          @client.get("#{BASE_PATH}/stats", params)
+        end
+      end
+    end
+  end
+end

data/lib/opnsense_api/core/unbound/service.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class Unbound
+      # @see https://docs.opnsense.org/development/api/core/unbound.html#id2
+      class Service
+        include OPNsenseAPI::Core
+
+        BASE_PATH = '/diagnostics/service'
+
+        def dnsbl(params = {})
+          @client.get("#{BASE_PATH}/dnsbl", params)
+        end
+
+        def reconfigure(params = {})
+          @client.get("#{BASE_PATH}/reconfigure", params)
+        end
+
+        def restart(body = {})
+          @client.post("#{BASE_PATH}/restart", body)
+        end
+
+        def start(body = {})
+          @client.post("#{BASE_PATH}/start", body)
+        end
+
+        def status(params = {})
+          @client.get("#{BASE_PATH}/status", params)
+        end
+
+        def stop(body = {})
+          @client.post("#{BASE_PATH}/stop", body)
+        end
+      end
+    end
+  end
+end

data/lib/opnsense_api/core/unbound/settings.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class Unbound
+      # @see https://docs.opnsense.org/development/api/core/unbound.html#id3
+      class Settings
+        include OPNsenseAPI::Core
+
+        BASE_PATH = '/diagnostics/settings'
+
+        def add_domain_override(body = {})
+          @client.post("#{BASE_PATH}/addDomainOverride", body)
+        end
+
+        def add_forward(body = {})
+          @client.post("#{BASE_PATH}/addForward", body)
+        end
+
+        def add_host_alias(body = {})
+          @client.post("#{BASE_PATH}/addHostAlias", body)
+        end
+
+        def add_host_override(body = {})
+          @client.post("#{BASE_PATH}/addHostOverride", body)
+        end
+
+        def del_domain_override(body = {}, uuid:)
+          @client.post("#{BASE_PATH}/delDomainOverride/#{uuid}", body)
+        end
+
+        def del_forward(body = {}, uuid:)
+          @client.post("#{BASE_PATH}/delForward/#{uuid}", body)
+        end
+
+        def del_host_alias(body = {}, uuid:)
+          @client.post("#{BASE_PATH}/delHostAlias/#{uuid}", body)
+        end
+
+        def del_host_override(body = {}, uuid:)
+          @client.post("#{BASE_PATH}/delHostOverride/#{uuid}", body)
+        end
+
+        def get(params = {})
+          @client.get("#{BASE_PATH}/get", params)
+        end
+
+        def get_domain_override(params = {}, uuid: nil)
+          @client.get("#{BASE_PATH}/getDomainOverride/#{uuid}", params)
+        end
+
+        def get_forward(params = {}, uuid: nil)
+          @client.get("#{BASE_PATH}/getForward/#{uuid}", params)
+        end
+
+        def get_host_alias(params = {}, uuid: nil)
+          @client.get("#{BASE_PATH}/getHostAlias/#{uuid}", params)
+        end
+
+        def get_host_override(params = {}, uuid: nil)
+          @client.get("#{BASE_PATH}/getHostOverride/#{uuid}", params)
+        end
+
+        def get_nameservers(params = {})
+          @client.get("#{BASE_PATH}/getNameservers", params)
+        end
+
+        def search_domain_override(body = {})
+          @client.post("#{BASE_PATH}/searchDomainOverride", body)
+        end
+
+        def search_forward(body = {})
+          @client.post("#{BASE_PATH}/searchForward", body)
+        end
+
+        def search_host_alias(body = {})
+          @client.post("#{BASE_PATH}/searchHostAlias", body)
+        end
+
+        def search_host_override(body = {})
+          @client.post("#{BASE_PATH}/searchHostOverride", body)
+        end
+
+        def set(body = {})
+          @client.post("#{BASE_PATH}/set", body)
+        end
+
+        def set_domain_override(body = {}, uuid:)
+          @client.post("#{BASE_PATH}/setDomainOverride/#{uuid}", body)
+        end
+
+        def set_forward(body = {}, uuid:)
+          @client.post("#{BASE_PATH}/setForward/#{uuid}", body)
+        end
+
+        def set_host_alias(body = {}, uuid:)
+          @client.post("#{BASE_PATH}/setHostAlias/#{uuid}", body)
+        end
+
+        def set_host_override(body = {}, uuid:)
+          @client.post("#{BASE_PATH}/setHostOverride/#{uuid}", body)
+        end
+
+        def toggle_domain_override(body = {}, uuid:, enabled: nil)
+          @client.post("#{BASE_PATH}/toggleDomainOverride/#{uuid}/#{enabled}", body)
+        end
+
+        def toggle_forward(body = {}, uuid:, enabled: nil)
+          @client.post("#{BASE_PATH}/toggleForward/#{uuid}/#{enabled}", body)
+        end
+
+        def toggle_host_alias(body = {}, uuid:, enabled: nil)
+          @client.post("#{BASE_PATH}/toggleHostAlias/#{uuid}/#{enabled}", body)
+        end
+
+        def toggle_host_override(body = {}, uuid:, enabled: nil)
+          @client.post("#{BASE_PATH}/toggleHostOverride/#{uuid}/#{enabled}", body)
+        end
+      end
+    end
+  end
+end

data/lib/opnsense_api/core/unbound.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    # @see https://docs.opnsense.org/development/api/core/unbound.html
+    class Unbound
+      autoload :Diagnostics, 'opnsense_api/core/unbound/diagnostics'
+      autoload :Service, 'opnsense_api/core/unbound/service'
+      autoload :Settings, 'opnsense_api/core/unbound/settings'
+
+      include OPNsenseAPI::Core
+
+      def diagnostics
+        Diagnostics.new(@client)
+      end
+
+      def service
+        Service.new(@client)
+      end
+
+      def settings
+        Settings.new(@client)
+      end
+    end
+  end
+end

data/lib/opnsense_api/core.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  # @see https://docs.opnsense.org/development/api.html#core-api
+  module Core
+    autoload :CaptivePortal, 'opnsense_api/core/captive_portal'
+    autoload :Core, 'opnsense_api/core/core'
+    autoload :Cron, 'opnsense_api/core/cron'
+    autoload :Diagnostics, 'opnsense_api/core/diagnostics'
+    autoload :Firewall, 'opnsense_api/core/firewall'
+    autoload :Firmware, 'opnsense_api/core/firmware'
+    autoload :IDS, 'opnsense_api/core/ids'
+    autoload :Interfaces, 'opnsense_api/core/interfaces'
+    autoload :IPSec, 'opnsense_api/core/ipsec'
+    autoload :Monit, 'opnsense_api/core/monit'
+    autoload :OpenVPN, 'opnsense_api/core/open_vpn'
+    autoload :Proxy, 'opnsense_api/core/proxy'
+    autoload :Routes, 'opnsense_api/core/routes'
+    autoload :Syslog, 'opnsense_api/core/syslog'
+    autoload :TrafficShaper, 'opnsense_api/core/traffic_shaper'
+    autoload :Unbound, 'opnsense_api/core/unbound'
+
+    def initialize(client)
+      @client = client
+    end
+  end
+end

data/lib/opnsense_api/error.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  class Error < StandardError; end
+end

data/lib/opnsense_api/version.rb

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

data/lib/opnsense_api.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative 'opnsense_api/error'
+require_relative 'opnsense_api/version'
+
+module OPNsenseAPI
+  autoload :Client, 'opnsense_api/client'
+
+  autoload :Core, 'opnsense_api/core'
+end

data/sig/lib/opnsense_api/client.rbs

@@ -0,0 +1,55 @@
+module OPNsenseAPI
+  class Client
+    BASE_PATH: String
+
+    attr_reader host: URI
+    attr_reader api_key: String
+    attr_reader api_secret: String
+    attr_reader options: Hash[Symbol, untyped]
+
+    def initialize: (URI | String host, String api_key, String api_secret, **Hash[Symbol, untyped] options) -> void
+
+    def captive_portal: () -> Core::CaptivePortal
+
+    def core: () -> Core::Core
+
+    def cron: () -> Core::Cron
+
+    def diagnostics: () -> Core::Diagnostics
+
+    def firewall: () -> Core::Firewall
+
+    def ids: () -> Core::IDS
+
+    def interfaces: () -> Core::Interfaces
+
+    def ipsec: () -> Core::IPSec
+
+    def monit: () -> Core::Monit
+
+    def open_vpn: () -> Core::OpenVPN
+
+    def proxy: () -> Core::Proxy
+
+    def routes: () -> Core::Routes
+
+    def syslog: () -> Core::Syslog
+
+    def traffic_shaping: () -> Core::TrafficShaping
+
+    def unbound: () -> Core::Unbound
+
+    def get: (String path, ?Hash[untyped, untyped] params) -> untyped
+
+    def post: (String path, ?untyped body) -> untyped
+
+    private
+
+    @http: Net::HTTP
+    def http: -> Net::HTTP
+
+    def setup_request: (Net::HTTP::Get | Net::HTTP::Post request) -> void
+
+    def handle_response: (Net::HTTPResponse response) -> untyped
+  end
+end

data/sig/lib/opnsense_api/core/captive_portal/access.rbs

@@ -0,0 +1,17 @@
+module OPNsenseAPI
+  module Core
+    class CaptivePortal
+      class Access
+        include OPNsenseAPI::Core
+
+        BASE_PATH: String
+
+        def logoff: (?zoneid: Integer) -> untyped
+
+        def logon: (?zoneid: Integer, ?body: Hash[untyped, untyped]) -> untyped
+
+        def status: (?zoneid: Integer, ?body: Hash[untyped, untyped]) -> untyped
+      end
+    end
+  end
+end

data/sig/lib/opnsense_api/core/captive_portal/service.rbs

@@ -0,0 +1,21 @@
+module OPNsenseAPI
+  module Core
+    class CaptivePortal
+      class Service
+        include OPNsenseAPI::Core
+
+        BASE_PATH: String
+
+        def del_template: (uuid: String) -> untyped
+
+        def get_template: (?fileid: String?) -> untyped
+
+        def reconfigure: (?Hash[untyped, untyped] body) -> untyped
+
+        def save_template: (?Hash[untyped, untyped] body) -> untyped
+
+        def search_templates: (?Hash[untyped, untyped] body) -> untyped
+      end
+    end
+  end
+end

data/sig/lib/opnsense_api/core/captive_portal/session.rbs

@@ -0,0 +1,19 @@
+module OPNsenseAPI
+  module Core
+    class CaptivePortal
+      class Session
+        include OPNsenseAPI::Core
+
+        BASE_PATH: String
+
+        def connect: (?zoneid: Integer, ?body: Hash[untyped, untyped]) -> untyped
+
+        def disconnect: (?zoneid: Integer, ?body: Hash[untyped, untyped]) -> untyped
+
+        def list: (?zoneid: Integer) -> untyped
+
+        def zones: () -> untyped
+      end
+    end
+  end
+end

data/sig/lib/opnsense_api/core/captive_portal/settings.rbs

@@ -0,0 +1,25 @@
+module OPNsenseAPI
+  module Core
+    class CaptivePortal
+      class Settings
+        include OPNsenseAPI::Core
+
+        BASE_PATH: String
+
+        def add_zone: (?Hash[untyped, untyped] body) -> untyped
+
+        def del_zone: (uuid: String) -> untyped
+
+        def get: () -> untyped
+
+        def get_zone: (uuid: String) -> untyped
+
+        def search_zones: (?Hash[untyped, untyped] body) -> untyped
+
+        def set_zone: (uuid: String, ?body: Hash[untyped, untyped]) -> untyped
+
+        def toggle_zone: (uuid: String, ?enabled: bool?, ?body: Hash[untyped, untyped]) -> untyped
+      end
+    end
+  end
+end

data/sig/lib/opnsense_api/core/captive_portal/voucher.rbs

@@ -0,0 +1,25 @@
+module OPNsenseAPI
+  module Core
+    class CaptivePortal
+      class Voucher
+        include OPNsenseAPI::Core
+
+        BASE_PATH: String
+
+        def drop_expired_vouchers: (provider: String, group: String, ?body: Hash[untyped, untyped]) -> untyped
+
+        def drop_voucher_group: (provider: String, group: String, ?body: Hash[untyped, untyped]) -> untyped
+
+        def expire_voucher: (provider: String, ?body: Hash[untyped, untyped]) -> untyped
+
+        def generate_vouchers: (provider: String, ?body: Hash[untyped, untyped]) -> untyped
+
+        def list_providers: () -> untyped
+
+        def list_voucher_groups: (provider: String) -> untyped
+
+        def list_vouchers: (provider: String, group: String) -> untyped
+      end
+    end
+  end
+end

data/sig/lib/opnsense_api/core/captive_portal.rbs

@@ -0,0 +1,17 @@
+module OPNsenseAPI
+  module Core
+    class CaptivePortal
+      include OPNsenseAPI::Core
+
+      def access: () -> Access
+
+      def service: () -> Service
+
+      def session: () -> Session
+
+      def settings: () -> Settings
+
+      def voucher: () -> Voucher
+    end
+  end
+end

data/sig/lib/opnsense_api/core/core/firmware.rbs

@@ -0,0 +1,37 @@
+module OPNsenseAPI
+  module Core
+    class Core
+      class Firmware
+        include OPNsenseAPI::Core
+
+        BASE_PATH: String
+
+        def poweroff: (?Hash[untyped, untyped] body) -> untyped
+
+        def reboot: (?Hash[untyped, untyped] body) -> untyped
+
+        def running: (?Hash[untyped, untyped] params) -> untyped
+
+        def get_firmware_config: (?Hash[untyped, untyped] params) -> untyped
+
+        def get_firmware_options: (?Hash[untyped, untyped] params) -> untyped
+
+        def set_firmware_config: (?Hash[untyped, untyped] body) -> untyped
+
+        def info: (?Hash[untyped, untyped] params) -> untyped
+
+        def status: (?params: Hash[untyped, untyped], ?body: Hash[untyped, untyped]) -> untyped
+
+        def audit: (?Hash[untyped, untyped] body) -> untyped
+
+        def update: (?Hash[untyped, untyped] body) -> untyped
+
+        def upgrade: (?Hash[untyped, untyped] body) -> untyped
+
+        def upgrade_status: (?Hash[untyped, untyped] params) -> untyped
+
+        def changelog: (version: String) -> untyped
+      end
+    end
+  end
+end

data/sig/lib/opnsense_api/core/core/menu.rbs

@@ -0,0 +1,15 @@
+module OPNsenseAPI
+  module Core
+    class Core
+      class Menu
+        include OPNsenseAPI::Core
+
+        BASE_PATH: String
+
+        def search: () -> untyped
+
+        def tree: () -> untyped
+      end
+    end
+  end
+end

data/sig/lib/opnsense_api/core/core/system.rbs

@@ -0,0 +1,19 @@
+module OPNsenseAPI
+  module Core
+    class Core
+      class System
+        include OPNsenseAPI::Core
+
+        BASE_PATH: String
+
+        def dismiss_status: () -> untyped
+
+        def halt: () -> untyped
+
+        def reboot: () -> untyped
+
+        def status: () -> untyped
+      end
+    end
+  end
+end

data/sig/lib/opnsense_api/core/core.rbs

@@ -0,0 +1,13 @@
+module OPNsenseAPI
+  module Core
+    class Core
+      include OPNsenseAPI::Core
+
+      def firmware: () -> Firmware
+
+      def menu: () -> Menu
+
+      def system: () -> System
+    end
+  end
+end

data/sig/lib/opnsense_api/core/cron/service.rbs

@@ -0,0 +1,13 @@
+module OPNsenseAPI
+  module Core
+    class Cron
+      class Service
+        include OPNsenseAPI::Core
+
+        BASE_PATH: String
+
+        def reconfigure: (?body: Hash[untyped, untyped]) -> untyped
+      end
+    end
+  end
+end