perimeter_x 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a06a83f955ae265238a23df8471c062428cf82ba37612160a439c52af3568e79
-  data.tar.gz: 0eaeb8c8b424a219d155f933494c0baec382b96e707cb7af22e676ea83a1fd4f
+  metadata.gz: d65b91dbf3bdf1829dbfe7b1d44677d86ecde223bc0bd614618d1a9b1a188e84
+  data.tar.gz: 473dc3f4a54232d59c2f89dcc6a1bddbb6a95de0268fddf53cfa28b47e8653d6
 SHA512:
-  metadata.gz: c615587bc9e1203636e0a74284aa9faadd3027dc50056929b4bb8fc2cdd6a86bdc0df10c94f3e262f0f313e518fc0397ac2b0b76669fe3e1b5afc85ad589567d
-  data.tar.gz: 22faae3132f9fce873829a0feec4b8f9bfcda420960a380d40a5101b4dae793969b8225a5376f2937954519a8c8cb1c20eb252fca096af77bff7980d5c223f71
+  metadata.gz: a89194401d9a60cd41fdb524724329bee547285742c218ffd157337203090ab66f4992fed517389868c639fea175a9c3561663b81b2463a9b1f3fb0011391e7b
+  data.tar.gz: 428757d1a7dafc96543a125db63a8a2c7639ba27673f96bd5222b1628bafcd117f26d1fefb8041179f30e89f5ea286454ebbfb897b0d81d54e5be2be24d6fb8e

data/changelog.md

@@ -5,6 +5,17 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [2.1.0] - 2020-09-01
+### Added
+ - Added option to set a different px configuration on each request
+ - Added types validation on configuration fields
+
+### Fixed
+ - New cookie logic for mobile requests
+ - Renamed api_connect_timeout to api_timeout_conncection on default configuration
+ - Removed unsapported configuration fields: max_buffer_len and local_proxy
+ - Send cookie_origin only if there is a cookie
+
 ## [2.0.0] - 2020-07-24
 ### Added
  - Added fields to Block Activity: simulated_block, http_version, http_method, risk_rtt, px_orig_cookie

data/lib/perimeter_x.rb

@@ -11,122 +11,122 @@ require 'perimeterx/internal/perimeter_x_context'
 require 'perimeterx/internal/clients/perimeter_x_activity_client'
 require 'perimeterx/internal/validators/perimeter_x_s2s_validator'
 require 'perimeterx/internal/validators/perimeter_x_cookie_validator'
+require 'perimeterx/internal/exceptions/px_config_exception'
 
 module PxModule
   # Module expose API
-  def px_verify_request
-    px_ctx = PerimeterX.instance.verify(request.env)
-    px_config = PerimeterX.instance.px_config
-    msg_title = 'PxModule[px_verify_request]'
-
-    # In case custom verification handler is in use
-    if px_config.key?(:custom_verification_handler)
-      px_config[:logger].debug("#{msg_title}: custom_verification_handler triggered")
-      return instance_exec(px_ctx, &px_config[:custom_verification_handler])
-    end
+  def px_verify_request(request_config={})    
+    begin
+      px_instance = PerimeterX.new(request_config)
+      px_ctx = px_instance.verify(request.env)
+      px_config = px_instance.px_config
+
+      msg_title = 'PxModule[px_verify_request]'
+
+      # In case custom verification handler is in use
+      if px_config.key?(:custom_verification_handler)
+        px_config[:logger].debug("#{msg_title}: custom_verification_handler triggered")
+        return instance_exec(px_ctx, &px_config[:custom_verification_handler])
+      end
 
