Merge pull request #167 from jaredhendrickson13/v132

v1.3.2 Fixes

Author: jaredhendrickson13

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

@@ -77,11 +77,12 @@ class APISystemAPIVersionRead extends APIModel {
         # Variables
         $releases_file = "/usr/local/share/pfSense-pkg-API/releases.json";
         $releases = json_decode(file_get_contents($releases_file), true);
+        $fetch_releases_cmd = "curl -s https://api.github.com/repos/jaredhendrickson13/pfsense-api/releases -m 10";
 
         # Check if our previous releases data is older than 120 seconds
         if ($releases["last_updated"] + 120 < time()) {
             # Pull the releases data from Github and rewrite the releases file
-            $api_resp = shell_exec("curl -s https://api.github.com/repos/jaredhendrickson13/pfsense-api/releases");
+            $api_resp = shell_exec($fetch_releases_cmd);
             $api_resp = json_decode($api_resp, true);
             $releases = ["last_updated" => time(), "releases" => $api_resp];
             file_put_contents($releases_file, json_encode($releases));

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

@@ -168,7 +168,7 @@ class APISystemCACreate extends APIModel {
             $this->errors[] = APIResponse\get(1035);
         }
         else {
-            $this->validated_data["crt"] = $this->initial_data["crt"];
+            $this->validated_data["crt"] = $crt;
         }
     }
 
@@ -187,7 +187,7 @@ class APISystemCACreate extends APIModel {
                 $this->errors[] = APIResponse\get(1049);
             }
             else {
-                $this->validated_data["prv"] = $this->initial_data["prv"];
+                $this->validated_data["prv"] = $key;
             }
         }
     }

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

@@ -201,8 +201,8 @@ class APIUserCreate extends APIModel {
     public function is_user_certificate($cert_ref_id) {
         # Loop through all certificates and check for matches
         foreach ($this->config["cert"] as $cert) {
-            # Check if this is a user certificate and that ref ID matches
-            if ($cert["type"] === "user" and $cert["refid"] === $cert_ref_id) {
+            # Check if this certificate matches the specified ref id
+            if ($cert["refid"] === $cert_ref_id) {
                 return true;
             }
         }

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

@@ -179,12 +179,13 @@ class APIUserUpdate extends APIModel {
     public function is_user_certificate($cert_ref_id) {
         # Loop through all certificates and check for matches
         foreach ($this->config["cert"] as $cert) {
-            # Check if this is a user certificate and that ref ID matches
-            if ($cert["type"] === "user" and $cert["refid"] === $cert_ref_id) {
+            # Check if this certificate matches the specified ref id
+            if ($cert["refid"] === $cert_ref_id) {
                 return true;
             }
         }
 
         return false;
+
     }
 }

pfSense-pkg-API/files/usr/local/www/api/documentation/index.php

@@ -2315,12 +2315,12 @@
 function IsJsonString(str){try{JSON.parse(str);}catch(e){return false;}
 return true;}
 String.prototype.replaceAll=function(replaceThis,withThis){var re=new RegExp(RegExp.quote(replaceThis),"g");return this.replace(re,withThis);};RegExp.quote=function(str){return str.replace(/([.?*+^$[\]\\(){}-])/g,"\\$1");};function syntaxHighlight(json){json=json.replace(/&/g,'&amp;').replace(/</g,'&lt;').replace(/>/g,'&gt;');return json.replace(/("(\\u[a-zA-Z0-9]{4}|\\[^u]|[^\\"])*"(\s*:)?|\b(true|false|null)\b|-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?)/g,function(match){var cls='number';if(/^"/.test(match)){if(/:$/.test(match)){cls='key';}else{cls='string';}}else if(/true|false/.test(match)){cls='boolean';}else if(/null/.test(match)){cls='null';}
-return '<span class="'+cls+'">'+match+'</span>';});}</script><br><br><footer class="navbar-default navbar-fixed-bottom"><div class=container-fluid><div class="span12 text-center"><span data-toggle=tooltip title="If the application help you, please feel free to give a star to the project in github. Your star inspire me to work more on open-source projects like this!">Made with <em class=love-color>&#9829;</em> by <a href=https://github.com/thedevsaddam target=_blank class=text-muted>thedevsaddam</a> | Generated at: 2021-10-04 13:17:07 by <a href=https://github.com/thedevsaddam/docgen target=_blank class=text-muted>docgen</a></span></div></div></footer>
+return '<span class="'+cls+'">'+match+'</span>';});}</script><br><br><footer class="navbar-default navbar-fixed-bottom"><div class=container-fluid><div class="span12 text-center"><span data-toggle=tooltip title="If the application help you, please feel free to give a star to the project in github. Your star inspire me to work more on open-source projects like this!">Made with <em class=love-color>&#9829;</em> by <a href=https://github.com/thedevsaddam target=_blank class=text-muted>thedevsaddam</a> | Generated at: 2021-10-18 16:28:46 by <a href=https://github.com/thedevsaddam/docgen target=_blank class=text-muted>docgen</a></span></div></div></footer>
 <script type="text/javascript">
     $(document).ready(function() {
         document.title = 'pfSense REST API Documentation';
         var curr_year = new Date().getFullYear();
-        document.querySelector('footer').innerHTML = "<a href='/api/'>Back to pfSense</a> | <a href='https://github.com/jaredhendrickson13/pfsense-api'>View on Github</a> | <a href='https://github.com/jaredhendrickson13/pfsense-api/issues/new'>Report an Issue</a><p>Copyright &copy; " + curr_year + " - Jared Hendrickson</p>";
+        document.querySelector('footer').innerHTML = "<a href='/api/'>Back to pfSense</a> | <a href='https://github.com/jaredhendrickson13/pfsense-api'>View on Github</a> | <a href='https://github.com/jaredhendrickson13/pfsense-api/issues/new/choose'>Report an Issue</a><p>Copyright &copy; " + curr_year + " - Jared Hendrickson</p>";
     });
 
 </script>

