logstash-filter-empowclassifier 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74937d8d6662e3b4b2f2823984b751fd8b51446901c591af25b782e8e619c61d
-  data.tar.gz: 892c0f3f8f7c1a253b96d4fb52f6c8c752dfdbebf939f8d7ec3f99f46f1ac122
+  metadata.gz: d2c7138d69ebbe84d65be86b8c7eceac98ca6a786480d6b3ab7b73735351723d
+  data.tar.gz: b2b579f47338fe34b6c1b8509ed5e137852c6c63d87cd19a8c4456dfea73914b
 SHA512:
-  metadata.gz: 7b37175bd121abb10e9a2904592b3d008b0c4217ee21c7750b8247a5622a74142159fb5363245d06330cd49d824301ed9b2b9a60d76bc6a0d2b6cb2232144091
-  data.tar.gz: 4827236e9939d9fdb4ef7ed6f5f667f0ce832a6b7e0c443bb8a122d27de5afa0f001605cef232f507623f46780decdf61c2b5d14b3e4d5afeb44df37118340ea
+  metadata.gz: 3aa136befd495d8ff94b1df6cf290a437979e03b3a0354caf4ba54ca032d175b230d1d6c22e7da89c1af49c26032065703fceb87c648a92a9f8896e98d0de494
+  data.tar.gz: 7762647e4d646869da4da89b303dcaf23465292b59db63fad59a0f2d95088ba2f744ad5c36d2affe6dbb73420bb8c9e4af371029e44a480b54f7a42e855b37cd

data/README.md

@@ -6,85 +6,59 @@ It is fully free and fully open source. The license is Apache 2.0, meaning you a
 
 <a href="https://badge.fury.io/rb/logstash-filter-empowclassifier"><img src="https://badge.fury.io/rb/logstash-filter-empowclassifier.svg" alt="Gem Version" height="18"></a>
 
-## Documentation
+# Using the empowclassifier plugin
 
-Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elastic.co/guide/en/logstash/current/).
-
-- For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
-- For more asciidoc formatting tips, see the excellent reference here https://github.com/elastic/docs#asciidoc-guide
-
-## Need Help?
-
-Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
-
-## Developing
-
-### 1. Plugin Developement and Testing
-
-#### Code
-- To get started, you'll need JRuby with the Bundler gem installed.
-
-- Create a new plugin or clone and existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization. We also provide [example plugins](https://github.com/logstash-plugins?query=example).
-
-- Install dependencies
-```sh
-bundle install
+## Example
+A log may look like this before the classification (in json form):
 ```
-
-#### Test
-
-- Update your dependencies
-
-```sh
-bundle install
+{
+	"product_type": "IDS",
+	"product_name": "snort",
+	"threat": { "signature": "1:234" }
+}
 ```
 
-- Run tests
-
-```sh
-bundle exec rspec
+After filtering, using the plugin, the response would be contain these fields:
 ```
+{
+    "signatureTactics": [
+        {
+            "tactic": "Full compromise - active patterns",
+            "attackStage": "Infiltration",
+            "isSrcPerformer": true
+        }
+    ]
+}
+```
+signatureTactics is an array of the tactics classified by empow.
 
-### 2. Running your unpublished Plugin in Logstash
-
-#### 2.1 Run in a local Logstash clone
+each result contains the actual tactic, the attack stage empow classified for this log (determined by the tactic and whether the source and dest are within the user’s network), and whether the source was the performer or the victim of this attack.
 
-- Edit Logstash `Gemfile` and add the local plugin path, for example:
-```ruby
-gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
-```
-- Install plugin
-```sh
-bin/logstash-plugin install --no-verify
-```
-- Run Logstash with your plugin
+## Installing the plugin
 ```sh
-bin/logstash -e 'filter {awesome {}}'
+bin/logstash-plugin install logstash-filter-empowclassifier
 ```
-At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
-
-#### 2.2 Run in an installed Logstash
-
-You can use the same **2.1** method to run your plugin in an installed Logstash by editing its `Gemfile` and pointing the `:path` to your local plugin development directory or you can build the gem and install it using:
 
-- Build your plugin gem
-```sh
-gem build logstash-filter-awesome.gemspec
+## Usage
 ```
-- Install the plugin from the Logstash home
-```sh
-bin/logstash-plugin install /your/local/plugin/logstash-filter-awesome.gem
+input {
+  ...
+}
+
+filter {
+  empowclassifier {
+    username => "cosmo@kramerica.com"
+    password => "12345"
+  }
+}
+
+output {
+  ...
+}
 ```
-- Start Logstash and proceed to test the plugin
-
-## Contributing
 
-All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
 
-Programming is not a required skill. Whatever you've seen about open source and maintainers or community members  saying "send patches or die" - you will not see that here.
 
-It is more important to the community that you are able to contribute.
 
-For more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md) file.
 
 I like rice. Rice is great if you're hungry and want 2000 of something.

data/lib/logstash/filters/empowclassifier.rb

@@ -100,8 +100,8 @@ class LogStash::Filters::EmpowClassifier < LogStash::Filters::Base
   ###############
   config :tag_on_product_type_failure, :validate => :array, :default => ['_empow_no_product_type']
   config :tag_on_signature_failure, :validate => :array, :default => ['_empow_no_signature']
-  config :tag_on_timeout, :validate => :array, :default => ['_empow_classifer_timeout']
-  config :tag_on_error, :validate => :array, :default => ['_empow_classifer_error']
+  config :tag_on_timeout, :validate => :array, :default => ['_empow_classifier_timeout']
+  config :tag_on_error, :validate => :array, :default => ['_empow_classifier_error']
 
   CLASSIFICATION_URL = 'https://intent.cloud.empow.co'
   CACHE_TTL = (24*60*60)
@@ -227,4 +227,4 @@ class LogStash::Filters::EmpowClassifier < LogStash::Filters::Base
 
     return nil
   end
-end
+end

data/logstash-filter-empowclassifier.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'logstash-filter-empowclassifier'
-  s.version       = '1.0.0'
+  s.version       = '1.0.1'
   s.licenses      = ['Apache-2.0']
   s.summary       = 'Returns classification information for attacks from the empow classification center, based on information in log strings'
   #s.description   = 'Write a longer description or delete this line.'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-empowclassifier
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - empow
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-02-13 00:00:00.000000000 Z
+date: 2019-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement