lp_token_auth 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9ad11f1250f5fe138d57dd234bd1be887dd681c180c9c845fa47e2e105bd523
-  data.tar.gz: ca8ceee02fcb2a82bf8f8674aa2f512178ff8b4c1803dd436eaa295ea3b94e3b
+  metadata.gz: 2c5a44184f3818f726afe249a92143dba06368c7508cfc5222c5a059c8939e6a
+  data.tar.gz: e851130aae59a29bce8ca48eb06b51e125dfc25a5f8b6bc70b3bdc8da86febff
 SHA512:
-  metadata.gz: ce31eea46cef645deeef72b92dce9b26844f407edc87190304bdd2eb39dfcbc39d0fc3b6fa69149df591c345c5aee06254facabd433aa63202a0e1435f4fa710
-  data.tar.gz: 84f50dca0334a2fb83a9efa1a93145fffe5e544a83cde1d24bec7e8d3ecb2a6f5d307755d10e3d598c82a1a069bdc33e09ac3de764f1b10d43e264605d3d647e
+  metadata.gz: 2b1af69f83a7d68fde624f8a87758b9d121b2c495f4a822126c7282c8fe7aaac681d4aab490314a42438ce6df66c216440c68c0e9932f12e104b8c2bd605083f
+  data.tar.gz: b947a6fe791ea47faf708419eacb4fdadcd688f8c16c33b11a8bb9c25eab2296ae98f515bb624135092ed76f64eed9ff0de692c5f3c21a2c3cb7ba7cbb18ab2d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lp_token_auth (2.0.0)
+    lp_token_auth (2.1.0)
       jwe (~> 0.4.0)
       jwt (>= 1.5.6)
 
@@ -13,7 +13,7 @@ GEM
     docile (1.1.5)
     json (2.5.1)
     jwe (0.4.0)
-    jwt (2.2.3)
+    jwt (2.3.0)
     minitest (5.14.4)
     rake (12.3.3)
     simplecov (0.13.0)

data/README.md

@@ -48,7 +48,7 @@ Or install it yourself as:
 3. All errors will return an instance of `LpTokenAuth::Error`
 
 ## Migration Guide
