opnsense_api 0.1.0

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

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class IDS
+      # @see https://docs.opnsense.org/development/api/core/ids.html#id2
+      class Settings
+        include OPNsenseAPI::Core
+
+        BASE_PATH = '/ids/settings'
+
+        def add_policy(body = {})
+          @client.post("#{BASE_PATH}/addPolicy", body)
+        end
+
+        def add_policy_rule(body = {})
+          @client.post("#{BASE_PATH}/addPolicyRule", body)
+        end
+
+        def add_user_rule(body = {})
+          @client.post("#{BASE_PATH}/addUserRule", body)
+        end
+
+        def check_policy_rule(params = {})
+          @client.get("#{BASE_PATH}/checkPolicyRule", params)
+        end
+
+        def del_policy(uuid:)
+          @client.post("#{BASE_PATH}/delPolicy/#{uuid}")
+        end
+
+        def del_policy_rule(uuid:)
+          @client.post("#{BASE_PATH}/delPolicyRule/#{uuid}")
+        end
+
+        def del_user_rule(uuid:)
+          @client.post("#{BASE_PATH}/delUserRule/#{uuid}")
+        end
+
+        def get(params = {})
+          @client.get("#{BASE_PATH}/get", params)
+        end
+
+        def get_policy(uuid: nil)
+          @client.get("#{BASE_PATH}/getPolicy/#{uuid}")
+        end
+
+        def get_policy_rule(uuid: nil)
+          @client.get("#{BASE_PATH}/getPolicyRule/#{uuid}")
+        end
+
+        def get_rule_info(sid: nil)
+          @client.get("#{BASE_PATH}/getRuleInfo/#{sid}")
+        end
+
+        def get_ruleset(id:)
+          @client.get("#{BASE_PATH}/getRuleset/#{id}")
+        end
+
+        def get_ruleset_properties(params = {})
+          @client.get("#{BASE_PATH}/getRulesetProperties", params)
+        end
+
+        def get_user_rule(uuid: nil)
+          @client.get("#{BASE_PATH}/getUserRule/#{uuid}")
+        end
+
+        def list_rule_metadata(params = {})
+          @client.get("#{BASE_PATH}/listRuleMetadata", params)
+        end
+
+        def list_rulesets(params = {})
+          @client.get("#{BASE_PATH}/listRulesets", params)
+        end
+
+        def search_installed_rules(body = {})
+          @client.post("#{BASE_PATH}/searchInstalledRules", body)
+        end
+
+        def search_policy(body = {})
+          @client.post("#{BASE_PATH}/searchPolicy", body)
+        end
+
+        def search_policy_rule(body = {})
+          @client.post("#{BASE_PATH}/searchPolicyRule", body)
+        end
+
+        def search_user_rule(body = {})
+          @client.post("#{BASE_PATH}/searchUserRule", body)
+        end
+
+        def set(body = {})
+          @client.post("#{BASE_PATH}/set", body)
+        end
+
+        def set_policy(body = {}, uuid:)
+          @client.post("#{BASE_PATH}/setPolicy/#{uuid}", body)
+        end
+
+        def set_policy_rule(body = {}, uuid:)
+          @client.post("#{BASE_PATH}/setPolicyRule/#{uuid}", body)
+        end
+
+        def set_rule(body = {}, sid:)
+          @client.post("#{BASE_PATH}/setRule/#{sid}", body)
+        end
+
+        def set_ruleset(body = {}, filename:)
+          @client.post("#{BASE_PATH}/setRuleset/#{filename}", body)
+        end
+
+        def set_ruleset_properties(body = {})
+          @client.post("#{BASE_PATH}/setRulesetProperties", body)
+        end
+
+        def set_user_rule(body = {}, uuid:)
+          @client.post("#{BASE_PATH}/setUserRule/#{uuid}", body)
+        end
+
+        def toggle_policy(uuid:, enabled: nil)
+          @client.post("#{BASE_PATH}/togglePolicy/#{uuid}/#{enabled}")
+        end
+
+        def toggle_policy_rule(uuid:, enabled: nil)
+          @client.post("#{BASE_PATH}/togglePolicyRule/#{uuid}/#{enabled}")
+        end
+
+        def toggle_rule(sid:, enabled: nil)
+          @client.post("#{BASE_PATH}/toggleRule/#{sid}/#{enabled}")
+        end
+
+        def toggle_ruleset(id:, enabled: nil)
+          @client.post("#{BASE_PATH}/toggleRuleset/#{id}/#{enabled}")
+        end
+
+        def toggle_user_rule(uuid:, enabled: nil)
+          @client.post("#{BASE_PATH}/toggleUserRule/#{uuid}/#{enabled}")
+        end
+      end
+    end
+  end
+end

data/lib/opnsense_api/core/ids.rb

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

data/lib/opnsense_api/core/interfaces/base.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class Interfaces
+      # Common methods for all interface types
+      class Base
+        include OPNsenseAPI::Core
+
+        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 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
+      end
+    end
+  end
+end

