ftpproxy 1.2.0

data/COPYING

@@ -0,0 +1,20 @@
+Copyright (c) 2007-2010 Charles Lowe
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+

data/ChangeLog

@@ -0,0 +1,16 @@
+== 1.2.0 / 2011-11-06
+
+- Add packaging trappings for gem release.
+
+== 1.1.0 / 2010-08-30
+
+- Use correct address in log output.
+
+== 1.0.1 / 2010-06-15
+
+- Minor code cleanups.
+
+== 1.0.0 / 2010-04-23
+
+- Initial release
+

data/README

@@ -0,0 +1,9 @@
+= Introduction
+
+This project is a small, simple, transparent FTP proxy daemon providing support
+for optional active/passive translation.
+
+Support usage behind firewalls by chaining to a parent proxy. Useful when using
+certain software that doesn't support passive mode (eg standard windows ftp
+client).
+

data/bin/ftpproxy

@@ -0,0 +1,44 @@
+#! /usr/bin/ruby
+
+require 'ftpproxy'
+require 'optparse'
+
+opts = {:mode => :client, :port => 21, :proxy => nil, :log => STDERR, :level => Logger::INFO}
+op = OptionParser.new do |op|
+	op.banner = "Usage: #{File.basename $0} [options]"
+	op.separator ''
+	op.on('-p', '--port=PORT', 'Port to listen on (default 21)') { |port| opts[:port] = Integer(port) }
+	op.on('-P', '--[no-]proxy=PROXY', 'Connect through ftp proxy (default direct)') { |proxy| opts[:proxy] = proxy }
+	op.on('-m', '--mode=active|passive', 'Mode for data connections (default client)') do |mode|
+		raise ArgumentError, 'invalid mode - %s' % mode unless %w[active passive client].include?(mode.downcase)
+		opts[:mode] = mode.downcase.to_sym
+	end
+	begin
+		Process.uid = Process.uid
+	rescue NotImplementedError
+		# windows...
+	else
+		op.on('-u', '--uid=UID', 'Switch uid after binding to port') { |uid| opts[:uid] = Integer(uid) }
+		op.on('-g', '--gid=GID', 'Switch gid after binding to port') { |gid| opts[:gid] = Integer(gid) }
+	end
+	op.separator ''
+	op.on('-l', '--log=FILE', 'Log to FILE (default is STDERR)') { |file| opts[:log] = file }
+	op.on('-v', '--[no-]verbose', 'Run verbosely') { |v| opts[:level] = v ? Logger::DEBUG : Logger::INFO }
+	op.on_tail('-h', '--help', 'Show this message') { puts op; exit }
+end
+
+unless op.parse(ARGV).empty?
+	puts 'Invalid trailing arguments.'
+	puts op
+	exit 1
+end
+
+log = Logger.new opts[:log]
+log.progname = File.basename $0
+log.level = opts.delete :level
+opts[:log] = log
+
+FtpProxy.new(opts).start
+#FtpProxy.new(:mode => :active, :proxy => 'proxy.example.com').start
+#FtpProxy.new(:mode => :passive).start
+

data/lib/ftpproxy.rb

