opnsense_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aa0e7a66c7fa38022e9b36abbbfe4b360b6eacf44a3a23882186e5c49cd4c5e7
+  data.tar.gz: b27402b19cf88535a3e9801258d9f7e483c16ae57279e4e17397414b8a3967a5
+SHA512:
+  metadata.gz: 9de15c076d171d616f9842966fb0cc5a7b266269b9f1d540a340d7b152ac381d5eeeae7086498931e553a4b540f99db037c21b0c2a4402bfd2c4465f24462f96
+  data.tar.gz: 2f3167582c2d1d6d8dc31646f3dbff528760e56e9bf76f98ec7ef602558973d0886c6c1b990e0a9bab3b447ed544424e049195ed2046c736015ea3ae3b59cbc5

data/lib/opnsense_api/client.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'net/http'
+
+module OPNsenseAPI
+  class Client
+    BASE_PATH = '/api'
+
+    attr_reader :host, :api_key, :api_secret, :options
+
+    def initialize(host, api_key, api_secret, **options)
+      @host = host.is_a?(URI) ? host : URI(host)
+      @api_key = api_key
+      @api_secret = api_secret
+      @options = {
+        verify_ssl: options[:verify_ssl] || true,
+        debug: options[:debug] || false,
+        **options
+      }
+    end
+
+    def captive_portal
+      Core::CaptivePortal.new(self)
+    end
+
+    def core
+      Core::Core.new(self)
+    end
+
+    def cron
+      Core::Cron.new(self)
+    end
+
+    def diagnostics
+      Core::Diagnostics.new(self)
+    end
+
+    def firewall
+      Core::Firewall.new(self)
+    end
+
+    def ids
+      Core::IDS.new(self)
+    end
+
+    def interfaces
+      Core::Interfaces.new(self)
+    end
+
+    def ipsec
+      Core::IPSec.new(self)
+    end
+
+    def monit
+      Core::Monit.new(self)
+    end
+
+    def open_vpn
+      Core::OpenVPN.new(self)
+    end
+
+    def proxy
+      Core::Proxy.new(self)
+    end
+
+    def routes
+      Core::Routes.new(self)
+    end
+
+    def syslog
+      Core::Syslog.new(self)
+    end
+
+    def traffic_shaping
+      Core::TrafficShaping.new(self)
+    end
+
+    def unbound
+      Core::Unbound.new(self)
+    end
+
+    def get(path, params = {})
+      request = Net::HTTP::Get.new("#{BASE_PATH}#{path}")
+      setup_request(request)
+      request.params = params if params.any?
+      handle_response(http.request(request))
+    end
+
+    def post(path, body = {})
+      request = Net::HTTP::Post.new("#{BASE_PATH}#{path}")
+      setup_request(request)
+      request.body = body.to_json if body.any?
+      handle_response(http.request(request))
+    end
+
+    private
+
+    def http
+      return @http if @http
+
+      @http = Net::HTTP.new(host.host, host.port)
+      @http.use_ssl = host.scheme == 'https'
+      @http.verify_mode = OpenSSL::SSL::VERIFY_NONE unless @options[:verify_ssl]
+      @http.set_debug_output($stdout) if @options[:debug]
+      @http
+    end
+
+    # Set common params for all requests
+    def setup_request(request)
+      request.basic_auth(api_key, api_secret)
+      request['User-Agent']   = "OPNsenseAPI/#{OPNsenseAPI::VERSION}"
+      request['Content-Type'] = 'application/json' if request.is_a?(Net::HTTP::Post)
+      request['Accept']       = 'application/json'
+    end
+
+    def handle_response(response)
+      if (100..299).include?(response.code.to_i)
+        JSON.parse(response.body)
+      else
+        response
+      end
+    end
+  end
+end

