swap-file-creator

From Kicksecure
Revision as of 13:44, 5 November 2024 by Patrick (talk | contribs) (→‎Disable)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
swap-file-creator logo

Adds encrypted swap file to the system.

Introduction[edit]

swap-file-creator adds an encrypted swap file to the system. On every boot, it creates a new encrypted swapfile with a random password.

This is useful for systems with low RAM such as those inside virtual machines. Prevents common cases of freezing of VMs with low RAM during upgrades. [1]

It has an ENOUGH_RAM setting which defaults to 1950 MB. If there is more than enough RAM, it will not advice to increase RAM.

An optional option exists to shred the swapfile on shutdown but this is slow. [2]

For further information, see: https://github.com/Kicksecure/swap-file-creatorarchive.org iconarchive.today icon

Installation[edit]

Platform dependent.

Configuration[edit]

The config file is located at /etc/default/swap-file-creatorarchive.org iconarchive.today icon. Here you can change various parameters for the swapfile creation such as the path for where to create the swapfile at startup. [5]

Open file /etc/default/swap-file-creator in an editor with root rights.

Kicksecure

See Open File with Root RightsOnion Logo for detailed instructions on why to use sudoedit for better security and how to use it.

Note: Mousepad (or the chosen text editor) must be closed before running the sudoedit command.

Click = Copy Copied to clipboard! sudoedit /etc/default/swap-file-creator

Kicksecure for Qubes

NOTES:

Click = Copy Copied to clipboard! sudoedit /etc/default/swap-file-creator

  • After applying this change, shutdown the Template.
  • All App Qubes based on the Template need to be restarted if they were already running.
  • This is a general procedure required for Qubes and unspecific to Kicksecure for Qubes.

Others and Alternatives

  • This is just an example. Other tools could achieve the same goal.
  • If this example does not work for you or if you are not using Kicksecure, please refer to this link.

Click = Copy Copied to clipboard! sudoedit /etc/default/swap-file-creator

For example, to set a custom swap file size of 1024 MB, add.

Click = Copy Copied to clipboard! SWAP_FILE_SIZE_CUSTOM_MB=1024

Save.

Done. Settings will be applied after reboot (or when swap-file-creator is restarted).

Other configuration options.

  • Click = Copy Copied to clipboard! SWAPFILE=/var/swapfile

Check Swap File Size[edit]

Click = Copy Copied to clipboard! sudo du -sh /var/swapfile

Functionality Test[edit]

To check it is working correctly, check the amount of free and used memory in the system.

Click = Copy Copied to clipboard! free -m

Next, enable swapping and display the swap usage summary.

Click = Copy Copied to clipboard! sudo swapon -s

For troubleshooting purposes, Check Daemon Log and search for unit-name: swap-file-creator.

Live Mode[edit]

swap-file-creator does not run if live mode is detected. [6]

Debugging[edit]

Only required in case of issues. Otherwise the user can skip this wiki chapter.

Error States[edit]

In case swap-file-creator is failing at boot time, it does not break the boot process.

For example, host kernel versions other than the one recommended on the recommended VirtualBox version wiki page are are likely to break VirtualBox VMs in many ways if these are unsupported by VirtualBox. [7] In this case, swap-file-creator might be brokenarchive.org iconarchive.today icon and this being the only visiblearchive.org iconarchive.today icon error but this still does not break the boot process. However, when using kernel versions unsupported by VirtualBox, many other things will be broken and the system will be unbootable anyhow.

Manual Swap File Creation[edit]

TODO: document

Disable[edit]

Click = Copy Copied to clipboard! sudo systemctl stop swap-file-creator

Click = Copy Copied to clipboard! sudo systemctl disable swap-file-creator

Click = Copy Copied to clipboard! sudo rm -f /var/swapfile

Development[edit]

See Also[edit]

Footnotes[edit]

  1. ↑ Such as during Linux kernel module building (VirtualBox guest additions) as well as kernel header package upgrades.
  2. ↑ https://github.com/Kicksecure/swap-file-creator/blob/master/etc/default/swap-file-creatorarchive.org iconarchive.today icon
  3. ↑

    Install package(s) swap-file-creator following these instructions

    1 Platform specific notice.

    2 Update the package lists and upgrade the systemOnion Logo.

    Click = Copy Copied to clipboard! sudo apt update && sudo apt full-upgrade

    3 Install the swap-file-creator package(s).

    Using apt command line --no-install-recommends optionOnion Logo is in most cases optional.

    Click = Copy Copied to clipboard! sudo apt install --no-install-recommends swap-file-creator

    4 Platform specific notice.

    • Kicksecure: No special notice.
    • Kicksecure-Qubes: Shut down Template and restart App Qubes based on it as per Qubes Template ModificationOnion Logo.

    5 Done.

    The procedure of installing package(s) swap-file-creator is complete.

  4. ↑ Setting up swap and/or encryption of any kind is completely up to Qubes. Unspecific to Kicksecure.
  5. ↑ Useful in case you have a copy-on-write system like ZFS or BtrFS.
  6. ↑ Live mode is detected if file /proc/cmdline contains string boot=live.
  7. ↑ https://www.virtualbox.org/ticket/17055#comment:3archive.org iconarchive.today icon
Your support makes
all the difference!

We believe security software like Kicksecure needs to remain Open Source and independent. Would you help sustain and grow the project? Learn more about our 12 year success story and maybe DONATE!

Retrieved from "https://www.kicksecure.com/w/index.php?title=Swap-file-creator&oldid=87874"