Clippy/Rust lints and other updates

 * Upgrade to `tokio` 1.47
 * Bumped MSRV to v1.82.0 needed by latest packages
 * Added more clippy/rust lints including `pedantic` and fixed found items
 * Use only the main api server, the others are deprecated
 * Updated GHA
 * Added dotenvy as a dev dependency to load `.env` files

Signed-off-by: BlackDex <black.dex@gmail.com>

Author: BlackDex

.env.template

@@ -0,0 +1,15 @@
+# Used for running the examples
+# Copy this template and rename it to `.env` for it to be used
+# Or provided the variables below inline during a run
+
+# Mandatory Client ID. A number like 111111
+YK_CLIENT_ID=111111
+
+# Mandatory API Key. A base64 encoded value
+YK_API_KEY=AAAAAAAAAAAAAAAAAAAAAAAA==
+
+# Optional
+YK_API_HOST=https://api2.yubico.com/wsapi/2.0/verify
+
+# Optional
+YK_PROXY=http://127.0.0.1:1080

.github/workflows/build.yml

@@ -29,8 +29,6 @@ jobs:
     # This is done globally to prevent rebuilds when the RUSTFLAGS env variable changes.
     env:
       RUSTFLAGS: "-D warnings"
-    strategy:
-      fail-fast: false
 
     steps:
       # Install dependencies
@@ -41,7 +39,7 @@ jobs:
 
       # Install Rust with clippy
       - name: "Install rust-toolchain version"
-        uses: dtolnay/rust-toolchain@fcf085fcb4b4b8f63f96906cd713eb52181b5ea4 # stable at Mar 18, 2025, 8:14 PM GMT+1
+        uses: dtolnay/rust-toolchain@4305c38b25d97ef35a8ad1f985ccf2d2242004f2 # stable at Apr 29, 2025, 9:23 PM GMT+2
         with:
           components: clippy
       # End Install Rust with clippy
@@ -55,13 +53,13 @@ jobs:
 
       # Checkout the repo
       - name: "Checkout"
-        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
         with:
           persist-credentials: false
       # End Checkout the repo
 
       # Enable Rust Caching
-      - uses: Swatinem/rust-cache@9d47c6ad4b02e050fd481d890b2ea34778fd09d6 # v2.7.8
+      - uses: Swatinem/rust-cache@98c8021b550208e191a6a3145459bfc9fb29c4c0 # v2.8.0
       # End Enable Rust Caching
 
       # Run cargo commands

.gitignore

@@ -1,5 +1,8 @@
+.vscode/
+
 target
 Cargo.lock
 
 *.fmt
 *.iml
+*.env

.travis.yml

@@ -1,9 +1,9 @@
 [package]
 name = "yubico_ng"
-version = "0.13.0"
+version = "0.14.0"
 authors = ["Mathijs van Veluw <black.dex@gmail.com>"]
 edition = "2021"
-rust-version = "1.81.0"
+rust-version = "1.82.0"
 
 description = "Yubikey client API library"
 license = "MIT OR Apache-2.0"
@@ -27,8 +27,9 @@ threadpool = "1.8"
 form_urlencoded = "1"
 
 [dev-dependencies]
-tokio = { version = "1.44", features = ["macros", "rt-multi-thread"] }
+tokio = { version = ">=1.47", features = ["macros", "rt-multi-thread"], default-features = false }
 futures = "0.3"
+dotenvy = "0.15"
 
 [features]
 default = ["online-tokio", "native-tls"]
@@ -44,18 +45,26 @@ unsafe_code = "forbid"
 non_ascii_idents = "forbid"
 
 # Deny
+arithmetic_overflow = "deny"
 deprecated_in_future = "deny"
+deprecated_safe = { level = "deny", priority = -1 }
 future_incompatible = { level = "deny", priority = -1 }
 keyword_idents = { level = "deny", priority = -1 }
 let_underscore = { level = "deny", priority = -1 }
+missing_copy_implementations = "deny"
+nonstandard_style = { level = "deny", priority = -1 }
 noop_method_call = "deny"
 refining_impl_trait = { level = "deny", priority = -1 }
 rust_2018_idioms = { level = "deny", priority = -1 }
 rust_2021_compatibility = { level = "deny", priority = -1 }
 rust_2024_compatibility = { level = "deny", priority = -1 }
+rust-2018-compatibility = { level = "deny", priority = -1 }
 single_use_lifetimes = "deny"
 trivial_casts = "deny"
 trivial_numeric_casts = "deny"
+unknown_or_malformed_diagnostic_attributes = { level = "deny", priority = -2 }
+unreachable_pub = "deny"
+unstable_features = "deny"
 unused = { level = "deny", priority = -1 }
 unused_import_braces = "deny"
 unused_lifetimes = "deny"
@@ -69,35 +78,25 @@ dbg_macro = "warn"
 todo = "warn"
 
 # Deny
-case_sensitive_file_extension_comparisons = "deny"
-cast_lossless = "deny"
+bool_comparison = "deny"
 clone_on_ref_ptr = "deny"
+empty_structs_with_brackets = "deny"
 equatable_if_let = "deny"
-filter_map_next = "deny"
 float_cmp_const = "deny"
-inefficient_to_string = "deny"
+indexing_slicing = "deny"
 iter_on_empty_collections = "deny"
 iter_on_single_items = "deny"
-linkedlist = "deny"
-macro_use_imports = "deny"
-manual_assert = "deny"
-manual_instant_elapsed = "deny"
-manual_string_new = "deny"
-match_on_vec_items = "deny"
-match_wildcard_for_single_variants = "deny"
+manual_map = "deny"
 mem_forget = "deny"
-needless_continue = "deny"
 needless_lifetimes = "deny"
-option_option = "deny"
-string_add_assign = "deny"
-string_to_string = "deny"
-unnecessary_join = "deny"
+nonminimal_bool = "deny"
+pedantic = { level = "deny", priority = -1 }
+redundant_clone = "deny"
+str_to_string = "deny"
+unnecessary_lazy_evaluations = "deny"
 unnecessary_self_imports = "deny"
-unnested_or_patterns = "deny"
-unused_async = "deny"
-unused_self = "deny"
+unwrap_used = "deny"
 verbose_file_reads = "deny"
-zero_sized_map_values = "deny"
 
 [lints]
 workspace = true

Cargo.toml

