yubikey-locker

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 21 Open GitHub ↗

Sciber Yubikey Locker

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Sciber YubiKey Locker
[![main - tests and build](https://github.com/sciber-io/yubikey-locker/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/sciber-io/yubikey-locker/actions/workflows/ci.yml)

For YubiKey users to enable automatic device locking when removing the YubiKey.

### Possible action to take when a YubiKey is not found
| Action        | Windows   | Mac  | Linux (Ubuntu)  |
| ---           | ---       | ---  | ---    |
| Nothing       | ✅       | ✅   | ✅    |
| Lock Computer | ✅       | ✅   | ✅    |
| Log Out User  | ✅       | ✅   | ✅    |

### Available installation instructions
| Method        | Windows   | Mac   | Linux (Ubuntu) |
| ---           | ---       | ---  | ---    |
| Intune        | ✅       | ✅   | ❌
| Manual        | ✅       | ✅   | ✅    |

### How to inspect application logs:
Windows: ```Get-EventLog -LogName Application -Source YubiKeyLocker | Select TimeGenerated,ReplacementStrings ```
Mac:   ```log show --predicate 'process = "yubikey-locker-macos"' ```
Linux (Ubuntu):  ```cat /var/log/syslog | grep yubikey-locker ```

## Installation via Intune
### Windows
1. Download the .admx and .adml files from [src/windows_utils/Administrative template (ADMX)/](src/windows_utils/Administrative%20template%20(ADMX)/)
2. Intune/GPO: Follow Jonas guide on his blog: https://swjm.blog/locking-the-workstation-on-fido2-security-key-removal-part-2-80962c944c78 to set up GPO/Intune control to decide what you want to do if the YubiKey is removed.
### Mac
1. Add an macOS app, upload yubikey-locker-macos.pkg
2. Add the contents of [src/macos_utils/post_install_script.sh](src/macos_utils/post_install_script.sh) to the post-install-script box in Intune
3. Depending on the groups that the app is pushed to, change contents of the post-install-script to pass apropriate arguments to the application

## Manual Installation
### Windows
1. Download and execute yubikey-locker.msi from [releases](https://github.com/sciber-io/yubikey-locker/releases)
#### Set registry values

1. Download the .admx and .adml files from [src/windows_utils/Administrative template (ADMX)/](src/windows_utils/Administrative%20template%20(ADMX)/) to `C:\Windows\PolicyDefinitions`
2. Start "local group policy editor" from Control Panel -> "Edit group policy" and navigate to:
  - "Computer Configuration"
    - "Administrative Templates"
      - "Sciber YubiKey Locker Settings"
        - Turn on to set registry values

### Mac
1. Download and execute yubikey-locker-macos.pkg from [releases](https://github.com/sciber-io/yubikey-locker/releases)
2. Download, modify script content if necessary, and execute [src/macos_utils/post_install_script.sh](src/macos_utils/post_install_script.sh)
3. Perform a logout or a reboot

### Linux (Ubuntu)
1. Download yubikey-locker-linux from [releases](https://github.com/sciber-io/yubikey-locker/releases) into  `/home/<your-user>/.sciber/yubikey-locker-linux `
2. Download [src/linux_utils/yubikey-locker.service](src/linux_utils/yubikey-locker.service) to `/etc/systemd/user/yubikey-locker.service`
3. Modify the service file to specify the correct path to the binary
4. Enable the service to start on reboot:  ```systemctl enable yubikey-locker --user ```
5. Start the service:  ```systemctl start yubikey-locker --user ```

## Default behavior
yubikey-locker will check if there is a YubiKey present every 10 seconds. If no command-line arguments / registry values instruments the application to lock the computer it will do nothing.

### Comand line options for Linux/MacOS
```bash
# Run yubikey-locker
# Defaults to doNothing with the device after 10 seconds without a YubiKey
yubikey-locker

# Optional arguments:
# Set removalOption
-l Lock|Logout|doNothing

# Set timeout
-t 20

# Example
yubikey-locker -l Logout -t 30
```

### Credits
Special thanks to [Jonas Markström](https://github.com/JMarkstrom/) for valuable feedback and support during this project.

## Known Issues
[MacOS: The check for the Yubikey may cause issues with gpg](https://github.com/sciber-io/yubikey-locker/issues/78)
____
For information regarding how to continue development and build your own binaries see [README-development.md](README_development.md)

yubikey-locker

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

yubikey-locker

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README