danvics/howdy
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Small fixes and the start of a man page

Browse source
This commit is contained in:
boltgolt 2018-04-09 19:58:37 +02:00
parent 13d5f8ae1a
commit 52e6be7be8
3 changed files with 57 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -1,4 +1,4 @@
# Howdy for Ubuntu ![Build Status](https://travis-ci.org/Boltgolt/howdy.svg?branch=master) # Howdy for Ubuntu [![Build Status](https://travis-ci.org/Boltgolt/howdy.svg?branch=dev)](https://travis-ci.org/Boltgolt/howdy)
Windows Hello™ style authentication for Ubuntu. Use your built-in IR emitters and camera in combination with face recognition to prove who you are. Windows Hello™ style authentication for Ubuntu. Use your built-in IR emitters and camera in combination with face recognition to prove who you are.
@ -14,7 +14,7 @@ sudo apt update
sudo apt install howdy sudo apt install howdy
``` ```
This will guide you through the installation. When that's done run `sudo howdy USER add` and replace `USER` with your username to add a face model. This will guide you through the installation. When that's done run `sudo howdy add $USER` and replace `$USER` with your username 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 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.
@ -41,10 +41,6 @@ Any python errors get logged directly into the console and should indicate what
If you encounter an error that hasn't been reported yet, don't be afraid to open a new issue. If you encounter an error that hasn't been reported yet, don't be afraid to open a new issue.
### Uninstalling
There is an uninstaller available, run `sudo python3 /lib/security/howdy/uninstall.py` to remove Howdy from your system.
### A note on security ### 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. 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.

2
debian/control vendored
View file

@ -10,6 +10,6 @@ Package: howdy
Homepage: https://github.com/Boltgolt/howdy Homepage: https://github.com/Boltgolt/howdy
Architecture: all Architecture: all
Depends: git, python3, python3-pip, python3-dev, python3-setuptools, build-essential, libpam-python, fswebcam, libopencv-dev, python-opencv, cmake Depends: git, python3, python3-pip, python3-dev, python3-setuptools, build-essential, libpam-python, fswebcam, libopencv-dev, python-opencv, cmake
Description: Windows Hello style authentication for Ubuntu Description: Windows Hello style authentication for Ubuntu.
Use your built-in IR emitters and camera in combination with face recognition Use your built-in IR emitters and camera in combination with face recognition
to prove who you are. to prove who you are.

54
debian/howdy.1 vendored Normal file
View file

@ -0,0 +1,54 @@
.\" Please adjust this date whenever revising the manpage.
.TH HOWDY SECTION "April 9, 2018"
.\" Some roff macros, for reference:
.\" .nh disable hyphenation
.\" .hy enable hyphenation
.\" .ad l left justify
.\" .ad b justify to both left and right margins
.\" .nf disable filling
.\" .fi enable filling
.\" .br insert line break
.\" .sp <n> insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
howdy \- Windows Hello style authentication for Ubuntu
.SH SYNOPSIS
.B howdy
.RI [ options ] " files" ...
.br
.B bar
.RI [ options ] " files" ...
.SH DESCRIPTION
This manual page documents briefly the
.B nwsmtp
and
.B bar
commands.
.PP
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
.\" respectively.
\fBnwsmtp\fP is a program that...
.SH OPTIONS
These programs follow the usual GNU command line syntax, with long
options starting with two dashes (`-').
A summary of options is included below.
For a complete description, see the Info files.
.TP
.B \-h, \-\-help
Show summary of options.
.TP
.B \-v, \-\-version
Show version of program.
.SH SEE ALSO
.BR bar (1),
.BR baz (1).
.br
The programs are documented fully by
.IR "The Rise and Fall of a Fooish Bar" ,
available via the Info system.
.SH AUTHOR
nwsmtp was written by <upstream author>.
.PP
This manual page was written by Alexei Moisseev <alexmois@ya.ru>,
for the Debian project (and may be used by others).