Changeset 179

Timestamp:

09/29/09 05:08:16 (4 years ago)

Author:

jabra

Message:

man page example updates

File:

• FierceParser/trunk/lib/Fierce/Parser.pod (modified) (10 diffs)

FierceParser/trunk/lib/Fierce/Parser.pod

@@ -49 +49 @@
  |  |
  |  |--Fierce::Parser::Domain::FindMX         -- Information about MX records found
+ |  |
+ |  |--Fierce::Parser::Domain::Vhost          -- Information about Virtual Hosts found
  
 
@@ -124 +126 @@
 =item B<domain()>
 
-Returns the domain name.
-
-=back
+returns the domain name.
+
+=back
+
+=head2 Fierce::Parser::Node
+
+This object contains the information for a node. A Node is a simplistic object
+containing information about a device found during a Fierce scan. Many of the
+Fierce modules use a Node to represent the a device.
+
+=over 4
+
+=item B<ip()>
+
+returns the ip address of the node.
+
+=item B<hostname()>
+
+returns the hostname of the node.
+
+=back 
 
 =head2 Fierce::Parser::Domain::NameServers
@@ -136 +156 @@
 =item B<startscan()>
 
-Returns the start time of the scan in unixtime format.
-
-=item B<startscanstr()>
-
-Returns the start time of the scan in a readable string.
-
-=item B<endscan()>
-
-Returns the end time of the scan in unixtime format.
-
-=item B<endscanstr()>
-
-Returns the end time of the scan in a readable string.
-
-=item B<elasptime()>
-
-Returns the elasptime of the scan.
-
-=back
+returns the start time of the scan in unixtime format.
+
+=item B<startscanstr()>
+
+Returns the start time of the scan in a readable string.
+
+=item B<endscan()>
+
+Returns the end time of the scan in unixtime format.
+
+=item B<endscanstr()>
+
+Returns the end time of the scan in a readable string.
+
+=item B<elasptime()>
+
+returns the elasptime of the scan.
+
+=item B<nodes()>
+
+returns an Arrayref to a list of Node Objects.
+
+=back
+
+=head2 EXAMPLE
+
+ my $name_servers = $domain->name_servers;
+
+ foreach my $i ( @{ $name_servers->nodes } ) {
+     print "\thostname:" . "\t" . $i->hostname . "\n";
+     print "\tip:" . "\t\t" . $i->ip . "\n";
+ }   
 
 =head2 Fierce::Parser::Domain::ZoneTransfer
@@ -184 +217 @@
 =back
 
+=head2 EXAMPLE
+
+ my $name_servers = $domain->name_servers;
+ my $zone_transfers = $domain->zone_transfers;
+ 
+ foreach my $i ( @{ $name_servers->nodes } ) {
+     print "\tIP:" . "\t\t" . $i->ip . "\n";
+     print "\tZone Transfer:" . "\t";
+     ( scalar(grep($i->hostname eq $_->name_server, @{ $zone_transfers->result } )) == 1 ) ? print "Enabled\n" : print "Disabled\n";
+ 
+     if  ( scalar(grep($i->hostname eq $_->name_server, @{ $zone_transfers->result } )) == 1 ) {
+         print "\tZone Trasfer Result:" . "\t";
+         foreach(@{ $zone_transfers->result} )  { print "\t\t" . $_->output . "\n"; }
+     }
+
+ } 
+
 =head2 Fierce::Parser::Domain::Bruteforce
 
+This object contains the Nodes found using Prefix Bruteforce.
+
+=over 4
+
+=item B<startscan()>
+
+Returns the start time of the scan in unixtime format.
+
+=item B<startscanstr()>
+
+Returns the start time of the scan in a readable string.
+
+=item B<endscan()>
+
+Returns the end time of the scan in unixtime format.
+
+=item B<endscanstr()>
+
+Returns the end time of the scan in a readable string.
+
+=item B<elasptime()>
+
+Returns the elasptime of the scan.
+
+=item B<nodes()>
+
+returns an arrayref to a list of node objects.
+
+=back
+
+=head2 EXAMPLE
+
+ my $bruteforce = $domain->bruteforce;
+
+ foreach ( @{ $bruteforce->nodes } ) {
+     print "\tHostname:" . "\t" . $_->hostname . "\n";
+     print "\tIP: " . "\t\t" . $_->ip . "\n";
+ }
+
+=head2 Fierce::Parser::Domain::ExtBruteForce
+
 This object contains the Nodes found using Extension Bruteforce.
 
