README.rdoc in ruby-nessus-0.1.3 vs README.rdoc in ruby-nessus-0.1.4

- old
+ new

@@ -4,31 +4,25 @@ Ruby-Nessus is a ruby interface for the popular Nessus vulnerability scanner. Ruby-Nessus aims to deliver an easy yet powerful interface for interacting and manipulating Nessus scan results and configurations. Please remember to submit bugs and request features if needed. More Information: * Documentation: http://rdoc.info/projects/mephux/ruby-nessus +* More: http://www.packetport.net == Install -Make sure you have gemcutter installed. - - sudo gem update --system - sudo gem install gemcutter - gem tumble - -Then install Ruby-Nessus - sudo gem install ruby-nessus == Usage & Examples The below example illustrates how easy it really is to iterate of result data. - + + require 'rubygems' require 'ruby-nessus' Nessus::XML.new("example.nessus") do |scan| - puts scan.report_name # The Nessus Report Title. + 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. puts scan.unique_ports # All Unique Ports Seen. scan.hosts do |host| @@ -62,11 +56,10 @@ puts event.data if event.data end end - There are a bunch of convenient methods added to make reporting a bit easier to produce quickly from a raw scan file. Nessus::XML.new("example.nessus") do |scan| puts scan.event_percentage_for('low', true) #=> 8% @@ -77,49 +70,43 @@ puts scan.open_ports_count # Open Port Count puts scan.total_event_count #=> 3411 # Total Event Count puts scan.hosts.count #=> 12 - puts scan.policy_name - puts scan.policy_comments unless scan.policy_comments.empty? - + puts scan.policy_title + puts scan.policy_notes unless scan.policy_notes.empty? + scan.hosts do |host| puts host.hostname - + # high_severity_events, medium_severity_events and low_severity_events host.high_severity_events do |high| puts high.port puts high.name if high.name puts high.data if high.data end - - end + end + end == Requirements * Ruby 1.8 or 1.9 * Nokogiri http://github.com/tenderlove/nokogiri == Todo * Add The Ability to parse the scan configuration and plugin options. * Building XML (.nessus) files configurations * Add Support For NBE File Formats. -* Add Complex Searching. == Note on Patches & Pull Requests * Fork the project. * Make your feature addition or bug fix. * Add tests for it. This is important so I don't break it in a future version unintentionally. * Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull) * Send me a pull request. Bonus points for topic branches. - -== Props - -Huge props to postmodern for helping me refactor! Check out his projects: -* http://github.com/postmodern == Copyright Copyright (c) 2009 Dustin Willis Webber. See LICENSE for details. \ No newline at end of file