jwt_sessions 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d38f64697988a31f87a3e1b4e95910f821a24fc0c35cea614b9d4a72f16a0a5
-  data.tar.gz: 4b1aecccf844e0d7dc4de866c03b9af136b9b422e7e3caf4ffb4138517e6e771
+  metadata.gz: 7740c76d1bba04e91c960b59d8dd248d09adbecbea3359e09e49b9ec82cd4a98
+  data.tar.gz: 43192bbcb08751f07216e84939a2b025239cb13b641c4563567b551626df79ae
 SHA512:
-  metadata.gz: 075e7f3b2dc0ebf798ab8696ad715badb95d0f485dbf6dc62d059055a65283d11e1250db541c7b90249055bc4424946a8bfcfc916d23c4afdb8d06958b1f52f3
-  data.tar.gz: cec03faa24c671b234022742a59689f07c4bd50105a286b03c3b7b1535134c8f95d69c0a29ee47d0d47385590071134d1c82844bdfa6bb2882108b88956f6a47
+  metadata.gz: c96b79c7ba0a8952766d3d5501a34e5877f0f8bcebb9a3210318b42e86eaf3370c15b0a534e980cbb699493633fe2b7652ec1797f8c467a1838e76fdb246530c
+  data.tar.gz: aa1d46b6890bf7d5907ad9a190598c91855db0f90e3f6f5522d4b0390ccc92a797d8977162980a072db8fc0fb9553961683eb59896c1cc7881111fe48413f1e6

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 3.1.0 (February 18, 20222)
+
+Features:
+
+- rename `encryption_key=` to `signing_key=` (keep the alias for backward compatibility)
+
 ## 3.0.1 (December 28, 2022)
 
 Support:

data/README.md

@@ -60,10 +60,10 @@ bundle install
 
 ## Getting Started
 
-You should configure an encryption algorithm and specify the encryption key. By default the gem uses the `HS256` signing algorithm.
+You should configure an algorithm and specify the signing key. By default the gem uses the `HS256` signing algorithm.
 
 ```ruby
-JWTSessions.encryption_key = "secret"
+JWTSessions.signing_key = "secret"
 ```
 
 `Authorization` mixin provides helper methods which are used to retrieve the access and refresh tokens from incoming requests and verify the CSRF token if needed. It assumes that a token can be found either in a cookie or in a header (cookie and header names are configurable). It tries to retrieve the token from headers first and then from cookies (CSRF check included) if the header check fails.
@@ -152,15 +152,15 @@ class ApplicationController < ActionController::API
 end
 ```
 
-Specify an encryption key for JSON Web Tokens in `config/initializers/jwt_session.rb` \
+Specify a signing key for JSON Web Tokens in `config/initializers/jwt_session.rb` \
 It is advisable to store the key itself in a secure way, f.e. within app credentials.
 
 ```ruby
 JWTSessions.algorithm = "HS256"
-JWTSessions.encryption_key = Rails.application.credentials.secret_jwt_encryption_key
+JWTSessions.signing_key = Rails.application.credentials.secret_jwt_signing_key
 ```
 
-Most of the encryption algorithms require private and public keys to sign a token. However, HMAC requires only a single key and you can use the `encryption_key` shortcut to sign the token. For other algorithms you must specify private and public keys separately.
+Most of the algorithms require private and public keys to sign a token. However, HMAC requires only a single key and you can use the `signing_key` shortcut to sign the token. For other algorithms you must specify private and public keys separately.
 
 ```ruby
 JWTSessions.algorithm   = "RS256"
@@ -294,7 +294,7 @@ require "sinatra/base"
 JWTSessions.access_header = "authorization"
 JWTSessions.refresh_header = "x_refresh_token"
 JWTSessions.csrf_header = "x_csrf_token"
-JWTSessions.encryption_key = "secret key"
+JWTSessions.signing_key = "secret key"
 
 class SimpleApp < Sinatra::Base
   include JWTSessions::Authorization
@@ -395,7 +395,7 @@ JWTSessions.algorithm = "HS256"
 You need to specify a secret to use for HMAC as this setting does not have a default value.
 
 ```ruby
-JWTSessions.encryption_key = "secret"
+JWTSessions.signing_key = "secret"
 ```
 
 If you are using another algorithm like RSA/ECDSA/EDDSA you should specify private and public keys.

data/lib/jwt_sessions/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JWTSessions
-  VERSION = "3.0.1"
+  VERSION = "3.1.0"
 end

data/lib/jwt_sessions.rb

@@ -121,10 +121,12 @@ module JWTSessions
   end
 
   # should be used for hmac only
-  def encryption_key=(key)
+  def signing_key=(key)
     @public_key  = key
     @private_key = key
   end
+  # alias for backward compatibility
+  alias encryption_key= signing_key=
 
   def access_expiration
     Time.now.to_i + access_exp_time.to_i

data/test/units/jwt_sessions/test_access_token.rb

@@ -7,7 +7,7 @@ class TestAccessToken < Minitest::Test
    attr_reader :access_token, :uid
 
   def setup
