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

annotate src/libpam/handle.rs @ 153:3036f2e6a022

Add module-specific data support. This adds support for a safe form of `pam_get_data` and `pam_set_data`, where data is (as best as humanly possible) type-safe and restricted to only the module where it was created.

author	Paul Fisher <paul@pfish.zone>
date	Tue, 08 Jul 2025 00:31:54 -0400
parents	4b3a5095f68c
children	ab8020566cd9

rev	line source
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	1 use super::conversation::{OwnedConversation, PamConv};
153 3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	2 use crate::_doc::{guide, linklist, man7, stdlinks};
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	3 use crate::constants::{ErrorCode, Result};
130 80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 118 diff changeset	4 use crate::conv::Exchange;
98 b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 97 diff changeset	5 use crate::environ::EnvironMapMut;
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	6 use crate::handle::PamShared;
146 1bc52025156b Split PAM items into their own separate struct. Paul Fisher <paul@pfish.zone> parents: 144 diff changeset	7 use crate::items::{Items, ItemsMut};
98 b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 97 diff changeset	8 use crate::libpam::environ::{LibPamEnviron, LibPamEnvironMut};
146 1bc52025156b Split PAM items into their own separate struct. Paul Fisher <paul@pfish.zone> parents: 144 diff changeset	9 use crate::libpam::items::{LibPamItems, LibPamItemsMut};
1bc52025156b Split PAM items into their own separate struct. Paul Fisher <paul@pfish.zone> parents: 144 diff changeset	10 use crate::libpam::{items, memory};
116 a12706e42c9d Logging, macros, and building: Paul Fisher <paul@pfish.zone> parents: 105 diff changeset	11 use crate::logging::{Level, Location};
146 1bc52025156b Split PAM items into their own separate struct. Paul Fisher <paul@pfish.zone> parents: 144 diff changeset	12 use crate::{Conversation, EnvironMap, Flags, ModuleClient, Transaction};
148 4b3a5095f68c Move libpam-sys helpers into their own library. Paul Fisher <paul@pfish.zone> parents: 147 diff changeset	13 use libpam_sys_consts::constants;
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	14 use num_enum::{IntoPrimitive, TryFromPrimitive};
153 3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	15 use std::any::TypeId;
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	16 use std::cell::Cell;
153 3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	17 use std::ffi::{c_char, c_int, c_void, CString, OsStr, OsString};
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	18 use std::mem::ManuallyDrop;
143 ebb71a412b58 Turn everything into OsString and Just Walk Out! for strings with nul. Paul Fisher <paul@pfish.zone> parents: 141 diff changeset	19 use std::os::unix::ffi::OsStrExt;
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	20 use std::ptr;
130 80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 118 diff changeset	21 use std::ptr::NonNull;
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	22
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	23 /// An owned PAM handle.
144 56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	24 pub struct LibPamTransaction<C: Conversation> {
101 94b51fa4f797 Fix memory soundness issues: Paul Fisher <paul@pfish.zone> parents: 98 diff changeset	25 /// The handle itself.
144 56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	26 handle: ManuallyDrop<LibPamHandle>,
101 94b51fa4f797 Fix memory soundness issues: Paul Fisher <paul@pfish.zone> parents: 98 diff changeset	27 /// The last return value from the handle.
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	28 last_return: Cell<Result<()>>,
101 94b51fa4f797 Fix memory soundness issues: Paul Fisher <paul@pfish.zone> parents: 98 diff changeset	29 /// If set, the Conversation that this PAM handle owns.
102 94eb11cb1798 Improve documentation for pam_start. Paul Fisher <paul@pfish.zone> parents: 101 diff changeset	30 ///
94eb11cb1798 Improve documentation for pam_start. Paul Fisher <paul@pfish.zone> parents: 101 diff changeset	31 /// We have to hold on to this because the PAM specification doesn't
94eb11cb1798 Improve documentation for pam_start. Paul Fisher <paul@pfish.zone> parents: 101 diff changeset	32 /// actually say what the PAM library should do with a passed-in
94eb11cb1798 Improve documentation for pam_start. Paul Fisher <paul@pfish.zone> parents: 101 diff changeset	33 /// conversation. Linux-PAM copies the contents of the `pam_conv` struct
94eb11cb1798 Improve documentation for pam_start. Paul Fisher <paul@pfish.zone> parents: 101 diff changeset	34 /// that you pass in to `pam_start`, but OpenPAM uses the pointer itself,
94eb11cb1798 Improve documentation for pam_start. Paul Fisher <paul@pfish.zone> parents: 101 diff changeset	35 /// so you have to keep it in one place.
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	36 conversation: Box<OwnedConversation<C>>,
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	37 }
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	38
97 efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	39 #[derive(Debug, PartialEq)]
144 56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	40 pub struct TransactionBuilder {
143 ebb71a412b58 Turn everything into OsString and Just Walk Out! for strings with nul. Paul Fisher <paul@pfish.zone> parents: 141 diff changeset	41 service_name: OsString,
ebb71a412b58 Turn everything into OsString and Just Walk Out! for strings with nul. Paul Fisher <paul@pfish.zone> parents: 141 diff changeset	42 username: Option<OsString>,
97 efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	43 }
efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	44
144 56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	45 impl TransactionBuilder {
97 efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	46 /// Updates the service name.
143 ebb71a412b58 Turn everything into OsString and Just Walk Out! for strings with nul. Paul Fisher <paul@pfish.zone> parents: 141 diff changeset	47 pub fn service_name(mut self, service_name: OsString) -> Self {
98 b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 97 diff changeset	48 self.service_name = service_name;
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 97 diff changeset	49 self
97 efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	50 }
102 94eb11cb1798 Improve documentation for pam_start. Paul Fisher <paul@pfish.zone> parents: 101 diff changeset	51 /// Sets the username. Setting this will avoid the need for an extra
94eb11cb1798 Improve documentation for pam_start. Paul Fisher <paul@pfish.zone> parents: 101 diff changeset	52 /// round trip through the conversation and may otherwise improve
94eb11cb1798 Improve documentation for pam_start. Paul Fisher <paul@pfish.zone> parents: 101 diff changeset	53 /// the login experience.
143 ebb71a412b58 Turn everything into OsString and Just Walk Out! for strings with nul. Paul Fisher <paul@pfish.zone> parents: 141 diff changeset	54 pub fn username(mut self, username: OsString) -> Self {
98 b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 97 diff changeset	55 self.username = Some(username);
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 97 diff changeset	56 self
97 efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	57 }
102 94eb11cb1798 Improve documentation for pam_start. Paul Fisher <paul@pfish.zone> parents: 101 diff changeset	58 /// Builds a PAM handle and starts the transaction.
144 56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	59 pub fn build(self, conv: impl Conversation) -> Result<LibPamTransaction<impl Conversation>> {
56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	60 LibPamTransaction::start(self.service_name, self.username, conv)
97 efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	61 }
efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	62 }
efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	63
144 56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	64 impl<C: Conversation> LibPamTransaction<C> {
102 94eb11cb1798 Improve documentation for pam_start. Paul Fisher <paul@pfish.zone> parents: 101 diff changeset	65 /// Creates a builder to start a PAM transaction for the given service.
94eb11cb1798 Improve documentation for pam_start. Paul Fisher <paul@pfish.zone> parents: 101 diff changeset	66 ///
94eb11cb1798 Improve documentation for pam_start. Paul Fisher <paul@pfish.zone> parents: 101 diff changeset	67 /// The service name is what controls the steps and checks PAM goes through
94eb11cb1798 Improve documentation for pam_start. Paul Fisher <paul@pfish.zone> parents: 101 diff changeset	68 /// when authenticating a user. This corresponds to the configuration file
94eb11cb1798 Improve documentation for pam_start. Paul Fisher <paul@pfish.zone> parents: 101 diff changeset	69 /// named <code>/etc/pam.d/<var>service_name</var></code>.
94eb11cb1798 Improve documentation for pam_start. Paul Fisher <paul@pfish.zone> parents: 101 diff changeset	70 ///
103 dfcd96a74ac4 write a truly prodigious amount of documentation Paul Fisher <paul@pfish.zone> parents: 102 diff changeset	71 /// # References
116 a12706e42c9d Logging, macros, and building: Paul Fisher <paul@pfish.zone> parents: 105 diff changeset	72 #[doc = linklist!(pam_start: adg, _std)]
102 94eb11cb1798 Improve documentation for pam_start. Paul Fisher <paul@pfish.zone> parents: 101 diff changeset	73 ///
116 a12706e42c9d Logging, macros, and building: Paul Fisher <paul@pfish.zone> parents: 105 diff changeset	74 #[doc = stdlinks!(3 pam_start)]
a12706e42c9d Logging, macros, and building: Paul Fisher <paul@pfish.zone> parents: 105 diff changeset	75 #[doc = guide!(adg: "adg-interface-by-app-expected.html#adg-pam_start")]
144 56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	76 pub fn build_with_service(service_name: OsString) -> TransactionBuilder {
56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	77 TransactionBuilder {
103 dfcd96a74ac4 write a truly prodigious amount of documentation Paul Fisher <paul@pfish.zone> parents: 102 diff changeset	78 service_name,
dfcd96a74ac4 write a truly prodigious amount of documentation Paul Fisher <paul@pfish.zone> parents: 102 diff changeset	79 username: None,
dfcd96a74ac4 write a truly prodigious amount of documentation Paul Fisher <paul@pfish.zone> parents: 102 diff changeset	80 }
97 efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	81 }
102 94eb11cb1798 Improve documentation for pam_start. Paul Fisher <paul@pfish.zone> parents: 101 diff changeset	82
143 ebb71a412b58 Turn everything into OsString and Just Walk Out! for strings with nul. Paul Fisher <paul@pfish.zone> parents: 141 diff changeset	83 fn start(service_name: OsString, username: Option<OsString>, conversation: C) -> Result<Self> {
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	84 let conv = Box::new(OwnedConversation::new(conversation));
143 ebb71a412b58 Turn everything into OsString and Just Walk Out! for strings with nul. Paul Fisher <paul@pfish.zone> parents: 141 diff changeset	85 let service_cstr = CString::new(service_name.as_bytes()).expect("null is forbidden");
ebb71a412b58 Turn everything into OsString and Just Walk Out! for strings with nul. Paul Fisher <paul@pfish.zone> parents: 141 diff changeset	86 let username_cstr = memory::option_cstr_os(username.as_deref());
ebb71a412b58 Turn everything into OsString and Just Walk Out! for strings with nul. Paul Fisher <paul@pfish.zone> parents: 141 diff changeset	87 let username_cstr = memory::prompt_ptr(username_cstr.as_deref());
97 efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	88
130 80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 118 diff changeset	89 let mut handle: *mut libpam_sys::pam_handle = ptr::null_mut();
97 efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	90 // SAFETY: We've set everything up properly to call `pam_start`.
efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	91 // The returned value will be a valid pointer provided the result is OK.
101 94b51fa4f797 Fix memory soundness issues: Paul Fisher <paul@pfish.zone> parents: 98 diff changeset	92 let result = unsafe {
130 80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 118 diff changeset	93 libpam_sys::pam_start(
101 94b51fa4f797 Fix memory soundness issues: Paul Fisher <paul@pfish.zone> parents: 98 diff changeset	94 service_cstr.as_ptr(),
94b51fa4f797 Fix memory soundness issues: Paul Fisher <paul@pfish.zone> parents: 98 diff changeset	95 username_cstr,
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	96 (conv.as_ref() as *const OwnedConversation<C>)
130 80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 118 diff changeset	97 .cast_mut()
80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 118 diff changeset	98 .cast(),
101 94b51fa4f797 Fix memory soundness issues: Paul Fisher <paul@pfish.zone> parents: 98 diff changeset	99 &mut handle,
94b51fa4f797 Fix memory soundness issues: Paul Fisher <paul@pfish.zone> parents: 98 diff changeset	100 )
94b51fa4f797 Fix memory soundness issues: Paul Fisher <paul@pfish.zone> parents: 98 diff changeset	101 };
97 efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	102 ErrorCode::result_from(result)?;
130 80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 118 diff changeset	103 let handle = NonNull::new(handle).ok_or(ErrorCode::BufferError)?;
98 b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 97 diff changeset	104 Ok(Self {
144 56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	105 handle: ManuallyDrop::new(LibPamHandle(handle)),
97 efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	106 last_return: Cell::new(Ok(())),
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	107 conversation: conv,
97 efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	108 })
efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	109 }
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	110
153 3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	111 #[cfg_attr(
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	112 pam_impl = "LinuxPam",
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	113 doc = "Ends the PAM transaction \"quietly\" (on Linux-PAM only)."
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	114 )]
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	115 #[cfg_attr(
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	116 not(pam_impl = "LinuxPam"),
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	117 doc = "Exactly equivalent to `drop(self)` (except on Linux-PAM)."
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	118 )]
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	119 ///
153 3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	120 /// On Linux-PAM, this is equivalent to passing the `PAM_DATA_SILENT` flag
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	121 /// to [`pam_end` on Linux-PAM][man7], which signals that data cleanup
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	122 /// should "not treat the call too seriously" \[sic].
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	123 ///
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	124 /// On other platforms, this is no different than letting the transaction
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	125 /// end on its own.
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	126 ///
153 3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	127 #[doc = man7!(3 pam_end)]
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	128 pub fn end_silent(self) {
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	129 #[cfg(pam_impl = "LinuxPam")]
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	130 {
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	131 let mut me = ManuallyDrop::new(self);
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	132 me.end_internal(libpam_sys::PAM_DATA_SILENT);
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	133 }
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	134 // If it's not LinuxPam, we just drop normally.
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	135 }
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	136
153 3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	137 /// Internal "end" function, which binary-ORs the status with `or_with`.
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	138 fn end_internal(&mut self, or_with: i32) {
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	139 let result = ErrorCode::result_to_c(self.last_return.get()) \| or_with;
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	140 unsafe { libpam_sys::pam_end(self.handle.raw_mut(), result) };
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	141 }
97 efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	142 }
efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	143
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	144 macro_rules! wrap {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	145 (fn $name:ident { $pam_func:ident }) => {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	146 fn $name(&mut self, flags: Flags) -> Result<()> {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	147 ErrorCode::result_from(unsafe { libpam_sys::$pam_func(self.0.as_mut(), flags.bits()) })
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	148 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	149 };
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	150 }
97 efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	151
144 56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	152 impl Transaction for LibPamHandle {
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	153 wrap!(fn authenticate { pam_authenticate });
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	154 wrap!(fn account_management { pam_acct_mgmt });
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	155 wrap!(fn change_authtok { pam_chauthtok });
97 efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	156 }
efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	157
147 4d7333337569 Implement Transaction for LibPamTransaction. Paul Fisher <paul@pfish.zone> parents: 146 diff changeset	158 // TODO: pam_setcred - app
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	159 // pam_open_session - app
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	160 // pam_close_session - app
147 4d7333337569 Implement Transaction for LibPamTransaction. Paul Fisher <paul@pfish.zone> parents: 146 diff changeset	161 // pam_set/get_data - module
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	162
144 56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	163 impl<C: Conversation> Drop for LibPamTransaction<C> {
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	164 /// Closes the PAM session on an owned PAM handle.
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	165 ///
103 dfcd96a74ac4 write a truly prodigious amount of documentation Paul Fisher <paul@pfish.zone> parents: 102 diff changeset	166 /// This internally calls `pam_end` with the appropriate error code.
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	167 ///
103 dfcd96a74ac4 write a truly prodigious amount of documentation Paul Fisher <paul@pfish.zone> parents: 102 diff changeset	168 /// # References
116 a12706e42c9d Logging, macros, and building: Paul Fisher <paul@pfish.zone> parents: 105 diff changeset	169 #[doc = linklist!(pam_end: adg, _std)]
103 dfcd96a74ac4 write a truly prodigious amount of documentation Paul Fisher <paul@pfish.zone> parents: 102 diff changeset	170 ///
116 a12706e42c9d Logging, macros, and building: Paul Fisher <paul@pfish.zone> parents: 105 diff changeset	171 #[doc = guide!(adg: "adg-interface-by-app-expected.html#adg-pam_end")]
a12706e42c9d Logging, macros, and building: Paul Fisher <paul@pfish.zone> parents: 105 diff changeset	172 #[doc = stdlinks!(3 pam_end)]
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	173 fn drop(&mut self) {
153 3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	174 self.end_internal(0)
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	175 }
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	176 }
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	177
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	178 macro_rules! delegate {
98 b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 97 diff changeset	179 // First have the kind that save the result after delegation.
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	180 (fn $meth:ident(&self $(, $param:ident: $typ:ty)*) -> Result<$ret:ty>) => {
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	181 fn $meth(&self $(, $param: $typ)*) -> Result<$ret> {
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	182 let result = self.handle.$meth($($param),*);
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	183 self.last_return.set(split(&result));
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	184 result
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	185 }
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	186 };
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	187 (fn $meth:ident(&mut self $(, $param:ident: $typ:ty)*) -> Result<$ret:ty>) => {
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	188 fn $meth(&mut self $(, $param: $typ)*) -> Result<$ret> {
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	189 let result = self.handle.$meth($($param),*);
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	190 self.last_return.set(split(&result));
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	191 result
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	192 }
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	193 };
98 b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 97 diff changeset	194 // Then have the kind that are just raw delegates
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 97 diff changeset	195 (fn $meth:ident(&self $(, $param:ident: $typ:ty)*) -> $ret:ty) => {
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 97 diff changeset	196 fn $meth(&self $(, $param: $typ)*) -> $ret {
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 97 diff changeset	197 self.handle.$meth($($param),*)
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 97 diff changeset	198 }
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 97 diff changeset	199 };
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 97 diff changeset	200 (fn $meth:ident(&mut self $(, $param:ident: $typ:ty)*) -> $ret:ty) => {
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 97 diff changeset	201 fn $meth(&mut self $(, $param: $typ)*) -> $ret {
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 97 diff changeset	202 self.handle.$meth($($param),*)
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 97 diff changeset	203 }
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 97 diff changeset	204 };
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 97 diff changeset	205 // Then have item getters / setters
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	206 (get = $get:ident$(, set = $set:ident)?) => {
143 ebb71a412b58 Turn everything into OsString and Just Walk Out! for strings with nul. Paul Fisher <paul@pfish.zone> parents: 141 diff changeset	207 delegate!(fn $get(&self) -> Result<Option<OsString>>);
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	208 $(delegate!(set = $set);)?
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	209 };
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	210 (set = $set:ident) => {
143 ebb71a412b58 Turn everything into OsString and Just Walk Out! for strings with nul. Paul Fisher <paul@pfish.zone> parents: 141 diff changeset	211 delegate!(fn $set(&mut self, value: Option<&OsStr>) -> Result<()>);
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	212 };
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	213 }
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	214
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	215 fn split<T>(result: &Result<T>) -> Result<()> {
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	216 result.as_ref().map(drop).map_err(\|&e\| e)
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	217 }
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	218
147 4d7333337569 Implement Transaction for LibPamTransaction. Paul Fisher <paul@pfish.zone> parents: 146 diff changeset	219 impl<C: Conversation> Transaction for LibPamTransaction<C> {
4d7333337569 Implement Transaction for LibPamTransaction. Paul Fisher <paul@pfish.zone> parents: 146 diff changeset	220 delegate!(fn authenticate(&mut self, flags: Flags) -> Result<()>);
4d7333337569 Implement Transaction for LibPamTransaction. Paul Fisher <paul@pfish.zone> parents: 146 diff changeset	221 delegate!(fn account_management(&mut self, flags: Flags) -> Result<()>);
4d7333337569 Implement Transaction for LibPamTransaction. Paul Fisher <paul@pfish.zone> parents: 146 diff changeset	222 delegate!(fn change_authtok(&mut self, flags: Flags) -> Result<()>);
4d7333337569 Implement Transaction for LibPamTransaction. Paul Fisher <paul@pfish.zone> parents: 146 diff changeset	223 }
4d7333337569 Implement Transaction for LibPamTransaction. Paul Fisher <paul@pfish.zone> parents: 146 diff changeset	224
144 56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	225 impl<C: Conversation> PamShared for LibPamTransaction<C> {
116 a12706e42c9d Logging, macros, and building: Paul Fisher <paul@pfish.zone> parents: 105 diff changeset	226 delegate!(fn log(&self, level: Level, location: Location<'_>, entry: &str) -> ());
98 b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 97 diff changeset	227 delegate!(fn environ(&self) -> impl EnvironMap);
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 97 diff changeset	228 delegate!(fn environ_mut(&mut self) -> impl EnvironMapMut);
143 ebb71a412b58 Turn everything into OsString and Just Walk Out! for strings with nul. Paul Fisher <paul@pfish.zone> parents: 141 diff changeset	229 delegate!(fn username(&mut self, prompt: Option<&OsStr>) -> Result<OsString>);
146 1bc52025156b Split PAM items into their own separate struct. Paul Fisher <paul@pfish.zone> parents: 144 diff changeset	230 delegate!(fn items(&self) -> impl Items);
1bc52025156b Split PAM items into their own separate struct. Paul Fisher <paul@pfish.zone> parents: 144 diff changeset	231 delegate!(fn items_mut(&mut self) -> impl ItemsMut);
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	232 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	233
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	234 /// An owned variation of a basic PAM handle.
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	235 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	236 /// This is the most basic version of a wrapped PAM handle. It's mostly used
144 56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	237 /// as the inside of the [`LibPamTransaction`], but can also be used to "adopt"
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	238 /// a PAM handle created by another library.
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	239 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	240 /// If [`Self::end`] is not called, this will always call `pam_end` reporting
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	241 /// successful completion.
144 56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	242 #[repr(transparent)]
56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	243 pub struct LibPamHandle(NonNull<libpam_sys::pam_handle>);
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	244
144 56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	245 impl LibPamHandle {
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	246 /// Takes ownership of the pointer to the given PAM handle.
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	247 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	248 /// Do not use this just to get a reference to a PAM handle.
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	249 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	250 /// # Safety
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	251 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	252 /// - The pointer must point to a valid PAM handle.
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	253 /// - The conversation associated with the handle must remain valid
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	254 /// for as long as the handle is open.
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	255 pub unsafe fn from_ptr(handle: NonNull<libpam_sys::pam_handle>) -> Self {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	256 Self(handle)
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	257 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	258
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	259 /// Ends the transaction, reporting `error_code` to cleanup callbacks.
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	260 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	261 /// # References
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	262 #[doc = linklist!(pam_end: adg, _std)]
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	263 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	264 #[doc = guide!(adg: "adg-interface-by-app-expected.html#adg-pam_end")]
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	265 #[doc = stdlinks!(3 pam_end)]
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	266 pub fn end(self, result: Result<()>) {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	267 let mut me = ManuallyDrop::new(self);
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	268 unsafe { libpam_sys::pam_end(me.raw_mut(), ErrorCode::result_to_c(result)) };
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	269 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	270
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	271 #[cfg_attr(
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	272 not(pam_impl = "LinuxPam"),
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	273 doc = "Exactly equivalent to [`Self::end`], except on Linux-PAM."
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	274 )]
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	275 #[cfg_attr(
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	276 pam_impl = "LinuxPam",
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	277 doc = "Ends the transaction \"quietly\", reporting `error_code` to cleanup callbacks."
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	278 )]
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	279 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	280 /// On Linux-PAM only, this sets the
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	281 /// [`PAM_DATA_SILENT`](libpam_sys::PAM_DATA_SILENT) flag on the flags
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	282 /// passed to the cleanup callbacks. This conventionally means that this
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	283 /// `pam_end` call is occurring on a forked process, and that a session
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	284 /// may still be open on the parent process, and modules "should not treat
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	285 /// the call too seriously".
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	286 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	287 /// # References
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	288 #[doc = linklist!(pam_end: adg, _std)]
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	289 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	290 #[doc = guide!(adg: "adg-interface-by-app-expected.html#adg-pam_end")]
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	291 #[doc = stdlinks!(3 pam_end)]
153 3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	292 pub fn end_silent(self, result: Result<()>) {
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	293 let mut me = ManuallyDrop::new(self);
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	294 let result = ErrorCode::result_to_c(result);
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	295 #[cfg(pam_impl = "LinuxPam")]
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	296 let result = result \| libpam_sys::PAM_DATA_SILENT;
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	297 unsafe {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	298 libpam_sys::pam_end(me.raw_mut(), result);
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	299 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	300 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	301
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	302 /// Consumes this and gives you back the raw PAM handle.
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	303 pub fn into_inner(self) -> NonNull<libpam_sys::pam_handle> {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	304 let me = ManuallyDrop::new(self);
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	305 me.0
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	306 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	307
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	308 /// Gets a reference to the inner PAM handle.
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	309 pub fn raw_ref(&self) -> &libpam_sys::pam_handle {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	310 unsafe { self.0.as_ref() }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	311 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	312 /// Gets a mutable reference to the inner PAM handle.
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	313 pub fn raw_mut(&mut self) -> &mut libpam_sys::pam_handle {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	314 unsafe { self.0.as_mut() }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	315 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	316 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	317
144 56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	318 impl Drop for LibPamHandle {
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	319 fn drop(&mut self) {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	320 unsafe { libpam_sys::pam_end(self.0.as_mut(), 0) };
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	321 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	322 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	323
144 56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	324 impl PamShared for LibPamHandle {
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	325 #[cfg(any())]
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	326 fn log(&self, level: Level, loc: Location<'_>, entry: &str) {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	327 let entry = match CString::new(entry).or_else(\|_\| CString::new(dbg!(entry))) {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	328 Ok(cstr) => cstr,
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	329 _ => return,
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	330 };
143 ebb71a412b58 Turn everything into OsString and Just Walk Out! for strings with nul. Paul Fisher <paul@pfish.zone> parents: 141 diff changeset	331 #[cfg(pam_impl = "LinuxPam")]
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	332 {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	333 _ = loc;
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	334 // SAFETY: We're calling this function with a known value.
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	335 unsafe {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	336 libpam_sys::pam_syslog(self, level as c_int, "%s\0".as_ptr().cast(), entry.as_ptr())
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	337 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	338 }
143 ebb71a412b58 Turn everything into OsString and Just Walk Out! for strings with nul. Paul Fisher <paul@pfish.zone> parents: 141 diff changeset	339 #[cfg(pam_impl = "OpenPam")]
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	340 {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	341 let func = CString::new(loc.function).unwrap_or(CString::default());
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	342 // SAFETY: We're calling this function with a known value.
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	343 unsafe {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	344 libpam_sys::_openpam_log(
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	345 level as c_int,
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	346 func.as_ptr(),
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	347 "%s\0".as_ptr().cast(),
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	348 entry.as_ptr(),
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	349 )
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	350 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	351 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	352 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	353
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	354 fn log(&self, _level: Level, _loc: Location<'_>, _entry: &str) {}
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	355
143 ebb71a412b58 Turn everything into OsString and Just Walk Out! for strings with nul. Paul Fisher <paul@pfish.zone> parents: 141 diff changeset	356 fn username(&mut self, prompt: Option<&OsStr>) -> Result<OsString> {
ebb71a412b58 Turn everything into OsString and Just Walk Out! for strings with nul. Paul Fisher <paul@pfish.zone> parents: 141 diff changeset	357 let prompt = memory::option_cstr_os(prompt);
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	358 let mut output: *const c_char = ptr::null();
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	359 let ret = unsafe {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	360 libpam_sys::pam_get_user(
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	361 self.raw_mut(),
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	362 &mut output,
143 ebb71a412b58 Turn everything into OsString and Just Walk Out! for strings with nul. Paul Fisher <paul@pfish.zone> parents: 141 diff changeset	363 memory::prompt_ptr(prompt.as_deref()),
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	364 )
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	365 };
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	366 ErrorCode::result_from(ret)?;
143 ebb71a412b58 Turn everything into OsString and Just Walk Out! for strings with nul. Paul Fisher <paul@pfish.zone> parents: 141 diff changeset	367 Ok(unsafe { memory::copy_pam_string(output).ok_or(ErrorCode::ConversationError)? })
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	368 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	369
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	370 fn environ(&self) -> impl EnvironMap {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	371 LibPamEnviron::new(self)
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	372 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	373
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	374 fn environ_mut(&mut self) -> impl EnvironMapMut {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	375 LibPamEnvironMut::new(self)
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	376 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	377
146 1bc52025156b Split PAM items into their own separate struct. Paul Fisher <paul@pfish.zone> parents: 144 diff changeset	378 fn items(&self) -> impl Items {
1bc52025156b Split PAM items into their own separate struct. Paul Fisher <paul@pfish.zone> parents: 144 diff changeset	379 LibPamItems(self)
1bc52025156b Split PAM items into their own separate struct. Paul Fisher <paul@pfish.zone> parents: 144 diff changeset	380 }
1bc52025156b Split PAM items into their own separate struct. Paul Fisher <paul@pfish.zone> parents: 144 diff changeset	381
1bc52025156b Split PAM items into their own separate struct. Paul Fisher <paul@pfish.zone> parents: 144 diff changeset	382 fn items_mut(&mut self) -> impl ItemsMut {
1bc52025156b Split PAM items into their own separate struct. Paul Fisher <paul@pfish.zone> parents: 144 diff changeset	383 LibPamItemsMut(self)
1bc52025156b Split PAM items into their own separate struct. Paul Fisher <paul@pfish.zone> parents: 144 diff changeset	384 }
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	385 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	386
144 56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	387 impl Conversation for LibPamHandle {
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	388 fn communicate(&self, messages: &[Exchange]) {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	389 match self.conversation_item() {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	390 Ok(conv) => conv.communicate(messages),
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	391 Err(e) => {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	392 for msg in messages {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	393 msg.set_error(e)
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	394 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	395 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	396 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	397 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	398 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	399
146 1bc52025156b Split PAM items into their own separate struct. Paul Fisher <paul@pfish.zone> parents: 144 diff changeset	400 impl ModuleClient for LibPamHandle {
143 ebb71a412b58 Turn everything into OsString and Just Walk Out! for strings with nul. Paul Fisher <paul@pfish.zone> parents: 141 diff changeset	401 fn authtok(&mut self, prompt: Option<&OsStr>) -> Result<OsString> {
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	402 self.get_authtok(prompt, ItemType::AuthTok)
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	403 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	404
143 ebb71a412b58 Turn everything into OsString and Just Walk Out! for strings with nul. Paul Fisher <paul@pfish.zone> parents: 141 diff changeset	405 fn old_authtok(&mut self, prompt: Option<&OsStr>) -> Result<OsString> {
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	406 self.get_authtok(prompt, ItemType::OldAuthTok)
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	407 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	408
153 3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	409 fn get_module_data<T: 'static>(&self, key: &str) -> Option<&T> {
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	410 // It's technically unsafe to do this, but we assume that other modules
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	411 // aren't going to go out of their way to find the key we've used
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	412 // and corrupt its value's data.
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	413 let full_key = module_data_key::<T>(key);
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	414 let mut ptr: *const c_void = ptr::null();
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	415 unsafe {
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	416 ErrorCode::result_from(libpam_sys::pam_get_data(
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	417 self.raw_ref(),
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	418 full_key.as_ptr(),
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	419 &mut ptr,
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	420 ))
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	421 .ok()?;
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	422
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	423 (ptr as *const T).as_ref()
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	424 }
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	425 }
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	426
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	427 fn set_module_data<T: 'static>(&mut self, key: &str, data: T) -> Result<()> {
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	428 let full_key = module_data_key::<T>(key);
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	429 let data = Box::new(data);
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	430 ErrorCode::result_from(unsafe {
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	431 libpam_sys::pam_set_data(
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	432 self.raw_mut(),
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	433 full_key.as_ptr(),
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	434 Box::into_raw(data).cast(),
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	435 drop_module_data::<T>,
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	436 )
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	437 })
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	438 }
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	439
146 1bc52025156b Split PAM items into their own separate struct. Paul Fisher <paul@pfish.zone> parents: 144 diff changeset	440 fn authtok_item(&self) -> Result<Option<OsString>> {
1bc52025156b Split PAM items into their own separate struct. Paul Fisher <paul@pfish.zone> parents: 144 diff changeset	441 unsafe { items::get_cstr_item(self, ItemType::AuthTok) }
1bc52025156b Split PAM items into their own separate struct. Paul Fisher <paul@pfish.zone> parents: 144 diff changeset	442 }
1bc52025156b Split PAM items into their own separate struct. Paul Fisher <paul@pfish.zone> parents: 144 diff changeset	443 fn old_authtok_item(&self) -> Result<Option<OsString>> {
1bc52025156b Split PAM items into their own separate struct. Paul Fisher <paul@pfish.zone> parents: 144 diff changeset	444 unsafe { items::get_cstr_item(self, ItemType::OldAuthTok) }
1bc52025156b Split PAM items into their own separate struct. Paul Fisher <paul@pfish.zone> parents: 144 diff changeset	445 }
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	446 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	447
153 3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	448 /// Constructs a type-specific, module-specific key for this data.
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	449 fn module_data_key<T: 'static>(key: &str) -> CString {
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	450 // The type ID is unique per-type.
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	451 let tid = TypeId::of::<T>();
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	452 // The `set_data_cleanup` function lives statically inside each PAM module,
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	453 // so its address will be different between `pam_a.so` and `pam_b.so`,
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	454 // even if both modules .so files are byte-for-byte identical.
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	455 let cleanup_addr = drop_module_data::<T> as usize;
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	456 // Then, by adding the key,
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	457 let key = format!("{key:?}::{tid:?}::{cleanup_addr:016x}");
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	458 CString::new(key).expect("null bytes somehow got into a debug string?")
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	459 }
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	460
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	461 /// Function called at the end of a PAM session that is called to clean up
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	462 /// a value previously provided to PAM in a `pam_set_data` call.
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	463 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	464 /// You should never call this yourself.
153 3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	465 extern "C" fn drop_module_data<T>(_: mut libpam_sys::pam_handle, c_data: mut c_void, _: c_int) {
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	466 unsafe {
153 3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	467 // Adopt the pointer into a Box and immediately drop it.
3036f2e6a022 Add module-specific data support. Paul Fisher <paul@pfish.zone> parents: 148 diff changeset	468 let _: Box<T> = Box::from_raw(c_data.cast());
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	469 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	470 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	471
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	472 // Implementations of internal functions.
144 56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	473 impl LibPamHandle {
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	474 #[cfg(any(pam_impl = "LinuxPam", pam_impl = "OpenPam"))]
143 ebb71a412b58 Turn everything into OsString and Just Walk Out! for strings with nul. Paul Fisher <paul@pfish.zone> parents: 141 diff changeset	475 fn get_authtok(&mut self, prompt: Option<&OsStr>, item_type: ItemType) -> Result<OsString> {
ebb71a412b58 Turn everything into OsString and Just Walk Out! for strings with nul. Paul Fisher <paul@pfish.zone> parents: 141 diff changeset	476 let prompt = memory::option_cstr_os(prompt);
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	477 let mut output: *const c_char = ptr::null_mut();
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	478 // SAFETY: We're calling this with known-good values.
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	479 let res = unsafe {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	480 libpam_sys::pam_get_authtok(
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	481 self.raw_mut(),
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	482 item_type.into(),
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	483 &mut output,
143 ebb71a412b58 Turn everything into OsString and Just Walk Out! for strings with nul. Paul Fisher <paul@pfish.zone> parents: 141 diff changeset	484 memory::prompt_ptr(prompt.as_deref()),
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	485 )
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	486 };
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	487 ErrorCode::result_from(res)?;
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	488 // SAFETY: We got this string from PAM.
143 ebb71a412b58 Turn everything into OsString and Just Walk Out! for strings with nul. Paul Fisher <paul@pfish.zone> parents: 141 diff changeset	489 unsafe { memory::copy_pam_string(output) }.ok_or(ErrorCode::ConversationError)
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	490 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	491
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	492 #[cfg(not(any(pam_impl = "LinuxPam", pam_impl = "OpenPam")))]
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	493 fn get_authtok(&mut self, prompt: Option<&str>, item_type: ItemType) -> Result<String> {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	494 Err(ErrorCode::ConversationError)
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	495 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	496
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	497 /// Gets the `PAM_CONV` item from the handle.
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	498 fn conversation_item(&self) -> Result<&PamConv> {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	499 let output: *const PamConv = ptr::null_mut();
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	500 let result = unsafe {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	501 libpam_sys::pam_get_item(
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	502 self.raw_ref(),
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	503 ItemType::Conversation.into(),
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	504 &mut output.cast(),
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	505 )
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	506 };
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	507 ErrorCode::result_from(result)?;
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	508 // SAFETY: We got this result from PAM, and we're checking if it's null.
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	509 unsafe { output.as_ref() }.ok_or(ErrorCode::ConversationError)
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	510 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	511 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	512
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	513 /// Identifies what is being gotten or set with `pam_get_item`
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	514 /// or `pam_set_item`.
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	515 #[derive(TryFromPrimitive, IntoPrimitive)]
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	516 #[repr(i32)]
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	517 #[non_exhaustive] // because C could give us anything!
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	518 pub enum ItemType {
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	519 /// The PAM service name.
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	520 Service = constants::PAM_SERVICE,
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	521 /// The user's login name.
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	522 User = constants::PAM_USER,
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	523 /// The TTY name.
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	524 Tty = constants::PAM_TTY,
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	525 /// The remote host (if applicable).
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	526 RemoteHost = constants::PAM_RHOST,
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	527 /// The conversation struct (not a CStr-based item).
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	528 Conversation = constants::PAM_CONV,
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	529 /// The authentication token (password).
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	530 AuthTok = constants::PAM_AUTHTOK,
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	531 /// The old authentication token (when changing passwords).
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	532 OldAuthTok = constants::PAM_OLDAUTHTOK,
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	533 /// The remote user's name.
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	534 RemoteUser = constants::PAM_RUSER,
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	535 /// The prompt shown when requesting a username.
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	536 UserPrompt = constants::PAM_USER_PROMPT,
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	537 #[cfg(feature = "linux-pam-ext")]
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	538 /// App-supplied function to override failure delays.
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	539 FailDelay = constants::PAM_FAIL_DELAY,
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	540 #[cfg(feature = "linux-pam-ext")]
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	541 /// X display name.
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	542 XDisplay = constants::PAM_XDISPLAY,
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	543 #[cfg(feature = "linux-pam-ext")]
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	544 /// X server authentication data.
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	545 XAuthData = constants::PAM_XAUTHDATA,
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	546 #[cfg(feature = "linux-pam-ext")]
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	547 /// The type of `pam_get_authtok`.
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	548 AuthTokType = constants::PAM_AUTHTOK_TYPE,
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	549 }

Mercurial > crates > nonstick

annotate src/libpam/handle.rs @ 153:3036f2e6a022