perimeter_x 1.0.4.pre.alpha → 1.0.4

data/readme.md

@@ -10,6 +10,20 @@ Table of Contents
   *   [Installation](#installation)
   *   [Basic Usage Example](#basic-usage)
 -   [Configuration](#configuration)
+  *   [Configuring Required Parameters](#requireied-params)
+  *   [Blocking Score](#blocking-score)
+  *   [Custom Block Page](#custom-block-page)
+  *   [Custom Block Action](#custom-block-action)
+  *   [Enable/Disable Captcha](#captcha-support)
+  *   [Extracting Real IP Address](#real-ip)
+  *   [Custom URI](#custom-uri)
+  *   [Filter Sensitive Headers](#sensitive-headers)
+  *   [API Timeouts](#api-timeout)
+  *   [Send Page Activities](#send-page-activities)
+  *   [Additional Page Activity Handler](#additional-page-activity-handler)
+  *   [Monitor Only](#logging)
+  *   [Debug Mode](#debug-mode)
+-   [Contributing](#contributing)
 
 <a name="Usage"></a>
 <a name="dependencies"></a> Dependencies
@@ -17,66 +31,85 @@ Table of Contents
 
 - Ruby version 2.3+
 - Rails version 4.2
-- [httparty](https://github.com/jnunemaker/httparty)
+- [httpclient](https://rubygems.org/gems/httpclient/versions/2.8.3)
+- [mustache](https://rubygems.org/gems/mustache)
 
 <a name="installation"></a> Installation
 ----------------------------------------
-Install it through command line ```gem install perimeter_x --pre```
-Or add it in Gemfile ```gem 'perimeter_x', '~> 1.0.3.pre.alpha'```
+Install it through command line ```gem install perimeter_x```
 
 
 <a name=basic-usage></a> Basic Usage Example
 ----------------------------------------
-On the Rails controller include the PerimeterX SDK via the before_action which will call your defined middleware function. This function is a wrapper for the px_verify method which takes a request and processes it. The verify method can return true if verified, or false if not verified.
 
-The default condition is to always return true for monitoring mode.
+### Configuration & Initialization
+Create a configuration file at `<rails_app>/config/initializers/perimeterx.rb` and initialize PerimeterX instance on the rails application startup
+```ruby
+params = {
+  :app_id => "APP_ID",
+  :cookie_key => "COOKIE_KEY",
+  :auth_token => "AUTH_TOKEN"
+}
 
+PxModule.configure(params)
 ```
+
+On the Rails controller include the PerimeterX SDK via the before_action and call PerimterX middleware function.
+
+```ruby
 class HomeController < ApplicationController
-  include PerimeterX
-  attr_accessor :px
-  ...
-  ...
-  before_action :px_middleware
+  include PxModule
+
+  before_filter :px_verify_request
   ...
   ...
-  initialize()
-    configuration = {
-      "app_id" => <APP_ID>
-      "auth_token" => <AUTH_TOKEN>
-    }
-    @px = PxModule.instance(params)
-  end
+end
+```
+
+<a name="configuration"></a> Configuration options
+----------------------------------------
+<a name="requireied-params"></a>**Configuring Required Parameters**
+Configuration options are set on the ``params`` variable on the initializer file.
+
+- ``app_id``
+- ``cookie_key``
+- ``auth_token``
+
+All parameters are obtainable via the PerimeterX Portal. (Applications and Policies pages)
+
+<a name="blocking-score"></a>**Changing the Minimum Score for Blocking**
+
+>Note:  Default blocking value: 70
+
+```ruby
+params = {
   ...
+  :blocking_score => 100
   ...
-  def px_middleware
-    px.px_verify(request.env)
-  end
+}
 ```
 
-<a name="configuration"></a> Configuration
-----------------------------------------
 
-** Custom Verification Handler **
-A custom verification handler replaces the default handle_verification method and allows you to take a custom action based on the risk score returned by PerimeterX.
+
+<a name="custom-block-action"></a>**Custom Verification Handler**
+
+A custom verification handler is being executed inside ``px_verify_request`` instead of the the default behavior and allows a user to use a custom action based on the risk score returned by PerimeterX.
 
 When implemented, this method receives  a hash variable as input which represents data from the PerimeterX context of the request (px_ctx).
 
-- `px_ctx[:score] ` contains the risk score 
-- `px_ctx[:uuid] ` contains the request UUID 
+- `px_ctx[:score] ` contains the risk score
+- `px_ctx[:uuid] ` contains the request UUID
 
 To replace the default verification behavior, add the configuration a lambda member as shown in the example below.
 
 The method must return boolen value.
 
-
-
 ```ruby
-configuration = {
-  "app_id" => <APP_ID>,
-  "auth_token" => <AUTH_TOKEN>,
-  "custom_verification_handler" => -> (px_ctx) {
-    if px_ctx[:score] >= 60
+params = {
+  :app_id => <APP_ID>,
+  :auth_token => <AUTH_TOKEN>,
+  :custom_block_handler => -> (px_ctx) {
+    if px_ctx.context[:score] >= 60
         # take your action and retun a message or JSON with a status code of 403 and option UUID of the request. Can return false and include action in the px_middleware method.  
     end
     return true
@@ -84,7 +117,33 @@ configuration = {
 }
 ```
 
-** Custom User IP **
+**Example**
+### Serving a Custom HTML Page ###
+```ruby
+
+params[:custom_block_handler] = -> (px_ctx)
+{
+    block_score = px_ctx.context[:score];
+    block_uuid = px_ctx.context[:uuid];
+    full_url = px_ctx.context[:full_url];
+
+    html = "<html>
+            <body>
+            <div>Access to #{full_url} has been blocked.</div>    
+            <div>Block reference - #{block_uuid} </div>
+            <div>Block score - #{block_score} </div>
+            </body>
+            </html>".html_safe
+    response.headers["Content-Type"] = "text/html"
+    response.status = 403
+    render :html => html
+    return false
+};
+
+PxModule.configure(params)
+```
+
+<a name="real-ip"></a>** Custom User IP **
 
 > Note: IP extraction, according to your network setup, is very important. It is common to have a load balancer/proxy on top of your applications, in which case the PerimeterX module will send the system's internal IP as the user's. In order to properly perform processing and detection on server-to-server calls, PerimeterX module needs the real user's IP.
 
@@ -111,3 +170,126 @@ configuration = {
   }
 }
 ```
+<a name="custom-block-page"></a>**Customizing Default Block Pages**
+
+Adding a custom logo to the blocking page is by providing the `params` a key `custom_logo` , the logo will be displayed at the top div of the the block page The logo's `max-heigh` property would be `150px` and width would be set to `auto`
+
+The key custom_logo expects a valid URL address such as https://s.perimeterx.net/logo.png
+
+```ruby
+params = [
+    :app_id => 'APP_ID',
+    :cookie_key => 'COOKIE_SECRET',
+    :auth_token => 'AUTH_TOKEN',
+    :custom_logo => 'LOGO_URL'
+];
+```
+
+**Custom JS/CSS**
+The block page can be modified with a custom CSS by adding to the `params` the key `css_ref` and providing a valid URL to the css In addition there is also the option to add a custom JS file by adding `js_ref` key to the pxConfig and providing the JS file that will be loaded with the block page, this key also expects a valid URL
+
+```ruby
+params = [
+    :app_id => 'APP_ID',
+    :cookie_key => 'COOKIE_SECRET',
+    :auth_token => 'AUTH_TOKEN',
+    :css_ref => 'CSS',
+    :js_ref => 'JS'
+];
+```
+> Note: Custom logo/js/css can be added together
+
+<a name="logging"></a>**No Blocking, Monitor Only**
+Default mode: PxModule::ACTIVE_MODE
+
+- PxModule::ACTIVE_MODE - Module blocks users crossing the predefined block threshold. Server-to-server requests are sent synchronously.
+
+- PxModule::$MONITOR_MODE - Module does not block users crossing the predefined block threshold. The `custom_block_handler` function will be eval'd in case one is supplied, upon crossing the defined block threshold.
+
+```ruby
+params[:module_mode] = PxModule::MONITOR_MODE
+```
+
+<a name="captcha-support"></a>**Enable/Disable CAPTCHA on the block page**
+Default mode: enabled
+
+By enabling CAPTCHA support, a CAPTCHA will be served as part of the block page, giving real users the ability to identify as a human. By solving the CAPTCHA, the user's score is then cleaned up and the user is allowed to continue normal use.
+
+```ruby
+params[:captcha_enabled] = false
+```
+
+<a name="custom-uri"></a>**Custom URI**
+
+Default: 'REQUEST_URI'
+
+The URI can be returned to the PerimeterX module, using a custom user function, defined on the ``params`` variable
+
+```ruby
+params[:custom_uri] = -> (request) {
+  return request.headers['HTTP_X_CUSTOM_URI']
+}
+```
+
+<a name="sensitive-headers"></a>**Filter sensitive headers**
+A list of sensitive headers can be configured to prevent specific headers from being sent to PerimeterX servers (lower case header names). Filtering cookie headers for privacy is set by default, and can be overridden on the `params` variable.
+
+Default: cookie, cookies
+
+```ruby
+params[:sensitive_headers] = ['cookie', 'cookies', 'secret-header']
+
+```
+
+<a name="api-timeout"></a>**API Timeouts**
+>Note: Controls the timeouts for PerimeterX requests. The API is called when a Risk Cookie does not exist, or is expired or invalid
+
+The API Timeout, in seconds (int), to wait for the PerimeterX server API response.
+
+Default: 1
+
+```ruby
+params[:api_timeout] = 4
+```
+
+<a name="send-page-activities"></a>**Send Page Activities**
+Default: true
+A boolean flag to enable or disable sending of activities and metrics to PerimeterX on each page request. Enabling this feature will provide data that populates the PerimeterX portal with valuable information, such as the amount of requests blocked and additional API usage statistics.
+
+```ruby
+params[:send_page_activities] = false
+```
+
+<a name="additional-page-activity-handler"></a>**Additional Page Activity Handler**
+
+Adding an additional activity handler is done by setting `additional_activity_handler` with a user defined function on the `params` variable. The `additional_activity_handler` function will be executed before sending the data to the PerimeterX portal.
+
+Default: Only send activity to PerimeterX as controlled by `params`.
+
+
+
+```ruby
+params[:additional_activity_handler] = -> (activity_type, px_ctx, details){
+    // user defined logic comes here
+};
+```
+
+<a name="debug-mode"></a>**Debug Mode**
+Default: false
+
+Enables debug logging mode to STDOUT
+```ruby
+  params[:debug] = true
+```
+
+<a name="contributing"></a># Contributing #
+------------------------------
+The following steps are welcome when contributing to our project.
+###Fork/Clone
+First and foremost, [Create a fork](https://guides.github.com/activities/forking/) of the repository, and clone it locally.
+Create a branch on your fork, preferably using a self descriptive branch name.
+
+###Code/Run
+Help improve our project by implementing missing features, adding capabilities or fixing bugs.
+
+To run the code, simply follow the steps in the [installation guide](#installation). Grab the keys from the PerimeterX Portal, and try refreshing your page several times continously. If no default behaviours have been overriden, you should see the PerimeterX block page. Solve the CAPTCHA to clean yourself and start fresh again.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: perimeter_x
 version: !ruby/object:Gem::Version
-  version: 1.0.4.pre.alpha
+  version: 1.0.4
 platform: ruby
 authors:
 - Nitzan Goldfeder
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-23 00:00:00.000000000 Z
+date: 2017-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,74 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 2.8.2.4
+- !ruby/object:Gem::Dependency
+  name: mustache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.1
 description: PerimeterX ruby module to monitor and block traffic according to PerimeterX
   risk score
 email: nitzan@perimeterx.com
@@ -67,18 +135,29 @@ files:
 - Gemfile.lock
 - LICENSE.txt
 - Rakefile
-- bin/console
-- bin/setup
 - changelog.md
-- examples/home_controller.rb.dist
-- examples/routes.rb
+- examples/app/controllers/home_controller.rb
+- examples/app/views/home/index.html.erb.dist
+- examples/config/initializers/perimeterx.rb.dist
+- examples/config/routes.rb
 - lib/perimeter_x.rb
 - 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_cookie_decryption_exception.rb
 - lib/perimeterx/internal/perimeter_x_context.rb
-- lib/perimeterx/internal/perimeter_x_risk_client.rb
-- lib/perimeterx/internal/perimeter_x_s2s_validator.rb
+- lib/perimeterx/internal/perimeter_x_cookie.rb
+- lib/perimeterx/internal/perimeter_x_cookie_v1.rb
+- lib/perimeterx/internal/perimeter_x_cookie_v3.rb
+- lib/perimeterx/internal/validators/perimeter_x_captcha_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
 - lib/perimeterx/utils/px_http_client.rb
 - lib/perimeterx/utils/px_logger.rb
+- lib/perimeterx/utils/px_template_factory.rb
+- lib/perimeterx/utils/templates/block.mustache
+- lib/perimeterx/utils/templates/captcha.mustache
 - lib/perimeterx/version.rb
 - perimeter_x.gemspec
 - readme.md
@@ -101,9 +180,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.11

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "perimeter_x"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/examples/home_controller.rb.dist

@@ -1,23 +0,0 @@
-class HomeController < ApplicationController
-  include PerimeterX
-
-  before_action :px_middleware
-
-  attr_accessor :px
-
-  def initialize()
-    params = {
-      "app_id" => <APP_ID>,
-      "cookie_key" => <COOKIE_KEY>,
-      "auth_token" => <AUTH_TOKEN>
-    }
-    @px = PxModule.instance(params)
-  end
-
-  def index
-  end
-
-  def px_middleware
-    px.px_verify(request.env)
-  end
-end

data/lib/perimeterx/internal/perimeter_x_risk_client.rb

@@ -1,29 +0,0 @@
-require 'perimeterx/utils/px_logger'
-
-class PerimeterxRiskClient
-  L = PxLogger.instance
-
-  attr_accessor :px_ctx
-  attr_accessor :px_config
-  attr_accessor :http_client
-
-  def initialize(px_ctx, px_config, http_client)
-    @px_ctx = px_ctx
-    @px_config = px_config
-    @http_client = http_client;
-  end
-
-  def format_headers()
-      formated_headers = []
-      @px_ctx.context[:headers].each do |k,v|
-        if (!@px_config["sensitive_headers"].include? k.to_s)
-          formated_headers.push({
-            :name => k.to_s,
-            :value => v
-            })
-        end #end if
-      end #end forech
-      return formated_headers
-  end #end method
-
-end #end class

data/lib/perimeterx/internal/perimeter_x_s2s_validator.rb

@@ -1,68 +0,0 @@
-require 'perimeterx/internal/perimeter_x_risk_client'
-
-class PerimeterxS2SValidator < PerimeterxRiskClient
-
-  attr_accessor :risk_mode
-  attr_accessor :response
-
-  def initialize(px_ctx, px_config, http_client)
-    L.info("PerimeterxS2SValidator: initialize")
-    @px_ctx = px_ctx
-    @px_config = px_config
-    @http_client = http_client
-  end
-
-  def send_risk_request
-    L.info("PerimeterxS2SValidator[send_risk_request]: send_risk_request")
-    request_body = {
-      'request' => {
-        'ip'      => @px_ctx.context[:ip],
-        'headers' => format_headers(),
-        'uri'     => @px_ctx.context[:uri],
-        'url'     => @px_ctx.context[:full_url]
-      },
-      'additional' => {
-        's2s_call_reason' => @px_ctx.context[:s2s_call_reason],
-        'module_version' => @px_config["sdk_name"],
-        'http_method' => @px_ctx.context[:http_method],
-        'http_version' => @px_ctx.context[:http_version],
-      }
-    }
-
-    headers = {
-        "Authorization" => "Bearer #{@px_config['auth_token']}" ,
-        "Content-Type" => "application/json"
-    };
-
-    return @http_client.post("/api/v2/risk", request_body, headers)
-  end
-
-  def verify
-    L.info("PerimeterxS2SValidator[verify]: started")
-    response = send_risk_request()
-    if (!response)
-      return @px_ctx
-    end
-    @px_ctx.context[:made_s2s_risk_api_call] = true
-    response_body = eval(response.content);
-    # When success
-    if (response.status == 200 && response_body.key?(:score) && response_body.key?(:action))
-      L.info("PerimeterxS2SValidator[verify]: response ok")
-      score = response_body[:score]
-      @px_ctx.context[:score] = score
-      @px_ctx.context[:uuid] = response_body[:uuid]
-      @px_ctx.context[:block_action] = response_body[:action]
-    end #end success response
-
-    # When error
-    if(response.status != 200)
-      L.warn("PerimeterxS2SValidator[verify]: bad response, return code #{response.code}")
-      @px_ctx.context[:uuid] = ""
-      @px_ctx.context[:s2s_error_msg] = response_body[:message]
-    end
-
-    L.info("PerimeterxS2SValidator[verify]: done")
-    return @px_ctx
-  end #end method
-
-end