yubikey-touch-detector(1)

📦
version 1.15.0 · 4 versions
, in arch rolling

✨ yubikey-touch-detector ✨

okay so bestie, welcome to yubikey-touch-detector(1) — the little General Commands Manual page that's about to become your whole personality 💅 this is the tool that tells you when your YubiKey is literally sitting there waiting for a touch, and honestly? iconic behaviour.

🌸 NAME 🌸

yubikey-touch-detector — detects when a YubiKey is waiting for a touch. that's it, that's the vibe 🫶

🦋 SYNOPSIS 🦋

yubikey-touch-detector [options...]

yes queen, just run it with whatever options you want ✨

🎀 OPTIONS 🎀

  • -notify — shows desktop notifications. like, on your actual screen. so you can't miss it 💖
  • -notify-title title — sets the desktop notification title template. defaults to "YubiKey is waiting for a touch".
  • -notify-body body — sets the desktop notification body template. defaults to "Touch your YubiKey to continue ({{.Reasons}})."
⚠️ heads up bestie, both the notification title and body use Go template syntax. {{.Reasons}} expands into a sorted, comma-separated list of the active event types: gpg, hmac, and u2f. so cute, so organised 🧚
  • -no-socket — disables the unix socket notifier. no socket for you 🙈
  • -stdout — prints notifications to stdout. for the terminal girlies 💻
  • -dbus — supports notifications via dbus SessionBus.
  • -v — enables debug logging. messy but make it diagnostic 🔥
  • -version — prints version information and exits. bye bestie, love you 👑

💜 DESCRIPTION 💜

yubikey-touch-detector detects when a YubiKey is waiting for a touch configuration. it's designed to be integrated with other UI components so they can display a visible indicator. so basically it's the backstage main character that makes everyone else look good ✨

🌈 ENVIRONMENT 🌈

  • YUBIKEY_TOUCH_DETECTOR_VERBOSE — equivalent to specifying -v.
  • YUBIKEY_TOUCH_DETECTOR_NOTIFY — equivalent to specifying -notify.
  • YUBIKEY_TOUCH_DETECTOR_NOTIFY_TITLE — equivalent to specifying -notify-title.
  • YUBIKEY_TOUCH_DETECTOR_NOTIFY_BODY — equivalent to specifying -notify-body.
  • YUBIKEY_TOUCH_DETECTOR_STDOUT — equivalent to specifying -stdout.
  • YUBIKEY_TOUCH_DETECTOR_NOSOCKET — equivalent to specifying -no-socket.
  • YUBIKEY_TOUCH_DETECTOR_DBUS — equivalent to specifying -dbus.

like, every option gets a little environment-variable twin. siblings! 🫶

🍓 FILES 🍓

  • $XDG_RUNTIME_DIR/yubikey-touch-detector.socket — the socket exposing events on Linux 🐧
  • $TMPDIR/yubikey-touch-detector.socket — the socket exposing events on macOS 🍎

different paths, same energy 💅

⭐ EVENTS ⭐

these are the events emitted over the socket, no cap:

  • GPG_1 — when a GPG operation starts waiting for a touch.
  • GPG_0 — when a GPG operation stops waiting for a touch.
  • U2F_1 — when a U2F operation starts waiting for a touch.
  • U2F_0 — when a U2F operation stops waiting for a touch.
  • MAC_1 — when a HMAC operation starts waiting for a touch.
  • MAC_0 — when a HMAC operation stops waiting for a touch.

see the pattern? _1 means it started, _0 means it stopped. slay, consistent ✨

👑 SEE ALSO 👑

ykman, pam_u2f(8) — go read those too, iykyk 📚

💀 LICENCE 💀

yubikey-touch-detector is distributed under the ISC licence. periodt.

okay that's the whole page, bestie 💖 this was yubikey-touch-detector(1) from the General Commands Manual, dated 2026-09-21 — go touch your YubiKey, it's literally waiting for you 🎀🦋✨

📦 where this page comes from