# README
Yubikey Basic Auth HTTP(S) Proxy.
Reverse HTTP(S) Proxy that adds a layer of Basic Auth that does Yubikey authentication. To allow proxying through the application, a user must validate correctly using a username+password+valid Yubikey OTP.
------------ ---------------------------- ------------
| | (HTTP/TLS) | | (HTTP/TLS) | |
| Internet | <---> | yubikey-basic-auth-proxy | <---> | Upstream |
| | | (authentication) | (authenticated) | |
------------ ---------------------------- ------------
Features
- Support for non-encrypted HTTP as well as TLS.
- Simple command line interface to configure the ACL, which is stored on disk in a single JSON file.
- Strong password hashing using scrypt.
Usage
$ ./yubikey-basic-auth-proxy --help
usage: yubikey-basic-auth-proxy [<flags>] <command> [<args> ...]
HTTP Proxy that adds a layer of Basic Auth that does Yubikey authentication.
Flags:
--help Show context-sensitive help (also try --help-long and --help-man).
--version Show application version.
--credentials-file="credentials.json"
The file that stores the credentials.
--log-level=INFO Set log level.
Commands:
help [<command>...]
Show help.
serve [<flags>] <upstream> <yubico-api-id> <yubico-api-key>
Run the proxy.
credentials add <username> <yubikey> [<password>]
Add a credentials.
credentials list
List the credentials.
credentials remove <username> [<yubikey>]
Delete a credentials.
Execute ./yubikey-basic-auth-proxy COMMAND --help
for command specific flags.
Current limitations
# Functions
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Constants
No description provided by the author
No description provided by the author
# Variables
The recommended parameters for interactive logins as of 2009.
# Structs
No description provided by the author
No description provided by the author
No description provided by the author
Access-expired cache that holds values for a certain expiration since write.
No description provided by the author
No description provided by the author
No description provided by the author
Outputs log records in JSON format.
No description provided by the author
Filters logging based log level.
No description provided by the author
Wraps payload in a LogRecord and delegates logging to a LogWriter.
Helper to add syntactic sugar to logging.
No description provided by the author
No description provided by the author
TODO: Rename to ScryptParams.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Interfaces
No description provided by the author
No description provided by the author
No description provided by the author
# Type aliases
No description provided by the author
No description provided by the author