Mercurial > crates > nonstick
annotate src/module.rs @ 11:827faa554528
Added items module.
| author | Marc Brinkmann <git@marcbrinkmann.de> |
|---|---|
| date | Sun, 26 Feb 2017 12:08:11 +0100 |
| parents | 74b53b921b23 |
| children | 30831c70e5c0 |
| rev | line source |
|---|---|
| 1 | 1 //! Functions for use in pam modules. |
| 2 | |
|
8
a83c56216e21
Ran everything through rustfmt.
Marc Brinkmann <git@marcbrinkmann.de>
parents:
7
diff
changeset
|
3 use libc::c_char; |
| 1 | 4 use std::{mem, ptr}; |
| 5 use std::ffi::{CStr, CString}; | |
|
8
a83c56216e21
Ran everything through rustfmt.
Marc Brinkmann <git@marcbrinkmann.de>
parents:
7
diff
changeset
|
6 use std::marker::PhantomData; |
| 1 | 7 |
| 8 use constants; | |
| 9 use constants::*; | |
| 10 | |
| 11 /// Opaque type, used as a pointer when making pam API calls. | |
| 12 /// | |
| 13 /// A module is invoked via an external function such as `pam_sm_authenticate`. | |
| 14 /// Such a call provides a pam handle pointer. The same pointer should be given | |
| 15 /// as an argument when making API calls. | |
| 16 #[allow(missing_copy_implementations)] | |
| 17 pub enum PamHandleT {} | |
| 18 | |
| 19 #[allow(missing_copy_implementations)] | |
| 20 enum PamItemT {} | |
| 21 | |
| 22 #[allow(missing_copy_implementations)] | |
| 23 pub enum PamDataT {} | |
| 24 | |
| 25 #[link(name = "pam")] | |
|
8
a83c56216e21
Ran everything through rustfmt.
Marc Brinkmann <git@marcbrinkmann.de>
parents:
7
diff
changeset
|
26 extern "C" { |
| 1 | 27 fn pam_get_data(pamh: *const PamHandleT, |
| 28 module_data_name: *const c_char, | |
|
8
a83c56216e21
Ran everything through rustfmt.
Marc Brinkmann <git@marcbrinkmann.de>
parents:
7
diff
changeset
|
29 data: &mut *const PamDataT) |
|
a83c56216e21
Ran everything through rustfmt.
Marc Brinkmann <git@marcbrinkmann.de>
parents:
7
diff
changeset
|
30 -> PamResultCode; |
| 1 | 31 |
| 32 fn pam_set_data(pamh: *const PamHandleT, | |
| 33 module_data_name: *const c_char, | |
| 34 data: Box<PamDataT>, | |
|
8
a83c56216e21
Ran everything through rustfmt.
Marc Brinkmann <git@marcbrinkmann.de>
parents:
7
diff
changeset
|
35 cleanup: extern "C" fn(pamh: *const PamHandleT, |
|
a83c56216e21
Ran everything through rustfmt.
Marc Brinkmann <git@marcbrinkmann.de>
parents:
7
diff
changeset
|
36 data: Box<PamDataT>, |
|
a83c56216e21
Ran everything through rustfmt.
Marc Brinkmann <git@marcbrinkmann.de>
parents:
7
diff
changeset
|
37 error_status: PamResultCode)) |
|
a83c56216e21
Ran everything through rustfmt.
Marc Brinkmann <git@marcbrinkmann.de>
parents:
7
diff
changeset
|
38 -> PamResultCode; |
| 1 | 39 |
| 40 fn pam_get_item(pamh: *const PamHandleT, | |
| 41 item_type: PamItemType, | |
|
8
a83c56216e21
Ran everything through rustfmt.
Marc Brinkmann <git@marcbrinkmann.de>
parents:
7
diff
changeset
|
42 item: &mut *const PamItemT) |
|
a83c56216e21
Ran everything through rustfmt.
Marc Brinkmann <git@marcbrinkmann.de>
parents:
7
diff
changeset
|
43 -> PamResultCode; |
| 1 | 44 |
| 45 fn pam_set_item(pamh: *mut PamHandleT, | |
| 46 item_type: PamItemType, | |
|
8
a83c56216e21
Ran everything through rustfmt.
Marc Brinkmann <git@marcbrinkmann.de>
parents:
7
diff
changeset
|
47 item: &PamItemT) |
|
a83c56216e21
Ran everything through rustfmt.
Marc Brinkmann <git@marcbrinkmann.de>
parents:
7
diff
changeset
|
48 -> PamResultCode; |
| 1 | 49 |
| 50 fn pam_get_user(pamh: *const PamHandleT, | |
|
8
a83c56216e21
Ran everything through rustfmt.
Marc Brinkmann <git@marcbrinkmann.de>
parents:
7
diff
changeset
|
51 user: &*mut c_char, |
|
a83c56216e21
Ran everything through rustfmt.
Marc Brinkmann <git@marcbrinkmann.de>
parents:
7
diff
changeset
|
52 prompt: *const c_char) |
|
a83c56216e21
Ran everything through rustfmt.
Marc Brinkmann <git@marcbrinkmann.de>
parents:
7
diff
changeset
|
53 -> PamResultCode; |
| 1 | 54 } |
| 55 | |
| 56 pub type PamResult<T> = Result<T, PamResultCode>; | |
| 57 | |
| 58 /// Type-level mapping for safely retrieving values with `get_item`. | |
| 59 /// | |
| 60 /// See `pam_get_item` in | |
| 61 /// http://www.linux-pam.org/Linux-PAM-html/mwg-expected-by-module-item.html | |
| 62 pub trait PamItem { | |
| 63 /// Maps a Rust type to a pam constant. | |
| 64 /// | |
| 65 /// For example, the type PamConv maps to the constant PAM_CONV. The pam | |
| 66 /// API contract specifies that when the API function `pam_get_item` is | |
| 67 /// called with the constant PAM_CONV, it will return a value of type | |
| 68 /// `PamConv`. | |
|
7
9380392b9a60
Changes type marker parameter type from Option<T> to PhantomData<T>
Jesse Hallett <jesse@galois.com>
parents:
6
diff
changeset
|
69 fn item_type(_: PhantomData<Self>) -> PamItemType; |
| 1 | 70 } |
| 71 | |
| 72 /// Gets some value, identified by `key`, that has been set by the module | |
| 73 /// previously. | |
| 74 /// | |
| 75 /// See `pam_get_data` in | |
| 76 /// http://www.linux-pam.org/Linux-PAM-html/mwg-expected-by-module-item.html | |
| 77 pub unsafe fn get_data<'a, T>(pamh: &'a PamHandleT, key: &str) -> PamResult<&'a T> { | |
| 78 let c_key = CString::new(key).unwrap().as_ptr(); | |
|
6
2ec97116d72c
Updates for rustc 1.0.0-beta
Jesse Hallett <jesse@galois.com>
parents:
1
diff
changeset
|
79 let mut ptr: *const PamDataT = ptr::null(); |
| 1 | 80 let res = pam_get_data(pamh, c_key, &mut ptr); |
| 81 if constants::PAM_SUCCESS == res && !ptr.is_null() { | |
|
6
2ec97116d72c
Updates for rustc 1.0.0-beta
Jesse Hallett <jesse@galois.com>
parents:
1
diff
changeset
|
82 let typed_ptr: *const T = mem::transmute(ptr); |
|
2ec97116d72c
Updates for rustc 1.0.0-beta
Jesse Hallett <jesse@galois.com>
parents:
1
diff
changeset
|
83 let data: &T = &*typed_ptr; |
| 1 | 84 Ok(data) |
|
8
a83c56216e21
Ran everything through rustfmt.
Marc Brinkmann <git@marcbrinkmann.de>
parents:
7
diff
changeset
|
85 } else { |
| 1 | 86 Err(res) |
| 87 } | |
| 88 } | |
| 89 | |
| 90 /// Stores a value that can be retrieved later with `get_data`. The value lives | |
| 91 /// as long as the current pam cycle. | |
| 92 /// | |
| 93 /// See `pam_set_data` in | |
| 94 /// http://www.linux-pam.org/Linux-PAM-html/mwg-expected-by-module-item.html | |
| 95 pub fn set_data<T>(pamh: &PamHandleT, key: &str, data: Box<T>) -> PamResult<()> { | |
| 96 let c_key = CString::new(key).unwrap().as_ptr(); | |
| 97 let res = unsafe { | |
| 98 let c_data: Box<PamDataT> = mem::transmute(data); | |
| 99 pam_set_data(pamh, c_key, c_data, cleanup::<T>) | |
| 100 }; | |
|
8
a83c56216e21
Ran everything through rustfmt.
Marc Brinkmann <git@marcbrinkmann.de>
parents:
7
diff
changeset
|
101 if constants::PAM_SUCCESS == res { |
|
a83c56216e21
Ran everything through rustfmt.
Marc Brinkmann <git@marcbrinkmann.de>
parents:
7
diff
changeset
|
102 Ok(()) |
|
a83c56216e21
Ran everything through rustfmt.
Marc Brinkmann <git@marcbrinkmann.de>
parents:
7
diff
changeset
|
103 } else { |
|
a83c56216e21
Ran everything through rustfmt.
Marc Brinkmann <git@marcbrinkmann.de>
parents:
7
diff
changeset
|
104 Err(res) |
|
a83c56216e21
Ran everything through rustfmt.
Marc Brinkmann <git@marcbrinkmann.de>
parents:
7
diff
changeset
|
105 } |
| 1 | 106 } |
| 107 | |
| 108 #[no_mangle] | |
|
8
a83c56216e21
Ran everything through rustfmt.
Marc Brinkmann <git@marcbrinkmann.de>
parents:
7
diff
changeset
|
109 pub extern "C" fn cleanup<T>(_: *const PamHandleT, c_data: Box<PamDataT>, _: PamResultCode) { |
| 1 | 110 unsafe { |
| 111 let data: Box<T> = mem::transmute(c_data); | |
| 112 mem::drop(data); | |
| 113 } | |
| 114 } | |
| 115 | |
| 116 /// Retrieves a value that has been set, possibly by the pam client. This is | |
| 117 /// particularly useful for getting a `PamConv` reference. | |
| 118 /// | |
| 119 /// See `pam_get_item` in | |
| 120 /// http://www.linux-pam.org/Linux-PAM-html/mwg-expected-by-module-item.html | |
| 121 pub fn get_item<'a, T: PamItem>(pamh: &'a PamHandleT) -> PamResult<&'a T> { | |
|
6
2ec97116d72c
Updates for rustc 1.0.0-beta
Jesse Hallett <jesse@galois.com>
parents:
1
diff
changeset
|
122 let mut ptr: *const PamItemT = ptr::null(); |
| 1 | 123 let (res, item) = unsafe { |
|
7
9380392b9a60
Changes type marker parameter type from Option<T> to PhantomData<T>
Jesse Hallett <jesse@galois.com>
parents:
6
diff
changeset
|
124 let r = pam_get_item(pamh, PamItem::item_type(PhantomData::<T>), &mut ptr); |
|
6
2ec97116d72c
Updates for rustc 1.0.0-beta
Jesse Hallett <jesse@galois.com>
parents:
1
diff
changeset
|
125 let typed_ptr: *const T = mem::transmute(ptr); |
|
2ec97116d72c
Updates for rustc 1.0.0-beta
Jesse Hallett <jesse@galois.com>
parents:
1
diff
changeset
|
126 let t: &T = &*typed_ptr; |
| 1 | 127 (r, t) |
| 128 }; | |
|
8
a83c56216e21
Ran everything through rustfmt.
Marc Brinkmann <git@marcbrinkmann.de>
parents:
7
diff
changeset
|
129 if constants::PAM_SUCCESS == res { |
|
a83c56216e21
Ran everything through rustfmt.
Marc Brinkmann <git@marcbrinkmann.de>
parents:
7
diff
changeset
|
130 Ok(item) |
|
a83c56216e21
Ran everything through rustfmt.
Marc Brinkmann <git@marcbrinkmann.de>
parents:
7
diff
changeset
|
131 } else { |
|
a83c56216e21
Ran everything through rustfmt.
Marc Brinkmann <git@marcbrinkmann.de>
parents:
7
diff
changeset
|
132 Err(res) |
|
a83c56216e21
Ran everything through rustfmt.
Marc Brinkmann <git@marcbrinkmann.de>
parents:
7
diff
changeset
|
133 } |
| 1 | 134 } |
| 135 | |
| 10 | 136 /// Sets a value in the pam context. The value can be retrieved using |
| 137 /// `get_item`. | |
| 138 /// | |
| 139 /// Note that all items are strings, except `PAM_CONV` and `PAM_FAIL_DELAY`. | |
| 140 /// | |
| 141 /// See `pam_set_item` in | |
| 142 /// http://www.linux-pam.org/Linux-PAM-html/mwg-expected-by-module-item.html | |
| 143 pub fn set_item_str<'a, P: PamItem>(pamh: &'a mut PamHandleT, item: &str) -> PamResult<()> { | |
| 144 let c_item = CString::new(item).unwrap().as_ptr(); | |
| 145 | |
| 146 let res = unsafe { | |
| 147 pam_set_item(pamh, | |
| 148 PamItem::item_type(PhantomData::<P>), | |
| 149 | |
| 150 // unwrapping is okay here, as c_item will not be a NULL | |
| 151 // pointer | |
| 152 (c_item as *const PamItemT).as_ref().unwrap()) | |
| 153 }; | |
| 154 if constants::PAM_SUCCESS == res { | |
| 155 Ok(()) | |
| 156 } else { | |
| 157 Err(res) | |
| 158 } | |
| 159 } | |
| 160 | |
| 1 | 161 /// Retrieves the name of the user who is authenticating or logging in. |
| 162 /// | |
| 163 /// This is really a specialization of `get_item`. | |
| 164 /// | |
| 165 /// See `pam_get_user` in | |
| 166 /// http://www.linux-pam.org/Linux-PAM-html/mwg-expected-by-module-item.html | |
| 167 pub fn get_user<'a>(pamh: &'a PamHandleT, prompt: Option<&str>) -> PamResult<String> { | |
| 168 let ptr: *mut c_char = ptr::null_mut(); | |
| 169 let c_prompt = match prompt { | |
| 170 Some(p) => CString::new(p).unwrap().as_ptr(), | |
|
8
a83c56216e21
Ran everything through rustfmt.
Marc Brinkmann <git@marcbrinkmann.de>
parents:
7
diff
changeset
|
171 None => ptr::null(), |
| 1 | 172 }; |
| 173 let res = unsafe { pam_get_user(pamh, &ptr, c_prompt) }; | |
| 174 if constants::PAM_SUCCESS == res && !ptr.is_null() { | |
| 175 let const_ptr = ptr as *const c_char; | |
| 176 let bytes = unsafe { CStr::from_ptr(const_ptr).to_bytes() }; | |
|
8
a83c56216e21
Ran everything through rustfmt.
Marc Brinkmann <git@marcbrinkmann.de>
parents:
7
diff
changeset
|
177 String::from_utf8(bytes.to_vec()).map_err(|_| PAM_CONV_ERR) |
|
a83c56216e21
Ran everything through rustfmt.
Marc Brinkmann <git@marcbrinkmann.de>
parents:
7
diff
changeset
|
178 } else { |
| 1 | 179 Err(res) |
| 180 } | |
| 181 } |