-    JWTSessions.encryption_key = "secret key"
+    JWTSessions.signing_key = "secret key"
     @payload = { user_id: 1 }
     @csrf = JWTSessions::CSRFToken.new
     @uid = SecureRandom.uuid

data/test/units/jwt_sessions/test_refresh_token.rb

@@ -9,7 +9,7 @@ class TestRefreshToken < Minitest::Test
   def setup
     JWTSessions::Session.flush_all
 
-    JWTSessions.encryption_key = "secure encryption"
+    JWTSessions.signing_key = "secure key"
     @access_uid = SecureRandom.uuid
     @csrf = JWTSessions::CSRFToken.new
     @token = JWTSessions::RefreshToken.create(@csrf.encoded,

data/test/units/jwt_sessions/test_session.rb

@@ -9,7 +9,7 @@ class TestSession < Minitest::Test
   REFRESH_KEYS = %i[access access_expires_at csrf].freeze
 
   def setup
-    JWTSessions.encryption_key = "encrypted"
+    JWTSessions.signing_key = "security"
     @payload = { test: "secret" }
     @session = JWTSessions::Session.new(payload: payload)
     @tokens = session.login

data/test/units/jwt_sessions/test_token.rb

@@ -19,7 +19,7 @@ class TestToken < Minitest::Test
 
   def setup
     @payload = { "user_id" => 1, "secret" => "mystery" }
-    JWTSessions.encryption_key = "abcdefghijklmnopqrstuvwxyzABCDEF"
+    JWTSessions.signing_key = "abcdefghijklmnopqrstuvwxyzABCDEF"
   end
 
   def teardown
@@ -70,7 +70,7 @@ class TestToken < Minitest::Test
   end
 
   def test_hmac_token_decode
-    JWTSessions.encryption_key = "abcdefghijklmnopqrstuvwxyzABCDEF"
+    JWTSessions.signing_key = "abcdefghijklmnopqrstuvwxyzABCDEF"
     token   = JWTSessions::Token.encode(payload)
     decoded = JWTSessions::Token.decode(token).first
     assert_equal payload["user_id"], decoded["user_id"]
@@ -78,7 +78,7 @@ class TestToken < Minitest::Test
   end
 
   def test_token_sub_claim
-    JWTSessions.encryption_key = "abcdefghijklmnopqrstuvwxyzABCDEF"
+    JWTSessions.signing_key = "abcdefghijklmnopqrstuvwxyzABCDEF"
     JWTSessions.jwt_options[:verify_sub] = true
     token   = JWTSessions::Token.encode(payload.merge(sub: "subject"))
     decoded = JWTSessions::Token.decode(token, { sub: "subject" }).first
@@ -90,7 +90,7 @@ class TestToken < Minitest::Test
   end
 
   def test_token_iss_claim
-    JWTSessions.encryption_key = "abcdefghijklmnopqrstuvwxyzABCDEF"
+    JWTSessions.signing_key = "abcdefghijklmnopqrstuvwxyzABCDEF"
     JWTSessions.jwt_options[:verify_iss] = true
     token   = JWTSessions::Token.encode(payload.merge(iss: "Me"))
     decoded = JWTSessions::Token.decode(token, { iss: "Me" }).first
@@ -102,7 +102,7 @@ class TestToken < Minitest::Test
   end
 
   def test_token_aud_claim
-    JWTSessions.encryption_key = "abcdefghijklmnopqrstuvwxyzABCDEF"
+    JWTSessions.signing_key = "abcdefghijklmnopqrstuvwxyzABCDEF"
     JWTSessions.jwt_options[:verify_aud] = true
     token   = JWTSessions::Token.encode(payload.merge(aud: ["young", "old"]))
     decoded = JWTSessions::Token.decode(token, { aud: ["young"] }).first
@@ -114,7 +114,7 @@ class TestToken < Minitest::Test
   end
 
   def test_token_leeway_decode
-    JWTSessions.encryption_key = "abcdefghijklmnopqrstuvwxyzABCDEF"
+    JWTSessions.signing_key = "abcdefghijklmnopqrstuvwxyzABCDEF"
     JWTSessions.jwt_options[:leeway] = 50
     token   = JWTSessions::Token.encode(payload.merge("exp" => Time.now.to_i - 20))
     decoded = JWTSessions::Token.decode(token).first

data/test/units/test_jwt_sessions.rb

@@ -18,7 +18,7 @@ class TestJWTSessions < Minitest::Test
     assert_equal JWTSessions::DEFAULT_CSRF_HEADER, JWTSessions.csrf_header
   end
 
-  def test_encryption_key
+  def test_signing_key
     JWTSessions.encryption_key = nil
     assert_raises JWTSessions::Errors::Malconfigured do
       JWTSessions.private_key

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jwt_sessions
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.1.0
 platform: ruby
 authors:
-- Yulia Oletskaya
+- Julija Alieckaja
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-28 00:00:00.000000000 Z
+date: 2023-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -127,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: JWT Sessions