@@ -192 +283 @@
 =item B<startscan()>
 
-Returns the start time of the scan in unixtime format.
-
-=item B<startscanstr()>
-
-Returns the start time of the scan in a readable string.
-
-=item B<endscan()>
-
-Returns the end time of the scan in unixtime format.
-
-=item B<endscanstr()>
-
-Returns the end time of the scan in a readable string.
-
-=item B<elasptime()>
-
-Returns the elasptime of the scan.
-
-=back
-
-=head2 Fierce::Parser::Domain::ExtBruteforce
+returns the start time of the scan in unixtime format.
+
+=item B<startscanstr()>
+
+returns the start time of the scan in a readable string.
+
+=item B<endscan()>
+
+returns the end time of the scan in unixtime format.
+
+=item B<endscanstr()>
+
+returns the end time of the scan in a readable string.
+
+=item B<elasptime()>
+
+returns the elasptime of the scan.
+
+=item B<nodes()>
+
+returns an arrayref to a list of node objects.
+
+=back
+
+=head2 EXAMPLE
+
+ my $ext_bruteforce = $domain->ext_bruteforce;
+
+ foreach ( @{ $ext_bruteforce->nodes } ) {
+     print "\thostname:" . "\t" . $_->hostname . "\n";
+     print "\tip: " . "\t\t" . $_->ip . "\n";
+ }
+
+=head2 Fierce::Parser::Domain::ReverseLookups
 
 This object contains the Nodes found using Reverse Lookups.
@@ -238 +342 @@
 Returns the elasptime of the scan.
 
-=back
-
-
-=head2 Fierce::Parser::Domain::ReverseLookups
-
-This object contains the Nodes found using Reverse Lookups.
-
-=over 4
-
-=item B<startscan()>
-
-Returns the start time of the scan in unixtime format.
-
-=item B<startscanstr()>
-
-Returns the start time of the scan in a readable string.
-
-=item B<endscan()>
-
-Returns the end time of the scan in unixtime format.
-
-=item B<endscanstr()>
-
-Returns the end time of the scan in a readable string.
-
-=item B<elasptime()>
-
-Returns the elasptime of the scan.
-
-=back
+=item B<nodes()>
+
+returns an ArrayRef to a list of Node Objects.
+
+=back
+
+=head2 EXAMPLE
+
+ my $reverse_lookups = $domain->reverse_lookups;
+ 
+ foreach ( @{ $reverse_lookups->nodes } ) {
+    print "\thostname:" . "\t" . $_->hostname . "\n";
+    print "\tip: " . "\t\t" . $_->ip . "\n";
+ }
+
 
 =head2 Fierce::Parser::Domain::WildCard
@@ -295 +384 @@
 Returns the elasptime of the scan.
 
-=back
+=back 
 
 =head2 Fierce::Parser::Domain::WhoisLookup
@@ -325 +414 @@
 =back
 
+=head2 EXAMPLE
+
 =head2 Fierce::Parser::Domain::FindMX
 
@@ -352 +443 @@
 
 =back
