Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 22 additions & 4 deletions codex-rs/app-server/src/user_verification_response.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,34 @@
use codex_app_server_protocol::McpServerElicitationAction;
use codex_app_server_protocol::McpServerElicitationRequestResponse;
use codex_app_server_protocol::UserVerificationProof;
use codex_rmcp_client::UserVerificationReason;
use serde::Deserialize;
use tokio::sync::oneshot;

use crate::outgoing_message::ClientRequestResult;
use crate::server_request_error::is_turn_transition_server_request_error;

pub(crate) fn from_client_result(
result: Result<ClientRequestResult, oneshot::error::RecvError>,
) -> McpServerElicitationRequestResponse {
let response = result.ok().and_then(Result::ok).and_then(|value| {
serde_json::from_value::<McpServerElicitationRequestResponse>(value).ok()
});
let mut reason = UserVerificationReason::InvalidResponse;
let response = match result {
Ok(Ok(value)) => serde_json::from_value::<McpServerElicitationRequestResponse>(value).ok(),
Ok(Err(error)) => {
reason = if is_turn_transition_server_request_error(&error) {
UserVerificationReason::Interrupted
} else {
UserVerificationReason::ResponseError
};
None
}
Err(_) => {
reason = UserVerificationReason::ResponseChannelClosed;
None
}
};
if let Some(mut response) = response {
let client_reason = UserVerificationReason::from_meta(response.meta.as_ref());
response.meta = None;
match response.action {
McpServerElicitationAction::Accept => {
Expand All @@ -26,17 +42,19 @@ pub(crate) fn from_client_result(
// The MCP boundary validates the encoded proof and size limits.
return response;
}
reason = UserVerificationReason::InvalidProof;
}
McpServerElicitationAction::Decline | McpServerElicitationAction::Cancel => {
response.content = None;
response.meta = client_reason.map(UserVerificationReason::into_meta);
return response;
}
}
}
McpServerElicitationRequestResponse {
action: McpServerElicitationAction::Cancel,
content: None,
meta: None,
meta: Some(reason.into_meta()),
}
}

