opnsense_api 0.1.0

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

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class Diagnostics
+      class Interface
+        include OPNsenseAPI::Core
+
+        BASE_PATH = '/diagnostics/interface'
+
+        def carp_status(status:)
+          @client.post("#{BASE_PATH}/carpStatus/#{status}")
+        end
+
+        def del_route(body = {})
+          @client.post("#{BASE_PATH}/delRoute", body)
+        end
+
+        def flush_arp(body = {})
+          @client.post("#{BASE_PATH}/flushArp", body)
+        end
+
+        def get_arp(params = {})
+          @client.get("#{BASE_PATH}/getArp", params)
+        end
+
+        def get_bpf_statistics(params = {})
+          @client.get("#{BASE_PATH}/getBpfStatistics", params)
+        end
+
+        def get_interface_config(params = {})
+          @client.get("#{BASE_PATH}/getInterfaceConfig", params)
+        end
+
+        def get_interface_names(params = {})
+          @client.get("#{BASE_PATH}/getInterfaceNames", params)
+        end
+
+        def get_memory_statistics(params = {})
+          @client.get("#{BASE_PATH}/getMemoryStatistics", params)
+        end
+
+        def get_ndp(params = {})
+          @client.get("#{BASE_PATH}/getNdp", params)
+        end
+
+        def get_netisr_statistics(params = {})
+          @client.get("#{BASE_PATH}/getNetisrStatistics", params)
+        end
+
+        def get_pf_sync_statistics(params = {})
+          @client.get("#{BASE_PATH}/getPfSyncStatistics", params)
+        end
+
+        def get_protocol_statistics(params = {})
+          @client.get("#{BASE_PATH}/getProtocolStatistics", params)
+        end
+
+        def get_routes(params = {})
+          @client.get("#{BASE_PATH}/getRoutes", params)
+        end
+
+        def get_socket_statistics(params = {})
+          @client.get("#{BASE_PATH}/getSocketStatistics", params)
+        end
+
+        def get_vip_status(params = {})
+          @client.get("#{BASE_PATH}/getVipStatus", params)
+        end
+
+        def search_arp(params = {})
+          @client.get("#{BASE_PATH}/searchArp", params)
+        end
+
+        def search_ndp(params = {})
+          @client.get("#{BASE_PATH}/searchNdp", params)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class Diagnostics
+      class LVTemplate
+        include OPNsenseAPI::Core
+
+        BASE_PATH = '/diagnostics/lvtemplate'
+
+        def add_item(body = {})
+          @client.post("#{BASE_PATH}/addItem", body)
+        end
+
+        def del_item(uuid:)
+          @client.post("#{BASE_PATH}/delItem/#{uuid}")
+        end
+
+        def get(params = {})
+          @client.get("#{BASE_PATH}/get", params)
+        end
+
+        def get_item(uuid: nil)
+          @client.get("#{BASE_PATH}/getItem/#{uuid}")
+        end
+
+        def search_item(body = {})
+          @client.post("#{BASE_PATH}/searchItem", body)
+        end
+
+        def set(body = {})
+          @client.post("#{BASE_PATH}/set", body)
+        end
+
+        def set_item(uuid:, body: {})
+          @client.post("#{BASE_PATH}/setItem/#{uuid}", body)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class Diagnostics
+      class Netflow
+        include OPNsenseAPI::Core
+
+        BASE_PATH = '/diagnostics/netflow'
+
+        def cache_stats(params = {})
+          @client.get("#{BASE_PATH}/cacheStats", params)
+        end
+
+        def get_config(params = {})
+          @client.get("#{BASE_PATH}/getConfig", params)
+        end
+
+        def is_enabled(params = {})
+          @client.get("#{BASE_PATH}/isEnabled", params)
+        end
+
+        def reconfigure(body = {})
+          @client.post("#{BASE_PATH}/reconfigure", body)
+        end
+
+        def set_config(params = {})
+          @client.get("#{BASE_PATH}/setConfig", params)
+        end
+
+        def status(params = {})
+          @client.get("#{BASE_PATH}/status", params)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class Diagnostics
+      class NetworkInsight
+        include OPNsenseAPI::Core
+
+        BASE_PATH = '/diagnostics/networkinsight'
+
+        def get_interfaces(params = {})
+          @client.get("#{BASE_PATH}/getInterfaces", params)
+        end
+
+        def get_metadata(params = {})
+          @client.get("#{BASE_PATH}/getMetadata", params)
+        end
+
+        def get_protocols(params = {})
+          @client.get("#{BASE_PATH}/getProtocols", params)
+        end
+
+        def get_services(params = {})
+          @client.get("#{BASE_PATH}/getServices", params)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class Diagnostics
+      class PacketCapture
+        include OPNsenseAPI::Core
+
+        BASE_PATH = '/diagnostics/packet_capture'
+
+        def download(jobid:)
+          @client.get("#{BASE_PATH}/download/#{jobid}")
+        end
+
+        def get(params = {})
+          @client.get("#{BASE_PATH}/get", params)
+        end
+
+        def mac_info(macaddr:)
+          @client.get("#{BASE_PATH}/mac_info/#{macaddr}")
+        end
+
+        def remove(jobid:)
+          @client.post("#{BASE_PATH}/remove/#{jobid}")
+        end
+
+        def search_jobs(params = {})
+          @client.get("#{BASE_PATH}/searchJobs", params)
+        end
+
+        def set(params: {}, body: {})
+          if body.any?
+            @client.post("#{BASE_PATH}/set", body)
+          else
+            @client.get("#{BASE_PATH}/set", params)
+          end
+        end
+
+        def start(jobid:)
+          @client.post("#{BASE_PATH}/start/#{jobid}")
+        end
+
+        def stop(jobid:)
+          @client.post("#{BASE_PATH}/stop/#{jobid}")
+        end
+
+        def view(jobid:, detail: 'normal')
+          @client.get("#{BASE_PATH}/view/#{jobid}/#{detail}")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class Diagnostics
+      class System
+        include OPNsenseAPI::Core
+
+        BASE_PATH = '/diagnostics/system'
+
+        def memory(params = {})
+          @client.get("#{BASE_PATH}/memory", params)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class Diagnostics
+      class SystemHealth
+        include OPNsenseAPI::Core
+
+        BASE_PATH = '/diagnostics/systemhealth'
+
+        def get_interfaces(params = {})
+          @client.get("#{BASE_PATH}/getInterfaces", params)
+        end
+
+        def get_rrd_list(params = {})
+          @client.get("#{BASE_PATH}/getRRDList", params)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class Diagnostics
+      class Traffic
+        include OPNsenseAPI::Core
+
+        BASE_PATH = '/diagnostics/traffic'
+
+        def interface(params = {})
+          @client.get("#{BASE_PATH}/Interface", params)
+        end
+
+        def top(params = {})
+          @client.get("#{BASE_PATH}/Top", params)
+        end
+      end
+    end
+  end
+end

