137 lines
5.9 KiB
Markdown
137 lines
5.9 KiB
Markdown
# Authelia
|
|
|
|
[][MIT License]
|
|
[](https://travis-ci.org/clems4ever/authelia)
|
|
|
|
**Authelia** is a complete HTTP 2-factor authentication server for proxies like
|
|
nginx. It has been made to work with NGINX auth_request module and is currently
|
|
used in production to secure internal services in a small docker swarm cluster.
|
|
|
|
## Features
|
|
* Two-factor authentication using either
|
|
**[TOTP] - Time-Base One Time password -** or **[U2F] - Universal 2-Factor -**
|
|
as 2nd factor.
|
|
* Password reset with identity verification by sending links to user email
|
|
address.
|
|
* Access restriction after too many authentication attempts.
|
|
|
|
## Deployment
|
|
|
|
### With NPM
|
|
|
|
npm install -g authelia
|
|
|
|
### Docker
|
|
|
|
docker pull clems4ever/authelia
|
|
|
|
## Getting started
|
|
|
|
The provided example is docker-based so that you can deploy and test it very
|
|
quickly. First clone the repo make sure you don't have anything listening on
|
|
port 8080 before starting.
|
|
Then, type the following command to build and deploy the services:
|
|
|
|
docker-compose build
|
|
docker-compose up -d
|
|
|
|
After few seconds the services should be running and you should be able to visit
|
|
[https://localhost:8080/](https://localhost:8080/).
|
|
|
|
Normally, a self-signed certificate exception should appear, it has to be
|
|
accepted before getting to the login page:
|
|
|
|
|
|
|
|
### 1st factor: LDAP
|
|
An LDAP server has been deployed for you with the following credentials: **user/password**.
|
|
|
|
Type them in the login page and validate. Then, the second factor page should
|
|
have appeared as shown below.
|
|
|
|
|
|
|
|
|
|
### 2nd factor: TOTP (Time-Base One Time Password)
|
|
In **Authelia**, you need to register a per user TOTP secret before
|
|
authenticating. To do that, you need to click on the register button. It will
|
|
send a link to the user email address. Since this is an example, no email will
|
|
be sent, the link is rather delivered in the file
|
|
./notifications/notification.txt. Paste the link in your browser and you'll get
|
|
your secret in QRCode and Base32 formats. You can use
|
|
[Google Authenticator](https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2&hl=en)
|
|
to store them and get the generated tokens required during authentication.
|
|
|
|
|
|
|
|
### 2nd factor: U2F (Universal 2-Factor) with security keys
|
|
**Authelia** also offers authentication using U2F devices like [Yubikey](Yubikey)
|
|
USB security keys. U2F is one of the most secure authentication protocol and is
|
|
already available for accounts on Google, Facebook, Github and more.
|
|
|
|
Like TOTP, U2F requires you register your security key before authenticating
|
|
with it. To do so, click on the register button. This will send a link to the
|
|
user email address. Since this is an example, no email will be sent, the
|
|
link is rather delivered in the file ./notifications/notification.txt. Paste
|
|
the link in your browser and you'll be asking to touch the token of your device
|
|
to register it. You can now authenticate using your U2F device by simply
|
|
touching the token.
|
|
|
|
|
|
|
|
### Password reset
|
|
With **Authelia**, you can also reset your password in no time. Click on the
|
|
according button in the login page, provide the username of the user requiring
|
|
a password reset and **Authelia** will send an email with an link to the user
|
|
email address. For the sake of the example, the email is delivered in the file
|
|
./notifications/notification.txt.
|
|
Paste the link in your browser and you should be able to reset the password.
|
|
|
|
## Documentation
|
|
### Configuration
|
|
The configuration of the server is defined in the file
|
|
**configuration.template.yml**. All the details are documented there.
|
|
You can specify another configuration file by giving it as first argument of
|
|
**Authelia**.
|
|
|
|
authelia config.custom.yml
|
|
|
|
### API documentation
|
|
There is a complete API documentation generated with
|
|
[apiDoc](http://apidocjs.com/) and embedded in the repo under the **doc/**
|
|
directory. Simply open index.html locally to watch it.
|
|
|
|
## Contributing to Authelia
|
|
Follow [contributing](CONTRIBUTORS.md) file.
|
|
|
|
## License
|
|
**Authelia** is **licensed** under the **[MIT License]**. The terms of the license are as follows:
|
|
|
|
The MIT License (MIT)
|
|
|
|
Copyright (c) 2016 - Clement Michaud
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
in the Software without restriction, including without limitation the rights
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
copies of the Software, and to permit persons to whom the Software is
|
|
furnished to do so, subject to the following conditions:
|
|
|
|
The above copyright notice and this permission notice shall be included in
|
|
all copies or substantial portions of the Software.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
|
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
|
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
|
|
|
|
[MIT License]: https://opensource.org/licenses/MIT
|
|
[TOTP]: https://en.wikipedia.org/wiki/Time-based_One-time_Password_Algorithm
|
|
[U2F]: https://www.yubico.com/about/background/fido/
|
|
[Yubikey]: https://www.yubico.com/products/yubikey-hardware/yubikey4/
|
|
|