crates/nonstick: src/conv.rs comparison

comparison src/conv.rs @ 93:efc2b56c8928

Remove undefined behavior per MIRI. This replaces a bunch of raw pointers with NonNull and removes all the undefined behavior that we can find with MIRI. We also remove the `SecureString` dependency (since it doesn't work with MIRI, and because it's not really necessary).

author	Paul Fisher <paul@pfish.zone>
date	Mon, 23 Jun 2025 13:02:58 -0400
parents	05291b601f0a
children	db167f96ba46

comparison

equal deleted inserted replaced

-:5ddbcada30f2
+:efc2b56c8928
 // Temporarily allowed until we get the actual conversation functions hooked up.
 #![allow(dead_code)]
 use crate::constants::{ErrorCode, Result};
-use secure_string::SecureString;
 use std::cell::Cell;
 use std::fmt;
+use std::fmt::Debug;
 use std::result::Result as StdResult;
 /// The types of message and request that can be sent to a user.
 ///
 /// The data within each enum value is the prompt (or other information)
 q_and_a!(
 /// A Q&A that asks the user for text and does not show it while typing.
 ///
 /// In other words, a password entry prompt.
-MaskedQAndA<'a, Q=&'a str, A=SecureString>,
+MaskedQAndA<'a, Q=&'a str, A=String>,
 Message::MaskedPrompt
 );
 q_and_a!(
 /// A standard Q&A prompt that asks the user for text.
 ///
 /// For example, to use a `Conversation` as a `SimpleConversation`:
 ///
 /// ```
 /// # use nonstick::{Conversation, Result};
-/// # use secure_string::SecureString;
 /// // Bring this trait into scope to get `masked_prompt`, among others.
 /// use nonstick::SimpleConversation;
 ///
-/// fn ask_for_token(convo: &mut impl Conversation) -> Result<SecureString> {
+/// fn ask_for_token(convo: &mut impl Conversation) -> Result<String> {
 ///     convo.masked_prompt("enter your one-time token")
 /// }
 /// ```
 ///
 /// or to use a `SimpleConversation` as a `Conversation`:
 ///
 /// ```
 /// use nonstick::{Conversation, SimpleConversation};
-/// use secure_string::SecureString;
 /// # use nonstick::{BinaryData, Result};
 /// mod some_library {
 /// #    use nonstick::Conversation;
 ///     pub fn get_auth_data(conv: &mut impl Conversation) { /* ... */
 ///     }
 ///     // ...
 /// # fn prompt(&mut self, request: &str) -> Result<String> {
 /// #     todo!()
 /// # }
 /// #
-/// # fn masked_prompt(&mut self, request: &str) -> Result<SecureString> {
+/// # fn masked_prompt(&mut self, request: &str) -> Result<String> {
 /// #     todo!()
 /// # }
 /// #
 /// # fn error_msg(&mut self, message: &str) {
 /// #     todo!()
 Demux(self)
 }
 /// Prompts the user for something.
 fn prompt(&mut self, request: &str) -> Result<String>;
 /// Prompts the user for something, but hides what the user types.
-fn masked_prompt(&mut self, request: &str) -> Result<SecureString>;
+fn masked_prompt(&mut self, request: &str) -> Result<String>;
 /// Alerts the user to an error.
 fn error_msg(&mut self, message: &str);
 /// Sends an informational message to the user.
 fn info_msg(&mut self, message: &str);
 /// \[Linux extension] Prompts the user for a yes/no/maybe conditional.
 };
 }
 impl<C: Conversation> SimpleConversation for C {
 conv_fn!(prompt(message: &str) -> String { QAndA });
-conv_fn!(masked_prompt(message: &str) -> SecureString { MaskedQAndA } );
+conv_fn!(masked_prompt(message: &str) -> String { MaskedQAndA } );
 conv_fn!(error_msg(message: &str) { ErrorMsg });
 conv_fn!(info_msg(message: &str) { InfoMsg });
 conv_fn!(radio_prompt(message: &str) -> String { RadioQAndA });
 conv_fn!(binary_prompt((data, data_type): (&[u8], u8)) -> BinaryData { BinaryQAndA });
 }
 "what" => Ok("whatwhat".to_owned()),
 "give_err" => Err(ErrorCode::PermissionDenied),
 _ => panic!("unexpected prompt!"),
 }
 }
-fn masked_prompt(&mut self, request: &str) -> Result<SecureString> {
+fn masked_prompt(&mut self, request: &str) -> Result<String> {
 assert_eq!("reveal", request);
-Ok(SecureString::from("my secrets"))
+Ok("my secrets".to_owned())
 }
 fn error_msg(&mut self, message: &str) {
 self.error_ran = true;
 assert_eq!("whoopsie", message);
 }
 info.message(),
 has_err.message(),
 ]);
 assert_eq!("whatwhat", what.answer().unwrap());
-assert_eq!(SecureString::from("my secrets"), pass.answer().unwrap());
+assert_eq!("my secrets", pass.answer().unwrap());
 assert_eq!(Ok(()), err.answer());
 assert_eq!(Ok(()), info.answer());
 assert_eq!(ErrorCode::PermissionDenied, has_err.answer().unwrap_err());
 assert!(tester.error_ran);
 assert!(tester.info_ran);
 }
 let mut tester = MuxTester;
 assert_eq!("answer", tester.prompt("question").unwrap());
-assert_eq!(
+assert_eq!("open sesame", tester.masked_prompt("password!").unwrap());
-SecureString::from("open sesame"),
-tester.masked_prompt("password!").unwrap()
-);
 tester.error_msg("oh no");
 tester.info_msg("let me tell you");
 // Linux-PAM extensions. Always implemented, but separate for clarity.
 {
 assert_eq!("yes", tester.radio_prompt("radio?").unwrap());

Mercurial > crates > nonstick

comparison src/conv.rs @ 93:efc2b56c8928