crates/nonstick: src/constants.rs annotate

annotate src/constants.rs @ 98:b87100c5eed4

Start on environment variables, and make pointers nicer. This starts work on the PAM environment handling, and in so doing, introduces the CHeapBox and CHeapString structs. These are analogous to Box and CString, but they're located on the C heap rather than being Rust-managed memory. This is because environment variables deal with even more pointers and it turns out we can lose a lot of manual freeing using homemade smart pointers.

author	Paul Fisher <paul@pfish.zone>
date	Tue, 24 Jun 2025 04:25:25 -0400
parents	efe2f5f8b5b2
children	dfcd96a74ac4

rev	line source
60 05cc2c27334f The Big Refactor: clean up docs and exports. Paul Fisher <paul@pfish.zone> parents: 59 diff changeset	1 //! Constants and enum values from the PAM library.
05cc2c27334f The Big Refactor: clean up docs and exports. Paul Fisher <paul@pfish.zone> parents: 59 diff changeset	2
87 05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 86 diff changeset	3 // We have a lot of dumb casts that we just gotta do because of differences
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 86 diff changeset	4 // between Linux-PAM and OpenPAM header files.
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 86 diff changeset	5 #![allow(clippy::unnecessary_cast)]
05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 86 diff changeset	6
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	7 #[cfg(feature = "link")]
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	8 use crate::libpam::pam_ffi;
56 daa2cde64601 Big big refactor. Probably should have been multiple changes. Paul Fisher <paul@pfish.zone> parents: 55 diff changeset	9 use bitflags::bitflags;
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	10 use libc::c_int;
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	11 use num_enum::{IntoPrimitive, TryFromPrimitive};
90 f6186e41399b Miscellaneous fixes and cleanup: Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	12 use std::error::Error;
84 a638a45e5f1f do some real irritating i32/u32 juggling to make bindgen happy Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	13 use std::ffi::c_uint;
90 f6186e41399b Miscellaneous fixes and cleanup: Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	14 use std::fmt;
f6186e41399b Miscellaneous fixes and cleanup: Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	15 use std::fmt::{Display, Formatter};
71 58f9d2a4df38 Reorganize everything again??? Paul Fisher <paul@pfish.zone> parents: 70 diff changeset	16 use std::result::Result as StdResult;
15 27730595f1ea Adding pam-http module Anthony Nowell <anthony@algorithmia.com> parents: diff changeset	17
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	18 /// Arbitrary values for PAM constants when not linking against system PAM.
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	19 ///
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	20 /// **The values of these constants are deliberately selected _not_ to match
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	21 /// any PAM implementations. Applications should always use the symbolic value
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	22 /// and not a magic number.**
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	23 #[cfg(not(feature = "link"))]
85 5e14bb093851 fix more openpam compat stuff Paul Fisher <paul@pfish.zone> parents: 84 diff changeset	24 mod pam_ffi {
92 5ddbcada30f2 Add the ability to log against a PAM handle. Paul Fisher <paul@pfish.zone> parents: 90 diff changeset	25 use std::ffi::c_uint;
5ddbcada30f2 Add the ability to log against a PAM handle. Paul Fisher <paul@pfish.zone> parents: 90 diff changeset	26
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	27 macro_rules! define {
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	28 ($(#[$attr:meta])* $($name:ident = $value:expr),+) => {
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	29 define!(
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	30 @meta { $(#[$attr])* }
84 a638a45e5f1f do some real irritating i32/u32 juggling to make bindgen happy Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	31 $(pub const $name: u32 = $value;)+
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	32 );
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	33 };
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	34 (@meta $m:tt $($i:item)+) => { define!(@expand $($m $i)+); };
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	35 (@expand $({ $(#[$m:meta])* } $i:item)+) => {$($(#[$m])* $i)+};
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	36 }
84 a638a45e5f1f do some real irritating i32/u32 juggling to make bindgen happy Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	37 const fn bit(n: u8) -> u32 {
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	38 1 << n
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	39 }
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	40 define!(
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	41 PAM_SILENT = bit(13),
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	42 PAM_DISALLOW_NULL_AUTHTOK = bit(14),
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	43 PAM_ESTABLISH_CRED = bit(15),
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	44 PAM_DELETE_CRED = bit(16),
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	45 PAM_REINITIALIZE_CRED = bit(17),
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	46 PAM_REFRESH_CRED = bit(18),
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	47 PAM_CHANGE_EXPIRED_AUTHTOK = bit(19),
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	48 PAM_PRELIM_CHECK = bit(20),
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	49 PAM_UPDATE_AUTHTOK = bit(21)
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	50 );
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	51
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	52 define!(
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	53 PAM_ABORT = 513,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	54 PAM_ACCT_EXPIRED = 514,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	55 PAM_AUTHINFO_UNAVAIL = 515,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	56 PAM_AUTHTOK_DISABLE_AGING = 516,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	57 PAM_AUTHTOK_ERR = 517,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	58 PAM_AUTHTOK_EXPIRED = 518,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	59 PAM_AUTHTOK_LOCK_BUSY = 519,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	60 PAM_AUTHTOK_RECOVERY_ERR = 520,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	61 PAM_AUTH_ERR = 521,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	62 PAM_BAD_ITEM = 522,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	63 PAM_BUF_ERR = 533,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	64 PAM_CONV_AGAIN = 534,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	65 PAM_CONV_ERR = 535,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	66 PAM_CRED_ERR = 536,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	67 PAM_CRED_EXPIRED = 537,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	68 PAM_CRED_INSUFFICIENT = 538,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	69 PAM_CRED_UNAVAIL = 539,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	70 PAM_IGNORE = 540,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	71 PAM_INCOMPLETE = 541,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	72 PAM_MAXTRIES = 542,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	73 PAM_MODULE_UNKNOWN = 543,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	74 PAM_NEW_AUTHTOK_REQD = 544,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	75 PAM_NO_MODULE_DATA = 545,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	76 PAM_OPEN_ERR = 546,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	77 PAM_PERM_DENIED = 547,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	78 PAM_SERVICE_ERR = 548,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	79 PAM_SESSION_ERR = 549,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	80 PAM_SYMBOL_ERR = 550,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	81 PAM_SYSTEM_ERR = 551,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	82 PAM_TRY_AGAIN = 552,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	83 PAM_USER_UNKNOWN = 553
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	84 );
90 f6186e41399b Miscellaneous fixes and cleanup: Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	85
92 5ddbcada30f2 Add the ability to log against a PAM handle. Paul Fisher <paul@pfish.zone> parents: 90 diff changeset	86 /// Dummy implementation of strerror so that it always returns None.
5ddbcada30f2 Add the ability to log against a PAM handle. Paul Fisher <paul@pfish.zone> parents: 90 diff changeset	87 pub fn strerror(val: c_uint) -> Option<&'static str> {
5ddbcada30f2 Add the ability to log against a PAM handle. Paul Fisher <paul@pfish.zone> parents: 90 diff changeset	88 _ = val;
90 f6186e41399b Miscellaneous fixes and cleanup: Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	89 None
f6186e41399b Miscellaneous fixes and cleanup: Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	90 }
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	91 }
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	92
56 daa2cde64601 Big big refactor. Probably should have been multiple changes. Paul Fisher <paul@pfish.zone> parents: 55 diff changeset	93 bitflags! {
60 05cc2c27334f The Big Refactor: clean up docs and exports. Paul Fisher <paul@pfish.zone> parents: 59 diff changeset	94 /// The available PAM flags.
05cc2c27334f The Big Refactor: clean up docs and exports. Paul Fisher <paul@pfish.zone> parents: 59 diff changeset	95 ///
64 bbe84835d6db More organization; add lots of docs. Paul Fisher <paul@pfish.zone> parents: 63 diff changeset	96 /// See `/usr/include/security/_pam_types.h` and
bbe84835d6db More organization; add lots of docs. Paul Fisher <paul@pfish.zone> parents: 63 diff changeset	97 /// See `/usr/include/security/pam_modules.h` for more details.
97 efe2f5f8b5b2 Implement "stateless" application-side PAM calls. Paul Fisher <paul@pfish.zone> parents: 92 diff changeset	98 #[derive(Debug, Default, PartialEq)]
56 daa2cde64601 Big big refactor. Probably should have been multiple changes. Paul Fisher <paul@pfish.zone> parents: 55 diff changeset	99 #[repr(transparent)]
84 a638a45e5f1f do some real irritating i32/u32 juggling to make bindgen happy Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	100 pub struct Flags: c_uint {
64 bbe84835d6db More organization; add lots of docs. Paul Fisher <paul@pfish.zone> parents: 63 diff changeset	101 /// The module should not generate any messages.
85 5e14bb093851 fix more openpam compat stuff Paul Fisher <paul@pfish.zone> parents: 84 diff changeset	102 const SILENT = pam_ffi::PAM_SILENT as u32;
64 bbe84835d6db More organization; add lots of docs. Paul Fisher <paul@pfish.zone> parents: 63 diff changeset	103
bbe84835d6db More organization; add lots of docs. Paul Fisher <paul@pfish.zone> parents: 63 diff changeset	104 /// The module should return [ErrorCode::AuthError]
bbe84835d6db More organization; add lots of docs. Paul Fisher <paul@pfish.zone> parents: 63 diff changeset	105 /// if the user has an empty authentication token
bbe84835d6db More organization; add lots of docs. Paul Fisher <paul@pfish.zone> parents: 63 diff changeset	106 /// rather than immediately accepting them.
85 5e14bb093851 fix more openpam compat stuff Paul Fisher <paul@pfish.zone> parents: 84 diff changeset	107 const DISALLOW_NULL_AUTHTOK = pam_ffi::PAM_DISALLOW_NULL_AUTHTOK as u32;
64 bbe84835d6db More organization; add lots of docs. Paul Fisher <paul@pfish.zone> parents: 63 diff changeset	108
bbe84835d6db More organization; add lots of docs. Paul Fisher <paul@pfish.zone> parents: 63 diff changeset	109 // Flag used for `set_credentials`.
bbe84835d6db More organization; add lots of docs. Paul Fisher <paul@pfish.zone> parents: 63 diff changeset	110
60 05cc2c27334f The Big Refactor: clean up docs and exports. Paul Fisher <paul@pfish.zone> parents: 59 diff changeset	111 /// Set user credentials for an authentication service.
85 5e14bb093851 fix more openpam compat stuff Paul Fisher <paul@pfish.zone> parents: 84 diff changeset	112 const ESTABLISH_CREDENTIALS = pam_ffi::PAM_ESTABLISH_CRED as u32;
60 05cc2c27334f The Big Refactor: clean up docs and exports. Paul Fisher <paul@pfish.zone> parents: 59 diff changeset	113 /// Delete user credentials associated with
05cc2c27334f The Big Refactor: clean up docs and exports. Paul Fisher <paul@pfish.zone> parents: 59 diff changeset	114 /// an authentication service.
85 5e14bb093851 fix more openpam compat stuff Paul Fisher <paul@pfish.zone> parents: 84 diff changeset	115 const DELETE_CREDENTIALS = pam_ffi::PAM_DELETE_CRED as u32;
60 05cc2c27334f The Big Refactor: clean up docs and exports. Paul Fisher <paul@pfish.zone> parents: 59 diff changeset	116 /// Reinitialize user credentials.
85 5e14bb093851 fix more openpam compat stuff Paul Fisher <paul@pfish.zone> parents: 84 diff changeset	117 const REINITIALIZE_CREDENTIALS = pam_ffi::PAM_REINITIALIZE_CRED as u32;
60 05cc2c27334f The Big Refactor: clean up docs and exports. Paul Fisher <paul@pfish.zone> parents: 59 diff changeset	118 /// Extend the lifetime of user credentials.
85 5e14bb093851 fix more openpam compat stuff Paul Fisher <paul@pfish.zone> parents: 84 diff changeset	119 const REFRESH_CREDENTIALS = pam_ffi::PAM_REFRESH_CRED as u32;
64 bbe84835d6db More organization; add lots of docs. Paul Fisher <paul@pfish.zone> parents: 63 diff changeset	120
bbe84835d6db More organization; add lots of docs. Paul Fisher <paul@pfish.zone> parents: 63 diff changeset	121 // Flags used for password changing.
bbe84835d6db More organization; add lots of docs. Paul Fisher <paul@pfish.zone> parents: 63 diff changeset	122
60 05cc2c27334f The Big Refactor: clean up docs and exports. Paul Fisher <paul@pfish.zone> parents: 59 diff changeset	123 /// The password service should only update those passwords
05cc2c27334f The Big Refactor: clean up docs and exports. Paul Fisher <paul@pfish.zone> parents: 59 diff changeset	124 /// that have aged. If this flag is _not_ passed,
05cc2c27334f The Big Refactor: clean up docs and exports. Paul Fisher <paul@pfish.zone> parents: 59 diff changeset	125 /// the password service should update all passwords.
64 bbe84835d6db More organization; add lots of docs. Paul Fisher <paul@pfish.zone> parents: 63 diff changeset	126 ///
bbe84835d6db More organization; add lots of docs. Paul Fisher <paul@pfish.zone> parents: 63 diff changeset	127 /// This flag is only used by `change_authtok`.
86 23162cd399aa fix THE REST OF THE CONSTANTS Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	128 const CHANGE_EXPIRED_AUTHTOK = pam_ffi::PAM_CHANGE_EXPIRED_AUTHTOK as u32;
64 bbe84835d6db More organization; add lots of docs. Paul Fisher <paul@pfish.zone> parents: 63 diff changeset	129 /// This is a preliminary check for password changing.
bbe84835d6db More organization; add lots of docs. Paul Fisher <paul@pfish.zone> parents: 63 diff changeset	130 /// The password should not be changed.
bbe84835d6db More organization; add lots of docs. Paul Fisher <paul@pfish.zone> parents: 63 diff changeset	131 ///
bbe84835d6db More organization; add lots of docs. Paul Fisher <paul@pfish.zone> parents: 63 diff changeset	132 /// This is only used between PAM and a module.
bbe84835d6db More organization; add lots of docs. Paul Fisher <paul@pfish.zone> parents: 63 diff changeset	133 /// Applications may not use this flag.
bbe84835d6db More organization; add lots of docs. Paul Fisher <paul@pfish.zone> parents: 63 diff changeset	134 ///
bbe84835d6db More organization; add lots of docs. Paul Fisher <paul@pfish.zone> parents: 63 diff changeset	135 /// This flag is only used by `change_authtok`.
86 23162cd399aa fix THE REST OF THE CONSTANTS Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	136 const PRELIMINARY_CHECK = pam_ffi::PAM_PRELIM_CHECK as u32;
64 bbe84835d6db More organization; add lots of docs. Paul Fisher <paul@pfish.zone> parents: 63 diff changeset	137 /// The password should actuallyPR be updated.
bbe84835d6db More organization; add lots of docs. Paul Fisher <paul@pfish.zone> parents: 63 diff changeset	138 /// This and [Self::PRELIMINARY_CHECK] are mutually exclusive.
bbe84835d6db More organization; add lots of docs. Paul Fisher <paul@pfish.zone> parents: 63 diff changeset	139 ///
bbe84835d6db More organization; add lots of docs. Paul Fisher <paul@pfish.zone> parents: 63 diff changeset	140 /// This is only used between PAM and a module.
bbe84835d6db More organization; add lots of docs. Paul Fisher <paul@pfish.zone> parents: 63 diff changeset	141 /// Applications may not use this flag.
bbe84835d6db More organization; add lots of docs. Paul Fisher <paul@pfish.zone> parents: 63 diff changeset	142 ///
bbe84835d6db More organization; add lots of docs. Paul Fisher <paul@pfish.zone> parents: 63 diff changeset	143 /// This flag is only used by `change_authtok`.
86 23162cd399aa fix THE REST OF THE CONSTANTS Paul Fisher <paul@pfish.zone> parents: 85 diff changeset	144 const UPDATE_AUTHTOK = pam_ffi::PAM_UPDATE_AUTHTOK as u32;
56 daa2cde64601 Big big refactor. Probably should have been multiple changes. Paul Fisher <paul@pfish.zone> parents: 55 diff changeset	145 }
daa2cde64601 Big big refactor. Probably should have been multiple changes. Paul Fisher <paul@pfish.zone> parents: 55 diff changeset	146 }
15 27730595f1ea Adding pam-http module Anthony Nowell <anthony@algorithmia.com> parents: diff changeset	147
60 05cc2c27334f The Big Refactor: clean up docs and exports. Paul Fisher <paul@pfish.zone> parents: 59 diff changeset	148 /// The Linux-PAM error return values. Success is an Ok [Result].
05cc2c27334f The Big Refactor: clean up docs and exports. Paul Fisher <paul@pfish.zone> parents: 59 diff changeset	149 ///
56 daa2cde64601 Big big refactor. Probably should have been multiple changes. Paul Fisher <paul@pfish.zone> parents: 55 diff changeset	150 /// Most abbreviations (except `AuthTok` and `Max`) are now full words.
55 676675c3d434 Make PamResultCode implement Error. Paul Fisher <paul@pfish.zone> parents: 45 diff changeset	151 /// For more detailed information, see
56 daa2cde64601 Big big refactor. Probably should have been multiple changes. Paul Fisher <paul@pfish.zone> parents: 55 diff changeset	152 /// `/usr/include/security/_pam_types.h`.
15 27730595f1ea Adding pam-http module Anthony Nowell <anthony@algorithmia.com> parents: diff changeset	153 #[allow(non_camel_case_types, dead_code)]
90 f6186e41399b Miscellaneous fixes and cleanup: Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	154 #[derive(Copy, Clone, Debug, PartialEq, TryFromPrimitive, IntoPrimitive)]
56 daa2cde64601 Big big refactor. Probably should have been multiple changes. Paul Fisher <paul@pfish.zone> parents: 55 diff changeset	155 #[non_exhaustive] // C might give us anything!
84 a638a45e5f1f do some real irritating i32/u32 juggling to make bindgen happy Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	156 #[repr(u32)]
56 daa2cde64601 Big big refactor. Probably should have been multiple changes. Paul Fisher <paul@pfish.zone> parents: 55 diff changeset	157 pub enum ErrorCode {
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	158 OpenError = pam_ffi::PAM_OPEN_ERR,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	159 SymbolError = pam_ffi::PAM_SYMBOL_ERR,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	160 ServiceError = pam_ffi::PAM_SERVICE_ERR,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	161 SystemError = pam_ffi::PAM_SYSTEM_ERR,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	162 BufferError = pam_ffi::PAM_BUF_ERR,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	163 PermissionDenied = pam_ffi::PAM_PERM_DENIED,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	164 AuthenticationError = pam_ffi::PAM_AUTH_ERR,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	165 CredentialsInsufficient = pam_ffi::PAM_CRED_INSUFFICIENT,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	166 AuthInfoUnavailable = pam_ffi::PAM_AUTHINFO_UNAVAIL,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	167 UserUnknown = pam_ffi::PAM_USER_UNKNOWN,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	168 MaxTries = pam_ffi::PAM_MAXTRIES,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	169 NewAuthTokRequired = pam_ffi::PAM_NEW_AUTHTOK_REQD,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	170 AccountExpired = pam_ffi::PAM_ACCT_EXPIRED,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	171 SessionError = pam_ffi::PAM_SESSION_ERR,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	172 CredentialsUnavailable = pam_ffi::PAM_CRED_UNAVAIL,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	173 CredentialsExpired = pam_ffi::PAM_CRED_EXPIRED,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	174 CredentialsError = pam_ffi::PAM_CRED_ERR,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	175 NoModuleData = pam_ffi::PAM_NO_MODULE_DATA,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	176 ConversationError = pam_ffi::PAM_CONV_ERR,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	177 AuthTokError = pam_ffi::PAM_AUTHTOK_ERR,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	178 AuthTokRecoveryError = pam_ffi::PAM_AUTHTOK_RECOVERY_ERR,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	179 AuthTokLockBusy = pam_ffi::PAM_AUTHTOK_LOCK_BUSY,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	180 AuthTokDisableAging = pam_ffi::PAM_AUTHTOK_DISABLE_AGING,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	181 TryAgain = pam_ffi::PAM_TRY_AGAIN,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	182 Ignore = pam_ffi::PAM_IGNORE,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	183 Abort = pam_ffi::PAM_ABORT,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	184 AuthTokExpired = pam_ffi::PAM_AUTHTOK_EXPIRED,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	185 ModuleUnknown = pam_ffi::PAM_MODULE_UNKNOWN,
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	186 BadItem = pam_ffi::PAM_BAD_ITEM,
87 05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 86 diff changeset	187 #[cfg(feature = "linux-pam-extensions")]
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	188 ConversationAgain = pam_ffi::PAM_CONV_AGAIN,
87 05291b601f0a Well and truly separate the Linux extensions. Paul Fisher <paul@pfish.zone> parents: 86 diff changeset	189 #[cfg(feature = "linux-pam-extensions")]
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	190 Incomplete = pam_ffi::PAM_INCOMPLETE,
15 27730595f1ea Adding pam-http module Anthony Nowell <anthony@algorithmia.com> parents: diff changeset	191 }
56 daa2cde64601 Big big refactor. Probably should have been multiple changes. Paul Fisher <paul@pfish.zone> parents: 55 diff changeset	192
60 05cc2c27334f The Big Refactor: clean up docs and exports. Paul Fisher <paul@pfish.zone> parents: 59 diff changeset	193 /// A PAM-specific Result type with an [ErrorCode] error.
71 58f9d2a4df38 Reorganize everything again??? Paul Fisher <paul@pfish.zone> parents: 70 diff changeset	194 pub type Result<T> = StdResult<T, ErrorCode>;
60 05cc2c27334f The Big Refactor: clean up docs and exports. Paul Fisher <paul@pfish.zone> parents: 59 diff changeset	195
90 f6186e41399b Miscellaneous fixes and cleanup: Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	196 impl Display for ErrorCode {
f6186e41399b Miscellaneous fixes and cleanup: Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	197 fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
f6186e41399b Miscellaneous fixes and cleanup: Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	198 match pam_ffi::strerror((*self).into()) {
f6186e41399b Miscellaneous fixes and cleanup: Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	199 Some(err) => f.write_str(err),
f6186e41399b Miscellaneous fixes and cleanup: Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	200 None => self.fmt_internal(f),
f6186e41399b Miscellaneous fixes and cleanup: Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	201 }
f6186e41399b Miscellaneous fixes and cleanup: Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	202 }
f6186e41399b Miscellaneous fixes and cleanup: Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	203 }
f6186e41399b Miscellaneous fixes and cleanup: Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	204
f6186e41399b Miscellaneous fixes and cleanup: Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	205 impl Error for ErrorCode {}
f6186e41399b Miscellaneous fixes and cleanup: Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	206
56 daa2cde64601 Big big refactor. Probably should have been multiple changes. Paul Fisher <paul@pfish.zone> parents: 55 diff changeset	207 impl ErrorCode {
60 05cc2c27334f The Big Refactor: clean up docs and exports. Paul Fisher <paul@pfish.zone> parents: 59 diff changeset	208 /// Converts this [Result] into a C-compatible result code.
05cc2c27334f The Big Refactor: clean up docs and exports. Paul Fisher <paul@pfish.zone> parents: 59 diff changeset	209 pub fn result_to_c<T>(value: Result<T>) -> c_int {
56 daa2cde64601 Big big refactor. Probably should have been multiple changes. Paul Fisher <paul@pfish.zone> parents: 55 diff changeset	210 match value {
daa2cde64601 Big big refactor. Probably should have been multiple changes. Paul Fisher <paul@pfish.zone> parents: 55 diff changeset	211 Ok(_) => 0, // PAM_SUCCESS
84 a638a45e5f1f do some real irritating i32/u32 juggling to make bindgen happy Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	212 Err(otherwise) => u32::from(otherwise) as i32,
56 daa2cde64601 Big big refactor. Probably should have been multiple changes. Paul Fisher <paul@pfish.zone> parents: 55 diff changeset	213 }
daa2cde64601 Big big refactor. Probably should have been multiple changes. Paul Fisher <paul@pfish.zone> parents: 55 diff changeset	214 }
daa2cde64601 Big big refactor. Probably should have been multiple changes. Paul Fisher <paul@pfish.zone> parents: 55 diff changeset	215
60 05cc2c27334f The Big Refactor: clean up docs and exports. Paul Fisher <paul@pfish.zone> parents: 59 diff changeset	216 /// Converts a C result code into a [Result], with success as Ok.
59 3f4a77aa88be Fix string copyting and improve error situation. Paul Fisher <paul@pfish.zone> parents: 56 diff changeset	217 /// Invalid values are returned as a [Self::SystemError].
60 05cc2c27334f The Big Refactor: clean up docs and exports. Paul Fisher <paul@pfish.zone> parents: 59 diff changeset	218 pub fn result_from(value: c_int) -> Result<()> {
56 daa2cde64601 Big big refactor. Probably should have been multiple changes. Paul Fisher <paul@pfish.zone> parents: 55 diff changeset	219 match value {
daa2cde64601 Big big refactor. Probably should have been multiple changes. Paul Fisher <paul@pfish.zone> parents: 55 diff changeset	220 0 => Ok(()),
84 a638a45e5f1f do some real irritating i32/u32 juggling to make bindgen happy Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	221 value => Err((value as u32).try_into().unwrap_or(Self::SystemError)),
56 daa2cde64601 Big big refactor. Probably should have been multiple changes. Paul Fisher <paul@pfish.zone> parents: 55 diff changeset	222 }
daa2cde64601 Big big refactor. Probably should have been multiple changes. Paul Fisher <paul@pfish.zone> parents: 55 diff changeset	223 }
90 f6186e41399b Miscellaneous fixes and cleanup: Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	224
f6186e41399b Miscellaneous fixes and cleanup: Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	225 /// A basic Display implementation for if we don't link against PAM.
f6186e41399b Miscellaneous fixes and cleanup: Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	226 fn fmt_internal(self, f: &mut Formatter<'_>) -> fmt::Result {
f6186e41399b Miscellaneous fixes and cleanup: Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	227 write!(f, "PAM error: {self:?} ({n})", n = self as c_uint)
f6186e41399b Miscellaneous fixes and cleanup: Paul Fisher <paul@pfish.zone> parents: 87 diff changeset	228 }
56 daa2cde64601 Big big refactor. Probably should have been multiple changes. Paul Fisher <paul@pfish.zone> parents: 55 diff changeset	229 }
daa2cde64601 Big big refactor. Probably should have been multiple changes. Paul Fisher <paul@pfish.zone> parents: 55 diff changeset	230
70 9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 64 diff changeset	231 /// Returned when text that should not have any `\0` bytes in it does.
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 64 diff changeset	232 /// Analogous to [`std::ffi::NulError`], but the data it was created from
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 64 diff changeset	233 /// is borrowed.
59 3f4a77aa88be Fix string copyting and improve error situation. Paul Fisher <paul@pfish.zone> parents: 56 diff changeset	234 #[cfg(test)]
3f4a77aa88be Fix string copyting and improve error situation. Paul Fisher <paul@pfish.zone> parents: 56 diff changeset	235 mod tests {
3f4a77aa88be Fix string copyting and improve error situation. Paul Fisher <paul@pfish.zone> parents: 56 diff changeset	236 use super::*;
3f4a77aa88be Fix string copyting and improve error situation. Paul Fisher <paul@pfish.zone> parents: 56 diff changeset	237
3f4a77aa88be Fix string copyting and improve error situation. Paul Fisher <paul@pfish.zone> parents: 56 diff changeset	238 #[test]
3f4a77aa88be Fix string copyting and improve error situation. Paul Fisher <paul@pfish.zone> parents: 56 diff changeset	239 fn test_enums() {
3f4a77aa88be Fix string copyting and improve error situation. Paul Fisher <paul@pfish.zone> parents: 56 diff changeset	240 assert_eq!(Ok(()), ErrorCode::result_from(0));
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	241 assert_eq!(
84 a638a45e5f1f do some real irritating i32/u32 juggling to make bindgen happy Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	242 pam_ffi::PAM_BAD_ITEM as i32,
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	243 ErrorCode::result_to_c::<()>(Err(ErrorCode::BadItem))
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	244 );
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	245 assert_eq!(
5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	246 Err(ErrorCode::Abort),
84 a638a45e5f1f do some real irritating i32/u32 juggling to make bindgen happy Paul Fisher <paul@pfish.zone> parents: 80 diff changeset	247 ErrorCode::result_from(pam_ffi::PAM_ABORT as i32)
80 5aa1a010f1e8 Start using PAM headers; improve owned/borrowed distinction. Paul Fisher <paul@pfish.zone> parents: 77 diff changeset	248 );
59 3f4a77aa88be Fix string copyting and improve error situation. Paul Fisher <paul@pfish.zone> parents: 56 diff changeset	249 assert_eq!(Err(ErrorCode::SystemError), ErrorCode::result_from(423));
3f4a77aa88be Fix string copyting and improve error situation. Paul Fisher <paul@pfish.zone> parents: 56 diff changeset	250 }
3f4a77aa88be Fix string copyting and improve error situation. Paul Fisher <paul@pfish.zone> parents: 56 diff changeset	251 }

Mercurial > crates > nonstick

annotate src/constants.rs @ 98:b87100c5eed4