This Waybar module adds a service that will lock your screen when your Yubikey is removed. The service is controlled by a toggle button in Waybar. This allows you to disable the service to conserve resources when the threat model is low risk, and to enable it when the threat model is higher risk (such as in public places like the airport or coffee shop).

The indicator will show the current status of the service and whether a YubiKey is currently inserted.

This Waybar module is intended to be used with hardware like the following (ref links to support my open source projects):

• YubiKey
• Magnetic USB A to C Adapter
• USB C Extension Cable

• usbutils needed to run lsusb

For NixOS users with Home Manager, you can use the included NixOS module for automatic systemd service management:

1. Import the module in your Home Manager configuration:

   { config, pkgs, ... }:
   {
     imports = [
       /path/to/yubilock/yubilock.nix
     ];
   
     services.yubilock = {
       enable = true;
       autoRestore = true;  # Automatically restore yubilock state on login
     };
   }

2. Copy the Waybar scripts to ~/.config/waybar/scripts/:

   mkdir -p ~/.config/waybar/scripts/
   cp scripts/*.sh ~/.config/waybar/scripts/
   chmod +x ~/.config/waybar/scripts/*.sh

3. Add the custom module to your Waybar config (see Waybar Configuration).

4. Add the CSS to your Waybar style.css (see Waybar CSS Style).

5. Rebuild your NixOS configuration:

   home-manager switch

The systemd services will be automatically configured:

• yubilock.service - Monitors YubiKey presence and locks screen on removal
• yubilock-restore.service - Restores yubilock state on login (if autoRestore = true)

1. Save the three scripts to: ~/.config/waybar/scripts/
2. Make them executable:

   chmod +x ~/.config/waybar/scripts/yubikey-status.sh
   chmod +x ~/.config/waybar/scripts/yubilock.sh
   chmod +x ~/.config/waybar/scripts/yubilock-toggle.sh
   

3. Add the custom module to your Waybar config (see Waybar Configuration).
4. Add the CSS to your Waybar style.css and/or style it to your liking (see Waybar CSS Style).
5. Restart Waybar: killall waybar && waybar &

Now you can toggle the Yubilock service by clicking the indicator in your Waybar. The indicator will show the current status of the service and whether a YubiKey is currently inserted.

Add this to your Waybar configuration file:

3.1 For NixOS:

"custom/yubilock" = {
  return-type = "json";
  interval = 5;
  exec = "$HOME/.config/waybar/scripts/yubikey-status.sh";
  on-click = "$HOME/.config/waybar/scripts/yubilock-toggle.sh";
  tooltip = true;
  format = "{icon}";
  format-icons = {
    active = "";
    inactive = "";
  };
};

3.2 For other Linux distributions:

"custom/yubilock": {
    "return-type": "json",
    "interval": 5,
    "exec": "$HOME/.config/waybar/scripts/yubikey-status.sh",
    "on-click": "$HOME/.config/waybar/scripts/yubilock-toggle.sh",
    "tooltip": true,
    "format": "{icon}",
    "format-icons": {
      "active": "",
      "inactive": "",
    },
}

Add this to your Waybar style.css file:

#custom-yubilock {
    padding: 0 10px;
    border-radius: 10px;
    margin: 6px 0;
}

#custom-yubilock.yubilock-on {
    background-color: #26a65b;
    color: #ffffff;
}

#custom-yubilock.yubilock-off {
    background-color: #e74c3c;
    color: #ffffff;
}

#custom-yubilock.yubilock-on:hover,
#custom-yubilock.yubilock-off:hover {
    background-color: #2
62BE
980b9;
}