Merge pull request #23 from jaredhendrickson13/v110

v1.1.0 Fixes & Features

docs/SECURITY.md

@@ -0,0 +1,21 @@
+# Security Policy
+
+## Supported Versions
+
+Below are versions that are currently supported and will receive security updates when available.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 1.1.x   | :white_check_mark: |
+| 1.0.x   | :white_check_mark: |
+| 0.0.x   | :x:                |
+
+
+## Reporting a Vulnerability
+
+Should you discover a vulnerability in the pfSense-API code, please report the issue in one of the following ways:
+1) A pull request with code that fixes the discovered vulnerability
+2) A private email to either the project owner or the respective code owner
+3) As a last resort, you may open a public issue on the repository
+
+Please note this is an independent and open-source project and no bug bounty or reward can be granted.

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

@@ -0,0 +1,26 @@
+<?php
+//   Copyright 2020 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 APIFirewallApply extends APIEndpoint {
+    public function __construct() {
+        $this->url = "/api/v1/firewall/apply";
+    }
+
+    protected function post() {
+        return (new APIFirewallApplyCreate())->call();
+    }
+}

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

@@ -0,0 +1,39 @@
+<?php
+//   Copyright 2020 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 APIFirewallNATOneToOne extends APIEndpoint {
+    public function __construct() {
+        $this->url = "/api/v1/firewall/nat/one_to_one";
+    }
+
+    protected function get() {
+        return (new APIFirewallNATOneToOneRead())->call();
+    }
+
+    protected function post() {
+        return (new APIFirewallNATOneToOneCreate())->call();
+    }
+
+    protected function put() {
+        return (new APIFirewallNATOneToOneUpdate())->call();
+    }
+
+    protected function delete() {
+        return (new APIFirewallNATOneToOneDelete())->call();
+    }
+
+}

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

@@ -0,0 +1,30 @@
+<?php
+//   Copyright 2020 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 APIFirewallNATOutbound extends APIEndpoint {
+    public function __construct() {
+        $this->url = "/api/v1/firewall/nat/outbound";
+    }
+
+    protected function get() {
+        return (new APIFirewallNATOutboundRead())->call();
+    }
+
+    protected function put() {
+        return (new APIFirewallNATOutboundUpdate())->call();
+    }
+}

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

@@ -0,0 +1,38 @@
+<?php
+//   Copyright 2020 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 APIFirewallNATOutboundMapping extends APIEndpoint {
+    public function __construct() {
+        $this->url = "/api/v1/firewall/nat/outbound/mapping";
+    }
+
+    protected function get() {
+        return (new APIFirewallNATOutboundMappingRead())->call();
+    }
+
+    protected function post() {
+        return (new APIFirewallNATOutboundMappingCreate())->call();
+    }
+
+    protected function put() {
+        return (new APIFirewallNATOutboundMappingUpdate())->call();
+    }
+
+    protected function delete() {
+        return (new APIFirewallNATOutboundMappingDelete())->call();
+    }
+}

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

@@ -28,6 +28,10 @@ class APIFirewallNATPortForward extends APIEndpoint {
         return (new APIFirewallNATPortForwardCreate())->call();
     }
 
+    protected function put() {
+        return (new APIFirewallNATPortForwardUpdate())->call();
+    }
+
     protected function delete() {
         return (new APIFirewallNATPortForwardDelete())->call();
     }

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

@@ -28,6 +28,10 @@ class APIInterface extends APIEndpoint {
         return (new APIInterfaceCreate())->call();
     }
 
+    protected function put() {
+        return (new APIInterfaceUpdate())->call();
+    }
+
     protected function delete() {
         return (new APIInterfaceDelete())->call();
     }

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

@@ -0,0 +1,26 @@
+<?php
+//   Copyright 2020 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 APIInterfaceApply extends APIEndpoint {
+    public function __construct() {
+        $this->url = "/api/v1/interface/apply";
+    }
+
+    protected function post() {
+        return (new APIInterfaceApplyCreate())->call();
+    }
+}

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

@@ -0,0 +1,26 @@
+<?php
+//   Copyright 2020 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 APIRoutingApply extends APIEndpoint {
+    public function __construct() {
+        $this->url = "/api/v1/routing/apply";
+    }
+
+    protected function post() {
+        return (new APIRoutingApplyCreate())->call();
+    }
+}

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

@@ -23,4 +23,16 @@ class APIRoutingGateway extends APIEndpoint {
     protected function get() {
         return (new APIRoutingGatewayRead())->call();
     }
+
+    protected function post() {
+        return (new APIRoutingGatewayCreate())->call();
+    }
+
+    protected function put() {
+        return (new APIRoutingGatewayUpdate())->call();
+    }
+
+    protected function delete() {
+        return (new APIRoutingGatewayDelete())->call();
+    }
 }

pfSense-pkg-API/files/etc/inc/api/endpoints/APIFirewallNAT.inc → pfSense-pkg-API/files/etc/inc/api/endpoints/APIServicesDDNS.inc

@@ -15,12 +15,12 @@
 
 require_once("api/framework/APIEndpoint.inc");
 
-class APIFirewallNAT extends APIEndpoint {
+class APIServicesDDNS extends APIEndpoint {
     public function __construct() {
-        $this->url = "/api/v1/firewall/nat";
+        $this->url = "/api/v1/services/ddns";
     }
 
     protected function get() {
-        return (new APIFirewallNATRead())->call();
+        return (new APIServicesDDNSRead())->call();
     }
 }

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

@@ -0,0 +1,26 @@
+<?php
+//   Copyright 2020 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 APIServicesDHCPdLease extends APIEndpoint {
+    public function __construct() {
+        $this->url = "/api/v1/services/dhcpd/lease";
+    }
+
+    protected function get() {
+        return (new APIServicesDHCPdLeaseRead())->call();
+    }
+}

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

@@ -0,0 +1,26 @@
+<?php
+//   Copyright 2020 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 APIStatusGateway extends APIEndpoint {
+    public function __construct() {
+        $this->url = "/api/v1/status/gateway";
+    }
+
+    protected function get() {
+        return (new APIStatusGatewayRead())->call();
+    }
+}

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

@@ -0,0 +1,26 @@
+<?php
+//   Copyright 2020 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 APIStatusInterface extends APIEndpoint {
+    public function __construct() {
+        $this->url = "/api/v1/status/interface";
+    }
+
+    protected function get() {
+        return (new APIStatusInterfaceRead())->call();
+    }
+}

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

@@ -0,0 +1,26 @@
+<?php
+//   Copyright 2020 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 APIStatusSystem extends APIEndpoint {
+    public function __construct() {
+        $this->url = "/api/v1/status/system";
+    }
+
+    protected function get() {
+        return (new APIStatusSystemRead())->call();
+    }
+}