- Notifications
You must be signed in to change notification settings - Fork10
Rust Google Oauth2 Client Implementation
License
Apache-2.0, MIT licenses found
Licenses found
makarski/gauth-rs
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
The library supports the following Google Auth flows:
[dependencies]gauth ="0.8"
- Create your application inGoogle API Console
a.Credentials>Create credentials>OAuth client ID
b. Set application type toOther
c. Enter your application name
d.Download JSONconfiguration of the newly created application
Client implementation with defaults
use gauth::app::Auth;#[tokio::main]asyncfnmain(){let auth_client =Auth::from_file("my_credentials.json",vec!["https://www.googleapis.com/auth/drive"],).unwrap();let token = auth_client.access_token().await.unwrap();println!("access token: {}", token);}
It is also possible to make ablocking call to retrieve an access token. This may be helpful if we want to wrap the logic into a closure.
[dependencies]gauth = { version = "0.8", features = ["app-blocking"] }use gauth::app::Auth;#[tokio::main]asyncfnmain(){let ga =Auth::from_file("client_secret.json",vec!["https://www.googleapis.com/auth/drive"]).unwrap();let closure =move ||{// add some logic here ga.access_token_blocking()};let token =closure().unwrap();println!("token from closure: {}", token);}
Custom app name and handler: access token will be stored in$HOME/.{app_name}/access_token.json
To assign a custom directory as access token caching, set env var value:GAUTH_TOKEN_DIR
use gauth::app::Auth;use anyhow::ErrorasAnyError;#[tokio::main]asyncfnmain(){let auth_handler = |consent_uri:String| ->Result<String,AnyError>{// business logicOk("auth_code".to_owned())};letmut auth_client =Auth::from_file("my_credentials.json",vec!["https://www.googleapis.com/auth/drive"],).unwrap();let auth_client = auth_client.app_name("new_name").handler(auth_handler);let token = auth_client.access_token().await.unwrap();println!("access token: {}", token);}
Follow instructions forcreating a service account. After a service account key has been created,it can be used to obtain an access token.
use gauth::serv_account::ServiceAccount;#[tokio::main]asyncfnaccess_token(){let scopes =vec!["https://www.googleapis.com/auth/drive"];let key_path ="test_fixtures/service-account-key.json";letmut service_account =ServiceAccount::from_file(key_path, scopes);let access_token = service_account.access_token().await.unwrap();println!("access token {}:", access_token);}
The default implementation for acquiring the access token in this library is asynchronous. However, there are scenarios where a synchronous call is necessary. For instance, asynchronous signatures can be cumbersome when used withtonic middlewares. The difficulties of integrating synchronous and asynchronous code are outlined in thisGitHub issue.
To resolve this, we adopted an experimental approach by developing atoken_provider package. This package includes aWatcher trait, which has been implemented for both theapp andserv_account packages. Each implementation of this trait spawns a daemon that periodically polls for and caches token updates at specified intervals. As a result, tokens are consistently refreshed through an asynchronous process. The retrieval of tokens is simplified to a synchronous function that reads from the internal cache.
[dependencies]gauth = { version = "0.8", features = ["token-watcher"] }let service_account =ServiceAccount::from_file(&keypath,vec!["https://www.googleapis.com/auth/pubsub"]);let tp =AsyncTokenProvider::new(service_account).with_interval(5);// the token is updated every 5 seconds// and cached in AsyncTokenProvidertp.watch_updates().await;// sync call to get the access tokenlet access_token = tp.access_token()?;
The full example can be foundhere
License under either or:
About
Rust Google Oauth2 Client Implementation