data/lib/opnsense_api/core/captive_portal/access.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class CaptivePortal
+      class Access
+        include OPNsenseAPI::Core
+
+        BASE_PATH = '/captiveportal/access'
+
+        def logoff(zoneid: 0)
+          @client.get("#{BASE_PATH}/logoff/#{zoneid}")
+        end
+
+        def logon(zoneid: 0, body: {})
+          @client.post("#{BASE_PATH}/logon/#{zoneid}", body)
+        end
+
+        def status(zoneid: 0, body: {})
+          @client.post("#{BASE_PATH}/status/#{zoneid}", body)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class CaptivePortal
+      class Service
+        include OPNsenseAPI::Core
+
+        BASE_PATH = '/captiveportal/service'
+
+        def del_template(uuid:)
+          @client.post("#{BASE_PATH}/delTemplate/#{uuid}")
+        end
+
+        def get_template(fileid: nil)
+          @client.get("#{BASE_PATH}/getTemplate/#{fileid}")
+        end
+
+        def reconfigure(body = {})
+          @client.post("#{BASE_PATH}/reconfigure", body)
+        end
+
+        def save_template(body = {})
+          @client.post("#{BASE_PATH}/saveTemplate", body)
+        end
+
+        def search_templates(body = {})
+          @client.post("#{BASE_PATH}/searchTemplates", body)
+        end
+      end
+    end
+  end
+end

data/lib/opnsense_api/core/captive_portal/session.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class CaptivePortal
+      class Session
+        include OPNsenseAPI::Core
+
+        BASE_PATH = '/captiveportal/session'
+
+        def connect(zoneid: 0, body: {})
+          @client.post("#{BASE_PATH}/connect/#{zoneid}", body)
+        end
+
+        def disconnect(zoneid: 0, body: {})
+          @client.post("#{BASE_PATH}/disconnect/#{zoneid}", body)
+        end
+
+        def list(zoneid: 0)
+          @client.get("#{BASE_PATH}/list/#{zoneid}")
+        end
+
+        def zones
+          @client.get("#{BASE_PATH}/zones")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class CaptivePortal
+      class Settings
+        include OPNsenseAPI::Core
+
+        BASE_PATH = '/captiveportal/settings'
+
+        def add_zone(body = {})
+          @client.post("#{BASE_PATH}/addZone", body)
+        end
+
+        def del_zone(uuid:)
+          @client.post("#{BASE_PATH}/delZone/#{uuid}")
+        end
+
+        def get
+          @client.get(BASE_PATH)
+        end
+
+        def get_zone(uuid:)
+          @client.get("#{BASE_PATH}/getZone/#{uuid}")
+        end
+
+        def search_zones(body = {})
+          @client.post("#{BASE_PATH}/searchZones", body)
+        end
+
+        def set_zone(uuid:, body: {})
+          @client.post("#{BASE_PATH}/setZone/#{uuid}", body)
+        end
+
+        def toggle_zone(uuid:, enabled: nil, body: {})
+          @client.post("#{BASE_PATH}/toggleZone/#{uuid}/#{enabled}", body)
+        end
+      end
+    end
+  end
+end

data/lib/opnsense_api/core/captive_portal/voucher.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class CaptivePortal
+      class Voucher
+        include OPNsenseAPI::Core
+
+        BASE_PATH = '/captiveportal/voucher'
+
+        def drop_expired_vouchers(provider:, group:, body: {})
+          @client.post("#{BASE_PATH}/dropExpiredVouchers/#{provider}/#{group}", body)
+        end
+
+        def drop_voucher_group(provider:, group:, body: {})
+          @client.post("#{BASE_PATH}/dropVoucherGroup/#{provider}/#{group}", body)
+        end
+
+        def expire_voucher(provider:, body: {})
+          @client.post("#{BASE_PATH}/expireVoucher/#{provider}", body)
+        end
+
+        def generate_vouchers(provider:, body: {})
+          @client.post("#{BASE_PATH}/generateVouchers/#{provider}", body)
+        end
+
+        def list_providers
+          @client.get("#{BASE_PATH}/listProviders")
+        end
+
+        def list_voucher_groups(provider:)
+          @client.get("#{BASE_PATH}/listVoucherGroups/#{provider}")
+        end
+
+        def list_vouchers(provider:, group:)
+          @client.get("#{BASE_PATH}/listVouchers/#{provider}/#{group}")
+        end
+      end
+    end
+  end
+end

