LinuxCommandLibrary

ykinfo

Show YubiKey device information

TLDR

Display all information from YubiKey

$ ykinfo -a
copy

Get only serial in decimal from YubiKey
$ ykinfo -s -q
copy

Get capabilities from YubiKey
$ ykinfo -c
copy

SYNOPSIS

ykinfo [options]

PARAMETERS

-h, --help
    Display help message and exit.

-v, --version
    Show version information and exit.

-s, --serial
    Read and display YubiKey serial number (if available).

-V, --verbose
    Increase verbosity level.

-q, --quiet
    Suppress output messages.

-d, --device
    Specify the device path.

-m, --mode
    Read and display YubiKey operating mode.

-l, --list
    List available readers.

--otp
    Read and display the YubiKey's OTP configuration.

DESCRIPTION

The ykinfo command is a command-line tool used to retrieve information from and configure YubiKey devices. It allows users to query the device's version, serial number, supported capabilities, and other relevant metadata. It's particularly useful for scripting and automation, enabling system administrators to easily manage and monitor YubiKeys deployed across an organization. Furthermore, it is used to read all available data from a YubiKey including OTP, version, mode, etc. It supports several options to enable specific output formats and to query/program specific features of the YubiKey. Using this tool requires an understanding of YubiKey configuration and usage, as some commands can potentially alter the device's behavior. This tool is crucial in environments where YubiKeys are used for authentication, access control, or secure storage.

CAVEATS

Some options require specific permissions or device drivers to be installed.
Alway test setting on a non-production environment first.

EXIT STATUS

ykinfo exits with status 0 if the operation was successful and 1 if not.

SEE ALSO

ykpersonalize(1)

Copied to clipboard