mirror of
https://github.com/opnsense/docs.git
synced 2026-05-04 22:40:25 -05:00
Development Manual / API reference - Firewall and firewall plugin additions.
o point people seeking for an API to manage rules to the os-firewall plugin o in the plugin, remove the quote about future plans as these might change and doesn't add much to the topic o explain general plugin usage in case anyone missed that o provide a general tip on how to debug issues with API's while explaining the scope of the work at hand. closes https://github.com/opnsense/docs/pull/437
This commit is contained in:
22
source/development/api/core/firewall.rst.in
Normal file
22
source/development/api/core/firewall.rst.in
Normal file
@@ -0,0 +1,22 @@
|
||||
.. _api_core_firewall:
|
||||
|
||||
{{ title }}
|
||||
{{ title_underline }}
|
||||
{% for controller in controllers %}
|
||||
.. csv-table:: {{controller.type}} ({{controller.filename}})
|
||||
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
||||
:widths: 4, 15, 15, 30, 40
|
||||
{% for endpoint in controller.endpoints %}
|
||||
"``{{endpoint.method}}``","{{endpoint.module}}","{{endpoint.controller}}","{{endpoint.command}}","{{endpoint.parameters}}"
|
||||
{%- endfor %}
|
||||
{%- if controller.uses %}
|
||||
{% for use in controller.uses %}
|
||||
"``<<uses>>``", "", "", "", "*{{use.type}}* `{{use.name}} <{{use.link}}>`__"
|
||||
{%- endfor %}
|
||||
{%- endif %}
|
||||
{% endfor %}
|
||||
|
||||
.. Tip::
|
||||
|
||||
In order to inject rules using an API, you may take a look at the :ref:`Firewall Plugin API <api_plugins_firewall>`,
|
||||
currently the core system does not support rule modifications via the api for this topic.
|
||||
@@ -1,9 +1,19 @@
|
||||
.. _api_plugins_firewall:
|
||||
|
||||
{{ title }}
|
||||
{{ title_underline }}
|
||||
|
||||
The firewall API plugin is a first step into migrating the legacy firewall components from OPNsense, although it does contain
|
||||
a user interface, it's main focus is only to provide machine to machine interaction between custom applications and OPNsense
|
||||
for selected features.
|
||||
The firewall API plugin (**os-firewall**) offers a way for machine to machine interaction between custom applications and OPNsense, it can
|
||||
easily be installed like any other plugin via :menuselection:`System --> Firmware --> Plugins`.
|
||||
|
||||
Although the plugin does contains a basic user interface (in :menuselection:`Firewall --> Automation`), it's mirely intended
|
||||
as a reference and testbed. There's no relation to any of the rules being managed via the core system.
|
||||
|
||||
.. Tip::
|
||||
|
||||
Use your browsers "inspect" feature to compare requests easily, the user interface in terms of communication is exactly the same
|
||||
as offered by the API . Rules not visible in the web interface will not be returned by the API either.
|
||||
|
||||
|
||||
{% for controller in controllers %}
|
||||
.. csv-table:: {{controller.type}} ({{controller.filename}}) {% if not controller.is_abstract %} -- extends : {{controller.base_class}} {% endif %}
|
||||
|
||||
Reference in New Issue
Block a user