data/lib/opnsense_api/core/captive_portal.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    # @see https://docs.opnsense.org/development/api/core/captiveportal.html
+    class CaptivePortal
+      autoload :Access, 'opnsense_api/core/captive_portal/access'
+      autoload :Service, 'opnsense_api/core/captive_portal/service'
+      autoload :Session, 'opnsense_api/core/captive_portal/session'
+      autoload :Settings, 'opnsense_api/core/captive_portal/settings'
+      autoload :Voucher, 'opnsense_api/core/captive_portal/voucher'
+
+      include OPNsenseAPI::Core
+
+      def access
+        Access.new(@client)
+      end
+
+      def service
+        Service.new(@client)
+      end
+
+      def session
+        Session.new(@client)
+      end
+
+      def settings
+        Settings.new(@client)
+      end
+
+      def voucher
+        Voucher.new(@client)
+      end
+    end
+  end
+end

data/lib/opnsense_api/core/core/firmware.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class Core
+      # @see https://docs.opnsense.org/development/api/core/firmware.html
+      class Firmware
+        include OPNsenseAPI::Core
+
+        BASE_PATH = '/core/firmware'
+
+        def poweroff(body = {})
+          @client.post("#{BASE_PATH}/poweroff", body)
+        end
+
+        def reboot(body = {})
+          @client.post("#{BASE_PATH}/reboot", body)
+        end
+
+        def running(params = {})
+          @client.get("#{BASE_PATH}/running", params)
+        end
+
+        def get_firmware_config(params = {})
+          @client.get("#{BASE_PATH}/getFirmwareConfig", params)
+        end
+
+        def get_firmware_options(params = {})
+          @client.get("#{BASE_PATH}/getFirmwareOptions", params)
+        end
+
+        def set_firmware_config(body = {})
+          @client.post("#{BASE_PATH}/setFirmwareConfig", body)
+        end
+
+        def info(params = {})
+          @client.get("#{BASE_PATH}/info", params)
+        end
+
+        def status(params: {}, body: {})
+          if body.any?
+            @client.post("#{BASE_PATH}/status", body)
+          else
+            @client.get("#{BASE_PATH}/status", params)
+          end
+        end
+
+        def audit(body = {})
+          @client.post("#{BASE_PATH}/audit", body)
+        end
+
+        def update(body = {})
+          @client.post("#{BASE_PATH}/update", body)
+        end
+
+        def upgrade(body = {})
+          @client.post("#{BASE_PATH}/upgrade", body)
+        end
+
+        def upgrade_status(params = {})
+          @client.get("#{BASE_PATH}/upgradeStatus", params)
+        end
+
+        def changelog(version:)
+          @client.get("#{BASE_PATH}/changelog/#{version}")
+        end
+      end
+    end
+  end
+end

data/lib/opnsense_api/core/core/menu.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class Core
+      class Menu
+        include OPNsenseAPI::Core
+
+        BASE_PATH = '/core/menu'
+
+        def search
+          @client.get(BASE_PATH)
+        end
+
+        def tree
+          @client.get("#{BASE_PATH}/tree")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class Core
+      class System
+        include OPNsenseAPI::Core
+
+        BASE_PATH = 'core/system'
+
+        def dismiss_status
+          @client.get("#{BASE_PATH}/dismissStatus")
+        end
+
+        def halt
+          @client.get("#{BASE_PATH}/halt")
+        end
+
+        def reboot
+          @client.get("#{BASE_PATH}/reboot")
+        end
+
+        def status
+          @client.get("#{BASE_PATH}/status")
+        end
+      end
+    end
+  end
+end

