summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatt Mastracci <matthew@mastracci.com>2024-04-02 15:55:06 -0600
committerGitHub <noreply@github.com>2024-04-02 15:55:06 -0600
commit3b9fd1af804e4fe534798ec2d7da440d97ba610c (patch)
tree0719c35c46a4d1210dcb48f8b69304744ca2fcc0
parentcc4ede41a7d39e318d18d3bccf797d232a5b286a (diff)
fix(cli): Enforce a human delay in prompt to fix paste problem (#23184)
The permission prompt doesn't wait for quiescent input, so someone pasting a large text file into the console may end up losing the prompt. We enforce a minimum human delay and wait for a 100ms quiescent period before we write and accept prompt input to avoid this problem. This does require adding a human delay in all prompt tests, but that's pretty straightforward. I rewrote the locked stdout/stderr test while I was in here.
-rw-r--r--runtime/permissions/prompter.rs64
-rw-r--r--tests/integration/run_tests.rs113
-rw-r--r--tests/testdata/run/stdio_streams_are_locked_in_permission_prompt/worker.js3
-rw-r--r--tests/util/server/src/pty.rs23
4 files changed, 140 insertions, 63 deletions
diff --git a/runtime/permissions/prompter.rs b/runtime/permissions/prompter.rs
index da5979f0a..f75fe466a 100644
--- a/runtime/permissions/prompter.rs
+++ b/runtime/permissions/prompter.rs
@@ -91,16 +91,58 @@ pub trait PermissionPrompter: Send + Sync {
}
pub struct TtyPrompter;
-
#[cfg(unix)]
fn clear_stdin(
_stdin_lock: &mut StdinLock,
_stderr_lock: &mut StderrLock,
) -> Result<(), AnyError> {
- // TODO(bartlomieju):
- #[allow(clippy::undocumented_unsafe_blocks)]
- let r = unsafe { libc::tcflush(0, libc::TCIFLUSH) };
- assert_eq!(r, 0);
+ use deno_core::anyhow::bail;
+ use std::mem::MaybeUninit;
+
+ const STDIN_FD: i32 = 0;
+
+ // SAFETY: use libc to flush stdin
+ unsafe {
+ // Create fd_set for select
+ let mut raw_fd_set = MaybeUninit::<libc::fd_set>::uninit();
+ libc::FD_ZERO(raw_fd_set.as_mut_ptr());
+ libc::FD_SET(STDIN_FD, raw_fd_set.as_mut_ptr());
+
+ loop {
+ let r = libc::tcflush(STDIN_FD, libc::TCIFLUSH);
+ if r != 0 {
+ bail!("clear_stdin failed (tcflush)");
+ }
+
+ // Initialize timeout for select to be 100ms
+ let mut timeout = libc::timeval {
+ tv_sec: 0,
+ tv_usec: 100_000,
+ };
+
+ // Call select with the stdin file descriptor set
+ let r = libc::select(
+ STDIN_FD + 1, // nfds should be set to the highest-numbered file descriptor in any of the three sets, plus 1.
+ raw_fd_set.as_mut_ptr(),
+ std::ptr::null_mut(),
+ std::ptr::null_mut(),
+ &mut timeout,
+ );
+
+ // Check if select returned an error
+ if r < 0 {
+ bail!("clear_stdin failed (select)");
+ }
+
+ // Check if select returned due to timeout (stdin is quiescent)
+ if r == 0 {
+ break; // Break out of the loop as stdin is quiescent
+ }
+
+ // If select returned due to data available on stdin, clear it by looping around to flush
+ }
+ }
+
Ok(())
}
@@ -291,9 +333,17 @@ impl PermissionPrompter for TtyPrompter {
}
let value = loop {
+ // Clear stdin each time we loop around in case the user accidentally pasted
+ // multiple lines or otherwise did something silly to generate a torrent of
+ // input.
+ if let Err(err) = clear_stdin(&mut stdin_lock, &mut stderr_lock) {
+ eprintln!("Error clearing stdin for permission prompt. {err:#}");
+ return PromptResponse::Deny; // don't grant permission if this fails
+ }
+
let mut input = String::new();
let result = stdin_lock.read_line(&mut input);
- if result.is_err() {
+ if result.is_err() || input.len() > 2 {
break PromptResponse::Deny;
};
let ch = match input.chars().next() {
@@ -310,7 +360,7 @@ impl PermissionPrompter for TtyPrompter {
writeln!(stderr_lock, "✅ {}", colors::bold(&msg)).unwrap();
break PromptResponse::Allow;
}
- 'n' | 'N' => {
+ 'n' | 'N' | '\x1b' => {
clear_n_lines(
&mut stderr_lock,
if api_name.is_some() { 4 } else { 3 },
diff --git a/tests/integration/run_tests.rs b/tests/integration/run_tests.rs
index 59163bfe8..31596c1bb 100644
--- a/tests/integration/run_tests.rs
+++ b/tests/integration/run_tests.rs
@@ -9,7 +9,6 @@ use std::io::Read;
use std::io::Write;
use std::process::Command;
use std::process::Stdio;
-use std::time::Duration;
use test_util as util;
use test_util::itest;
use test_util::TempDir;
@@ -513,6 +512,7 @@ fn _090_run_permissions_request() {
"├ Run again with --allow-run to bypass this prompt.\r\n",
"└ Allow? [y/n/A] (y = yes, allow; n = no, deny; A = allow all run permissions)",
));
+ console.human_delay();
console.write_line_raw("y");
console.expect("Granted run access to \"ls\".");
console.expect(concat!(
@@ -521,6 +521,7 @@ fn _090_run_permissions_request() {
"├ Run again with --allow-run to bypass this prompt.\r\n",
"└ Allow? [y/n/A] (y = yes, allow; n = no, deny; A = allow all run permissions)",
));
+ console.human_delay();
console.write_line_raw("n");
console.expect("Denied run access to \"cat\".");
console.expect("granted");
@@ -540,6 +541,7 @@ fn _090_run_permissions_request_sync() {
"├ Run again with --allow-run to bypass this prompt.\r\n",
"└ Allow? [y/n/A] (y = yes, allow; n = no, deny; A = allow all run permissions)",
));
+ console.human_delay();
console.write_line_raw("y");
console.expect("Granted run access to \"ls\".");
console.expect(concat!(
@@ -548,6 +550,7 @@ fn _090_run_permissions_request_sync() {
"├ Run again with --allow-run to bypass this prompt.\r\n",
"└ Allow? [y/n/A] (y = yes, allow; n = no, deny; A = allow all run permissions)",
));
+ console.human_delay();
console.write_line_raw("n");
console.expect("Denied run access to \"cat\".");
console.expect("granted");
@@ -568,6 +571,7 @@ fn permissions_prompt_allow_all() {
"├ Run again with --allow-run to bypass this prompt.\r\n",
"└ Allow? [y/n/A] (y = yes, allow; n = no, deny; A = allow all run permissions)",
));
+ console.human_delay();
console.write_line_raw("A");
console.expect("✅ Granted all run access.");
// "read" permissions
@@ -577,6 +581,7 @@ fn permissions_prompt_allow_all() {
"├ Run again with --allow-read to bypass this prompt.\r\n",
"└ Allow? [y/n/A] (y = yes, allow; n = no, deny; A = allow all read permissions)",
));
+ console.human_delay();
console.write_line_raw("A");
console.expect("✅ Granted all read access.");
// "write" permissions
@@ -586,6 +591,7 @@ fn permissions_prompt_allow_all() {
"├ Run again with --allow-write to bypass this prompt.\r\n",
"└ Allow? [y/n/A] (y = yes, allow; n = no, deny; A = allow all write permissions)",
));
+ console.human_delay();
console.write_line_raw("A");
console.expect("✅ Granted all write access.");
// "net" permissions
@@ -595,7 +601,8 @@ fn permissions_prompt_allow_all() {
"├ Run again with --allow-net to bypass this prompt.\r\n",
"└ Allow? [y/n/A] (y = yes, allow; n = no, deny; A = allow all net permissions)",
));
- console.write_line_raw("A\n");
+ console.human_delay();
+ console.write_line_raw("A");
console.expect("✅ Granted all net access.");
// "env" permissions
console.expect(concat!(
@@ -604,7 +611,8 @@ fn permissions_prompt_allow_all() {
"├ Run again with --allow-env to bypass this prompt.\r\n",
"└ Allow? [y/n/A] (y = yes, allow; n = no, deny; A = allow all env permissions)",
));
- console.write_line_raw("A\n");
+ console.human_delay();
+ console.write_line_raw("A");
console.expect("✅ Granted all env access.");
// "sys" permissions
console.expect(concat!(
@@ -613,7 +621,8 @@ fn permissions_prompt_allow_all() {
"├ Run again with --allow-sys to bypass this prompt.\r\n",
"└ Allow? [y/n/A] (y = yes, allow; n = no, deny; A = allow all sys permissions)",
));
- console.write_line_raw("A\n");
+ console.human_delay();
+ console.write_line_raw("A");
console.expect("✅ Granted all sys access.");
// "ffi" permissions
console.expect(concat!(
@@ -622,7 +631,8 @@ fn permissions_prompt_allow_all() {
"├ Run again with --allow-ffi to bypass this prompt.\r\n",
"└ Allow? [y/n/A] (y = yes, allow; n = no, deny; A = allow all ffi permissions)",
));
- console.write_line_raw("A\n");
+ console.human_delay();
+ console.write_line_raw("A");
console.expect("✅ Granted all ffi access.")
},
);
@@ -640,6 +650,7 @@ fn permissions_prompt_allow_all_2() {
"├ Run again with --allow-env to bypass this prompt.\r\n",
"└ Allow? [y/n/A] (y = yes, allow; n = no, deny; A = allow all env permissions)",
));
+ console.human_delay();
console.write_line_raw("A");
console.expect("✅ Granted all env access.");
@@ -650,6 +661,7 @@ fn permissions_prompt_allow_all_2() {
"├ Run again with --allow-sys to bypass this prompt.\r\n",
"└ Allow? [y/n/A] (y = yes, allow; n = no, deny; A = allow all sys permissions)",
));
+ console.human_delay();
console.write_line_raw("A");
console.expect("✅ Granted all sys access.");
@@ -660,6 +672,7 @@ fn permissions_prompt_allow_all_2() {
"├ Run again with --allow-read to bypass this prompt.\r\n",
"└ Allow? [y/n/A] (y = yes, allow; n = no, deny; A = allow all read permissions)",
));
+ console.human_delay();
console.write_line_raw("A");
console.expect("✅ Granted all read access.");
});
@@ -678,6 +691,7 @@ fn permissions_prompt_allow_all_lowercase_a() {
"├ Run again with --allow-run to bypass this prompt.\r\n",
"└ Allow? [y/n/A] (y = yes, allow; n = no, deny; A = allow all run permissions)",
));
+ console.human_delay();
console.write_line_raw("a");
console.expect("Unrecognized option.");
});
@@ -720,6 +734,7 @@ fn permissions_cache() {
"├ Run again with --allow-read to bypass this prompt.\r\n",
"└ Allow? [y/n/A] (y = yes, allow; n = no, deny; A = allow all read permissions)",
));
+ console.human_delay();
console.write_line_raw("y");
console.expect("✅ Granted read access to \"foo\".");
console.expect("granted");
@@ -2969,6 +2984,7 @@ mod permissions {
"├ Run again with --allow-read to bypass this prompt.\r\n",
"└ Allow? [y/n/A] (y = yes, allow; n = no, deny; A = allow all read permissions)",
));
+ console.human_delay();
console.write_line_raw("y");
console.expect(concat!(
"┌ ⚠️ Deno requests read access to \"bar\".\r\n",
@@ -2976,6 +2992,7 @@ mod permissions {
"├ Run again with --allow-read to bypass this prompt.\r\n",
"└ Allow? [y/n/A] (y = yes, allow; n = no, deny; A = allow all read permissions)",
));
+ console.human_delay();
console.write_line_raw("n");
console.expect("granted");
console.expect("prompt");
@@ -2995,6 +3012,7 @@ mod permissions {
"├ Run again with --allow-read to bypass this prompt.\r\n",
"└ Allow? [y/n/A] (y = yes, allow; n = no, deny; A = allow all read permissions)",
));
+ console.human_delay();
console.write_line_raw("y");
console.expect(concat!(
"┌ ⚠️ Deno requests read access to \"bar\".\r\n",
@@ -3002,6 +3020,7 @@ mod permissions {
"├ Run again with --allow-read to bypass this prompt.\r\n",
"└ Allow? [y/n/A] (y = yes, allow; n = no, deny; A = allow all read permissions)",
));
+ console.human_delay();
console.write_line_raw("n");
console.expect("granted");
console.expect("prompt");
@@ -3021,6 +3040,7 @@ mod permissions {
"├ Run again with --allow-read to bypass this prompt.\r\n",
"└ Allow? [y/n/A] (y = yes, allow; n = no, deny; A = allow all read permissions)",
));
+ console.human_delay();
console.write_line_raw("y\n");
console
.expect("PermissionStatus { state: \"granted\", onchange: null }");
@@ -3043,6 +3063,7 @@ mod permissions {
"├ Run again with --allow-read to bypass this prompt.\r\n",
"└ Allow? [y/n/A] (y = yes, allow; n = no, deny; A = allow all read permissions)",
));
+ console.human_delay();
console.write_line_raw("y");
console
.expect("PermissionStatus { state: \"granted\", onchange: null }");
@@ -3184,6 +3205,7 @@ fn issue9750() {
"├ Run again with --allow-env to bypass this prompt.\r\n",
"└ Allow? [y/n/A] (y = yes, allow; n = no, deny; A = allow all env permissions)",
));
+ console.human_delay();
console.write_line_raw("n");
console.expect("Denied env access.");
console.expect(concat!(
@@ -3191,6 +3213,7 @@ fn issue9750() {
"├ Run again with --allow-env to bypass this prompt.\r\n",
"└ Allow? [y/n/A] (y = yes, allow; n = no, deny; A = allow all env permissions)",
));
+ console.human_delay();
console.write_line_raw("n");
console.expect_all(&[
"Denied env access to \"SECRET\".",
@@ -4625,6 +4648,7 @@ fn file_fetcher_preserves_permissions() {
"const a = await import('http://localhost:4545/run/019_media_types.ts');",
);
console.expect("Allow?");
+ console.human_delay();
console.write_line_raw("y");
console.expect_all(&["success", "true"]);
});
@@ -4638,56 +4662,39 @@ fn stdio_streams_are_locked_in_permission_prompt() {
return;
}
- let context = TestContextBuilder::new()
- .use_http_server()
- .use_copy_temp_dir("run/stdio_streams_are_locked_in_permission_prompt")
- .build();
- let mut passed_test = false;
- let mut i = 0;
- while !passed_test {
- i += 1;
- if i > 5 {
- panic!("Output happened before permission prompt too many times");
- }
+ let context = TestContextBuilder::new().build();
- context
- .new_command()
- .args("repl --allow-read")
- .with_pty(|mut console| {
- let malicious_output = r#"Are you sure you want to continue?"#;
-
- console.write_line(r#"const url = "file://" + Deno.cwd().replace("\\", "/") + "/run/stdio_streams_are_locked_in_permission_prompt/worker.js";"#);
- console.expect("undefined");
- // ensure this file exists
- console.write_line(r#"const _file = Deno.readTextFileSync("./run/stdio_streams_are_locked_in_permission_prompt/worker.js");"#);
- console.expect("undefined");
- console.write_line(r#"new Worker(url, { type: "module" }); await Deno.writeTextFile("./text.txt", "some code");"#);
- console.expect("Allow? [y/n/A] (y = yes, allow; n = no, deny; A = allow all write permissions)");
-
- // Due to the main thread being slow, it may occur that the worker thread outputs
- // before the permission prompt is shown. This is not a bug and just a timing issue
- // when dealing with multiple threads. If this occurs, detect such a case and then
- // retry running the test.
- if let Some(malicious_index) = console.all_output().find(malicious_output) {
- let prompt_index = console.all_output().find("Allow?").unwrap();
- // Ensure the malicious output is shown before the prompt as we
- // expect in this scenario. If not, that would indicate a bug.
- assert!(malicious_index < prompt_index);
- return;
- }
-
- std::thread::sleep(Duration::from_millis(50)); // give the other thread some time to output
- console.write_line_raw("invalid");
- console.expect("Unrecognized option.");
- console.expect("Allow? [y/n/A] (y = yes, allow; n = no, deny; A = allow all write permissions)");
- console.write_line_raw("y");
- console.expect("Granted write access to");
+ context
+ .new_command()
+ .args("repl")
+ .with_pty(|mut console| {
+ let malicious_output = r#"**malicious**"#;
+
+ // Start a worker that starts spamming stdout
+ console.write_line(r#"new Worker(URL.createObjectURL(new Blob(["setInterval(() => console.log('**malicious**'), 10)"])), { type: "module" });"#);
+ // The worker is now spamming
+ console.expect(malicious_output);
+ console.write_line(r#"Deno.readTextFileSync('Cargo.toml');"#);
+ // We will get a permission prompt
+ console.expect("Allow? [y/n/A] (y = yes, allow; n = no, deny; A = allow all read permissions) > ");
+ // The worker is blocked, so nothing else should get written here
+ console.human_delay();
+ console.write_line_raw("i");
+ // We ensure that nothing gets written here between the permission prompt and this text, despire the delay
+ let newline = if cfg!(target_os = "linux") {
+ "^J"
+ } else {
+ "\r\n"
+ };
+ console.expect_raw_next(format!("i{newline}\u{1b}[1A\u{1b}[0J└ Unrecognized option. Allow? [y/n/A] (y = yes, allow; n = no, deny; A = allow all read permissions) > "));
+ console.human_delay();
+ console.write_line_raw("y");
+ // We ensure that nothing gets written here between the permission prompt and this text, despire the delay
+ console.expect_raw_next(format!("y{newline}\x1b[4A\x1b[0J✅ Granted read access to \"Cargo.toml\"."));
- // this output should now be shown below and not above
- console.expect(malicious_output);
- passed_test = true;
- });
- }
+ // Back to spamming!
+ console.expect(malicious_output);
+ });
}
#[test]
diff --git a/tests/testdata/run/stdio_streams_are_locked_in_permission_prompt/worker.js b/tests/testdata/run/stdio_streams_are_locked_in_permission_prompt/worker.js
deleted file mode 100644
index 287027c83..000000000
--- a/tests/testdata/run/stdio_streams_are_locked_in_permission_prompt/worker.js
+++ /dev/null
@@ -1,3 +0,0 @@
-setTimeout(() => {
- console.log("Are you sure you want to continue?");
-}, 10); // ensure we don't output too quickly before the permission prompt
diff --git a/tests/util/server/src/pty.rs b/tests/util/server/src/pty.rs
index 3e3331b84..9b2a5eb5d 100644
--- a/tests/util/server/src/pty.rs
+++ b/tests/util/server/src/pty.rs
@@ -77,6 +77,12 @@ impl Pty {
self.pty.flush().unwrap();
}
+ /// Pause for a human-like delay to read or react to something (human responses are ~100ms).
+ #[track_caller]
+ pub fn human_delay(&mut self) {
+ std::thread::sleep(Duration::from_millis(250));
+ }
+
#[track_caller]
pub fn write_line(&mut self, line: impl AsRef<str>) {
self.write_line_raw(&line);
@@ -161,6 +167,23 @@ impl Pty {
});
}
+ /// Expects the raw text to be found next.
+ #[track_caller]
+ pub fn expect_raw_next(&mut self, text: impl AsRef<str>) {
+ let expected = text.as_ref();
+ let last_index = self.read_bytes.len();
+ self.read_until_condition(|pty| {
+ if pty.read_bytes.len() >= last_index + expected.len() {
+ let data = String::from_utf8_lossy(
+ &pty.read_bytes[last_index..last_index + expected.len()],
+ );
+ data == expected
+ } else {
+ false
+ }
+ });
+ }
+
pub fn all_output(&self) -> Cow<str> {
String::from_utf8_lossy(&self.read_bytes)
}