fix(oauth): require CSRF token as part of the OAuth authorization flow. (#435)
* Require CSRF token as part of the authorization flow. * Update auth example. * Update docs/OAUTH_SUPPORT.md.
This commit is contained in:
parent
83ce13c331
commit
271cf0b232
3 changed files with 45 additions and 24 deletions
|
|
@ -147,7 +147,7 @@ pub struct AuthorizationManager {
|
||||||
metadata: Option<AuthorizationMetadata>,
|
metadata: Option<AuthorizationMetadata>,
|
||||||
oauth_client: Option<OAuthClient>,
|
oauth_client: Option<OAuthClient>,
|
||||||
credentials: RwLock<Option<OAuthTokenResponse>>,
|
credentials: RwLock<Option<OAuthTokenResponse>>,
|
||||||
pkce_verifier: RwLock<Option<PkceCodeVerifier>>,
|
state: RwLock<Option<AuthorizationState>>,
|
||||||
expires_at: RwLock<Option<Instant>>,
|
expires_at: RwLock<Option<Instant>>,
|
||||||
base_url: Url,
|
base_url: Url,
|
||||||
}
|
}
|
||||||
|
|
@ -172,6 +172,12 @@ pub struct ClientRegistrationResponse {
|
||||||
pub additional_fields: HashMap<String, serde_json::Value>,
|
pub additional_fields: HashMap<String, serde_json::Value>,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[derive(Debug)]
|
||||||
|
struct AuthorizationState {
|
||||||
|
pkce_verifier: PkceCodeVerifier,
|
||||||
|
csrf_token: CsrfToken,
|
||||||
|
}
|
||||||
|
|
||||||
impl AuthorizationManager {
|
impl AuthorizationManager {
|
||||||
/// create new auth manager with base url
|
/// create new auth manager with base url
|
||||||
pub async fn new<U: IntoUrl>(base_url: U) -> Result<Self, AuthError> {
|
pub async fn new<U: IntoUrl>(base_url: U) -> Result<Self, AuthError> {
|
||||||
|
|
@ -186,7 +192,7 @@ impl AuthorizationManager {
|
||||||
metadata: None,
|
metadata: None,
|
||||||
oauth_client: None,
|
oauth_client: None,
|
||||||
credentials: RwLock::new(None),
|
credentials: RwLock::new(None),
|
||||||
pkce_verifier: RwLock::new(None),
|
state: RwLock::new(None),
|
||||||
expires_at: RwLock::new(None),
|
expires_at: RwLock::new(None),
|
||||||
base_url,
|
base_url,
|
||||||
};
|
};
|
||||||
|
|
@ -405,11 +411,14 @@ impl AuthorizationManager {
|
||||||
auth_request = auth_request.add_scope(Scope::new(scope.to_string()));
|
auth_request = auth_request.add_scope(Scope::new(scope.to_string()));
|
||||||
}
|
}
|
||||||
|
|
||||||
let (auth_url, _csrf_token) = auth_request.url();
|
let (auth_url, csrf_token) = auth_request.url();
|
||||||
|
|
||||||
// store pkce verifier for later use
|
// store pkce verifier for later use
|
||||||
*self.pkce_verifier.write().await = Some(pkce_verifier);
|
*self.state.write().await = Some(AuthorizationState {
|
||||||
debug!("set pkce verifier: {:?}", self.pkce_verifier.read().await);
|
pkce_verifier,
|
||||||
|
csrf_token,
|
||||||
|
});
|
||||||
|
debug!("set authorization state: {:?}", self.state.read().await);
|
||||||
|
|
||||||
Ok(auth_url.to_string())
|
Ok(auth_url.to_string())
|
||||||
}
|
}
|
||||||
|
|
@ -418,6 +427,7 @@ impl AuthorizationManager {
|
||||||
pub async fn exchange_code_for_token(
|
pub async fn exchange_code_for_token(
|
||||||
&self,
|
&self,
|
||||||
code: &str,
|
code: &str,
|
||||||
|
csrf_token: &str,
|
||||||
) -> Result<StandardTokenResponse<EmptyExtraTokenFields, BasicTokenType>, AuthError> {
|
) -> Result<StandardTokenResponse<EmptyExtraTokenFields, BasicTokenType>, AuthError> {
|
||||||
debug!("start exchange code for token: {:?}", code);
|
debug!("start exchange code for token: {:?}", code);
|
||||||
let oauth_client = self
|
let oauth_client = self
|
||||||
|
|
@ -425,12 +435,17 @@ impl AuthorizationManager {
|
||||||
.as_ref()
|
.as_ref()
|
||||||
.ok_or_else(|| AuthError::InternalError("OAuth client not configured".to_string()))?;
|
.ok_or_else(|| AuthError::InternalError("OAuth client not configured".to_string()))?;
|
||||||
|
|
||||||
let pkce_verifier = self
|
let AuthorizationState {
|
||||||
.pkce_verifier
|
pkce_verifier,
|
||||||
.write()
|
csrf_token: expected_csrf_token,
|
||||||
.await
|
} =
|
||||||
.take()
|
self.state.write().await.take().ok_or_else(|| {
|
||||||
.ok_or_else(|| AuthError::InternalError("PKCE verifier not found".to_string()))?;
|
AuthError::InternalError("Authorization state not found".to_string())
|
||||||
|
})?;
|
||||||
|
|
||||||
|
if csrf_token != expected_csrf_token.secret() {
|
||||||
|
return Err(AuthError::InternalError("CSRF token mismatch".to_string()));
|
||||||
|
}
|
||||||
|
|
||||||
let http_client = reqwest::ClientBuilder::new()
|
let http_client = reqwest::ClientBuilder::new()
|
||||||
.redirect(reqwest::redirect::Policy::none())
|
.redirect(reqwest::redirect::Policy::none())
|
||||||
|
|
@ -601,8 +616,11 @@ impl AuthorizationSession {
|
||||||
pub async fn handle_callback(
|
pub async fn handle_callback(
|
||||||
&self,
|
&self,
|
||||||
code: &str,
|
code: &str,
|
||||||
|
csrf_token: &str,
|
||||||
) -> Result<StandardTokenResponse<EmptyExtraTokenFields, BasicTokenType>, AuthError> {
|
) -> Result<StandardTokenResponse<EmptyExtraTokenFields, BasicTokenType>, AuthError> {
|
||||||
self.auth_manager.exchange_code_for_token(code).await
|
self.auth_manager
|
||||||
|
.exchange_code_for_token(code, csrf_token)
|
||||||
|
.await
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -787,10 +805,10 @@ impl OAuthState {
|
||||||
}
|
}
|
||||||
|
|
||||||
/// handle authorization callback
|
/// handle authorization callback
|
||||||
pub async fn handle_callback(&mut self, code: &str) -> Result<(), AuthError> {
|
pub async fn handle_callback(&mut self, code: &str, csrf_token: &str) -> Result<(), AuthError> {
|
||||||
match self {
|
match self {
|
||||||
OAuthState::Session(session) => {
|
OAuthState::Session(session) => {
|
||||||
session.handle_callback(code).await?;
|
session.handle_callback(code, csrf_token).await?;
|
||||||
self.complete_authorization().await
|
self.complete_authorization().await
|
||||||
}
|
}
|
||||||
OAuthState::Unauthorized(_) => {
|
OAuthState::Unauthorized(_) => {
|
||||||
|
|
|
||||||
|
|
@ -44,8 +44,9 @@ rmcp = { version = "0.1", features = ["auth", "transport-sse-client"] }
|
||||||
println!("Please open the following URL in your browser for authorization:\n{}", auth_url);
|
println!("Please open the following URL in your browser for authorization:\n{}", auth_url);
|
||||||
|
|
||||||
// Handle callback - In real applications, this is typically done in a callback server
|
// Handle callback - In real applications, this is typically done in a callback server
|
||||||
let auth_code = "Authorization code obtained from browser after user authorization";
|
let auth_code = "Authorization code (`code` param) obtained from browser after user authorization";
|
||||||
let credentials = oauth_state.handle_callback(auth_code).await?;
|
let csrf_token = "CSRF token (`state` param) obtained from browser after user authorization";
|
||||||
|
let credentials = oauth_state.handle_callback(auth_code, csrf_token).await?;
|
||||||
|
|
||||||
println!("Authorization successful, access token: {}", credentials.access_token);
|
println!("Authorization successful, access token: {}", credentials.access_token);
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -31,25 +31,24 @@ const CALLBACK_HTML: &str = include_str!("callback.html");
|
||||||
|
|
||||||
#[derive(Clone)]
|
#[derive(Clone)]
|
||||||
struct AppState {
|
struct AppState {
|
||||||
code_receiver: Arc<Mutex<Option<oneshot::Sender<String>>>>,
|
code_receiver: Arc<Mutex<Option<oneshot::Sender<CallbackParams>>>>,
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Debug, Deserialize)]
|
#[derive(Debug, Deserialize)]
|
||||||
struct CallbackParams {
|
struct CallbackParams {
|
||||||
code: String,
|
code: String,
|
||||||
#[allow(dead_code)]
|
state: String,
|
||||||
state: Option<String>,
|
|
||||||
}
|
}
|
||||||
|
|
||||||
async fn callback_handler(
|
async fn callback_handler(
|
||||||
Query(params): Query<CallbackParams>,
|
Query(params): Query<CallbackParams>,
|
||||||
State(state): State<AppState>,
|
State(state): State<AppState>,
|
||||||
) -> Html<String> {
|
) -> Html<String> {
|
||||||
tracing::info!("Received callback with code: {}", params.code);
|
tracing::info!("Received callback: {params:?}");
|
||||||
|
|
||||||
// Send the code to the main thread
|
// Send the code to the main thread
|
||||||
if let Some(sender) = state.code_receiver.lock().await.take() {
|
if let Some(sender) = state.code_receiver.lock().await.take() {
|
||||||
let _ = sender.send(params.code);
|
let _ = sender.send(params);
|
||||||
}
|
}
|
||||||
// Return success page
|
// Return success page
|
||||||
Html(CALLBACK_HTML.to_string())
|
Html(CALLBACK_HTML.to_string())
|
||||||
|
|
@ -67,7 +66,7 @@ async fn main() -> Result<()> {
|
||||||
.init();
|
.init();
|
||||||
// it is a http server for handling callback
|
// it is a http server for handling callback
|
||||||
// Create channel for receiving authorization code
|
// Create channel for receiving authorization code
|
||||||
let (code_sender, code_receiver) = oneshot::channel::<String>();
|
let (code_sender, code_receiver) = oneshot::channel::<CallbackParams>();
|
||||||
|
|
||||||
// Create app state
|
// Create app state
|
||||||
let app_state = AppState {
|
let app_state = AppState {
|
||||||
|
|
@ -121,14 +120,17 @@ async fn main() -> Result<()> {
|
||||||
|
|
||||||
// Wait for authorization code
|
// Wait for authorization code
|
||||||
tracing::info!("Waiting for authorization code...");
|
tracing::info!("Waiting for authorization code...");
|
||||||
let auth_code = code_receiver
|
let CallbackParams {
|
||||||
|
code: auth_code,
|
||||||
|
state: csrf_token,
|
||||||
|
} = code_receiver
|
||||||
.await
|
.await
|
||||||
.context("Failed to get authorization code")?;
|
.context("Failed to get authorization code")?;
|
||||||
tracing::info!("Received authorization code: {}", auth_code);
|
tracing::info!("Received authorization code: {}", auth_code);
|
||||||
// Exchange code for access token
|
// Exchange code for access token
|
||||||
tracing::info!("Exchanging authorization code for access token...");
|
tracing::info!("Exchanging authorization code for access token...");
|
||||||
oauth_state
|
oauth_state
|
||||||
.handle_callback(&auth_code)
|
.handle_callback(&auth_code, &csrf_token)
|
||||||
.await
|
.await
|
||||||
.context("Failed to handle callback")?;
|
.context("Failed to handle callback")?;
|
||||||
tracing::info!("Successfully obtained access token");
|
tracing::info!("Successfully obtained access token");
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue