Updated contribution doc, started painful migration from function based API calls to object oriented design, small framework adjustments

Author: Jared Hendrickson

CONTRIBUTING.md

@@ -1304,7 +1304,7 @@ function get_carp_if_status() {
 // Enables CARP interfaces
 function enable_carp($enable) {
     // Local variables
-    global $err_lib, $config;
+    global $config;
     $vip_arr = $config['virtualip']['vip'];
     $no_action = (is_carp_enabled() === $enable) ? true : false;    // Check if a change is even requried
     // Disable if $enable is false, enable if $enable is true

pfSense-pkg-API/Makefile

@@ -23,7 +23,7 @@ class APIAccessToken extends APIBaseModel {
         }
     }
 
-    # Override action subclass to create a JWT and return it to the user
+    # Override action subclass to create a JWT and return it to the user after successful validation
     public function action() {
         $jwt = APITools\create_jwt($this->client->username);
         return APIResponse\get(0, ["token" => $jwt]);

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

@@ -0,0 +1,22 @@
+<?php
+require_once("api/framework/APIBaseModel.inc");
+require_once("api/framework/APIResponse.inc");
+
+
+class APIFirewallNat extends APIBaseModel {
+    # Create our method constructor
+    public function __construct() {
+        parent::__construct();
+        $this->methods = ["GET"];
+        $this->validators = [];
+    }
+
+    public function action() {
+        global $config;
+        // Check that we have a NAT configuration
+        if (!empty($config["nat"])) {
+            $this->validated_data = $config["nat"];
+        }
+        return APIResponse\get(0, $this->validated_data);
+    }
+}

…etc/inc/api/api_calls/APIAccessToken.inc …tc/inc/api/api_models/APIAccessToken.incpfSense-pkg-API/files/etc/inc/api/api_calls/APIAccessToken.inc renamed to pfSense-pkg-API/files/etc/inc/api/api_models/APIAccessToken.inc pfSense-pkg-API/files/etc/inc/api/api_calls/APIAccessToken.inc renamed to pfSense-pkg-API/files/etc/inc/api/api_models/APIAccessToken.inc

@@ -0,0 +1,23 @@
+<?php
+require_once("api/framework/APIBaseModel.inc");
+require_once("api/framework/APIResponse.inc");
+
+
+class APIStatusCarp extends APIBaseModel {
+    # Create our method constructor
+    public function __construct() {
+        parent::__construct();
+        $this->privileges = ["page-all", "page-status-carp"];
+        $this->methods = ["GET"];
+        $this->validators = [];
+    }
+
+    public function action() {
+        global $config;
+        $carp_status = [];
+        $carp_status["enable"] = APITools\is_carp_enabled();
+        $carp_status["maintenance_mode"] = isset($config["virtualip_carp_maintenancemode"]);
+        $carp_status["interfaces"] = APITools\get_carp_if_status();
+        return APIResponse\get(0, $carp_status);
+    }
+}

pfSense-pkg-API/files/etc/inc/api/api_models/APIFirewallNat.inc

@@ -0,0 +1,45 @@
+<?php
+require_once("api/framework/APIBaseModel.inc");
+require_once("api/framework/APIResponse.inc");
+
+
+class APIStatusCarpModify extends APIBaseModel {
+    # Create our method constructor
+    public function __construct() {
+        parent::__construct();
+        $this->privileges = ["page-all", "page-status-carp"];
+        $this->methods = ["POST"];
+        $this->validators = [$this->validate_payload()];
+    }
+
+    private function validate_payload() {
+        // Check if user specified enable value
+        if (isset($this->initial_data['enable'])) {
+            // Check if value is true or false
+            if (boolval($this->initial_data['enable'])) {
+                $enable = true;
+            } else {
+                $enable = false;
+            }
+            $this->validated_data["enable"] = $enable;
+        }
+        // Check if user specified maintenance mode value
+        if (isset($this->initial_data['maintenance_mode'])) {
+            // Check if value is true or false
+            if (boolval($this->initial_data['maintenance_mode'])) {
+                $mm_enable = true;
+            } else {
+                $mm_enable = false;
+            }
+            $this->validated_data["maintenance_mode"] = $mm_enable;
+        }
+    }
+
+    public function action() {
+        // Add our CARP settings
+        $_SESSION["Username"] = $this->client->username;
+        interfaces_carp_set_maintenancemode($this->validated_data["maintenance_mode"]);
+        APITools\enable_carp($this->validated_data["enable"]);
+        return APIResponse\get(0, $this->validated_data);
+    }
+}

pfSense-pkg-API/files/etc/inc/api/api_models/APIStatusCarp.inc

@@ -61,7 +61,7 @@ class APIAuth {
 
     # Attempts to authenticate using API token authentication
     private function authenticate_token() {
-        if (APITools\authenticate_token($this->request["client-id"], $this->request["client-id"]) === true) {
+        if (APITools\authenticate_token($this->request["client-id"], $this->request["client-token"]) === true) {
             $this->username = pack("H*", $this->request["client-id"]);
             // Ensure user is not disabled
             if (APITools\is_user_disabled($this->request["client-id"]) === false) {

pfSense-pkg-API/files/etc/inc/api/api_models/APIStatusCarpModify.inc

@@ -31,7 +31,7 @@ class APIBaseModel {
         # This function is intended to be overridden by an API model extended class
         # Any configuration writes, system configurations, etc should be added when overriding this base class
         # If this class is not overridden a 500 unexpected error is returned
-        return APIResponse\get(1);
+        return APIResponse\get(10);
     }
 
     public function validate() {

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

@@ -65,6 +65,12 @@ function get($id, $data=[]) {
             "return" => $id,
             "message" => "Authentication mode must be set to JWT to enable access token authentication",
         ],
+        10 => [
+            "status" => "server error",
+            "code" => "500",
+            "return" => $id,
+            "message" => "Your API request was valid but no actions were specified for this endpoint",
+        ]
     ];
 
     $response = $responses[$id];