-    unless px_ctx.nil? || px_ctx.context[:verified] || (px_config[:module_mode] == PxModule::MONITOR_MODE && !px_ctx.context[:should_bypass_monitor])
-      # In case custom block handler exists (soon to be deprecated)
-      if px_config.key?(:custom_block_handler)
-        px_config[:logger].debug("#{msg_title}: custom_block_handler triggered")
-        px_config[:logger].debug(
-            "#{msg_title}: Please note that custom_block_handler is deprecated. Use custom_verification_handler instead.")
-        return instance_exec(px_ctx, &px_config[:custom_block_handler])
-      else
-        if px_ctx.context[:block_action]== 'rate_limit'
-          px_config[:logger].debug("#{msg_title}: sending rate limit page")
-          response.status = 429
+      unless px_ctx.nil? || px_ctx.context[:verified] || (px_config[:module_mode] == PxModule::MONITOR_MODE && !px_ctx.context[:should_bypass_monitor])
+        # In case custom block handler exists (soon to be deprecated)
+        if px_config.key?(:custom_block_handler)
+          px_config[:logger].debug("#{msg_title}: custom_block_handler triggered")
+          px_config[:logger].debug(
+              "#{msg_title}: Please note that custom_block_handler is deprecated. Use custom_verification_handler instead.")
+          return instance_exec(px_ctx, &px_config[:custom_block_handler])
         else
-          px_config[:logger].debug("#{msg_title}: sending default block page")
-          response.status = 403
-        end
-
-        is_mobile = px_ctx.context[:cookie_origin] == 'header' ? '1' : '0'
-        action = px_ctx.context[:block_action][0,1]
-
-        px_template_object = {
-          block_script: "//#{PxModule::CAPTCHA_HOST}/#{px_config[:app_id]}/captcha.js?a=#{action}&u=#{px_ctx.context[:uuid]}&v=#{px_ctx.context[:vid]}&m=#{is_mobile}",
-          js_client_src: "//#{PxModule::CLIENT_HOST}/#{px_config[:app_id]}/main.min.js"
-        }
-
-        html = PxTemplateFactory.get_template(px_ctx, px_config, px_template_object)
+          if px_ctx.context[:block_action]== 'rate_limit'
+            px_config[:logger].debug("#{msg_title}: sending rate limit page")
+            response.status = 429
+          else
+            px_config[:logger].debug("#{msg_title}: sending default block page")
+            response.status = 403
+          end
 
-        # Web handler
-        if px_ctx.context[:cookie_origin] == 'cookie'
+          is_mobile = px_ctx.context[:cookie_origin] == 'header' ? '1' : '0'
+          action = px_ctx.context[:block_action][0,1]
 
-          accept_header_value = request.headers['accept'] || request.headers['content-type'];
-          is_json_response = px_ctx.context[:block_action] != 'rate_limit' && accept_header_value && accept_header_value.split(',').select {|e| e.downcase.include? 'application/json'}.length > 0;
+          px_template_object = {
+            block_script: "//#{PxModule::CAPTCHA_HOST}/#{px_config[:app_id]}/captcha.js?a=#{action}&u=#{px_ctx.context[:uuid]}&v=#{px_ctx.context[:vid]}&m=#{is_mobile}",
+            js_client_src: "//#{PxModule::CLIENT_HOST}/#{px_config[:app_id]}/main.min.js"
+          }
 
-          if (is_json_response)
-            px_config[:logger].debug("#{msg_title}: advanced blocking response response")
+          html = PxTemplateFactory.get_template(px_ctx, px_config, px_template_object)
+
+          # Web handler
+          if px_ctx.context[:cookie_origin] == 'cookie'
+
+            accept_header_value = request.headers['accept'] || request.headers['content-type'];
+            is_json_response = px_ctx.context[:block_action] != 'rate_limit' && accept_header_value && accept_header_value.split(',').select {|e| e.downcase.include? 'application/json'}.length > 0;
+
+            if (is_json_response)
+              px_config[:logger].debug("#{msg_title}: advanced blocking response response")
+              response.headers['Content-Type'] = 'application/json'
+
+              hash_json = {
+                  :appId => px_config[:app_id],
+                  :jsClientSrc => px_template_object[:js_client_src],
+                  :firstPartyEnabled => false,
+                  :uuid => px_ctx.context[:uuid],
+                  :vid => px_ctx.context[:vid],
+                  :hostUrl => "https://collector-#{px_config[:app_id]}.perimeterx.net",
+                  :blockScript => px_template_object[:block_script],
+              }
+
+              render :json => hash_json
+            else
+              px_config[:logger].debug('#{msg_title}: web block')
+              response.headers['Content-Type'] = 'text/html'
+              render :html => html
+            end
+          else # Mobile SDK
+            px_config[:logger].debug("#{msg_title}: mobile sdk block")
             response.headers['Content-Type'] = 'application/json'
