YubiGuard

KO | EN

gitlite — search

#javascript #golang #deep-learning #linux #macos #nodejs #java #cli #vue #pytorch #mcp #ios #openai #open-source

(★ 25)

Python script to prevent accidental triggering of YubiKeys on Linux.

YubiGuard Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# YubiGuard

Python script to protect against accidental triggering of YubiKeys on Linux.

Most recent version: 0.9.3

A predecessor called [YubiSwitch](https://github.com/gsstark/yubiswitch-for-linux) tried to solve the same problem, but came with major security flaws, was cumbersome to use and lacked several important features.

## Advantages over YubiSwitch:
1. **No root privilege required to run!**
2. **No unintended output release after reactivation, if you pressed your YubiKey while locked!**
3. Detects YubiKeys automatically, no need to hardcode ids manually.
4. Can handle multiple YubiKeys concurrently.
5. Timeout which locks off YubiKey after 5 seconds.
6. Automatically locking after YubiKey has been triggered.
7. Panel indicator showing the activation status of YubiKey(s).

## Installation & Setup
1. Download zip archive here: [ZIP](https://github.com/bfelder/YubiGuard/zipball/master[)
2. Extract files.
3. Install dependencies.
4. Run YubiGuard.py.
5. Bind system key combination to the same file, but with **"-t"** as command line parameter.
6. This key combinatin is used to unlock YubiKeys (See: Usage for further instructions.)

### Requirements:
- xinput (installed on most Linux distributions by default)
- gir1.2-gtk-3.0
- gir1.2-appindicator3
- pyzmq

```
sudo pip install pyzmq
```

## Usage:
- YubiGuard locks output from all inserted YubiKeys by default.
- The locked state is indicated in the panel by the default icon.
- Simply Triggering via key combination (e.g.: super + y) will unlock YubiKey. (_Here is a short explanation on how to create key bindings under Linux Mint: https://www.lifewire.com/how-to-change-the-linux-mint-cinnamon-keyboard-shortcuts-4064754_) |
Alternatively click the **PanelIcon**, then click **Unlock**.
- In the unlocked state the icon changes to green.
- After triggering your YubiKey or after timeout, YubiKey will again be locked with the icon reverting back to default.
- While no YubiKeys are inserted, the panel indicator will be darkened.

### Usage screen lock mode:
- start YubiGuard.py with **"-l"** as command line flag:
```
./YubiGuard.py -l
```
- removing a YubiKey will now immediately result in screen lock

## FAQ:
**_Q:_** The LED of my YubiKey is still active. Does this mean the script is not working?
**_A:_** No. LEDs will continue to blink, despite YubiKey output being blocked as intended.

**_Q:_** How does YubiGuard activate and deactivate YubiKeys?
**_A:_** YubiGuard uses the xinput command to identify and control the output of YubiKeys. Namely:
_xinput list_, _xinput --enable <id>_, _xinput --disable <id>_ and _xinput test <id>_.

## Tested on:
### Linux Distributions (all 64-bit):
_(Only checked working of xinput command and correct panel indicator display so far.)_
- Xubuntu 15.10 (Wily Werewolf)
- Xubuntu 16.04 (Xenial Xerus)
- Elementary OS 0.4
- Fedora 24
- Linux Mint 18 (Cinnamon)
- Manjaro Linux 15.09
- Ubuntu 16.04

### Not working on (all 64-bit):
_(Those distros are not working as xinput is not installed: "xinput: command not found".
One might get YubiGuard to run with additional work though.)_
- Debian 8.5 (Jessie)
- OpenSUSE 42.1
- Solus 1.2
- Mageia 5
- Fedora 26 ([likely due to switch from xinput to libinput](https://github.com/bfelder/YubiGuard/issues/11))

### Screen lock mode:
- Xubuntu 16.04 (Xenial Xerus)

### YubiKey models:
- YubiKey 4 Nano
- YubiKey NEO
- YubiKey II

## Credits:
- **Yubico company** generously provided additional YubiKey models for testing.
- **Stefaan Lippens'** asynchronous stdout pipe allowed for an non-blocking way to monitor YubiKey output:
stefaanlippens.net/python-asynchronous-subprocess-pipe-reading
- **mozfreddyb** provided the idea to add the unlock button in version 0.9.3 and also helped clean up parts of the code.

## Changelog:
### v 0.2:
- renamed to YubiLock, as this name better portrays the function
- instead of text notificaions, now descriptive icons are displayed
- in case of changing xinput ids (e.g. devices are switched) old ids will be automatically activated

### v 0.3
- beautified icons
- set working dir, to always allow relative import of icons
- now preventing overtriggering when hitting key combinations in short succession

### v 0.4
- added exit handler, which will reactivate YubiKeys after script has exited

### v 0.5
- code rectified
- introduced missing thread locking

### v 0.6 (major update)
- added a Panel Indicator (replacing notification of LOCK/UNLOCK)
- major rectification of code
- switched from thread based concurrency to process based for superb responsiveness
- added key event listener, replacing triggering via external script over zmq
- added settings.ini to grant user to customize time out and triggering key combination
- eliminated minor bugs which led to laggy or unreliable unlocking

### v 0.7
- switched back from KeyEventListener to ZmqListener, as the former interfered with YubiKey release (see issue)

### v 0.8
- changed name back to YubiGuard, as two other GitHub projects are already titled YubiLock
- updated icons
- minor rectifivation of code

### v 0.9
- YubiGuard.py itself is now used for triggering, when run with command line paramater: '-t'. (yg_trigger.sh removed)
- fixed minor bug preventing exit when no keys were inserted

### v 0.9.1
- introduced screen lock mode which will automatically lock your screen when removing a YubiKey (security feature)

### v 0.9.2
- reduced internal cycle time to more reasonable settings to minimize CPU load

### v 0.9.3
- minor code cleanup
- added unlock button to Menu (kudos to **mozfreddyb** for initial idea and co-development)

YubiGuard

YubiGuard Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

YubiGuard

YubiGuard Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README