Merge pull request #115 from jaredhendrickson13/v130

v1.3.0

Author: jaredhendrickson13

README.md

@@ -122,9 +122,17 @@ changes to the configuration by updating it's values. If you do make changes to
 `$this->write_config()` to apply them. 
 - `$this->id` : A property to track the current instances configuration ID. This is primarily helpful for updating and 
 deleting objects.
-- `$this->validate_id` : A boolean to dictate whether the model object should require validation of the configuraiton ID.
+- `$this->validate_id` : A boolean to dictate whether the model object should require validation of the configuration ID.
 This defaults to true, but can be useful for nested model object calls where you would like to validate a payload before
 it's parent is created. It is entirely up to you to implement this property if desired.
+- `$this->retain_read_mode` : A boolean to dictate whether this model should respect the API's read only setting if
+set. If set to `false`, the model will be considered a read only model and will be allowed to answer requests when the
+API is in read only mode, even if the request is not a GET request. Defaults to `true`.
+- `$this->ignore_ifs` : A boolean to dictate whether or not this model should respect the allowed interfaces API
+setting. If set to `true`, the model will be allowed to answer API requests regardless of the interface the request was
+received on. Defaults to `false`.
+- `$this->ignore_enabled` : A boolean to dictate whether or not this model should respect the API's enabled setting. If
+set to true, this model will be allowed to answer API requests even if the API is disabled. Defaults to `false`.
 
 #### Reading and Writing to pfSense's XML Configuration ####
 Included in the API framework are properties and methods to read and write to pfSense's XML configuration. Please note

docs/CONTRIBUTING.md

@@ -6,10 +6,9 @@ Below are versions that are currently supported and will receive security update
 
 | Version | Supported          |
 | ------- | ------------------ |
+| 1.3.x   | :white_check_mark: |
 | 1.2.x   | :white_check_mark: |
-| 1.1.x   | :white_check_mark: |
-| 1.0.x   | :x:                |
-
+| 1.1.x   | :x:                |
 
 ## Reporting a Vulnerability
 

docs/SECURITY.md

@@ -0,0 +1,26 @@
+<?php
+//   Copyright 2021 Jared Hendrickson
+//
+//   Licensed under the Apache License, Version 2.0 (the "License");
+//   you may not use this file except in compliance with the License.
+//   You may obtain a copy of the License at
+//
+//       http://www.apache.org/licenses/LICENSE-2.0
+//
+//   Unless required by applicable law or agreed to in writing, software
+//   distributed under the License is distributed on an "AS IS" BASIS,
+//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//   See the License for the specific language governing permissions and
+//   limitations under the License.
+
+require_once("api/framework/APIEndpoint.inc");
+
+class APIDiagnosticsCommandPrompt extends APIEndpoint {
+    public function __construct() {
+        $this->url = "/api/v1/diagnostics/command_prompt";
+    }
+
+    protected function post() {
+        return (new APIDiagnosticsCommandPromptCreate())->call();
+    }
+}

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

@@ -0,0 +1,27 @@
+<?php
+//   Copyright 2021 Jared Hendrickson
+//
+//   Licensed under the Apache License, Version 2.0 (the "License");
+//   you may not use this file except in compliance with the License.
+//   You may obtain a copy of the License at
+//
+//       http://www.apache.org/licenses/LICENSE-2.0
+//
+//   Unless required by applicable law or agreed to in writing, software
+//   distributed under the License is distributed on an "AS IS" BASIS,
+//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//   See the License for the specific language governing permissions and
+//   limitations under the License.
+
+require_once("api/framework/APIEndpoint.inc");
+
+class APIFirewallRuleFlush extends APIEndpoint {
+    public function __construct() {
+        $this->url = "/api/v1/firewall/rule/flush";
+    }
+
+    protected function delete() {
+        return (new APIFirewallRuleFlushDelete())->call();
+    }
+
+}

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

