Lands rapid7#4977, updates test module to support arbitrary base filename.

Author: HD Moore

test/modules/post/test/file.rb

@@ -23,6 +23,11 @@ def initialize(info={})
         'Platform'      => [ 'windows', 'linux', 'java' ],
         'SessionTypes'  => [ 'meterpreter', 'shell' ]
       ))
+
+    register_options(
+      [
+        OptString.new("BaseFileName" , [true, "File name to create", "meterpreter-test"])
+      ], self.class)
   end
 
   #
@@ -68,13 +73,13 @@ def test_file
     end
 
     it "should create text files" do
-      write_file("pwned", "foo")
+      write_file(datastore["BaseFileName"], "foo")
 
-      file?("pwned")
+      file?(datastore["BaseFileName"])
     end
 
     it "should read the text we just wrote" do
-      f = read_file("pwned")
+      f = read_file(datastore["BaseFileName"])
       ret = ("foo" == f)
       unless ret
         print_error("Didn't read what we wrote, actual file on target: #{f}")
@@ -85,11 +90,11 @@ def test_file
 
     it "should append text files" do
       ret = true
-      append_file("pwned", "bar")
+      append_file(datastore["BaseFileName"], "bar")
 
-      ret &&= read_file("pwned") == "foobar"
-      append_file("pwned", "baz")
-      final_contents = read_file("pwned")
+      ret &&= read_file(datastore["BaseFileName"]) == "foobar"
+      append_file(datastore["BaseFileName"], "baz")
+      final_contents = read_file(datastore["BaseFileName"])
       ret &&= final_contents == "foobarbaz"
       unless ret
         print_error("Didn't read what we wrote, actual file on target: #{final_contents}")
@@ -99,9 +104,9 @@ def test_file
     end
 
     it "should delete text files" do
-      file_rm("pwned")
+      file_rm(datastore["BaseFileName"])
 
-      not file_exist?("pwned")
+      not file_exist?(datastore["BaseFileName"])
     end
 
     it "should move files" do
@@ -131,30 +136,30 @@ def test_binary_files
     it "should write binary data" do
       vprint_status "Writing #{binary_data.length} bytes"
       t = Time.now
-      write_file("pwned", binary_data)
+      write_file(datastore["BaseFileName"], binary_data)
       vprint_status("Finished in #{Time.now - t}")
 
-      file_exist?("pwned")
+      file_exist?(datastore["BaseFileName"])
     end
 
     it "should read the binary data we just wrote" do
-      bin = read_file("pwned")
+      bin = read_file(datastore["BaseFileName"])
       vprint_status "Read #{bin.length} bytes"
 
       bin == binary_data
     end
 
     it "should delete binary files" do
-      file_rm("pwned")
+      file_rm(datastore["BaseFileName"])
 
-      not file_exist?("pwned")
+      not file_exist?(datastore["BaseFileName"])
     end
 
     it "should append binary data" do
-      write_file("pwned", "\xde\xad")
-      append_file("pwned", "\xbe\xef")
-      bin = read_file("pwned")
-      file_rm("pwned")
+      write_file(datastore["BaseFileName"], "\xde\xad")
+      append_file(datastore["BaseFileName"], "\xbe\xef")
+      bin = read_file(datastore["BaseFileName"])
+      file_rm(datastore["BaseFileName"])
 
       bin == "\xde\xad\xbe\xef"
     end

test/modules/post/test/meterpreter.rb

@@ -19,7 +19,10 @@ def initialize(info={})
         'Platform'      => [ 'windows', 'linux', 'java' ],
         'SessionTypes'  => [ 'meterpreter' ]
       ))
-
+    register_options(
+      [
+        OptString.new("BaseFileName" , [true, "File/dir base name", "meterpreter-test"])
+      ], self.class)
   end
 
   #
@@ -164,66 +167,68 @@ def test_fs
     end
 
     it "should create and remove a dir" do
-      session.fs.dir.rmdir("meterpreter-test-dir") rescue nil
-      res = create_directory("meterpreter-test-dir")
+      dir_name = "#{datastore["BaseFileName"]}-dir"
+      session.fs.dir.rmdir(dir_name) rescue nil
+      res = create_directory(dir_name)
       if (res)