-
             hash_json = {
-                :appId => px_config[:app_id],
-                :jsClientSrc => px_template_object[:js_client_src],
-                :firstPartyEnabled => false,
+                :action => px_ctx.context[:block_action],
                 :uuid => px_ctx.context[:uuid],
                 :vid => px_ctx.context[:vid],
-                :hostUrl => "https://collector-#{px_config[:app_id]}.perimeterx.net",
-                :blockScript => px_template_object[:block_script],
+                :appId => px_config[:app_id],
+                :page => Base64.strict_encode64(html),
+                :collectorUrl => "https://collector-#{px_config[:app_id]}.perimeterx.net"
             }
-
             render :json => hash_json
-          else
-            px_config[:logger].debug('#{msg_title}: web block')
-            response.headers['Content-Type'] = 'text/html'
-            render :html => html
           end
-        else # Mobile SDK
-          px_config[:logger].debug("#{msg_title}: mobile sdk block")
-          response.headers['Content-Type'] = 'application/json'
-          hash_json = {
-              :action => px_ctx.context[:block_action],
-              :uuid => px_ctx.context[:uuid],
-              :vid => px_ctx.context[:vid],
-              :appId => px_config[:app_id],
-              :page => Base64.strict_encode64(html),
-              :collectorUrl => "https://collector-#{px_config[:app_id]}.perimeterx.net"
-          }
-          render :json => hash_json
         end
       end
-    end
 
-    # Request was verified
-    return px_ctx.nil? ? true : px_ctx.context[:verified]
+      # Request was verified
+      return px_ctx.nil? ? true : px_ctx.context[:verified]
+      
+    rescue PxConfigurationException
+      raise
+    rescue Exception => e
+      error_logger = PxLogger.new(true)
+      error_logger.error("#{e.backtrace.first}: #{e.message} (#{e.class})")
+      e.backtrace.drop(1).map {|s| error_logger.error("\t#{s}")}
+      return nil
+    end
   end
 
-  def self.configure(params)
-    @px_instance = PerimeterX.configure(params)
+  def self.configure(basic_config)
+    PerimeterX.set_basic_config(basic_config)
   end
 
 
   # PerimeterX Module
   class PerimeterX
-    @@__instance = nil
-    @@mutex = Mutex.new
 
     attr_reader :px_config
     attr_accessor :px_http_client
     attr_accessor :px_activity_client
 
     #Static methods
-    def self.configure(params)
-      return true if @@__instance
-      @@mutex.synchronize {
-        return @@__instance if @@__instance
-        @@__instance = new(params)
-      }
-      return true
+    def self.set_basic_config(basic_config)
+      Configuration.set_basic_config(basic_config)
     end
 
-    def self.instance
-      return @@__instance if !@@__instance.nil?
-      raise Exception.new('Please initialize perimeter x first')
-    end
-
-
     #Instance Methods
     def verify(env)
       begin
@@ -155,6 +155,9 @@ module PxModule
         # Cookie phase
         cookie_verified, px_ctx = @px_cookie_validator.verify(px_ctx)
         if !cookie_verified
+          if !px_ctx.context[:mobile_error].nil?
+            px_ctx.context[:s2s_call_reason] = "mobile_error_#{px_ctx.context[:mobile_error]}"
+          end
           @px_s2s_validator.verify(px_ctx)
         end
 
@@ -166,8 +169,9 @@ module PxModule
       end
     end
 
