Skip to content

Store the passphrase in a zeroizing buffer instead of a TextEdit #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
domenkozar wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Store the passphrase in a zeroizing buffer instead of a TextEdit #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ exclude = ["CLAUDE.md"]
[dependencies]
eframe = { version = "0.33", default-features = false, features = ["default_fonts", "glow", "wayland", "x11"] }
secrecy = "0.10"
zeroize = "1"

[dev-dependencies]
eframe = { version = "0.33", features = ["accesskit"] }
egui_kittest = "0.33"
accesskit = "0.21"

[profile.release]
strip = true
Expand Down
90 changes: 53 additions & 37 deletions src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ use std::sync::mpsc;

use eframe::egui;
use secrecy::{ExposeSecret, SecretString};
use zeroize::Zeroizing;

fn percent_decode(s: &str) -> String {
let bytes = s.as_bytes();
Expand Down Expand Up @@ -48,9 +49,11 @@ struct PinentryState {

#[derive(Default)]
struct PinDialogState {
password: String,
// Keystrokes are appended here directly (never through an egui `TextEdit`,
// whose retained widget state and undo history would keep the plaintext), and
// the buffer is zeroized on drop. Moved into the `SecretString` on submit.
password: Zeroizing<String>,
submitted: Option<bool>, // Some(true) = OK, Some(false) = Cancel
focus_set: bool,
}

fn pin_dialog_ui(
Expand Down Expand Up @@ -89,20 +92,34 @@ fn pin_dialog_ui(
};
ui.label(prompt);
ui.add_space(4.0);
let response = ui.add_sized(
[ui.available_width(), 28.0],
egui::TextEdit::singleline(&mut dialog.password)
.password(true)
.hint_text("Enter passphrase")
.font(egui::TextStyle::Body),
);
if !dialog.focus_set {
dialog.focus_set = true;
response.request_focus();
}
if response.lost_focus()
&& ui.input(|i| i.key_pressed(egui::Key::Enter))
{

// Feed keystrokes straight into the zeroizing buffer instead of an
// egui `TextEdit`, so the plaintext never enters egui's retained
// widget state or undo history. Only a masked view is drawn.
ui.input(|input| {
for event in &input.events {
match event {
egui::Event::Text(text) | egui::Event::Paste(text) => {
dialog.password.push_str(text);
}
egui::Event::Key {
key: egui::Key::Backspace,
pressed: true,
..
} => {
dialog.password.pop();
}
_ => {}
}
}
});
let dots = "\u{2022}".repeat(dialog.password.chars().count());
egui::Frame::group(ui.style()).show(ui, |ui| {
ui.set_min_width(ui.available_width());
ui.add(egui::Label::new(egui::RichText::new(dots).monospace()));
});

if ui.input(|i| i.key_pressed(egui::Key::Enter)) {
dialog.submitted = Some(true);
}
ui.add_space(12.0);
Expand Down Expand Up @@ -158,10 +175,10 @@ impl eframe::App for PinDialog {
if let Some(ok) = self.dialog.submitted.take() {
if ok {
if self.want_pin {
let _ = self.tx.send(DialogResult::Pin(SecretString::from(
self.dialog.password.clone(),
)));
self.dialog.password.clear();
// Move the inner String out (leaving an empty one) into the
// secret, which zeroizes it in turn.
let value = std::mem::take(&mut *self.dialog.password);
let _ = self.tx.send(DialogResult::Pin(SecretString::from(value)));
} else {
let _ = self.tx.send(DialogResult::Confirmed);
}
Expand Down Expand Up @@ -322,7 +339,7 @@ fn main() {
#[cfg(test)]
mod tests {
use super::*;
use egui_kittest::kittest::{Queryable, NodeT};
use egui_kittest::kittest::Queryable;
use egui_kittest::Harness;

struct TestState {
Expand Down Expand Up @@ -350,45 +367,44 @@ mod tests {
)
}

// The custom masked field is not an accessible widget, so drive it with
// synthetic input events and assert on the resulting buffer/state.
#[test]
fn test_password_field_gets_focus() {
let mut harness = make_harness("Enter your GPG passphrase", true);
fn test_type_password() {
let mut harness = make_harness("Enter passphrase", true);
harness.run();

let ti = harness.get_by_role(accesskit::Role::PasswordInput);
println!("focused: {}, value: {:?}", ti.is_focused(), ti.accesskit_node().value());
assert!(ti.is_focused(), "password field should be auto-focused");
harness.event(egui::Event::Text("secret123".into()));
harness.run();

assert_eq!(harness.state().dialog.password.as_str(), "secret123");
}

#[test]
fn test_type_password() {
fn test_backspace_removes_last_char() {
let mut harness = make_harness("Enter passphrase", true);
harness.run();

let ti = harness.get_by_role(accesskit::Role::PasswordInput);
assert!(ti.is_focused());

ti.type_text("secret123");
harness.event(egui::Event::Text("abc".into()));
harness.run();
harness.key_press(egui::Key::Backspace);
harness.run();

println!("password: {:?}", harness.state().dialog.password);
assert_eq!(harness.state().dialog.password, "secret123");
assert_eq!(harness.state().dialog.password.as_str(), "ab");
}

#[test]
fn test_enter_submits() {
let mut harness = make_harness("Enter passphrase", true);
harness.run();

let ti = harness.get_by_role(accesskit::Role::PasswordInput);
ti.type_text("mypass");
harness.event(egui::Event::Text("mypass".into()));
harness.run();

harness.key_press(egui::Key::Enter);
harness.run();

println!("submitted: {:?}, password: {:?}", harness.state().dialog.submitted, harness.state().dialog.password);
assert_eq!(harness.state().dialog.submitted, Some(true));
assert_eq!(harness.state().dialog.password.as_str(), "mypass");
}


Expand Down