crates/nonstick: src/libpam/answer.rs annotate

annotate src/libpam/answer.rs @ 141:a508a69c068a

Remove a lot of Results from functions. Many functions are documented to only return failing Results when given improper inputs or when there is a memory allocation failure (which can be verified by looking at the source). In cases where we know our input is correct, we don't need to check for memory allocation errors for the same reason that Rust doesn't do so when you, e.g., create a new Vec.

author	Paul Fisher <paul@pfish.zone>
date	Sat, 05 Jul 2025 17:16:56 -0400
parents	33b9622ed6d2
children	ebb71a412b58

rev	line source
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	1 //! Types used to communicate data from the application to the module.
69 8f3ae0c7ab92 Rework conversation data types and make safe wrappers. Paul Fisher <paul@pfish.zone> parents: 66 diff changeset	2
130 80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 108 diff changeset	3 use crate::libpam::conversation::OwnedExchange;
75 c30811b4afae rename pam_ffi submodule to libpam. Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	4 use crate::libpam::memory;
139 33b9622ed6d2 Remove redundant memory management in nonstick::libpam; fix UB. Paul Fisher <paul@pfish.zone> parents: 130 diff changeset	5 use crate::libpam::memory::{CHeapBox, CHeapPayload, CHeapString, Immovable};
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	6 use crate::{ErrorCode, Result};
139 33b9622ed6d2 Remove redundant memory management in nonstick::libpam; fix UB. Paul Fisher <paul@pfish.zone> parents: 130 diff changeset	7 use libpam_sys_helpers::memory::BinaryPayload;
130 80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 108 diff changeset	8 use std::ffi::{c_int, c_void, CStr};
101 94b51fa4f797 Fix memory soundness issues: Paul Fisher <paul@pfish.zone> parents: 100 diff changeset	9 use std::mem::ManuallyDrop;
71 58f9d2a4df38 Reorganize everything again??? Paul Fisher <paul@pfish.zone> parents: 70 diff changeset	10 use std::ops::{Deref, DerefMut};
93 efc2b56c8928 Remove undefined behavior per MIRI. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	11 use std::ptr::NonNull;
101 94b51fa4f797 Fix memory soundness issues: Paul Fisher <paul@pfish.zone> parents: 100 diff changeset	12 use std::{iter, ptr, slice};
69 8f3ae0c7ab92 Rework conversation data types and make safe wrappers. Paul Fisher <paul@pfish.zone> parents: 66 diff changeset	13
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	14 /// The corridor via which the answer to Messages navigate through PAM.
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	15 #[derive(Debug)]
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	16 pub struct Answers {
98 b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	17 /// The actual list of answers. This can't be a [`CHeapBox`] because
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	18 /// this is the pointer to the start of an array, not a single Answer.
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	19 base: NonNull<Answer>,
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	20 count: usize,
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	21 }
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	22
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	23 impl Answers {
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	24 /// Builds an Answers out of the given answered Message Q&As.
130 80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 108 diff changeset	25 pub fn build(value: Vec<OwnedExchange>) -> Result<Self> {
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	26 let mut outputs = Self {
139 33b9622ed6d2 Remove redundant memory management in nonstick::libpam; fix UB. Paul Fisher <paul@pfish.zone> parents: 130 diff changeset	27 base: memory::calloc(value.len()),
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	28 count: value.len(),
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	29 };
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	30 // Even if we fail during this process, we still end up freeing
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	31 // all allocated answer memory.
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	32 for (input, output) in iter::zip(value, outputs.iter_mut()) {
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	33 match input {
130 80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 108 diff changeset	34 OwnedExchange::MaskedPrompt(p) => TextAnswer::fill(output, p.answer()?.as_ref())?,
80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 108 diff changeset	35 OwnedExchange::Prompt(p) => TextAnswer::fill(output, &(p.answer()?))?,
80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 108 diff changeset	36 OwnedExchange::Error(p) => TextAnswer::fill(output, p.answer().map(\|_\| "")?)?,
80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 108 diff changeset	37 OwnedExchange::Info(p) => TextAnswer::fill(output, p.answer().map(\|_\| "")?)?,
87 05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	38 // If we're here, that means that we got a Linux-PAM
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	39 // question from PAM, so we're OK to answer it.
130 80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 108 diff changeset	40 OwnedExchange::RadioPrompt(p) => TextAnswer::fill(output, &(p.answer()?))?,
80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 108 diff changeset	41 OwnedExchange::BinaryPrompt(p) => {
80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 108 diff changeset	42 BinaryAnswer::fill(output, (&p.answer()?).into())?
80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 108 diff changeset	43 }
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	44 }
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	45 }
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	46 Ok(outputs)
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	47 }
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	48
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	49 /// Converts this into a `*Answer` for passing to PAM.
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	50 ///
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	51 /// This object is consumed and the `Answer` pointer now owns its data.
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	52 /// It can be recreated with [`Self::from_c_heap`].
130 80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 108 diff changeset	53 pub fn into_ptr(self) -> *mut libpam_sys::pam_response {
80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 108 diff changeset	54 ManuallyDrop::new(self).base.as_ptr().cast()
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	55 }
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	56
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	57 /// Takes ownership of a list of answers allocated on the C heap.
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	58 ///
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	59 /// # Safety
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	60 ///
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	61 /// It's up to you to make sure you pass a valid pointer,
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	62 /// like one that you got from PAM, or maybe [`Self::into_ptr`].
130 80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 108 diff changeset	63 pub unsafe fn from_c_heap(base: NonNull<libpam_sys::pam_response>, count: usize) -> Self {
80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 108 diff changeset	64 Answers {
80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 108 diff changeset	65 base: NonNull::new_unchecked(base.as_ptr().cast()),
80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 108 diff changeset	66 count,
80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 108 diff changeset	67 }
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	68 }
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	69 }
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	70
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	71 impl Deref for Answers {
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	72 type Target = [Answer];
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	73 fn deref(&self) -> &Self::Target {
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	74 // SAFETY: This is the memory we manage ourselves.
98 b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	75 unsafe { slice::from_raw_parts(self.base.as_ptr(), self.count) }
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	76 }
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 impl DerefMut for Answers {
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	80 fn deref_mut(&mut self) -> &mut Self::Target {
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	81 // SAFETY: This is the memory we manage ourselves.
98 b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	82 unsafe { slice::from_raw_parts_mut(self.base.as_ptr(), self.count) }
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	83 }
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	84 }
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	85
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	86 impl Drop for Answers {
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	87 fn drop(&mut self) {
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	88 // SAFETY: We allocated this ourselves, or it was provided to us by PAM.
98 b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	89 // We own these pointers, and they will never be used after this.
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	90 unsafe {
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	91 for answer in self.iter_mut() {
98 b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	92 ptr::drop_in_place(answer)
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	93 }
98 b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	94 memory::free(self.base.as_ptr())
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	95 }
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	96 }
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	97 }
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	98
130 80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 108 diff changeset	99 /// Generic version of answer data.
80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 108 diff changeset	100 ///
80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 108 diff changeset	101 /// This has the same structure as [`BinaryAnswer`](crate::libpam::answer::BinaryAnswer)
80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 108 diff changeset	102 /// and [`TextAnswer`](crate::libpam::answer::TextAnswer).
80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 108 diff changeset	103 #[repr(C)]
80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 108 diff changeset	104 #[derive(Debug, Default)]
80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 108 diff changeset	105 pub struct Answer {
80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 108 diff changeset	106 /// Owned pointer to the data returned in an answer.
80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 108 diff changeset	107 /// For most answers, this will be a
80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 108 diff changeset	108 /// [`CHeapString`](crate::libpam::memory::CHeapString),
80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 108 diff changeset	109 /// but for [`BinaryQAndA`](crate::conv::BinaryQAndA)s
80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 108 diff changeset	110 /// (a Linux-PAM extension), this will be a [`CHeapBox`] of
80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 108 diff changeset	111 /// [`CBinaryData`](crate::libpam::memory::CBinaryData).
80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 108 diff changeset	112 pub data: Option<CHeapBox<c_void>>,
80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 108 diff changeset	113 /// Unused. Just here for the padding.
80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 108 diff changeset	114 return_code: c_int,
80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 108 diff changeset	115 _marker: Immovable,
80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 108 diff changeset	116 }
80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 108 diff changeset	117
71 58f9d2a4df38 Reorganize everything again??? Paul Fisher <paul@pfish.zone> parents: 70 diff changeset	118 #[repr(transparent)]
58f9d2a4df38 Reorganize everything again??? Paul Fisher <paul@pfish.zone> parents: 70 diff changeset	119 #[derive(Debug)]
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	120 pub struct TextAnswer(Answer);
69 8f3ae0c7ab92 Rework conversation data types and make safe wrappers. Paul Fisher <paul@pfish.zone> parents: 66 diff changeset	121
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	122 impl TextAnswer {
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	123 /// Interprets the provided `Answer` as a text answer.
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	124 ///
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	125 /// # Safety
69 8f3ae0c7ab92 Rework conversation data types and make safe wrappers. Paul Fisher <paul@pfish.zone> parents: 66 diff changeset	126 ///
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	127 /// It's up to you to provide an answer that is a `TextAnswer`.
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	128 pub unsafe fn upcast(from: &mut Answer) -> &mut Self {
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	129 // SAFETY: We're provided a valid reference.
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	130 &mut (from as mut Answer).cast::<Self>()
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	131 }
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	132
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	133 /// Converts the `Answer` to a `TextAnswer` with the given text.
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	134 fn fill(dest: &mut Answer, text: &str) -> Result<()> {
98 b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	135 let allocated = CHeapString::new(text)?;
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	136 let _ = dest
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	137 .data
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	138 .replace(unsafe { CHeapBox::cast(allocated.into_box()) });
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	139 Ok(())
69 8f3ae0c7ab92 Rework conversation data types and make safe wrappers. Paul Fisher <paul@pfish.zone> parents: 66 diff changeset	140 }
8f3ae0c7ab92 Rework conversation data types and make safe wrappers. Paul Fisher <paul@pfish.zone> parents: 66 diff changeset	141
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	142 /// Gets the string stored in this answer.
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	143 pub fn contents(&self) -> Result<&str> {
98 b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	144 match self.0.data.as_ref() {
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	145 None => Ok(""),
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	146 Some(data) => {
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	147 // SAFETY: This data is either passed from PAM (so we are forced
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	148 // to trust it) or was created by us in TextAnswerInner::alloc.
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	149 // In either case, it's going to be a valid null-terminated string.
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	150 unsafe { CStr::from_ptr(CHeapBox::as_ptr(data).as_ptr().cast()) }
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	151 .to_str()
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	152 .map_err(\|_\| ErrorCode::ConversationError)
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	153 }
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	154 }
69 8f3ae0c7ab92 Rework conversation data types and make safe wrappers. Paul Fisher <paul@pfish.zone> parents: 66 diff changeset	155 }
8f3ae0c7ab92 Rework conversation data types and make safe wrappers. Paul Fisher <paul@pfish.zone> parents: 66 diff changeset	156
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	157 /// Zeroes out the answer data, frees it, and points our data to `null`.
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	158 ///
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	159 /// When this `TextAnswer` is part of an [`Answers`],
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	160 /// this is optional (since that will perform the `free`),
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	161 /// but it will clear potentially sensitive data.
98 b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	162 pub fn zero_contents(&mut self) {
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	163 // SAFETY: We own this data and know it's valid.
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	164 // If it's null, this is a no-op.
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	165 // After we're done, it will be null.
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	166 unsafe {
98 b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	167 if let Some(ptr) = self.0.data.as_ref() {
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	168 CHeapString::zero(CHeapBox::as_ptr(ptr).cast());
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	169 }
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	170 }
69 8f3ae0c7ab92 Rework conversation data types and make safe wrappers. Paul Fisher <paul@pfish.zone> parents: 66 diff changeset	171 }
8f3ae0c7ab92 Rework conversation data types and make safe wrappers. Paul Fisher <paul@pfish.zone> parents: 66 diff changeset	172 }
8f3ae0c7ab92 Rework conversation data types and make safe wrappers. Paul Fisher <paul@pfish.zone> parents: 66 diff changeset	173
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	174 /// A [`Answer`] with [`CBinaryData`] in it.
71 58f9d2a4df38 Reorganize everything again??? Paul Fisher <paul@pfish.zone> parents: 70 diff changeset	175 #[repr(transparent)]
58f9d2a4df38 Reorganize everything again??? Paul Fisher <paul@pfish.zone> parents: 70 diff changeset	176 #[derive(Debug)]
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	177 pub struct BinaryAnswer(Answer);
69 8f3ae0c7ab92 Rework conversation data types and make safe wrappers. Paul Fisher <paul@pfish.zone> parents: 66 diff changeset	178
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	179 impl BinaryAnswer {
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	180 /// Interprets the provided [`Answer`] as a binary answer.
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	181 ///
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	182 /// # Safety
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	183 ///
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	184 /// It's up to you to provide an answer that is a `BinaryAnswer`.
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	185 pub unsafe fn upcast(from: &mut Answer) -> &mut Self {
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	186 // SAFETY: We're provided a valid reference.
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	187 &mut (from as mut Answer).cast::<Self>()
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	188 }
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	189
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	190 /// Fills in a [`Answer`] with the provided binary data.
69 8f3ae0c7ab92 Rework conversation data types and make safe wrappers. Paul Fisher <paul@pfish.zone> parents: 66 diff changeset	191 ///
8f3ae0c7ab92 Rework conversation data types and make safe wrappers. Paul Fisher <paul@pfish.zone> parents: 66 diff changeset	192 /// The `data_type` is a tag you can use for whatever.
8f3ae0c7ab92 Rework conversation data types and make safe wrappers. Paul Fisher <paul@pfish.zone> parents: 66 diff changeset	193 /// It is passed through PAM unchanged.
8f3ae0c7ab92 Rework conversation data types and make safe wrappers. Paul Fisher <paul@pfish.zone> parents: 66 diff changeset	194 ///
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	195 /// The referenced data is copied to the C heap.
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	196 /// We do not take ownership of the original data.
139 33b9622ed6d2 Remove redundant memory management in nonstick::libpam; fix UB. Paul Fisher <paul@pfish.zone> parents: 130 diff changeset	197 pub fn fill(dest: &mut Answer, (data, type_): (&[u8], u8)) -> Result<()> {
33b9622ed6d2 Remove redundant memory management in nonstick::libpam; fix UB. Paul Fisher <paul@pfish.zone> parents: 130 diff changeset	198 let payload = CHeapPayload::new(data, type_).map_err(\|_\| ErrorCode::BufferError)?;
33b9622ed6d2 Remove redundant memory management in nonstick::libpam; fix UB. Paul Fisher <paul@pfish.zone> parents: 130 diff changeset	199 let _ = dest
33b9622ed6d2 Remove redundant memory management in nonstick::libpam; fix UB. Paul Fisher <paul@pfish.zone> parents: 130 diff changeset	200 .data
33b9622ed6d2 Remove redundant memory management in nonstick::libpam; fix UB. Paul Fisher <paul@pfish.zone> parents: 130 diff changeset	201 .replace(unsafe { CHeapBox::cast(payload.into_inner()) });
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	202 Ok(())
69 8f3ae0c7ab92 Rework conversation data types and make safe wrappers. Paul Fisher <paul@pfish.zone> parents: 66 diff changeset	203 }
8f3ae0c7ab92 Rework conversation data types and make safe wrappers. Paul Fisher <paul@pfish.zone> parents: 66 diff changeset	204
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	205 /// Gets the binary data in this answer.
139 33b9622ed6d2 Remove redundant memory management in nonstick::libpam; fix UB. Paul Fisher <paul@pfish.zone> parents: 130 diff changeset	206 pub fn contents(&self) -> Option<(&[u8], u8)> {
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	207 // SAFETY: We either got this data from PAM or allocated it ourselves.
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	208 // Either way, we trust that it is either valid data or null.
98 b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	209 self.0
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	210 .data
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	211 .as_ref()
139 33b9622ed6d2 Remove redundant memory management in nonstick::libpam; fix UB. Paul Fisher <paul@pfish.zone> parents: 130 diff changeset	212 .map(\|data\| unsafe { BinaryPayload::contents(CHeapBox::as_ptr(data).cast().as_ptr()) })
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	213 }
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	214
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	215 /// Zeroes out the answer data, frees it, and points our data to `null`.
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	216 ///
93 efc2b56c8928 Remove undefined behavior per MIRI. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	217 /// When this `BinaryAnswer` is part of an [`Answers`],
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	218 /// this is optional (since that will perform the `free`),
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	219 /// but it will clear potentially sensitive data.
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	220 pub fn zero_contents(&mut self) {
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	221 // SAFETY: We know that our data pointer is either valid or null.
139 33b9622ed6d2 Remove redundant memory management in nonstick::libpam; fix UB. Paul Fisher <paul@pfish.zone> parents: 130 diff changeset	222 if let Some(data) = self.0.data.as_mut() {
33b9622ed6d2 Remove redundant memory management in nonstick::libpam; fix UB. Paul Fisher <paul@pfish.zone> parents: 130 diff changeset	223 unsafe {
33b9622ed6d2 Remove redundant memory management in nonstick::libpam; fix UB. Paul Fisher <paul@pfish.zone> parents: 130 diff changeset	224 let total = BinaryPayload::total_bytes(CHeapBox::as_ptr(data).cast().as_ref());
33b9622ed6d2 Remove redundant memory management in nonstick::libpam; fix UB. Paul Fisher <paul@pfish.zone> parents: 130 diff changeset	225 let data: &mut [u8] =
33b9622ed6d2 Remove redundant memory management in nonstick::libpam; fix UB. Paul Fisher <paul@pfish.zone> parents: 130 diff changeset	226 slice::from_raw_parts_mut(CHeapBox::as_raw_ptr(data).cast(), total);
33b9622ed6d2 Remove redundant memory management in nonstick::libpam; fix UB. Paul Fisher <paul@pfish.zone> parents: 130 diff changeset	227 data.fill(0)
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	228 }
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	229 }
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	230 }
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	231 }
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	232
69 8f3ae0c7ab92 Rework conversation data types and make safe wrappers. Paul Fisher <paul@pfish.zone> parents: 66 diff changeset	233 #[cfg(test)]
71 58f9d2a4df38 Reorganize everything again??? Paul Fisher <paul@pfish.zone> parents: 70 diff changeset	234 mod tests {
87 05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	235 use super::*;
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	236 use crate::conv::{ErrorMsg, InfoMsg, MaskedQAndA, QAndA};
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	237
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	238 macro_rules! answered {
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	239 ($typ:ty, $msg:path, $data:expr) => {{
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	240 let qa = <$typ>::new("");
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	241 qa.set_answer(Ok($data));
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	242 $msg(qa)
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	243 }};
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	244 }
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	245
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	246 fn assert_text_answer(want: &str, answer: &mut Answer) {
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	247 let up = unsafe { TextAnswer::upcast(answer) };
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	248 assert_eq!(want, up.contents().unwrap());
98 b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	249 up.zero_contents();
87 05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	250 assert_eq!("", up.contents().unwrap());
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	251 }
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	252
130 80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 108 diff changeset	253 fn round_trip(msgs: Vec<OwnedExchange>) -> Answers {
87 05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	254 let n = msgs.len();
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	255 let sent = Answers::build(msgs).unwrap();
130 80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 108 diff changeset	256 unsafe { Answers::from_c_heap(NonNull::new_unchecked(sent.into_ptr()), n) }
87 05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	257 }
71 58f9d2a4df38 Reorganize everything again??? Paul Fisher <paul@pfish.zone> parents: 70 diff changeset	258
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	259 #[test]
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	260 fn test_round_trip() {
87 05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	261 let mut answers = round_trip(vec![
130 80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 108 diff changeset	262 answered!(QAndA, OwnedExchange::Prompt, "whats going on".to_owned()),
80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 108 diff changeset	263 answered!(MaskedQAndA, OwnedExchange::MaskedPrompt, "well then".into()),
80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 108 diff changeset	264 answered!(ErrorMsg, OwnedExchange::Error, ()),
80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 108 diff changeset	265 answered!(InfoMsg, OwnedExchange::Info, ()),
87 05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	266 ]);
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	267
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	268 if let [going, well, err, info] = &mut answers[..] {
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	269 assert_text_answer("whats going on", going);
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	270 assert_text_answer("well then", well);
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	271 assert_text_answer("", err);
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	272 assert_text_answer("", info);
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	273 } else {
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	274 panic!("received wrong size {len}!", len = answers.len())
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	275 }
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	276 }
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	277
108 e97534be35e3 Make some proc macros for doing cfg-like stuff for PAM impls. Paul Fisher <paul@pfish.zone> parents: 101 diff changeset	278 #[cfg(feature = "linux-pam-ext")]
87 05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	279 fn test_round_trip_linux() {
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	280 use crate::conv::{BinaryData, BinaryQAndA, RadioQAndA};
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	281 let binary_msg = {
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	282 let qa = BinaryQAndA::new((&[][..], 0));
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	283 qa.set_answer(Ok(BinaryData::new(vec![1, 2, 3], 99)));
130 80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 108 diff changeset	284 OwnedExchange::BinaryPrompt(qa)
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	285 };
87 05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	286 let mut answers = round_trip(vec![
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	287 binary_msg,
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	288 answered!(
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	289 RadioQAndA,
130 80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 108 diff changeset	290 OwnedExchange::RadioPrompt,
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	291 "beep boop".to_owned()
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	292 ),
87 05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	293 ]);
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	294
87 05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	295 if let [bin, radio] = &mut answers[..] {
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	296 let up = unsafe { BinaryAnswer::upcast(bin) };
139 33b9622ed6d2 Remove redundant memory management in nonstick::libpam; fix UB. Paul Fisher <paul@pfish.zone> parents: 130 diff changeset	297 assert_eq!((&[1, 2, 3][..], 99), up.contents().unwrap());
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	298 up.zero_contents();
139 33b9622ed6d2 Remove redundant memory management in nonstick::libpam; fix UB. Paul Fisher <paul@pfish.zone> parents: 130 diff changeset	299 assert_eq!((&[][..], 0), up.contents().unwrap());
87 05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	300
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	301 assert_text_answer("beep boop", radio);
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	302 } else {
87 05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	303 panic!("received wrong size {len}!", len = answers.len())
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	304 }
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	305 }
69 8f3ae0c7ab92 Rework conversation data types and make safe wrappers. Paul Fisher <paul@pfish.zone> parents: 66 diff changeset	306
8f3ae0c7ab92 Rework conversation data types and make safe wrappers. Paul Fisher <paul@pfish.zone> parents: 66 diff changeset	307 #[test]
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	308 fn test_text_answer() {
98 b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	309 let mut answer: CHeapBox<Answer> = CHeapBox::default();
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	310 TextAnswer::fill(&mut answer, "hello").unwrap();
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	311 let zeroth_text = unsafe { TextAnswer::upcast(&mut answer) };
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	312 let data = zeroth_text.contents().expect("valid");
69 8f3ae0c7ab92 Rework conversation data types and make safe wrappers. Paul Fisher <paul@pfish.zone> parents: 66 diff changeset	313 assert_eq!("hello", data);
98 b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	314 zeroth_text.zero_contents();
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	315 zeroth_text.zero_contents();
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	316 TextAnswer::fill(&mut answer, "hell\0").expect_err("should error; contains nul");
69 8f3ae0c7ab92 Rework conversation data types and make safe wrappers. Paul Fisher <paul@pfish.zone> parents: 66 diff changeset	317 }
8f3ae0c7ab92 Rework conversation data types and make safe wrappers. Paul Fisher <paul@pfish.zone> parents: 66 diff changeset	318
8f3ae0c7ab92 Rework conversation data types and make safe wrappers. Paul Fisher <paul@pfish.zone> parents: 66 diff changeset	319 #[test]
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	320 fn test_binary_answer() {
87 05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	321 use crate::conv::BinaryData;
98 b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	322 let mut answer: CHeapBox<Answer> = CHeapBox::default();
79 2128123b9406 Format (oops!) and make some fun and/or stupid conversions available. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	323 let real_data = BinaryData::new([1, 2, 3, 4, 5, 6, 7, 8], 9);
98 b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	324 BinaryAnswer::fill(&mut answer, (&real_data).into()).expect("alloc should succeed");
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	325 let bin_answer = unsafe { BinaryAnswer::upcast(&mut answer) };
139 33b9622ed6d2 Remove redundant memory management in nonstick::libpam; fix UB. Paul Fisher <paul@pfish.zone> parents: 130 diff changeset	326 assert_eq!(real_data, bin_answer.contents().unwrap().into());
70 9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	327 }
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	328
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	329 #[test]
69 8f3ae0c7ab92 Rework conversation data types and make safe wrappers. Paul Fisher <paul@pfish.zone> parents: 66 diff changeset	330 #[ignore]
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	331 fn test_binary_answer_too_big() {
87 05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	332 let big_data: Vec<u8> = vec![0xFFu8; 0x1_0000_0001];
98 b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	333 let mut answer: CHeapBox<Answer> = CHeapBox::default();
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	334 BinaryAnswer::fill(&mut answer, (&big_data, 100)).expect_err("this is too big!");
69 8f3ae0c7ab92 Rework conversation data types and make safe wrappers. Paul Fisher <paul@pfish.zone> parents: 66 diff changeset	335 }
8f3ae0c7ab92 Rework conversation data types and make safe wrappers. Paul Fisher <paul@pfish.zone> parents: 66 diff changeset	336 }

Mercurial > crates > nonstick

annotate src/libpam/answer.rs @ 141:a508a69c068a