waylock

Notice: This repository has been migrated to https://codeberg.org/ifreund/waylock.

Waylock is a small screenlocker for Wayland compositors implementing ext-session-lock-v1. The ext-session-lock-v1 protocol is significantly more robust than previous client-side Wayland screen locking approaches. Importantly, the screenlocker crashing does not cause the session to be unlocked.

In addition, waylock has been entirely rewritten since version 0.3.5 for security and simplicity. It now benefits from everything I've learned about Wayland and programming in general over the past few years working on river.

Building

On cloning the repository, you must init and update the submodules as well with e.g.

git submodule update --init

To compile waylock first ensure that you have the following dependencies installed:

• zig 0.11.0
• wayland
• wayland-protocols
• xkbcommon
• pam
• pkg-config
• scdoc (optional, but required for man page generation)

Then run, for example:

zig build -Doptimize=ReleaseSafe --prefix /usr install

Note that PAM will only use configuration files in the system directory, likely /etc/pam.d by default. Therefore care must be taken if installing to a prefix other than /usr to ensure the configuration file pam.d/waylock is found by PAM.

If you are packaging waylock for distribution, see also PACKAGING.md.

Usage

See the waylock(1) man page or the output of waylock -h for an overview of the command line options.

Run the waylock executable to lock the session. All monitors will be blanked with the -init-color. Typing causes the color to change to the -input-color, to clear what you've typed press Esc or Ctrl-U.

To unlock the session, type your password and press Enter. If the password is correct, waylock will unlock the session and exit. Otherwise, the color will change to the -fail-color and you may try again.

In order to automatically run waylock after a certain amount of time with no input or before sleep, the swayidle utility or a similar program may be used. See the swayidle(1) man page for details.

Licensing

Waylock is released under the ISC License.