logstash-codec-nmap 0.0.18 → 0.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9922e7ce269569efd0d07c15da86f995e66d6f35
-  data.tar.gz: 170e6de746c85da3c5fd62d4c802d0f745b9ba7c
+  metadata.gz: 65b8ca71640b64d9e2177098e2b16c3258710d97
+  data.tar.gz: dc21a7499b75a6f3403811b729f026336679d8d4
 SHA512:
-  metadata.gz: 3fa27503b71e68855baef1081c48bdcbe1bbd3cf508dd3de3a1c278a0c878ba9f787906f0f2ddf5d166fb368e597431e91a11c27a4145560bd1cdbb7cba1a188
-  data.tar.gz: 41ab6a85cbda6d86d365f04c92ca71917a98d652f0e7bb8f8551765e64141040abb3033bd033c1ece670c0d35d6f79e46608f1789b0678f5f9126a426bc0a511
+  metadata.gz: 3a499c610e4da6ebbf9833b60850b0f31ff21e8340ebd3f2fb880ccb4b6789be20ddf8bbc5bda036ec4fc8038523e134f2b48044c5d3a0dcd96d7377d25681a3
+  data.tar.gz: 4b060e3cc6765df6c697788b9d88f17b53de27c07d6027e0714bb711bc4d216815610b28516d1631d1efed593cd6072e3adb4491cf281ba67d099593cb137fd8

data/Gemfile

@@ -1,2 +1,11 @@
 source 'https://rubygems.org'
-gemspec
+
+gemspec
+
+logstash_path = ENV["LOGSTASH_PATH"] || "../../logstash"
+use_logstash_source = ENV["LOGSTASH_SOURCE"] && ENV["LOGSTASH_SOURCE"].to_s == "1"
+
+if Dir.exist?(logstash_path) && use_logstash_source
+  gem 'logstash-core', :path => "#{logstash_path}/logstash-core"
+  gem 'logstash-core-plugin-api', :path => "#{logstash_path}/logstash-core-plugin-api"
+end

data/docs/index.asciidoc

@@ -0,0 +1,81 @@
+:plugin: nmap
+:type: codec
+
+///////////////////////////////////////////
+START - GENERATED VARIABLES, DO NOT EDIT!
+///////////////////////////////////////////
+:version: %VERSION%
+:release_date: %RELEASE_DATE%
+:changelog_url: %CHANGELOG_URL%
+:include_path: ../../../../logstash/docs/include
+///////////////////////////////////////////
+END - GENERATED VARIABLES, DO NOT EDIT!
+///////////////////////////////////////////
+
+[id="plugins-{type}-{plugin}"]
+
+=== Nmap codec plugin
+
+include::{include_path}/plugin_header.asciidoc[]
+
+==== Description
+
+This codec is used to parse https://nmap.org/[namp] output data which is serialized in XML format. Nmap ("Network Mapper") is a free and open source utility for network discovery and security auditing. 
+For more information on nmap, see https://nmap.org/.
+
+This codec can only be used for decoding data.
+
+Event types are listed below
+
+`nmap_scan_metadata`: An object containing top level information about the scan, including how many hosts were up, and how many were down. Useful for the case where you need to check if a DNS based hostname does not resolve, where both those numbers will be zero.
+`nmap_host`: One event is created per host. The full data covering an individual host, including open ports and traceroute information as a nested structure.
+`nmap_port`: One event is created per host/port. This duplicates data already in `nmap_host`: This was put in for the case where you want to model ports as separate documents in Elasticsearch (which Kibana prefers).
+`nmap_traceroute_link`: One of these is output per traceroute 'connection', with a `from` and a `to` object describing each hop. Note that traceroute hop data is not always correct due to the fact that each tracing ICMP packet may take a different route. Also very useful for Kibana visualizations.
+
+[id="plugins-{type}s-{plugin}-options"]
+==== Nmap Codec Configuration Options
+
+[cols="<,<,<",options="header",]
+|=======================================================================
+|Setting |Input type|Required
+| <<plugins-{type}s-{plugin}-emit_hosts>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-emit_ports>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-emit_scan_metadata>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-emit_traceroute_links>> |<<boolean,boolean>>|No
+|=======================================================================
+
+&nbsp;
+
+[id="plugins-{type}s-{plugin}-emit_hosts"]
+===== `emit_hosts` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `true`
+
+Emit all host data as a nested document (including ports + traceroutes) with the type 'nmap_fullscan'
+
+[id="plugins-{type}s-{plugin}-emit_ports"]
+===== `emit_ports` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `true`
+
+Emit each port as a separate document with type 'nmap_port'
+
+[id="plugins-{type}s-{plugin}-emit_scan_metadata"]
+===== `emit_scan_metadata` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `true`
+
+Emit scan metadata
+
+[id="plugins-{type}s-{plugin}-emit_traceroute_links"]
+===== `emit_traceroute_links` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `true`
+
+Emit each hop_tuple of the traceroute with type 'nmap_traceroute_link'
+
+

data/logstash-codec-nmap.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-codec-nmap'
-  s.version         = '0.0.18'
+  s.version         = '0.0.19'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "This codec may be used to decode Nmap XML"
   s.description     = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"
@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # Files
-  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+  s.files = Dir["lib/**/*","spec/**/*","*.gemspec","*.md","CONTRIBUTORS","Gemfile","LICENSE","NOTICE.TXT", "vendor/jar-dependencies/**/*.jar", "vendor/jar-dependencies/**/*.rb", "VERSION", "docs/**/*"]
 
   # Tests
   s.test_files = s.files.grep(%r{^(test|spec|features)/})

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-codec-nmap
 version: !ruby/object:Gem::Version
-  version: 0.0.18
+  version: 0.0.19
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-03-23 00:00:00.000000000 Z
+date: 2017-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -69,6 +69,7 @@ files:
 - LICENSE
 - NOTICE.TXT
 - README.md
+- docs/index.asciidoc
 - lib/logstash/codecs/nmap.rb
 - logstash-codec-nmap.gemspec
 - spec/codecs/nmap_spec.rb