-    private def initialize(params)
-      @px_config = Configuration.new(params).configuration
+    def initialize(request_config)
+
+      @px_config = Configuration.new(request_config).configuration
       @logger = @px_config[:logger]
       @px_http_client = PxHttpClient.new(@px_config)
 
@@ -219,6 +223,5 @@ module PxModule
       false
     end
 
-    private_class_method :new
   end
 end

data/lib/perimeterx/configuration.rb

@@ -1,11 +1,13 @@
 require 'perimeterx/utils/px_logger'
 require 'perimeterx/utils/px_constants'
+require 'perimeterx/internal/validators/hash_schema_validator'
 
 module PxModule
   class Configuration
+    @@basic_config = nil
+    @@mutex = Mutex.new
 
     attr_accessor :configuration
-    attr_accessor :PX_DEFAULT
 
     PX_DEFAULT = {
       :app_id                       => nil,
@@ -16,15 +18,13 @@ module PxModule
       :encryption_enabled           => true,
       :blocking_score               => 100,
       :sensitive_headers            => ["http-cookie", "http-cookies"],
-      :api_connect_timeout          => 1,
+      :api_timeout_connection       => 1,
       :api_timeout                  => 1,
-      :max_buffer_len               => 10,
       :send_page_activities         => true,
       :send_block_activities        => true,
       :sdk_name                     => PxModule::SDK_NAME,
       :debug                        => false,
       :module_mode                  => PxModule::MONITOR_MODE,
-      :local_proxy                  => false,
       :sensitive_routes             => [],
       :whitelist_routes             => [],
       :ip_headers                   => [],
@@ -33,9 +33,54 @@ module PxModule
       :risk_cookie_max_iterations   => 5000
     }
 
+    CONFIG_SCHEMA = {
+      :app_id                       => {types: [String], required: true},
+      :cookie_key                   => {types: [String], required: true},
+      :auth_token                   => {types: [String], required: true},
+      :module_enabled               => {types: [FalseClass, TrueClass], required: false},
+      :challenge_enabled            => {types: [FalseClass, TrueClass], required: false},
+      :encryption_enabled           => {types: [FalseClass, TrueClass], required: false},
+      :blocking_score               => {types: [Integer], required: false},
+      :sensitive_headers            => {types: [Array], allowed_element_types: [String], required: false},
+      :api_timeout_connection       => {types: [Integer, Float], required: false},
+      :api_timeout                  => {types: [Integer, Float], required: false},
+      :send_page_activities         => {types: [FalseClass, TrueClass], required: false},
+      :send_block_activities        => {types: [FalseClass, TrueClass], required: false},
+      :sdk_name                     => {types: [String], required: false},
+      :debug                        => {types: [FalseClass, TrueClass], required: false},
+      :module_mode                  => {types: [Integer], required: false},
+      :sensitive_routes             => {types: [Array], allowed_element_types: [String], required: false},
+      :whitelist_routes             => {types: [Array], allowed_element_types: [String, Regexp], required: false},
+      :ip_headers                   => {types: [Array], allowed_element_types: [String], required: false},
+      :ip_header_function           => {types: [Proc], required: false},
+      :bypass_monitor_header        => {types: [FalseClass, TrueClass], required: false},
+      :risk_cookie_max_iterations   => {types: [Integer], required: false},
+      :custom_verification_handler  => {types: [Proc], required: false},
+      :additional_activity_handler  => {types: [Proc], required: false},
+      :custom_logo                  => {types: [String], required: false},
+      :css_ref                      => {types: [String], required: false},
+      :js_ref                       => {types: [String], required: false},
+      :custom_uri                   => {types: [Proc], required: false}
+    }
+
+    def self.set_basic_config(basic_config)
+      if @@basic_config.nil?
+        @@mutex.synchronize {          
+          @@basic_config = PX_DEFAULT.merge(basic_config)
+      }
+      end
+    end
+
     def initialize(params)
