vonage-jwt 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e83f93abf55574d8da1dc73a55e89a17597275911927a9200b3e51be71655e3f
-  data.tar.gz: 4772db0876bc1129f2f038d1ee3d235852e763a8b9f7bf457acdb823acefafc7
+  metadata.gz: ddf304ba0c31efdaf0da2618355b23f5800cb7dd07ed2d19d613e624bd577131
+  data.tar.gz: 1786f96a4dfcad228ee5b6583b0db99806cc545206f5db6eff4832c4fd702ad8
 SHA512:
-  metadata.gz: ee524f8242fe11c48d7ca420bf7d57115f88c6ff0fad19c1b4bd85163ca132b6b7b0e147138e16977ed5ded7c0b89b10291b805f2627e75fcef3e92150ae002c
-  data.tar.gz: e5f64c2947797813e9c450d71f7a9a16fed6f22c515521f026607de0ce7d34807f0e933674c8e035b3301f57c86f023e16a4ae5f92c179bbbca6441cf70c2185
+  metadata.gz: a2ff24275b3b26cb6c47ab9b50c8279ceef69286d1628919f062c29356f936bf35552cf06371727073dfcd959fb699f79b4fa3cdd94e0f7353bca372d945c24e
+  data.tar.gz: eea38e2c24d80c04b75e1ff293ff3110743224cd948f2016c5b6640db7ec4ab7ee5a488e09e1f382e45dd4e69086177ab6359def24e6dc9f6c76eb063f75e630

data/README.md

@@ -27,9 +27,11 @@ Alternatively you can clone the repository:
 
 ## Usage
 
+### Generating a JWT
+
 By default the Vonage JWT generator creates a short lived JWT (15 minutes) per request.
 To generate a long lived JWT for multiple requests, specify a longer value in the `exp`
-parameter during initialization. 
+parameter during initialization.
 
 Example with no custom configuration:
 
@@ -51,10 +53,10 @@ Example providing custom configuration options:
         "/messages": {
           "methods": ["POST", "GET"],
           "filters": {
-            "from": "447977271009"  
-          }     
-        }  
-      }   
+            "from": "447977271009"
+          }
+        }
+      }
     }
   },
   subject: 'My_Custom_Subject'
@@ -62,6 +64,28 @@ Example providing custom configuration options:
 @token = @builder.jwt.generate
 ```
 
+### Decoding a JWT
+
+You can decode a JWT like so:
+
+```ruby
+Vonage::JWT.decode(token, nil, false)
+```
+
+where `token` is the JWT that you want to decode. The `Vonage::JWT::decode` method is essentially just a wrapper around the `ruby-jwt` library method of the same name, and usage is identical to what is [documented for that library](https://github.com/jwt/ruby-jwt#algorithms-and-usage).
+
+### Verifying a Signature
+
+For JWTs that are signed, you can verify a JWT signature like so:
+
+```ruby
+Vonage::JWT.verify_signature(token, signature_secret, algorithm)
+```
+
+where `token` is the signed JWT, `signature_secret` is the secret or key required by whichever algorithm was used to sign the JWT, and `algorithm` is a string indicating the algorithm that was used to sign the JWT (e.g. `'HS256'`, `'RS256'`, etc)
+
+The method will return `true` if the signature is verified and `false` if it is not.
+
 ## Documentation
 
 Vonage Ruby JWT documentation: https://www.rubydoc.info/github/Vonage/vonage-jwt

data/lib/vonage-jwt/jwt.rb

@@ -21,13 +21,26 @@ module Vonage
         iat: iat,
         jti: generator.jti,
         exp: generator.exp || iat + generator.ttl,
-        sub: generator.subject,
         application_id: generator.application_id
       }
       hash.merge!(generator.paths) if generator.paths
+      hash.merge!(sub: generator.subject) if generator.subject
       hash.merge!(nbf: generator.nbf) if generator.nbf
       hash.merge!(generator.additional_claims) if !generator.additional_claims.empty?
       hash
     end
+
+    def self.decode(token, secret = nil, verify = true, opts = {}, &block)
+      ::JWT.decode(token, secret, verify, opts, &block)
+    end
+
+    def self.verify_signature(token, signature_secret, algorithm)
+      begin
+        decode(token, signature_secret, true, {algorithm: algorithm})
+        return true
+      rescue ::JWT::VerificationError
+        return false
+      end
+    end
   end
 end

data/lib/vonage-jwt/jwt_builder.rb

@@ -54,7 +54,7 @@ module Vonage
       @exp = params.fetch(:exp, nil)
       @alg = params.fetch(:alg, 'RS256')
       @paths = params.fetch(:paths, nil)
-      @subject = params.fetch(:subject, 'Subject')
+      @subject = params.fetch(:subject, nil)
       @additional_claims = set_additional_claims(params)
       @jwt = Vonage::JWT.new(generator: self)
 

data/lib/vonage-jwt/version.rb

@@ -2,6 +2,6 @@
 
 module Vonage
   class JWT
-    VERSION = '0.1.2'
+    VERSION = '0.2.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vonage-jwt
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Vonage
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-28 00:00:00.000000000 Z
+date: 2023-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt