yubico_ng

Crates.io	yubico_ng
lib.rs	yubico_ng
version	0.15.0
created_at	2025-04-23 11:56:34.28314+00
updated_at	2026-01-18 17:41:14.610906+00
description	Yubikey client API library
homepage
repository	https://github.com/BlackDex/yubico-rs
max_upload_size
id	1645433
size	85,747

Mathijs van Veluw (BlackDex)

documentation

README

Yubico NG

Enables integration with the Yubico validation platform, so you can use Yubikey's one-time-password in your Rust application, allowing a user to authenticate via Yubikey.

Current features

Synchronous Yubikey client API library, validation protocol version 2.0.
Asynchronous Yubikey client API library relying on Tokio

Note: The USB-related features have been moved to a separated repository, yubico-manager

Usage

Add this to your Cargo.toml

[dependencies]
yubico_ng = "0.14"

Or, since this crate is still backwards compatible with the yubico crate.

[dependencies]
yubico = { version = "0.14", package = "yubico_ng" }

The following are a list of Cargo features that can be enabled or disabled:

online-tokio (enabled by default): Provides integration to Tokio using futures.
native-tls (enabled by default): Use native-tls provided by the OS.
rustls-tls: Use rustls instead of native-tls.

You can enable or disable them using the example below:

[dependencies.yubico_ng]
version = "0.13"
# don't include the default features (online-tokio, native-tls)
default-features = false
# cherry-pick individual features
features = []

Request your api key.

OTP with Default Servers

extern crate yubico_ng;

use yubico_ng::config::*;
use yubico_ng::verify;

fn main() {
   let config = Config::default()
       .set_client_id("CLIENT_ID")
       .set_key("API_KEY");

   match verify("OTP", config) {
      Ok(answer) => println!("{}", answer),
      Err(e) => println!("Error: {}", e),
   }
}

OTP with custom API servers

use yubico_ng::verify;
use yubico_ng::config::Config;

fn main() {
   let config = Config::default()
       .set_client_id("CLIENT_ID")
       .set_key("API_KEY")
       .set_api_hosts(vec!["https://api.example.com/verify".into()]);

   match verify("OTP", config) {
      Ok(answer) => println!("{}", answer),
      Err(e) => println!("Error: {}", e),
   }
}

Asynchronous OTP validation

#![recursion_limit="128"]
use futures::TryFutureExt;

use std::io::stdin;
use yubico_ng::config::Config;
use yubico_ng::verify_async;

#[tokio::main]
async fn main() -> Result<(), ()> {
    println!("Please plug in a yubikey and enter an OTP");

    let client_id = std::env::var("YK_CLIENT_ID")
        .expect("Please set a value to the YK_CLIENT_ID environment variable.");

    let api_key = std::env::var("YK_API_KEY")
        .expect("Please set a value to the YK_API_KEY environment variable.");

    let config = Config::default()
        .set_client_id(client_id)
        .set_key(api_key);

    let otp = read_user_input();

    verify_async(otp, config)
        .map_ok(|()| println!("Valid OTP."))
        .map_err(|err| println!("Invalid OTP. Cause: {:?}", err))
        .await
}

fn read_user_input() -> String {
    let mut buf = String::new();
    stdin()
        .read_line(&mut buf)
        .expect("Could not read user input.");
    buf
}

Docker

For convenience and reproducibility, a Docker image can be generated via the provided repo's Dockerfile.

General

You can use a build-arg to select which example to be used. For example use --build-arg=EXAMPLE=otp_async to build the async example instead of the default otp example.

Build:

$ docker build -t yubico-rs .
...
Successfully built 983cc040c78e
Successfully tagged yubico-rs:latest

Run:

$ docker run --rm -it -e YK_CLIENT_ID=XXXXX -e YK_API_KEY=XXXXXXXXXXXXXX yubico-rs:latest
Please plug in a yubikey and enter an OTP
ccccccXXXXXXXXXXXXXXXXXXXX
The OTP is valid.

Static

A static binary can be extracted from the container and run on almost any Linux system.