ftp_login: Expand login scanner specs

LLM was used here.

Author: g0tmi1k

spec/lib/metasploit/framework/login_scanner/ftp_spec.rb

@@ -100,11 +100,17 @@
         expect(ftp_scanner.errors[:ftp_timeout]).to be_empty
       end
     end
+  end
 
-
+  describe '#banner' do
+    it 'is a public method' do
+      expect(described_class.public_method_defined?(:banner)).to be true
+    end
   end
 
   context '#attempt_login' do
+    let(:mock_socket) { double('socket') }
+
     before(:example) do
       ftp_scanner.host = '127.0.0.1'
       ftp_scanner.port = 21
@@ -114,34 +120,144 @@
       ftp_scanner.cred_details = detail_group
     end
 
+    context 'when the connection fails' do
 
-    context 'when it fails' do
-
-      it 'returns Metasploit::Model::Login::Status::UNABLE_TO_CONNECT for a Rex::ConnectionError' do
+      it 'returns UNABLE_TO_CONNECT for a Rex::ConnectionError' do
         expect(Rex::Socket::Tcp).to receive(:create) { raise Rex::ConnectionError }
         expect(ftp_scanner.attempt_login(pub_pri).status).to eq Metasploit::Model::Login::Status::UNABLE_TO_CONNECT
       end
 
-      it 'returns Metasploit::Model::Login::Status::UNABLE_TO_CONNECT for a Rex::AddressInUse' do
+      it 'returns UNABLE_TO_CONNECT for a Rex::AddressInUse' do
         expect(Rex::Socket::Tcp).to receive(:create) { raise Rex::AddressInUse }
         expect(ftp_scanner.attempt_login(pub_pri).status).to eq Metasploit::Model::Login::Status::UNABLE_TO_CONNECT
       end
 
-      it 'returns :connection_disconnect for a ::EOFError' do
+      it 'returns UNABLE_TO_CONNECT for a ::EOFError' do
         expect(Rex::Socket::Tcp).to receive(:create) { raise ::EOFError }
         expect(ftp_scanner.attempt_login(pub_pri).status).to eq Metasploit::Model::Login::Status::UNABLE_TO_CONNECT
       end
 
-      it 'returns :connection_disconnect for a ::Timeout::Error' do
+      it 'returns UNABLE_TO_CONNECT for a ::Timeout::Error' do
         expect(Rex::Socket::Tcp).to receive(:create) { raise ::Timeout::Error }
         expect(ftp_scanner.attempt_login(pub_pri).status).to eq Metasploit::Model::Login::Status::UNABLE_TO_CONNECT
       end
 
+      it 'returns UNABLE_TO_CONNECT for a Errno::ECONNRESET' do
+        expect(Rex::Socket::Tcp).to receive(:create) { raise Errno::ECONNRESET }
+        expect(ftp_scanner.attempt_login(pub_pri).status).to eq Metasploit::Model::Login::Status::UNABLE_TO_CONNECT
+      end
+
+      it 'returns UNABLE_TO_CONNECT for a Rex::ConnectionTimeout' do
+        expect(Rex::Socket::Tcp).to receive(:create) { raise Rex::ConnectionTimeout }
+        expect(ftp_scanner.attempt_login(pub_pri).status).to eq Metasploit::Model::Login::Status::UNABLE_TO_CONNECT
+      end
+
+      it 'sets proof to the exception message' do
+        expect(Rex::Socket::Tcp).to receive(:create) { raise ::Timeout::Error, 'connection timed out' }
+        expect(ftp_scanner.attempt_login(pub_pri).proof).to eq 'connection timed out'
+      end
+
     end
 
-    context 'when it succeeds' do
+    context 'when the connection succeeds' do
+      before(:example) do
+        allow(ftp_scanner).to receive(:connect).and_return(mock_socket)
+        allow(ftp_scanner).to receive(:disconnect)
+      end
+
+      context 'and the login fails' do
+
+        it 'returns UNABLE_TO_CONNECT when send_user returns nil' do
+          allow(ftp_scanner).to receive(:send_user).and_return(nil)
+          expect(ftp_scanner.attempt_login(pub_pri).status).to eq Metasploit::Model::Login::Status::UNABLE_TO_CONNECT
+        end
+
+        it 'sets proof to the expected string when the response is nil' do
+          allow(ftp_scanner).to receive(:send_user).and_return(nil)
+          expect(ftp_scanner.attempt_login(pub_pri).proof).to eq 'No response to login command'
+        end
+
+        it 'returns INCORRECT when send_user returns a non-2xx non-331 response' do
+          allow(ftp_scanner).to receive(:send_user).and_return("530 Login incorrect\r\n")
+          expect(ftp_scanner.attempt_login(pub_pri).status).to eq Metasploit::Model::Login::Status::INCORRECT
+        end
 
