device

    $device = $key->device($device);

Get or set the device number, which is the index number starting and incrementing from zero assigned to the YubiKey device. If there is only one detected YubiKey device, its number is 0.

Defaults to 0.

slot

    $slot = $key->slot($slot);

Get or set the slot number, which is a number starting and incrementing from one. A YubiKey can have multiple slots (often just two) which can be independently configured.

Defaults to 1.

timeout

    $timeout = $key->timeout($timeout);

Get or set the timeout, in seconds. If the challenge takes longer than this, the challenge will be cancelled and an error is thrown.

If the timeout is zero, the challenge is non-blocking; an error is thrown if the challenge would block. If the timeout is negative, timeout is disabled and the challenge will block forever or until a response is received.

Defaults to 0.

pre_challenge

    $callback = $key->pre_challenge($callback);

Get or set a callback function that will be called immediately before any challenge is issued. This might be used to prompt the user so they are aware that they are expected to interact with their YubiKey.

    $key->pre_challenge(sub {
        my ($key, $challenge) = @_;
        if ($key->requires_interaction) {
            say 'Please touch your key device to proceed with decrypting your KDBX file.';
        }
        say 'Key: ', $key->name;
        if (0 < $key->timeout) {
            say 'Key access request expires: ' . localtime(time + $key->timeout);
        }
    });

You can throw from this subroutine to abort the challenge. If the challenge is part of loading or dumping a KDBX database, the entire load/dump will be aborted.

post_challenge

    $callback = $key->post_challenge($callback);

Get or set a callback function that will be called immediately after a challenge response has been received.

You can throw from this subroutine to abort the challenge. If the challenge is part of loading or dumping a KDBX database, the entire load/dump will be aborted.

ykchalresp

    $program = $key->ykchalresp;

Get or set the ykchalresp(1) program name or filepath. Defaults to $ENV{YKCHALRESP} or "ykchalresp".

ykinfo

    $program = $key->ykinfo;

Get or set the ykinfo(1) program name or filepath. Defaults to $ENV{YKINFO} or "ykinfo".

scan

    @keys = File::KDBX::Key::YubiKey->scan(%options);

Find connected, configured YubiKeys that are capable of responding to a challenge. This can take several seconds.

Options:

•

"limit" - Scan for only up to this many YubiKeys (default: 4)

Other options are passed as-is as attributes to the key constructors of found keys (if any).

serial

Get the device serial number, as a number, or "undef" if there is no such device.

version

Get the device firmware version (or "undef").

touch_level

Get the "touch level" value for the device associated with this key (or "undef").

vendor_id

product_id

Get the vendor ID or product ID for the device associated with this key (or "undef").

name

    $name = $key->name;

Get a human-readable string identifying the YubiKey (or "undef").

requires_interaction

Get whether or not the key requires interaction (e.g. a touch) to provide a challenge response (or "undef").