annotate src/conv.rs @ 8:a83c56216e21

Ran everything through rustfmt.
author Marc Brinkmann <git@marcbrinkmann.de>
date Sun, 26 Feb 2017 11:29:31 +0100
parents 9380392b9a60
children 30831c70e5c0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
1 use libc::{c_char, c_int};
8
a83c56216e21 Ran everything through rustfmt.
Marc Brinkmann <git@marcbrinkmann.de>
parents: 7
diff changeset
2 use std::ptr;
1
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
3 use std::ffi::{CStr, CString};
8
a83c56216e21 Ran everything through rustfmt.
Marc Brinkmann <git@marcbrinkmann.de>
parents: 7
diff changeset
4 use std::marker::PhantomData;
1
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
5
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
6 use constants;
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
7 use constants::*;
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
8 use module::{PamItem, PamResult};
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
9
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
10 #[allow(missing_copy_implementations)]
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
11 pub enum AppDataPtr {}
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
12
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
13 #[repr(C)]
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
14 struct PamMessage {
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
15 msg_style: PamMessageStyle,
8
a83c56216e21 Ran everything through rustfmt.
Marc Brinkmann <git@marcbrinkmann.de>
parents: 7
diff changeset
16 msg: *const c_char,
1
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
17 }
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
18
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
19 #[repr(C)]
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
20 struct PamResponse {
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
21 resp: *const c_char,
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
22 resp_retcode: AlwaysZero,
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
23 }
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
24
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
25 /// `PamConv` acts as a channel for communicating with user.
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
26 ///
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
27 /// Communication is mediated by the pam client (the application that invoked
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
28 /// pam). Messages sent will be relayed to the user by the client, and response
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
29 /// will be relayed back.
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
30 #[repr(C)]
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
31 pub struct PamConv {
8
a83c56216e21 Ran everything through rustfmt.
Marc Brinkmann <git@marcbrinkmann.de>
parents: 7
diff changeset
32 conv: extern "C" fn(num_msg: c_int,
a83c56216e21 Ran everything through rustfmt.
Marc Brinkmann <git@marcbrinkmann.de>
parents: 7
diff changeset
33 pam_message: &&PamMessage,
a83c56216e21 Ran everything through rustfmt.
Marc Brinkmann <git@marcbrinkmann.de>
parents: 7
diff changeset
34 pam_response: &mut *const PamResponse,
a83c56216e21 Ran everything through rustfmt.
Marc Brinkmann <git@marcbrinkmann.de>
parents: 7
diff changeset
35 appdata_ptr: *const AppDataPtr)
a83c56216e21 Ran everything through rustfmt.
Marc Brinkmann <git@marcbrinkmann.de>
parents: 7
diff changeset
36 -> PamResultCode,
1
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
37 appdata_ptr: *const AppDataPtr,
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
38 }
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
39
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
40 impl PamConv {
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
41 /// Sends a message to the pam client.
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
42 ///
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
43 /// This will typically result in the user seeing a message or a prompt.
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
44 /// There are several message styles available:
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
45 ///
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
46 /// - PAM_PROMPT_ECHO_OFF
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
47 /// - PAM_PROMPT_ECHO_ON
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
48 /// - PAM_ERROR_MSG
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
49 /// - PAM_TEXT_INFO
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
50 /// - PAM_RADIO_TYPE
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
51 /// - PAM_BINARY_PROMPT
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
52 ///
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
53 /// Note that the user experience will depend on how the client implements
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
54 /// these message styles - and not all applications implement all message
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
55 /// styles.
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
56 pub fn send(&self, style: PamMessageStyle, msg: &str) -> PamResult<Option<String>> {
6
2ec97116d72c Updates for rustc 1.0.0-beta
Jesse Hallett <jesse@galois.com>
parents: 1
diff changeset
57 let mut resp_ptr: *const PamResponse = ptr::null();
1
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
58 let msg = PamMessage {
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
59 msg_style: style,
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
60 msg: CString::new(msg).unwrap().as_ptr(),
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
61 };
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
62
6
2ec97116d72c Updates for rustc 1.0.0-beta
Jesse Hallett <jesse@galois.com>
parents: 1
diff changeset
63 let ret = (self.conv)(1, &&msg, &mut resp_ptr, self.appdata_ptr);
1
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
64
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
65 if constants::PAM_SUCCESS == ret {
6
2ec97116d72c Updates for rustc 1.0.0-beta
Jesse Hallett <jesse@galois.com>
parents: 1
diff changeset
66 if resp_ptr.is_null() {
2ec97116d72c Updates for rustc 1.0.0-beta
Jesse Hallett <jesse@galois.com>
parents: 1
diff changeset
67 Ok(None)
8
a83c56216e21 Ran everything through rustfmt.
Marc Brinkmann <git@marcbrinkmann.de>
parents: 7
diff changeset
68 } else {
6
2ec97116d72c Updates for rustc 1.0.0-beta
Jesse Hallett <jesse@galois.com>
parents: 1
diff changeset
69 let bytes = unsafe { CStr::from_ptr((*resp_ptr).resp).to_bytes() };
2ec97116d72c Updates for rustc 1.0.0-beta
Jesse Hallett <jesse@galois.com>
parents: 1
diff changeset
70 Ok(String::from_utf8(bytes.to_vec()).ok())
2ec97116d72c Updates for rustc 1.0.0-beta
Jesse Hallett <jesse@galois.com>
parents: 1
diff changeset
71 }
1
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
72 } else {
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
73 Err(ret)
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
74 }
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
75 }
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
76 }
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
77
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
78 impl PamItem for PamConv {
8
a83c56216e21 Ran everything through rustfmt.
Marc Brinkmann <git@marcbrinkmann.de>
parents: 7
diff changeset
79 fn item_type(_: PhantomData<Self>) -> PamItemType {
a83c56216e21 Ran everything through rustfmt.
Marc Brinkmann <git@marcbrinkmann.de>
parents: 7
diff changeset
80 PAM_CONV
a83c56216e21 Ran everything through rustfmt.
Marc Brinkmann <git@marcbrinkmann.de>
parents: 7
diff changeset
81 }
1
b195a14058bb initial commit
Jesse Hallett <jesse@galois.com>
parents:
diff changeset
82 }