This is a simple implementation of a Dead Man's Switch.
Use at your own risk. Check the f****(as in friendly) code.
Dead man's switches are designed to require positive action or they will automatically deploy. They are ideal for situations where you are worried about unforeseen death, kidnapping, or memory loss. If you don’t engage the trigger for a certain amount of time, the switch automatically sends the desired message.
- Simple: Easy to use and setup.
- Reliable: Implemented in Rust.
- Minimal: Very few dependencies and needs minimal resources.
- Warning: Sends a warning email before the final email.
- Attachments (Optional): Send attachments with the final email.
If you want a very simple explanation and the motivation behind the project, check my blog post here.
Upon starting the program it will create a config.toml file in an OS-agnostic config file location:
- Linux:
$XDG_CONFIG_HOME, i.e.$HOME/.config|/home/alice/.config - macOS:
$HOME/Library/Application Support, i.e./Users/Alice/Library/Application Support - Windows:
{FOLDERID_RoamingAppData}, i.e.C:\Users\Alice\AppData\Roaming
Edit the config.toml file to your liking. Some default values are provided for inspiration.
Dead Man's Switch comprises of two timers:
- Warning Timer: This timer is set to the
timer_warning(seconds) value in theconfig.tomlfile. If the user do not check-in before timer reaches 0, it will send a warning email to the users' own specified email address, thefromin theconfig.toml. - Dead Man's Timer: After the warning timer expires, the timer will change to a Dead Man's timer, and the timer will be set to the
timer_dead_man(seconds). If the user do not check-in before timer reaches 0, it will send the final email to the specified email address in theconfig.toml, i.e. thetoin theconfig.toml.
If you want to send attachments with the Dead Man's email, you can specify the attachments option config in the config.toml and provide the absolute path to the file you want to attach.
To check-in, you just need to press the c key as in check-in.
There are several ways to install Dead Man's Switch:
-
Crates.io:
cargo install dead-man-switch. -
GitHub:
cargo install --git https://github.com/storopoli/dead-man-switch. -
From source: Clone the repository and run
cargo install --path .. -
Using Nix:
nix run github:storopoli/dead-man-switch. -
Using Nix Flakes: add this to your
flake.nix:{ # ... inputs.dead-man-switch = { url = "github:storopoli/neovix"; inputs = { nixpkgs.follows = "nixpkgs"; flake-parts.follows = "flake-parts"; }; }; outputs = inputs @ { self, ... }: { imports = [ { nixpkgs.overlays = [ # ... inputs.dead-man-switch.overlays.default ]; } ]; }; }
Then
dead-man-switchwill be available aspkgs.dead-man-switch;
This crate uses current Debian stable Rust version as Minimum Supported Rust Version (MSRV). Please check Debian's rustc package for more details.
Currently, the MSRV is 1.63.0.
The source code is licensed under an AGPL v3 License
3 Mar 30, 2024
51 Dec 29, 2022
172 Dec 10, 2022
2 Sep 23, 2022
5 Aug 20, 2022
17 Mar 13, 2023
169 Dec 25, 2022
4 Jul 1, 2022
6 Nov 9, 2023
17 Dec 13, 2021
9 May 12, 2023
5 Apr 18, 2024
599 Jan 9, 2023
2.1k Jan 3, 2023
9 Jan 5, 2022
1 Oct 21, 2021
136 Jan 1, 2023
1 Jan 14, 2022
13 May 3, 2022