crates/nonstick: src/conv.rs annotate

annotate src/conv.rs @ 78:002adfb98c5c

Rename files, reorder structs, remove annoying BorrowedBinaryData type. This is basically a cleanup change. Also it adds tests. - Renames the files with Questions and Answers to question and answer. - Reorders the structs in those files to put the important ones first. - Removes the BorrowedBinaryData type. It was a bad idea all along. Instead, we just use (&[u8], u8). - Adds some tests because I just can't help myself.

author	Paul Fisher <paul@pfish.zone>
date	Sun, 08 Jun 2025 03:48:40 -0400
parents	351bdc13005e
children	2128123b9406

rev	line source
69 8f3ae0c7ab92 Rework conversation data types and make safe wrappers. Paul Fisher <paul@pfish.zone> parents: 64 diff changeset	1 //! The PAM conversation and associated Stuff.
60 05cc2c27334f The Big Refactor: clean up docs and exports. Paul Fisher <paul@pfish.zone> parents: 59 diff changeset	2
70 9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	3 // Temporarily allowed until we get the actual conversation functions hooked up.
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	4 #![allow(dead_code)]
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	5
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	6 use crate::constants::{ErrorCode, Result};
70 9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	7 use secure_string::SecureString;
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	8 use std::cell::Cell;
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	9 use std::fmt;
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	10 use std::result::Result as StdResult;
70 9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	11
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	12 /// The types of message and request that can be sent to a user.
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	13 ///
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	14 /// The data within each enum value is the prompt (or other information)
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	15 /// that will be presented to the user.
76 e58d24849e82 Add Message::set_error to quickly answer a question with an error. Paul Fisher <paul@pfish.zone> parents: 74 diff changeset	16 #[non_exhaustive]
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	17 pub enum Message<'a> {
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	18 Prompt(&'a QAndA<'a>),
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	19 MaskedPrompt(&'a MaskedQAndA<'a>),
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	20 RadioPrompt(&'a RadioQAndA<'a>),
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	21 BinaryPrompt(&'a BinaryQAndA<'a>),
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	22 Error(&'a ErrorMsg<'a>),
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	23 Info(&'a InfoMsg<'a>),
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	24 }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	25
76 e58d24849e82 Add Message::set_error to quickly answer a question with an error. Paul Fisher <paul@pfish.zone> parents: 74 diff changeset	26 impl Message<'_> {
e58d24849e82 Add Message::set_error to quickly answer a question with an error. Paul Fisher <paul@pfish.zone> parents: 74 diff changeset	27 /// Sets an error answer on this question, without having to inspect it.
e58d24849e82 Add Message::set_error to quickly answer a question with an error. Paul Fisher <paul@pfish.zone> parents: 74 diff changeset	28 ///
e58d24849e82 Add Message::set_error to quickly answer a question with an error. Paul Fisher <paul@pfish.zone> parents: 74 diff changeset	29 /// Use this as a default match case:
e58d24849e82 Add Message::set_error to quickly answer a question with an error. Paul Fisher <paul@pfish.zone> parents: 74 diff changeset	30 ///
e58d24849e82 Add Message::set_error to quickly answer a question with an error. Paul Fisher <paul@pfish.zone> parents: 74 diff changeset	31 /// ```
e58d24849e82 Add Message::set_error to quickly answer a question with an error. Paul Fisher <paul@pfish.zone> parents: 74 diff changeset	32 /// use nonstick::conv::{Message, QAndA};
e58d24849e82 Add Message::set_error to quickly answer a question with an error. Paul Fisher <paul@pfish.zone> parents: 74 diff changeset	33 /// use nonstick::ErrorCode;
e58d24849e82 Add Message::set_error to quickly answer a question with an error. Paul Fisher <paul@pfish.zone> parents: 74 diff changeset	34 ///
e58d24849e82 Add Message::set_error to quickly answer a question with an error. Paul Fisher <paul@pfish.zone> parents: 74 diff changeset	35 /// fn cant_respond(message: Message) {
e58d24849e82 Add Message::set_error to quickly answer a question with an error. Paul Fisher <paul@pfish.zone> parents: 74 diff changeset	36 /// match message {
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	37 /// Message::Info(i) => {
76 e58d24849e82 Add Message::set_error to quickly answer a question with an error. Paul Fisher <paul@pfish.zone> parents: 74 diff changeset	38 /// eprintln!("fyi, {}", i.question());
e58d24849e82 Add Message::set_error to quickly answer a question with an error. Paul Fisher <paul@pfish.zone> parents: 74 diff changeset	39 /// i.set_answer(Ok(()))
e58d24849e82 Add Message::set_error to quickly answer a question with an error. Paul Fisher <paul@pfish.zone> parents: 74 diff changeset	40 /// }
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	41 /// Message::Error(e) => {
76 e58d24849e82 Add Message::set_error to quickly answer a question with an error. Paul Fisher <paul@pfish.zone> parents: 74 diff changeset	42 /// eprintln!("ERROR: {}", e.question());
e58d24849e82 Add Message::set_error to quickly answer a question with an error. Paul Fisher <paul@pfish.zone> parents: 74 diff changeset	43 /// e.set_answer(Ok(()))
e58d24849e82 Add Message::set_error to quickly answer a question with an error. Paul Fisher <paul@pfish.zone> parents: 74 diff changeset	44 /// }
e58d24849e82 Add Message::set_error to quickly answer a question with an error. Paul Fisher <paul@pfish.zone> parents: 74 diff changeset	45 /// // We can't answer any questions.
e58d24849e82 Add Message::set_error to quickly answer a question with an error. Paul Fisher <paul@pfish.zone> parents: 74 diff changeset	46 /// other => other.set_error(ErrorCode::ConversationError),
e58d24849e82 Add Message::set_error to quickly answer a question with an error. Paul Fisher <paul@pfish.zone> parents: 74 diff changeset	47 /// }
e58d24849e82 Add Message::set_error to quickly answer a question with an error. Paul Fisher <paul@pfish.zone> parents: 74 diff changeset	48 /// }
e58d24849e82 Add Message::set_error to quickly answer a question with an error. Paul Fisher <paul@pfish.zone> parents: 74 diff changeset	49 pub fn set_error(&self, err: ErrorCode) {
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	50 match *self {
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	51 Message::Prompt(m) => m.set_answer(Err(err)),
76 e58d24849e82 Add Message::set_error to quickly answer a question with an error. Paul Fisher <paul@pfish.zone> parents: 74 diff changeset	52 Message::MaskedPrompt(m) => m.set_answer(Err(err)),
e58d24849e82 Add Message::set_error to quickly answer a question with an error. Paul Fisher <paul@pfish.zone> parents: 74 diff changeset	53 Message::RadioPrompt(m) => m.set_answer(Err(err)),
e58d24849e82 Add Message::set_error to quickly answer a question with an error. Paul Fisher <paul@pfish.zone> parents: 74 diff changeset	54 Message::BinaryPrompt(m) => m.set_answer(Err(err)),
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	55 Message::Error(m) => m.set_answer(Err(err)),
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	56 Message::Info(m) => m.set_answer(Err(err)),
76 e58d24849e82 Add Message::set_error to quickly answer a question with an error. Paul Fisher <paul@pfish.zone> parents: 74 diff changeset	57 }
e58d24849e82 Add Message::set_error to quickly answer a question with an error. Paul Fisher <paul@pfish.zone> parents: 74 diff changeset	58 }
e58d24849e82 Add Message::set_error to quickly answer a question with an error. Paul Fisher <paul@pfish.zone> parents: 74 diff changeset	59 }
e58d24849e82 Add Message::set_error to quickly answer a question with an error. Paul Fisher <paul@pfish.zone> parents: 74 diff changeset	60
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	61 macro_rules! q_and_a {
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	62 ($name:ident<'a, Q=$qt:ty, A=$at:ty>, $val:path, $($doc:literal)*) => {
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	63 $(
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	64 #[doc = $doc]
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	65 )*
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	66 pub struct $name<'a> {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	67 q: $qt,
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	68 a: Cell<Result<$at>>,
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	69 }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	70
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	71 impl<'a> $name<'a> {
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	72 #[doc = concat!("Creates a `", stringify!($t), "` to be sent to the user.")]
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	73 pub fn new(question: $qt) -> Self {
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	74 Self {
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	75 q: question,
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	76 a: Cell::new(Err(ErrorCode::ConversationError)),
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	77 }
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	78 }
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	79
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	80 /// Converts this Q&A into a [`Message`] for the [`Conversation`].
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	81 pub fn message(&self) -> Message<'_> {
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	82 $val(self)
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	83 }
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	84
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	85 /// The contents of the question being asked.
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	86 ///
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	87 /// For instance, this might say `"Username:"` to prompt the user
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	88 /// for their name, or the text of an error message.
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	89 pub fn question(&self) -> $qt {
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	90 self.q
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	91 }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	92
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	93 /// Sets the answer to the question.
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	94 ///
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	95 /// The [`Conversation`] implementation calls this to set the answer.
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	96 /// The conversation should always call this function,
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	97 /// even for Q&A messages that don't have "an answer"
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	98 /// (like error or info messages).
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	99 pub fn set_answer(&self, answer: Result<$at>) {
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	100 self.a.set(answer)
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	101 }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	102
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	103 /// Gets the answer to the question.
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	104 pub fn answer(self) -> Result<$at> {
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	105 self.a.into_inner()
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	106 }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	107 }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	108
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	109 // shout out to stackoverflow user ballpointben for this lazy impl:
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	110 // https://stackoverflow.com/a/78871280/39808
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	111 impl fmt::Debug for $name<'_> {
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	112 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> StdResult<(), fmt::Error> {
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	113 #[derive(Debug)]
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	114 struct $name<'a> { q: $qt }
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	115 fmt::Debug::fmt(&$name { q: self.q }, f)
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	116 }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	117 }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	118 };
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	119 }
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	120
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	121 q_and_a!(
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	122 MaskedQAndA<'a, Q=&'a str, A=SecureString>,
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	123 Message::MaskedPrompt,
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	124 "A Q&A that asks the user for text and does not show it while typing."
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	125 ""
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	126 "In other words, a password entry prompt."
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	127 );
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	128
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	129 q_and_a!(
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	130 QAndA<'a, Q=&'a str, A=String>,
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	131 Message::Prompt,
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	132 "A standard Q&A prompt that asks the user for text."
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	133 ""
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	134 "This is the normal \"ask a person a question\" prompt."
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	135 "When the user types, their input will be shown to them."
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	136 "It can be used for things like usernames."
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	137 );
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	138
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	139 q_and_a!(
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	140 RadioQAndA<'a, Q=&'a str, A=String>,
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	141 Message::RadioPrompt,
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	142 "A Q&A for \"radio button\"–style data. (Linux-PAM extension)"
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	143 ""
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	144 "This message type is theoretically useful for \"yes/no/maybe\""
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	145 "questions, but nowhere in the documentation is it specified"
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	146 "what the format of the answer will be, or how this should be shown."
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	147 );
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	148
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	149 q_and_a!(
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	150 BinaryQAndA<'a, Q=(&'a [u8], u8), A=BinaryData>,
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	151 Message::BinaryPrompt,
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	152 "Asks for binary data. (Linux-PAM extension)"
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	153 ""
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	154 "This sends a binary message to the client application."
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	155 "It can be used to communicate with non-human logins,"
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	156 "or to enable things like security keys."
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	157 ""
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	158 "The `data_type` tag is a value that is simply passed through"
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	159 "to the application. PAM does not define any meaning for it."
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	160 );
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	161
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	162 /// Owned binary data.
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	163 ///
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	164 /// You can take ownership of the stored data by destructuring it:
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	165 ///
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	166 /// ```
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	167 /// # use nonstick::BinaryData;
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	168 /// # let binary_data = BinaryData::new(vec![99, 88, 77], 66);
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	169 /// let (data, data_type) = binary_data.into();
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	170 /// ```
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	171 #[derive(Debug, Default, PartialEq)]
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	172 pub struct BinaryData {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	173 data: Vec<u8>,
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	174 data_type: u8,
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	175 }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	176
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	177 impl BinaryData {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	178 /// Creates a `BinaryData` with the given contents and type.
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	179 pub fn new(data: impl Into<Vec<u8>>, data_type: u8) -> Self {
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	180 Self { data: data.into(), data_type }
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	181 }
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	182 }
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	183
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	184 impl From<BinaryData> for (Vec<u8>, u8) {
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	185 fn from(value: BinaryData) -> Self {
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	186 (value.data, value.data_type)
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	187 }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	188 }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	189
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	190 impl From<(&'_[u8], u8)> for BinaryData {
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	191 fn from((data, data_type): (&'_[u8], u8)) -> Self {
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	192 Self {
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	193 data: data.to_vec(),
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	194 data_type,
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	195 }
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	196 }
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	197 }
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	198
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	199 impl<'a> From<&'a BinaryData> for (&'a[u8], u8) {
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	200 fn from(value: &'a BinaryData) -> Self {
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	201 (&value.data, value.data_type)
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	202 }
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	203 }
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	204
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	205 impl From<BinaryData> for Vec<u8> {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	206 /// Takes ownership of the data stored herein.
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	207 fn from(value: BinaryData) -> Self {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	208 value.data
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	209 }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	210 }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	211
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	212 q_and_a!(
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	213 InfoMsg<'a, Q = &'a str, A = ()>,
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	214 Message::Info,
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	215 "A message containing information to be passed to the user."
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	216 ""
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	217 "While this does not have an answer, [`Conversation`] implementations"
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	218 "should still call [`set_answer`][`QAndA::set_answer`] to verify that"
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	219 "the message has been displayed (or actively discarded)."
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	220 );
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	221
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	222 q_and_a!(
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	223 ErrorMsg<'a, Q = &'a str, A = ()>,
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	224 Message::Error,
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	225 "An error message to be passed to the user."
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	226 ""
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	227 "While this does not have an answer, [`Conversation`] implementations"
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	228 "should still call [`set_answer`][`QAndA::set_answer`] to verify that"
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	229 "the message has been displayed (or actively discarded)."
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	230 );
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	231
70 9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	232 /// A channel for PAM modules to request information from the user.
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	233 ///
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	234 /// This trait is used by both applications and PAM modules:
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	235 ///
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	236 /// - Applications implement Conversation and provide a user interface
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	237 /// to allow the user to respond to PAM questions.
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	238 /// - Modules call a Conversation implementation to request information
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	239 /// or send information to the user.
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	240 pub trait Conversation {
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	241 /// Sends messages to the user.
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	242 ///
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	243 /// The returned Vec of messages always contains exactly as many entries
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	244 /// as there were messages in the request; one corresponding to each.
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	245 ///
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	246 /// TODO: write detailed documentation about how to use this.
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	247 fn communicate(&mut self, messages: &[Message]);
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	248 }
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	249
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	250 /// Turns a simple function into a [`Conversation`].
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	251 ///
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	252 /// This can be used to wrap a free-floating function for use as a
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	253 /// Conversation:
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	254 ///
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	255 /// ```
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	256 /// use nonstick::conv::{conversation_func, Conversation, Message};
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	257 /// mod some_library {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	258 /// # use nonstick::Conversation;
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	259 /// pub fn get_auth_data(conv: &mut impl Conversation) {
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	260 /// /* ... */
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	261 /// }
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	262 /// }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	263 ///
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	264 /// fn my_terminal_prompt(messages: &[Message]) {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	265 /// // ...
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	266 /// # todo!()
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	267 /// }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	268 ///
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	269 /// fn main() {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	270 /// some_library::get_auth_data(&mut conversation_func(my_terminal_prompt));
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	271 /// }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	272 /// ```
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	273 pub fn conversation_func(func: impl FnMut(&[Message])) -> impl Conversation {
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	274 Convo(func)
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	275 }
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	276
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	277 struct Convo<C: FnMut(&[Message])>(C);
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	278
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	279 impl<C: FnMut(&[Message])> Conversation for Convo<C> {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	280 fn communicate(&mut self, messages: &[Message]) {
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	281 self.0(messages)
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	282 }
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	283 }
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	284
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	285 /// A conversation trait for asking or answering one question at a time.
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	286 ///
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	287 /// An implementation of this is provided for any [`Conversation`],
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	288 /// or a PAM application can implement this trait and handle messages
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	289 /// one at a time.
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	290 ///
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	291 /// For example, to use a `Conversation` as a `SimpleConversation`:
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	292 ///
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	293 /// ```
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	294 /// # use nonstick::{Conversation, Result};
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	295 /// # use secure_string::SecureString;
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	296 /// // Bring this trait into scope to get `masked_prompt`, among others.
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	297 /// use nonstick::SimpleConversation;
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	298 ///
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	299 /// fn ask_for_token(convo: &mut impl Conversation) -> Result<SecureString> {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	300 /// convo.masked_prompt("enter your one-time token")
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	301 /// }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	302 /// ```
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	303 ///
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	304 /// or to use a `SimpleConversation` as a `Conversation`:
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	305 ///
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	306 /// ```
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	307 /// use nonstick::{Conversation, SimpleConversation};
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	308 /// use secure_string::SecureString;
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	309 /// # use nonstick::{BinaryData, Result};
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	310 /// mod some_library {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	311 /// # use nonstick::Conversation;
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	312 /// pub fn get_auth_data(conv: &mut impl Conversation) { /* ... */
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	313 /// }
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	314 /// }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	315 ///
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	316 /// struct MySimpleConvo {/* ... */}
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	317 /// # impl MySimpleConvo { fn new() -> Self { Self{} } }
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	318 ///
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	319 /// impl SimpleConversation for MySimpleConvo {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	320 /// // ...
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	321 /// # fn prompt(&mut self, request: &str) -> Result<String> {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	322 /// # todo!()
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	323 /// # }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	324 /// #
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	325 /// # fn masked_prompt(&mut self, request: &str) -> Result<SecureString> {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	326 /// # todo!()
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	327 /// # }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	328 /// #
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	329 /// # fn radio_prompt(&mut self, request: &str) -> Result<String> {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	330 /// # todo!()
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	331 /// # }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	332 /// #
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	333 /// # fn error_msg(&mut self, message: &str) {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	334 /// # todo!()
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	335 /// # }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	336 /// #
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	337 /// # fn info_msg(&mut self, message: &str) {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	338 /// # todo!()
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	339 /// # }
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	340 /// #
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	341 /// # fn binary_prompt(&mut self, (data, data_type): (&[u8], u8)) -> Result<BinaryData> {
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	342 /// # todo!()
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	343 /// # }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	344 /// }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	345 ///
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	346 /// fn main() {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	347 /// let mut simple = MySimpleConvo::new();
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	348 /// some_library::get_auth_data(&mut simple.as_conversation())
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	349 /// }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	350 /// ```
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	351 pub trait SimpleConversation {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	352 /// Lets you use this simple conversation as a full [Conversation].
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	353 ///
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	354 /// The wrapper takes each message received in [`Conversation::communicate`]
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	355 /// and passes them one-by-one to the appropriate method,
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	356 /// then collects responses to return.
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	357 fn as_conversation(&mut self) -> Demux<'_, Self>
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	358 where
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	359 Self: Sized,
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	360 {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	361 Demux(self)
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	362 }
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	363 /// Prompts the user for something.
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	364 fn prompt(&mut self, request: &str) -> Result<String>;
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	365 /// Prompts the user for something, but hides what the user types.
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	366 fn masked_prompt(&mut self, request: &str) -> Result<SecureString>;
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	367 /// Prompts the user for a yes/no/maybe conditional (a Linux-PAM extension).
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	368 ///
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	369 /// PAM documentation doesn't define the format of the response.
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	370 fn radio_prompt(&mut self, request: &str) -> Result<String>;
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	371 /// Alerts the user to an error.
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	372 fn error_msg(&mut self, message: &str);
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	373 /// Sends an informational message to the user.
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	374 fn info_msg(&mut self, message: &str);
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	375 /// Requests binary data from the user (a Linux-PAM extension).
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	376 fn binary_prompt(&mut self, data_and_type: (&[u8], u8)) -> Result<BinaryData>;
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	377 }
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	378
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	379 macro_rules! conv_fn {
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	380 ($fn_name:ident($($param:tt: $pt:ty),+) -> $resp_type:ty { $msg:ty }) => {
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	381 fn $fn_name(&mut self, $($param: $pt),*) -> Result<$resp_type> {
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	382 let prompt = <$msg>::new($($param),*);
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	383 self.communicate(&[prompt.message()]);
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	384 prompt.answer()
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	385 }
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	386 };
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	387 ($fn_name:ident($($param:tt: $pt:ty),+) { $msg:ty }) => {
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	388 fn $fn_name(&mut self, $($param: $pt),*) {
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	389 self.communicate(&[<$msg>::new($($param),*).message()]);
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	390 }
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	391 };
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	392 }
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	393
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	394 impl<C: Conversation> SimpleConversation for C {
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	395 conv_fn!(prompt(message: &str) -> String { QAndA });
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	396 conv_fn!(masked_prompt(message: &str) -> SecureString { MaskedQAndA } );
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	397 conv_fn!(radio_prompt(message: &str) -> String { RadioQAndA });
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	398 conv_fn!(error_msg(message: &str) { ErrorMsg });
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	399 conv_fn!(info_msg(message: &str) { InfoMsg });
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	400 conv_fn!(binary_prompt((data, data_type): (&[u8], u8)) -> BinaryData { BinaryQAndA });
70 9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	401 }
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	402
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	403 /// A [`Conversation`] which asks the questions one at a time.
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	404 ///
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	405 /// This is automatically created by [`SimpleConversation::as_conversation`].
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	406 pub struct Demux<'a, SC: SimpleConversation>(&'a mut SC);
70 9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	407
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	408 impl<SC: SimpleConversation> Conversation for Demux<'_, SC> {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	409 fn communicate(&mut self, messages: &[Message]) {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	410 for msg in messages {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	411 match msg {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	412 Message::Prompt(prompt) => prompt.set_answer(self.0.prompt(prompt.question())),
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	413 Message::MaskedPrompt(prompt) => {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	414 prompt.set_answer(self.0.masked_prompt(prompt.question()))
70 9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	415 }
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	416 Message::RadioPrompt(prompt) => {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	417 prompt.set_answer(self.0.radio_prompt(prompt.question()))
70 9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	418 }
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	419 Message::Info(prompt) => {
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	420 self.0.info_msg(prompt.question());
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	421 prompt.set_answer(Ok(()))
70 9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	422 }
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	423 Message::Error(prompt) => {
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	424 self.0.error_msg(prompt.question());
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	425 prompt.set_answer(Ok(()))
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	426 }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	427 Message::BinaryPrompt(prompt) => {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	428 let q = prompt.question();
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	429 prompt.set_answer(self.0.binary_prompt(q))
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	430 }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	431 }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	432 }
70 9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	433 }
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	434 }
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	435
69 8f3ae0c7ab92 Rework conversation data types and make safe wrappers. Paul Fisher <paul@pfish.zone> parents: 64 diff changeset	436 #[cfg(test)]
71 58f9d2a4df38 Reorganize everything again??? Paul Fisher <paul@pfish.zone> parents: 70 diff changeset	437 mod tests {
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	438 use super::{
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	439 BinaryQAndA, Conversation, ErrorMsg, InfoMsg, MaskedQAndA, Message, QAndA, RadioQAndA,
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	440 Result, SecureString, SimpleConversation,
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	441 };
70 9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	442 use crate::constants::ErrorCode;
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	443 use crate::BinaryData;
70 9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	444
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	445 #[test]
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	446 fn test_demux() {
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	447 #[derive(Default)]
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	448 struct DemuxTester {
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	449 error_ran: bool,
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	450 info_ran: bool,
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	451 }
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	452
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	453 impl SimpleConversation for DemuxTester {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	454 fn prompt(&mut self, request: &str) -> Result<String> {
70 9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	455 match request {
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	456 "what" => Ok("whatwhat".to_owned()),
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	457 "give_err" => Err(ErrorCode::PermissionDenied),
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	458 _ => panic!("unexpected prompt!"),
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	459 }
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	460 }
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	461 fn masked_prompt(&mut self, request: &str) -> Result<SecureString> {
70 9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	462 assert_eq!("reveal", request);
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	463 Ok(SecureString::from("my secrets"))
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	464 }
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	465 fn radio_prompt(&mut self, request: &str) -> Result<String> {
70 9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	466 assert_eq!("channel?", request);
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	467 Ok("zero".to_owned())
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	468 }
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	469 fn error_msg(&mut self, message: &str) {
70 9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	470 self.error_ran = true;
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	471 assert_eq!("whoopsie", message);
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	472 }
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	473 fn info_msg(&mut self, message: &str) {
70 9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	474 self.info_ran = true;
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	475 assert_eq!("did you know", message);
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	476 }
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	477 fn binary_prompt(&mut self, data_and_type: (&[u8], u8)) -> Result<BinaryData> {
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	478 assert_eq!((&[10, 9, 8][..], 66), data_and_type);
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	479 Ok(BinaryData::new(vec![5, 5, 5], 5))
70 9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	480 }
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	481 }
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	482
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	483 let mut tester = DemuxTester::default();
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	484
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	485 let what = QAndA::new("what");
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	486 let pass = MaskedQAndA::new("reveal");
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	487 let err = ErrorMsg::new("whoopsie");
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	488 let info = InfoMsg::new("did you know");
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	489 let has_err = QAndA::new("give_err");
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	490
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	491 let mut conv = tester.as_conversation();
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	492
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	493 // Basic tests.
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	494
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	495 conv.communicate(&[
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	496 what.message(),
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	497 pass.message(),
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	498 err.message(),
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	499 info.message(),
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	500 has_err.message(),
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	501 ]);
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	502
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	503 assert_eq!("whatwhat", what.answer().unwrap());
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	504 assert_eq!(SecureString::from("my secrets"), pass.answer().unwrap());
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	505 assert_eq!(Ok(()), err.answer());
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	506 assert_eq!(Ok(()), info.answer());
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	507 assert_eq!(ErrorCode::PermissionDenied, has_err.answer().unwrap_err());
70 9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	508 assert!(tester.error_ran);
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	509 assert!(tester.info_ran);
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	510
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	511 // Test the Linux extensions separately.
70 9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	512
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	513 let mut conv = tester.as_conversation();
70 9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	514
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	515 let radio = RadioQAndA::new("channel?");
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	516 let bin = BinaryQAndA::new((&[10, 9, 8], 66));
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	517 conv.communicate(&[radio.message(), bin.message()]);
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	518
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	519 assert_eq!("zero", radio.answer().unwrap());
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	520 assert_eq!(BinaryData::new(vec![5, 5, 5], 5), bin.answer().unwrap());
70 9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	521 }
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	522
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	523 fn test_mux() {
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	524 struct MuxTester;
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	525
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	526 impl Conversation for MuxTester {
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	527 fn communicate(&mut self, messages: &[Message]) {
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	528 if let [msg] = messages {
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	529 match *msg {
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	530 Message::Info(info) => {
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	531 assert_eq!("let me tell you", info.question());
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	532 info.set_answer(Ok(()))
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	533 }
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 76 diff changeset	534 Message::Error(error) => {
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	535 assert_eq!("oh no", error.question());
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	536 error.set_answer(Ok(()))
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	537 }
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	538 Message::Prompt(prompt) => prompt.set_answer(match prompt.question() {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	539 "should_err" => Err(ErrorCode::PermissionDenied),
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	540 "question" => Ok("answer".to_owned()),
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	541 other => panic!("unexpected question {other:?}"),
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	542 }),
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	543 Message::MaskedPrompt(ask) => {
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	544 assert_eq!("password!", ask.question());
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	545 ask.set_answer(Ok("open sesame".into()))
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	546 }
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	547 Message::BinaryPrompt(prompt) => {
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	548 assert_eq!((&[1, 2, 3][..], 69), prompt.question());
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	549 prompt.set_answer(Ok(BinaryData::new(vec![3, 2, 1], 42)))
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	550 }
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	551 Message::RadioPrompt(ask) => {
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	552 assert_eq!("radio?", ask.question());
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	553 ask.set_answer(Ok("yes".to_owned()))
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	554 }
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	555 }
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	556 } else {
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	557 panic!(
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	558 "there should only be one message, not {len}",
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	559 len = messages.len()
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	560 )
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	561 }
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	562 }
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	563 }
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	564
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	565 let mut tester = MuxTester;
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	566
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	567 assert_eq!("answer", tester.prompt("question").unwrap());
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	568 assert_eq!(
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	569 SecureString::from("open sesame"),
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	570 tester.masked_prompt("password!").unwrap()
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	571 );
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	572 tester.error_msg("oh no");
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	573 tester.info_msg("let me tell you");
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	574 {
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	575 assert_eq!("yes", tester.radio_prompt("radio?").unwrap());
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	576 assert_eq!(
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	577 BinaryData::new(vec![3, 2, 1], 42),
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	578 tester.binary_prompt((&[1, 2, 3], 69)).unwrap(),
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	579 )
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	580 }
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	581 assert_eq!(
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	582 ErrorCode::BufferError,
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	583 tester.prompt("should_error").unwrap_err(),
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	584 );
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	585 assert_eq!(
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	586 ErrorCode::ConversationError,
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	587 tester.masked_prompt("return_wrong_type").unwrap_err()
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	588 )
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	589 }
69 8f3ae0c7ab92 Rework conversation data types and make safe wrappers. Paul Fisher <paul@pfish.zone> parents: 64 diff changeset	590 }

Mercurial > crates > nonstick

annotate src/conv.rs @ 78:002adfb98c5c