+        it 'sets proof to the stripped server response when INCORRECT' do
+          allow(ftp_scanner).to receive(:send_user).and_return("530 Login incorrect\r\n")
+          expect(ftp_scanner.attempt_login(pub_pri).proof).to eq '530 Login incorrect'
+        end
 
+        it 'does not call send_pass when send_user response does not match 331 or 2xx' do
+          allow(ftp_scanner).to receive(:send_user).and_return("530 Login incorrect\r\n")
+          expect(ftp_scanner).not_to receive(:send_pass)
+          ftp_scanner.attempt_login(pub_pri)
+        end
+
+        it 'returns INCORRECT when send_pass returns a non-2xx response' do
+          allow(ftp_scanner).to receive(:send_user).and_return("331 Password required\r\n")
+          allow(ftp_scanner).to receive(:send_pass).and_return("530 Login incorrect\r\n")
+          expect(ftp_scanner.attempt_login(pub_pri).status).to eq Metasploit::Model::Login::Status::INCORRECT
+        end
+
+        it 'returns INCORRECT when send_user returns 2xx and send_pass returns a non-2xx response' do
+          allow(ftp_scanner).to receive(:send_user).and_return("230 Login successful\r\n")
+          allow(ftp_scanner).to receive(:send_pass).and_return("530 Login incorrect\r\n")
+          expect(ftp_scanner.attempt_login(pub_pri).status).to eq Metasploit::Model::Login::Status::INCORRECT
+        end
+
+        it 'returns UNABLE_TO_CONNECT when send_pass returns nil' do
+          allow(ftp_scanner).to receive(:send_user).and_return("331 Password required\r\n")
+          allow(ftp_scanner).to receive(:send_pass).and_return(nil)
+          expect(ftp_scanner.attempt_login(pub_pri).status).to eq Metasploit::Model::Login::Status::UNABLE_TO_CONNECT
+        end
+
+      end
+
+      context 'and the login succeeds' do
+
+        it 'returns SUCCESSFUL when send_user returns 331 and send_pass returns 2xx' do
+          allow(ftp_scanner).to receive(:send_user).and_return("331 Password required\r\n")
+          allow(ftp_scanner).to receive(:send_pass).and_return("230 Login successful\r\n")
+          expect(ftp_scanner.attempt_login(pub_pri).status).to eq Metasploit::Model::Login::Status::SUCCESSFUL
+        end
+
+        it 'returns SUCCESSFUL when send_user returns 2xx and send_pass returns 2xx' do
+          allow(ftp_scanner).to receive(:send_user).and_return("230 Login successful\r\n")
+          allow(ftp_scanner).to receive(:send_pass).and_return("230 Already logged in\r\n")
+          expect(ftp_scanner.attempt_login(pub_pri).status).to eq Metasploit::Model::Login::Status::SUCCESSFUL
+        end
+
+        it 'sets proof to the stripped server response' do
+          allow(ftp_scanner).to receive(:send_user).and_return("331 Password required\r\n")
+          allow(ftp_scanner).to receive(:send_pass).and_return("230 Login successful\r\n")
+          expect(ftp_scanner.attempt_login(pub_pri).proof).to eq "230 Login successful"
+        end
+
+      end
+
+      context 'result metadata' do
+        before(:example) do
+          allow(ftp_scanner).to receive(:send_user).and_return("331 Password required\r\n")
+          allow(ftp_scanner).to receive(:send_pass).and_return("230 Login successful\r\n")
+        end
+
+        it 'sets result.host to the scanner host' do
+          expect(ftp_scanner.attempt_login(pub_pri).host).to eq '127.0.0.1'
+        end
+
+        it 'sets result.port to the scanner port' do
+          expect(ftp_scanner.attempt_login(pub_pri).port).to eq 21
+        end
+
+        it 'sets result.protocol to tcp' do
+          expect(ftp_scanner.attempt_login(pub_pri).protocol).to eq 'tcp'
+        end
+
+        it 'sets result.service_name to ftp' do
+          expect(ftp_scanner.attempt_login(pub_pri).service_name).to eq 'ftp'
+        end
+
+      end
     end
   end
 

spec/modules/auxiliary/scanner/ftp/ftp_login_spec.rb