@@ -0,0 +1,38 @@
+<?php
+//   Copyright 2021 Jared Hendrickson
+//
+//   Licensed under the Apache License, Version 2.0 (the "License");
+//   you may not use this file except in compliance with the License.
+//   You may obtain a copy of the License at
+//
+//       http://www.apache.org/licenses/LICENSE-2.0
+//
+//   Unless required by applicable law or agreed to in writing, software
+//   distributed under the License is distributed on an "AS IS" BASIS,
+//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//   See the License for the specific language governing permissions and
+//   limitations under the License.
+
+require_once("api/framework/APIEndpoint.inc");
+
+class APIInterfaceBridge extends APIEndpoint {
+    public function __construct() {
+        $this->url = "/api/v1/interface/bridge";
+    }
+
+    protected function get() {
+        return (new APIInterfaceBridgeRead())->call();
+    }
+
+    protected function post() {
+        return (new APIInterfaceBridgeCreate())->call();
+    }
+
+    protected function put() {
+        return (new APIInterfaceBridgeUpdate())->call();
+    }
+
+    protected function delete() {
+        return (new APIInterfaceBridgeDelete())->call();
+    }
+}

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

@@ -21,7 +21,7 @@ class APIRoutingGateway extends APIEndpoint {
     }
 
     protected function get() {
-        return (new APIRoutingGatewayRead())->call();
+        return (new APIRoutingGatewayDetailRead())->call();
     }
 
     protected function post() {
@@ -35,4 +35,4 @@ class APIRoutingGateway extends APIEndpoint {
     protected function delete() {
         return (new APIRoutingGatewayDelete())->call();
     }
-}
+}

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

@@ -0,0 +1,26 @@
+<?php
+//   Copyright 2021 Jared Hendrickson
+//
+//   Licensed under the Apache License, Version 2.0 (the "License");
+//   you may not use this file except in compliance with the License.
+//   You may obtain a copy of the License at
+//
+//       http://www.apache.org/licenses/LICENSE-2.0
+//
+//   Unless required by applicable law or agreed to in writing, software
+//   distributed under the License is distributed on an "AS IS" BASIS,
+//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//   See the License for the specific language governing permissions and
+//   limitations under the License.
+
+require_once("api/framework/APIEndpoint.inc");
+
+class APIRoutingGatewayDetail extends APIEndpoint {
+    public function __construct() {
+        $this->url = "/api/v1/routing/gateway/detail";
+    }
+
+    protected function get() {
+        return (new APIRoutingGatewayDetailRead())->call();
+    }
+}

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

@@ -0,0 +1,26 @@
+<?php
+//   Copyright 2021 Jared Hendrickson
+//
+//   Licensed under the Apache License, Version 2.0 (the "License");
+//   you may not use this file except in compliance with the License.
+//   You may obtain a copy of the License at
+//
+//       http://www.apache.org/licenses/LICENSE-2.0
+//
+//   Unless required by applicable law or agreed to in writing, software
+//   distributed under the License is distributed on an "AS IS" BASIS,
+//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//   See the License for the specific language governing permissions and
+//   limitations under the License.
+
+require_once("api/framework/APIEndpoint.inc");
+
+class APIServicesDnsmasq extends APIEndpoint {
+    public function __construct() {
+        $this->url = "/api/v1/services/dnsmasq";
+    }
+
+    protected function get() {
+        return (new APIServicesDnsmasqRead())->call();
+    }
+}

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

@@ -0,0 +1,26 @@
+<?php
+//   Copyright 2021 Jared Hendrickson
+//
+//   Licensed under the Apache License, Version 2.0 (the "License");
+//   you may not use this file except in compliance with the License.
+//   You may obtain a copy of the License at
+//
+//       http://www.apache.org/licenses/LICENSE-2.0
+//
+//   Unless required by applicable law or agreed to in writing, software
+//   distributed under the License is distributed on an "AS IS" BASIS,
+//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//   See the License for the specific language governing permissions and
+//   limitations under the License.
+
+require_once("api/framework/APIEndpoint.inc");
+
+class APIServicesDnsmasqApply extends APIEndpoint {
+    public function __construct() {
+        $this->url = "/api/v1/services/dnsmasq/apply";
+    }
+
+    protected function post() {
+        return (new APIServicesDnsmasqApplyCreate())->call();
+    }
+}