-      PX_DEFAULT[:backend_url] = "https://sapi-#{params[:app_id].downcase}.perimeterx.net"
-      @configuration = PX_DEFAULT.merge(params)
+      if ! @@basic_config.is_a?(Hash)
+        raise PxConfigurationException.new('PerimeterX: Please initialize PerimeterX first')
+      end
+      
+      # merge request configuration into the basic configuration
+      @configuration = @@basic_config.merge(params)
+      validate_hash_schema(@configuration, CONFIG_SCHEMA)
+      
+      @configuration[:backend_url] = "https://sapi-#{@configuration[:app_id].downcase}.perimeterx.net"
       @configuration[:logger] = PxLogger.new(@configuration[:debug])
     end
   end

data/lib/perimeterx/internal/clients/perimeter_x_activity_client.rb

@@ -17,8 +17,11 @@ module PxModule
         @px_config[:additional_activity_handler].call(activity_type, px_ctx, details)
       end
 
+      if !px_ctx.context[:px_cookie].empty?
+        details[:cookie_origin] = px_ctx.context[:cookie_origin]
+      end
+
       details[:module_version] = @px_config[:sdk_name]
-      details[:cookie_origin] = px_ctx.context[:cookie_origin]
 
       px_data = {
         :type       => activity_type,

data/lib/perimeterx/internal/exceptions/px_config_exception.rb

@@ -0,0 +1,6 @@
+class PxConfigurationException < StandardError
+    def initialize(msg)
+     super(msg)
+   end
+  end
+  

data/lib/perimeterx/internal/perimeter_x_context.rb

@@ -37,12 +37,16 @@ module PxModule
       if req.headers[PxModule::TOKEN_HEADER]
         @context[:cookie_origin] = 'header'
         token = force_utf8(req.headers[PxModule::TOKEN_HEADER])
-        if token.include? ':'
-          exploded_token = token.split(':', 2)
-          cookie_sym = "v#{exploded_token[0]}".to_sym
-          @context[:px_cookie][cookie_sym] = exploded_token[1]
-        else  # TOKEN_HEADER exists yet there's no ':' delimiter - may indicate an error (storing original value)
-          @context[:px_cookie] = force_utf8(req.headers[PxModule::TOKEN_HEADER])
+        if token.match(PxModule::MOBILE_TOKEN_V3_REGEX)
+          @context[:px_cookie][:v3] = token[2..-1]
+        elsif token.match(PxModule::MOBILE_ERROR_REGEX)
+          @context[:mobile_error] = token
+          if req.headers[PxModule::ORIGINAL_TOKEN_HEADER]
+            token = force_utf8(req.headers[PxModule::ORIGINAL_TOKEN_HEADER])
+            if token.match(PxModule::MOBILE_TOKEN_V3_REGEX)
+              @context[:px_cookie][:v3] = token[2..-1]
+            end
+          end
         end
       elsif !cookies.empty? # Get cookie from jar
         # Prepare hashed cookies

data/lib/perimeterx/internal/validators/hash_schema_validator.rb

@@ -0,0 +1,26 @@
+def validate_hash_schema(hash, schema)
+  hash.each do |key, value|
+    if schema.key?(key) && value != nil
+      # validate value types in hash are according to schema
+      if !schema[key][:types].include?(value.class)
+        raise PxConfigurationException.new("PerimeterX: Type of #{key} should be one of #{schema[key][:types]} but instead is #{value.class}")
+      end
+      
+      # validate arrays elments types are according to schema
+      if value.class == Array
+        value.each do |element|
+          if !schema[key][:allowed_element_types].include?(element.class)
+            raise PxConfigurationException.new("PerimeterX: #{key} may only contain elements of the following types: #{schema[key][:allowed_element_types]} but includes element of type #{element.class}")
+          end
+        end
+      end
+    end
+  end
+
+  # validate required fields exist in hash
+  schema.each do |key, value|
+    if value[:required] && hash[key].nil?
+      raise PxConfigurationException.new("PerimeterX: #{key} configuration is missing")
+    end
+  end
+end

data/lib/perimeterx/internal/validators/perimeter_x_cookie_validator.rb

@@ -18,31 +18,12 @@ module PxModule
 
     def verify(px_ctx)
       begin
-        # Mobile Error cases
-        if px_ctx.context[:cookie_origin] == 'header'
-          if px_ctx.context[:px_cookie].to_s.empty?
-            @logger.warn("PerimeterxCookieValidator:[verify]: Empty token value - decryption failed")
-            px_ctx.context[:s2s_call_reason] = PxModule::COOKIE_DECRYPTION_FAILED
-            return false, px_ctx
-          elsif px_ctx.context[:px_cookie] == "1"
-            @logger.warn("PerimeterxCookieValidator:[verify]: no cookie")
-            px_ctx.context[:s2s_call_reason] = PxModule::NO_COOKIE
-            return false, px_ctx
-          elsif px_ctx.context[:px_cookie] == "2"   # Mobile SDK connection error
-            @logger.warn("PerimeterxCookieValidator:[verify]: mobile sdk connection error")
-            px_ctx.context[:s2s_call_reason] = PxModule::MOBILE_SDK_CONNECTION_ERROR
-            return false, px_ctx
-          elsif px_ctx.context[:px_cookie] == "3"   # Mobile SDK pinning error
-            @logger.warn("PerimeterxCookieValidator:[verify]: mobile sdk pinning error")
-            px_ctx.context[:s2s_call_reason] = PxModule::MOBILE_SDK_PINNING_ERROR
-            return false, px_ctx
-          end
-        elsif px_ctx.context[:px_cookie].empty?
+        if px_ctx.context[:px_cookie].empty?
           @logger.warn("PerimeterxCookieValidator:[verify]: no cookie")
           px_ctx.context[:s2s_call_reason] = PxModule::NO_COOKIE
           return false, px_ctx
         end
-
+        
         # Deserialize cookie start
         cookie = PerimeterxPayload.px_cookie_factory(px_ctx, @px_config)
         if !cookie.deserialize()

data/lib/perimeterx/internal/validators/perimeter_x_s2s_validator.rb

@@ -26,12 +26,22 @@ module PxModule
         :additional => {
           :s2s_call_reason => px_ctx.context[:s2s_call_reason],
           :module_version => @px_config[:sdk_name],
-          :cookie_origin => px_ctx.context[:cookie_origin],
           :http_method => px_ctx.context[:http_method],
           :http_version => px_ctx.context[:http_version],
           :risk_mode => risk_mode
         }
       }
