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

annotate src/libpam/handle.rs @ 144:56b559b7ecea

Big rename: separate concepts of Transaction from Handle. - An application that uses PAM creates a Transaction. - The Transaction has a Handle. Currently, a module still get something called a "handle", but that's probably going to change soon.

author	Paul Fisher <paul@pfish.zone>
date	Sun, 06 Jul 2025 11:59:26 -0400
parents	ebb71a412b58
children	1bc52025156b

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};
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	2 use crate::constants::{ErrorCode, Result};
130 80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 118 diff changeset	3 use crate::conv::Exchange;
98 b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 97 diff changeset	4 use crate::environ::EnvironMapMut;
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	5 use crate::handle::PamShared;
98 b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 97 diff changeset	6 use crate::libpam::environ::{LibPamEnviron, LibPamEnvironMut};
130 80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 118 diff changeset	7 use crate::libpam::memory;
116 a12706e42c9d Logging, macros, and building: Paul Fisher <paul@pfish.zone> parents: 105 diff changeset	8 use crate::logging::{Level, Location};
103 dfcd96a74ac4 write a truly prodigious amount of documentation Paul Fisher <paul@pfish.zone> parents: 102 diff changeset	9 use crate::{
144 56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	10 guide, linklist, stdlinks, Conversation, EnvironMap, Flags, PamHandleModule, Transaction,
103 dfcd96a74ac4 write a truly prodigious amount of documentation Paul Fisher <paul@pfish.zone> parents: 102 diff changeset	11 };
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	12 use libpam_sys_helpers::constants;
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	13 use num_enum::{IntoPrimitive, TryFromPrimitive};
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	14 use std::cell::Cell;
143 ebb71a412b58 Turn everything into OsString and Just Walk Out! for strings with nul. Paul Fisher <paul@pfish.zone> parents: 141 diff changeset	15 use std::ffi::{c_char, c_int, CString, OsStr, OsString};
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	16 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	17 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	18 use std::ptr;
130 80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 118 diff changeset	19 use std::ptr::NonNull;
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	20
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	21 /// An owned PAM handle.
144 56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	22 pub struct LibPamTransaction<C: Conversation> {
101 94b51fa4f797 Fix memory soundness issues: Paul Fisher <paul@pfish.zone> parents: 98 diff changeset	23 /// The handle itself.
144 56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	24 handle: ManuallyDrop<LibPamHandle>,
101 94b51fa4f797 Fix memory soundness issues: Paul Fisher <paul@pfish.zone> parents: 98 diff changeset	25 /// 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	26 last_return: Cell<Result<()>>,
101 94b51fa4f797 Fix memory soundness issues: Paul Fisher <paul@pfish.zone> parents: 98 diff changeset	27 /// 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	28 ///
94eb11cb1798 Improve documentation for pam_start. Paul Fisher <paul@pfish.zone> parents: 101 diff changeset	29 /// 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	30 /// 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	31 /// 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	32 /// 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	33 /// 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	34 conversation: Box<OwnedConversation<C>>,
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	35 }
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	36
97 efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	37 #[derive(Debug, PartialEq)]
144 56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	38 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	39 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	40 username: Option<OsString>,
97 efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	41 }
efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	42
144 56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	43 impl TransactionBuilder {
97 efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	44 /// 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	45 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	46 self.service_name = service_name;
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 97 diff changeset	47 self
97 efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	48 }
102 94eb11cb1798 Improve documentation for pam_start. Paul Fisher <paul@pfish.zone> parents: 101 diff changeset	49 /// 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	50 /// round trip through the conversation and may otherwise improve
94eb11cb1798 Improve documentation for pam_start. Paul Fisher <paul@pfish.zone> parents: 101 diff changeset	51 /// 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	52 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	53 self.username = Some(username);
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 97 diff changeset	54 self
97 efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	55 }
102 94eb11cb1798 Improve documentation for pam_start. Paul Fisher <paul@pfish.zone> parents: 101 diff changeset	56 /// 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	57 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	58 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	59 }
efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	60 }
efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	61
144 56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	62 impl<C: Conversation> LibPamTransaction<C> {
102 94eb11cb1798 Improve documentation for pam_start. Paul Fisher <paul@pfish.zone> parents: 101 diff changeset	63 /// 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	64 ///
94eb11cb1798 Improve documentation for pam_start. Paul Fisher <paul@pfish.zone> parents: 101 diff changeset	65 /// 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	66 /// 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	67 /// 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	68 ///
103 dfcd96a74ac4 write a truly prodigious amount of documentation Paul Fisher <paul@pfish.zone> parents: 102 diff changeset	69 /// # References
116 a12706e42c9d Logging, macros, and building: Paul Fisher <paul@pfish.zone> parents: 105 diff changeset	70 #[doc = linklist!(pam_start: adg, _std)]
102 94eb11cb1798 Improve documentation for pam_start. Paul Fisher <paul@pfish.zone> parents: 101 diff changeset	71 ///
116 a12706e42c9d Logging, macros, and building: Paul Fisher <paul@pfish.zone> parents: 105 diff changeset	72 #[doc = stdlinks!(3 pam_start)]
a12706e42c9d Logging, macros, and building: Paul Fisher <paul@pfish.zone> parents: 105 diff changeset	73 #[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	74 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	75 TransactionBuilder {
103 dfcd96a74ac4 write a truly prodigious amount of documentation Paul Fisher <paul@pfish.zone> parents: 102 diff changeset	76 service_name,
dfcd96a74ac4 write a truly prodigious amount of documentation Paul Fisher <paul@pfish.zone> parents: 102 diff changeset	77 username: None,
dfcd96a74ac4 write a truly prodigious amount of documentation Paul Fisher <paul@pfish.zone> parents: 102 diff changeset	78 }
97 efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	79 }
102 94eb11cb1798 Improve documentation for pam_start. Paul Fisher <paul@pfish.zone> parents: 101 diff changeset	80
143 ebb71a412b58 Turn everything into OsString and Just Walk Out! for strings with nul. Paul Fisher <paul@pfish.zone> parents: 141 diff changeset	81 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	82 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	83 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	84 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	85 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	86
130 80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 118 diff changeset	87 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	88 // 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	89 // 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	90 let result = unsafe {
130 80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 118 diff changeset	91 libpam_sys::pam_start(
101 94b51fa4f797 Fix memory soundness issues: Paul Fisher <paul@pfish.zone> parents: 98 diff changeset	92 service_cstr.as_ptr(),
94b51fa4f797 Fix memory soundness issues: Paul Fisher <paul@pfish.zone> parents: 98 diff changeset	93 username_cstr,
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	94 (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	95 .cast_mut()
80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 118 diff changeset	96 .cast(),
101 94b51fa4f797 Fix memory soundness issues: Paul Fisher <paul@pfish.zone> parents: 98 diff changeset	97 &mut handle,
94b51fa4f797 Fix memory soundness issues: Paul Fisher <paul@pfish.zone> parents: 98 diff changeset	98 )
94b51fa4f797 Fix memory soundness issues: Paul Fisher <paul@pfish.zone> parents: 98 diff changeset	99 };
97 efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	100 ErrorCode::result_from(result)?;
130 80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 118 diff changeset	101 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	102 Ok(Self {
144 56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	103 handle: ManuallyDrop::new(LibPamHandle(handle)),
97 efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	104 last_return: Cell::new(Ok(())),
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	105 conversation: conv,
97 efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	106 })
efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	107 }
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	108
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	109 /// "Quietly" closes the PAM session on an owned PAM handle.
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	110 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	111 /// This internally calls `pam_end` with the appropriate error code.
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	112 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	113 /// # References
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	114 #[doc = linklist!(pam_end: adg, _std)]
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	115 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	116 #[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	117 #[doc = stdlinks!(3 pam_end)]
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	118
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	119 fn end_quiet(self) {}
97 efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	120 }
efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	121
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	122 macro_rules! wrap {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	123 (fn $name:ident { $pam_func:ident }) => {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	124 fn $name(&mut self, flags: Flags) -> Result<()> {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	125 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	126 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	127 };
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	128 }
97 efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	129
144 56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	130 impl Transaction for LibPamHandle {
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	131 wrap!(fn authenticate { pam_authenticate });
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	132 wrap!(fn account_management { pam_acct_mgmt });
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	133 wrap!(fn change_authtok { pam_chauthtok });
97 efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	134 }
efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	135
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	136 // TODO: pam_authenticate - app
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	137 // pam_setcred - app
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	138 // pam_acct_mgmt - app
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	139 // pam_chauthtok - app
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	140 // pam_open_session - app
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	141 // pam_close_session - app
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	142 // pam_putenv - shared
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	143 // pam_getenv - shared
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	144 // pam_getenvlist - shared
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	145
144 56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	146 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	147 /// 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	148 ///
103 dfcd96a74ac4 write a truly prodigious amount of documentation Paul Fisher <paul@pfish.zone> parents: 102 diff changeset	149 /// 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	150 ///
103 dfcd96a74ac4 write a truly prodigious amount of documentation Paul Fisher <paul@pfish.zone> parents: 102 diff changeset	151 /// # References
116 a12706e42c9d Logging, macros, and building: Paul Fisher <paul@pfish.zone> parents: 105 diff changeset	152 #[doc = linklist!(pam_end: adg, _std)]
103 dfcd96a74ac4 write a truly prodigious amount of documentation Paul Fisher <paul@pfish.zone> parents: 102 diff changeset	153 ///
116 a12706e42c9d Logging, macros, and building: Paul Fisher <paul@pfish.zone> parents: 105 diff changeset	154 #[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	155 #[doc = stdlinks!(3 pam_end)]
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	156 fn drop(&mut self) {
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	157 unsafe {
130 80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 118 diff changeset	158 libpam_sys::pam_end(
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	159 self.handle.raw_mut(),
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	160 ErrorCode::result_to_c(self.last_return.get()),
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	161 );
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	162 }
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	163 }
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	164 }
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	165
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	166 macro_rules! delegate {
98 b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 97 diff changeset	167 // 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	168 (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	169 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	170 let result = self.handle.$meth($($param),*);
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	171 self.last_return.set(split(&result));
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	172 result
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	173 }
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	174 };
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	175 (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	176 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	177 let result = self.handle.$meth($($param),*);
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	178 self.last_return.set(split(&result));
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	179 result
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	180 }
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	181 };
98 b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 97 diff changeset	182 // 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	183 (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	184 fn $meth(&self $(, $param: $typ)*) -> $ret {
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 97 diff changeset	185 self.handle.$meth($($param),*)
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 97 diff changeset	186 }
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 97 diff changeset	187 };
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 97 diff changeset	188 (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	189 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	190 self.handle.$meth($($param),*)
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 97 diff changeset	191 }
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 97 diff changeset	192 };
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 97 diff changeset	193 // Then have item getters / setters
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	194 (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	195 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	196 $(delegate!(set = $set);)?
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	197 };
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	198 (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	199 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	200 };
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	201 }
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	202
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	203 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	204 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	205 }
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	206
144 56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	207 impl<C: Conversation> PamShared for LibPamTransaction<C> {
116 a12706e42c9d Logging, macros, and building: Paul Fisher <paul@pfish.zone> parents: 105 diff changeset	208 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	209 delegate!(fn environ(&self) -> impl EnvironMap);
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 97 diff changeset	210 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	211 delegate!(fn username(&mut self, prompt: Option<&OsStr>) -> Result<OsString>);
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	212 delegate!(get = user_item, set = set_user_item);
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	213 delegate!(get = service, set = set_service);
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	214 delegate!(get = user_prompt, set = set_user_prompt);
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	215 delegate!(get = tty_name, set = set_tty_name);
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	216 delegate!(get = remote_user, set = set_remote_user);
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	217 delegate!(get = remote_host, set = set_remote_host);
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	218 delegate!(set = set_authtok_item);
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	219 delegate!(set = set_old_authtok_item);
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	220 }
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	221
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	222 /// Macro to implement getting/setting a CStr-based item.
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	223 macro_rules! cstr_item {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	224 (get = $getter:ident, item = $item_type:path) => {
143 ebb71a412b58 Turn everything into OsString and Just Walk Out! for strings with nul. Paul Fisher <paul@pfish.zone> parents: 141 diff changeset	225 fn $getter(&self) -> Result<Option<OsString>> {
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	226 unsafe { self.get_cstr_item($item_type) }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	227 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	228 };
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	229 (set = $setter:ident, item = $item_type:path) => {
143 ebb71a412b58 Turn everything into OsString and Just Walk Out! for strings with nul. Paul Fisher <paul@pfish.zone> parents: 141 diff changeset	230 fn $setter(&mut self, value: Option<&OsStr>) -> Result<()> {
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	231 unsafe { self.set_cstr_item($item_type, value) }
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 }
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 /// 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	237 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	238 /// 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	239 /// 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	240 /// a PAM handle created by another library.
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	241 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	242 /// 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	243 /// successful completion.
144 56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	244 #[repr(transparent)]
56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	245 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	246
144 56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	247 impl LibPamHandle {
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	248 /// 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	249 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	250 /// 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	251 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	252 /// # Safety
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	253 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	254 /// - 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	255 /// - 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	256 /// 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	257 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	258 Self(handle)
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	259 }
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 /// 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	262 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	263 /// # References
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	264 #[doc = linklist!(pam_end: adg, _std)]
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	265 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	266 #[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	267 #[doc = stdlinks!(3 pam_end)]
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	268 pub fn end(self, result: Result<()>) {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	269 let mut me = ManuallyDrop::new(self);
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	270 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	271 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	272
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	273 #[cfg_attr(
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	274 not(pam_impl = "LinuxPam"),
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	275 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	276 )]
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	277 #[cfg_attr(
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	278 pam_impl = "LinuxPam",
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	279 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	280 )]
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	281 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	282 /// On Linux-PAM only, this sets the
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	283 /// [`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	284 /// 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	285 /// `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	286 /// 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	287 /// the call too seriously".
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	288 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	289 /// # References
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	290 #[doc = linklist!(pam_end: adg, _std)]
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	291 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	292 #[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	293 #[doc = stdlinks!(3 pam_end)]
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	294 pub fn end_quiet(self, result: Result<()>) {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	295 let mut me = ManuallyDrop::new(self);
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	296 let result = ErrorCode::result_to_c(result);
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	297 #[cfg(pam_impl = "LinuxPam")]
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	298 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	299 unsafe {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	300 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	301 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	302 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	303
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	304 /// 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	305 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	306 let me = ManuallyDrop::new(self);
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	307 me.0
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	308 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	309
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	310 /// 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	311 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	312 unsafe { self.0.as_ref() }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	313 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	314 /// 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	315 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	316 unsafe { self.0.as_mut() }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	317 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	318 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	319
144 56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	320 impl Drop for LibPamHandle {
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	321 fn drop(&mut self) {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	322 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	323 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	324 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	325
144 56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	326 impl PamShared for LibPamHandle {
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	327 #[cfg(any())]
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	328 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	329 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	330 Ok(cstr) => cstr,
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	331 _ => return,
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	332 };
143 ebb71a412b58 Turn everything into OsString and Just Walk Out! for strings with nul. Paul Fisher <paul@pfish.zone> parents: 141 diff changeset	333 #[cfg(pam_impl = "LinuxPam")]
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	334 {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	335 _ = loc;
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	336 // 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	337 unsafe {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	338 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	339 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	340 }
143 ebb71a412b58 Turn everything into OsString and Just Walk Out! for strings with nul. Paul Fisher <paul@pfish.zone> parents: 141 diff changeset	341 #[cfg(pam_impl = "OpenPam")]
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	342 {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	343 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	344 // 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	345 unsafe {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	346 libpam_sys::_openpam_log(
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	347 level as c_int,
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	348 func.as_ptr(),
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	349 "%s\0".as_ptr().cast(),
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	350 entry.as_ptr(),
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 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	355
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	356 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	357
143 ebb71a412b58 Turn everything into OsString and Just Walk Out! for strings with nul. Paul Fisher <paul@pfish.zone> parents: 141 diff changeset	358 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	359 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	360 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	361 let ret = unsafe {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	362 libpam_sys::pam_get_user(
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	363 self.raw_mut(),
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	364 &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	365 memory::prompt_ptr(prompt.as_deref()),
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	366 )
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	367 };
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	368 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	369 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	370 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	371
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	372 fn environ(&self) -> impl EnvironMap {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	373 LibPamEnviron::new(self)
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	374 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	375
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	376 fn environ_mut(&mut self) -> impl EnvironMapMut {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	377 LibPamEnvironMut::new(self)
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	378 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	379
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	380 cstr_item!(get = user_item, item = ItemType::User);
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	381 cstr_item!(set = set_user_item, item = ItemType::User);
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	382 cstr_item!(get = service, item = ItemType::Service);
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	383 cstr_item!(set = set_service, item = ItemType::Service);
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	384 cstr_item!(get = user_prompt, item = ItemType::UserPrompt);
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	385 cstr_item!(set = set_user_prompt, item = ItemType::UserPrompt);
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	386 cstr_item!(get = tty_name, item = ItemType::Tty);
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	387 cstr_item!(set = set_tty_name, item = ItemType::Tty);
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	388 cstr_item!(get = remote_user, item = ItemType::RemoteUser);
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	389 cstr_item!(set = set_remote_user, item = ItemType::RemoteUser);
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	390 cstr_item!(get = remote_host, item = ItemType::RemoteHost);
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	391 cstr_item!(set = set_remote_host, item = ItemType::RemoteHost);
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	392 cstr_item!(set = set_authtok_item, item = ItemType::AuthTok);
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	393 cstr_item!(set = set_old_authtok_item, item = ItemType::OldAuthTok);
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
144 56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	396 impl Conversation for LibPamHandle {
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	397 fn communicate(&self, messages: &[Exchange]) {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	398 match self.conversation_item() {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	399 Ok(conv) => conv.communicate(messages),
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	400 Err(e) => {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	401 for msg in messages {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	402 msg.set_error(e)
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 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	405 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	406 }
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
144 56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	409 impl PamHandleModule 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	410 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	411 self.get_authtok(prompt, ItemType::AuthTok)
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	412 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	413
143 ebb71a412b58 Turn everything into OsString and Just Walk Out! for strings with nul. Paul Fisher <paul@pfish.zone> parents: 141 diff changeset	414 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	415 self.get_authtok(prompt, ItemType::OldAuthTok)
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	416 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	417
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	418 cstr_item!(get = authtok_item, item = ItemType::AuthTok);
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	419 cstr_item!(get = old_authtok_item, item = ItemType::OldAuthTok);
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	420 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	421
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	422 /// 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	423 /// 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	424 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	425 /// You should never call this yourself.
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	426 extern "C" fn set_data_cleanup<T>(_: const libc::c_void, c_data: mut libc::c_void, _: c_int) {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	427 unsafe {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	428 let _data: Box<T> = Box::from_raw(c_data.cast());
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	429 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	430 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	431
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	432 // Implementations of internal functions.
144 56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	433 impl LibPamHandle {
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	434 #[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	435 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	436 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	437 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	438 // 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	439 let res = unsafe {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	440 libpam_sys::pam_get_authtok(
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	441 self.raw_mut(),
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	442 item_type.into(),
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	443 &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	444 memory::prompt_ptr(prompt.as_deref()),
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	445 )
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 ErrorCode::result_from(res)?;
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	448 // 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	449 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	450 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	451
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	452 #[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	453 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	454 Err(ErrorCode::ConversationError)
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	455 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	456
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	457 /// Gets a C string item.
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	458 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	459 /// # Safety
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	460 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	461 /// You better be requesting an item which is a C string.
143 ebb71a412b58 Turn everything into OsString and Just Walk Out! for strings with nul. Paul Fisher <paul@pfish.zone> parents: 141 diff changeset	462 unsafe fn get_cstr_item(&self, item_type: ItemType) -> Result<Option<OsString>> {
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	463 let mut output = ptr::null();
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	464 let ret =
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	465 unsafe { libpam_sys::pam_get_item(self.raw_ref(), item_type as c_int, &mut output) };
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	466 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	467 Ok(memory::copy_pam_string(output.cast()))
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	468 }
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 /// Sets a C string item.
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 /// # Safety
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	473 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	474 /// You better be setting an item which is a C string.
143 ebb71a412b58 Turn everything into OsString and Just Walk Out! for strings with nul. Paul Fisher <paul@pfish.zone> parents: 141 diff changeset	475 unsafe fn set_cstr_item(&mut self, item_type: ItemType, data: Option<&OsStr>) -> Result<()> {
ebb71a412b58 Turn everything into OsString and Just Walk Out! for strings with nul. Paul Fisher <paul@pfish.zone> parents: 141 diff changeset	476 let data_str = memory::option_cstr_os(data);
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	477 let ret = unsafe {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	478 libpam_sys::pam_set_item(
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	479 self.raw_mut(),
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	480 item_type as c_int,
143 ebb71a412b58 Turn everything into OsString and Just Walk Out! for strings with nul. Paul Fisher <paul@pfish.zone> parents: 141 diff changeset	481 memory::prompt_ptr(data_str.as_deref()).cast(),
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	482 )
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	483 };
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	484 ErrorCode::result_from(ret)
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 /// 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	488 fn conversation_item(&self) -> Result<&PamConv> {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	489 let output: *const PamConv = ptr::null_mut();
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	490 let result = unsafe {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	491 libpam_sys::pam_get_item(
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	492 self.raw_ref(),
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	493 ItemType::Conversation.into(),
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	494 &mut output.cast(),
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 ErrorCode::result_from(result)?;
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	498 // 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	499 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	500 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	501 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	502
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	503 /// 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	504 /// or `pam_set_item`.
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	505 #[derive(TryFromPrimitive, IntoPrimitive)]
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	506 #[repr(i32)]
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	507 #[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	508 pub enum ItemType {
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	509 /// The PAM service name.
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	510 Service = constants::PAM_SERVICE,
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	511 /// The user's login name.
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	512 User = constants::PAM_USER,
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	513 /// The TTY name.
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	514 Tty = constants::PAM_TTY,
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	515 /// The remote host (if applicable).
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	516 RemoteHost = constants::PAM_RHOST,
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	517 /// 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	518 Conversation = constants::PAM_CONV,
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	519 /// The authentication token (password).
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	520 AuthTok = constants::PAM_AUTHTOK,
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	521 /// 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	522 OldAuthTok = constants::PAM_OLDAUTHTOK,
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	523 /// The remote user's name.
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	524 RemoteUser = constants::PAM_RUSER,
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	525 /// 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	526 UserPrompt = constants::PAM_USER_PROMPT,
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	527 #[cfg(feature = "linux-pam-ext")]
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	528 /// 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	529 FailDelay = constants::PAM_FAIL_DELAY,
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	530 #[cfg(feature = "linux-pam-ext")]
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	531 /// X display name.
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	532 XDisplay = constants::PAM_XDISPLAY,
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	533 #[cfg(feature = "linux-pam-ext")]
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	534 /// X server authentication data.
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	535 XAuthData = constants::PAM_XAUTHDATA,
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	536 #[cfg(feature = "linux-pam-ext")]
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	537 /// The type of `pam_get_authtok`.
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	538 AuthTokType = constants::PAM_AUTHTOK_TYPE,
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	539 }

Mercurial > crates > nonstick

annotate src/libpam/handle.rs @ 144:56b559b7ecea