Merge pull request #248 from jaredhendrickson13/v143

v1.4.3 Features & Fixes

Author: jaredhendrickson13

README.md

@@ -10,7 +10,19 @@ are made preventing the need for a reboot. All this results in the fastest, safe
 
 # Requirements
 
-- pfSense CE 2.5.0 and pfSense Plus 22.01 or later on AMD64 systems are supported. (older pfSense versions may be compatible with older versions of pfSense API)
+<details>
+    <summary>Supported pfSense Versions</summary>
+
+  - pfSense Plus 22.05 (AMD64)
+  - pfSense Plus 22.01 (AMD64)
+  - pfSense CE 2.6.0 (AMD64)
+  - pfSense CE 2.5.2 (AMD64)
+  - pfSense CE 2.5.1 (AMD64)
+  - pfSense CE 2.5.0 (AMD64)
+  ---
+  
+</details>
+
 - pfSense API requires a local user account in pfSense. The same permissions required to make configurations in the
   webConfigurator are required to make calls to the API endpoints.
 - While not an enforced requirement, it is **strongly** recommended that you configure pfSense to use HTTPS instead of
@@ -21,7 +33,7 @@ are made preventing the need for a reboot. All this results in the fastest, safe
 To install pfSense API, simply run the following command from the pfSense shell:<br>
 
 ```
-pkg add https://github.com/jaredhendrickson13/pfsense-api/releases/latest/download/pfSense-2.5-pkg-API.txz && /etc/rc.restart_webgui
+pkg add https://github.com/jaredhendrickson13/pfsense-api/releases/latest/download/pfSense-2.6-pkg-API.txz && /etc/rc.restart_webgui
 ```
 
 <br>
@@ -52,8 +64,9 @@ pfsense-api revert v1.1.7
 
 ### Notes:
 
-- To install the pfSense CE 2.6 package, simply change the `2.5` in the install URL to `2.6`.
-- To install the pfSense Plus 22.01 package, simply change the `2.5` in the install URL `22.01`.
+- While not always necessary, it's recommended to change the installation command to reference the package built for your
+  version of pfSense. You can check the [releases page](https://github.com/jaredhendrickson13/pfsense-api/releases)
+  for available versions.
 - In order for pfSense to apply some required web server changes, it is required to restart the webConfigurator after
   installing the package.
 - If you do not have shell access to pfSense, you can still install via the webConfigurator by navigating to '

pfSense-pkg-API/files/etc/inc/api/endpoints/APIInterfaceApply.inc

@@ -20,6 +20,10 @@ class APIInterfaceApply extends APIEndpoint {
         $this->url = "/api/v1/interface/apply";
     }
 
+    protected function get() {
+        return (new APIInterfaceApplyRead())->call();
+    }
+
     protected function post() {
         return (new APIInterfaceApplyCreate())->call();
     }

pfSense-pkg-API/files/etc/inc/api/endpoints/APIServicesUnboundApply.inc

@@ -20,6 +20,10 @@ class APIServicesUnboundApply extends APIEndpoint {
         $this->url = "/api/v1/services/unbound/apply";
     }
 
+    protected function get() {
+        return (new APIServicesUnboundApplyRead())->call();
+    }
+
     protected function post() {
         return (new APIServicesUnboundApplyCreate())->call();
     }

pfSense-pkg-API/files/etc/inc/api/framework/APIResponse.inc

@@ -103,6 +103,12 @@ function get($id, $data=[], $all=false) {
             "return" => $id,
             "message" => "Failed to connect to upstream package repositories",
         ],
+        14 => [
+            "status" => "accepted",
+            "code" => 202,
+            "return" => $id,
+            "message" => "Request was successful and is processing in the background",
+        ],
 
         // 1000-1999 reserved for /system API calls
         1000 => [

pfSense-pkg-API/files/etc/inc/api/framework/APITools.inc

@@ -359,7 +359,7 @@ function sort_nat_rules($top=false, $data=null, $field=null) {
 }
 
 # Input a physical interface ID, or a descriptive interface name, and return the pfSense interface ID (lan,wan,optx)
-function get_pfsense_if_id($interface, $include_carp=false) {
+function get_pfsense_if_id($interface, $include_carp=false, $include_ipsec=false) {
     # Variables
     global $config;
     # Loop through our config and check each interface for a physical ID match
@@ -399,6 +399,11 @@ function get_pfsense_if_id($interface, $include_carp=false) {
             }
         }
     }
+
+    # Only include the default IPsec interface (enc0) if explicitly requested
+    if ($include_ipsec and $interface === "enc0") {
+        return $interface;
+    }
 }
 
 # Check if input is valid for rule source and destination