|
| 1 | +//! Service responsible for authenticating with the cache with Oauth tokens. |
| 2 | +//! This authenticator periodically fetches a new token every set amount of seconds. |
| 3 | +use crate::{ |
| 4 | + deps::tracing::{error, info}, |
| 5 | + utils::from_env::FromEnv, |
| 6 | +}; |
| 7 | +use oauth2::{ |
| 8 | + basic::{BasicClient, BasicTokenType}, |
| 9 | + AuthUrl, ClientId, ClientSecret, EmptyExtraTokenFields, EndpointNotSet, EndpointSet, |
| 10 | + HttpClientError, RequestTokenError, StandardErrorResponse, StandardTokenResponse, TokenUrl, |
| 11 | +}; |
| 12 | +use std::sync::{Arc, Mutex}; |
| 13 | +use tokio::task::JoinHandle; |
| 14 | + |
| 15 | +type Token = StandardTokenResponse<EmptyExtraTokenFields, BasicTokenType>; |
| 16 | + |
| 17 | +type MyOAuthClient = |
| 18 | + BasicClient<EndpointSet, EndpointNotSet, EndpointNotSet, EndpointNotSet, EndpointSet>; |
| 19 | + |
| 20 | +/// Configuration for the OAuth2 client. |
| 21 | +#[derive(Debug, Clone, FromEnv)] |
| 22 | +#[from_env(crate)] |
| 23 | +pub struct OAuthConfig { |
| 24 | + /// OAuth client ID for the builder. |
| 25 | + #[from_env(var = "OAUTH_CLIENT_ID", desc = "OAuth client ID for the builder")] |
| 26 | + pub oauth_client_id: String, |
| 27 | + /// OAuth client secret for the builder. |
| 28 | + #[from_env( |
| 29 | + var = "OAUTH_CLIENT_SECRET", |
| 30 | + desc = "OAuth client secret for the builder" |
| 31 | + )] |
| 32 | + pub oauth_client_secret: String, |
| 33 | + /// OAuth authenticate URL for the builder for performing OAuth logins. |
| 34 | + #[from_env( |
| 35 | + var = "OAUTH_AUTHENTICATE_URL", |
| 36 | + desc = "OAuth authenticate URL for the builder for performing OAuth logins" |
| 37 | + )] |
| 38 | + pub oauth_authenticate_url: url::Url, |
| 39 | + /// OAuth token URL for the builder to get an OAuth2 access token |
| 40 | + #[from_env( |
| 41 | + var = "OAUTH_TOKEN_URL", |
| 42 | + desc = "OAuth token URL for the builder to get an OAuth2 access token" |
| 43 | + )] |
| 44 | + pub oauth_token_url: url::Url, |
| 45 | + /// The oauth token refresh interval in seconds. |
| 46 | + #[from_env( |
| 47 | + var = "AUTH_TOKEN_REFRESH_INTERVAL", |
| 48 | + desc = "The oauth token refresh interval in seconds" |
| 49 | + )] |
| 50 | + pub oauth_token_refresh_interval: u64, |
| 51 | +} |
| 52 | + |
| 53 | +impl OAuthConfig { |
| 54 | + /// Create a new [`Authenticator`] from the provided config. |
| 55 | + pub fn authenticator(&self) -> Authenticator { |
| 56 | + Authenticator::new(self) |
| 57 | + } |
| 58 | +} |
| 59 | + |
| 60 | +/// A shared token that can be read and written to by multiple threads. |
| 61 | +#[derive(Debug, Clone, Default)] |
| 62 | +pub struct SharedToken(Arc<Mutex<Option<Token>>>); |
| 63 | + |
| 64 | +impl SharedToken { |
| 65 | + /// Read the token from the shared token. |
| 66 | + pub fn read(&self) -> Option<Token> { |
| 67 | + self.0.lock().unwrap().clone() |
| 68 | + } |
| 69 | + |
| 70 | + /// Write a new token to the shared token. |
| 71 | + pub fn write(&self, token: Token) { |
| 72 | + let mut lock = self.0.lock().unwrap(); |
| 73 | + *lock = Some(token); |
| 74 | + } |
| 75 | + |
| 76 | + /// Check if the token is authenticated. |
| 77 | + pub fn is_authenticated(&self) -> bool { |
| 78 | + self.0.lock().unwrap().is_some() |
| 79 | + } |
| 80 | +} |
| 81 | + |
| 82 | +/// A self-refreshing, periodically fetching authenticator for the block |
| 83 | +/// builder. This task periodically fetches a new token, and stores it in a |
| 84 | +/// [`SharedToken`]. |
| 85 | +#[derive(Debug)] |
| 86 | +pub struct Authenticator { |
| 87 | + /// Configuration |
| 88 | + pub config: OAuthConfig, |
| 89 | + client: MyOAuthClient, |
| 90 | + token: SharedToken, |
| 91 | + reqwest: reqwest::Client, |
| 92 | +} |
| 93 | + |
| 94 | +impl Authenticator { |
| 95 | + /// Creates a new Authenticator from the provided builder config. |
| 96 | + pub fn new(config: &OAuthConfig) -> Self { |
| 97 | + let client = BasicClient::new(ClientId::new(config.oauth_client_id.clone())) |
| 98 | + .set_client_secret(ClientSecret::new(config.oauth_client_secret.clone())) |
| 99 | + .set_auth_uri(AuthUrl::from_url(config.oauth_authenticate_url.clone())) |
| 100 | + .set_token_uri(TokenUrl::from_url(config.oauth_token_url.clone())); |
| 101 | + |
| 102 | + let rq_client = reqwest::Client::builder() |
| 103 | + .redirect(reqwest::redirect::Policy::none()) |
| 104 | + .build() |
| 105 | + .unwrap(); |
| 106 | + |
| 107 | + Self { |
| 108 | + config: config.clone(), |
| 109 | + client, |
| 110 | + token: Default::default(), |
| 111 | + reqwest: rq_client, |
| 112 | + } |
| 113 | + } |
| 114 | + |
| 115 | + /// Requests a new authentication token and, if successful, sets it to as the token |
| 116 | + pub async fn authenticate( |
| 117 | + &self, |
| 118 | + ) -> Result< |
| 119 | + (), |
| 120 | + RequestTokenError< |
| 121 | + HttpClientError<reqwest::Error>, |
| 122 | + StandardErrorResponse<oauth2::basic::BasicErrorResponseType>, |
| 123 | + >, |
| 124 | + > { |
| 125 | + let token = self.fetch_oauth_token().await?; |
| 126 | + self.set_token(token); |
| 127 | + Ok(()) |
| 128 | + } |
| 129 | + |
| 130 | + /// Returns true if there is Some token set |
| 131 | + pub fn is_authenticated(&self) -> bool { |
| 132 | + self.token.is_authenticated() |
| 133 | + } |
| 134 | + |
| 135 | + /// Sets the Authenticator's token to the provided value |
| 136 | + fn set_token(&self, token: StandardTokenResponse<EmptyExtraTokenFields, BasicTokenType>) { |
| 137 | + self.token.write(token); |
| 138 | + } |
| 139 | + |
| 140 | + /// Returns the currently set token |
| 141 | + pub fn token(&self) -> SharedToken { |
| 142 | + self.token.clone() |
| 143 | + } |
| 144 | + |
| 145 | + /// Fetches an oauth token |
| 146 | + pub async fn fetch_oauth_token( |
| 147 | + &self, |
| 148 | + ) -> Result< |
| 149 | + Token, |
| 150 | + RequestTokenError< |
| 151 | + HttpClientError<reqwest::Error>, |
| 152 | + StandardErrorResponse<oauth2::basic::BasicErrorResponseType>, |
| 153 | + >, |
| 154 | + > { |
| 155 | + let token_result = self |
| 156 | + .client |
| 157 | + .exchange_client_credentials() |
| 158 | + .request_async(&self.reqwest) |
| 159 | + .await?; |
| 160 | + |
| 161 | + Ok(token_result) |
| 162 | + } |
| 163 | + |
| 164 | + /// Spawns a task that periodically fetches a new token every 300 seconds. |
| 165 | + pub fn spawn(self) -> JoinHandle<()> { |
| 166 | + let interval = self.config.oauth_token_refresh_interval; |
| 167 | + |
| 168 | + let handle: JoinHandle<()> = tokio::spawn(async move { |
| 169 | + loop { |
| 170 | + info!("Refreshing oauth token"); |
| 171 | + match self.authenticate().await { |
| 172 | + Ok(_) => { |
| 173 | + info!("Successfully refreshed oauth token"); |
| 174 | + } |
| 175 | + Err(e) => { |
| 176 | + error!(%e, "Failed to refresh oauth token"); |
| 177 | + } |
| 178 | + }; |
| 179 | + let _sleep = tokio::time::sleep(tokio::time::Duration::from_secs(interval)).await; |
| 180 | + } |
| 181 | + }); |
| 182 | + |
| 183 | + handle |
| 184 | + } |
| 185 | +} |
0 commit comments