FreshTomato Wiki

User Tools

Site Tools

Trace:
remote_upgrade_poc

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
remote_upgrade_poc [2023/06/27 00:03] – [Remote Upgrade types] -formatting hogwildremote_upgrade_poc [2024/10/19 05:44] (current) – [References] hogwild
Line 40: Line 40:
   - A VPN server is configured, enabled and working.   - A VPN server is configured, enabled and working.
   - Dropbear/SSH access is possible.   - Dropbear/SSH access is possible.
-  - The internal network has an Ethernet LAN client that accessible via Teamviewer, once Internet connectivity \\ is available after minimal upgrade & reconfiguration. This will be used to complete other major reconfiguration.+  - The internal network has an Ethernet LAN client that accessible via Teamviewer, \\ once Internet connectivity is available after minimal upgrade & reconfiguration. \\ This will be used to complete other major reconfiguration.
  
  
Line 71: Line 71:
   - How critical is Internet access at the remote location? \\  \\    - How critical is Internet access at the remote location? \\  \\ 
   - How quickly can you reach the remote location to fix possible problems? \\  \\    - How quickly can you reach the remote location to fix possible problems? \\  \\ 
-  - Best practices include firmware upgrades when available. However, in scenarios involving remote configurations,  \\ only high impact CVEs should be considered.  Does this rule apply in your scenario? \\  \\ +  - Best practices include firmware upgrades when available. However, in remote configuration scenarios,  \\ only high impact CVEs should be considered.  Does this rule apply in your scenario? \\  \\ 
   - Make a backup plan in case the upgrade fails:   - Make a backup plan in case the upgrade fails:
     - Keep a spare device on site, fully configured and ready, or;     - Keep a spare device on site, fully configured and ready, or;
     - Reach the remote location in x hours/days or;     - Reach the remote location in x hours/days or;
     - Have someone on site who can recover from a failure.      - Have someone on site who can recover from a failure. 
-      - (Such as using the factory Reset button to restore the backup configuration / switch to PC internet only) \\  \\ +      - (Such as using the Reset button to restore the backup configuration/switch to PC internet only) \\  \\ 
-  - One problem with these routers is that newer firmware is written on top of the running firmware. This involves some risk that \\ the (now invalid) filesystem could cause issues/ crash during reboot. This would cause a manual power cycle to be needed.+  - A problem with these routers is the newer firmware is written on top of the running firmware. \\ This involves some risk that the (now invalid) filesystem could cause issues/ crash during reboot. \\ This would cause a manual power cycle \\ to be needed.
     - This could be easily resolved if someone on site could perform the power cycle. \\  \\     - This could be easily resolved if someone on site could perform the power cycle. \\  \\
-  - Asus tries to avoid this by creating a temporary rootfs where the critical bits are copied during reboot.  \\ It's unknown if FreshTomato does this. Even if it did, it wouldn't be fully reliable if a component were missing. +  - Asus tries to avoid this by creating a temporary rootfs where the critical bits are copied during reboot.  \\ It's unknown if FreshTomato does. Even if it did, it wouldn't be fully reliable if a component were missing. 
-    - Newer Broadcom routers solve this using two separate firmware partitions. The new firmware is written to  \\ the other partition, so the running filesystem remains intact.+    - Newer Broadcom routers solve this using two firmware partitions. The new firmware is written to  \\ the other partition, so the running filesystem remains intact.
     - **If you need something that is remotely managed, you need a router designed for that.**\\  \\     - **If you need something that is remotely managed, you need a router designed for that.**\\  \\
   - Trying to script fail-safe procedures for all possible scenarios will require a lot of work.   - Trying to script fail-safe procedures for all possible scenarios will require a lot of work.
-    - Other, potentially unrecoverable issues remain when physical access isn't available. Even in non-critical use cases, \\ it's annoying to perform that kind of recovery. \\  \\+    - Other, potentially unrecoverable issues remain when physical access isn't available. \\ Even in non-critical use cases, \\ it's annoying to perform that kind of recovery. \\  \\
   - You are strongly advised to perform an NVRAM full erase/reset after a FreshTomato upgrade.   - You are strongly advised to perform an NVRAM full erase/reset after a FreshTomato upgrade.
     - On its first run, FreshTomato will recreate and initialize required default parameters.     - On its first run, FreshTomato will recreate and initialize required default parameters.
     - A "dirty" upgrade (without NVRAM full erase/reset) might work. However, it is strongly discouraged,\\ since conflicts of current parameters/functions with the old ones can cause issues. \\  \\     - A "dirty" upgrade (without NVRAM full erase/reset) might work. However, it is strongly discouraged,\\ since conflicts of current parameters/functions with the old ones can cause issues. \\  \\
