ftpd 0.2.1 → 0.2.2

data/Changelog.md

@@ -1,3 +1,22 @@
+### 0.2.2
+
+Bug fixes
+
+* Respond with sequence error if RNFR is not immediately followed by
+  RNTO
+* Respond with sequence error if USER is not immediately followed by
+  PASS
+* Open PASV mode data connection on same local IP as control connection.
+  This is required by RFC 1123.
+* Disabled globbing in LIST (for now) due to code injection
+  vulnerability.  This patch also disables globbing in NLST, but NLST
+  probably shouldn't do globbing.
+
+Enhancements
+
+* Support STOU (store unique)
+* Support HELP
+
 ### 0.2.1
 
 API changes

data/Gemfile.lock

@@ -7,13 +7,13 @@ GIT
 GEM
   remote: http://rubygems.org/
   specs:
-    builder (3.1.4)
+    builder (3.2.0)
     cucumber (1.2.1)
       builder (>= 2.1.2)
       diff-lcs (>= 1.1.3)
       gherkin (~> 2.11.0)
       json (>= 1.4.6)
-    diff-lcs (1.1.3)
+    diff-lcs (1.2.1)
     gherkin (2.11.6)
       json (>= 1.7.6)
     git (1.2.5)
@@ -25,18 +25,18 @@ GEM
     json (1.7.7)
     memoizer (1.0.1)
     rake (10.0.3)
-    rdoc (3.12.1)
+    rdoc (4.0.0)
       json (~> 1.4)
     redcarpet (2.2.2)
-    rspec (2.12.0)
-      rspec-core (~> 2.12.0)
-      rspec-expectations (~> 2.12.0)
-      rspec-mocks (~> 2.12.0)
-    rspec-core (2.12.2)
-    rspec-expectations (2.12.1)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.12.2)
-    yard (0.8.4.1)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.0)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.0)
+    yard (0.8.5.2)
 
 PLATFORMS
   ruby

data/README.md

@@ -88,31 +88,14 @@ output without having to change any code.
 
 ## LIMITATIONS
 
-The automated tests don't cover TLS in passive mode (although it works
-fine): The FTPS client used by the test locks up in active mode.
+Ftpd is not yet RFC compliant.  It does most of RFC969, and enough TLS
+to get by.  {file:doc/rfc.md Here} is a list of RFCs, indicating how
+much of each Ftpd complies with.
 
 The DiskFileSystem class only works in Linux.  This is because it
 shells out to the "ls" command.  This affects the example, which uses
 the DiskFileSystem.
 
-The control connection is supposed to be a Telnet session.  It's not.
-In practice, it doesn't seem to matter whether it's a Telnet session
-or just plain sending and receiving characters.
-
-The following commands defined by RFC969 are understood, but not
-implemented.  They result in a "502 Command not implemented" response.
-
-* ABOR - Abort
-* ACCT - Account
-* APPE - Append (with create)
-* HELP - Help
-* REIN - Reinitialize
-* REST - Restart
-* SITE - Site parameters
-* SMNT - Structure mount
-* STAT - Status
-* STOU - Store Unique
-
 To bind the server to an external interface, the interface must be set
 to the public IP of that interface (e.g. "1.2.3.4"), not to "0.0.0.0".
 That's because the interface IP is used both for binding server ports,
@@ -120,7 +103,11 @@ _and_ for advertising to the client which IP to connect to.  Binding
 to 0.0.0.0 will work fine, but when the client tries to connect to
 0.0.0.0, it won't get to the server.
 
-## VERSIONS
+LIST doesn't accept globs.  It has other problems (it accepts
+arbitrary ls arguments!) and needs to be rewritten to not shell out to
+"ls".
+
+## RUBY COMPATABILITY
 
 The tests pass with these Rubies:
 
@@ -156,33 +143,6 @@ The example prints its port, username and password to the console.
 You can connect to the stand-alone example with any FTP client.  This
 is useful when testing how the server responds to a given FTP client.
 
-## REFERENCES
-
-(This list of references comes from the README of the em-ftpd gem,
-which is licensed under the same MIT license as this gem, and is
-Copyright (c) 2008 James Healy)
-
-There are a range of RFCs that together specify the FTP protocol. In
-chronological order, the more useful ones are:
-
-* <http://tools.ietf.org/rfc/rfc959.txt>
-* <http://tools.ietf.org/rfc/rfc1123.txt>
-* <http://tools.ietf.org/rfc/rfc2228.txt>
-* <http://tools.ietf.org/rfc/rfc2389.txt>
-* <http://tools.ietf.org/rfc/rfc2428.txt>
-* <http://tools.ietf.org/rfc/rfc3659.txt>
-* <http://tools.ietf.org/rfc/rfc4217.txt>
-
-For an english summary that's somewhat more legible than the RFCs, and
-provides some commentary on what features are actually useful or
-relevant 24 years after RFC959 was published:
-
-* <http://cr.yp.to/ftp.html>
-
-For a history lesson, check out Appendix III of RCF959. It lists the
-preceding (obsolete) RFC documents that relate to file transfers,
-including the ye old RFC114 from 1971, "A File Transfer Protocol"
-
 ## ORIGIN
 
 I created ftpd to support the test framework I wrote for Databill,
