feat(app-server): allow configured websocket query token

This commit is contained in:
mikhail-oai
2026-07-01 18:57:30 -04:00
parent d46eb761b5
commit f044742bc8
2 changed files with 46 additions and 2 deletions
@@ -29,6 +29,7 @@ const DEFAULT_MAX_CLOCK_SKEW_SECONDS: u64 = 30;
const GENERATED_QUERY_TOKEN_BYTES: usize = 32;
const MIN_SIGNED_BEARER_SECRET_BYTES: usize = 32;
const INVALID_AUTHORIZATION_HEADER_MESSAGE: &str = "invalid authorization header";
const REMOTE_WS_TOKEN_ENV_VAR: &str = "CODEX_REMOTE_WS_TOKEN";
#[derive(Debug, Clone, Default, PartialEq, Eq, Args)]
pub struct AppServerWebsocketAuthArgs {
@@ -373,6 +374,17 @@ impl WebsocketAuthPolicy {
}
fn generate_query_token() -> io::Result<String> {
match std::env::var(REMOTE_WS_TOKEN_ENV_VAR) {
Ok(token) => return Ok(token),
Err(std::env::VarError::NotPresent) => {}
Err(std::env::VarError::NotUnicode(_)) => {
return Err(io::Error::new(
ErrorKind::InvalidData,
format!("{REMOTE_WS_TOKEN_ENV_VAR} must contain valid Unicode"),
));
}
}
let mut bytes = [0_u8; GENERATED_QUERY_TOKEN_BYTES];
let mut rng = OsRng;
rng.try_fill_bytes(&mut bytes)
@@ -185,6 +185,34 @@ async fn websocket_transport_requires_generated_query_token() -> Result<()> {
Ok(())
}
#[tokio::test]
async fn websocket_transport_uses_remote_ws_token() -> Result<()> {
let server = create_mock_responses_server_sequence_unchecked(Vec::new()).await;
let codex_home = TempDir::new()?;
create_config_toml(codex_home.path(), &server.uri(), "never")?;
let expected_token = "configured-remote-ws-token";
let (mut process, bind_addr, token) = spawn_websocket_server_and_read_generated_token(
codex_home.path(),
"ws://127.0.0.1:0",
&[],
&[("CODEX_REMOTE_WS_TOKEN", expected_token)],
)
.await?;
assert_eq!(token.as_deref(), Some(expected_token));
let mut ws = connect_websocket_with_query_token(bind_addr, expected_token).await?;
send_initialize_request(&mut ws, /*id*/ 1, "ws_remote_token_client").await?;
let init = read_response_for_id(&mut ws, /*id*/ 1).await?;
assert_eq!(init.id, RequestId::Integer(1));
process
.kill()
.await
.context("failed to stop websocket app-server process")?;
Ok(())
}
#[tokio::test]
async fn websocket_transport_no_token_check_accepts_invalid_tokens() -> Result<()> {
let server = create_mock_responses_server_sequence_unchecked(Vec::new()).await;
@@ -452,7 +480,8 @@ pub(super) async fn spawn_websocket_server_with_args(
extra_args: &[String],
) -> Result<(Child, SocketAddr)> {
let (process, bind_addr, _token) =
spawn_websocket_server_and_read_generated_token(codex_home, listen_url, extra_args).await?;
spawn_websocket_server_and_read_generated_token(codex_home, listen_url, extra_args, &[])
.await?;
Ok((process, bind_addr))
}
@@ -462,7 +491,8 @@ async fn spawn_websocket_server_with_generated_token(
extra_args: &[String],
) -> Result<(Child, SocketAddr, String)> {
let (process, bind_addr, token) =
spawn_websocket_server_and_read_generated_token(codex_home, listen_url, extra_args).await?;
spawn_websocket_server_and_read_generated_token(codex_home, listen_url, extra_args, &[])
.await?;
let token = token.context("websocket app-server did not print a generated query token")?;
Ok((process, bind_addr, token))
}
@@ -471,6 +501,7 @@ async fn spawn_websocket_server_and_read_generated_token(
codex_home: &Path,
listen_url: &str,
extra_args: &[String],
extra_env: &[(&str, &str)],
) -> Result<(Child, SocketAddr, Option<String>)> {
let program = codex_utils_cargo_bin::cargo_bin("codex-app-server")
.context("should find app-server binary")?;
@@ -483,6 +514,7 @@ async fn spawn_websocket_server_and_read_generated_token(
.stdout(Stdio::null())
.stderr(Stdio::piped())
.env("CODEX_HOME", codex_home)
.envs(extra_env.iter().copied())
.env("RUST_LOG", "warn");
let mut process = cmd
.kill_on_drop(true)