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

annotate src/libpam/handle.rs @ 146:1bc52025156b

Split PAM items into their own separate struct. To trim down the number of methods on `PamShared`, this puts all the Items into their own struct(s). This also makes the split between authtok/authtok_item easier to understand.

author	Paul Fisher <paul@pfish.zone>
date	Sun, 06 Jul 2025 19:10:26 -0400
parents	56b559b7ecea
children	4d7333337569

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};
146 1bc52025156b Split PAM items into their own separate struct. Paul Fisher <paul@pfish.zone> parents: 144 diff changeset	2 use crate::_doc::{guide, linklist, 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};
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	13 use libpam_sys_helpers::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};
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	15 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	16 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	17 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	18 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	19 use std::ptr;
130 80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 118 diff changeset	20 use std::ptr::NonNull;
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	21
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	22 /// An owned PAM handle.
144 56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	23 pub struct LibPamTransaction<C: Conversation> {
101 94b51fa4f797 Fix memory soundness issues: Paul Fisher <paul@pfish.zone> parents: 98 diff changeset	24 /// The handle itself.
144 56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	25 handle: ManuallyDrop<LibPamHandle>,
101 94b51fa4f797 Fix memory soundness issues: Paul Fisher <paul@pfish.zone> parents: 98 diff changeset	26 /// 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	27 last_return: Cell<Result<()>>,
101 94b51fa4f797 Fix memory soundness issues: Paul Fisher <paul@pfish.zone> parents: 98 diff changeset	28 /// 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	29 ///
94eb11cb1798 Improve documentation for pam_start. Paul Fisher <paul@pfish.zone> parents: 101 diff changeset	30 /// 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	31 /// 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	32 /// 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	33 /// 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	34 /// 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	35 conversation: Box<OwnedConversation<C>>,
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	36 }
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	37
97 efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	38 #[derive(Debug, PartialEq)]
144 56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	39 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	40 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	41 username: Option<OsString>,
97 efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	42 }
efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	43
144 56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	44 impl TransactionBuilder {
97 efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	45 /// 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	46 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	47 self.service_name = service_name;
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 97 diff changeset	48 self
97 efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	49 }
102 94eb11cb1798 Improve documentation for pam_start. Paul Fisher <paul@pfish.zone> parents: 101 diff changeset	50 /// 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	51 /// round trip through the conversation and may otherwise improve
94eb11cb1798 Improve documentation for pam_start. Paul Fisher <paul@pfish.zone> parents: 101 diff changeset	52 /// 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	53 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	54 self.username = Some(username);
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 97 diff changeset	55 self
97 efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	56 }
102 94eb11cb1798 Improve documentation for pam_start. Paul Fisher <paul@pfish.zone> parents: 101 diff changeset	57 /// 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	58 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	59 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	60 }
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
144 56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	63 impl<C: Conversation> LibPamTransaction<C> {
102 94eb11cb1798 Improve documentation for pam_start. Paul Fisher <paul@pfish.zone> parents: 101 diff changeset	64 /// 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	65 ///
94eb11cb1798 Improve documentation for pam_start. Paul Fisher <paul@pfish.zone> parents: 101 diff changeset	66 /// 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	67 /// 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	68 /// 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	69 ///
103 dfcd96a74ac4 write a truly prodigious amount of documentation Paul Fisher <paul@pfish.zone> parents: 102 diff changeset	70 /// # References
116 a12706e42c9d Logging, macros, and building: Paul Fisher <paul@pfish.zone> parents: 105 diff changeset	71 #[doc = linklist!(pam_start: adg, _std)]
102 94eb11cb1798 Improve documentation for pam_start. Paul Fisher <paul@pfish.zone> parents: 101 diff changeset	72 ///
116 a12706e42c9d Logging, macros, and building: Paul Fisher <paul@pfish.zone> parents: 105 diff changeset	73 #[doc = stdlinks!(3 pam_start)]
a12706e42c9d Logging, macros, and building: Paul Fisher <paul@pfish.zone> parents: 105 diff changeset	74 #[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	75 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	76 TransactionBuilder {
103 dfcd96a74ac4 write a truly prodigious amount of documentation Paul Fisher <paul@pfish.zone> parents: 102 diff changeset	77 service_name,
dfcd96a74ac4 write a truly prodigious amount of documentation Paul Fisher <paul@pfish.zone> parents: 102 diff changeset	78 username: None,
dfcd96a74ac4 write a truly prodigious amount of documentation Paul Fisher <paul@pfish.zone> parents: 102 diff changeset	79 }
97 efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	80 }
102 94eb11cb1798 Improve documentation for pam_start. Paul Fisher <paul@pfish.zone> parents: 101 diff changeset	81
143 ebb71a412b58 Turn everything into OsString and Just Walk Out! for strings with nul. Paul Fisher <paul@pfish.zone> parents: 141 diff changeset	82 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	83 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	84 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	85 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	86 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	87
130 80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 118 diff changeset	88 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	89 // 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	90 // 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	91 let result = unsafe {
130 80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 118 diff changeset	92 libpam_sys::pam_start(
101 94b51fa4f797 Fix memory soundness issues: Paul Fisher <paul@pfish.zone> parents: 98 diff changeset	93 service_cstr.as_ptr(),
94b51fa4f797 Fix memory soundness issues: Paul Fisher <paul@pfish.zone> parents: 98 diff changeset	94 username_cstr,
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	95 (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	96 .cast_mut()
80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 118 diff changeset	97 .cast(),
101 94b51fa4f797 Fix memory soundness issues: Paul Fisher <paul@pfish.zone> parents: 98 diff changeset	98 &mut handle,
94b51fa4f797 Fix memory soundness issues: Paul Fisher <paul@pfish.zone> parents: 98 diff changeset	99 )
94b51fa4f797 Fix memory soundness issues: Paul Fisher <paul@pfish.zone> parents: 98 diff changeset	100 };
97 efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	101 ErrorCode::result_from(result)?;
130 80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 118 diff changeset	102 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	103 Ok(Self {
144 56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	104 handle: ManuallyDrop::new(LibPamHandle(handle)),
97 efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	105 last_return: Cell::new(Ok(())),
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	106 conversation: conv,
97 efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	107 })
efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	108 }
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	109
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	110 /// "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	111 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	112 /// 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	113 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	114 /// # References
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	115 #[doc = linklist!(pam_end: adg, _std)]
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	116 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	117 #[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	118 #[doc = stdlinks!(3 pam_end)]
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	119
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	120 fn end_quiet(self) {}
97 efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	121 }
efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	122
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	123 macro_rules! wrap {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	124 (fn $name:ident { $pam_func:ident }) => {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	125 fn $name(&mut self, flags: Flags) -> Result<()> {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	126 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	127 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	128 };
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	129 }
97 efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	130
144 56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	131 impl Transaction for LibPamHandle {
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	132 wrap!(fn authenticate { pam_authenticate });
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	133 wrap!(fn account_management { pam_acct_mgmt });
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	134 wrap!(fn change_authtok { pam_chauthtok });
97 efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	135 }
efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	136
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	137 // TODO: pam_authenticate - app
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	138 // pam_setcred - app
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	139 // pam_acct_mgmt - app
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	140 // pam_chauthtok - app
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	141 // pam_open_session - app
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	142 // pam_close_session - app
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	143 // pam_putenv - shared
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	144 // pam_getenv - shared
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	145 // pam_getenvlist - shared
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	146
144 56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	147 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	148 /// 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	149 ///
103 dfcd96a74ac4 write a truly prodigious amount of documentation Paul Fisher <paul@pfish.zone> parents: 102 diff changeset	150 /// 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	151 ///
103 dfcd96a74ac4 write a truly prodigious amount of documentation Paul Fisher <paul@pfish.zone> parents: 102 diff changeset	152 /// # References
116 a12706e42c9d Logging, macros, and building: Paul Fisher <paul@pfish.zone> parents: 105 diff changeset	153 #[doc = linklist!(pam_end: adg, _std)]
103 dfcd96a74ac4 write a truly prodigious amount of documentation Paul Fisher <paul@pfish.zone> parents: 102 diff changeset	154 ///
116 a12706e42c9d Logging, macros, and building: Paul Fisher <paul@pfish.zone> parents: 105 diff changeset	155 #[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	156 #[doc = stdlinks!(3 pam_end)]
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	157 fn drop(&mut self) {
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	158 unsafe {
130 80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 118 diff changeset	159 libpam_sys::pam_end(
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	160 self.handle.raw_mut(),
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	161 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	162 );
73 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 }
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	166
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	167 macro_rules! delegate {
98 b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 97 diff changeset	168 // 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	169 (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	170 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	171 let result = self.handle.$meth($($param),*);
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	172 self.last_return.set(split(&result));
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	173 result
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 };
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	176 (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	177 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	178 let result = self.handle.$meth($($param),*);
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	179 self.last_return.set(split(&result));
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	180 result
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	181 }
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	182 };
98 b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 97 diff changeset	183 // 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	184 (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	185 fn $meth(&self $(, $param: $typ)*) -> $ret {
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 97 diff changeset	186 self.handle.$meth($($param),*)
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 };
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 97 diff changeset	189 (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	190 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	191 self.handle.$meth($($param),*)
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 };
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 97 diff changeset	194 // Then have item getters / setters
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	195 (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	196 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	197 $(delegate!(set = $set);)?
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	198 };
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	199 (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	200 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	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
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	204 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	205 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	206 }
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	207
144 56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	208 impl<C: Conversation> PamShared for LibPamTransaction<C> {
116 a12706e42c9d Logging, macros, and building: Paul Fisher <paul@pfish.zone> parents: 105 diff changeset	209 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	210 delegate!(fn environ(&self) -> impl EnvironMap);
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 97 diff changeset	211 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	212 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	213 delegate!(fn items(&self) -> impl Items);
1bc52025156b Split PAM items into their own separate struct. Paul Fisher <paul@pfish.zone> parents: 144 diff changeset	214 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	215 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	216
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	217 /// 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	218 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	219 /// 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	220 /// 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	221 /// a PAM handle created by another library.
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	222 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	223 /// 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	224 /// successful completion.
144 56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	225 #[repr(transparent)]
56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	226 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	227
144 56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	228 impl LibPamHandle {
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	229 /// 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	230 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	231 /// 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	232 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	233 /// # Safety
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 /// - 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	236 /// - 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	237 /// 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	238 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	239 Self(handle)
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	240 }
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 /// 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	243 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	244 /// # References
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	245 #[doc = linklist!(pam_end: adg, _std)]
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	246 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	247 #[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	248 #[doc = stdlinks!(3 pam_end)]
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	249 pub fn end(self, result: Result<()>) {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	250 let mut me = ManuallyDrop::new(self);
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	251 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	252 }
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 #[cfg_attr(
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	255 not(pam_impl = "LinuxPam"),
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	256 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	257 )]
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	258 #[cfg_attr(
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	259 pam_impl = "LinuxPam",
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	260 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	261 )]
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 /// On Linux-PAM only, this sets the
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	264 /// [`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	265 /// 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	266 /// `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	267 /// 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	268 /// the call too seriously".
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 /// # References
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	271 #[doc = linklist!(pam_end: adg, _std)]
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 #[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	274 #[doc = stdlinks!(3 pam_end)]
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	275 pub fn end_quiet(self, result: Result<()>) {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	276 let mut me = ManuallyDrop::new(self);
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	277 let result = ErrorCode::result_to_c(result);
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	278 #[cfg(pam_impl = "LinuxPam")]
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	279 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	280 unsafe {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	281 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	282 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	283 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	284
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	285 /// 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	286 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	287 let me = ManuallyDrop::new(self);
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	288 me.0
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
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	291 /// 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	292 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	293 unsafe { self.0.as_ref() }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	294 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	295 /// 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	296 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	297 unsafe { self.0.as_mut() }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	298 }
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
144 56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	301 impl Drop for LibPamHandle {
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	302 fn drop(&mut self) {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	303 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	304 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	305 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	306
144 56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	307 impl PamShared for LibPamHandle {
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	308 #[cfg(any())]
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	309 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	310 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	311 Ok(cstr) => cstr,
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	312 _ => return,
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	313 };
143 ebb71a412b58 Turn everything into OsString and Just Walk Out! for strings with nul. Paul Fisher <paul@pfish.zone> parents: 141 diff changeset	314 #[cfg(pam_impl = "LinuxPam")]
141 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 _ = loc;
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	317 // 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	318 unsafe {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	319 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	320 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	321 }
143 ebb71a412b58 Turn everything into OsString and Just Walk Out! for strings with nul. Paul Fisher <paul@pfish.zone> parents: 141 diff changeset	322 #[cfg(pam_impl = "OpenPam")]
141 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 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	325 // 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	326 unsafe {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	327 libpam_sys::_openpam_log(
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	328 level as c_int,
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	329 func.as_ptr(),
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	330 "%s\0".as_ptr().cast(),
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	331 entry.as_ptr(),
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 }
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 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	336
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	337 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	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 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	340 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	341 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	342 let ret = unsafe {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	343 libpam_sys::pam_get_user(
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	344 self.raw_mut(),
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	345 &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	346 memory::prompt_ptr(prompt.as_deref()),
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	347 )
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	348 };
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	349 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	350 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	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 fn environ(&self) -> impl EnvironMap {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	354 LibPamEnviron::new(self)
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
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	357 fn environ_mut(&mut self) -> impl EnvironMapMut {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	358 LibPamEnvironMut::new(self)
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	359 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	360
146 1bc52025156b Split PAM items into their own separate struct. Paul Fisher <paul@pfish.zone> parents: 144 diff changeset	361 fn items(&self) -> impl Items {
1bc52025156b Split PAM items into their own separate struct. Paul Fisher <paul@pfish.zone> parents: 144 diff changeset	362 LibPamItems(self)
1bc52025156b Split PAM items into their own separate struct. Paul Fisher <paul@pfish.zone> parents: 144 diff changeset	363 }
1bc52025156b Split PAM items into their own separate struct. Paul Fisher <paul@pfish.zone> parents: 144 diff changeset	364
1bc52025156b Split PAM items into their own separate struct. Paul Fisher <paul@pfish.zone> parents: 144 diff changeset	365 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	366 LibPamItemsMut(self)
1bc52025156b Split PAM items into their own separate struct. Paul Fisher <paul@pfish.zone> parents: 144 diff changeset	367 }
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
144 56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	370 impl Conversation for LibPamHandle {
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	371 fn communicate(&self, messages: &[Exchange]) {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	372 match self.conversation_item() {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	373 Ok(conv) => conv.communicate(messages),
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	374 Err(e) => {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	375 for msg in messages {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	376 msg.set_error(e)
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	377 }
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 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	381 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	382
146 1bc52025156b Split PAM items into their own separate struct. Paul Fisher <paul@pfish.zone> parents: 144 diff changeset	383 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	384 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	385 self.get_authtok(prompt, ItemType::AuthTok)
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	386 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	387
143 ebb71a412b58 Turn everything into OsString and Just Walk Out! for strings with nul. Paul Fisher <paul@pfish.zone> parents: 141 diff changeset	388 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	389 self.get_authtok(prompt, ItemType::OldAuthTok)
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	390 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	391
146 1bc52025156b Split PAM items into their own separate struct. Paul Fisher <paul@pfish.zone> parents: 144 diff changeset	392 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	393 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	394 }
1bc52025156b Split PAM items into their own separate struct. Paul Fisher <paul@pfish.zone> parents: 144 diff changeset	395 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	396 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	397 }
141 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
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	400 /// 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	401 /// 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	402 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	403 /// You should never call this yourself.
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	404 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	405 unsafe {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	406 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	407 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	408 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	409
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	410 // Implementations of internal functions.
144 56b559b7ecea Big rename: separate concepts of Transaction from Handle. Paul Fisher <paul@pfish.zone> parents: 143 diff changeset	411 impl LibPamHandle {
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	412 #[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	413 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	414 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	415 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	416 // 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	417 let res = unsafe {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	418 libpam_sys::pam_get_authtok(
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	419 self.raw_mut(),
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	420 item_type.into(),
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	421 &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	422 memory::prompt_ptr(prompt.as_deref()),
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	423 )
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 ErrorCode::result_from(res)?;
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	426 // 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	427 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	428 }
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 #[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	431 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	432 Err(ErrorCode::ConversationError)
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	433 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	434
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	435 /// 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	436 fn conversation_item(&self) -> Result<&PamConv> {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	437 let output: *const PamConv = ptr::null_mut();
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	438 let result = unsafe {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	439 libpam_sys::pam_get_item(
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	440 self.raw_ref(),
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	441 ItemType::Conversation.into(),
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	442 &mut output.cast(),
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	443 )
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	444 };
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	445 ErrorCode::result_from(result)?;
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	446 // 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	447 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	448 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	449 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	450
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	451 /// 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	452 /// or `pam_set_item`.
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	453 #[derive(TryFromPrimitive, IntoPrimitive)]
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	454 #[repr(i32)]
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	455 #[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	456 pub enum ItemType {
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	457 /// The PAM service name.
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	458 Service = constants::PAM_SERVICE,
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	459 /// The user's login name.
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	460 User = constants::PAM_USER,
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	461 /// The TTY name.
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	462 Tty = constants::PAM_TTY,
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	463 /// The remote host (if applicable).
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	464 RemoteHost = constants::PAM_RHOST,
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	465 /// 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	466 Conversation = constants::PAM_CONV,
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	467 /// The authentication token (password).
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	468 AuthTok = constants::PAM_AUTHTOK,
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	469 /// 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	470 OldAuthTok = constants::PAM_OLDAUTHTOK,
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	471 /// The remote user's name.
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	472 RemoteUser = constants::PAM_RUSER,
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	473 /// 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	474 UserPrompt = constants::PAM_USER_PROMPT,
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	475 #[cfg(feature = "linux-pam-ext")]
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	476 /// 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	477 FailDelay = constants::PAM_FAIL_DELAY,
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	478 #[cfg(feature = "linux-pam-ext")]
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	479 /// X display name.
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	480 XDisplay = constants::PAM_XDISPLAY,
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	481 #[cfg(feature = "linux-pam-ext")]
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	482 /// X server authentication data.
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	483 XAuthData = constants::PAM_XAUTHDATA,
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	484 #[cfg(feature = "linux-pam-ext")]
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	485 /// The type of `pam_get_authtok`.
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	486 AuthTokType = constants::PAM_AUTHTOK_TYPE,
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	487 }

Mercurial > crates > nonstick

annotate src/libpam/handle.rs @ 146:1bc52025156b