data/lib/opnsense_api/core/diagnostics.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    # @see https://docs.opnsense.org/development/api/core/diagnostics.html
+    class Diagnostics
+      autoload :Activity, 'opnsense_api/core/diagnostics/activity'
+      autoload :DNS, 'opnsense_api/core/diagnostics/dns'
+      autoload :DNSDiagnostics, 'opnsense_api/core/diagnostics/dns_diagnostics'
+      autoload :Firewall, 'opnsense_api/core/diagnostics/firewall'
+      autoload :Interface, 'opnsense_api/core/diagnostics/interface'
+      autoload :LVTemplate, 'opnsense_api/core/diagnostics/lv_template'
+      autoload :Netflow, 'opnsense_api/core/diagnostics/netflow'
+      autoload :NetworkInsight, 'opnsense_api/core/diagnostics/network_insight'
+      autoload :PacketCapture, 'opnsense_api/core/diagnostics/packet_capture'
+      autoload :System, 'opnsense_api/core/diagnostics/system'
+      autoload :SystemHealth, 'opnsense_api/core/diagnostics/system_health'
+      autoload :Traffic, 'opnsense_api/core/diagnostics/traffic'
+
+      include OPNsenseAPI::Core
+
+      def activity
+        Activity.new(@client)
+      end
+
+      def dns
+        DNS.new(@client)
+      end
+
+      def dns_diagnostics
+        DNSDiagnostics.new(@client)
+      end
+
+      def firewall
+        Firewall.new(@client)
+      end
+
+      def interface
+        Interface.new(@client)
+      end
+
+      def lv_template
+        LVTemplate.new(@client)
+      end
+
+      def netflow
+        Netflow.new(@client)
+      end
+
+      def network_insight
+        NetworkInsight.new(@client)
+      end
+
+      def packet_capture
+        PacketCapture.new(@client)
+      end
+
+      def system
+        System.new(@client)
+      end
+
+      def system_health
+        SystemHealth.new(@client)
+      end
+
+      def traffic
+        Traffic.new(@client)
+      end
+    end
+  end
+end