+
+      #Check for cookie_origin
+      if !px_ctx.context[:px_cookie].empty?
+        request_body[:additional][:cookie_origin] = px_ctx.context[:cookie_origin]
+      end
+
+      #Override s2s_call_reason in case of mobile error
+      if !px_ctx.context[:mobile_error].nil?
+        request_body[:additional][:s2s_call_reason] = "mobile_error_#{px_ctx.context[:mobile_error]}"
+      end
+
       #Check for hmac
       @logger.debug("px_ctx cookie_hmac key = #{px_ctx.context.key?(:cookie_hmac)}, value is: #{px_ctx.context[:cookie_hmac]}")
       if px_ctx.context.key?(:cookie_hmac)

data/lib/perimeterx/utils/px_constants.rb

@@ -54,9 +54,10 @@ module PxModule
 
   # Mobile SDK
   TOKEN_HEADER = 'X-PX-AUTHORIZATION'
-  MOBILE_SDK_CONNECTION_ERROR = 'mobile_sdk_connection_error'
-  MOBILE_SDK_PINNING_ERROR = 'mobile_sdk_pinning_error'
+  ORIGINAL_TOKEN_HEADER = 'X-PX-ORIGINAL-TOKEN'
 
   # Regular Expressions
   VID_REGEX = /^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/
+  MOBILE_TOKEN_V3_REGEX = /\A3:(.*)\z/ 
+  MOBILE_ERROR_REGEX = /\A[0-9]\z/           
 end

data/lib/perimeterx/version.rb

@@ -1,3 +1,3 @@
 module PxModule
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
 end

