#oauth2 #base64 #url-safe #codec #token #sha-256 #pkce

oauth2_utils

crate that provides utility functions for working with OAuth2

5 releases (stable)

2.0.0 Apr 9, 2024
1.0.2 Dec 24, 2023
1.0.1 Dec 18, 2023
0.0.1 Dec 18, 2023

#9 in #url-safe

Download history 3/week @ 2024-07-13 6/week @ 2024-09-21 2/week @ 2024-09-28

257 downloads per month

MIT license

19KB
249 lines

Overview

This crate provides utility functions for working with OAuth2:

  • PKCE
  • URL-safe tokens
  • URL-safe base64 encoding/decoding

Installation

cargo add oauth2_utils

Usage

To generate a PKCE pair with the corresponding method (SHA256 by default):

use oauth2_utils::pkce::PKCE;

let pkce = PKCE::new();

println!("PKCE Code Challenge: {}", pkce.code_challenge);
println!("PKCE Code Verifier: {}", pkce.code_verifier);
println!("PKCE Code method: {}", pkce.method);

To generate a code verifier with a custom length:

use oauth2_utils::errors::CodeVerifierError;

use oauth2_utils::pkce::gen::{gen_code_challenge, gen_code_verifier};

  
pub fn main() -> Result<(), CodeVerifierError> {
    let code_verifier = gen_code_verifier(Some(128))?;
    eprintln!("Code Verifier: {}", code_verifier);
    let code_challenge = gen_code_challenge(&code_verifier);
    eprintln!("Code Challenge: {}", code_challenge);
    Ok(())
}

To generate a URL-safe token for Nonce, State, etc..

use oauth2_utils::urlsafe::urlsafe_token;

println!("URL-safe Token: {}", urlsafe_token(32))

For base64 encoding/decoding operations:


use oauth2_utils::errors::B64Error;
use oauth2_utils::urlsafe::b64::{urlsafe_b64decode, urlsafe_b64encode};

pub fn main() -> Result<(), B64Error> {
    let val = String::from("some value");
    let encoded = urlsafe_b64encode(val);
    println!("{}", encoded);
    let decoded = urlsafe_b64decode(encoded)?;
    println!("{}", decoded);
    Ok(())
}

License

GPL

Dependencies

~1MB
~20K SLoC