-  - Some form of permanent storage is needed. A full erase/reset of NVRAM-stored parameters via //mtd-erase// is not \\ committed until the next reboot/power cycle.+  - A form of permanent storage is needed. A full erase/reset of NVRAM-stored parameters via //mtd-erase// \\ is not committed until the next reboot/power cycle.
     - What is the difference betweeen the //mtd-erase// and //nvram erase// commands?     - What is the difference betweeen the //mtd-erase// and //nvram erase// commands?
-      - Issuing the //nvram erase// command still erases the nvram mtd. However, on reboot (or other action) NVRAM is saved \\ to mtd from RAM. Thus, it will not wipe everything unless power is removed right after the command completes. \\ However, //nvram erase// clears the NVRAM in RAM then writes to flash, but doesn't zero out all the flash. \\ See also [[https://wiki.dd-wrt.com/wiki/index.php/Hard_reset_or_30/30/30#Erasing_NVRAM|Hard reset or 30/30/30 - DD-WRT Wiki]] +      - Issuing the //nvram erase// command still erases the nvram mtd. However, on actions like a reboot, \\ NVRAM is saved to mtd from RAM. Thus, it will not wipe everything unless power is removed \\ right after the command completes. However, //nvram erase// clears the NVRAM in RAM then writes to flash, \\ but doesn't zero out all the flash. See also: [[https://wiki.dd-wrt.com/wiki/index.php/Hard_reset_or_30/30/30#Erasing_NVRAM|Hard reset or 30/30/30 - DD-WRT Wiki]] 
-      - The //nvram erase// command maintains the NVRAM structure (header/checksum/length) but erases the variables. \\ The //mtd// command erases the sectors of a flash partition, leaving the partition data values set to "FF" (flash erase state). \\  \\ +      - The //nvram erase// command maintains the NVRAM header/checksum/length structure but erases variables. \\ The //mtd// command erases a flash partition's sectors, leaving its data values set to "FF" (flash erase state). \\  \\ 
-  - Thus, options for storage persistence seem to be:+  - Thus, options for storage persistence would seem to be:
     - JFFS. However, by default, if NVRAM is cleared, JFFS is unmounted. Also, JFFS needs to be unmounted \\ before an upgrade, since occasionally it gets repartitioned/reformatted to a different size if the image grows.\\ (See [[https://www.linksysinfo.org/index.php?forums/tomato-firmware.33/|www.linksysinfo.org forum]] for more details)      - JFFS. However, by default, if NVRAM is cleared, JFFS is unmounted. Also, JFFS needs to be unmounted \\ before an upgrade, since occasionally it gets repartitioned/reformatted to a different size if the image grows.\\ (See [[https://www.linksysinfo.org/index.php?forums/tomato-firmware.33/|www.linksysinfo.org forum]] for more details) 
     - USB storage \\  \\     - USB storage \\  \\
-  - All forks of Tomato and DD-WRT trigger execution of certain shell scripts with the <filename>**.autorun** extension after \\ \\ external volumes or partitions are mounted.+  - All forks of Tomato trigger execution of certain shell scripts with the <filename>**.autorun** extension after \\ external volumes or partitions are mounted.
     - Automount mounts all partitions to subdirectories in "/mnt". The //nvram usb_automount// parameter \\ defaults to "1" (enabled), at least in recently compiled ".trx" firmware builds).     - Automount mounts all partitions to subdirectories in "/mnt". The //nvram usb_automount// parameter \\ defaults to "1" (enabled), at least in recently compiled ".trx" firmware builds).
-    - Logic is needed to distinguish if <filename>.autorun was run right after an upgrade or during reboots during normal operation. \\  \\ +    - Logic is needed to tell if the .autorun file ran right after an upgrade or on reboot during normal operation. \\  \\ 
-  - Performing an upgrade via the shell is safer than via the web interface. From the shell, you download a .zip and check \\ for magic number errors when extracting the archive. Most devices have enough RAM to host the .zip. Uploading a ".trx" file \\ via the web interface increases risk, especially on a less stable connection, such as WiFi client. \\  \\  +  - Performing an upgrade via the shell is safer than via the web interface. From the shell, you download a .zip \\ and check for magic number errors when extracting the archive. Most devices have enough RAM \\ to host the .zip. Uploading a ".trx" file via the web interface is more risky, especially on a less stable connection, \\ such as a WiFi client. \\  \\  
-  - Clearing NVRAM and restoring variables remotely via a script could lead to a serious lockout or bootloop. \\ Even if such an approach (having a list of nvram set commands) saved time, too many things could go wrong.\\  \\  +  - Clearing NVRAM and restoring variables remotely via a script could lead to a serious lockout or bootloop. \\ Even if such an approach (having a list of nvram set commands) saved time, too many things can go wrong.\\  \\  
-  - Having a persistent basic Internet connection, VPN, and LAN parameters could allow an internal device (such as a PC, \\ or small service/maintenance appliance RPI) to announce its availability. This could allow it to be accessed \\ remotely for finalizing the whole post-upgrade configuration. A VPN might not be needed if a remote access tool \\ such as Teamviewer were available). \\  \\  +  - Having a stable basic Internet connection, VPN, and LAN parameters could allow an internal device \\ (like a PC or small service/maintenance appliance RPI) to announce its availability. This could allow it \\ to be accessed remotely for finalizing the whole post-upgrade configuration. A VPN may not be needed \\ if a remote access tool such as Teamviewer were available). \\  \\  
-  - Upgrade options using TFTP wouldn't be viable because of the need to trigger the transfer during a short (few seconds) \\ service window during power-up. Such options might also require specific button combinations which wouldn't be practical.\\  \\  +  - Upgrade options using TFTP wouldn't be viable because of the need to trigger the transfer during a short \\ (a few seconds) service window during power-up. Also, such options may require specific button combinations \\ which would not be practical.\\  \\  
-  - Other options for FreshTomato to do a controlled reconfiguration during upgrade might include leaving specific entry points, \\ hooks, or callback scripts. However, this would require thorough examination, development and testing. Such work might be  \\ unfeasible if developer resources were limited.+  - Other options to do a controlled reconfiguration during upgrade might include leaving specific entry points, \\ hooks, or callback scripts. However, this would require thorough examination, development and testing. \\ Such work might be unfeasible if developer resources were limited.
  
  
Line 116: Line 116:
  
 There are several types of remote upgrades. They can be summarized in order of risk, as follows: There are several types of remote upgrades. They can be summarized in order of risk, as follows:
 + \\ 
 + \\ 
 +  * Dirty upgrade - overwrites the firmware and retains current NVRAM settings. This is probably \\ the safest method. It will function similar to an upgrade using the router's web interface. \\ \\ 
 +  * Clean upgrade - overwrites firmware and erases NVRAM settings, (restoring the default ones). \\ This will restore default settings, IP address and logon credentials. This is generally not a good option \\ when doing a remote upgrade. However, it can speed up the upgrade process if you're beside the router. \\ \\ 
 +  * Advanced upgrade - overwrites firmware, saves selected NVRAM configuration, erases NVRAM \\ and  restores saved settings via USB automount. This should be used only in unusual cases. \\ Such cases include sensitive remote installations, large installations, or anything that would justify \\ automating that level of complexity.
  
-  * Dirty upgrade - overwrites the firmware and retains current NVRAM settings. This is probably \\ the safest method. It will function similar to an upgrade using the router's web interface. + \\ 
-  * Clean upgrade - overwrites firmware and erases NVRAM settings, (restoring the default ones). \\ This will restore the default settings, IP address and logon credentials. This is generally not a good option \\ when doing a remote upgrade. However, it can useful for speeding up the upgrade process if you are physically beside the router. +
-  * Advanced upgrade - overwrites firmware, saves selected NVRAM configuration, erases NVRAM and  \\ restores saved settings via USB automount. This should be used only in unusual cases. Such cases include \\ sensitive remote installations, large installations, or anything that would justify automating that level of complexity. +
- +
-A dirty upgrade is probably the least risky method. It will function similar to an upgrade using the router's web interface. +
- +
-A clean upgrade will restore the default settings, IP address and logon credentials. This is generally not a good option when doing a remote upgrade. However, it can useful for speeding up the upgrade process if you are physically beside the hardware device. +
- +
-Advanced upgrades should be used only in unusual cases. Such cases include sensitive remote installations, large installations, or anything that would justify automating that level of complexity. +
- +
 ==== Dirty Upgrade ==== ==== Dirty Upgrade ====
  
Line 163: Line 158:
  
   - Evaluate the use of external files for certificates.   - Evaluate the use of external files for certificates.
-  - Evaluate the use of an external file for the list of parameters which need to be preserved.+  - Evaluate the use of an external file for the list of parameters to be preserved.
   - Replace the: `....` notation for subshell with FreshTomato's default syntax of:  "$(....)".   - Replace the: `....` notation for subshell with FreshTomato's default syntax of:  "$(....)".
-  - Consider handling EOL of files you reference internally. There are many sed examples on how to achieve this and force LR.+  - Consider handling EOL of files you reference internally. There are many sed examples \\ on how to do this and force LR.
   - Consider defining the USB path as a variable at the beginning of your script.   - Consider defining the USB path as a variable at the beginning of your script.
-  - Remember: some devices might have multiple USB drives plugged/multiple partitions. A "scan" of their content might help.+  - Remember: some devices might have multiple USB drives plugged/multiple partitions. \\ A "scan" of their content might help.
  
  \\  \\
Line 178: Line 173:
 The Main Preserve Script, with a list of parameters to save, creates the Restore script with actual parameter values. The Main Preserve Script, with a list of parameters to save, creates the Restore script with actual parameter values.
  
-**Caution: Unexpected side effects can occur if any parameter value contains the single quote (') character. ** +**Caution: Unexpected side effects can occur if any parameter value contains the single quote (') character. Consider replacing single quotes with double quotes (") whenever possible.**
- +
-**Consider replacing single quotes with double quote (") whenever possible.**+
  
  \\  \\
  
-After every upgrade, you should review the FreshTomato Changelog and code commits to help you decide whether further configuration adjustments will be needed. Such adjustments could be caused by:+After every upgrade, you should review the FreshTomato changelog and code commits to help you decide whether further configuration adjustments will be needed. Such adjustments could be caused by:
  
   - Bug fixes   - Bug fixes
Line 190: Line 183:
   - New features   - New features
   - Explicit recommendations from the developers   - Explicit recommendations from the developers
 +
  \\  \\
  
Line 203: Line 197:
  
  \\  \\
 +
 <code bash> <code bash>
 #!/bin/sh #!/bin/sh
Line 697: Line 692:
  \\   \\ 
 ===== Alternatives ===== ===== Alternatives =====
-  - Compile your own firmware with your settings hard-coded within it. 
-    - Building the compilation environment requires a lot of effort.  
-    - Consolidated experience with such process is necessary. 
-    - Several previous attempts were made using directions from: freshtomato-arm [[https://bitbucket.org/pedro311/freshtomato-arm/src/arm-master/README.md|README.md]] . However, these methods were **NEVER** able to generate a byte match with their own .trx build vs. .trx images prepared for general distribution in the [[https://freshtomato.org/downloads/|download repo]] 
  
-===== References and Online Resources =====+  * Compile your own firmware with your settings hard-coded within it. 
 +    * Building the compilation environment requires a lot of effort.  
 +    * Consolidated experience with such process is necessary. 
 +    * Earlier attempts were made using steps from: freshtomato-arm \\ [[https://bitbucket.org/pedro311/freshtomato-arm/src/arm-master/README.md|README.md]]. \\ However, these methods **weren't** able to generate a byte match \\ between their .trx build and .trx images prepared for general distribution \\ in the [[https://freshtomato.org/downloads/|download repository]]
  
-[[https://www.linksysinfo.org/index.php?threads/whats-the-best-way-to-upgrade-tomato-upgrade-2020-2-aio-to-latest.77558/post-339284|Whats the best way to upgrade Tomato upgrade 2020.2 AIO to latest] 
  
-[[https://bitbucket.org/pedro311/freshtomato-arm/src/04909aa16f6e41e60db742e781397cf505bda2de/release/src-rt-6.x.4708/router/httpd/upgrade.c?at=arm-master#upgrade.c-82,84,86,92,96,121,123,128|freshtomato-arm/release/httpd/upgrade.c source code]]+===== Remote Upgrade Notes and Troubleshooting =====
  
-[[https://bitbucket.org/pedro311/freshtomato-arm/issues/161/fature-request-separate-firmware-upload|Fature request: Separate firmware-upload and reboot actions]]+==== References ==== 
 + 
 + \\ 
 + 
 +[[https://www.linksysinfo.org/index.php?threads/whats-the-best-way-to-upgrade-tomato-upgrade-2020-2-aio-to-latest.77558/post-339284|Whats the best way to upgrade Tomato upgrade 2020.2 AIO to latest]] 
 + 
 + \\ 
 + 
 +[[https://bitbucket.org/pedro311/freshtomato-arm/issues/161/fature-request-separate-firmware-upload|Feature request: Separate firmware-upload and reboot actions]] 
 + 
 + \\
  
 [[https://www.linksysinfo.org/index.php?threads/run-one-off-script-after-installation-upgrade.77505/#post-336930|Run one off script after installation/upgrade]] [[https://www.linksysinfo.org/index.php?threads/run-one-off-script-after-installation-upgrade.77505/#post-336930|Run one off script after installation/upgrade]]
 +
 + \\
  
 [[https://wiki.dd-wrt.com/wiki/index.php/Script_Execution|Script Execution]] [[https://wiki.dd-wrt.com/wiki/index.php/Script_Execution|Script Execution]]
 +
 + \\
  
 [[https://www.linksysinfo.org/index.php?threads/a-curiosity-why-cant-tomato-have-router-config-backup-across-versions.76565/page-3#post-326993|A curiosity...why can't Tomato have router config backup across versions?]] [[https://www.linksysinfo.org/index.php?threads/a-curiosity-why-cant-tomato-have-router-config-backup-across-versions.76565/page-3#post-326993|A curiosity...why can't Tomato have router config backup across versions?]]
 +
 + \\
  
 [[https://wiki.dd-wrt.com/wiki/index.php/Hard_reset_or_30/30/30#Erasing_NVRAM|Hard reset or 30/30/30]] [[https://wiki.dd-wrt.com/wiki/index.php/Hard_reset_or_30/30/30#Erasing_NVRAM|Hard reset or 30/30/30]]
 +
 + \\
  
 [[https://forum.dd-wrt.com/phpBB2/viewtopic.php?p=470706#470706|Safe to run MTD ERASE NVRAM on WRT610n?]] [[https://forum.dd-wrt.com/phpBB2/viewtopic.php?p=470706#470706|Safe to run MTD ERASE NVRAM on WRT610n?]]
Line 724: Line 735:
 The "//nvram set//" command can be effectively integrated with [[https://www.linksysinfo.org/index.php?threads/a-curiosity-why-cant-tomato-have-router-config-backup-across-versions.76565/post-326993|the backup_nvram script]] The "//nvram set//" command can be effectively integrated with [[https://www.linksysinfo.org/index.php?threads/a-curiosity-why-cant-tomato-have-router-config-backup-across-versions.76565/post-326993|the backup_nvram script]]
  
 + \\
  
-===== Credits =====+ \\
  
-Thanks to all those at: [[https://www.linksysinfo.org/index.php|https://www.linksysinfo.org/index.php]] who supported this crazy endeavour! 
  
-[[https://www.linksysinfo.org/index.php?members/hommeoursporc.67394/|hommeoursporc@linksysinfo]]+==== Credits ==== 
 + 
 + \\ 
 + 
 +Thanks to all those at: [[https://www.linksysinfo.org/index.php|www.linksysinfo.org]] who supported this crazy endeavour! 
 + 
 + \\ 
 + 
 +[[https://www.linksysinfo.org/index.php?members/hommeoursporc.67394/|hommeoursporc@linksysinfo.org]]
  
-[[https://www.linksysinfo.org/index.php?members/rs232.25203/|rs232@linksysinfo]]+[[https://www.linksysinfo.org/index.php?members/rs232.25203/|rs232@linksysinfo.org]]
  
-[[https://www.linksysinfo.org/index.php?members/maurer.25051/|maurer@linksysinfo]]+[[https://www.linksysinfo.org/index.php?members/maurer.25051/|maurer@linksysinfo.org]]
  
-[[https://www.linksysinfo.org/index.php?members/djk44883.65725/|djk44883@linksysinfo]]+[[https://www.linksysinfo.org/index.php?members/djk44883.65725/|djk44883@linksysinfo.org]]
  
-[[https://www.linksysinfo.org/index.php?members/rmerlin.2388/|rmerlin@linksysinfo]]+[[https://www.linksysinfo.org/index.php?members/rmerlin.2388/|rmerlin@linksysinfo.org]]
  
  \\  \\
remote_upgrade_poc.1687820599.txt.gz · Last modified: by hogwild

Page Tools

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki