6 releases
new 0.3.1 | Dec 10, 2024 |
---|---|
0.3.0 | Nov 21, 2024 |
0.2.2 | Sep 2, 2024 |
0.2.1 | Aug 30, 2024 |
0.1.0 | Aug 15, 2024 |
#1324 in Web programming
1,336 downloads per month
Used in 2 crates
87KB
2K
SLoC
Unofficial Keygen Rust SDK
The keygen-rs
crate allows Rust programs to license using the keygen.sh service.
Sponsored by
Installing
Add this to your Cargo.toml
:
[dependencies]
keygen-rs = "0.3.1"
Tauri Plugin
A Tauri plugin for this SDK is available as tauri-plugin-keygen-rs
.
It provides an easy way to integrate Keygen licensing into your Tauri applications. For more information, check the plugin's README.
Config
KeygenConfig
Use KeygenConfig
to configure the SDK globally. You should set this before making any API calls.
use keygen_rs::config::{self, KeygenConfig};
config::set_config(KeygenConfig {
api_url: "https://api.keygen.sh".to_string(),
account: "YOUR_KEYGEN_ACCOUNT_ID".to_string(),
product: "YOUR_KEYGEN_PRODUCT_ID".to_string(),
license_key: Some("A_KEYGEN_LICENSE_KEY".to_string()),
public_key: Some("YOUR_KEYGEN_PUBLIC_KEY".to_string()),
..KeygenConfig::default()
});
Usage
Validate a License
To validate a license, configure KeygenConfig
with your Keygen account details. Then call the validate
function with a device fingerprint:
use keygen_rs::{config::{self, KeygenConfig}, errors::Error};
#[tokio::main]
async fn main() -> Result<(), Error> {
config::set_config(KeygenConfig {
api_url: "https://api.keygen.sh".to_string(),
account: "YOUR_KEYGEN_ACCOUNT_ID".to_string(),
product: "YOUR_KEYGEN_PRODUCT_ID".to_string(),
license_key: Some("A_KEYGEN_LICENSE_KEY".to_string()),
public_key: Some("YOUR_KEYGEN_PUBLIC_KEY".to_string()),
..KeygenConfig::default()
});
let fingerprint = machine_uid::get().unwrap_or("".into());
let license = keygen_rs::validate(&[fingerprint]).await?;
println!("License validated successfully: {:?}", license);
Ok(())
}
Activate a Machine
To activate a machine for a license:
use keygen_rs::{
config::{self, KeygenConfig},
errors::Error,
};
#[tokio::main]
async fn main() -> Result<(), Error> {
dotenv().ok();
config::set_config(KeygenConfig {
// ... (configuration)
});
let fingerprint = machine_uid::get().unwrap_or("".into());
if let Err(err) = keygen_rs::validate(&[fingerprint.clone()], &[]).await {
match err {
Error::LicenseNotActivated { license, .. } => {
let machine = license.activate(&fingerprint, &[]).await?;
println!("License activated successfully: {:?}", machine);
}
_ => {
println!("License validation failed: {:?}", err);
}
}
} else {
println!("License validated successfully");
}
Ok(())
}
Offline License Key Verification
To verify a signed license key offline:
use keygen_rs::{config::{self, KeygenConfig}, license::SchemeCode};
fn main() {
config::set_config(KeygenConfig {
// ... (configuration)
});
let signed_key = "YOUR_SIGNED_LICENSE_KEY";
if let Ok(data) = keygen_rs::verify(SchemeCode::Ed25519Sign, signed_key) {
println!("License verified: {:?}", String::from_utf8_lossy(&data));
} else {
println!("License verification failed");
}
}
Error Handling
The SDK returns meaningful errors which can be handled in your integration. Here's an example of handling a LicenseNotActivated
error:
use keygen_rs::{config::{self, KeygenConfig}, errors::Error};
#[tokio::main]
async fn main() -> Result<(), Error> {
config::set_config(KeygenConfig {
// ... (configuration)
});
let fingerprint = machine_uid::get().unwrap_or("".into());
match keygen_rs::validate(&[fingerprint.clone()]).await {
Ok(license) => println!("License is valid: {:?}", license),
Err(Error::LicenseNotActivated { license, .. }) => {
println!("License is not activated. Activating...");
let machine = license.activate(&fingerprint, &[]).await?;
println!("Machine activated: {:?}", machine);
},
Err(e) => println!("Error: {:?}", e),
}
Ok(())
}
Examples
For more detailed examples, please refer to the examples
directory in the repository.
Testing
When implementing a testing strategy for your licensing integration, we recommend mocking the Keygen API responses. This is especially important for CI/CD environments to prevent unnecessary load on Keygen's servers and to stay within your account's daily request limits.
You can use crates like mockito
or wiremock
to mock HTTP responses in your tests.
Inspired by
License
This project is licensed under the MIT License.
Dependencies
~14–49MB
~729K SLoC