pfSense-pkg-API/files/usr/local/www/api/index.php

@@ -366,7 +366,7 @@
 $rotate_btn->setOnclick("return confirm(\"Rotating the server key will void any existng API tokens and JWTs. Proceed?\");");
 $form->addGlobal(new Form_Button('save', 'Save', null, 'fa-save'))->addClass('btn btn-sm btn-primary api-save-btn');
 (in_array($pkg_config["authmode"], ["token", "jwt"])) ? $form->addGlobal($rotate_btn) : null;
-$form->addGlobal(new Form_Button('report', 'Report an Issue', 'https://github.com/jaredhendrickson13/pfsense-api/issues/new', ''))->addClass('fa fa-question-circle api-report');
+$form->addGlobal(new Form_Button('report', 'Report an Issue', 'https://github.com/jaredhendrickson13/pfsense-api/issues/new/choose', ''))->addClass('fa fa-question-circle api-report');
 
 # Display the populated configuration form
 print $form;

tests/test_api_v1_system_ca.py

@@ -1,4 +1,5 @@
 import unit_test_framework
+import base64
 
 
 class APIUnitTestSystemCA(unit_test_framework.APIUnitTest):
@@ -208,4 +209,25 @@ class APIUnitTestSystemCA(unit_test_framework.APIUnitTest):
         # TODO: add test to check that CAs in use cannot be deleted
     ]
 
+    def post_post(self):
+        # Check if this is after the first POST test
+        if len(self.post_responses) == 1:
+            self.is_return_crt_base64(self.post_responses[0])
+
+
+    def is_return_crt_base64(self, response):
+        """
+        Takes a test response and checks if the return 'crt' data field is a Base64 encoded certificate
+        """
+        # Variables
+        test_params = {"name": "Ensure cert is Base64 encoded"}
+        crt = base64.b64decode(response["data"]["crt"])
+
+        # Ensure the returned Base64 decoded crt value is a certificate
+        if "BEGIN CERTIFICATE" not in crt.decode():
+            self.exit_code = 1
+            print(self.__format_msg__("POST", test_params, "Returned certificate is not Base64 encoded"))
+        else:
+            print(self.__format_msg__("POST", test_params, "Response is valid", "ok"))
+
 APIUnitTestSystemCA()

tests/test_api_v1_user.py

@@ -154,18 +154,7 @@ class APIUnitTestUser(unit_test_framework.APIUnitTest):
                 "password": "changeme",
                 "cert": "INVALID"
             }
-        },
-        {
-            "name": "Check inability to add server certificate as a user certificate",
-            "status": 400,
-            "return": 5041,
-            "server_cert": True,
-            "payload": {
-                "username": "another_user",
-                "password": "changeme"
-            }
-        },
-
+        }
     ]
     put_tests = [
         {
@@ -213,9 +202,7 @@ class APIUnitTestUser(unit_test_framework.APIUnitTest):
             }
         },
         {
-            "name": "Check inability to add server certificate as a user certificate",
-            "status": 400,
-            "return": 5041,
+            "name": "Check ability to add server certificate as a user certificate",
             "server_cert": True,
             "payload": {
                 "username": "new_user",
@@ -245,11 +232,6 @@ class APIUnitTestUser(unit_test_framework.APIUnitTest):
             "return": 1005,
             "payload": {"descr": "USER_CERT"}
         },
-        {
-            "name": "Delete server certificate used for testing",
-            "uri": "/api/v1/system/certificate",
-            "payload": {"descr": "SERVER_CERT"}
-        },
         {
             "name": "Delete local user",
             "payload": {"username": "new_user"}
@@ -275,6 +257,11 @@ class APIUnitTestUser(unit_test_framework.APIUnitTest):
             "uri": "/api/v1/system/certificate",
             "payload": {"descr": "USER_CERT"}
         },
+        {
+            "name": "Delete server certificate used for testing",
+            "uri": "/api/v1/system/certificate",
+            "payload": {"descr": "SERVER_CERT"}
+        },
         {
             "name": "Delete CA used for testing",
             "uri": "/api/v1/system/ca",

tools/make_documentation.py

@@ -127,7 +127,7 @@
     $(document).ready(function() {
         document.title = 'pfSense REST API Documentation';
         var curr_year = new Date().getFullYear();
-        document.querySelector('footer').innerHTML = "<a href='/api/'>Back to pfSense</a> | <a href='https://github.com/jaredhendrickson13/pfsense-api'>View on Github</a> | <a href='https://github.com/jaredhendrickson13/pfsense-api/issues/new'>Report an Issue</a><p>Copyright &copy; " + curr_year + " - Jared Hendrickson</p>";
+        document.querySelector('footer').innerHTML = "<a href='/api/'>Back to pfSense</a> | <a href='https://github.com/jaredhendrickson13/pfsense-api'>View on Github</a> | <a href='https://github.com/jaredhendrickson13/pfsense-api/issues/new/choose'>Report an Issue</a><p>Copyright &copy; " + curr_year + " - Jared Hendrickson</p>";
     });
 
 </script>