-[Migration Guide](https://github.com/LaunchPadLab/lp_token_auth/blob/master/migration-guide.md)
+Version 2.0 contains breaking changes for LP Token Auth. This migration guide contains instructions for using v2.0. [Migration Guide](https://github.com/LaunchPadLab/lp_token_auth/blob/master/migration-guide.md)
 
 ## Examples
 ### Controller

data/lib/generators/lp_token_auth/templates/initializer.rb.erb

@@ -19,4 +19,14 @@ LpTokenAuth.config do |config|
   # default: [:cookie]
   #
   config.token_transport = [:cookie]
+
+  # Where to find the required JWE_PRIVATE_KEY value
+  # default: ENV['JWE_PRIVATE_KEY']
+  #
+  config.jwe_private_key = ENV['JWE_PRIVATE_KEY']
+
+  # The JWE encryption algorithm to use
+  # default: 'A256GCM'
+  #
+  config.jwe_encryption = 'A256GCM'
 end

data/lib/lp_token_auth/config.rb

@@ -9,13 +9,18 @@ module LpTokenAuth
     # * `expires` is an integer corresponding to the number of hours that the token is active
     # * `secret` is a string corresponding to the secret key used when encrypting the token
     # * `token_transport` is a string indicating where to include the token in the HTTP response
-    attr_accessor :algorithm, :expires, :secret, :token_transport
+    attr_accessor :algorithm, :expires, :secret, :token_transport, :jwe_private_key, :jwe_encryption
 
     # Provides default values to token options
+    # ENV defaults defined as procs to ensure they return their
+    # latest value at call time (else they return nil,
+    # since ENV values may not be initialized before gem code)
     DEFAULT_VALUES = {
       algorithm: 'HS512',
       expires: (7 * 24),
       token_transport: [:cookie],
+      jwe_private_key: -> { ENV['JWE_PRIVATE_KEY'] },
+      jwe_encryption: -> { ENV['JWE_ENCRYPTION'] || 'A256GCM' }
     }
 
     # Retrieves value for token option, either as set by the application, or the default
@@ -23,9 +28,17 @@ module LpTokenAuth
     # @raise [LpTokenAuth::Error] if the option has not been set by the application and a default value does not exist
     # @return [String,Integer] the value of the token option
     def get_option(key)
-      option = send(key) || DEFAULT_VALUES[key]
-      raise LpTokenAuth::Error "Missing config option value: #{ key }" unless option
+      option = send(key) || get_default_value(key)
+      raise LpTokenAuth::Error, "Missing config option value: #{key}" unless option
       option
     end
+
+    # Retrieves default value for a token option
+    # @param [Symbol] key the token option name
+    # @return [String,Integer] the value of the token option
+    def get_default_value(key)
+      default = DEFAULT_VALUES[key]
+      default.is_a?(Proc) ? default.call : default
+    end
   end
 end

data/lib/lp_token_auth/core.rb

@@ -28,7 +28,7 @@ module LpTokenAuth
         LpTokenAuth.config.get_option(:algorithm)
       )
 
-      JWE.encrypt(jwt, private_key, enc: ENV['JWE_ENCRYPTION'] || 'A256GCM')
+      JWE.encrypt(jwt, private_key, enc: LpTokenAuth.config.get_option(:jwe_encryption))
     end
 
     # Decodes the JWT token
@@ -64,11 +64,12 @@ module LpTokenAuth
     private
 
     def private_key
-        raise LpTokenAuth::Error, 'You do not have a private key.' if ENV['JWE_PRIVATE_KEY'].nil?
-        
-        OpenSSL::PKey::RSA.new(ENV['JWE_PRIVATE_KEY'].split("\\n").join("\n"))
-      rescue OpenSSL::PKey::RSAError => msg
-        raise LpTokenAuth::Error, 'Your private key is formatted incorrectly.'
+      key = LpTokenAuth.config.get_option(:jwe_private_key)
+      raise LpTokenAuth::Error, 'You do not have a private key.' if key.nil?
+
+      OpenSSL::PKey::RSA.new(key.split("\\n").join("\n"))
+    rescue OpenSSL::PKey::RSAError => msg
+      raise LpTokenAuth::Error, 'Your private key is formatted incorrectly.'
     end
   end
 end

data/lib/lp_token_auth/version.rb

@@ -1,4 +1,4 @@
 module LpTokenAuth
   # Current version of LpTokenAuth
-  VERSION = '2.0.0'.freeze
+  VERSION = '2.1.0'.freeze
 end

data/migration-guide.md

@@ -13,8 +13,16 @@ This version contains the following breaking changes:
    `JWE_PRIVATE_KEY` contains an RSA key.
    `JWE_ENCRYPTION` is optional and specifies the encryption used. The default encryption is `A256GCM`.
 
-The RSA key is generated by running `bundle exec rails generate lp_token_auth:rsa`. This rake task will output a formatted RSA key to your console.
+Values for the new settings can alternatively be configured within your LpTokenAuth initializer by setting `LpTokenAuth.config.jwe_private_key` and `LpTokenAuth.config.jwe_encryption`. For example, apps using Rails credentials can set the private key as follows (or point to an ENV variable with a name other than `JWE_PRIVATE_KEY`)
+```
+LpTokenAuth.config.jwe_private_key = Rails.application.credentials[:jwe_private_key] || ENV['SOME_OTHER_ENV_VARIABLE']
+```
+The RSA key is generated by running `rails generate lp_token_auth:rsa` in the terminal of your application. This generator will output a formatted RSA key to your console. Directly copy and paste this token as an environment variable with a key of `JWE_PRIVATE_KEY`.
 
 **Common Pitfalls in Copy and Pasting RSA Keys**
-The generated RSA key is formatted as a string on a single line with newline characters (\n) at the end of each line. Commonly, there are errors in copy and pasting a string without explicit newline characters. The single line string with newline characters included should avoid most of these errors.
-Please keep in mind this is for the most common use case of using the `JWE_PRIVATE_KEY` in the `.env.[environment]` file. If you are encountering an error during your migration, consider the format of your RSA string.
+
+The generated RSA key is formatted as a string on a single line with newline characters (\n) at the end of each line. Commonly, there are errors in copy and pasting a string without explicit newline characters.
+
+Please keep in mind this is for the most common use case of using the `JWE_PRIVATE_KEY` in the `.env.[environment]` file. If you are encountering an error during your migration, consider the format of your RSA string.
+
+Be sure to include the `-----BEGIN RSA PRIVATE KEY-----` and `-----END RSA PRIVATE KEY-----` portions of the generated string.

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: lp_token_auth
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Dave Corwin
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
 date: 2017-02-03 00:00:00.000000000 Z
@@ -108,7 +108,7 @@ homepage: https://github.com/launchpadlab/lp_token_auth
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -123,8 +123,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.17
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: Auth!
 test_files: []