data/readme.md

@@ -1,11 +1,11 @@
 [![Build Status](https://travis-ci.org/PerimeterX/perimeterx-ruby-sdk.svg?branch=master)](https://travis-ci.org/PerimeterX/perimeterx-ruby-sdk)
 
-![image](http://media.marketwire.com/attachments/201604/34215_PerimeterX_logo.jpg)
+![image](https://storage.googleapis.com/perimeterx-logos/primary_logo_red_cropped.png)
 #
 [PerimeterX](http://www.perimeterx.com) Ruby SDK
 =============================================================
 
-> Latest stable version: [v1.3.0](https://rubygems.org/gems/perimeter_x/versions/1.3.0)
+> Latest stable version: [v2.1.0](https://rubygems.org/gems/perimeter_x)
 
 Table of Contents
 -----------------
@@ -30,6 +30,7 @@ Table of Contents
   *   [Monitor Only](#logging)
   *   [Debug Mode](#debug-mode)
   *   [Whitelist Routes](#whitelist-routes)
+  *   [Update Configuration on Runtime](#update-config)
   
   **[Contributing](#contributing)**
 
@@ -308,6 +309,7 @@ Enables debug logging mode to STDOUT
 
 <a name="whitelist-routes"></a>**Whitelist Routes**
 Default: []
+
 An array of route prefixes and/or regular expressions that are always whitelisted and not validated by PerimeterX.
 A string value of a path will be treated as a prefix.
 A regexp value of a path will be treated as is.
@@ -316,6 +318,35 @@ A regexp value of a path will be treated as is.
   params[:whitelist_routes] = ["/example", /\A\/example\z/]
 ```
 
+<a name="update-config"></a>**Update Configuration on Runtime**
+
+As mentioned before, PerimeterX Module should be configured in `<rails_app>/config/initializers/perimeterx.rb`.
+However, it is possible to override configuration options on each request.
+To do so, send the configuration options as an argument when calling to `px_verify_request` as described in the following example.
+Notice that in case of an invalid argument, the module will raise an error. Therefore, when using this feature, make sure to wrap the call to `px_verify_request` with begin and rescue. It is highly recommended to log the error message to follow such errors.
+
+```ruby
+class HomeController < ApplicationController
+  include PxModule
+
+
+  before_action do call_perimeterx_verify_request end
+
+  def call_perimeterx_verify_request
+    params = {
+    :blocking_score => 70,
+    :module_mode => 2
+    }
+    begin
+      px_verify_request(params) 
+    rescue StandardError => e
+      # $stdout.write(e.message)
+    end
+  end
+
+end
+```
+
 <a name="contributing"></a># Contributing #
 ------------------------------
 The following steps are welcome when contributing to our project.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: perimeter_x
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Nitzan Goldfeder
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-26 00:00:00.000000000 Z
+date: 2020-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -171,6 +171,7 @@ files:
 - lib/perimeterx/configuration.rb
 - lib/perimeterx/internal/clients/perimeter_x_activity_client.rb
 - lib/perimeterx/internal/clients/perimeter_x_risk_client.rb
+- lib/perimeterx/internal/exceptions/px_config_exception.rb
 - lib/perimeterx/internal/exceptions/px_cookie_decryption_exception.rb
 - lib/perimeterx/internal/payload/perimeter_x_cookie_v1.rb
 - lib/perimeterx/internal/payload/perimeter_x_cookie_v3.rb
@@ -178,6 +179,7 @@ files:
 - lib/perimeterx/internal/payload/perimeter_x_token_v1.rb
 - lib/perimeterx/internal/payload/perimeter_x_token_v3.rb
 - lib/perimeterx/internal/perimeter_x_context.rb
+- lib/perimeterx/internal/validators/hash_schema_validator.rb
 - lib/perimeterx/internal/validators/perimeter_x_cookie_validator.rb
 - lib/perimeterx/internal/validators/perimeter_x_s2s_validator.rb
 - lib/perimeterx/utils/px_constants.rb