+
+=head2 EXAMPLE
+
+ my $reverse_lookups = $domain->reverse_lookups;
+ 
+ foreach ( @{ $findmx->result } ) {
+     print "\tpreference:" . "\t" . $_->preference . "\n";
+     print "\texchange: " . "\t" . $_->exchange . "\n";
+ }
+ 
+
+=head2 Fierce::Parser::Domain::Vhost
+
+This object contains Information about Virtual Hosts found.
+
+=over 4
+
+=item B<startscan()>
+
+Returns the start time of the scan in unixtime format.
+
+=item B<startscanstr()>
+
+Returns the start time of the scan in a readable string.
+
+=item B<endscan()>
+
+Returns the end time of the scan in unixtime format.
+
+=item B<endscanstr()>
+
+Returns the end time of the scan in a readable string.
+
+=item B<elasptime()>
+
+Returns the elasptime of the scan.
+
+=item B<nodes()>
+
+returns an ArrayRef to a list of Node Objects.
+
+=back
+
+=head2 EXAMPLE
+
+ my $reverse_lookups = $domain->reverse_lookups;
+ 
+ foreach ( @{ $vhost->nodes } ) {
+    print "\thostname:" . "\t" . $_->hostname . "\n";
+    print "\tip: " . "\t\t" . $_->ip . "\n";
+ }
+
+=head1 EXAMPLES
+
+
+Here is an example of parsing an XML file using Fierce::Parser:
+
+ use Fierce::Parser;
+ my $fp = new Fierce::Parser;
+
+ if (defined($ARGV[0])){
+    my $file = $ARGV[0];
+    my $parser = $fp->parse_file($file);
+    my @nodes    = $parser->get_all_nodes();
+
+    foreach my $n (@nodes){
+        my $domain = $n;
+        my $name_servers = $domain->name_servers;
+        my $zone_transfers = $domain->zone_transfers;
+        my $bruteforce = $domain->bruteforce;
+        my $vhost = $domain->vhost;
+        my $subdomain_bruteforce = $domain->subdomain_bruteforce;
+        my $ext_bruteforce = $domain->ext_bruteforce;
+        my $reverse_lookups = $domain->reverse_lookups;
+        my $wildcard = $domain->wildcard;
+        my $findmx = $domain->findmx;
+        my $find_nearby = $domain->find_nearby;
+
+        print "==== " . $n->domain . " ====\n";
+        if ( $name_servers ) {
+            print "Nameservers:\n";
+            foreach my $i ( @{ $name_servers->nodes } ) {
+                print "\tHostname:" . "\t" . $i->hostname . "\n";
+                print "\tIP:" . "\t\t" . $i->ip . "\n";
+                print "\tZone Transfer:" . "\t";
+                ( scalar(grep($i->hostname eq $_->name_server, @{ $zone_transfers->result } )) == 1 ) ? print "Enabled\n" : print "Disabled\n";
+
+                if  ( scalar(grep($i->hostname eq $_->name_server, @{ $zone_transfers->result } )) == 1 ) { 
+                    print "\tZone Trasfer Result:" . "\t";
+                    foreach(@{ $zone_transfers->result} )  { print "\t\t" . $_->output . "\n"; }
+                }
+
+            }   
+            print "\n";
+        }
+        if ( $findmx ) {
+            print "MX:\n";
+            foreach ( @{ $findmx->result } ) {
+                print "\tpreference:" . "\t" . $_->preference . "\n";
+                print "\texchange: " . "\t" . $_->exchange . "\n";
+            }   
+            print "\n";
+        }
+        
+        if ($bruteforce) {
+            print "Prefix Bruteforce:\n";
+            foreach ( @{ $bruteforce->nodes } ) {
+                print "\tHostname:" . "\t" . $_->hostname . "\n";
+                print "\tIP: " . "\t\t" . $_->ip . "\n";
+            }
+            print "\n";
+        }
+        if ($vhost) {
+            print "Virtual Hosts:\n";
+            foreach ( @{ $vhost->nodes } ) {
+                print "\thostname:" . "\t" . $_->hostname . "\n";
+                print "\tip: " . "\t\t" . $_->ip . "\n";
+            }
+            print "\n";
+        }
+        if ($ext_bruteforce){
+            print "Extension Bruteforce:\n";
+            foreach ( @{ $ext_bruteforce->nodes } ) {
+                print "\thostname:" . "\t" . $_->hostname . "\n";
+                print "\tip: " . "\t\t" . $_->ip . "\n";
+            }
+            print "\n";
+        }
+        if ($reverse_lookups){
+            print "reverse lookup:\n";
+            foreach ( @{ $reverse_lookups->nodes } ) {
+                print "\thostname:" . "\t" . $_->hostname . "\n";
+                print "\tip: " . "\t\t" . $_->ip . "\n";
+            }
+            print "\n";
+        }
+       
+        if ($find_nearby){ 
+            print "Find Nearby:\n";
+            foreach ( @{ $find_nearby->ptrs } ) {
+                print "\tPtrdname:" . "\t" . $_->ptrdname . "\n";
+                print "\tIP: " . "\t\t" . $_->ip . "\n";
+            }
+        }
+    }
+
+ }
+ else {
+    print "Usage: $0 [fierce-xml]\n";
+ }
 
 =head1 SEE ALSO
@@ -369 +610 @@
 
 =cut
-
-