Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

readme update

  • Loading branch information...
commit 0afbee96e71b0a05dc18f20e4faa9a1475d35297 1 parent 3434c70
@mephux authored
Showing with 59 additions and 1 deletion.
  1. +59 −1 README.rdoc
View
60 README.rdoc
@@ -20,6 +20,8 @@ The below example illustrates how easy it really is to iterate of result data.
require 'ruby-nessus'
Nessus::Parse.new("example_v1.nessus", :version => 1) do |scan|
+ # OR: Nessus::Parse.new("example_v2.nessus") do |scan| <-- Ruby-Nessus will figured out the correct Nessus file version.
+
puts scan.title # The Nessus Report Title.
puts scan.runtime # The Scan Runtime. #=> 2 hours 23 minutes 12 seconds
puts scan.host_count # Host Count.
@@ -60,7 +62,7 @@ You also have the ability to search for particular hostnames. In the near future
There are a bunch of convenient methods (maybe more then needed) added to make reporting a bit easier to produce quickly from a raw scan file. If you do not pass :version as an option it will default to the 2.0 .nessus schema.
- Nessus::Parse.new("example_v2.nessus", :version => 2) do |scan|
+ Nessus::Parse.new("example_v2.nessus") do |scan|
puts scan.event_percentage_for('low', true) #=> 8%
@@ -94,6 +96,62 @@ There are a bunch of convenient methods (maybe more then needed) added to make r
end
+Ruby-Nessus also ships with a POC CLI application for the lib called 'recess':
+
+ Recess 0.1.1
+ usage: recess FILE [OPTIONS]
+ -f, --file FILE The .nessus file to parse.
+ -h, --help This help summary page.
+ -v, --version Recess Version.
+
+Below is example output generated by recess:
+
+ $> recess examples/example_v2.nessus
+ Recess - Ruby-Nessus CLI
+ Version: 0.1.1
+
+ -> SCAN Metadata:
+
+ Scan Title: Ruby-Nessus
+ Policy Title: Ruby-Nessus
+
+ -> SCAN Statistics:
+
+ Host Count: 2
+ Open Port Count: 51
+ TCP Count: 38
+ UDP Count: 11
+ ICMP Count: 1
+
+ -> EVENT Statistics:
+
+ Informational Severity Count: 19
+ Low Severity Count: 47
+ Medium Severity Count: 3
+ High Severity Count: 0
+ Total Event Count: 50
+
+
+ Low Event Percentage: 94
+ Medium Event Percentage: 6
+ High Event Percentage: 0
+
+ -> HOSTS:
+
+ Hostname: snorby.org
+ - IP Address:: 173.45.230.150
+ - Informational Count: 12
+ - Low Count: 34
+ - Medium Count: 1
+ - High Count: 0
+
+ Hostname: scanme.insecure.org
+ - IP Address:: 64.13.134.52
+ - Informational Count: 7
+ - Low Count: 13
+ - Medium Count: 2
+ - High Count: 0
+
== Requirements
* Ruby 1.8 or 1.9
* Nokogiri http://github.com/tenderlove/nokogiri

0 comments on commit 0afbee9

Please sign in to comment.
Something went wrong with that request. Please try again.