data/lib/opnsense_api/core/firewall/alias.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class Firewall
+      # @see https://docs.opnsense.org/development/api/core/firewall.html#id1
+      # @see https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Firewall/Alias.xml
+      class Alias
+        include OPNsenseAPI::Core
+
+        BASE_PATH = '/firewall/alias'
+
+        def add_item(body = {})
+          @client.post("#{BASE_PATH}/addItem", body)
+        end
+
+        def del_item(uuid:)
+          @client.post("#{BASE_PATH}/delItem/#{uuid}")
+        end
+
+        def export(params = {})
+          @client.get("#{BASE_PATH}/export", params)
+        end
+
+        def get(params = {})
+          @client.get("#{BASE_PATH}/get", params)
+        end
+
+        def get_alias_uuid(name:)
+          @client.get("#{BASE_PATH}/getAliasUUID/#{name}")
+        end
+
+        def get_geo_ip(params = {})
+          @client.get("#{BASE_PATH}/getGeoIP", params)
+        end
+
+        def get_item(uuid:)
+          @client.get("#{BASE_PATH}/getItem/#{uuid}")
+        end
+
+        def get_table_size(params = {})
+          @client.get("#{BASE_PATH}/getTableSize", params)
+        end
+
+        def import(body = {})
+          @client.post("#{BASE_PATH}/import", body)
+        end
+
+        def list_categories(params = {})
+          @client.get("#{BASE_PATH}/listCategories", params)
+        end
+
+        def list_countries(params = {})
+          @client.get("#{BASE_PATH}/listCountries", params)
+        end
+
+        def list_network_aliases(params = {})
+          @client.get("#{BASE_PATH}/listNetworkAliases", params)
+        end
+
+        def reconfigure(body = {})
+          @client.post("#{BASE_PATH}/reconfigure", body)
+        end
+
+        def search_item(body = {})
+          @client.post("#{BASE_PATH}/searchItem", body)
+        end
+
+        def set(body = {})
+          @client.post("#{BASE_PATH}/set", body)
+        end
+
+        def set_item(uuid:, body: {})
+          @client.post("#{BASE_PATH}/setItem/#{uuid}", body)
+        end
+
+        def toggle_item(uuid:, enabled: nil)
+          @client.post("#{BASE_PATH}/toggleItem/#{uuid}/#{enabled}")
+        end
+      end
+    end
+  end
+end

data/lib/opnsense_api/core/firewall/alias_util.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class Firewall
+      # @see https://docs.opnsense.org/development/api/core/firewall.html#id2
+      # NOTE: using `id` instead of `alias` as it is a reserved keyword
+      class AliasUtil
+        include OPNsenseAPI::Core
+
+        BASE_PATH = '/firewall/alias_util'
+
+        def add(id:, body: {})
+          @client.post("#{BASE_PATH}/add/#{id}", body)
+        end
+
+        def aliases(params = {})
+          @client.get("#{BASE_PATH}/aliases", params)
+        end
+
+        def delete(id:)
+          @client.post("#{BASE_PATH}/delete/#{id}")
+        end
+
+        def find_references(body = {})
+          @client.post("#{BASE_PATH}/findReferences", body)
+        end
+
+        def flush(id:, body: {})
+          @client.post("#{BASE_PATH}/flush/#{id}", body)
+        end
+
+        def list(id:, params: {})
+          @client.get("#{BASE_PATH}/list/#{id}", params)
+        end
+
+        def update_bogons(params = {})
+          @client.get("#{BASE_PATH}/updateBogons", params)
+        end
+      end
+    end
+  end
+end

