blob: a699404cb8054ad6cc863f8313f9159606018dc3 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
|
# Auth
Library and CLI tool for authentication using [pam](https://github.com/linux-pam/linux-pam).
## Installation
1. install dependencies
:::code-group
```sh [<i class="devicon-archlinux-plain"></i> Arch]
sudo pacman -Syu meson pam gobject-introspection
```
```sh [<i class="devicon-fedora-plain"></i> Fedora]
sudo dnf install meson pam-devel gobject-introspection-devel
```
```sh [<i class="devicon-ubuntu-plain"></i> Ubuntu]
# Not yet documented
```
:::
::: warning On NixOS you have to add `astal-auth` to `security.pam`.
::: code-group
```nix [configuration.nix]
{
security.pam.services.astal-auth = {}
}
```
:::
2. clone repo
```sh
git clone https://github.com/aylur/astal.git
cd astal/lib/auth
```
3. install
```sh
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:
```sh
meson setup --prefix /usr build
```
:::
## Usage
You can browse the [Auth reference](https://aylur.github.io/libastal/auth).
### CLI
```sh
astal-auth --password my-password
```
### Library
:::code-group
```js [<i class="devicon-javascript-plain"></i> JavaScript]
import Auth from "gi://AstalAuth";
import Gio from "gi://Gio";
Gio._promisify(Auth.Pam, "authenticate");
await Auth.Pam.authenticate("password")
.then(_ => print("authentication sucessful"))
.catch(logError);
```
```py [<i class="devicon-python-plain"></i> Python]
# Not yet documented
```
```lua [<i class="devicon-lua-plain"></i> Lua]
-- Not yet documented
```
```vala [<i class="devicon-vala-plain"></i> Vala]
// Not yet documented
```
:::
|
