logstash-filter-jwt_decode 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 89c50db2aed9a821e7933d0530b5a157deb3e4989be3db0c884d05c232f46f9d
+  data.tar.gz: ae627c8231e5425e2e1bb50fb9bbc6f17327def0044f3b879c72b8bfaa81fa4d
+SHA512:
+  metadata.gz: d538725cb6c65bc8e6c0c1eaad856e15102891af1e2a3ab82ec31c23e4c57fe366ea502d505b26f760ebafb76dbc147352d222ee832c4a9e7a01b3d0146b753e
+  data.tar.gz: 708ba7836cf32b1526235baf6d2c84e3d11410c4fd3f919be6df18b6e33fe3b96249aeb6707e4fc1d5ac1a55e806cf603ae2b252cfd8b1f951a7fa88f70bb132

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.1.0
+  - Plugin created with the logstash plugin generator

data/CONTRIBUTORS

@@ -0,0 +1,10 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+* Bharat Raj Arutla - bharatraj.arutla@gmail.com
+
+Note: If you've sent us patches, bug reports, or otherwise contributed to
+Logstash, and you aren't on the list above and want to be, please let us know
+and we'll make sure you're here. Contributions from folks like you are what make
+open source awesome.

data/DEVELOPER.md

@@ -0,0 +1,2 @@
+# logstash-filter-jwt_decode
+Example filter plugin. This should help bootstrap your effort to write your own filter plugin!

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gemspec
+

data/LICENSE