data/lib/opnsense_api/core/core.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    # @see https://docs.opnsense.org/development/api/core/core.html
+    class Core
+      autoload :Firmware, 'opnsense_api/core/core/firmware'
+      autoload :Menu, 'opnsense_api/core/core/menu'
+      autoload :System, 'opnsense_api/core/core/system'
+
+      include OPNsenseAPI::Core
+
+      def firmware
+        Firmware.new(@client)
+      end
+
+      def menu
+        Menu.new(@client)
+      end
+
+      def system
+        System.new(@client)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class Cron
+      class Service
+        include OPNsenseAPI::Core
+
+        BASE_PATH = '/cron/service'
+
+        def reconfigure(body: {})
+          @client.post("#{BASE_PATH}/reconfigure", body)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class Cron
+      class Settings
+        include OPNsenseAPI::Core
+
+        BASE_PATH = '/cron/settings'
+
+        def add_job(body)
+          @client.post("#{BASE_PATH}/addJob", body)
+        end
+
+        def del_job(uuid:)
+          @client.post("#{BASE_PATH}/delJob/#{uuid}")
+        end
+
+        def get
+          @client.get("#{BASE_PATH}/get")
+        end
+
+        def get_job(uuid: nil)
+          @client.get("#{BASE_PATH}/getJob/#{uuid}")
+        end
+
+        def search_jobs(body)
+          @client.post("#{BASE_PATH}/searchJobs", body)
+        end
+
+        def set(body)
+          @client.post("#{BASE_PATH}/set", body)
+        end
+
+        def set_job(uuid:, body: {})
+          @client.post("#{BASE_PATH}/setJob/#{uuid}", body)
+        end
+
+        def toggle_job(uuid:, enabled: nil)
+          @client.post("#{BASE_PATH}/toggleJob/#{uuid}/#{enabled}")
+        end
+      end
+    end
+  end
+end

data/lib/opnsense_api/core/cron.rb

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

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

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

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

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

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class Diagnostics
+      class DNSDiagnostics
+        include OPNsenseAPI::Core
+
+        BASE_PATH = '/diagnostics/dns_diagnostics'
+
+        def get(params = {})
+          @client.get("#{BASE_PATH}/get", params)
+        end
+
+        def set(params: {}, body: {})
+          if params
+            @client.get("#{BASE_PATH}/set", params)
+          else
+            @client.post("#{BASE_PATH}/set", body)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module OPNsenseAPI
+  module Core
+    class Diagnostics
+      class Firewall
+        include OPNsenseAPI::Core
+
+        BASE_PATH = '/diagnostics/firewall'
+
+        def del_state(stateid:, creatorid:)
+          @client.post("#{BASE_PATH}/delState/#{stateid}/#{creatorid}")
+        end
+
+        def flush_sources(body = {})
+          @client.post("#{BASE_PATH}/flushSources", body)
+        end
+
+        def flush_states(body = {})
+          @client.post("#{BASE_PATH}/flushStates", body)
+        end
+
+        def kill_states(body = {})
+          @client.post("#{BASE_PATH}/killStates", body)
+        end
+
+        def list_rule_ids(params = {})
+          @client.post("#{BASE_PATH}/listRuleIds", params)
+        end
+
+        def log(params = {})
+          @client.get("#{BASE_PATH}/log", params)
+        end
+
+        def log_filters(params = {})
+          @client.get("#{BASE_PATH}/logFilters", params)
+        end
+
+        def pf_statistics(section: nil)
+          @client.get("#{BASE_PATH}/pfStatistics/#{section}")
+        end
+
+        def query_pf_top(body = {})
+          @client.post("#{BASE_PATH}/queryPfTop", body)
+        end
+
+        def query_states(body = {})
+          @client.post("#{BASE_PATH}/queryStates", body)
+        end
+
+        def stats(params = {})
+          @client.get("#{BASE_PATH}/stats", params)
+        end
+      end
+    end
+  end
+end