https://github.com/ifreund/waylock

[mirror] A small, secure Wayland screenlocker
https://github.com/ifreund/waylock

screenlocker wayland wayland-client zig

Last synced: 26 days ago
JSON representation

[mirror] A small, secure Wayland screenlocker

• Host: GitHub
• URL: https://github.com/ifreund/waylock
• Owner: ifreund
• License: isc
• Created: 2019-12-12T00:58:16.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-09-15T12:35:50.000Z (about 2 months ago)
• Last Synced: 2024-09-30T03:20:58.661Z (about 1 month ago)
• Topics: screenlocker, wayland, wayland-client, zig
• Language: Zig
• Homepage: https://isaacfreund.com/software/waylock
• Size: 318 KB
• Stars: 392
• Watchers: 6
• Forks: 18
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-zig - waylock🗒️A small screenlocker for Wayland compositors

README

        
# 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.

Install from your [package manager](https://repology.org/project/waylock/versions)

The main repository is on [codeberg](https://codeberg.org/ifreund/waylock),

which is where the issue tracker may be found and where contributions are accepted.

Read-only mirrors exist on [sourcehut](https://git.sr.ht/~ifreund/waylock)

and [github](https://github.com/ifreund/waylock).

## Building

Note: If you are packaging waylock for distribution, see [PACKAGING.md](PACKAGING.md).

To compile waylock first ensure that you have the following dependencies

installed:

- [zig](https://ziglang.org/download/) 0.13.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](pam.d/waylock) is found by PAM.

## 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`. `Esc` or `Ctrl-U` clears all current input, while `backspace`

deletes the last UTF-8 codepoint.

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](https://github.com/swaywm/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.