mirror of
https://github.com/boltgolt/howdy.git
synced 2024-09-19 09:51:19 +02:00
74 lines
4 KiB
Markdown
74 lines
4 KiB
Markdown
# Howdy for Linux [![](https://img.shields.io/travis/boltgolt/howdy/master.svg)](https://travis-ci.org/boltgolt/howdy) [![](https://img.shields.io/github/release/boltgolt/howdy.svg?colorB=4c1)](https://github.com/boltgolt/howdy/releases) ![](https://boltgolt.nl/howdy_badge/installs.php?nc) ![](https://boltgolt.nl/howdy_badge/views.php)
|
||
|
||
Windows Hello™ style authentication for Linux. Use your built-in IR emitters and camera in combination with face recognition to prove who you are.
|
||
|
||
Using the central authentication system (PAM), this works everywhere you would otherwise need your password: Login, lock screen, sudo, su, etc.
|
||
|
||
## Installation
|
||
|
||
Howdy is currently available for Ubuntu/Debian and Arch Linux. If you’re interested in packaging Howdy for your distro, don’t hesitate to open an issue.
|
||
|
||
**Note:** The build of dlib can hang on 100% for over a minute, give it time.
|
||
|
||
### Ubuntu (apt)
|
||
|
||
Run the installer by pasting (`ctrl+shift+V`) the following commands into the terminal one at a time:
|
||
|
||
```
|
||
sudo add-apt-repository ppa:boltgolt/howdy
|
||
sudo apt update
|
||
sudo apt install howdy
|
||
```
|
||
|
||
This will guide you through the installation.
|
||
|
||
### Arch Linux
|
||
|
||
Install the `howdy` package from the AUR. For AUR installation instructions, take a look at this [wiki page](https://wiki.archlinux.org/index.php/Arch_User_Repository#Installing_packages).
|
||
|
||
You will need to do some additional configuration steps. Please read the [ArchWiki entry](https://wiki.archlinux.org/index.php/Howdy) for more information.
|
||
|
||
## Setup
|
||
|
||
After installation, you need to let Howdy learn your face. Run `sudo howdy add` to add a face model.
|
||
|
||
If nothing went wrong we should be able to run sudo by just showing your face. Open a new terminal and run `sudo -i` to see it in action.
|
||
|
||
If you're curious you can run `sudo howdy config` to open the central config file and see the options Howdy has. On most systems this will open the nano editor, where you have to press `ctrl`+`x` to save your changes.
|
||
|
||
## CLI
|
||
|
||
The installer adds a `howdy` command to manage face models for the current user. Use `howdy --help` or `man howdy` to list the available options.
|
||
|
||
Usage:
|
||
```
|
||
howdy [-U user] [-y] command [argument]
|
||
```
|
||
|
||
| Command | Description |
|
||
|-----------|-----------------------------------------------|
|
||
| `add` | Add a new face model for an user |
|
||
| `clear` | Remove all face models for an user |
|
||
| `config` | Open the config file in gedit |
|
||
| `disable` | Disable or enable howdy |
|
||
| `list` | List all saved face models for an user |
|
||
| `remove` | Remove a specific model for an user |
|
||
| `test` | Test the camera and recognition methods |
|
||
|
||
## Contributing [![](https://img.shields.io/travis/boltgolt/howdy/dev.svg?label=dev%20build)](https://github.com/boltgolt/howdy/tree/dev) [![](https://img.shields.io/github/issues-raw/boltgolt/howdy/enhancement.svg?label=feature+requests&colorB=4c1)](https://github.com/boltgolt/howdy/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement)
|
||
|
||
You can contribute in many ways. The easiest are reporting bugs and opening github issues for features you'd like to see in howdy. Code contributions are also very welcome.
|
||
|
||
## Troubleshooting
|
||
|
||
Any python errors get logged directly into the console and should indicate what went wrong. If authentication still fails but no errors are printed you could take a look at the last lines in `/var/log/auth.log` to see if anything has been reported there.
|
||
|
||
If you encounter an error that hasn't been reported yet, don't be afraid to open a new issue.
|
||
|
||
## A note on security
|
||
|
||
This script is in no way as secure as a password and will never be. Although it's harder to fool than normal face recognition, a person who looks similar to you or well-printed photo of you could be enough to do it.
|
||
|
||
To minimize the chance of this program being compromised, it's recommend to leave Howdy in `/lib/security` and to keep it read only.
|
||
|
||
DO NOT USE HOWDY AS THE SOLE AUTHENTICATION METHOD FOR YOUR SYSTEM.
|