🔐 A Rust Library for JSON Web Keys (JWK)

📚 Overview

jwk_kit simplifies working with JSON Web Keys (JWK) in Rust by offering a clean, efficient API for key generation, serialization, and conversion.

jwk_kit is a modern, lightweight, developer-friendly Rust library designed for generating, managing, and serializing JSON Web Keys (JWK). It provides an easy-to-use interface for handling cryptographic keys in the JWK format, widely used in securing APIs, OAuth2, JWT, and other authentication protocols.

jwk_kit is a programmatic alternative to using the openssl command-line tool, enabling direct integration into your Rust applications without the need for shelling out to external commands.

Whether you're managing a JWKS endpoint or handling tokens in your auth layer, jwk_kit helps you stay compliant, secure, and productive.

🆚 Why Use `jwk_kit` Over `openssl` CLI?

While openssl is a powerful tool for generating and working with cryptographic keys, it often requires external subprocess calls or manual interaction. jwk_kit, on the other hand, provides a native Rust API for working with JWKs, allowing you to automate and embed key generation and conversion directly into your applications.

📌 Example:

Instead of using the openssl CLI commands to generate RSA keys:

openssl genpkey -algorithm RSA -out access-private.pem -pkeyopt rsa_keygen_bits:2048
openssl rsa -pubout -in access-private.pem -out access-public.pem

openssl genpkey -algorithm EC -pkeyopt ec_paramgen_curve:P-256 -out ec-access-private.pem
openssl ec -in ec-access-private.pem -pubout -out ec-access-public.pem

With jwk_kit, you can do it all programmatically in Rust, see Usage Example

This approach allows you to handle key generation and management entirely within your Rust application, without relying on shell commands. While in a CLI-based solution, you would still need external tools or commands to convert your keys into JWK format, with jwk_kit, the ability to generate, manage, and convert keys to the JWK format is built directly into your Rust application, streamlining the process and eliminating the need for additional external efforts.

✨ Features

Native Rust API — No need for external shell commands or subprocess management.
Key Generation and Management — Easily generate RSA (2048/4096 bits) and ES256 (P-256) key pairs, and convert them into JWK format.
Base64URL-safe encoding (no padding) and export keys in PEM (PKCS#8) format.
Web Standards Integration — Ideal for use with JSON Web Tokens (JWT), OAuth2, and OpenID Connect.
Testing and Dynamic Key Rotation — Useful for key management in secure applications, including key rotation for compliance.
Lightweight and Ergonomic — Minimal dependencies, built with ergonomics in mind, and simple to use in your Rust projects.
Compliant with RFC 7517 — Fully compliant with the RFC 7517 specification for JSON Web Keys (JWK).

🔧 Installation

Add this to your Cargo.toml:

[dependencies]
jwk_kit = "0.1.0"

🚀 Usage Example

use jwk_kit::generator::rsa::{extract_rsa_n_e, generate_rsa_keypair_pem};
use jwk_kit::generator::ecdsa::{extract_es256_coordinates, generate_es256_keypair_pem};
use jwk_kit::jwk::{create_jwks, JwkBuilder};
use jwk_kit::error::JwkError;
use std::fs::{write, File};

fn main() -> Result<(), JwkError> {
    // Generate an RSA key pair (private and public keys) with a 2048-bit modulus
    let (private_pem, public_pem) = generate_rsa_keypair_pem(2048)?;
    println!("RSA Private Key:\n{}", private_pem);
    println!("RSA Public Key:\n{}", public_pem);
    
    // Save the RSA private key to a file named rsa-access-private.pem
    write("./examples/rsa/rsa-access-private.pem", &private_pem)
    .map_err(|_| JwkError::PemWriteError)?;
    println!("Private key saved to rsa-access-private.pem:\n{}", private_pem);
    
    // Save the RSA public key to a file named rsa-access-public.pem
    write("./examples/rsa/rsa-access-public.pem", &public_pem)
    .map_err(|_| JwkError::PemWriteError)?;
    println!("Public key saved to rsa-access-public.pem:\n{}", public_pem);
    
    // Extract the RSA modulus (n) and exponent (e) from the public key in PEM format
    let (n_b64, e_b64) = extract_rsa_n_e(&public_pem)?;
    
    // Build a JWK (JSON Web Key) for the RSA key using the modulus and exponent
    let rsa_jwk = JwkBuilder::new("RSA")
    .set_key_use("sig") 
    .set_algorithm("RS256") 
    .set_key_id("rsa-key-1") 
    .set_modulus(&n_b64) 
    .set_exponent(&e_b64) 
    .build()?;
    
    // Generate an ECDSA key pair (private and public keys) for ES256 (P-256 curve)
    let (private_pem, public_pem) = generate_es256_keypair_pem()?;
    println!("ECDSA Private Key:\n{}", private_pem);
    println!("ECDSA Public Key:\n{}", public_pem);
    
    // Extract the EC curve coordinates (x, y) from the public key in PEM format
    let (x, y) = extract_es256_coordinates(&public_pem)?;
    
    // Build a JWK for the ECDSA key using the curve type (P-256) and coordinates (x, y)
    let ec_jwk = JwkBuilder::new("EC")
    .set_key_use("sig") 
    .set_algorithm("ES256") 
    .set_key_id("ecdsa-key-1") 
    .set_curve_type("P-256") 
    .set_x_coordinate(&x) 
    .set_y_coordinate(&y) 
    .build()?;
    
    // Create a JSON Web Key Set (JWKS) containing both the RSA and ECDSA keys
    let jwks = create_jwks(vec![rsa_jwk, ec_jwk]);
    
    // Serialize the JWKS to a JSON string
    let jwks_json = serde_json::to_string_pretty(&jwks)
    .map_err(|_| JwkError::UnsupportedKeyType("serialization failed".into()))?;
    
    // Print the resulting JWKS (containing both RSA and ECDSA keys) in a human-readable format
    println!("JWKS:\n{}", jwks_json);
    
    Ok(())
}

📜 License

This project is licensed under the Apache 2.0 License. See the LICENSE for details.

🧑‍💻 Author

Created and maintained by Jerry Maheswara

Feel free to reach out for suggestions, issues, or improvements!

❤️ Built with Love in Rust

This project is built with ❤️ using Rust — a systems programming language that is safe, fast, and concurrent. Rust is the perfect choice for building reliable and efficient applications.

👋 Contributing

Pull requests, issues, and feedback are welcome!
If you find this crate useful, give it a ⭐ and share it with others in the Rust community.

🌍 Specification Compliance

jwk_kit is designed to be fully compliant with the following IETF specifications:

RFC 7517 - JSON Web Key (JWK): Defines a JSON-based data structure for representing cryptographic keys, including both public and private key information.
RFC 7518 - JSON Web Algorithms (JWA): Specifies cryptographic algorithms and identifiers for use with JWKs, JWTs, and related technologies.

These specifications ensure interoperability across different languages, platforms, and identity systems. The key generation, encoding, and serialization behaviors of jwk_kit are aligned with the structures and field requirements outlined in these RFCs.

For deeper integration or troubleshooting, reviewing these documents can be highly beneficial.

jwk_kit 0.1.0