@@ -197,3 +157,9 @@ Wayne Conrad <wconrad@yagni.com>
 
 Thanks to Databill, LLC, which supported the creation of this library,
 and granted permission to donate it to the community.
+
+## See also
+
+* {file:Changelog.md}
+* {file:doc/rfc-compliance.md RFC compliance}
+* {file:doc/references.md}

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.2.2

data/doc/references.md

@@ -0,0 +1,32 @@
+# REFERENCES
+
+_This list of references comes from the README of the em-ftpd gem,
+which is licensed under the same MIT license as this gem, and is
+Copyright (c) 2008 James Healy_
+
+There are a range of RFCs that together specify the FTP protocol. In
+chronological order, the more useful ones are:
+
+* {http://tools.ietf.org/rfc/rfc959.txt RFC-959} - File Transfer Protocol
+* {http://tools.ietf.org/rfc/rfc1123.txt RFC-1123} - Requirements for Internet Hosts
+* {http://tools.ietf.org/rfc/rfc2228.txt RFC-2228} - FTP Security Extensions
+* {http://tools.ietf.org/rfc/rfc2389.txt RFC-2389} - Feature negotiation mechanism for the File Transfer Protocol
+* {http://tools.ietf.org/rfc/rfc2428.txt RFC-2428} - FTP Extensions for IPv6 and NATs
+* {http://tools.ietf.org/rfc/rfc2577.txt RFC-2577} - FTP Security Considerations
+* {http://tools.ietf.org/rfc/rfc2640.txt RFC-2640} - Internationalization of the File Transfer Protocol
+* {http://tools.ietf.org/rfc/rfc3659.txt RFC-3659} - Extensions to FTP
+* {http://tools.ietf.org/rfc/rfc4217.txt RFC-4217} - Internationalization of the File Transfer Protocol
+
+For an english summary that's somewhat more legible than the RFCs, and
+provides some commentary on what features are actually useful or
+relevant 24 years after RFC959 was published:
+
+* <http://cr.yp.to/ftp.html>
+
+For a history lesson, check out Appendix III of RCF959. It lists the
+preceding (obsolete) RFC documents that relate to file transfers,
+including the ye old RFC114 from 1971, "A File Transfer Protocol"
+
+There is a {http://secureftp-test.com public test server} which is
+very handy for checking out clients, and seeing how at least one
+server behaves.

data/doc/{rfc.md → rfc-compliance.md}

@@ -29,9 +29,9 @@ Commands supported:
     CDUP    Yes    0.1.0    Change to parent directory    
     CWD     Yes    0.1.0    Change working directory    
     DELE    Yes    0.1.0    Delete file    
-    HELP    No      ---     Help
+    HELP    Yes    0.2.2    Help
     LIST    Yes    0.1.0    List directory    
-    MKD     Yes     dev     Make directory    
+    MKD     Yes    0.2.1    Make directory    
     MODE    Yes    0.1.0    Set transfer mode
                             "Stream" mode supported; "Block" and
                             "Compressed" are not
@@ -45,14 +45,14 @@ Commands supported:
     REIN    No      ---     Reinitialize session    
     REST    No      ---     Restart transfer    
     RETR    Yes    0.1.0    Retrieve file    
-    RMD     Yes     dev     Remove directory    
-    RNFR    Yes     dev     Rename file (from)    
-    RNTO    Yes     dev     Rename file (to)    
+    RMD     Yes    0.2.1    Remove directory    
+    RNFR    Yes    0.2.1    Rename file (from)    
+    RNTO    Yes    0.2.1    Rename file (to)    
     SITE    No      ---     Site specific commands
     SMNT    No      ---     Structure Mount    
     STAT    No      ---     Server status    
     STOR    Yes    0.1.0    Store file    
-    STOU    No      ---     Store with unique name    
+    STOU    Yes    0.2.2    Store with unique name    
     STRU    Yes    0.1.0    Set file structure
                             Supports "File" structure only. "Record" and
                             "Page" are not supported
@@ -90,16 +90,16 @@ FEATURE                                    |SECTION        | | | |T|T|e
 Implement TYPE T if same as TYPE N         |4.1.2.2        | |x| | | |  
 File/Record transform invertible if poss.  |4.1.2.4        | |x| | | |  
 Server-FTP implement PASV                  |4.1.2.6        |x| | | | |  C
-  PASV is per-transfer                     |4.1.2.6        |x| | | | |  
+  PASV is per-transfer                     |4.1.2.6        |x| | | | |  C
 NLST reply usable in RETR cmds             |4.1.2.7        |x| | | | |  C
 Implied type for LIST and NLST             |4.1.2.7        | |x| | | |  C
 SITE cmd for non-standard features         |4.1.2.8        | |x| | | |  
-STOU cmd return pathname as specified      |4.1.2.9        |x| | | | |  
+STOU cmd return pathname as specified      |4.1.2.9        |x| | | | |  C
 Use TCP READ boundaries on control conn.   |4.1.2.10       | | | | |x|  C
 Server-FTP send only correct reply format  |4.1.2.11       |x| | | | |  C
 Server-FTP use defined reply code if poss. |4.1.2.11       | |x| | | |  C
   New reply code following Section 4.2     |4.1.2.11       | | |x| | |
-Default data port same IP addr as ctl conn |4.1.2.12       |x| | | | |
+Default data port same IP addr as ctl conn |4.1.2.12       |x| | | | |  C
 Server-FTP handle Telnet options           |4.1.2.12       |x| | | | |
 Handle "Experimental" directory cmds       |4.1.3.1        | |x| | | |  C
 Idle timeout in server-FTP                 |4.1.3.2        | |x| | | |
@@ -143,7 +143,7 @@ Support commands:                          |               | | | | | |
                                            |               | | | | | |
   RETR                                     |4.1.2.13       |x| | | | |  C
   STOR                                     |4.1.2.13       |x| | | | |  C
-  STOU                                     |959 5.3.1      | | |x| | |
+  STOU                                     |959 5.3.1      | | |x| | |  C
   APPE                                     |4.1.2.13       |x| | | | |
   ALLO                                     |959 5.3.1      | | |x| | |  C
   REST                                     |959 5.3.1      | | |x| | |
@@ -158,8 +158,8 @@ Support commands:                          |               | | | | | |
   NLST                                     |4.1.2.13       |x| | | | |  C
   SITE                                     |4.1.2.8        | | |x| | |
   STAT                                     |4.1.2.13       |x| | | | |
-  SYST                                     |4.1.2.13       |x| | | | |
-  HELP                                     |4.1.2.13       |x| | | | |
+  SYST                                     |4.1.2.13       |x| | | | |  C
+  HELP                                     |4.1.2.13       |x| | | | |  C
   NOOP                                     |4.1.2.13       |x| | | | |  C
 
 Footnotes:
@@ -202,6 +202,21 @@ FEAT    No      ---     List new supported commands
 OPTS    No      ---     Set options for certain commands
 </pre>
 
+## RFC-2428 - FTP Extensions for IPv6 and NATs
+
+Introduces the new commands EPRT and EPSV extending FTP to enable its
+use over various network protocols, and the new response codes 522 and
+229.
+
+* Issued: September 1998
+* Status: PROPOSED STANDARD
+* [link](http://tools.ietf.org/rfc/rfc2428.txt)
+
+<pre>
+EPRT    No      ---     Set active data connection over IPv4 or IPv6    
+EPSV    No      ---     Set passive data connection over IPv4 or IPv6 
+</pre>
+
 ##RFC-2577 - FTP Security Considerations
 
 Provides several configuration and implementation suggestions to
@@ -215,11 +230,11 @@ attempts and third-party "proxy FTP" transfers, which can be used in
 
 <pre>
 FTP bounce protection
-Restruct PASV/PORT to non-priv. ports     No      ---
+Restrict PASV/PORT to non-priv. ports     No      ---
 Disconnect after so many wrong auths.     No      ---
 Delay on invalid password                 No      ---
 Per-source IP limit                       No      ---
-Do not reject wrong usernames             Yes     ---
+Do not reject wrong usernames             Yes    0.1.0
 Port stealing protection                  No      ---
 </pre>
 
@@ -269,9 +284,9 @@ Provides a description on how to implement TLS as a security mechanism to secure
 * [link](http://tools.ietf.org/rfc/rfc4217.txt)
 
 <pre>
-AUTH    Yes     ---     Authentication/Security Mechanism
+AUTH    Yes    0.1.0    Authentication/Security Mechanism
 CCC     No      ---     Clear Command Channel
-PBSZ    Yes     ---     Protection Buffer Size
-PROT    Yes     ---     Data Channel Protection Level.
+PBSZ    Yes    0.1.0    Protection Buffer Size
+PROT    Yes    0.1.0    Data Channel Protection Level.
                         Support only "Private" level
 </pre>

data/features/ftp_server/command_errors.feature

@@ -21,10 +21,8 @@ Feature: Command Errors
       | ABOR    |
       | ACCT    |
       | APPE    |
-      | HELP    |
       | REIN    |
       | REST    |
       | SITE    |
       | SMNT    |
       | STAT    |
-      | STOU    |

data/features/ftp_server/help.feature

@@ -0,0 +1,21 @@
+Feature: Help
+
+  As a client
+  I want to ask for help
+  So that I can know which commands are supported
+
+  Background:
+    Given the test server is started
+    And a successful connection
+
+  Scenario: No argument
+    When the client successfully asks for help
+    Then the server should return a list of commands
+
+  Scenario: Known command
+    When the client successfully asks for help for "NOOP"
+    Then the server should return help for "NOOP"
+
+  Scenario: Unknown command
+    When the client successfully asks for help for "FOO"
+    Then the server should return no help for "FOO"

data/features/ftp_server/list.feature

@@ -42,6 +42,7 @@ Feature: List
     And the file list should contain "foo"
 
   Scenario: Glob
+    Given PENDING "Disabled (for now) due to code injection vulnerability"
     Given a successful login
     And the server has file "foo"
     And the server has file "bar"

data/features/ftp_server/login.feature

@@ -47,10 +47,17 @@ Feature: Login
 
   Scenario: PASS without parameter
     Given a successful connection
-    And the client sends a password with no parameter
+    And the client sends a user
+    When the client sends a password with no parameter
     Then the server returns a syntax error
 
-  Scenario: USRE without parameter
+  Scenario: USER without parameter
     Given a successful connection
     And the client sends a user with no parameter
     Then the server returns a syntax error
+
+  Scenario: USER not followed by PASS
+    Given a successful connection
+    And the client sends a user
+    When the client sends "NOOP"
+    Then the server returns a bad sequence error

data/features/ftp_server/name_list.feature

@@ -41,15 +41,6 @@ Feature: Name List
     Then the file list should be in short form
     And the file list should contain "foo"
 
-  Scenario: Glob
-    Given a successful login
-    And the server has file "foo"
-    And the server has file "bar"
-    When the client successfully name-lists the directory "f*"
-    Then the file list should be in short form
-    And the file list should contain "foo"
-    And the file list should not contain "bar"
-
   Scenario: Passive
     Given a successful login
     And the server has file "foo"

data/features/ftp_server/put.feature

@@ -1,9 +1,8 @@
 Feature: Put
 
   As a client
-  I want to securely put a file
+  I want to upload a file
   So that someone else can have it
-  But nobody else can
 
   Background:
     Given the test server is started

data/features/ftp_server/put_tls.feature

@@ -1,8 +1,8 @@
 Feature: Put TLS
 
   As a client
-  I want to put a file
-  So that someone else can have it
+  I want to put a file securely
+  So that nobody can intercept it
 
   Background:
     Given the test server is started with explicit TLS

data/features/ftp_server/put_unique.feature

@@ -0,0 +1,56 @@
+Feature: Put Unique
+
+  As a client
+  I want to upload a file with a unique name
+  So that it will not overwrite an existing file
+
+  Background:
+    Given the test server is started
+
+  Scenario: File does not exist
+    Given a successful login
+    And the client has file "foo"
+    When the client successfully stores unique "foo"
+    Then the server should have a file with the contents of "foo"
+
+  Scenario: Suggest name
+    Given a successful login
+    And the client has file "foo"
+    When the client successfully stores unique "foo" to "bar"
+    Then the server should have a file with the contents of "foo"
+    And the server should have 1 file with "bar" in the name
+
+  Scenario: Suggested name exists
+    Given a successful login
+    And the client has file "foo"
+    And the server has file "bar"
+    When the client successfully stores unique "foo" to "bar"
+    Then the server should have a file with the contents of "foo"
+    Then the server should have a file with the contents of "bar"
+    And the server should have 2 files with "bar" in the name
+
+  Scenario: Non-root working directory
+    Given a successful login
+    And the client has file "bar"
+    And the server has directory "foo"
+    And the client successfully cd's to "foo"
+    When the client successfully stores unique "bar" to "bar"
+    Then the remote file "foo/bar" should match the local file
+
+  Scenario: Missing directory
+    Given a successful login
+    And the client has file "bar"
+    When the client stores unique "bar" to "foo/bar"
+    Then the server returns a not found error
+
+  Scenario: Not logged in
+    Given a successful connection
+    When the client sends "STOU"
+    Then the server returns a not logged in error
+
+  Scenario: Write not enabled
+    Given the test server is started without write
+    And a successful login
+    And the client has file "foo"
+    When the client stores unique "foo"
+    Then the server returns an unimplemented command error

data/features/ftp_server/rename.feature

@@ -88,3 +88,10 @@ Feature: Rename
     Given a successful login
     When the client sends "RNTO bar"
     Then the server returns a bad sequence error
+
+  Scenario: RNFR not followed by RNTO
+    Given a successful login
+    And the server has file "foo"
+    And the client sends "RNFR foo"
+    When the client sends "NOOP"
+    Then the server returns a bad sequence error

data/features/step_definitions/help.rb

@@ -0,0 +1,18 @@
+When /^the client successfully asks for help(?: for "(.*?)")?$/ do
+|command|
+  @help_reply = @client.help(command)
+end
+
+Then /^the server should return a list of commands$/ do
+  commands = @help_reply.scan(/\b([A-Z][A-Z]+)\b/).flatten
+  commands.should include 'NOOP'
+  commands.should include 'USER'
+end
+
+Then /^the server should return help for "(.*?)"$/ do |command|
+  @help_reply.should =~ /Command #{command} is recognized/
+end
+
+Then /^the server should return no help for "(.*?)"$/ do |command|
+  @help_reply.should =~ /Command #{command} is not recognized/
+end

data/features/step_definitions/pending.rb

@@ -0,0 +1,3 @@
+Given /^PENDING/ do
+  pending
+end

data/features/step_definitions/put.rb

@@ -14,3 +14,16 @@ When /^the client puts with no path$/ do
     @client.raw 'STOR'
   end
 end
+
+When /^the client successfully stores unique "(.*?)"(?: to "(.*?)")?$/ do
+|local_path, remote_path|
+  @client.store_unique local_path, remote_path
+end
+
+When /^the client stores unique "(.*?)"( to ".*?")?$/ do
+|local_path, remote_path|
+  capture_error do
+    step(%Q'the client successfully stores unique ' +
+         %Q'"#{local_path}"#{remote_path}')
+  end
+end

data/features/step_definitions/server_files.rb

@@ -29,3 +29,13 @@ Then /^the remote file "(.*?)" should have (unix|windows) line endings$/ do
   line_ending_type(@server.file_contents(remote_path)).should ==
     line_ending_type.to_sym
 end
+
+Then /^the server should have a file with the contents of "(.*?)"$/ do
+|path|
+  @server.has_file_with_contents_of?(path).should be_true
+end
+
+Then /^the server should have (\d+) files? with "(.*?)" in the name$/ do
+|count, name|
+  @server.files_named_like(name).size.should == count.to_i
+end

data/features/support/test_client.rb

@@ -22,6 +22,7 @@ class TestClient
   :delete,
   :getbinaryfile,
   :gettextfile,
+  :help,
   :login,
   :ls,
   :mkdir,
@@ -52,7 +53,7 @@ class TestClient
     full_path = temp_path(path)
     mkdir_p File.dirname(full_path)
     File.open(full_path, 'wb') do |file|
-      file.puts @templates[File.basename(full_path)]
+      file.write @templates[File.basename(full_path)]
     end
   end
 
@@ -65,6 +66,13 @@ class TestClient
     response[/"(.+)"/, 1]
   end
 
+  def store_unique(local_path, remote_path)
+    command = ['STOU', remote_path].compact.join(' ')
+    File.open(temp_path(local_path), 'rb') do |file|
+      @ftp.storbinary command, file, Net::FTP::DEFAULT_BLOCKSIZE
+    end
+  end
+
   private
 
   RAW_METHOD_REGEX = /^send_(.*)$/

data/features/support/test_server_files.rb

@@ -4,7 +4,7 @@ module TestServerFiles
     full_path = temp_path(path)
     mkdir_p File.dirname(full_path)
     File.open(full_path, 'wb') do |file|
-      file.puts @templates[File.basename(full_path)]
+      file.write @templates[File.basename(full_path)]
     end
   end
 
@@ -18,6 +18,19 @@ module TestServerFiles
     File.exists?(full_path)
   end
 
+  def has_file_with_contents_of?(path)
+    expected_contents = @templates[File.basename(path)]
+    all_paths.any? do |path|
+      File.open(path, 'rb', &:read) == expected_contents
+    end
+  end
+
+  def files_named_like(name)
+    all_paths.select do |path|
+      path.include?(name)
+    end
+  end
+
   def has_directory?(path)
     full_path = temp_path(path)
     File.directory?(full_path)
@@ -32,4 +45,8 @@ module TestServerFiles
     File.expand_path(path, temp_dir)
   end
 
+  def all_paths
+    Dir[temp_path('**/*')]
+  end
+
 end

data/ftpd.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "ftpd"
-  s.version = "0.2.1"
+  s.version = "0.2.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Wayne Conrad"]
-  s.date = "2013-02-28"
+  s.date = "2013-03-02"
   s.description = "ftpd is a pure Ruby FTP server library.  It supports implicit and explicit TLS, passive and active mode, and most of the commands specified in RFC 969.  It an be used as part of a test fixture or embedded in a program."
   s.email = "wconrad@yagni.com"
   s.extra_rdoc_files = [
@@ -24,7 +24,8 @@ Gem::Specification.new do |s|
     "README.md",
     "Rakefile",
     "VERSION",
-    "doc/rfc.md",
+    "doc/references.md",
+    "doc/rfc-compliance.md",
     "examples/example.rb",
     "examples/hello_world.rb",
     "features/example/example.feature",
@@ -39,6 +40,7 @@ Gem::Specification.new do |s|
     "features/ftp_server/file_structure.feature",
     "features/ftp_server/get.feature",
     "features/ftp_server/get_tls.feature",
+    "features/ftp_server/help.feature",
     "features/ftp_server/implicit_tls.feature",
     "features/ftp_server/list.feature",
     "features/ftp_server/list_tls.feature",
@@ -51,6 +53,7 @@ Gem::Specification.new do |s|
     "features/ftp_server/port.feature",
     "features/ftp_server/put.feature",
     "features/ftp_server/put_tls.feature",
+    "features/ftp_server/put_unique.feature",
     "features/ftp_server/quit.feature",
     "features/ftp_server/rename.feature",
     "features/ftp_server/rmdir.feature",
@@ -70,6 +73,7 @@ Gem::Specification.new do |s|
     "features/step_definitions/file_structure.rb",
     "features/step_definitions/generic_send.rb",
     "features/step_definitions/get.rb",
+    "features/step_definitions/help.rb",
     "features/step_definitions/invalid_commands.rb",
     "features/step_definitions/line_endings.rb",
     "features/step_definitions/list.rb",
@@ -78,6 +82,7 @@ Gem::Specification.new do |s|
     "features/step_definitions/mode.rb",
     "features/step_definitions/noop.rb",
     "features/step_definitions/passive.rb",
+    "features/step_definitions/pending.rb",
     "features/step_definitions/port.rb",
     "features/step_definitions/put.rb",
     "features/step_definitions/quit.rb",
@@ -100,6 +105,7 @@ Gem::Specification.new do |s|
     "ftpd.gemspec",
     "insecure-test-cert.pem",
     "lib/ftpd.rb",
+    "lib/ftpd/command_sequence_checker.rb",
     "lib/ftpd/disk_file_system.rb",
     "lib/ftpd/error.rb",
     "lib/ftpd/exception_translator.rb",
@@ -118,6 +124,7 @@ Gem::Specification.new do |s|
     "rake_tasks/spec.rake",
     "rake_tasks/test.rake",
     "rake_tasks/yard.rake",
+    "spec/command_sequence_checker_spec.rb",
     "spec/disk_file_system_spec.rb",
     "spec/exception_translator_spec.rb",
     "spec/file_system_error_translator_spec.rb",
@@ -127,7 +134,7 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/wconrad/ftpd"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.24"
+  s.rubygems_version = "1.8.25"
   s.summary = "Pure Ruby FTP server library"
 
   if s.respond_to? :specification_version then

data/lib/ftpd.rb

@@ -2,10 +2,12 @@ require 'fileutils'
 require 'memoizer'
 require 'openssl'
 require 'pathname'
+require 'shellwords'
 require 'socket'
 require 'tmpdir'
 
 module Ftpd
+  autoload :CommandSequenceChecker,    'ftpd/command_sequence_checker'
   autoload :DiskFileSystem,            'ftpd/disk_file_system'
   autoload :Error,                     'ftpd/error'
   autoload :ExceptionTranslator,       'ftpd/exception_translator'

data/lib/ftpd/command_sequence_checker.rb

@@ -0,0 +1,55 @@
+# Some commands are supposed to occur in sequence.  For example, USER
+# must be immediately followed by PASS.  This class keeps track of
+# when a specific command is expected, and raises a "bad sequence"
+# error when that command is not next.
+
+module Ftpd
+  class CommandSequenceChecker
+
+    include Error
+
+    def initialize
+      @must_expect = []
+    end
+
+    # Set the command to expect next.  If not set, then any command
+    # will be accepted, so long as it hasn't been registered using
+    # {#must_expect}.
+    #
+    # @param command [String] The command.  Must be lowercase.
+
+    def expect(command)
+      @expected_command = command
+    end
+
+    # Register a command that must be expected.  When that command is
+    # received without {#expect} having been called for it, a sequence
+    # error will result.
+
+    def must_expect(command)
+      @must_expect << command
+    end
+
+    # Check a command.  If expecting a specific command and this
+    # command isn't it, then raise an error that will cause a "503 Bad
+    # sequence" error to be sent.  After checking, the expected
+    # command is cleared and any command will be accepted, unless
+    # {#expect} is called again.
+    #
+    # @param command [String] The command.  Must be lowercase.
+    # @raise [CommandError] A "503 Bad sequence" error
+
+    def check(command)
+      if @expected_command
+        begin
+          sequence_error unless command == @expected_command
+        ensure
+          @expected_command = nil
+        end
+      else
+        sequence_error if @must_expect.include?(command)
+      end
+    end
+
+  end
+end

data/lib/ftpd/disk_file_system.rb

@@ -138,6 +138,7 @@ module Ftpd
       #
       # Called for:
       # * STOR
+      # * STOU
       #
       # If missing, then these commands are not supported.
 
@@ -205,6 +206,8 @@ module Ftpd
 
     module Ls
 
+      include Shellwords
+
       def ls(ftp_path, option)
         path = expand_ftp_path(ftp_path)
         dirname = File.dirname(path)
@@ -213,11 +216,10 @@ module Ftpd
           'ls',
           option,
           filename,
-          '2>&1',
-        ].compact.join(' ')
+        ].compact
         if File.exists?(dirname)
           list = Dir.chdir(dirname) do
-            `#{command}`
+            `#{shelljoin(command)} 2>&1`
           end
         else
           list = ''

data/lib/ftpd/error.rb

@@ -17,6 +17,10 @@ module Ftpd
       error "502 Command not implemented"
     end
 
+    def sequence_error
+      error "503 Bad sequence of commands"
+    end
+
     def permanent_error(message)
       error "550 #{message}"
     end

data/lib/ftpd/ftp_server.rb

@@ -54,7 +54,6 @@ module Ftpd
 
     def session(socket)
       Session.new(:socket => socket,
-                  :interface => interface,
                   :driver => @driver,
                   :debug => @debug,
                   :debug_path => debug_path,

data/lib/ftpd/server.rb

@@ -21,7 +21,7 @@ module Ftpd
       @port = 0
     end
 
-    # The port the server is bound to.  Must be called until after
+    # The port the server is bound to.  Must not be called until after
     # #start is called.
 
     def bound_port

data/lib/ftpd/session.rb

@@ -8,7 +8,6 @@ module Ftpd
     def initialize(opts)
       @driver = opts[:driver]
       @socket = opts[:socket]
-      @interface = opts[:interface]
       @tls = opts[:tls]
       if @tls == :implicit
         @socket.encrypt
@@ -22,11 +21,12 @@ module Ftpd
       @structure = 'F'
       @response_delay = opts[:response_delay]
       @data_channel_protection_level = :clear
+      @command_sequence_checker = init_command_sequence_checker
+      @logged_in = false
     end
 
     def run
       reply "220 ftpd"
-      @state = :user
       catch :done do
         loop do
           begin
@@ -37,6 +37,7 @@ module Ftpd
             unless respond_to?(method, true)
               unrecognized_error s
             end
+            @command_sequence_checker.check command
             send(method, argument)
           rescue CommandError => e
             reply e.message
@@ -61,34 +62,28 @@ module Ftpd
 
     def cmd_user(argument)
       syntax_error unless argument
-      sequence_error unless @state == :user
+      sequence_error if @logged_in
       @user = argument
-      @state = :password
       reply "331 Password required"
-    end
-
-    def sequence_error
-      error "503 Bad sequence of commands"
+      expect 'pass'
     end
 
     def cmd_pass(argument)
       syntax_error unless argument
-      sequence_error unless @state == :password
       password = argument
       unless @driver.authenticate(@user, password)
-        @state = :user
         error "530 Login incorrect"
       end
       reply "230 Logged in"
       set_file_system @driver.file_system(@user)
-      @state = :logged_in
+      @logged_in = true
     end
 
     def cmd_quit(argument)
       syntax_error if argument
       ensure_logged_in
       reply "221 Byebye"
-      @state = :user
+      @logged_in = false
     end
 
     def syntax_error
@@ -119,7 +114,22 @@ module Ftpd
         path = File.expand_path(path, @name_prefix)
         ensure_accessible path
         ensure_exists File.dirname(path)
-        contents = receive_file(path)
+        contents = receive_file
+        @file_system.write path, contents
+        reply "226 Transfer complete"
+      end
+    end
+
+    def cmd_stou(argument)
+      close_data_server_socket_when_done do
+        ensure_logged_in
+        ensure_file_system_supports :write
+        path = argument || 'ftpd'
+        path = File.expand_path(path, @name_prefix)
+        path = unique_path(path)
+        ensure_accessible path
+        ensure_exists File.dirname(path)
+        contents = receive_file(File.basename(path))
         @file_system.write path, contents
         reply "226 Transfer complete"
       end
@@ -230,7 +240,8 @@ module Ftpd
       if @data_server
         reply "200 Already in passive mode"
       else
-        @data_server = TCPServer.new(@interface, 0)
+        interface = @socket.addr[3]
+        @data_server = TCPServer.new(interface, 0)
         ip = @data_server.addr[3]
         port = @data_server.addr[1]
         quads = [
@@ -287,7 +298,7 @@ module Ftpd
     end
 
     def ensure_logged_in
-      return if @state == :logged_in
+      return if @logged_in
       error "530 Not logged in"
     end
 
@@ -389,10 +400,10 @@ module Ftpd
       ensure_exists from_path
       @rename_from_path = from_path
       reply '350 RNFR accepted; ready for destination'
+      expect 'rnto'
     end
 
     def cmd_rnto(argument)
-      sequence_error unless @rename_from_path
       ensure_logged_in
       ensure_file_system_supports :rename
       syntax_error unless argument
@@ -401,7 +412,26 @@ module Ftpd
       ensure_does_not_exist to_path
       @file_system.rename(@rename_from_path, to_path)
       reply '250 Rename successful'
-      @rename_from_path = nil
+    end
+
+    def cmd_help(argument)
+      if argument
+        command = argument.upcase
+        if supported_commands.include?(command)
+          reply "214 Command #{command} is recognized"
+        else
+          reply "214 Command #{command} is not recognized"
+        end
+      else
+        reply '214-The following commands are recognized:'
+        supported_commands.sort.each_slice(8) do |commands|
+          line = commands.map do |command|
+            '   %-4s' % command
+          end.join
+          reply line
+        end
+        reply '214 Have a nice day.'
+      end
     end
 
     def self.unimplemented(command)
@@ -415,13 +445,17 @@ module Ftpd
     unimplemented :abor
     unimplemented :acct
     unimplemented :appe
-    unimplemented :help
     unimplemented :rein
     unimplemented :rest
     unimplemented :site
     unimplemented :smnt
     unimplemented :stat
-    unimplemented :stou
+
+    def supported_commands
+      private_methods.map do |method|
+        method.to_s[/^cmd_(\w+)$/, 1]
+      end.compact.map(&:upcase)
+    end
 
     def pwd
       reply %Q(257 "#{@name_prefix}" is current directory)
@@ -459,6 +493,10 @@ module Ftpd
       'P'=>:private
     }
 
+    def expect(command)
+      @command_sequence_checker.expect command
+    end
+
     def set_file_system(file_system)
       @file_system = FileSystemErrorTranslator.new(file_system)
     end
@@ -472,8 +510,8 @@ module Ftpd
       end
     end
 
-    def receive_file(path)
-      open_data_connection do |data_socket|
+    def receive_file(path_to_advertise = nil)
+      open_data_connection(path_to_advertise) do |data_socket|
         contents = data_socket.read
         contents = nvt_ascii_to_unix(contents) if @data_type == 'A'
         debug("Received #{contents.size} bytes")
@@ -490,8 +528,8 @@ module Ftpd
       s.gsub(/\r\n/, "\n")
     end
 
-    def open_data_connection(&block)
-      reply "150 Opening #{data_connection_description}"
+    def open_data_connection(path_to_advertise = nil, &block)
+      send_start_of_data_connection_reply(path_to_advertise)
       if @data_server
         if encrypt_data?
           open_passive_tls_data_connection(&block)
@@ -507,6 +545,14 @@ module Ftpd
       end
     end
 
+    def send_start_of_data_connection_reply(path)
+      if path
+        reply "150 FILE: #{path}"
+      else
+        reply "150 Opening #{data_connection_description}"
+      end
+    end
+
     def data_connection_description
       [
         DATA_TYPES[@data_type][0],
@@ -596,6 +642,25 @@ module Ftpd
       @socket.puts(s)
     end
 
+    def unique_path(path)
+      suffix = nil
+      100.times do
+        path_with_suffix = [path, suffix].compact.join('.')
+        unless @file_system.exists?(path_with_suffix)
+          return path_with_suffix
+        end
+        suffix = generate_suffix
+      end
+      raise "Unable to find unique path"
+    end
+
+    def generate_suffix
+      set = ('a'..'z').to_a
+      8.times.map do
+        set.sample
+      end.join
+    end
+
     def debug(*s)
       return unless debug?
       File.open(@debug_path, 'a') do |file|
@@ -607,5 +672,12 @@ module Ftpd
       @debug || ENV['FTPD_DEBUG'].to_i != 0
     end
 
+    def init_command_sequence_checker
+      checker = CommandSequenceChecker.new
+      checker.must_expect 'pass'
+      checker.must_expect 'rnto'
+      checker
+    end
+
   end
 end

data/spec/command_sequence_checker_spec.rb

@@ -0,0 +1,81 @@
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+
+module Ftpd
+  describe CommandSequenceChecker do
+
+    let(:sequence_error) {[CommandError, '503 Bad sequence of commands']}
+    subject(:checker) {CommandSequenceChecker.new}
+
+    context 'initial' do
+
+      it 'accepts any command' do
+        checker.check 'NOOP'
+      end
+
+    end
+
+    context 'when a specific command is expected' do
+      
+      before(:each) {checker.expect 'PASS'}
+
+      it 'accepts that command' do
+        checker.check 'PASS'
+      end
+
+      it 'rejects any other command' do
+        expect {
+          checker.check 'NOOP'
+        }.to raise_error *sequence_error
+      end
+
+    end
+
+    context 'after the expected command has arrived' do
+
+      before(:each) do
+        checker.expect 'PASS'
+        checker.check 'PASS'
+      end
+
+      it 'accepts any other command' do
+        checker.check 'NOOP'
+      end
+
+    end
+
+    context 'after a command is rejected' do
+
+      before(:each) do
+        checker.expect 'PASS'
+        expect {
+          checker.check 'NOOP'
+        }.to raise_error *sequence_error
+      end
+
+      it 'accepts any other command' do
+        checker.check 'NOOP'
+      end
+
+    end
+
+    context 'when a command must be expected' do
+
+      before(:each) do
+        checker.must_expect 'PASS'
+      end
+
+      it 'rejects that command if not expected' do
+        expect {
+          checker.check 'PASS'
+        }.to raise_error *sequence_error
+      end
+
+      it 'accepts that command when it is accepted' do
+        checker.expect 'PASS'
+        checker.check 'PASS'
+      end
+
+    end
+
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ftpd
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-28 00:00:00.000000000 Z
+date: 2013-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: memoizer
@@ -156,7 +156,8 @@ files:
 - README.md
 - Rakefile
 - VERSION
-- doc/rfc.md
+- doc/references.md
+- doc/rfc-compliance.md
 - examples/example.rb
 - examples/hello_world.rb
 - features/example/example.feature
@@ -171,6 +172,7 @@ files:
 - features/ftp_server/file_structure.feature
 - features/ftp_server/get.feature
 - features/ftp_server/get_tls.feature
+- features/ftp_server/help.feature
 - features/ftp_server/implicit_tls.feature
 - features/ftp_server/list.feature
 - features/ftp_server/list_tls.feature
@@ -183,6 +185,7 @@ files:
 - features/ftp_server/port.feature
 - features/ftp_server/put.feature
 - features/ftp_server/put_tls.feature
+- features/ftp_server/put_unique.feature
 - features/ftp_server/quit.feature
 - features/ftp_server/rename.feature
 - features/ftp_server/rmdir.feature
@@ -202,6 +205,7 @@ files:
 - features/step_definitions/file_structure.rb
 - features/step_definitions/generic_send.rb
 - features/step_definitions/get.rb
+- features/step_definitions/help.rb
 - features/step_definitions/invalid_commands.rb
 - features/step_definitions/line_endings.rb
 - features/step_definitions/list.rb
@@ -210,6 +214,7 @@ files:
 - features/step_definitions/mode.rb
 - features/step_definitions/noop.rb
 - features/step_definitions/passive.rb
+- features/step_definitions/pending.rb
 - features/step_definitions/port.rb
 - features/step_definitions/put.rb
 - features/step_definitions/quit.rb
@@ -232,6 +237,7 @@ files:
 - ftpd.gemspec
 - insecure-test-cert.pem
 - lib/ftpd.rb
+- lib/ftpd/command_sequence_checker.rb
 - lib/ftpd/disk_file_system.rb
 - lib/ftpd/error.rb
 - lib/ftpd/exception_translator.rb
@@ -250,6 +256,7 @@ files:
 - rake_tasks/spec.rake
 - rake_tasks/test.rake
 - rake_tasks/yard.rake
+- spec/command_sequence_checker_spec.rb
 - spec/disk_file_system_spec.rb
 - spec/exception_translator_spec.rb
 - spec/file_system_error_translator_spec.rb
@@ -270,7 +277,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 537238415
+      hash: 460714675
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -279,7 +286,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Pure Ruby FTP server library