Skip to content

Commit

Permalink
minor: Update README for slot parameter
Browse files Browse the repository at this point in the history
  • Loading branch information
MeneDev committed May 14, 2021
1 parent b04ae5e commit 7883eb5
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 5 deletions.
2 changes: 1 addition & 1 deletion .circleci/config.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
version: 2
version: 2.1
jobs:
create_builder:
machine: true
Expand Down
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
.idea/
.vscode/

vendor/
docker-hub-login.sh

/yubi-oath-vpn

Expand Down
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.

0 comments on commit 7883eb5

Please sign in to comment.