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

annotate src/libpam/question.rs @ 103:dfcd96a74ac4 default tip

write a truly prodigious amount of documentation adds a bunch of links to the OpenPAM man pages and the XSSO spec as well as just a bunch of prose and stuff.

author	Paul Fisher <paul@pfish.zone>
date	Wed, 25 Jun 2025 00:59:24 -0400
parents	94b51fa4f797
children

rev	line source
71 58f9d2a4df38 Reorganize everything again??? Paul Fisher <paul@pfish.zone> parents: 70 diff changeset	1 //! Data and types dealing with PAM messages.
69 8f3ae0c7ab92 Rework conversation data types and make safe wrappers. Paul Fisher <paul@pfish.zone> parents: 66 diff changeset	2
87 05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	3 #[cfg(feature = "linux-pam-extensions")]
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	4 use crate::conv::{BinaryQAndA, RadioQAndA};
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	5 use crate::conv::{ErrorMsg, InfoMsg, MaskedQAndA, Message, QAndA};
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	6 use crate::libpam::conversation::OwnedMessage;
98 b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	7 use crate::libpam::memory::{CBinaryData, CHeapBox, CHeapString, Immovable};
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	8 use crate::libpam::pam_ffi;
87 05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	9 pub use crate::libpam::pam_ffi::Question;
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	10 use crate::ErrorCode;
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	11 use crate::Result;
87 05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	12 use num_enum::{IntoPrimitive, TryFromPrimitive};
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 79 diff changeset	13 use std::ffi::{c_void, CStr};
101 94b51fa4f797 Fix memory soundness issues: Paul Fisher <paul@pfish.zone> parents: 98 diff changeset	14 use std::pin::Pin;
98 b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	15 use std::slice;
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	16
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	17 /// Abstraction of a collection of questions to be sent in a PAM conversation.
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	18 ///
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	19 /// The PAM C API conversation function looks like this:
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	20 ///
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	21 /// ```c
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	22 /// int pam_conv(
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	23 /// int count,
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	24 /// const struct pam_message **questions,
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	25 /// struct pam_response **answers,
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	26 /// void *appdata_ptr,
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	27 /// )
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	28 /// ```
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 /// On Linux-PAM and other compatible implementations, `questions`
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	31 /// is treated as a pointer-to-pointers, like `int argc, char **argv`.
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	32 /// (In this situation, the value of `Questions.indirect` is
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	33 /// the pointer passed to `pam_conv`.)
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	34 ///
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	35 /// ```text
89 dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	36 /// points to ┌───────────────┐ ╔═ Question ═╗
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	37 /// questions ┄┄┄┄┄┄┄┄┄┄> │ questions[0] ┄┼┄┄┄┄> ║ style ║
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	38 /// │ questions[1] ┄┼┄┄┄╮ ║ data ┄┄┄┄┄┄╫┄┄> ...
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	39 /// │ ... │ ┆ ╚════════════╝
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	40 /// ┆
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	41 /// ┆ ╔═ Question ═╗
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	42 /// ╰┄┄> ║ style ║
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	43 /// ║ data ┄┄┄┄┄┄╫┄┄> ...
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	44 /// ╚════════════╝
78 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 ///
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	47 /// On OpenPAM and other compatible implementations (like Solaris),
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	48 /// `messages` is a pointer-to-pointer-to-array. This appears to be
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	49 /// the correct implementation as required by the XSSO specification.
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 /// ```text
89 dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	52 /// points to ┌─────────────┐ ╔═ Question[] ═╗
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	53 /// questions ┄┄┄┄┄┄┄┄┄┄> │ *questions ┄┼┄┄┄┄┄> ║ style ║
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	54 /// └─────────────┘ ║ data ┄┄┄┄┄┄┄┄╫┄┄> ...
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	55 /// ╟──────────────╢
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	56 /// ║ style ║
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	57 /// ║ data ┄┄┄┄┄┄┄┄╫┄┄> ...
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	58 /// ╟──────────────╢
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	59 /// ║ ... ║
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	60 /// ```
89 dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	61 pub trait QuestionsTrait {
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	62 /// Allocates memory for this indirector and all its members.
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	63 fn new(messages: &[Message]) -> Result<Self>
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	64 where
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	65 Self: Sized;
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	66
89 dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	67 /// Gets the pointer that is passed .
101 94b51fa4f797 Fix memory soundness issues: Paul Fisher <paul@pfish.zone> parents: 98 diff changeset	68 fn ptr(self: Pin<&Self>) -> const const Question;
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	69
89 dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	70 /// Converts a pointer into a borrowed list of Questions.
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 79 diff changeset	71 ///
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 79 diff changeset	72 /// # Safety
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 79 diff changeset	73 ///
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 79 diff changeset	74 /// You have to provide a valid pointer.
89 dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	75 unsafe fn borrow_ptr<'a>(
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	76 ptr: const const Question,
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	77 count: usize,
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	78 ) -> impl Iterator<Item = &'a Question>;
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 79 diff changeset	79 }
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 79 diff changeset	80
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 79 diff changeset	81 #[cfg(pam_impl = "linux-pam")]
89 dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	82 pub type Questions = LinuxPamQuestions;
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 79 diff changeset	83
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 79 diff changeset	84 #[cfg(not(pam_impl = "linux-pam"))]
89 dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	85 pub type Questions = XSsoQuestions;
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 79 diff changeset	86
89 dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	87 /// The XSSO standard version of the pointer train to questions.
87 05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	88 #[derive(Debug)]
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	89 #[repr(C)]
89 dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	90 pub struct XSsoQuestions {
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	91 /// Points to the memory address where the meat of `questions` is.
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	92 /// The memory layout of Vec is not specified, and we need to return
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	93 /// a pointer to the pointer, hence we have to store it here.
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	94 pointer: *const Question,
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	95 questions: Vec<Question>,
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 79 diff changeset	96 _marker: Immovable,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 79 diff changeset	97 }
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 79 diff changeset	98
89 dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	99 impl XSsoQuestions {
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	100 fn len(&self) -> usize {
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	101 self.questions.len()
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	102 }
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	103 fn iter_mut(&mut self) -> impl Iterator<Item = &mut Question> {
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	104 self.questions.iter_mut()
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	105 }
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	106 }
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	107
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	108 impl QuestionsTrait for XSsoQuestions {
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	109 fn new(messages: &[Message]) -> Result<Self> {
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	110 let questions: Result<Vec<_>> = messages.iter().map(Question::try_from).collect();
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	111 let questions = questions?;
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	112 Ok(Self {
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	113 pointer: questions.as_ptr(),
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	114 questions,
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	115 _marker: Default::default(),
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	116 })
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 79 diff changeset	117 }
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 79 diff changeset	118
101 94b51fa4f797 Fix memory soundness issues: Paul Fisher <paul@pfish.zone> parents: 98 diff changeset	119 fn ptr(self: Pin<&Self>) -> const const Question {
89 dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	120 &self.pointer as const const Question
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 79 diff changeset	121 }
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 79 diff changeset	122
89 dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	123 unsafe fn borrow_ptr<'a>(
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	124 ptr: const const Question,
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	125 count: usize,
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	126 ) -> impl Iterator<Item = &'a Question> {
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	127 slice::from_raw_parts(*ptr, count).iter()
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 79 diff changeset	128 }
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 79 diff changeset	129 }
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 79 diff changeset	130
89 dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	131 /// The Linux version of the pointer train to questions.
87 05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	132 #[derive(Debug)]
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	133 #[repr(C)]
89 dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	134 pub struct LinuxPamQuestions {
101 94b51fa4f797 Fix memory soundness issues: Paul Fisher <paul@pfish.zone> parents: 98 diff changeset	135 #[allow(clippy::vec_box)] // we need to box vec items.
89 dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	136 /// The place where the questions are.
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	137 questions: Vec<Box<Question>>,
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	138 }
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	139
89 dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	140 impl LinuxPamQuestions {
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	141 fn len(&self) -> usize {
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	142 self.questions.len()
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	143 }
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	144
89 dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	145 fn iter_mut(&mut self) -> impl Iterator<Item = &mut Question> {
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	146 self.questions.iter_mut().map(AsMut::as_mut)
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	147 }
89 dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	148 }
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	149
89 dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	150 impl QuestionsTrait for LinuxPamQuestions {
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	151 fn new(messages: &[Message]) -> Result<Self> {
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	152 let questions: Result<_> = messages
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	153 .iter()
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	154 .map(\|msg\| Question::try_from(msg).map(Box::new))
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	155 .collect();
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	156 Ok(Self {
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	157 questions: questions?,
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	158 })
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	159 }
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	160
101 94b51fa4f797 Fix memory soundness issues: Paul Fisher <paul@pfish.zone> parents: 98 diff changeset	161 fn ptr(self: Pin<&Self>) -> const const Question {
89 dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	162 self.questions.as_ptr().cast()
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	163 }
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	164
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	165 unsafe fn borrow_ptr<'a>(
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	166 ptr: const const Question,
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	167 count: usize,
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	168 ) -> impl Iterator<Item = &'a Question> {
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	169 slice::from_raw_parts(ptr.cast::<&Question>(), count)
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	170 .iter()
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	171 .copied()
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	172 }
002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	173 }
71 58f9d2a4df38 Reorganize everything again??? Paul Fisher <paul@pfish.zone> parents: 70 diff changeset	174
87 05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	175 /// The C enum values for messages shown to the user.
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	176 #[derive(Debug, PartialEq, TryFromPrimitive, IntoPrimitive)]
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	177 #[repr(u32)]
89 dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	178 enum Style {
87 05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	179 /// Requests information from the user; will be masked when typing.
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	180 PromptEchoOff = pam_ffi::PAM_PROMPT_ECHO_OFF,
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	181 /// Requests information from the user; will not be masked.
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	182 PromptEchoOn = pam_ffi::PAM_PROMPT_ECHO_ON,
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	183 /// An error message.
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	184 ErrorMsg = pam_ffi::PAM_ERROR_MSG,
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	185 /// An informational message.
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	186 TextInfo = pam_ffi::PAM_TEXT_INFO,
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	187 /// Yes/No/Maybe conditionals. A Linux-PAM extension.
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	188 #[cfg(feature = "linux-pam-extensions")]
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	189 RadioType = pam_ffi::PAM_RADIO_TYPE,
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	190 /// For server–client non-human interaction.
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	191 ///
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	192 /// NOT part of the X/Open PAM specification.
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	193 /// A Linux-PAM extension.
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	194 #[cfg(feature = "linux-pam-extensions")]
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	195 BinaryPrompt = pam_ffi::PAM_BINARY_PROMPT,
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	196 }
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	197
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	198 impl Question {
71 58f9d2a4df38 Reorganize everything again??? Paul Fisher <paul@pfish.zone> parents: 70 diff changeset	199 /// Gets this message's data pointer as a string.
69 8f3ae0c7ab92 Rework conversation data types and make safe wrappers. Paul Fisher <paul@pfish.zone> parents: 66 diff changeset	200 ///
8f3ae0c7ab92 Rework conversation data types and make safe wrappers. Paul Fisher <paul@pfish.zone> parents: 66 diff changeset	201 /// # Safety
8f3ae0c7ab92 Rework conversation data types and make safe wrappers. Paul Fisher <paul@pfish.zone> parents: 66 diff changeset	202 ///
71 58f9d2a4df38 Reorganize everything again??? Paul Fisher <paul@pfish.zone> parents: 70 diff changeset	203 /// It's up to you to pass this only on types with a string value.
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	204 unsafe fn string_data(&self) -> Result<&str> {
98 b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	205 match self.data.as_ref() {
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	206 None => Ok(""),
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	207 Some(data) => CStr::from_ptr(CHeapBox::as_ptr(data).cast().as_ptr())
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	208 .to_str()
98 b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	209 .map_err(\|_\| ErrorCode::ConversationError),
70 9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	210 }
69 8f3ae0c7ab92 Rework conversation data types and make safe wrappers. Paul Fisher <paul@pfish.zone> parents: 66 diff changeset	211 }
8f3ae0c7ab92 Rework conversation data types and make safe wrappers. Paul Fisher <paul@pfish.zone> parents: 66 diff changeset	212
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	213 /// Gets this message's data pointer as borrowed binary data.
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	214 unsafe fn binary_data(&self) -> (&[u8], u8) {
98 b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	215 self.data
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	216 .as_ref()
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	217 .map(\|data\| CBinaryData::data(CHeapBox::as_ptr(data).cast()))
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	218 .unwrap_or_default()
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	219 }
89 dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	220 }
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	221
89 dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	222 impl TryFrom<&Message<'_>> for Question {
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	223 type Error = ErrorCode;
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	224 fn try_from(msg: &Message) -> Result<Self> {
98 b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	225 let alloc = \|style, text\| -> Result<_> {
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	226 Ok((style, unsafe {
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	227 CHeapBox::cast(CHeapString::new(text)?.into_box())
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	228 }))
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	229 };
89 dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	230 // We will only allocate heap data if we have a valid input.
98 b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	231 let (style, data): (_, CHeapBox<c_void>) = match *msg {
89 dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	232 Message::MaskedPrompt(p) => alloc(Style::PromptEchoOff, p.question()),
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	233 Message::Prompt(p) => alloc(Style::PromptEchoOn, p.question()),
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	234 Message::Error(p) => alloc(Style::ErrorMsg, p.question()),
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	235 Message::Info(p) => alloc(Style::TextInfo, p.question()),
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	236 #[cfg(feature = "linux-pam-extensions")]
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	237 Message::RadioPrompt(p) => alloc(Style::RadioType, p.question()),
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	238 #[cfg(feature = "linux-pam-extensions")]
98 b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	239 Message::BinaryPrompt(p) => Ok((Style::BinaryPrompt, unsafe {
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	240 CHeapBox::cast(CBinaryData::alloc(p.question())?)
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	241 })),
89 dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	242 #[cfg(not(feature = "linux-pam-extensions"))]
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	243 Message::RadioPrompt(_) \| Message::BinaryPrompt(_) => Err(ErrorCode::ConversationError),
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	244 }?;
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	245 Ok(Self {
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	246 style: style.into(),
98 b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	247 data: Some(data),
89 dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	248 })
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	249 }
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	250 }
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	251
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	252 impl Drop for Question {
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	253 fn drop(&mut self) {
71 58f9d2a4df38 Reorganize everything again??? Paul Fisher <paul@pfish.zone> parents: 70 diff changeset	254 // SAFETY: We either created this data or we got it from PAM.
58f9d2a4df38 Reorganize everything again??? Paul Fisher <paul@pfish.zone> parents: 70 diff changeset	255 // After this function is done, it will be zeroed out.
69 8f3ae0c7ab92 Rework conversation data types and make safe wrappers. Paul Fisher <paul@pfish.zone> parents: 66 diff changeset	256 unsafe {
87 05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	257 // This is nice-to-have. We'll try to zero out the data
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	258 // in the Question. If it's not a supported format, we skip it.
71 58f9d2a4df38 Reorganize everything again??? Paul Fisher <paul@pfish.zone> parents: 70 diff changeset	259 if let Ok(style) = Style::try_from(self.style) {
98 b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	260 let _ = match style {
87 05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	261 #[cfg(feature = "linux-pam-extensions")]
98 b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	262 Style::BinaryPrompt => self
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	263 .data
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	264 .as_ref()
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	265 .map(\|p\| CBinaryData::zero_contents(CHeapBox::as_ptr(p).cast())),
87 05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	266 #[cfg(feature = "linux-pam-extensions")]
98 b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	267 Style::RadioType => self
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	268 .data
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	269 .as_ref()
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	270 .map(\|p\| CHeapString::zero(CHeapBox::as_ptr(p).cast())),
71 58f9d2a4df38 Reorganize everything again??? Paul Fisher <paul@pfish.zone> parents: 70 diff changeset	271 Style::TextInfo
58f9d2a4df38 Reorganize everything again??? Paul Fisher <paul@pfish.zone> parents: 70 diff changeset	272 \| Style::ErrorMsg
58f9d2a4df38 Reorganize everything again??? Paul Fisher <paul@pfish.zone> parents: 70 diff changeset	273 \| Style::PromptEchoOff
98 b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	274 \| Style::PromptEchoOn => self
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	275 .data
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	276 .as_ref()
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	277 .map(\|p\| CHeapString::zero(CHeapBox::as_ptr(p).cast())),
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 93 diff changeset	278 };
71 58f9d2a4df38 Reorganize everything again??? Paul Fisher <paul@pfish.zone> parents: 70 diff changeset	279 };
69 8f3ae0c7ab92 Rework conversation data types and make safe wrappers. Paul Fisher <paul@pfish.zone> parents: 66 diff changeset	280 }
8f3ae0c7ab92 Rework conversation data types and make safe wrappers. Paul Fisher <paul@pfish.zone> parents: 66 diff changeset	281 }
8f3ae0c7ab92 Rework conversation data types and make safe wrappers. Paul Fisher <paul@pfish.zone> parents: 66 diff changeset	282 }
8f3ae0c7ab92 Rework conversation data types and make safe wrappers. Paul Fisher <paul@pfish.zone> parents: 66 diff changeset	283
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	284 impl<'a> TryFrom<&'a Question> for OwnedMessage<'a> {
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	285 type Error = ErrorCode;
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	286 fn try_from(question: &'a Question) -> Result<Self> {
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	287 let style: Style = question
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	288 .style
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	289 .try_into()
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	290 .map_err(\|_\| ErrorCode::ConversationError)?;
87 05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	291 // SAFETY: In all cases below, we're creating questions based on
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	292 // known types that we get from PAM and the inner types it should have.
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	293 let prompt = unsafe {
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	294 match style {
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	295 Style::PromptEchoOff => {
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	296 Self::MaskedPrompt(MaskedQAndA::new(question.string_data()?))
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	297 }
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	298 Style::PromptEchoOn => Self::Prompt(QAndA::new(question.string_data()?)),
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	299 Style::ErrorMsg => Self::Error(ErrorMsg::new(question.string_data()?)),
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	300 Style::TextInfo => Self::Info(InfoMsg::new(question.string_data()?)),
87 05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	301 #[cfg(feature = "linux-pam-extensions")]
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	302 Style::RadioType => Self::RadioPrompt(RadioQAndA::new(question.string_data()?)),
87 05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	303 #[cfg(feature = "linux-pam-extensions")]
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	304 Style::BinaryPrompt => Self::BinaryPrompt(BinaryQAndA::new(question.binary_data())),
77 351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	305 }
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	306 };
351bdc13005e Update the libpam module to work with the new structure. Paul Fisher <paul@pfish.zone> parents: 75 diff changeset	307 Ok(prompt)
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	308 }
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	309 }
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	310
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	311 #[cfg(test)]
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	312 mod tests {
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	313
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 79 diff changeset	314 macro_rules! assert_matches {
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 79 diff changeset	315 ($id:ident => $variant:path, $q:expr) => {
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 79 diff changeset	316 if let $variant($id) = $id {
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 79 diff changeset	317 assert_eq!($q, $id.question());
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 79 diff changeset	318 } else {
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 79 diff changeset	319 panic!("mismatched enum variant {x:?}", x = $id);
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 79 diff changeset	320 }
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 79 diff changeset	321 };
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 79 diff changeset	322 }
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	323
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 79 diff changeset	324 macro_rules! tests { ($fn_name:ident<$typ:ident>) => {
87 05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	325 mod $fn_name {
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	326 use super::super::*;
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	327 #[test]
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	328 fn standard() {
101 94b51fa4f797 Fix memory soundness issues: Paul Fisher <paul@pfish.zone> parents: 98 diff changeset	329 let interrogation = Box::pin(<$typ>::new(&[
87 05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	330 MaskedQAndA::new("hocus pocus").message(),
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	331 QAndA::new("what").message(),
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	332 QAndA::new("who").message(),
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	333 InfoMsg::new("hey").message(),
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	334 ErrorMsg::new("gasp").message(),
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	335 ])
101 94b51fa4f797 Fix memory soundness issues: Paul Fisher <paul@pfish.zone> parents: 98 diff changeset	336 .unwrap());
94b51fa4f797 Fix memory soundness issues: Paul Fisher <paul@pfish.zone> parents: 98 diff changeset	337 let indirect = interrogation.as_ref().ptr();
87 05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	338
89 dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	339 let remade = unsafe { $typ::borrow_ptr(indirect, interrogation.len()) };
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	340 let messages: Vec<OwnedMessage> = remade
87 05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	341 .map(TryInto::try_into)
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	342 .collect::<Result<_>>()
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	343 .unwrap();
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	344 let [masked, what, who, hey, gasp] = messages.try_into().unwrap();
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	345 assert_matches!(masked => OwnedMessage::MaskedPrompt, "hocus pocus");
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	346 assert_matches!(what => OwnedMessage::Prompt, "what");
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	347 assert_matches!(who => OwnedMessage::Prompt, "who");
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	348 assert_matches!(hey => OwnedMessage::Info, "hey");
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	349 assert_matches!(gasp => OwnedMessage::Error, "gasp");
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	350 }
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 79 diff changeset	351
87 05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	352 #[test]
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	353 #[cfg(not(feature = "linux-pam-extensions"))]
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	354 fn no_linux_extensions() {
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	355 use crate::conv::{BinaryQAndA, RadioQAndA};
89 dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	356 <$typ>::new(&[
87 05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	357 BinaryQAndA::new((&[5, 4, 3, 2, 1], 66)).message(),
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	358 RadioQAndA::new("you must choose").message(),
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	359 ]).unwrap_err();
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	360 }
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	361
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	362 #[test]
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	363 #[cfg(feature = "linux-pam-extensions")]
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	364 fn linux_extensions() {
101 94b51fa4f797 Fix memory soundness issues: Paul Fisher <paul@pfish.zone> parents: 98 diff changeset	365 let interrogation = Box::pin(<$typ>::new(&[
87 05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	366 BinaryQAndA::new((&[5, 4, 3, 2, 1], 66)).message(),
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	367 RadioQAndA::new("you must choose").message(),
101 94b51fa4f797 Fix memory soundness issues: Paul Fisher <paul@pfish.zone> parents: 98 diff changeset	368 ]).unwrap());
94b51fa4f797 Fix memory soundness issues: Paul Fisher <paul@pfish.zone> parents: 98 diff changeset	369 let indirect = interrogation.as_ref().ptr();
87 05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	370
89 dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	371 let remade = unsafe { $typ::borrow_ptr(indirect, interrogation.len()) };
93 efc2b56c8928 Remove undefined behavior per MIRI. Paul Fisher <paul@pfish.zone> parents: 89 diff changeset	372 let messages: Vec<OwnedMessage> = remade
87 05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	373 .map(TryInto::try_into)
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	374 .collect::<Result<_>>()
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	375 .unwrap();
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	376 let [bin, choose] = messages.try_into().unwrap();
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	377 assert_matches!(bin => OwnedMessage::BinaryPrompt, (&[5, 4, 3, 2, 1][..], 66));
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	378 assert_matches!(choose => OwnedMessage::RadioPrompt, "you must choose");
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	379 }
78 002adfb98c5c Rename files, reorder structs, remove annoying BorrowedBinaryData type. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	380 }
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 79 diff changeset	381 }}
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 79 diff changeset	382
89 dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	383 tests!(test_xsso<XSsoQuestions>);
dd3e9c4bcde3 Simplify memory management in Questions. Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	384 tests!(test_linux<LinuxPamQuestions>);
69 8f3ae0c7ab92 Rework conversation data types and make safe wrappers. Paul Fisher <paul@pfish.zone> parents: 66 diff changeset	385 }

Mercurial > crates > nonstick

annotate src/libpam/question.rs @ 103:dfcd96a74ac4 default tip