ronin-rb/ronin-brute

# frozen_string_literal: true
#
# ronin-brute - A micro-framework and tool for bruteforcing credentials.
#
# Copyright (c) 2023-2024 Hal Brodigan (postmodern.mod3@gmail.com)
#
# ronin-brute is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published
# by the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# ronin-brute is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with ronin-brute.  If not, see <https://www.gnu.org/licenses/>.
#

require 'ronin/brute/tcp_bruteforcer'
require 'ronin/brute/mixins/login_timeout'

module Ronin
  module Brute
    #
    # A FTP login bruteforcer.
    #
    class FTP < TCPBruteforcer

      include Mixins::LoginTimeout

      register 'ftp'

      port 21
      login_timeout 2

      #
      # Bruteforces a FTP server.
      #
      # @param [Async::LimitedQueue] credentials
      #   The credentials to test.
      #
      # @yield [username, password]
      #   The given block will be passed each valid username and password
      #   combination from the credentials list.
      #
      # @yieldparam [String] username
      #   A valid username.
      #
      # @yieldparam [String] password
      #   A valid password.
      #
      def bruteforce(credentials)
        while (username, password = credentials.dequeue)
          tcp_connect do |socket|
            # ignore the banner
            socket.gets

            socket.puts "USER #{username}"

            if socket.gets.chomp == "331 Please specify the password."
              socket.puts "PASS #{password}"

              response = login_timeout { socket.gets }

              if response && response.chomp == "230 Login successful."
                yield username, password
              end
            end
          end
        end
      end

    end
  end
end