Expand Down
74 changes: 69 additions & 5 deletions codex-rs/app-server/src/user_verification_response_tests.rs
Original file line number Diff line number Diff line change
Expand Up @@ -19,18 +19,82 @@ fn accepted_device_proof_uses_existing_content_and_discards_metadata() {

#[test]
fn invalid_response_or_accept_without_proof_cancels() {
for response in [
json!({"invalid": "response"}),
json!({"action": "accept", "content": null, "_meta": null}),
json!({"action": "accept", "content": {}, "_meta": null}),
for (response, reason) in [
(json!({"invalid": "response"}), "invalidResponse"),
(
json!({"action": "accept", "content": null, "_meta": null}),
"invalidProof",
),
(
json!({"action": "accept", "content": {}, "_meta": null}),
"invalidProof",
),
] {
assert_eq!(
from_client_result(Ok(Ok(response))),
McpServerElicitationRequestResponse {
action: McpServerElicitationAction::Cancel,
content: None,
meta: None,
meta: Some(json!({"openai/userVerificationReason": reason})),
}
);
}
}

#[test]
fn terminal_response_keeps_only_a_known_reason() {
for (input, expected) in [
(
json!({"openai/userVerificationReason": "timeout", "secret": "discard"}),
Some(json!({"openai/userVerificationReason": "timeout"})),
),
(
json!({"openai/userVerificationReason": "arbitrary secret"}),
None,
),
(json!(null), None),
] {
assert_eq!(
from_client_result(Ok(Ok(
json!({"action": "cancel", "content": {"signature": "discard"}, "_meta": input})
))),
McpServerElicitationRequestResponse {
action: McpServerElicitationAction::Cancel,
content: None,
meta: expected
}
);
}
}

#[tokio::test]
async fn runtime_failures_keep_their_reason_without_error_text() {
for (data, reason) in [
(Some(json!({"reason": "turnTransition"})), "interrupted"),
(None, "responseError"),
] {
let response = from_client_result(Ok(Err(codex_app_server_protocol::JSONRPCErrorError {
code: -1,
message: "private error details".into(),
data,
})));
assert_eq!(
response,
McpServerElicitationRequestResponse {
action: McpServerElicitationAction::Cancel,
content: None,
meta: Some(json!({"openai/userVerificationReason": reason}))
}
);
}
let (sender, receiver) = oneshot::channel();
drop(sender);
assert_eq!(
from_client_result(receiver.await),
McpServerElicitationRequestResponse {
action: McpServerElicitationAction::Cancel,
content: None,
meta: Some(json!({"openai/userVerificationReason": "responseChannelClosed"}))
}
);
}
5 changes: 4 additions & 1 deletion codex-rs/codex-mcp/src/elicitation.rs
Original file line number Diff line number Diff line change
Expand Up @@ -460,7 +460,10 @@ impl ElicitationRequestManager {
return Ok(ElicitationResponse {
action: ElicitationAction::Cancel,
content: None,
meta: None,
meta: Some(
codex_rmcp_client::UserVerificationReason::ApprovalUnavailable
.into_meta(),
),
});
}
return user_verification_elicitation::route(
Expand Down
6 changes: 3 additions & 3 deletions codex-rs/codex-mcp/src/elicitation_tests.rs
Original file line number Diff line number Diff line change
Expand Up @@ -982,7 +982,7 @@ async fn user_verification_cancels_when_no_app_can_receive_the_request() {
ElicitationResponse {
action: ElicitationAction::Cancel,
content: None,
meta: None
meta: Some(json!({"openai/userVerificationReason": "approvalUnavailable"}))
},
);
}
Expand Down Expand Up @@ -1016,7 +1016,7 @@ async fn user_verification_cancels_for_an_event_receiver_without_host_activation
ElicitationResponse {
action: ElicitationAction::Cancel,
content: None,
meta: None,
meta: Some(json!({"openai/userVerificationReason": "approvalUnavailable"})),
},
);
assert!(events.try_recv().is_err());
Expand Down Expand Up @@ -1099,7 +1099,7 @@ async fn user_verification_rejects_attached_servers_even_if_they_use_the_plugin_
ElicitationResponse {
action: ElicitationAction::Cancel,
content: None,
meta: None
meta: Some(json!({"openai/userVerificationReason": "approvalUnavailable"}))
},
);
assert!(events.try_recv().is_err());
Expand Down
2 changes: 1 addition & 1 deletion codex-rs/codex-mcp/src/user_verification_elicitation.rs
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ pub(super) async fn route(
return Ok(ElicitationResponse {
action: ElicitationAction::Cancel,
content: None,
meta: None,
meta: Some(codex_rmcp_client::UserVerificationReason::ApprovalUnavailable.into_meta()),
});
};
router
Expand Down
13 changes: 10 additions & 3 deletions codex-rs/rmcp-client/src/elicitation_client_service.rs
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,14 @@ impl ElicitationClientService {
return Ok(ElicitationResponse {
action: ElicitationAction::Cancel,
content: None,
meta: None,
meta: user_verification.then(|| {
if cancellations.saturated {
crate::UserVerificationReason::ApprovalUnavailable
} else {
crate::UserVerificationReason::Interrupted
}
.into_meta()
}),
});
}
cancellations.pending.insert(id.clone(), cancel_tx);
Expand All @@ -167,14 +174,14 @@ impl ElicitationClientService {
return Ok(ElicitationResponse {
action: ElicitationAction::Cancel,
content: None,
meta: None,
meta: user_verification.then(|| crate::UserVerificationReason::Interrupted.into_meta()),
});
}
_ = cancel_rx => {
return Ok(ElicitationResponse {
action: ElicitationAction::Cancel,
content: None,
meta: None,
meta: user_verification.then(|| crate::UserVerificationReason::Interrupted.into_meta()),
});
}
response = (self.send_elicitation)(id, request) => response,
Expand Down
1 change: 1 addition & 0 deletions codex-rs/rmcp-client/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -101,3 +101,4 @@ pub use startup_error::is_authentication_required_error;
pub use stdio_server_launcher::ExecutorStdioServerLauncher;
pub use stdio_server_launcher::LocalStdioServerLauncher;
pub use stdio_server_launcher::StdioServerLauncher;
pub use user_verification::UserVerificationReason;
44 changes: 42 additions & 2 deletions codex-rs/rmcp-client/src/user_verification.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,45 @@ use base64::engine::general_purpose::URL_SAFE_NO_PAD;
use rmcp::model::CustomRequest;
use rmcp::model::ElicitationAction;
use serde::Deserialize;
use serde::Serialize;

use crate::rmcp_client::Elicitation;
use crate::rmcp_client::ElicitationResponse;

pub(crate) const MODE: &str = "openai/userVerification";

/// Bounded diagnostic reason only; never a proof or an authorization decision.
#[derive(Clone, Copy, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub enum UserVerificationReason {
UserCancelled,
UserDeclined,
CredentialMissing,
BiometricsUnavailable,
ProviderUnavailable,
AuthenticationFailed,
Timeout,
ProviderError,
ServiceError,
InvalidParams,
InvalidProof,
InvalidResponse,
ResponseError,
ResponseChannelClosed,
Interrupted,
ApprovalUnavailable,
}

impl UserVerificationReason {
pub fn from_meta(meta: Option<&serde_json::Value>) -> Option<Self> {
Self::deserialize(meta?.get("openai/userVerificationReason")?).ok()
}

pub fn into_meta(self) -> serde_json::Value {
serde_json::json!({"openai/userVerificationReason": self})
}
}

