ANVILOCK

ANVILOCK stands for A Naive yet Intelligent LOCK

An upcoming screen lock for Wayland compositors that abides by the ext-session-lock-v1 Wayland Protocol.

Important

ANVILOCK is a [WIP] - Work in Progress

Stay tuned for more updates!

List of Contents

1. Project Structure

ANVILOCK
├── CHANGELOG/
├── LICENSE
├── README.md
├── SECURITY.md
├── VERSION
├── client_state.h
├── CMakeLists.txt
├── config.h
├── egl.h
├── freetype.h
├── log.h
├── main.c
├── Makefile
├── meson.build
├── pam.h
├── password_buffer.h
├── session_lock_handle.h
├── shared_mem_handle.h
├── stb_image.h
├── stb_image_write.h
├── surface_colors.h
├── toml
├   ├── toml.h
├   └── toml.c
├── unicode.h
├── wl_buffer_handle.h
├── wl_keyboard_handle.h
├── wl_output_handle.h
├── wl_pointer_handle.h
├── wl_registry_handle.h
├── wl_seat_handle.h
├── xdg_surface_handle.h
├── xdg_wm_base_handle.h
└── protocols
    ├── xdg-shell-client-protocol.h
    ├── ext-session-lock-client-protocol.h
    └── src
        ├── xdg-shell-client-protocol.c
        └── ext-session-lock-client-protocol.c

File Descriptions

client_state.h: Handles the overall state of the client, including tracking of surfaces, input, and buffer states.
log.h: Centralized logging mechanism to track operations and errors.
password_buffer.h: Secure handling of password storage, using memory sanitization techniques.
pam.h: Integration with Pluggable Authentication Modules (PAM) for user authentication.
wl_registry_handle.h: Handles Wayland registry interface, responsible for connecting to the Wayland compositor.
wl_buffer_handle.h: Deals with buffer management for rendering lock screens.
wl_seat_handle.h: Handles Wayland seat interface, used to manage input devices like keyboards and pointers.
wl_keyboard_handle.h: Manages keyboard input and event handling.
wl_pointer_handle.h: Manages pointer input and event handling.
xdg_surface_handle.h: Handles XDG surface protocols to create and manage window surfaces.
xdg_wm_base_handle.h: Deals with the XDG window manager base protocol for interacting with compositor windowing systems.
shared_mem_handle.h: Manages shared memory to allow efficient communication between processes.

Protocol Files:

Important

For more information regarding Wayland Protocol generation and its working,

Read PROTOCOLS.md

It gives a better understanding of generating protocol headers and source code along with details of what protocols to abide by to compile anvilock.

protocols/xdg-shell-client-protocol.h: Protocol definitions for XDG shell clients, managing surfaces and windows.
protocols/src/xdg-shell-client-protocol.c: Implementation of the XDG shell client protocol.
protocols/ext-session-lock-client-protocol.h: Protocol definitions for ext-session-lock-v1 protocol, session lock listener and management of lock surface.
protocols/src/ext-session-lock-client-protocol.c: Implementation of ext-session-lock-v1 protocol.

Toml Files:

toml/toml.h: Header file for tomlc99 parser.
toml/toml.c: Implementation of tomlc99 parser.

The TOML Parser being used in this repo is thanks to tomlc99

stb Files:

Headers used to draw and write images which are then loaded into an EGL texture for rendering

stb_image.h and stb_image_write.h are thanks to stb

Note

If you want to manually build anvilock without using build.sh

You will have to download stb_image.h header file from the stb repo mentioned above and place it in the anvilock directory.

2. Dependencies

ANVILOCK relies on the following dependencies:

libwayland-client: Handles Wayland client communication.
libwayland-server: Communication with the display server is possible through this library.
libwayland-egl: An interfacing library with OpenEGL ES 2.0 API binding for Wayland.
glesv2: Used for rendering 2D and 3D graphics on embedded systems and low-power devices, ensuring efficient graphics performance.
freetype2: Facilitates high-quality text rendering by processing and rasterizing font files in applications. (NOT BEING USED CURRENTLY)
libxkbcommon: Provides keyboard keymap compilation and handling.
libpam: Integration with the PAM authentication framework.
libc: Standard C library for memory handling, I/O, and other essential operations.
libm: Mathematical operations required by stb_image.h header.

Build dependencies:

pkg-config: To find and locate the required libraries.
CMake / Make / Meson: Any one is enough to locate and compile anvilock with default configurations.
gcc / clang: Any one compiler is enough to compile the source code.

All dependencies must be installed on your system before building.

Building

Prerequisites

Ensure that the dependencies listed in Dependencies are installed.

Build Instructions:

Simply run this in your terminal:

[anvilock]$ ./build.sh

The build script will take care of dependencies list, loading stb_image.h from github and loading the required wayland protocols for anvilock to run

Build Instructions (Manual)

1. Cloning the Repository

First, clone the repository:

git clone https://github.com/muvilon/anvilock.git

2. Building the Application

You can build the application using one of the following methods: Make, CMake, or Meson. Choose one based on your preference or environment.

Method 1: Building with Make

Navigate to the project directory:
```
cd anvilock
```
Build the application:
```
make
```
Modify the ~/.config/anvilock/config.toml file to use your font
Run the application (ensure the compositor is Wayland-compatible):
```
./anvilock
```

Caveats for Make:

Ensure that the Makefile is configured properly to find all necessary libraries and dependencies.
The Make build may not automatically handle out-of-source builds, so you might want to keep your source directory clean.

Method 2: Building with CMake

Navigate to the project directory:
```
cd anvilock
```
Create a build directory and navigate into it:
```
mkdir build && cd build
```
Configure the project:
```
cmake ..
```
Build the application:
```
make
```
Modify the ~/.config/anvilock/config.toml file to use your font
Run the application:
```
./anvilock
```

Caveats for CMake:

Ensure that you have the necessary CMake version (3.10 or later).
You may need to install cmake and pkg-config if they are not already available.
CMake supports out-of-source builds, keeping the source directory clean.

Method 3: Building with Meson

Navigate to the project directory:
```
cd anvilock
```
Create a build directory and set it up with Meson:
```
meson setup build
```
Build the application with or without the placeholder config file:
```
meson compile -C build [config]
```
Modify the ~/.config/anvilock/config.toml file to use your font
Run the application:
```
./build/anvilock
```

Caveats for Meson:

Ensure that you have Meson installed (you can usually install it via your package manager).
Meson defaults to an out-of-source build, which helps keep the project directory clean.
If you encounter issues with dependencies, you may need to install ninja (the default backend for Meson).

4. Configuration

All configurations are done through a config.toml file that will be generated in ~/.config/anvilock/ if not present

Make sure to check out ~/.config/anvilock/config.toml for more!

Note

Only the config for [bg] is customizable that lets you set the background of the lock screen

More configurations and customizations are to come!

An example config file is explained in config.toml

Conclusion

This project is far from over and has very active BREAKING changes so build and use with caution.

FAQ

Will this work for KDE or GNOME?

Short Answer is NO. They have their own implementations of the Wayland Protocol so unless we attempt to abide by both the general ext-session-lock-v1 and their protocols, it will NOT work on those DEs

Where can I use this?

Any WM/DE that does not have custom implementations of the Wayland Protocol and has the ext-session-lock-v1 protocol

Few examples: Hyprland, Sway, Wayfire, Cosmic, etc.

-> This will not work for compositors like Weston which lack the ext-session-lock-v1 protocol needed for anvilock to work.

5. Future

Stay tuned for more updates as we progress through development.

Anvilock is an open source software licensed under the BSD 3 Clause License.