data/lib/opnsense_api/core/interfaces/loopback_settings.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class Interfaces
+      # @see https://docs.opnsense.org/development/api/core/interfaces.html#id1
+      class LoopbackSettings < Base
+        BASE_PATH = '/interfaces/loopback_settings'
+      end
+    end
+  end
+end

data/lib/opnsense_api/core/interfaces/vip_settings.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class Interfaces
+      # @see https://docs.opnsense.org/development/api/core/interfaces.html#id2
+      class VIPSettings < Base
+        BASE_PATH = '/interfaces/vip_settings'
+
+        def get_unused_vhid(params = {})
+          @client.get("#{BASE_PATH}/getUnusedVhid", params)
+        end
+      end
+    end
+  end
+end

data/lib/opnsense_api/core/interfaces/vlan_settings.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class Interfaces
+      # @see https://docs.opnsense.org/development/api/core/interfaces.html#id3
+      class VLANSettings < Base
+        BASE_PATH = '/interfaces/vlan_settings'
+      end
+    end
+  end
+end

data/lib/opnsense_api/core/interfaces/vxlan_settings.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class Interfaces
+      # @see https://docs.opnsense.org/development/api/core/interfaces.html#id4
+      class VXLANSettings < Base
+        BASE_PATH = '/interfaces/vxlan_settings'
+      end
+    end
+  end
+end

data/lib/opnsense_api/core/interfaces.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    # @see https://docs.opnsense.org/development/api/core/interfaces.html
+    class Interfaces
+      autoload :Base, 'opnsense_api/core/interfaces/base'
+      autoload :LoopbackSettings, 'opnsense_api/core/interfaces/loopback_settings'
+      autoload :VIPSettings, 'opnsense_api/core/interfaces/vip_settings'
+      autoload :VLANSettings, 'opnsense_api/core/interfaces/vlan_settings'
+      autoload :VXLANSettings, 'opnsense_api/core/interfaces/vxlan_settings'
+
+      include OPNsenseAPI::Core
+
+      def loopback_settings
+        LoopbackSettings.new(@client)
+      end
+
+      def vip_settings
+        VIPSettings.new(@client)
+      end
+
+      def vlan_settings
+        VLANSettings.new(@client)
+      end
+
+      def vxlan_settings
+        VXLANSettings.new(@client)
+      end
+    end
+  end
+end

data/lib/opnsense_api/core/ipsec/key_pairs.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class IPSec
+      # @see https://docs.opnsense.org/development/api/core/ipsec.html#id1
+      class KeyPairs
+        include OPNsenseAPI::Core
+
+        BASE_PATH = '/ipsec/key_pairs'
+
+        def add_item(body = {})
+          @client.post("#{BASE_PATH}/addItem", body)
+        end
+
+        def del_item(uuid:)
+          @client.post("#{BASE_PATH}/delItem/#{uuid}")
+        end
+
+        def get_key_pair(type:, size: nil)
+          @client.get("#{BASE_PATH}/getKeyPair/#{type}/#{size}")
+        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/ipsec/leases.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class IPSec
+      # @see https://docs.opnsense.org/development/api/core/ipsec.html#id2
+      class Leases
+        include OPNsenseAPI::Core
+
+        BASE_PATH = '/ipsec/key_pairs'
+
+        def pools(params = {})
+          @client.get("#{BASE_PATH}/pools", params)
+        end
+
+        def search(params = {})
+          @client.get("#{BASE_PATH}/search", params)
+        end
+      end
+    end
+  end
+end

data/lib/opnsense_api/core/ipsec/legacy_subsystem.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class IPSec
+      # @see https://docs.opnsense.org/development/api/core/ipsec.html#id3
+      class LegacySubsystem
+        include OPNsenseAPI::Core
+
+        BASE_PATH = '/ipsec/legacy_subsystem'
+
+        def apply_config(body = {})
+          @client.post("#{BASE_PATH}/applyConfig", body)
+        end
+
+        def status(params = {})
+          @client.get("#{BASE_PATH}/status", params)
+        end
+      end
+    end
+  end
+end

data/lib/opnsense_api/core/ipsec/pre_shared_keys.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class IPSec
+      # @see https://docs.opnsense.org/development/api/core/ipsec.html#id4
+      class PreSharedKeys
+        include OPNsenseAPI::Core
+
+        BASE_PATH = '/ipsec/pre_shared_keys'
+
+        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 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
+      end
+    end
+  end
+end

