Auth

Library and CLI tool for authentication using pam.

Installation

1. install dependencies

Arch

sudo pacman -Syu meson pam gobject-introspection

Fedora

sudo dnf install meson pam-devel gobject-introspection-devel

Ubuntu

# Not yet documented

On NixOS you have to add astal-auth to security.pam.

configuration.nix

{
  security.pam.services.astal-auth = {}
}

2. clone repo

git clone https://github.com/aylur/astal.git
cd astal/lib/auth

3. install

meson setup build
meson install -C build

TIP

Most distros recommend manual installs in /usr/local, which is what meson defaults to. If you want to install to /usr instead which most package managers do, set the prefix option:

meson setup --prefix /usr build

Usage

You can browse the Auth reference.

CLI

astal-auth --password my-password

Library

JavaScript

import Auth from "gi://AstalAuth"

Auth.Pam.authenticate("password", (_, task) => {
    try {
        AstalAuth.Pam.authenticate_finish(task)
        print("authentication sucessful")
    } catch (error) {
        print(error)
    }
})

Python

from gi.repository import AstalAuth as Auth

def callback(_, task) -> None:
    try:
        Auth.Pam.authenticate_finish(task)
        print("success")
    except Exception as e:
        print(e)

Auth.Pam.authenticate("password", callback)

Lua

local Auth = require("lgi").require("AstalAuth")

Auth.Pam.authenticate("password", function(_, task)
    local status, err = Auth.Pam.authenticate_finish(task)
    if err ~= nil then
        print(err)
    else
        print("success")
    end
end)

Vala

// Not yet documented