-        session.fs.dir.rmdir("meterpreter-test-dir")
-        res &&= !session.fs.dir.entries.include?("meterpreter-test-dir")
+        session.fs.dir.rmdir(dir_name)
+        res &&= !session.fs.dir.entries.include?(dir_name)
         vprint_status("Directory removed successfully")
       end
 
       res
     end
 
     it "should change directories" do
-      session.fs.dir.rmdir("meterpreter-test-dir") rescue nil
-      res = create_directory("meterpreter-test-dir")
+      dir_name = "#{datastore["BaseFileName"]}-dir"
+      session.fs.dir.rmdir(dir_name) rescue nil
+      res = create_directory(dir_name)
 
       old_wd = session.fs.dir.pwd
       vprint_status("Old CWD: #{old_wd}")
 
       if res
-        session.fs.dir.chdir("meterpreter-test-dir")
+        session.fs.dir.chdir(dir_name)
         new_wd = session.fs.dir.pwd
         vprint_status("New CWD: #{new_wd}")
-        res &&= (new_wd =~ /meterpreter-test-dir$/)
 
+        res &&= new_wd.include? dir_name
         if res
           session.fs.dir.chdir("..")
           wd = session.fs.dir.pwd
           vprint_status("Back to old CWD: #{wd}")
         end
       end
-      session.fs.dir.rmdir("meterpreter-test-dir")
-      res &&= !session.fs.dir.entries.include?("meterpreter-test-dir")
+      session.fs.dir.rmdir(dir_name)
+      res &&= !session.fs.dir.entries.include?(dir_name)
       vprint_status("Directory removed successfully")
 
       res
     end
 
     it "should create and remove files" do
       res = true
-      res &&= session.fs.file.open("meterpreter-test", "wb") { |fd|
+      file_name = datastore["BaseFileName"]
+      res &&= session.fs.file.open(file_name, "wb") { |fd|
         fd.write("test")
       }
 
-      vprint_status("Wrote to meterpreter-test, checking contents")
-      res &&= session.fs.file.open("meterpreter-test", "rb") { |fd|
+      vprint_status("Wrote to #{file_name}, checking contents")
+      res &&= session.fs.file.open(file_name, "rb") { |fd|
         contents = fd.read
         vprint_status("Wrote #{contents}")
         (contents == "test")
       }
 
-      session.fs.file.rm("meterpreter-test")
-      res &&= !session.fs.dir.entries.include?("meterpreter-test")
+      session.fs.file.rm(file_name)
+      res &&= !session.fs.dir.entries.include?(file_name)
 
       res
     end
 
     it "should upload a file" do
       res = true
-
-      remote = "meterpreter-test-file.txt"
+      remote = "#{datastore["BaseFileName"]}-file.txt"
       local  = __FILE__
       vprint_status("uploading")
       session.fs.file.upload_file(remote, local)
@@ -249,31 +254,33 @@ def test_fs
     if session.commands.include?("stdapi_fs_file_move")
       it "should move files" do
         res = true
+        src_name = datastore["BaseFileName"]
+        dst_name = "#{datastore["BaseFileName"]}-moved"
 
         # Make sure we don't have leftovers from a previous run
-        session.fs.file.rm("meterpreter-test") rescue nil
-        session.fs.file.rm("meterpreter-test-moved") rescue nil
+        session.fs.file.rm(src_name) rescue nil
+        session.fs.file.rm(dst_name) rescue nil
 
         # touch a new file
-        fd = session.fs.file.open("meterpreter-test", "wb")
+        fd = session.fs.file.open(src_name, "wb")
         fd.close
 
-        session.fs.file.mv("meterpreter-test", "meterpreter-test-moved")
+        session.fs.file.mv(src_name, dst_name)
         entries = session.fs.dir.entries
-        res &&= entries.include?("meterpreter-test-moved")
-        res &&= !entries.include?("meterpreter-test")
+        res &&= entries.include?(dst_name)
+        res &&= !entries.include?(src_name)
 
         # clean up
-        session.fs.file.rm("meterpreter-test") rescue nil
-        session.fs.file.rm("meterpreter-test-moved") rescue nil
+        session.fs.file.rm(src_name) rescue nil
+        session.fs.file.rm(dst_name) rescue nil
 
         res
       end
     end
 
     it "should do md5 and sha1 of files" do
       res = true
-      remote = "meterpreter-test-file.txt"
+      remote = "#{datastore["BaseFileName"]}-file.txt"
       local  = __FILE__
       vprint_status("uploading")
       session.fs.file.upload_file(remote, local)