Merge pull request #715 from LeeLeahy2/dbg-cert

Debug Point Perfect certificate management

Author: nseidle

Firmware/RTK_Surveyor/NVM.ino

@@ -259,6 +259,8 @@ void recordSystemSettingsToFile(File *settingsFile)
     settingsFile->printf("%s=%s\r\n", "ntripClient_MountPointPW", settings.ntripClient_MountPointPW);
     settingsFile->printf("%s=%d\r\n", "ntripClient_TransmitGGA", settings.ntripClient_TransmitGGA);
     settingsFile->printf("%s=%d\r\n", "serialTimeoutGNSS", settings.serialTimeoutGNSS);
+
+    // Point Perfect
     settingsFile->printf("%s=%s\r\n", "pointPerfectDeviceProfileToken", settings.pointPerfectDeviceProfileToken);
     settingsFile->printf("%s=%d\r\n", "enablePointPerfectCorrections", settings.enablePointPerfectCorrections);
     settingsFile->printf("%s=%d\r\n", "autoKeyRenewal", settings.autoKeyRenewal);
@@ -272,6 +274,8 @@ void recordSystemSettingsToFile(File *settingsFile)
     settingsFile->printf("%s=%llu\r\n", "pointPerfectNextKeyDuration", settings.pointPerfectNextKeyDuration);
     settingsFile->printf("%s=%llu\r\n", "pointPerfectNextKeyStart", settings.pointPerfectNextKeyStart);
     settingsFile->printf("%s=%llu\r\n", "lastKeyAttempt", settings.lastKeyAttempt);
+    settingsFile->printf("%s=%d\r\n", "debugPpCertificate", settings.debugPpCertificate);
+
     settingsFile->printf("%s=%d\r\n", "updateZEDSettings", settings.updateZEDSettings);
     settingsFile->printf("%s=%d\r\n", "LBandFreq", settings.LBandFreq);
     settingsFile->printf("%s=%d\r\n", "enableLogging", settings.enableLogging);
@@ -1045,6 +1049,8 @@ bool parseLine(char *str, Settings *settings)
         settings->ntripClient_TransmitGGA = d;
     else if (strcmp(settingName, "serialTimeoutGNSS") == 0)
         settings->serialTimeoutGNSS = d;
+
+    // Point Perfect
     else if (strcmp(settingName, "pointPerfectDeviceProfileToken") == 0)
         strcpy(settings->pointPerfectDeviceProfileToken, settingValue);
     else if (strcmp(settingName, "enablePointPerfectCorrections") == 0)
@@ -1074,6 +1080,9 @@ bool parseLine(char *str, Settings *settings)
 
     else if (strcmp(settingName, "lastKeyAttempt") == 0)
         settings->lastKeyAttempt = d;
+    else if (strcmp(settingName, "debugPpCertificate") == 0)
+        settings->debugPpCertificate = d;
+
     else if (strcmp(settingName, "updateZEDSettings") == 0)
     {
         if (settings->updateZEDSettings != d)

Firmware/RTK_Surveyor/menuPP.ino

@@ -423,7 +423,8 @@ bool checkCertificates()
 
     if (checkCertificateValidity(certificateContents, strlen(certificateContents)) == false)
     {
-        log_d("Certificate is corrupt.");
+        if (settings.debugPpCertificate)
+            systemPrintln("Certificate is corrupt.");
         validCertificates = false;
     }
 
@@ -433,7 +434,8 @@ bool checkCertificates()
 
     if (checkCertificateValidity(keyContents, strlen(keyContents)) == false)
     {
-        log_d("PrivateKey is corrupt.");
+        if (settings.debugPpCertificate)
+            systemPrintln("PrivateKey is corrupt.");
         validCertificates = false;
     }
 
@@ -443,6 +445,8 @@ bool checkCertificates()
     if (keyContents)
         free(keyContents);
 
+    if (settings.debugPpCertificate && validCertificates)
+        systemPrintln("Certificates are valid!");
     return (validCertificates);
 }
 
@@ -463,7 +467,8 @@ bool checkCertificateValidity(char *certificateContent, int certificateContentSi
 
     if (result_code < 0)
     {
-        log_d("Cert formatting invalid");
+        if (settings.debugPpCertificate)
+            systemPrintln("Cert formatting invalid");
         return (false);
     }
 

Firmware/RTK_Surveyor/menuSystem.ino

@@ -655,6 +655,10 @@ void menuDebugSoftware()
         systemPrintf("60) Print firmware update states: %s\r\n",
                      settings.debugFirmwareUpdate ? "Enabled" : "Disabled");
 
+        // Point Perfect
+        systemPrintf("70) Point Perfect certificate management: %s\r\n",
+                     settings.debugPpCertificate ? "Enabled" : "Disabled");
+
         systemPrintln("e) Erase LittleFS");
 
         systemPrintln("r) Force system reset");
@@ -716,6 +720,8 @@ void menuDebugSoftware()
             settings.enableTaskReports ^= 1;
         else if (incoming == 60)
             settings.debugFirmwareUpdate ^= 1;
+        else if (incoming == 70)
+            settings.debugPpCertificate ^= 1;
         else if (incoming == 'e')
         {
             systemPrintln("Erasing LittleFS and resetting");

Firmware/RTK_Surveyor/settings.h

@@ -896,6 +896,7 @@ typedef struct
     int16_t serialTimeoutGNSS = 1; // In ms - used during SerialGNSS.begin. Number of ms to pass of no data before
                                    // hardware serial reports data available.
 
+    // Point Perfect
     char pointPerfectDeviceProfileToken[40] = "";
     bool enablePointPerfectCorrections = true;
     bool autoKeyRenewal = true; // Attempt to get keys if we get under 28 days from the expiration date
@@ -915,6 +916,8 @@ typedef struct
     bool updateZEDSettings = true;   // When in doubt, update the ZED with current settings
     uint32_t LBandFreq = 1556290000; // Default to US band
 
+    bool debugPpCertificate = false; // Debug Point Perfect certificate management
+
     // Time Zone - Default to UTC
     int8_t timeZoneHours = 0;
     int8_t timeZoneMinutes = 0;