@@ -17,21 +17,21 @@
 - [X] Synchronous Yubikey client API library, [validation protocol version 2.0](https://developers.yubico.com/OTP/Specifications/OTP_validation_protocol.html).
 - [X] Asynchronous Yubikey client API library relying on [Tokio](https://github.com/tokio-rs/tokio)
 
-**Note:** The USB-related features have been moved to a sepatated repository, [yubico-manager](https://github.com/wisespace-io/yubico-manager)
+**Note:** The USB-related features have been moved to a separated repository, [yubico-manager](https://github.com/wisespace-io/yubico-manager)
 
 ## Usage
 
 Add this to your Cargo.toml
 
 ```toml
 [dependencies]
-yubico_ng = "0.13"
+yubico_ng = "0.14"
 ```
 
 Or, since this crate is still backwards compatible with the yubico crate.
 ```toml
 [dependencies]
-yubico = { version = "0.13", package = "yubico_ng" }
+yubico = { version = "0.14", package = "yubico_ng" }
 ```
 
 The following are a list of Cargo features that can be enabled or disabled:
@@ -179,6 +179,14 @@ The OTP is valid.
 
 ## Changelog
 
+    - 0.14.0 (2025-08-13):
+      * Upgrade to `tokio` 1.47
+      * Bumped MSRV to v1.82.0 needed by latest packages
+      * Added more clippy/rust lints including `pedantic` and fixed found items
+      * Use only the main api server, the others are deprecated
+      * Updated GHA
+      * Added dotenvy as a dev dependency to load `.env` files
+
     - 0.13.0 (2025-04-23):
       * Upgrade to `tokio` 1.44, `rand` 0.9
       * Renamed to yubico_ng and published crate

README.md

@@ -6,18 +6,30 @@ All these examples need some environment variables to work.
 
 If you run the example it will show you which variables are missing.
 
+You can also copy the `.env.template` file to `.env` adjust the variables where needed and run the examples.
+
+The `.env` file is excluded from git.
+
 ## OTP (One Time Password)
 
-cargo run --release --example "otp"
+```bash
+cargo run --release --example otp
+```
 
 ## OTP (One Time Password) with a HTTP Proxy
 
-cargo run --release --example "otp_with_proxy"
+```bash
+cargo run --release --example otp_with_proxy
+```
 
 ## OTP (One Time Password) with Custom Servers
 
-cargo run --release --example "otp_custom"
+```bash
+cargo run --release --example otp_custom
+```
 
 ## Asynchronous OTP check
 
-cargo run --release --example "otp_async"
+```bash
+cargo run --release --example otp_async
+```

examples/README.md

@@ -1,8 +1,14 @@
+use dotenvy::dotenv;
 use std::io::stdin;
 use yubico_ng::config::Config;
 use yubico_ng::verify;
 
 fn main() {
+    match dotenv() {
+        Ok(_) => println!("Loaded .env"),
+        Err(_) => eprintln!("Unable to load .env, provide proper environment variables manually"),
+    }
+
     println!("Please plug in a yubikey and enter an OTP");
 
     let client_id = std::env::var("YK_CLIENT_ID")
@@ -16,8 +22,8 @@ fn main() {
     let otp = read_user_input();
 
     match verify(otp, config) {
-        Ok(answer) => println!("{}", answer),
-        Err(e) => println!("Error: {}", e),
+        Ok(answer) => println!("{answer}"),
+        Err(e) => println!("Error: {e}"),
     }
 }
 

examples/otp.rs

@@ -1,11 +1,17 @@
 use futures::TryFutureExt;
 
+use dotenvy::dotenv;
 use std::io::stdin;
 use yubico_ng::config::Config;
 use yubico_ng::verify_async;
 
 #[tokio::main]
 async fn main() -> Result<(), ()> {
+    match dotenv() {
+        Ok(_) => println!("Loaded .env"),
+        Err(_) => eprintln!("Unable to load .env, provide proper environment variables manually"),
+    }
+
     println!("Please plug in a yubikey and enter an OTP");
 
     let client_id = std::env::var("YK_CLIENT_ID")
@@ -20,7 +26,7 @@ async fn main() -> Result<(), ()> {
 
     verify_async(otp, config)
         .map_ok(|()| println!("Valid OTP."))
-        .map_err(|err| println!("Invalid OTP. Cause: {:?}", err))
+        .map_err(|err| println!("Invalid OTP. Cause: {err:?}"))
         .await
 }
 

examples/otp_async.rs

@@ -1,8 +1,15 @@
+use dotenvy::dotenv;
 use std::io::stdin;
 use yubico_ng::config::Config;
 use yubico_ng::verify;
 
 fn main() {
+    match dotenv() {
+        Ok(_) => println!("Loaded .env"),
+        Err(_) => eprintln!("Unable to load .env, provide proper environment variables manually"),
+
+    }
+
     println!("Please plug in a yubikey and enter an OTP");
 
     let client_id = std::env::var("YK_CLIENT_ID")
@@ -22,8 +29,8 @@ fn main() {
     let otp = read_user_input();
 
     match verify(otp, config) {
-        Ok(answer) => println!("{}", answer),
-        Err(e) => println!("Error: {}", e),
+        Ok(answer) => println!("{answer}"),
+        Err(e) => println!("Error: {e}"),
     }
 }