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

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

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

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

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::{
118 39760dfc9b3b Detect PAM library based only on system lib; rename minimal lib to XSso. Paul Fisher <paul@pfish.zone> parents: 116 diff changeset	10 guide, linklist, stdlinks, Conversation, EnvironMap, Flags, PamHandleApplication,
39760dfc9b3b Detect PAM library based only on system lib; rename minimal lib to XSso. Paul Fisher <paul@pfish.zone> parents: 116 diff changeset	11 PamHandleModule,
103 dfcd96a74ac4 write a truly prodigious amount of documentation Paul Fisher <paul@pfish.zone> parents: 102 diff changeset	12 };
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;
92 5ddbcada30f2 Add the ability to log against a PAM handle. Paul Fisher <paul@pfish.zone> parents: 90 diff changeset	16 use std::ffi::{c_char, c_int, CString};
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	17 use std::mem::ManuallyDrop;
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.
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	22 pub struct OwnedLibPamHandle<C: Conversation> {
101 94b51fa4f797 Fix memory soundness issues: Paul Fisher <paul@pfish.zone> parents: 98 diff changeset	23 /// The handle itself.
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	24 handle: ManuallyDrop<RawPamHandle>,
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)]
efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	38 pub struct HandleBuilder {
efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	39 service_name: String,
efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	40 username: Option<String>,
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
efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	43 impl HandleBuilder {
efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	44 /// Updates the service name.
efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	45 pub fn service_name(mut self, service_name: String) -> 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.
97 efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	52 pub fn username(mut self, username: String) -> 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.
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	57 pub fn build(self, conv: impl Conversation) -> Result<OwnedLibPamHandle<impl Conversation>> {
97 efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	58 OwnedLibPamHandle::start(self.service_name, self.username, conv)
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
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	62 impl<C: Conversation> OwnedLibPamHandle<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")]
97 efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	74 pub fn build_with_service(service_name: String) -> HandleBuilder {
103 dfcd96a74ac4 write a truly prodigious amount of documentation Paul Fisher <paul@pfish.zone> parents: 102 diff changeset	75 HandleBuilder {
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
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	81 fn start(service_name: String, username: Option<String>, conversation: C) -> Result<Self> {
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));
97 efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	83 let service_cstr = CString::new(service_name).map_err(\|_\| ErrorCode::ConversationError)?;
efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	84 let username_cstr = memory::prompt_ptr(memory::option_cstr(username.as_deref())?.as_ref());
efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	85
130 80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 118 diff changeset	86 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	87 // 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	88 // 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	89 let result = unsafe {
130 80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 118 diff changeset	90 libpam_sys::pam_start(
101 94b51fa4f797 Fix memory soundness issues: Paul Fisher <paul@pfish.zone> parents: 98 diff changeset	91 service_cstr.as_ptr(),
94b51fa4f797 Fix memory soundness issues: Paul Fisher <paul@pfish.zone> parents: 98 diff changeset	92 username_cstr,
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	93 (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	94 .cast_mut()
80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 118 diff changeset	95 .cast(),
101 94b51fa4f797 Fix memory soundness issues: Paul Fisher <paul@pfish.zone> parents: 98 diff changeset	96 &mut handle,
94b51fa4f797 Fix memory soundness issues: Paul Fisher <paul@pfish.zone> parents: 98 diff changeset	97 )
94b51fa4f797 Fix memory soundness issues: Paul Fisher <paul@pfish.zone> parents: 98 diff changeset	98 };
97 efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	99 ErrorCode::result_from(result)?;
130 80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 118 diff changeset	100 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	101 Ok(Self {
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	102 handle: ManuallyDrop::new(RawPamHandle(handle)),
97 efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	103 last_return: Cell::new(Ok(())),
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	104 conversation: conv,
97 efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	105 })
efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	106 }
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	107
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	108 /// "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	109 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	110 /// 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	111 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	112 /// # References
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	113 #[doc = linklist!(pam_end: adg, _std)]
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	114 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	115 #[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	116 #[doc = stdlinks!(3 pam_end)]
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	117
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	118 fn end_quiet(self) {}
97 efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	119 }
efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	120
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	121 macro_rules! wrap {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	122 (fn $name:ident { $pam_func:ident }) => {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	123 fn $name(&mut self, flags: Flags) -> Result<()> {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	124 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	125 }
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 }
97 efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	128
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	129 impl PamHandleApplication for RawPamHandle {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	130 wrap!(fn authenticate { pam_authenticate });
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	131 wrap!(fn account_management { pam_acct_mgmt });
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	132 wrap!(fn change_authtok { pam_chauthtok });
97 efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	133 }
efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 96 diff changeset	134
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	135 // TODO: pam_authenticate - app
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	136 // pam_setcred - app
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	137 // pam_acct_mgmt - app
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	138 // pam_chauthtok - app
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	139 // pam_open_session - app
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	140 // pam_close_session - app
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	141 // pam_putenv - shared
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	142 // pam_getenv - shared
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	143 // pam_getenvlist - shared
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	144
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	145 impl<C: Conversation> Drop for OwnedLibPamHandle<C> {
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	146 /// 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	147 ///
103 dfcd96a74ac4 write a truly prodigious amount of documentation Paul Fisher <paul@pfish.zone> parents: 102 diff changeset	148 /// 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	149 ///
103 dfcd96a74ac4 write a truly prodigious amount of documentation Paul Fisher <paul@pfish.zone> parents: 102 diff changeset	150 /// # References
116 a12706e42c9d Logging, macros, and building: Paul Fisher <paul@pfish.zone> parents: 105 diff changeset	151 #[doc = linklist!(pam_end: adg, _std)]
103 dfcd96a74ac4 write a truly prodigious amount of documentation Paul Fisher <paul@pfish.zone> parents: 102 diff changeset	152 ///
116 a12706e42c9d Logging, macros, and building: Paul Fisher <paul@pfish.zone> parents: 105 diff changeset	153 #[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	154 #[doc = stdlinks!(3 pam_end)]
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	155 fn drop(&mut self) {
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	156 unsafe {
130 80c07e5ab22f Transfer over (almost) completely to using libpam-sys. Paul Fisher <paul@pfish.zone> parents: 118 diff changeset	157 libpam_sys::pam_end(
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	158 self.handle.raw_mut(),
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	159 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	160 );
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	161 }
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
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	165 macro_rules! delegate {
98 b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 97 diff changeset	166 // 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	167 (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	168 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	169 let result = self.handle.$meth($($param),*);
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	170 self.last_return.set(split(&result));
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	171 result
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	172 }
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 (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	175 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	176 let result = self.handle.$meth($($param),*);
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	177 self.last_return.set(split(&result));
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	178 result
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	179 }
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	180 };
98 b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 97 diff changeset	181 // 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	182 (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	183 fn $meth(&self $(, $param: $typ)*) -> $ret {
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 97 diff changeset	184 self.handle.$meth($($param),*)
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 97 diff changeset	185 }
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 (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	188 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	189 self.handle.$meth($($param),*)
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 97 diff changeset	190 }
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 // Then have item getters / setters
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	193 (get = $get:ident$(, set = $set:ident)?) => {
95 51c9d7e8261a Return owned strings rather than borrowed strings. Paul Fisher <paul@pfish.zone> parents: 92 diff changeset	194 delegate!(fn $get(&self) -> Result<Option<String>>);
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	195 $(delegate!(set = $set);)?
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	196 };
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	197 (set = $set:ident) => {
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	198 delegate!(fn $set(&mut self, value: Option<&str>) -> Result<()>);
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	199 };
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 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	203 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	204 }
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	205
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	206 impl<C: Conversation> PamShared for OwnedLibPamHandle<C> {
116 a12706e42c9d Logging, macros, and building: Paul Fisher <paul@pfish.zone> parents: 105 diff changeset	207 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	208 delegate!(fn environ(&self) -> impl EnvironMap);
b87100c5eed4 Start on environment variables, and make pointers nicer. Paul Fisher <paul@pfish.zone> parents: 97 diff changeset	209 delegate!(fn environ_mut(&mut self) -> impl EnvironMapMut);
95 51c9d7e8261a Return owned strings rather than borrowed strings. Paul Fisher <paul@pfish.zone> parents: 92 diff changeset	210 delegate!(fn username(&mut self, prompt: Option<&str>) -> Result<String>);
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	211 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	212 delegate!(get = service, set = set_service);
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	213 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	214 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	215 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	216 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	217 delegate!(set = set_authtok_item);
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	218 delegate!(set = set_old_authtok_item);
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	219 }
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	220
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	221 /// 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	222 macro_rules! cstr_item {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	223 (get = $getter:ident, item = $item_type:path) => {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	224 fn $getter(&self) -> Result<Option<String>> {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	225 unsafe { self.get_cstr_item($item_type) }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	226 }
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 (set = $setter:ident, item = $item_type:path) => {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	229 fn $setter(&mut self, value: Option<&str>) -> Result<()> {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	230 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	231 }
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 /// 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	236 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	237 /// This is the most basic version of a wrapped PAM handle. It's mostly used
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	238 /// as the inside of the [`OwnedLibPamHandle`], but can also be used to "adopt"
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	239 /// a PAM handle created by another library.
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 /// 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	242 /// successful completion.
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	243 pub struct RawPamHandle(NonNull<libpam_sys::pam_handle>);
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	244
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	245 impl RawPamHandle {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	246 /// Takes ownership of the pointer to the given PAM handle.
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	247 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	248 /// Do not use this just to get a reference to a PAM handle.
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	249 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	250 /// # Safety
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	251 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	252 /// - The pointer must point to a valid PAM handle.
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	253 /// - The conversation associated with the handle must remain valid
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	254 /// for as long as the handle is open.
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	255 pub unsafe fn from_ptr(handle: NonNull<libpam_sys::pam_handle>) -> Self {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	256 Self(handle)
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	257 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	258
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	259 /// Ends the transaction, reporting `error_code` to cleanup callbacks.
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	260 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	261 /// # References
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	262 #[doc = linklist!(pam_end: adg, _std)]
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	263 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	264 #[doc = guide!(adg: "adg-interface-by-app-expected.html#adg-pam_end")]
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	265 #[doc = stdlinks!(3 pam_end)]
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	266 pub fn end(self, result: Result<()>) {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	267 let mut me = ManuallyDrop::new(self);
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	268 unsafe { libpam_sys::pam_end(me.raw_mut(), ErrorCode::result_to_c(result)) };
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	269 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	270
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	271 #[cfg_attr(
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	272 not(pam_impl = "LinuxPam"),
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	273 doc = "Exactly equivalent to [`Self::end`], except on Linux-PAM."
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	274 )]
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	275 #[cfg_attr(
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	276 pam_impl = "LinuxPam",
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	277 doc = "Ends the transaction \"quietly\", reporting `error_code` to cleanup callbacks."
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	278 )]
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	279 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	280 /// On Linux-PAM only, this sets the
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	281 /// [`PAM_DATA_SILENT`](libpam_sys::PAM_DATA_SILENT) flag on the flags
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	282 /// passed to the cleanup callbacks. This conventionally means that this
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	283 /// `pam_end` call is occurring on a forked process, and that a session
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	284 /// may still be open on the parent process, and modules "should not treat
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	285 /// the call too seriously".
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	286 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	287 /// # References
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	288 #[doc = linklist!(pam_end: adg, _std)]
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	289 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	290 #[doc = guide!(adg: "adg-interface-by-app-expected.html#adg-pam_end")]
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	291 #[doc = stdlinks!(3 pam_end)]
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	292 pub fn end_quiet(self, result: Result<()>) {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	293 let mut me = ManuallyDrop::new(self);
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	294 let result = ErrorCode::result_to_c(result);
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	295 #[cfg(pam_impl = "LinuxPam")]
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	296 let result = result \| libpam_sys::PAM_DATA_SILENT;
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	297 unsafe {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	298 libpam_sys::pam_end(me.raw_mut(), result);
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	299 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	300 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	301
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	302 /// Consumes this and gives you back the raw PAM handle.
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	303 pub fn into_inner(self) -> NonNull<libpam_sys::pam_handle> {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	304 let me = ManuallyDrop::new(self);
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	305 me.0
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	306 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	307
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	308 /// Gets a reference to the inner PAM handle.
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	309 pub fn raw_ref(&self) -> &libpam_sys::pam_handle {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	310 unsafe { self.0.as_ref() }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	311 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	312 /// Gets a mutable reference to the inner PAM handle.
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	313 pub fn raw_mut(&mut self) -> &mut libpam_sys::pam_handle {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	314 unsafe { self.0.as_mut() }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	315 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	316 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	317
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	318 impl Drop for RawPamHandle {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	319 fn drop(&mut self) {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	320 unsafe { libpam_sys::pam_end(self.0.as_mut(), 0) };
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	321 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	322 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	323
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	324 impl PamShared for RawPamHandle {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	325 #[cfg(any())]
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	326 fn log(&self, level: Level, loc: Location<'_>, entry: &str) {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	327 let entry = match CString::new(entry).or_else(\|_\| CString::new(dbg!(entry))) {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	328 Ok(cstr) => cstr,
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	329 _ => return,
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	330 };
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	331 #[cfg(pam_impl = "linux-pam")]
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	332 {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	333 _ = loc;
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	334 // SAFETY: We're calling this function with a known value.
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	335 unsafe {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	336 libpam_sys::pam_syslog(self, level as c_int, "%s\0".as_ptr().cast(), entry.as_ptr())
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	337 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	338 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	339 #[cfg(pam_impl = "openpam")]
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	340 {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	341 let func = CString::new(loc.function).unwrap_or(CString::default());
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	342 // SAFETY: We're calling this function with a known value.
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	343 unsafe {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	344 libpam_sys::_openpam_log(
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	345 level as c_int,
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	346 func.as_ptr(),
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	347 "%s\0".as_ptr().cast(),
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	348 entry.as_ptr(),
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	349 )
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	350 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	351 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	352 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	353
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	354 fn log(&self, _level: Level, _loc: Location<'_>, _entry: &str) {}
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	355
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	356 fn username(&mut self, prompt: Option<&str>) -> Result<String> {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	357 let prompt = memory::option_cstr(prompt)?;
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	358 let mut output: *const c_char = ptr::null();
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	359 let ret = unsafe {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	360 libpam_sys::pam_get_user(
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	361 self.raw_mut(),
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	362 &mut output,
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	363 memory::prompt_ptr(prompt.as_ref()),
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	364 )
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	365 };
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	366 ErrorCode::result_from(ret)?;
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	367 unsafe { memory::copy_pam_string(output) }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	368 .transpose()
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	369 .unwrap_or(Err(ErrorCode::ConversationError))
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
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	396 impl Conversation for RawPamHandle {
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
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	409 impl PamHandleModule for RawPamHandle {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	410 fn authtok(&mut self, prompt: Option<&str>) -> Result<String> {
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
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	414 fn old_authtok(&mut self, prompt: Option<&str>) -> Result<String> {
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.
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	433 impl RawPamHandle {
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"))]
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	435 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	436 let prompt = memory::option_cstr(prompt)?;
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,
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	444 memory::prompt_ptr(prompt.as_ref()),
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.
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	449 unsafe { memory::copy_pam_string(output) }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	450 .transpose()
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	451 .unwrap_or(Err(ErrorCode::ConversationError))
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	452 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	453
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	454 #[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	455 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	456 Err(ErrorCode::ConversationError)
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	457 }
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 /// Gets a C string item.
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 /// # Safety
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	462 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	463 /// You better be requesting an item which is a C string.
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	464 unsafe fn get_cstr_item(&self, item_type: ItemType) -> Result<Option<String>> {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	465 let mut output = ptr::null();
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	466 let ret =
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	467 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	468 ErrorCode::result_from(ret)?;
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	469 memory::copy_pam_string(output.cast())
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	470 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	471
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	472 /// Sets a C string item.
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 /// # Safety
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	475 ///
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	476 /// You better be setting an item which is a C string.
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	477 unsafe fn set_cstr_item(&mut self, item_type: ItemType, data: Option<&str>) -> Result<()> {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	478 let data_str = memory::option_cstr(data)?;
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	479 let ret = unsafe {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	480 libpam_sys::pam_set_item(
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	481 self.raw_mut(),
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	482 item_type as c_int,
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	483 memory::prompt_ptr(data_str.as_ref()).cast(),
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	484 )
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 ErrorCode::result_from(ret)
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	487 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	488
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	489 /// 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	490 fn conversation_item(&self) -> Result<&PamConv> {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	491 let output: *const PamConv = ptr::null_mut();
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	492 let result = unsafe {
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	493 libpam_sys::pam_get_item(
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	494 self.raw_ref(),
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	495 ItemType::Conversation.into(),
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	496 &mut output.cast(),
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	497 )
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	498 };
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	499 ErrorCode::result_from(result)?;
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	500 // 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	501 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	502 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	503 }
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	504
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	505 /// 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	506 /// or `pam_set_item`.
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 78 diff changeset	507 #[derive(TryFromPrimitive, IntoPrimitive)]
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	508 #[repr(i32)]
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	509 #[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	510 pub enum ItemType {
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	511 /// The PAM service name.
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	512 Service = constants::PAM_SERVICE,
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	513 /// The user's login name.
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	514 User = constants::PAM_USER,
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	515 /// The TTY name.
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	516 Tty = constants::PAM_TTY,
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	517 /// The remote host (if applicable).
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	518 RemoteHost = constants::PAM_RHOST,
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	519 /// 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	520 Conversation = constants::PAM_CONV,
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	521 /// The authentication token (password).
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	522 AuthTok = constants::PAM_AUTHTOK,
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	523 /// 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	524 OldAuthTok = constants::PAM_OLDAUTHTOK,
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	525 /// The remote user's name.
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	526 RemoteUser = constants::PAM_RUSER,
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	527 /// 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	528 UserPrompt = constants::PAM_USER_PROMPT,
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	529 #[cfg(feature = "linux-pam-ext")]
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	530 /// 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	531 FailDelay = constants::PAM_FAIL_DELAY,
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	532 #[cfg(feature = "linux-pam-ext")]
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	533 /// X display name.
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	534 XDisplay = constants::PAM_XDISPLAY,
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	535 #[cfg(feature = "linux-pam-ext")]
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	536 /// X server authentication data.
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	537 XAuthData = constants::PAM_XAUTHDATA,
a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	538 #[cfg(feature = "linux-pam-ext")]
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	539 /// The type of `pam_get_authtok`.
141 a508a69c068a Remove a lot of Results from functions. Paul Fisher <paul@pfish.zone> parents: 134 diff changeset	540 AuthTokType = constants::PAM_AUTHTOK_TYPE,
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: diff changeset	541 }

Mercurial > crates > nonstick

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