data/lib/opnsense_api/core/firewall/category.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class Firewall
+      # @see https://docs.opnsense.org/development/api/core/firewall.html#id3
+      class Category
+        include OPNsenseAPI::Core
+
+        BASE_PATH = '/firewall/category'
+
+        def add_item(body = {})
+          @client.post("#{BASE_PATH}/addItem", body)
+        end
+
+        def del_item(uuid:)
+          @client.post("#{BASE_PATH}/delItem/#{uuid}")
+        end
+
+        def get(params = {})
+          @client.get("#{BASE_PATH}/get", params)
+        end
+
+        def get_item(uuid: nil)
+          @client.get("#{BASE_PATH}/getItem/#{uuid}")
+        end
+
+        def search_item(body = {})
+          @client.post("#{BASE_PATH}/searchItem", body)
+        end
+
+        def search_no_category_item(body = {})
+          @client.post("#{BASE_PATH}/searchNoCategoryItem", body)
+        end
+
+        def set(body = {})
+          @client.post("#{BASE_PATH}/set", body)
+        end
+
+        def set_item(uuid:, body: {})
+          @client.post("#{BASE_PATH}/setItem/#{uuid}", body)
+        end
+      end
+    end
+  end
+end

data/lib/opnsense_api/core/firewall/filter_util.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class Firewall
+      # @see https://docs.opnsense.org/development/api/core/firewall.html#id4
+      class FilterUtil
+        include OPNsenseAPI::Core
+
+        BASE_PATH = '/firewall/filter_util'
+
+        def rule_stats(params = {})
+          @client.get("#{BASE_PATH}/ruleStats", params)
+        end
+      end
+    end
+  end
+end

data/lib/opnsense_api/core/firewall.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    # @see https://docs.opnsense.org/development/api/core/firewall.html
+    class Firewall
+      autoload :Alias, 'opnsense_api/core/firewall/alias'
+      autoload :AliasUtil, 'opnsense_api/core/firewall/alias_util'
+      autoload :Category, 'opnsense_api/core/firewall/category'
+      autoload :FilterUtil, 'opnsense_api/core/firewall/filter_util'
+
+      include OPNsenseAPI::Core
+
+      def alias
+        Alias.new(@client)
+      end
+
+      def alias_util
+        AliasUtil.new(@client)
+      end
+
+      def category
+        Category.new(@client)
+      end
+
+      def filter_util
+        FilterUtil.new(@client)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class IDS
+      # @see https://docs.opnsense.org/development/api/core/ids.html#id1
+      class Service
+        include OPNsenseAPI::Core
+
+        BASE_PATH = '/ids/service'
+
+        def drop_alert_log(body = {})
+          @client.post("#{BASE_PATH}/dropAlertLog", body)
+        end
+
+        def get_alert_info(alertid:, fileid: nil)
+          @client.get("#{BASE_PATH}/getAlertInfo/#{alertid}/#{fileid}")
+        end
+
+        def get_alert_logs(params = {})
+          @client.get("#{BASE_PATH}/getAlertLogs", params)
+        end
+
+        def query_alerts(body = {})
+          @client.post("#{BASE_PATH}/queryAlerts", body)
+        end
+
+        def reconfigure(body = {})
+          @client.post("#{BASE_PATH}/reconfigure", body)
+        end
+
+        def reload_rules(body = {})
+          @client.post("#{BASE_PATH}/reloadRules", body)
+        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
+
+        def update_rules(body = {}, wait: nil)
+          @client.post("#{BASE_PATH}/updateRules/#{wait}", body)
+        end
+      end
+    end
+  end
+end