yubikey-touch-detector(1)

Usage

yubikey-touch-detector [options ...]

Options

-notify: Show desktop notifications.

-notify-title title: Set the desktop notification title template. Defaults to "YubiKey is waiting for a touch".

-notify-body body: Set the desktop notification body template. Defaults to "Touch your YubiKey to continue ({{.Reasons}})."

The notification title and body use Go template syntax. {{.Reasons}} expands to a sorted, comma-separated list of active event types: gpg, hmac, and u2f.

-no-socket: Disable unix socket notifier.

-stdout: Print notifications to stdout.

-dbus: Support notifications via dbus SessionBus.

-v: Enable debug logging.

-version: Print version information and exit.

Overview

yubikey-touch-detector detects when a YubiKey is waiting for a touch configuration. It is designed to be integrated with other UI components to display a visible indicator.

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.

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.

Events

The following events are emitted over the socket:

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.

Licence

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