@@ -0,0 +1,136 @@
+require 'rspec'
+
+RSpec.describe 'FTP Login Scanner' do
+  include_context 'Msf::Simple::Framework#modules loading'
+
+  subject do
+    load_and_create_module(
+      module_type: 'auxiliary',
+      reference_name: 'scanner/ftp/ftp_login'
+    )
+  end
+
+  let(:ip) { '127.0.0.1' }
+
+  describe '#check_host' do
+    before(:each) do
+      allow(subject).to receive(:connect)
+      allow(subject).to receive(:disconnect)
+      allow(subject).to receive(:report_ftp_service_and_banner)
+      allow(subject).to receive(:rport).and_return(21)
+    end
+
+    context 'when an FTP banner is present' do
+      before(:each) do
+        allow(subject).to receive(:banner).and_return('220 vsftpd 3.0.3')
+        allow(subject).to receive(:banner_version).and_return('vsftpd 3.0.3')
+      end
+
+      it 'returns CheckCode::Appears' do
+        expect(subject.check_host(ip).code).to eq 'appears'
+      end
+
+      it 'includes the banner version in the message' do
+        expect(subject.check_host(ip).reason).to include('vsftpd 3.0.3')
+      end
+
+      it 'reports the FTP service and banner' do
+        expect(subject).to receive(:report_ftp_service_and_banner).with(ip)
+        subject.check_host(ip)
+      end
+    end
+
+    context 'when a 120 banner is present' do
+      before(:each) do
+        allow(subject).to receive(:banner).and_return('120 Service ready in 2 minutes')
+        allow(subject).to receive(:banner_version).and_return('Service ready in 2 minutes')
+      end
+
+      it 'returns CheckCode::Appears' do
+        expect(subject.check_host(ip).code).to eq 'appears'
+      end
+    end
+
+    context 'when the banner is nil' do
+      before(:each) do
+        allow(subject).to receive(:banner).and_return(nil)
+      end
+
+      it 'returns CheckCode::Unknown' do
+        expect(subject.check_host(ip).code).to eq 'unknown'
+      end
+
+      it 'reports no valid banner' do
+        expect(subject.check_host(ip).reason).to include('No valid FTP banner received')
+      end
+    end
+
+    context 'when the banner does not match a valid FTP code' do
+      before(:each) do
+        allow(subject).to receive(:banner).and_return('500 Not FTP')
+      end
+
+      it 'returns CheckCode::Unknown' do
+        expect(subject.check_host(ip).code).to eq 'unknown'
+      end
+
+      it 'reports no valid banner' do
+        expect(subject.check_host(ip).reason).to include('No valid FTP banner received')
+      end
+    end
+
+    context 'when the connection fails' do
+      it 'returns CheckCode::Unknown for Rex::ConnectionError' do
+        allow(subject).to receive(:connect).and_raise(Rex::ConnectionError)
+        expect(subject.check_host(ip).code).to eq 'unknown'
+      end
+
+      it 'returns CheckCode::Unknown for Errno::ECONNRESET' do
+        allow(subject).to receive(:connect).and_raise(Errno::ECONNRESET)
+        expect(subject.check_host(ip).code).to eq 'unknown'
+      end
+
+      it 'reports port closed for Rex::ConnectionError' do
+        allow(subject).to receive(:connect).and_raise(Rex::ConnectionError)
+        expect(subject.check_host(ip).reason).to include('Port closed or connection refused')
+      end
+    end
+
+    context 'when the connection times out' do
+      it 'returns CheckCode::Unknown for Rex::ConnectionTimeout' do
+        allow(subject).to receive(:connect).and_raise(Rex::ConnectionTimeout, 'timed out')
+        expect(subject.check_host(ip).code).to eq 'unknown'
+      end
+
+      it 'returns CheckCode::Unknown for Timeout::Error' do
+        allow(subject).to receive(:connect).and_raise(::Timeout::Error, 'timed out')
+        expect(subject.check_host(ip).code).to eq 'unknown'
+      end
+
+      it 'returns CheckCode::Unknown for EOFError' do
+        allow(subject).to receive(:connect).and_raise(::EOFError, 'end of file')
+        expect(subject.check_host(ip).code).to eq 'unknown'
+      end
+
+      it 'includes the exception message' do
+        allow(subject).to receive(:connect).and_raise(::Timeout::Error, 'timed out')
+        expect(subject.check_host(ip).reason).to include('timed out')
+      end
+    end
+
+    context 'disconnect behaviour' do
+      it 'always calls disconnect on success' do
+        allow(subject).to receive(:banner).and_return('220 FTP ready')
+        allow(subject).to receive(:banner_version).and_return('FTP ready')
+        expect(subject).to receive(:disconnect)
+        subject.check_host(ip)
+      end
+
+      it 'always calls disconnect on connection failure' do
+        allow(subject).to receive(:connect).and_raise(Rex::ConnectionError)
+        expect(subject).to receive(:disconnect)
+        subject.check_host(ip)
+      end
+    end
+  end
+end