Change sprintf to snprintf

Author: PaulZC

Firmware/RTK_Surveyor/Begin.ino

@@ -647,7 +647,7 @@ void beginGNSS()
   if (theGNSS.getModuleInfo(1100) == true) // Try to get the module info
   {
     // Reconstruct the firmware version
-    sprintf(zedFirmwareVersion, "%s %d.%02d", theGNSS.getFirmwareType(), theGNSS.getFirmwareVersionHigh(), theGNSS.getFirmwareVersionLow());
+    snprintf(zedFirmwareVersion, sizeof(zedFirmwareVersion), "%s %d.%02d", theGNSS.getFirmwareType(), theGNSS.getFirmwareVersionHigh(), theGNSS.getFirmwareVersionLow());
 
     // Construct the firmware version as uint8_t. Note: will fail above 2.55!
     zedFirmwareVersionInt = (theGNSS.getFirmwareVersionHigh() * 100) + theGNSS.getFirmwareVersionLow();
@@ -953,7 +953,7 @@ void beginIdleTasks()
 
     for (int index = 0; index < MAX_CPU_CORES; index++)
     {
-      sprintf(taskName, "IdleTask%d", index);
+      snprintf(taskName, sizeof(taskName), "IdleTask%d", index);
       if (idleTaskHandle[index] == nullptr)
         xTaskCreatePinnedToCore(
           idleTask,

Firmware/RTK_Surveyor/Bluetooth.ino

@@ -153,7 +153,7 @@ void bluetoothStart()
     else if (systemState >= STATE_BASE_NOT_STARTED && systemState <= STATE_BASE_FIXED_TRANSMITTING)
       strcpy(stateName, "Base-");
 
-    sprintf(deviceName, "%s %s%02X%02X", platformPrefix, stateName, btMACAddress[4], btMACAddress[5]);
+    snprintf(deviceName, sizeof(deviceName), "%s %s%02X%02X", platformPrefix, stateName, btMACAddress[4], btMACAddress[5]);
 
     // Select Bluetooth setup
     if (settings.bluetoothRadioType == BLUETOOTH_RADIO_OFF)
@@ -270,7 +270,7 @@ void bluetoothTest(bool runTest)
 
   //Display Bluetooth MAC address and test results
   char macAddress[5];
-  sprintf(macAddress, "%02X%02X", btMACAddress[4], btMACAddress[5]);
+  snprintf(macAddress, sizeof(macAddress), "%02X%02X", btMACAddress[4], btMACAddress[5]);
   systemPrint("Bluetooth ");
   if (settings.bluetoothRadioType == BLUETOOTH_RADIO_BLE)
     systemPrint("Low Energy ");

Firmware/RTK_Surveyor/Display.ino

@@ -365,7 +365,7 @@ void updateDisplay()
         const uint8_t * rtkMacAddress = getMacAddress();
 
         //Print four characters of MAC
-        sprintf(macAddress, "%02X%02X", rtkMacAddress[4], rtkMacAddress[5]);
+        snprintf(macAddress, sizeof(macAddress), "%02X%02X", rtkMacAddress[4], rtkMacAddress[5]);
         oled.setFont(QW_FONT_5X7); //Set font to smallest
         oled.setCursor(0, 3);
         oled.print(macAddress);
@@ -409,7 +409,7 @@ void updateDisplay()
         const uint8_t * rtkMacAddress = getMacAddress();
 
         //Print only last two digits of MAC
-        sprintf(macAddress, "%02X", rtkMacAddress[5]);
+        snprintf(macAddress, sizeof(macAddress), "%02X", rtkMacAddress[5]);
         oled.setFont(QW_FONT_5X7); //Set font to smallest
         oled.setCursor(14, 3);
         oled.print(macAddress);
@@ -523,9 +523,9 @@ void displaySplash()
     yPos = yPos + fontHeight + 7;
     char unitFirmware[50];
 #ifdef ENABLE_DEVELOPER
-    sprintf(unitFirmware, "v%d.%d-DEV", FIRMWARE_VERSION_MAJOR, FIRMWARE_VERSION_MINOR);
+    snprintf(unitFirmware, sizeof(unitFirmware), "v%d.%d-DEV", FIRMWARE_VERSION_MAJOR, FIRMWARE_VERSION_MINOR);
 #else
-    sprintf(unitFirmware, "v%d.%d", FIRMWARE_VERSION_MAJOR, FIRMWARE_VERSION_MINOR);
+    snprintf(unitFirmware, sizeof(unitFirmware), "v%d.%d", FIRMWARE_VERSION_MAJOR, FIRMWARE_VERSION_MINOR);
 #endif
     printTextCenter(unitFirmware, yPos, QW_FONT_5X7, 1, false);
 
@@ -1696,11 +1696,11 @@ void displayWiFiConfig()
 
 #ifdef COMPILE_WIFI
   if (settings.wifiConfigOverAP == true)
-    sprintf(mySSID, "%s", "RTK Config");
+    snprintf(mySSID, sizeof(mySSID), "%s", "RTK Config");
   else
-    sprintf(mySSID, "%s", WiFi.SSID().c_str());
+    snprintf(mySSID, sizeof(mySSID), "%s", WiFi.SSID().c_str());
 #else
-  sprintf(mySSID, "%s", "!Compiled");
+  snprintf(mySSID, sizeof(mySSID), "%s", "!Compiled");
 #endif
 
   char mySSIDFront[displayMaxCharacters + 1]; //1 for null terminator
@@ -1736,7 +1736,7 @@ void displayWiFiConfig()
 
   //Convert to string
   char myIP[20] = {'\0'};
-  sprintf(myIP, "%d.%d.%d.%d", myIpAddress[0], myIpAddress[1], myIpAddress[2], myIpAddress[3]);
+  snprintf(myIP, sizeof(myIP), "%d.%d.%d.%d", myIpAddress[0], myIpAddress[1], myIpAddress[2], myIpAddress[3]);
 
   char myIPFront[displayMaxCharacters + 1]; //1 for null terminator
   char myIPBack[displayMaxCharacters + 1]; //1 for null terminator
@@ -1856,7 +1856,7 @@ void displayFirmwareUpdateProgress(int percentComplete)
 
     yPos = yPos + fontHeight + 3;
     char temp[50];
-    sprintf(temp, "%d%%", percentComplete);
+    snprintf(temp, sizeof(temp), "%d%%", percentComplete);
     printTextCenter(temp, yPos, QW_FONT_8X16, 1, false); //text, y, font type, kerning, inverted
 
     oled.display(); //Push internal buffer to display
@@ -2014,7 +2014,7 @@ void paintSystemTest()
       //Get the last two digits of MAC
       char macAddress[5];
       const uint8_t * rtkMacAddress = getMacAddress();
-      sprintf(macAddress, "%02X%02X", rtkMacAddress[4], rtkMacAddress[5]);
+      snprintf(macAddress, sizeof(macAddress), "%02X%02X", rtkMacAddress[4], rtkMacAddress[5]);
 
       //Display MAC address
       oled.setCursor(xOffset, yOffset + (5 * charHeight) ); //x, y
@@ -2587,11 +2587,11 @@ void paintKeyProvisionFail(uint16_t displayTime)
     char hardwareID[13];
     const uint8_t * rtkMacAddress = getMacAddress();
 
-    sprintf(hardwareID, "%02X%02X%02X", rtkMacAddress[0], rtkMacAddress[1], rtkMacAddress[2]);
+    snprintf(hardwareID, sizeof(hardwareID), "%02X%02X%02X", rtkMacAddress[0], rtkMacAddress[1], rtkMacAddress[2]);
     y += fontHeight;
     printTextCenter(hardwareID, y, QW_FONT_5X7, 1, false); //text, y, font type, kerning, inverted
 
-    sprintf(hardwareID, "%02X%02X%02X", rtkMacAddress[3], rtkMacAddress[4], rtkMacAddress[5]);
+    snprintf(hardwareID, sizeof(hardwareID), "%02X%02X%02X", rtkMacAddress[3], rtkMacAddress[4], rtkMacAddress[5]);
     y += fontHeight;
     printTextCenter(hardwareID, y, QW_FONT_5X7, 1, false); //text, y, font type, kerning, inverted
 

Firmware/RTK_Surveyor/Form.ino

@@ -367,7 +367,7 @@ static void handleFirmwareFileUpload(AsyncWebServerRequest * request, String fil
         binBytesLastUpdate = binBytesSent;
 
         char bytesSentMsg[100];
-        sprintf(bytesSentMsg, "%'d bytes sent", binBytesSent);
+        snprintf(bytesSentMsg, sizeof(bytesSentMsg), "%'d bytes sent", binBytesSent);
 
         systemPrintf("bytesSentMsg: %s\r\n", bytesSentMsg);
 
@@ -446,7 +446,7 @@ void createSettingsString(char* newSettings)
   stringRecord(newSettings, "platformPrefix", platformPrefix);
 
   char apRtkFirmwareVersion[86];
-  sprintf(apRtkFirmwareVersion, "v%d.%d-%s", FIRMWARE_VERSION_MAJOR, FIRMWARE_VERSION_MINOR, __DATE__);
+  snprintf(apRtkFirmwareVersion, sizeof(apRtkFirmwareVersion), "v%d.%d-%s", FIRMWARE_VERSION_MAJOR, FIRMWARE_VERSION_MINOR, __DATE__);
   stringRecord(newSettings, "rtkFirmwareVersion", apRtkFirmwareVersion);
 
   char apZedPlatform[50];
@@ -456,11 +456,11 @@ void createSettingsString(char* newSettings)
     strcpy(apZedPlatform, "ZED-F9R");
 
   char apZedFirmwareVersion[80];
-  sprintf(apZedFirmwareVersion, "%s Firmware: %s", apZedPlatform, zedFirmwareVersion);
+  snprintf(apZedFirmwareVersion, sizeof(apZedFirmwareVersion), "%s Firmware: %s", apZedPlatform, zedFirmwareVersion);
   stringRecord(newSettings, "zedFirmwareVersion", apZedFirmwareVersion);
 
   char apDeviceBTID[30];
-  sprintf(apDeviceBTID, "Device Bluetooth ID: %02X%02X", btMACAddress[4], btMACAddress[5]);
+  snprintf(apDeviceBTID, sizeof(apDeviceBTID), "Device Bluetooth ID: %02X%02X", btMACAddress[4], btMACAddress[5]);
   stringRecord(newSettings, "deviceBTID", apDeviceBTID);
 
   //GNSS Config
@@ -544,19 +544,19 @@ void createSettingsString(char* newSettings)
 
   //L-Band
   char hardwareID[13];
-  sprintf(hardwareID, "%02X%02X%02X%02X%02X%02X", lbandMACAddress[0], lbandMACAddress[1], lbandMACAddress[2], lbandMACAddress[3], lbandMACAddress[4], lbandMACAddress[5]); //Get ready for JSON
+  snprintf(hardwareID, sizeof(hardwareID), "%02X%02X%02X%02X%02X%02X", lbandMACAddress[0], lbandMACAddress[1], lbandMACAddress[2], lbandMACAddress[3], lbandMACAddress[4], lbandMACAddress[5]); //Get ready for JSON
   stringRecord(newSettings, "hardwareID", hardwareID);
 
   char apDaysRemaining[20];
   if (strlen(settings.pointPerfectCurrentKey) > 0)
   {
 #ifdef COMPILE_L_BAND
     uint8_t daysRemaining = daysFromEpoch(settings.pointPerfectNextKeyStart + settings.pointPerfectNextKeyDuration + 1);
-    sprintf(apDaysRemaining, "%d", daysRemaining);
+    snprintf(apDaysRemaining, sizeof(apDaysRemaining), "%d", daysRemaining);
 #endif
   }
   else
-    sprintf(apDaysRemaining, "No Keys");
+    snprintf(apDaysRemaining, sizeof(apDaysRemaining), "No Keys");
 
   stringRecord(newSettings, "daysRemaining", apDaysRemaining);
 
@@ -576,8 +576,8 @@ void createSettingsString(char* newSettings)
   stringRecord(newSettings, "profileNumber", profileNumber);
   for (int index = 0; index < MAX_PROFILE_COUNT; index++)
   {
-    sprintf(tagText, "profile%dName", index);
-    sprintf(nameText, "%d: %s", index + 1, profileNames[index]);
+    snprintf(tagText, sizeof(tagText), "profile%dName", index);
+    snprintf(nameText, sizeof(nameText), "%d: %s", index + 1, profileNames[index]);
     stringRecord(newSettings, tagText, nameText);
   }
   //stringRecord(newSettings, "activeProfiles", activeProfiles);
@@ -611,7 +611,7 @@ void createSettingsString(char* newSettings)
 
   //Radio / ESP-Now settings
   char radioMAC[18];   //Send radio MAC
-  sprintf(radioMAC, "%02X:%02X:%02X:%02X:%02X:%02X",
+  snprintf(radioMAC, sizeof(radioMAC), "%02X:%02X:%02X:%02X:%02X:%02X",
           wifiMACAddress[0],
           wifiMACAddress[1],
           wifiMACAddress[2],
@@ -624,8 +624,8 @@ void createSettingsString(char* newSettings)
   stringRecord(newSettings, "espnowPeerCount", settings.espnowPeerCount);
   for (int index = 0; index < settings.espnowPeerCount; index++)
   {
-    sprintf(tagText, "peerMAC%d", index);
-    sprintf(nameText, "%02X:%02X:%02X:%02X:%02X:%02X",
+    snprintf(tagText, sizeof(tagText), "peerMAC%d", index);
+    snprintf(nameText, sizeof(nameText), "%02X:%02X:%02X:%02X:%02X:%02X",
             settings.espnowPeers[index][0],
             settings.espnowPeers[index][1],
             settings.espnowPeers[index][2],
@@ -649,15 +649,15 @@ void createSettingsString(char* newSettings)
       trim(stationInfo); //Remove trailing whitespace
       //log_d("ECEF SD station %d - found: %s", index, stationInfo);
       replaceCharacter(stationInfo, ',', ' '); //Change all , to ' ' for easier parsing on the JS side
-      sprintf(tagText, "stationECEF%d", index);
+      snprintf(tagText, sizeof(tagText), "stationECEF%d", index);
       stringRecord(newSettings, tagText, stationInfo);
     }
     else if (getFileLineLFS(stationCoordinateECEFFileName, index, stationInfo, sizeof(stationInfo)) == true) //fileName, lineNumber, array, arraySize
     {
       trim(stationInfo); //Remove trailing whitespace
       //log_d("ECEF LFS station %d - found: %s", index, stationInfo);
       replaceCharacter(stationInfo, ',', ' '); //Change all , to ' ' for easier parsing on the JS side
-      sprintf(tagText, "stationECEF%d", index);
+      snprintf(tagText, sizeof(tagText), "stationECEF%d", index);
       stringRecord(newSettings, tagText, stationInfo);
     }
     else
@@ -678,15 +678,15 @@ void createSettingsString(char* newSettings)
       trim(stationInfo); //Remove trailing whitespace
       //log_d("Geo SD station %d - found: %s", index, stationInfo);
       replaceCharacter(stationInfo, ',', ' '); //Change all , to ' ' for easier parsing on the JS side
-      sprintf(tagText, "stationGeodetic%d", index);
+      snprintf(tagText, sizeof(tagText), "stationGeodetic%d", index);
       stringRecord(newSettings, tagText, stationInfo);
     }
     else if (getFileLineLFS(stationCoordinateGeodeticFileName, index, stationInfo, sizeof(stationInfo)) == true) //fileName, lineNumber, array, arraySize
     {
       trim(stationInfo); //Remove trailing whitespace
       //log_d("Geo LFS station %d - found: %s", index, stationInfo);
       replaceCharacter(stationInfo, ',', ' '); //Change all , to ' ' for easier parsing on the JS side
-      sprintf(tagText, "stationGeodetic%d", index);
+      snprintf(tagText, sizeof(tagText), "stationGeodetic%d", index);
       stringRecord(newSettings, tagText, stationInfo);
     }
     else
@@ -699,10 +699,10 @@ void createSettingsString(char* newSettings)
   //Add WiFi credential table
   for (int x = 0 ; x < MAX_WIFI_NETWORKS ; x++)
   {
-    sprintf(tagText, "wifiNetwork%dSSID", x);
+    snprintf(tagText, sizeof(tagText), "wifiNetwork%dSSID", x);
     stringRecord(newSettings, tagText, settings.wifiNetworks[x].ssid);
 
-    sprintf(tagText, "wifiNetwork%dPassword", x);
+    snprintf(tagText, sizeof(tagText), "wifiNetwork%dPassword", x);
     stringRecord(newSettings, tagText, settings.wifiNetworks[x].password);
   }
 
@@ -1013,26 +1013,26 @@ void updateSettingWithValue(const char *settingName, const char* settingValueStr
       //We got a version number, now determine if it's newer or not
       char currentVersion[20];
       if (enableRCFirmware == false)
-        sprintf(currentVersion, "%d.%d", FIRMWARE_VERSION_MAJOR, FIRMWARE_VERSION_MINOR);
+        snprintf(currentVersion, sizeof(currentVersion), "%d.%d", FIRMWARE_VERSION_MAJOR, FIRMWARE_VERSION_MINOR);
       else
-        sprintf(currentVersion, "%d.%d-%s", FIRMWARE_VERSION_MAJOR, FIRMWARE_VERSION_MINOR, __DATE__);
+        snprintf(currentVersion, sizeof(currentVersion), "%d.%d-%s", FIRMWARE_VERSION_MAJOR, FIRMWARE_VERSION_MINOR, __DATE__);
 
       if (isReportedVersionNewer(reportedVersion, currentVersion) == true)
       {
         log_d("New version detected");
-        sprintf(newVersionCSV, "newFirmwareVersion,%s,", reportedVersion);
+        snprintf(newVersionCSV, sizeof(newVersionCSV), "newFirmwareVersion,%s,", reportedVersion);
       }
       else
       {
         log_d("No new firmware available");
-        sprintf(newVersionCSV, "newFirmwareVersion,CURRENT,");
+        snprintf(newVersionCSV, sizeof(newVersionCSV), "newFirmwareVersion,CURRENT,");
       }
     }
     else
     {
       //Failed to get version number
       log_d("Sending error to AP config page");
-      sprintf(newVersionCSV, "newFirmwareVersion,ERROR,");
+      snprintf(newVersionCSV, sizeof(newVersionCSV), "newFirmwareVersion,ERROR,");
     }
 
     websocket->textAll(newVersionCSV);
@@ -1062,7 +1062,7 @@ void updateSettingWithValue(const char *settingName, const char* settingValueStr
       for (int x = 0 ; x < MAX_WIFI_NETWORKS ; x++)
       {
         char tempString[100]; //wifiNetwork0Password=parachutes
-        sprintf(tempString, "wifiNetwork%dSSID", x);
+        snprintf(tempString, sizeof(tempString), "wifiNetwork%dSSID", x);
         if (strcmp(settingName, tempString) == 0)
         {
           strcpy(settings.wifiNetworks[x].ssid, settingValueStr);
@@ -1071,7 +1071,7 @@ void updateSettingWithValue(const char *settingName, const char* settingValueStr
         }
         else
         {
-          sprintf(tempString, "wifiNetwork%dPassword", x);
+          snprintf(tempString, sizeof(tempString), "wifiNetwork%dPassword", x);
           if (strcmp(settingName, tempString) == 0)
           {
             strcpy(settings.wifiNetworks[x].password, settingValueStr);
@@ -1088,7 +1088,7 @@ void updateSettingWithValue(const char *settingName, const char* settingValueStr
       for (int x = 0 ; x < MAX_CONSTELLATIONS ; x++)
       {
         char tempString[50]; //ubxConstellationsSBAS
-        sprintf(tempString, "ubxConstellations%s", settings.ubxConstellations[x].textName);
+        snprintf(tempString, sizeof(tempString), "ubxConstellations%s", settings.ubxConstellations[x].textName);
 
         if (strcmp(settingName, tempString) == 0)
         {
@@ -1126,29 +1126,29 @@ void updateSettingWithValue(const char *settingName, const char* settingValueStr
 void stringRecord(char* settingsCSV, const char *id, int settingValue)
 {
   char record[100];
-  sprintf(record, "%s,%d,", id, settingValue);
+  snprintf(record, sizeof(record), "%s,%d,", id, settingValue);
   strcat(settingsCSV, record);
 }
 
 //Add record with uint32_t
 void stringRecord(char* settingsCSV, const char *id, uint32_t settingValue)
 {
   char record[100];
-  sprintf(record, "%s,%d,", id, settingValue);
+  snprintf(record, sizeof(record), "%s,%d,", id, settingValue);
   strcat(settingsCSV, record);
 }
 
 //Add record with double
 void stringRecord(char* settingsCSV, const char *id, double settingValue, int decimalPlaces)
 {
   char format[10];
-  sprintf(format, "%%0.%dlf", decimalPlaces); //Create '%0.09lf'
+  snprintf(format, sizeof(format), "%%0.%dlf", decimalPlaces); //Create '%0.09lf'
 
   char formattedValue[20];
-  sprintf(formattedValue, format, settingValue);
+  snprintf(formattedValue, sizeof(formattedValue), format, settingValue);
 
   char record[100];
-  sprintf(record, "%s,%s,", id, formattedValue);
+  snprintf(record, sizeof(record), "%s,%s,", id, formattedValue);
   strcat(settingsCSV, record);
 }
 
@@ -1162,23 +1162,23 @@ void stringRecord(char* settingsCSV, const char *id, bool settingValue)
     strcpy(temp, "false");
 
   char record[100];
-  sprintf(record, "%s,%s,", id, temp);
+  snprintf(record, sizeof(record), "%s,%s,", id, temp);
   strcat(settingsCSV, record);
 }
 
 //Add record with string
 void stringRecord(char* settingsCSV, const char *id, char* settingValue)
 {
   char record[100];
-  sprintf(record, "%s,%s,", id, settingValue);
+  snprintf(record, sizeof(record), "%s,%s,", id, settingValue);
   strcat(settingsCSV, record);
 }
 
 //Add record with uint64_t
 void stringRecord(char* settingsCSV, const char *id, uint64_t settingValue)
 {
   char record[100];
-  sprintf(record, "%s,%lld,", id, settingValue);
+  snprintf(record, sizeof(record), "%s,%lld,", id, settingValue);
   strcat(settingsCSV, record);
 }
 
@@ -1333,13 +1333,13 @@ String stringHumanReadableSize(uint64_t bytes)
   else cardSize = bytes / 1024.0 / 1024.0 / 1024.0; //GB
 
   if (strcmp(suffix, "GB") == 0)
-    sprintf(readableSize, "%0.1f %s", cardSize, suffix); //Print decimal portion
+    snprintf(readableSize, sizeof(readableSize), "%0.1f %s", cardSize, suffix); //Print decimal portion
   else if (strcmp(suffix, "MB") == 0)
-    sprintf(readableSize, "%0.1f %s", cardSize, suffix); //Print decimal portion
+    snprintf(readableSize, sizeof(readableSize), "%0.1f %s", cardSize, suffix); //Print decimal portion
   else if (strcmp(suffix, "KB") == 0)
-    sprintf(readableSize, "%0.1f %s", cardSize, suffix); //Print decimal portion
+    snprintf(readableSize, sizeof(readableSize), "%0.1f %s", cardSize, suffix); //Print decimal portion
   else
-    sprintf(readableSize, "%.0f %s", cardSize, suffix); //Don't print decimal portion
+    snprintf(readableSize, sizeof(readableSize), "%.0f %s", cardSize, suffix); //Don't print decimal portion
 
   return String(readableSize);
 }