data/lib/opnsense_api/core/ipsec/sad.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class IPSec
+      # @see https://docs.opnsense.org/development/api/core/ipsec.html#id5
+      class SAD
+        include OPNsenseAPI::Core
+
+        BASE_PATH = '/ipsec/sad'
+
+        def delete(body = {}, id:)
+          @client.post("#{BASE_PATH}/delete/#{id}", body)
+        end
+
+        def search(params = {})
+          @client.get(BASE_PATH, params)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class IPSec
+      # @see https://docs.opnsense.org/development/api/core/ipsec.html#id6
+      class Service
+        include OPNsenseAPI::Core
+
+        BASE_PATH = '/ipsec/service'
+
+        def reconfigure(body = {})
+          @client.post("#{BASE_PATH}/reconfigure", 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
+      end
+    end
+  end
+end

data/lib/opnsense_api/core/ipsec/sessions.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class IPSec
+      # @see https://docs.opnsense.org/development/api/core/ipsec.html#id7
+      class Sessions
+        include OPNsenseAPI::Core
+
+        BASE_PATH = '/ipsec/sessions'
+
+        def connect(body = {}, id:)
+          @client.post("#{BASE_PATH}/connect/#{id}", body)
+        end
+
+        def disconnect(body = {}, id:)
+          @client.post("#{BASE_PATH}/disconnect/#{id}", body)
+        end
+
+        def search_phase_1(params = {})
+          @client.get("#{BASE_PATH}/searchPhase1", params)
+        end
+
+        def search_phase_2(params = {})
+          @client.get("#{BASE_PATH}/searchPhase2", params)
+        end
+      end
+    end
+  end
+end

data/lib/opnsense_api/core/ipsec/spd.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class IPSec
+      # @see https://docs.opnsense.org/development/api/core/ipsec.html#id8
+      class SPD
+        include OPNsenseAPI::Core
+
+        BASE_PATH = '/ipsec/spd'
+
+        def delete(body = {}, id:)
+          @client.post("#{BASE_PATH}/delete/#{id}", body)
+        end
+
+        def search(params = {})
+          @client.get("#{BASE_PATH}/search", params)
+        end
+      end
+    end
+  end
+end

data/lib/opnsense_api/core/ipsec/tunnel.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class IPSec
+      # @see https://docs.opnsense.org/development/api/core/ipsec.html#id9
+      class Tunnel
+        include OPNsenseAPI::Core
+
+        BASE_PATH = '/ipsec/tunnel'
+
+        def del_phase_1(body = {}, ikeid:)
+          @client.post("#{BASE_PATH}/delPhase1/#{ikeid}", body)
+        end
+
+        def del_phase_2(body = {}, seqid:)
+          @client.post("#{BASE_PATH}/delPhase2/#{seqid}", body)
+        end
+
+        def search_phase_1(params = {})
+          @client.get("#{BASE_PATH}/searchPhase1", params)
+        end
+
+        def search_phase_2(params = {})
+          @client.get("#{BASE_PATH}/searchPhase2", params)
+        end
+
+        def toggle(body = {}, enabled: nil)
+          @client.post("#{BASE_PATH}/toggle/#{enabled}", body)
+        end
+
+        def toggle_phase_1(body = {}, ikeid:, enabled: nil)
+          @client.post("#{BASE_PATH}/togglePhase1/#{ikeid}/#{enabled}", body)
+        end
+
+        def toggle_phase_2(body = {}, seqid:, enabled: nil)
+          @client.post("#{BASE_PATH}/togglePhase2/#{seqid}/#{enabled}", body)
+        end
+      end
+    end
+  end
+end

data/lib/opnsense_api/core/ipsec.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    # @see https://docs.opnsense.org/development/api/core/ipsec.html
+    class IPSec
+      autoload :KeyPairs, 'opnsense_api/core/interfaces/key_pairs'
+      autoload :leases, 'opnsense_api/core/interfaces/leases'
+      autoload :LegacySubsystem, 'opnsense_api/core/interfaces/legacy_subsystem'
+      autoload :PreSharedKeys, 'opnsense_api/core/interfaces/pre_shared_keys'
+      autoload :SAD, 'opnsense_api/core/interfaces/sad'
+      autoload :Service, 'opnsense_api/core/interfaces/service'
+      autoload :Sessions, 'opnsense_api/core/interfaces/sessions'
+      autoload :SPD, 'opnsense_api/core/interfaces/spd'
+      autoload :Tunnel, 'opnsense_api/core/interfaces/tunnel'
+
+      include OPNsenseAPI::Core
+
+      def key_pairs
+        KeyPairs.new(@client)
+      end
+
+      def leases
+        Leases.new(@client)
+      end
+
+      def legacy_subsystem
+        LegacySubsystem.new(@client)
+      end
+
+      def pre_shared_keys
+        PreSharedKeys.new(@client)
+      end
+
+      def sad
+        SAD.new(@client)
+      end
+
+      def service
+        Service.new(@client)
+      end
+
+      def sessions
+        Sessions.new(@client)
+      end
+
+      def spd
+        SPD.new(@client)
+      end
+
+      def tunnel
+        Tunnel.new(@client)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class Monit
+      # @see https://docs.opnsense.org/development/api/core/monit.html#id1
+      class Service
+        include OPNsenseAPI::Core
+
+        BASE_PATH = '/monit/service'
+
+        def check(body = {})
+          @client.post("#{BASE_PATH}/check", body)
+        end
+
+        def reconfigure(body = {})
+          @client.post("#{BASE_PATH}/reconfigure", 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
+      end
+    end
+  end
+end