-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
minor: Update README for slot parameter
- Loading branch information
Showing
3 changed files
with
9 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
version: 2 | ||
version: 2.1 | ||
jobs: | ||
create_builder: | ||
machine: true | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,7 @@ | ||
.idea/ | ||
.vscode/ | ||
|
||
vendor/ | ||
docker-hub-login.sh | ||
|
||
/yubi-oath-vpn | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,13 +4,15 @@ Simply insert your Yubikey to an USB-slot and connect to your 2FA-VPN. | |
|
||
## Usage | ||
Windows (experimental, see below) | ||
`yubi-oath-vpn /connection=<OpenVPN configuration name>` | ||
`yubi-oath-vpn /connection=<OpenVPN configuration name> [/[email protected]]` | ||
|
||
Linux | ||
`yubi-oath-vpn --connection=<connection name>` | ||
`yubi-oath-vpn --connection=<connection name> [[email protected]]` | ||
|
||
Will start the program and connect as soon as the Yubikey is inserted (and not already connected) | ||
|
||
If the `slot` argument is omitted, the first slot is used. | ||
|
||
### Autostart Startmenu entry (Windows) | ||
|
||
* Extract all files to a single directory in you User directory | ||
|
@@ -55,8 +57,9 @@ Example: | |
|
||
## Background | ||
We use Yubikeys for two factor authentication against our VPN. | ||
We have a Bash script with similar functionality, but the tools (ykman, yubioath) keep changing and dbus-monitor was behaving differently depending on distro. | ||
We have a Bash script with similar functionality, but the tools (ykman, yubioath) keep changing and dbus-monitor was behaving differently depending on Linux distribution. | ||
|
||
## Disclaimer | ||
Only tested against one Yubikey 4 and one Yubikey 5 version. | ||
It's my first go project. Expect bugs and low code quality. | ||
That being said it's in active use for several years on different systems and seems to work just fine. |