readme.md

YubiKey Removal Behavior

ℹ️ About

The YubiKey Removal Behavior application is inspired by the native Windows "Smart Card Removal Behavior" feature and extends a similar level of control to FIDO2 Security Keys (YubiKeys) by locking a compatible Windows workstation OR logging out the currently logged in user(s) when a YubiKey is removed. It does this by monitoring for YubiKey removal events and checking the value of the removalOption registry key:

• If the value is set to lock, the application will lock the workstation
• If the value is set to logout, the application will log out the user(s)

Control of the value is exercised using Group Policy, Registry or MDM.

⚠️ This application is provided "as-is" without any warranty of any kind, either expressed or implied.

Note: For cross-platform use, consider Sciber YubiKey Locker

💻 Prerequisites

The YubiKey Removal Behavior application is supported on 64 bit Windows 10 and Windows 11.

💾 Installation

Run the provided MSI (no interaction is required) and reboot the computer for changes to take effect.

Here is an example of a running the installer from command line:

msiexec /i /qn "YubiKey-Removal-Behavior.msi"

👮🏻 Administrative template (ADMX)

The accompanying administrative template (ADMX) adds the option to control YubiKey removal behavior by setting a central (or local) GPO. To use this template with Microsoft Active Directory (or a local computer):

1. Copy the .admx file to location: C:\Windows\PolicyDefinitions
2. Copy the .adml file to location: C:\Windows\PolicyDefinitions\en-US
3. Open the GPO editor (restart if open previously) and navigate to Computer Configuration > Policies > Administrative Templates > Yubico >
4. Double-click on 'YubiKey Removal Behavior' and adjust settings as required
5. Click Apply and OK.

Note: To use the ADMX with Intune, please refer to instructions on swjm.blog

📖 Usage

By default (no configuration required), the application will lock the workstation on YubiKey removal. This behavior can be modified to instead log out the user(s) OR disabling the functionality.

Note further with regards to U/X:

Removal from USB port

• By default, the application will lock the workstation if the YubiKey is removed from the USB port.
• If Log out user(s) is configured, any logged in user will be logged out from Windows.
• To log back in, the user reinserts the YubiKey into the USB port and provides PIN and Touch.

Removal using NFC reader

With NFC it is possible to achieve a "tap 'n go" type user experience:

⚠️ If you are using NFC you MUST set application behavior to Log out user(s) (registry value logout) else you will be logged out immediately on login(!)

• To log out, the user "taps" or places the YubiKey on the NFC reader.
• To log back in, the user will place the YubiKey on the NFC reader and provide PIN.

💾 Uninstalling the app

The application can be uninstalled from Add/Remove Programs, using GPO or MDM.

Here is an example of uninstalling from command line:

msiexec /qn /x "YubiKey-Removal-Behavior.msi"

📖 Roadmap

Possible improvements includes:

• Using variables and/or relative paths in the installer (paths, registry keys)
• Reducing overall footprint / size of of application
• Code signing

🥷🏻 Contributing

You can help by getting involved in the project, or by donating (any amount!).
Donations will support costs such as domain registration and code signing (planned).

📜 Release History

• 2025.01.06 v2.2
• 2023.08.30 v2.1
• 2023.08.26 v2.0
• 2022.12.27 v1.0