@@ -0,0 +1,11 @@
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,86 @@
+# Logstash Plugin
+
+This is a plugin for [Logstash](https://github.com/elastic/logstash).
+
+It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
+
+## Documentation
+
+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
+```
+
+#### Test
+
+- Update your dependencies
+
+```sh
+bundle install
+```
+
+- Run tests
+
+```sh
+bundle exec rspec
+```
+
+### 2. Running your unpublished Plugin in Logstash
+
+#### 2.1 Run in a local Logstash clone
+
+- 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
+```sh
+bin/logstash -e 'filter {awesome {}}'
+```
+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
+```
+- Install the plugin from the Logstash home
+```sh
+bin/logstash-plugin install /your/local/plugin/logstash-filter-awesome.gem
+```
+- 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.

data/lib/logstash/filters/jwt_decode.rb

@@ -0,0 +1,86 @@
+# encoding: utf-8
+require "logstash/filters/base"
+require "logstash/namespace"
+require "jwt"
+
+# This  filter will decode the jwt token in your message event and retrievs the values
+# as specified in `extract_fields` and adds the extracted values to the event.
+#
+# It is only intended to be used as an .
+class LogStash::Filters::JWTDecode < LogStash::Filters::Base
+
+  # Setting the config_name here is required. This is how you
+  # configure this filter from your Logstash config.
+  #
+  # jwt_decode {
+  #    "match" => "token",
+  #    "extract_fields" => {"user_id" => "user.id"}
+  # }    
+  #   
+  # Incase if there is any error during decoding, populates
+  # `JWT_PARSER_ERROR` in the event with the corresponding error
+  #
+  config_name "jwt_decode"
+
+  # Looks for a match in message which contains the token field
+  config :match, :validate => :string, :required => true
+  # Valid algorithms are defined here https://tools.ietf.org/html/rfc7518#section-3.1
+  config :signature_alg, :validate => :string, :required => false, :default => "HS256"
+  config :key, :validate => :string, :required => false, :default => nil
+  config :extract_fields, :validate => :hash, :required => true
+
+
+  public
+  def register
+    # Add instance variables
+    if @key && !@signature_alg
+      raise LogStash::ConfigurationError, "signature_alg has to be specified if key is present "
+    end  
+  end # def register
+
+  public
+  def filter(event)
+    begin 
+      if not @key
+        decoded_token = JWT.decode event.get(@match), nil, false
+      else
+        decoded_token = JWT.decode event.get(@match), @key, true, {algorithm: @signature_alg}    
+      end
+
+      @extract_fields.each do |k, v| 
+        event.set(k , getValueFromDecodedToken(v, decoded_token[0]))
+      end
+    rescue JWT::ExpiredSignature
+      event.set("JWT_PARSER_ERROR","ExpiredSignature")
+    rescue JWT::VerificationError
+      event.set("JWT_PARSER_ERROR","VerificationError")  
+    rescue JWT::ImmatureSignature
+      event.set("JWT_PARSER_ERROR","ImmatureSignature")
+    rescue JWT::InvalidIssuerError
+      event.set("JWT_PARSER_ERROR","InvalidIssuerError")
+    rescue JWT::InvalidAudError
+      event.set("JWT_PARSER_ERROR","InvalidAudError")
+    rescue JWT::InvalidJtiError
+      event.set("JWT_PARSER_ERROR","InvalidJtiError")
+    rescue JWT::InvalidIatError
+      event.set("JWT_PARSER_ERROR","InvalidIatError")
+    rescue JWT::InvalidSubError
+      event.set("JWT_PARSER_ERROR","InvalidSubError")
+    rescue JWT::DecodeError  
+      event.set("JWT_PARSER_ERROR","DecodeError")
+    end  
+    # filter_matched should go in the last line of our successful code
+    filter_matched(event)
+  end # def filter
+
+  private
+  def getValueFromDecodedToken(key, decoded_token)
+    key.split(".").each do |val, index| 
+          if decoded_token.nil?
+            return nil 
+          end 
+          decoded_token = decoded_token[val]
+    end
+    return decoded_token;   
+  end
+end # class LogStash::Filters::jwt_decode

data/logstash-filter-jwt_decode.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |s|
+  s.name          = 'logstash-filter-jwt_decode'
+  s.version       = '1.0.0'
+  s.licenses      = ['Apache-2.0']
+  s.summary       = 'Logstash filter plugin for decoding JSON Web Token (JWT)'
+  s.description   = 'Logstash filter plugin for decoding JSON Web Token (JWT)'
+  s.homepage      = 'https://github.com/bharatraj88/logstash-filter-jwt_decode'
+  s.authors       = ['Bharat Raj Arutla']
+  s.email         = 'bharatraj.arutla@gmail.com'
+  s.require_paths = ['lib']
+
+  # Files
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+   # Tests
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+
+  # Special flag to let us know this is actually a logstash plugin
+  s.metadata = { "logstash_plugin" => "true", "logstash_group" => "filter" }
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core-plugin-api", "~> 2.0"
+  s.add_development_dependency 'logstash-devutils'
+  s.add_runtime_dependency 'jwt',"=1.5.6"
+end

data/spec/filters/jwt_decode_spec.rb

@@ -0,0 +1,89 @@
+# encoding: utf-8
+require_relative '../spec_helper'
+require "logstash/filters/jwt_decode"
+require "jwt"
+
+describe LogStash::Filters::JWTDecode do
+
+  context "Configuration Validations " do
+    describe " No match field" do
+      it "Expect LogStash::ConfigurationError" do
+        expect{
+        filter = setup_filter({
+          "extract_fields" => {"business_id" => "user.busId"}
+        })
+        }.to raise_error(LogStash::ConfigurationError)
+      end
+    end
+
+    describe " No extract_fields" do
+      it "Expect LogStash::ConfigurationError" do
+        expect{
+        filter = setup_filter({
+          "match" => "token"
+        })
+        }.to raise_error(LogStash::ConfigurationError)
+      end
+    end
+
+     describe " No signature_alg defined for key" do
+      it "Expect LogStash::ConfigurationError" do
+        expect{
+        filter = setup_filter({
+          "match" => "token",
+          "extract_fields" => {"name" => "user.name", "id" => "user.id"},
+          "key" => "SECRET",
+          "signature_alg"=> nil
+        })
+        }.to raise_error(LogStash::ConfigurationError)
+      end
+    end
+
+    describe " Invalid Key" do
+      it "Expect VerificationError" do
+        filter = setup_filter({
+          "match" => "token",
+          "extract_fields" => {"name" => "user.name", "id" => "user.id"},
+          "key" => "SECRET123",
+          "signature_alg"=>"HS256"
+        })
+        event = start_event({"token" => "eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyIjp7Im5hbWUiOiJ0ZXN0TmFtZSIsImlkIjo0fX0.5fs1Ghwm9rtN2GaB66bhTLbYrEAuBxh4s46uOyX6Zos"})
+        filter.filter(event)
+        expect(event.get("JWT_PARSER_ERROR")).to eq("VerificationError")
+      end
+    end
+
+  end
+
+  context "Check Decode token" do
+    describe " Decode token with no key " do
+      it "Decode token with no key" do
+        filter = setup_filter({
+          "match" => "token",
+          "extract_fields" => {"name" => "user.name", "id" => "user.id"}
+        })
+        event = start_event({"token" => "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7Im5hbWUiOiJ0ZXN0TmFtZSIsImlkIjo0fX0.P_GRg4n5J7ka3SQKG308clou9OuyxLxAj6V7kb7NcQQ"})
+        filter.filter(event)
+        expect(event.get("id")).to eq(4)
+        expect(event.get("name")).to eq("testName")
+      end
+    end
+
+    describe " Decode token with key " do
+      it "Decode token with no key" do
+        filter = setup_filter({
+          "match" => "token",
+          "extract_fields" => {"name" => "user.name", "id" => "user.id"},
+          "key" => "SECRET",
+          "signature_alg"=>"HS256"
+        })
+        event = start_event({"token" => "eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyIjp7Im5hbWUiOiJ0ZXN0TmFtZSIsImlkIjo0fX0.5fs1Ghwm9rtN2GaB66bhTLbYrEAuBxh4s46uOyX6Zos"})
+        filter.filter(event)
+        expect(event.get("id")).to eq(4)
+        expect(event.get("name")).to eq("testName")
+      end
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/filters/jwt_decode"
+
+def event(data = {})
+	LogStash::Event.new(data)
+end
+
+def start_event(data = {})
+	event(data)
+end
+
+def setup_filter(config = {})
+	filter = LogStash::Filters::JWTDecode.new(config)
+	filter.register()
+	return filter
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: logstash-filter-jwt_decode
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Bharat Raj Arutla
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2019-07-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  name: logstash-core-plugin-api
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-devutils
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.6
+  name: jwt
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.6
+description: Logstash filter plugin for decoding JSON Web Token (JWT)
+email: bharatraj.arutla@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- README.md
+- lib/logstash/filters/jwt_decode.rb
+- logstash-filter-jwt_decode.gemspec
+- spec/filters/jwt_decode_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/bharatraj88/logstash-filter-jwt_decode
+licenses:
+- Apache-2.0
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: filter
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.7.6
+signing_key:
+specification_version: 4
+summary: Logstash filter plugin for decoding JSON Web Token (JWT)
+test_files:
+- spec/filters/jwt_decode_spec.rb
+- spec/spec_helper.rb