@@ -0,0 +1,240 @@
+require 'socket'
+require 'logger'
+
+class FtpProxy
+	VERSION    = '1.2.0'
+	WHITELIST  = %w[cwd cdup dele list mdtm mkd nlst pass pwd quit retr rmd rnfr rnto size stor syst type user xpwd]
+
+	# relay is used to proxy for the data channel
+	class Relay
+		def initialize left, right
+			@left, @right = left, right
+		end
+
+		def relay
+			# find out which way to relay
+			(src, ), dst, ignore = IO.select [@left, @right], nil, nil, 60000
+			raise 'timeout waiting for data' if !src
+			dst,  = [@left, @right] - [src]
+			while data = src.read(8192)
+				dst.write data
+			end
+			close
+		end
+
+		def close
+			@left.close if @left and !@left.closed?
+			@right.close if @right and !@right.closed?
+		end
+	end
+
+	class ActiveRelay < Relay
+		def initialize srv, right
+			@srv = srv
+			super nil, right
+		end
+
+		def relay
+			raise 'timeout waiting for connection' unless IO.select [@srv], nil, nil, 60000
+			@left = @srv.accept
+			@srv.close
+			super
+		end
+
+		def close
+			@srv.close if !@srv.closed?
+			super
+		end
+	end
+
+	class Session
+		def initialize socket, params={}
+			@client = socket
+			@server = nil
+			@relay  = nil
+			@log    = params[:log]
+			@mode   = params[:mode]
+			if @proxy = params[:proxy]
+				raise ArgumentError, 'malformed proxy' unless @proxy =~ /^(.*)(?::(\d+))?$/
+				@proxy = [$1, $2]
+			end
+		rescue
+			@log.error $!
+			raise
+		end
+
+		# handle multiline responses
+		def read_server
+			data = @server.readline
+			if data[3] == ?-
+				code = data[0, 3]
+				begin
+					line = @server.readline
+					data << line
+				end until line[0, 3] == code and line[3] != ?-
+			end
+			@log.debug "@SERVER>> #{data.inspect}"
+			data.gsub(/\r\n|\r/, "\n")
+		end
+
+		def read_client
+			line = @client.gets
+			@log.debug "@CLIENT>> #{line.inspect}"
+			line
+		end
+
+		def write_server str
+			@log.debug "@SERVER<< #{str.inspect}"
+			@server.write str + "\r\n"
+		end
+
+		def write_client str
+			@log.debug "@CLIENT<< #{str.inspect}"
+			@client.write str + "\r\n"
+		end
+
+		def start
+			write_client "220 #{Socket.gethostname} (#{File.basename $0}) #{Time.now.strftime '%a, %d %b %Y %H:%M:%S'}"
+			while line = read_client
+				line.chomp!
+				cmd, params = line.split ' ', 2
+				cmd = cmd.downcase
+				params = nil if params == ''
+				msg = "cmd_#{cmd}"
+				if @server and WHITELIST.include?(cmd)
+					proxy line
+				elsif cmd == 'user' or @server && respond_to?(msg)
+					send msg, params
+				elsif WHITELIST.include?(cmd) or respond_to?(msg)
+					write_client '530 Not logged in.'
+				else
+					write_client '500 Syntax error, command unrecognized.'
+				end
+			end
+		rescue Errno::EINVAL
+			# common, when client just aborts
+		rescue
+			@log.warn $!
+		ensure
+			@client.close if !@client.closed?
+			@server.close if @server and !@server.closed?
+			@relay.close if @relay
+		end
+
+		def proxy line
+			write_server line
+			if %w[125 150].include? relay_cmd[0, 3]
+				begin
+					# relay data channel
+					@relay.relay
+				rescue
+					@log.error $!
+					write_client '425 Data connection failed'
+				else
+					relay_cmd
+				end
+			end
+		end
+
+		# relay command channel
+		def relay_cmd
+			resp = read_server
+			resp.each { |line| write_client line.chomp }
+			resp
+		end
+
+		def cmd_user user
+			raise 'malformed user string' unless user =~ /(.+)@(.+?)(?::(\d+))?$/
+			user, host, port = $1, $2, $3
+			# this is to double-proxy through an upstream proxy
+			if @proxy
+				user, pass = "#{user}@#{host}#{':' + port.to_s if port}", pass
+				host, port = @proxy
+			end
+			@log.debug "Connecting to #{host}:#{port || 21}"
+			@server = TCPSocket.open host, (port || '21').to_i
+			raise 'invalid server response' unless read_server[0] == ?2
+			write_server "USER #{user}"
+		rescue
+			@log.error $!
+			write_client '530 Not logged in.'
+		else
+			relay_cmd
+		end
+
+		def cmd_port params
+			nums = params.split(',')
+			raise 'invalid parameters' unless nums.length == 6
+			host = nums[0, 4].join('.')
+			port = nums[4].to_i * 256 + nums[5].to_i
+			@log.debug "Opening active connection to client on #{host}:#{port}"
+			socket = TCPSocket.open(host, port)
+			write_client "200 Connection established (#{port})"
+			make_relay socket, :active
+		rescue
+			@log.error $!
+			write_client '425 Data connection failed'
+		end
+
+		def cmd_pasv params
+			socket = TCPServer.open @server.addr[3], 0
+			host = socket.addr[3]
+			port = socket.addr[1]
+			@log.debug "Waiting for passive connection from client on #{host}:#{port}"
+			write_client "227 Entering Passive Mode (#{(host.split('.') + port.divmod(256)).join ','})"
+			make_relay socket.accept, :passive
+		rescue
+			@log.error $!
+			write_client '425 Data connection failed'
+		end
+
+		def make_relay clientdata, mode
+			@relay.close if @relay
+			case mode = @mode || mode
+			when :active
+				socket = TCPServer.open @server.addr[3], 0
+				host = socket.addr[3]
+				port = socket.addr[1]
+				@log.debug "Waiting for active connection from server on #{host}:#{port}"
+				write_server "PORT #{(host.split('.') + port.divmod(256)).join ','}"
+				raise 'invalid server response' unless read_server[0] == ?2
+				@relay = ActiveRelay.new socket, clientdata
+			when :passive
+				write_server 'PASV'
+				raise 'invalid server response' unless nums = read_server[/^227[^(]*\(([^)]*)\)/, 1]
+				nums = nums.split(',')
+				raise 'invalid server response' unless nums.length == 6
+				host = nums[0, 4].join('.')
+				port = nums[4].to_i * 256 + nums[5].to_i
+				@log.debug "Opening passive connection to server on #{host}:#{port}"
+				@relay = Relay.new TCPSocket.new(host, port), clientdata
+			else
+				raise 'unhandled server data channel mode - %p' % mode
+			end
+		end
+	end
+
+	def initialize params={}
+		params = {:mode => :client, :port => 21, :proxy => nil}.merge(params)
+		params[:mode] = nil if params[:mode] == :client
+		@params = params
+		unless @log = params[:log]
+			@log = @params[:log] = Logger.new(STDERR)
+		end
+		@log.info "Starting ftpproxy v#{VERSION} on #{Socket.gethostname}:#{params[:port]}"
+		@server = TCPServer.new '', params[:port]
+		Process.egid = params[:gid] if params[:gid]
+		Process.euid = params[:uid] if params[:uid]
+	end
+	
+	def start
+		threads = []
+		@log.debug 'Waiting for connections'
+		while socket = @server.accept
+			@log.debug "Accepted connection from #{socket.peeraddr.join(', ')}"
+			threads << Thread.new { Session.new(socket, @params).start }
+		end
+		threads.each { |t| t.join }
+	end
+end
+

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: ftpproxy
+version: !ruby/object:Gem::Version 
+  hash: 31
+  prerelease: false
+  segments: 
+  - 1
+  - 2
+  - 0
+  version: 1.2.0
+platform: ruby
+authors: 
+- Charles Lowe
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-06 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Thin and simple FTP proxy providing support for active/passive translation.
+email: aquasync@gmail.com
+executables: 
+- ftpproxy
+extensions: []
+
+extra_rdoc_files: 
+- README
+- ChangeLog
+files: 
+- README
+- COPYING
+- ChangeLog
+- bin/ftpproxy
+- lib/ftpproxy.rb
+has_rdoc: true
+homepage: http://github.com/aquasync/ftpproxy
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+- --title
+- ftpproxy documentation
+- --tab-width
+- "2"
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: FTP proxy daemon.
+test_files: []
+