logstash-filter-jwt-decode 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94b7495aae39a0ee8b0719922256ca9f697ad46c198a77737c2006d9c143a89b
-  data.tar.gz: 86be2b917a8af634572f4c844592cf24f42b5bf520e2d6290407d4e500dc0377
+  metadata.gz: f204b3f7b98a56ffcf869f9b9f9ec0ec8329d5dfc70aae81372c835ddc6c1eb9
+  data.tar.gz: 877e39c40ea6565d6dedb8e5ee3ba51de09ea7c0bb4074be03183e2d359e5978
 SHA512:
-  metadata.gz: 51a42eff24bf245dec14d6cff741f6b2a1c9de9d85480c30791f2d26b3a89c648409108a6d50a056fabc6435dc2fca48922035a8aed63ad2a53e345d5b76ad10
-  data.tar.gz: 6fad7d27efc836d57a2de63bc7745e2f652a93835d618980c9daf841204c03dd4061d2edd136f848bb93482e98c12c4f6d167a1b9ced41fcd833d7e75e0f2246
+  metadata.gz: b88f101fc8280b2ff14e67bdf2ff4f1d23ca599533b311b7df77d45f4b2a18b04f1f1edd75db825545a4991e958b92e3421462aefb2d4bbc12d145b12bdc55fc
+  data.tar.gz: 0a2be8e2d27244a20a31c994d35a3c6861159f383b0bfb98d53e9dcc653e83b83f13feb21373d4955172a8b3a351bfdc0bc3fe401798b09440b0c1700f45edeb

data/CONTRIBUTORS

@@ -2,7 +2,7 @@ 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 - v-bharat.a@turvo.com
+* 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

data/lib/logstash/filters/jwt-decode.rb

@@ -13,7 +13,7 @@ class LogStash::Filters::JWTDecode < LogStash::Filters::Base
   #
   # jwt-decode {
   #    "match" => "token",
-  #    "extract_fields" => {"business_id" => "user.busId"}
+  #    "extract_fields" => {"user_id" => "user.id"}
   # }    
   #   
   # 
@@ -22,8 +22,8 @@ class LogStash::Filters::JWTDecode < LogStash::Filters::Base
 
   # Looks for a match in message which contains the token field
   config :match, :validate => :string, :required => true
-  # Supported Algorithms NONE, HMAC, RSASSA and ECDSA
-  config :signature_alg, :validate => :string, :required => false, :default => "NONE"
+  # 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
 
@@ -31,14 +31,19 @@ class LogStash::Filters::JWTDecode < LogStash::Filters::Base
   public
   def register
     # Add instance variables
-    if not ['NONE', 'HMAC', 'RSASSA', 'ECDSA'].include? @signature_alg
-      raise LogStash::ConfigurationError, "JWTDecode plugin: Invalid signature_alg '#{@signature_alg}' must be one of NONE, HMAC, RSASSA and ECDSA"
+    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)
-    decoded_token = JWT.decode event.get(@match), @key, false, {algorithm: @signature_alg}    
+    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

data/logstash-filter-jwt-decode.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'logstash-filter-jwt-decode'
-  s.version       = '0.1.0'
+  s.version       = '0.1.1'
   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)'

data/spec/filters/jwt-filter_spec.rb

@@ -1,19 +1,90 @@
 # 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 JWT::VerificationError" do
+        expect{
+        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)
+        }.to raise_error(JWT::VerificationError)
+      end
+    end
+
+  end
+
   context "Check Decode token" do
-    describe " registering filter with all params" do
-      it "Get business from Token" do
+    describe " Decode token with no key " do
+      it "Decode token with no key" do
         filter = setup_filter({
           "match" => "token",
-          "extract_fields" => {"business_id" => "user.busId"}
+          "extract_fields" => {"name" => "user.name", "id" => "user.id"}
         })
-        event = start_event({"token" => "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7InVzZXJuYW1lIjoidGVzdEB0dXJ2by5jb20iLCJjbGllbnRJZCI6Im1hZ2VsbGFuLXdzIiwiYnVzSWQiOjQsImJ1c05hbWUiOiJUZXN0IiwibG9naW5CeUlkIjo3LCJsb2dpbkJ5TmFtZSI6IlRlc3QgVXNlciAgICIsInVzZXJUaW1lem9uZSI6IkFtZXJpY2EvTG9zX0FuZ2VsZXMiLCJidXNUaW1lem9uZSI6IkFtZXJpY2EvTG9zX0FuZ2VsZXMiLCJ0eXBlIjoiQlVTVVNFUiIsImFkbWluIjpmYWxzZSwiZGV2aWNlSWQiOm51bGwsInNjb3BlIjoicmVhZCx3cml0ZSIsImF1dGhvcml6ZWRHcmFudFR5cGVzIjpudWxsLCJyZXNvdXJjZUlkcyI6InJlc291cmNlLWNvcmUifX0.3weaxgRD5qRTUaazA5DWO7t5WoAJB8jghDMjJF9mWew"})
+        event = start_event({"token" => "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7Im5hbWUiOiJ0ZXN0TmFtZSIsImlkIjo0fX0.P_GRg4n5J7ka3SQKG308clou9OuyxLxAj6V7kb7NcQQ"})
         filter.filter(event)
-        expect(event.get("business_id")).to eq(4)
+        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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-jwt-decode
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Bharat Raj Arutla
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-05-24 00:00:00.000000000 Z
+date: 2019-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement