A simple Nginx OTP module for use with auth_request
10K+
A simple Nginx OTP module for use with auth_request
Report Bugs · Request Features
| Environment | Default value | Description |
|---|---|---|
| SNO_LISTEN_IP | 0.0.0.0 | IP which SNO will listen at |
| SNO_LISTEN_PORT | 7079 | Port which SNO will listen at |
| SNO_SECRET | OTP secret key. Enables TOTP functionality if not empty. If both this and SNO_YUBIOTP are empty, application will reply a random one for use and exit | |
| SNO_YUBIOTP | One example of your YubiOTP. Enables YubiOTP functionality if not empty. Only the first 12 characters are used | |
| SNO_TITLE | Simple Nginx OTP | Page title on OTP entry page |
| SNO_COOKIE_NAME | sno_session | Session cookie name |
| SNO_COOKIE_LENGTH | 16 | Session cookie length (recommended >=16) |
| SNO_COOKIE_LIFETIME | 14 | Session cookie lifetime in days |
| SNO_COOKIE_DOMAIN | Session cookie domain. If empty, default to current domain | |
| SNO_RATE_LIMIT_COUNT | 3 | How many failures till rate limit kicks in |
| SNO_RATE_LIMIT_LIFETIME | 1 | Rate limit lifetime in minutes |
To get a local copy up and running follow these simple steps.
Make sure to only allow nginx to access the application!
Please change/
SNO_SECRETandSNO_YUBIOTPaccordingly as they are examples, run without both to generate a randomSNO_SECRETfor use.
docker run -d \
--name simple-nginx-otp \
-e SNO_LISTEN_IP=0.0.0.0 \
-e SNO_LISTEN_PORT=7079 \
-e SNO_SECRET=JBSWY3DPEHPK3PXP \
-e SNO_YUBIOTP=vvvvvvcurikvhjcvnlnbecbkubjvuittbifhndhn \
-e SNO_TITLE="Simple Nginx OTP" \
-e SNO_COOKIE_NAME=sno_session \
-e SNO_COOKIE_LENGTH=16 \
-e SNO_COOKIE_LIFETIME=14 \
-e SNO_COOKIE_DOMAIN="" \
-e SNO_RATE_LIMIT_COUNT=3 \
-e SNO_RATE_LIMIT_LIFETIME=1 \
-p 7079:7079 \
--restart unless-stopped \
jarylc/simple-nginx-otp
Please change/remove
SNO_SECRETandSNO_YUBIOTPaccordingly as they are examples, run without both to generate a randomSNO_SECRETfor use.
simple-nginx-otp:
image: jarylc/simple-nginx-otp
user: nobody
ports:
- "7079:7079"
environment:
- UID=0
- GID=0
- SNO_LISTEN_IP=0.0.0.0
- SNO_LISTEN_PORT=7079
- SNO_SECRET=JBSWY3DPEHPK3PXP
- SNO_YUBIOTP=vvvvvvcurikvhjcvnlnbecbkubjvuittbifhndhn
- SNO_TITLE="Simple Nginx OTP"
- SNO_COOKIE_NAME=sno_session
- SNO_COOKIE_LENGTH=16
- SNO_COOKIE_LIFETIME=14
- SNO_COOKIE_DOMAIN=""
- SNO_RATE_LIMIT_COUNT=3
- SNO_RATE_LIMIT_LIFETIME=1
restart: unless-stopped
Inside the server block:
error_page 401 = @error401;
location @error401 {
return 302 /sno;
}
location /sno {
error_page 401 /;
proxy_pass http://127.0.0.1:7079;
proxy_pass_request_body off;
proxy_set_header Content-Length "";
proxy_set_header X-Original-URI $scheme://$http_host$request_uri;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
}
location / {
auth_request /sno;
proxy_pass http://endpoint;
}
cd /path/to/project/folder
go build -ldflags="-w -s"
cd /path/to/project/folder
docker build .
See the open issues for a list of proposed features (and known issues).
Feel free to fork the repository and submit pull requests.
Distributed under the MIT License. See LICENSE for more information.
Jaryl Chng - [email protected]
Project Link: https://gitlab.com/jarylc/simple-nginx-otp/
Content type
Image
Digest
sha256:505f1534b…
Size
2.3 MB
Last updated
over 3 years ago
docker pull jarylc/simple-nginx-otp