18 releases (7 breaking)

✓ Uses Rust 2018 edition

0.9.0-alpha.1 Oct 18, 2019
0.6.1 Jun 29, 2019
0.5.1 Jan 13, 2019
0.4.2 Nov 17, 2018
0.1.1 Dec 2, 2016

#7 in Authentication

Download history 198/week @ 2019-08-04 171/week @ 2019-08-11 197/week @ 2019-08-18 279/week @ 2019-08-25 205/week @ 2019-09-01 201/week @ 2019-09-08 172/week @ 2019-09-15 217/week @ 2019-09-22 409/week @ 2019-09-29 676/week @ 2019-10-06 679/week @ 2019-10-13 883/week @ 2019-10-20 747/week @ 2019-10-27 905/week @ 2019-11-03 781/week @ 2019-11-10

1,149 downloads per month

MIT/Apache

29KB
602 lines

Yubico   Build Status Latest Version MIT licensed Apache-2.0 licensed

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

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

Usage

Add this to your Cargo.toml

[dependencies]
yubico = "0.9.0-alpha.1"

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.

You can enable or disable them using the example below:

[dependencies.yubico]
version = "0.9.0-alpha.1"
# don't include the default features (online)
default-features = false
# cherry-pick individual features
features = []

Request your api key.

OTP with Default Servers

extern crate yubico;

use yubico::config::*;
use yubico::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

extern crate yubico;

use yubico::verify;
use yubico::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"]
extern crate futures;
extern crate tokio;
extern crate yubico;

use futures::future::Future;
use yubico::verify_async;
extern crate yubico;

use std::io::stdin;
use yubico::config::Config;

fn main() {
    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 otp = read_user_input();

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

    tokio::run(verify_async(otp, config)
        .unwrap()
        .map(|_|{
            println!("Valid OTP.");
        })
        .map_err(|err|{
            println!("Invalid OTP. Cause: {:?}", err);
        }))
}

fn read_user_input() -> String {
    let mut buf = String::new();

    stdin()
        .read_line(&mut buf)
        .expect("Could not read user input.");

    buf
}

Changelog

0.9.0-alpha.1: Moving to futures 0.3.0-alpha.19 0.8: Rename the sync and async modules to sync_verifier and async_verifier to avoid the use of the async reserved keyword.

Dependencies

~16MB
~397K SLoC