Changeset 737

Timestamp:

07/23/07 15:17:56 (1 year ago)

Author:

kindlund

Message:

Cleaned up IE module, extensively. Working on reliable unit tests.

Files:

• honeyclient/branches/exp/kindlund-firefox/lib/HoneyClient/Agent/Driver/Browser/IE.pm (modified) (9 diffs)

honeyclient/branches/exp/kindlund-firefox/lib/HoneyClient/Agent/Driver/Browser/IE.pm

@@ -31 +31 @@
-#######################################################################
-
-#TODO: Documentation below
-
-=pod
-
-=head1 NAME
-
-fetch the conten
-
-the getContent() function
+drive Microsof
+
+package, by overridding the drive() method
-
-=head1 VERSION
@@ -49 +47 @@
-  use HoneyClient::Agent::Driver::Browser::IE;
-
+  # TODO: Need more here.
+
+=head1 DESCRIPTION
+
+# TODO: Need more here.
+
-=cut
-
-package HoneyClient::Agent::Driver::Browser::IE;
-
-# XXX: Disabled version check, Honeywall does not have Perl v5.8 installed.
-#use 5.008006;
-use strict;
-use warnings;
-use Config;
-use Carp ();
-
@@ -105 +106 @@
-    @EXPORT_OK = ( @{ $EXPORT_TAGS{'all'} } );
-
-# XXX: Fix this!
-# Check to make sure our OS is Windows-based.
-#if ($Config{osname} !~ /^MSWin32$/) {
-#    Carp::croak "Error: " . __PACKAGE__ . " will only run on Win32 platforms!\n";
-#}
-
-    $SIG{PIPE} = 'IGNORE';    # Do not exit on broken pipes.
-}
-our ( @EXPORT_OK, $VERSION );
-
-#TODO: Rewrite the test module
-
-=pod
-
-=begin testing
-
+# Make sure Log::Log4perl loads
+BEGIN { use_ok('Log::Log4perl', qw(:nowarn))
+        or diag("Can't load Log::Log4perl package. Check to make sure the package library is correctly listed within the path.");
+       
+        # Suppress all logging messages, since we need clean output for unit testing.
+        Log::Log4perl->init({
+            "log4perl.rootLogger"                               => "DEBUG, Buffer",
+            "log4perl.appender.Buffer"                          => "Log::Log4perl::Appender::TestBuffer",
+            "log4perl.appender.Buffer.min_level"                => "fatal",
+            "log4perl.appender.Buffer.layout"                   => "Log::Log4perl::Layout::PatternLayout",
+            "log4perl.appender.Buffer.layout.ConversionPattern" => "%d{yyyy-MM-dd HH:mm:ss} %5p [%M] (%F:%L) - %m%n",
+        });
+}
+require_ok('Log::Log4perl');
+use Log::Log4perl qw(:easy);
+
+# Make sure HoneyClient::Util::Config loads.
+BEGIN { use_ok('HoneyClient::Util::Config', qw(getVar))
+        or diag("Can't load HoneyClient::Util::Config package.  Check to make sure the package library is correctly listed within the path."); 
+
+        # Suppress all logging messages, since we need clean output for unit testing.
+        Log::Log4perl->init({
+            "log4perl.rootLogger"                               => "DEBUG, Buffer",
+            "log4perl.appender.Buffer"                          => "Log::Log4perl::Appender::TestBuffer",
+            "log4perl.appender.Buffer.min_level"                => "fatal",
+            "log4perl.appender.Buffer.layout"                   => "Log::Log4perl::Layout::PatternLayout",
+            "log4perl.appender.Buffer.layout.ConversionPattern" => "%d{yyyy-MM-dd HH:mm:ss} %5p [%M] (%F:%L) - %m%n",
+        });
+        
+}
+require_ok('HoneyClient::Util::Config');
+can_ok('HoneyClient::Util::Config', 'getVar');
+use HoneyClient::Util::Config qw(getVar);
+
+# Make sure the module loads properly, with the exportable
+# functions shared.
+BEGIN { use_ok('HoneyClient::Agent::Driver::Browser::IE') or diag("Can't load HoneyClient::Agent::Driver::Browser::IE package.  Check to make sure the package library is correctly listed within the path."); }
+require_ok('HoneyClient::Agent::Driver::Browser::IE');
+can_ok('HoneyClient::Agent::Driver::Browser::IE', 'new');
+can_ok('HoneyClient::Agent::Driver::Browser::IE', 'drive');
+can_ok('HoneyClient::Agent::Driver::Browser::IE', 'isFinished');
+can_ok('HoneyClient::Agent::Driver::Browser::IE', 'next');
+can_ok('HoneyClient::Agent::Driver::Browser::IE', 'status');
+can_ok('HoneyClient::Agent::Driver::Browser::IE', 'getNextLink');
+use HoneyClient::Agent::Driver::Browser::IE;
+
+# Suppress all logging messages, since we need clean output for unit testing.
+Log::Log4perl->init({
+    "log4perl.rootLogger"                               => "DEBUG, Buffer",
+    "log4perl.appender.Buffer"                          => "Log::Log4perl::Appender::TestBuffer",
+    "log4perl.appender.Buffer.min_level"                => "fatal",
+    "log4perl.appender.Buffer.layout"                   => "Log::Log4perl::Layout::PatternLayout",
+    "log4perl.appender.Buffer.layout.ConversionPattern" => "%d{yyyy-MM-dd HH:mm:ss} %5p [%M] (%F:%L) - %m%n",
+});
+
+# Make sure Win32::Job loads.
+BEGIN { use_ok('Win32::Job') or diag("Can't load Win32::Job package.  Check to make sure the package library is correctly listed within the path."); }
+require_ok('Win32::Job');
+use Win32::Job;
+
-=end testing
-
@@ -126 +179 @@
-
-#######################################################################
-
-#TODO: Remove any of these use statements that aren't needed
-
-# Include the Global Configuration Processing Library
-use HoneyClient::Util::Config qw(getVar);
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-use Win32::Job;
-
@@ -161 +192 @@
-our $LOG = get_logger();
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-sub drive {
@@ -256 +290 @@
-
-    # Spawn the job.
-    #$job->spawn(undef, "\"C:\\Program Files\\Internet Explorer\\iexplore.exe\"" . $args{'url'});
-    my $processExec = getVar(name => "process_exec");
-    my $processName = getVar(name => "process_name");
@@ -270 +303 @@
-    $job->run($timeout);
-
-TODO: c
+C
-    $status = $job->status();
-
@@ -292 +325 @@
-    }
-
+    # TODO: We may want to report this suspicious activity back to the Agent;
+    # perhaps force the Agent to do an early integrity check, to make sure nothing
+    # sketchy is going on.
+
-    # Check to make sure the exitcode is '293', meaning, that the
-    # application didn't unexpectedly die early.
-    if ($status->{$processID}->{'exitcode'} != 293) {
-'" . $processName . "' process (ID = " . $processID . ") unexpectedly
+Unexpected: '" . $processName . "' process (ID = " . $processID . ")
-    }
-
@@ -306 +343 @@
-1;
-
+#######################################################################
+# Additional Module Documentation                                     #
+#######################################################################
+
+__END__
+
+=head1 BUGS & ASSUMPTIONS
+
+This package will only run on Win32 platforms.  Furthermore, it has
+only been tested to work reliably within a Cygwin environment.
+
+In a nutshell, this object is nothing more than a blessed anonymous
+reference to a hashtable, where (key => value) pairs are defined in
+the L<DEFAULT PARAMETER LIST>, as well as fed via the new() function
+during object initialization.  As such, this package does B<not>
+perform any rigorous B<data validation> prior to accepting any new
+or overriding (key => value) pairs.
+
+However, additional links can be fed to any IE driver at any time, by
+simply adding new hashtable entries to the B<links_to_visit> hashtable
+within the B<$object>.
+
+For example, if you wanted to add the URL "http://www.mitre.org"
+to the IE driver B<$object>, simply use the following code:
+
+  $object->{links_to_visit}->{'http://www.mitre.org'} = 1;
+
+In general, the IE driver does B<not> know how many links it will
+ultimately end up browsing to, until it conducts an exhaustive
+spider of all initial URLs supplied.  As such, expect the output
+of $object->status() to change significantly, upon each
+$object->drive() iteration.
+
+For example, if at one given point, the status of B<percent_complete>
+is 30% and then this value drops to 15% upon another iteration, then
+this means that the total number of links to drive to has greatly
+increased.
+
+Lastly, we assume that the Microsoft Internet Explorer browser has
+been preconfigured to B<not cache any data>.  This ensures the browser
+will render the most recent version of the content hosted at each URL.
+
+=head1 SEE ALSO
+
+L<http://www.honeyclient.org/trac>
+
+=head1 REPORTING BUGS
+
+L<http://www.honeyclient.org/trac/newticket>
+
+=head1 AUTHORS
+
+Kathy Wang, E<lt>knwang@mitre.orgE<gt>
+
+Thanh Truong, E<lt>ttruong@mitre.orgE<gt>
+
+Darien Kindlund, E<lt>kindlund@mitre.orgE<gt>
+
+Brad Stephenson, E<lt>stephenson@mitre.orgE<gt>
+
+=head1 COPYRIGHT & LICENSE
+
+Copyright (C) 2007 The MITRE Corporation.  All rights reserved.
+
+This program is free software; you can redistribute it and/or
+modify it under the terms of the GNU General Public License
+as published by the Free Software Foundation, using version 2
+of the License.
+
+This program 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 General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+02110-1301, USA.
+
+
+=cut
+