Merge pull request #347 from yodaldevoid/ScottCUSA/add_userauth_banner

Add Session.userauth_banner

Author: yodaldevoid

src/session.rs

@@ -662,6 +662,27 @@ impl Session {
         }
     }
 
+    /// Retrieve banner message from server, if available.
+    ///
+    /// When no such message is sent by server or if no authentication attempt has
+    /// been made, this function returns LIBSSH2_ERROR_MISSING_AUTH_BANNER.
+    ///
+    /// The return value is the userauth banner or None or an Error
+    pub fn userauth_banner(&self) -> Result<Option<&str>, Error> {
+        let mut userauth_banner = null_mut();
+        let inner = self.inner();
+        match unsafe { raw::libssh2_userauth_banner(inner.raw, &mut userauth_banner)} {
+            0 => {
+                unsafe {
+                    Ok(::opt_bytes(self, userauth_banner).and_then(|s| str::from_utf8(s).ok()))
+                }
+            },
+            rc => {
+                Err(Error::from_errno(ErrorCode::Session(rc)))
+            }
+        }
+    }
+
     /// Set preferred key exchange method
     ///
     /// The preferences provided are a comma delimited list of preferred methods

tests/all/session.rs

@@ -58,6 +58,19 @@ fn smoke_handshake() {
     sess.host_key_hash(HashType::Md5).unwrap();
 }
 
+#[test]
+fn smoke_userauth_banner() {
+    let user = env::var("USER").unwrap();
+    let socket = ::socket();
+    let mut sess = Session::new().unwrap();
+    sess.set_tcp_stream(socket);
+    sess.handshake().unwrap();
+    sess.host_key().unwrap();
+    sess.auth_methods(&user).unwrap();
+    let banner = sess.userauth_banner().unwrap().unwrap();
+    assert_eq!(banner, "Authorized access only!");
+}
+
 #[test]
 fn keyboard_interactive() {
     let user = env::var("USER").unwrap();

tests/run_integration_tests.sh

@@ -32,10 +32,13 @@ cp $SSHDIR/id_rsa.pub $SSHDIR/authorized_keys
 
 ssh-keygen -f $SSHDIR/ssh_host_rsa_key -N '' -t rsa
 
+echo -n "Authorized access only!" > $SSHDIR/banner
+
 cat > $SSHDIR/sshd_config <<-EOT
 AuthorizedKeysFile=$SSHDIR/authorized_keys
 HostKey=$SSHDIR/ssh_host_rsa_key
 PidFile=$SSHDIR/sshd.pid
+Banner $SSHDIR/banner
 Subsystem sftp internal-sftp
 UsePAM yes
 X11Forwarding yes