#[derive(Deserialize)]
#[serde(rename_all = "camelCase", deny_unknown_fields)]
struct RequestParams {
Expand Down Expand Up @@ -53,6 +86,7 @@ pub(crate) fn parse_request(request: CustomRequest) -> Result<Elicitation, rmcp:

/// Accept only a bounded proof, and never return proof material for cancellation or rejection.
pub(crate) fn validate_response(mut response: ElicitationResponse) -> ElicitationResponse {
let reason = UserVerificationReason::from_meta(response.meta.as_ref());
response.meta = None;
match response.action {
ElicitationAction::Accept => {
Expand All @@ -69,9 +103,15 @@ pub(crate) fn validate_response(mut response: ElicitationResponse) -> Elicitatio
}
tracing::warn!("user-verification acceptance omitted a valid proof; cancelling");
response.action = ElicitationAction::Cancel;
response.meta = Some(UserVerificationReason::InvalidProof.into_meta());
}
ElicitationAction::Decline | ElicitationAction::Cancel => {
response.meta = reason.map(UserVerificationReason::into_meta);
}
_ => {
response.action = ElicitationAction::Cancel;
response.meta = Some(UserVerificationReason::InvalidResponse.into_meta());
}
ElicitationAction::Decline | ElicitationAction::Cancel => {}
_ => response.action = ElicitationAction::Cancel,
}
response.content = None;
response
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -369,7 +369,10 @@ async fn cancelling_one_verification_leaves_the_mcp_connection_and_other_request
anyhow::bail!("expected a cancellation response");
};
assert_eq!(cancel.id, first_id);
assert_eq!(serde_json::to_value(cancel.result)?["action"], "cancel");
assert_eq!(
serde_json::to_value(cancel.result)?,
json!({"action": "cancel", "_meta": {"openai/userVerificationReason": "interrupted"}})
);

for request_id in [first_id, RequestId::Number(999)] {
server
Expand Down
11 changes: 9 additions & 2 deletions codex-rs/rmcp-client/src/user_verification_dispatch_tests.rs
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,9 @@ async fn user_verification_remembers_cancellation_before_request_handler_runs()
assert_eq!(
serde_json::to_value(response)?,
json!({
"jsonrpc": "2.0", "id": 1, "result": {"action": "cancel"}
"jsonrpc": "2.0", "id": 1, "result": {
"action": "cancel", "_meta": {"openai/userVerificationReason": "interrupted"}
}
})
);
assert!(
Expand Down Expand Up @@ -159,7 +161,12 @@ async fn user_verification_early_cancellation_storage_fails_closed_at_capacity()
})))),
RequestContext::new(RequestId::Number(5000), client.peer().clone()),
).await?;
assert_eq!(serde_json::to_value(response)?, json!({"action": "cancel"}));
assert_eq!(
serde_json::to_value(response)?,
json!({
"action": "cancel", "_meta": {"openai/userVerificationReason": "approvalUnavailable"}
})
);
// Ordinary requests still work after verification fails closed.
server
.send(serde_json::from_value::<ServerJsonRpcMessage>(json!({
Expand Down
10 changes: 6 additions & 4 deletions codex-rs/rmcp-client/src/user_verification_tests.rs
Original file line number Diff line number Diff line change
Expand Up @@ -131,12 +131,12 @@ fn user_verification_cancels_acceptance_without_a_valid_bounded_proof() {
validate_response(ElicitationResponse {
action: ElicitationAction::Accept,
content,
meta: None,
meta: Some(json!({"openai/userVerificationReason": "userCancelled"})),
}),
ElicitationResponse {
action: ElicitationAction::Cancel,
content: None,
meta: None,
meta: Some(json!({"openai/userVerificationReason": "invalidProof"})),
}
);
}
Expand All @@ -149,12 +149,14 @@ fn user_verification_decline_and_cancel_discard_proof_material() {
validate_response(ElicitationResponse {
action: action.clone(),
content: Some(json!({"credentialId": "AQID", "signature": "BAUG"})),
meta: Some(json!({"secret": "discarded"})),
meta: Some(
json!({"secret": "discarded", "openai/userVerificationReason": "timeout"})
),
}),
ElicitationResponse {
action,
content: None,
meta: None
meta: Some(json!({"openai/userVerificationReason": "timeout"}))
}
);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,10 @@ async fn native_mrtr_returns_validated_proof_or_cancellation_in_content() -> any
(
ElicitationAction::Accept,
json!({"signature": "invalid"}),
json!({"action": "cancel"}),
json!({
"action": "cancel",
"_meta": {"openai/userVerificationReason": "invalidProof"},
}),
),
] {
let server = MockServer::start().await;
Expand Down
Loading
Loading