perimeter_x 1.0.4.pre.alpha → 1.0.4

data/lib/perimeterx/utils/px_http_client.rb

@@ -1,34 +1,55 @@
 require "perimeterx/utils/px_logger"
 require "httpclient"
 
-class PxHttpClient
-  L = PxLogger.instance
-  attr_accessor :px_config
-  attr_accessor :BASE_URL
-  attr_accessor :http_client
+module PxModule
+  class PxHttpClient
+    attr_accessor :px_config
+    attr_accessor :BASE_URL
+    attr_accessor :http_client
 
-  def initialize(px_config)
-    L.info("PxHttpClient[initialize]: HTTP client is being initilized with base_uri: #{px_config['perimeterx_server_host']}")
-    @px_config = px_config
-    @http_client = HTTPClient.new(:base_url => px_config['perimeterx_server_host'])
-  end
+    def initialize(px_config)
+      @px_config = px_config
+      @http_client = HTTPClient.new(:base_url => px_config[:perimeterx_server_host])
+      @logger = px_config[:logger]
+      @logger.debug("PxHttpClient[initialize]: HTTP client is being initilized with base_uri: #{px_config[:perimeterx_server_host]}")
+    end
 
-  def post(path, body, headers, connection_timeout = 0, timeoute = 0)
-    s = Time.now
-    begin
-      L.info("PxHttpClient[post]: posting to #{path} headers {#{headers.to_json()}} body: {#{body.to_json()}} ")
-      response = @http_client.post(path,
-                  :header => headers,
-                  :body => body.to_json(),
-                  :timeout => @px_config['api_timeout']
-                )
-    rescue Net::OpenTimeout, Net::ReadTimeout => error
-      L.warn("PerimeterxS2SValidator[verify]: request timedout")
-      return false
+    def post(path, body, headers, api_timeout = 0, timeoute = 0)
+      s = Time.now
+      begin
+        @logger.debug("PxHttpClient[post]: posting to #{path} headers {#{headers.to_json()}} body: {#{body.to_json()}} ")
+        response = @http_client.post(path,
+                    :header => headers,
+                    :body => body.to_json(),
+                    :timeout => api_timeout
+                  )
+      rescue Net::OpenTimeout, Net::ReadTimeout => error
+        @logger.warn("PerimeterxS2SValidator[verify]: request timedout")
+        return false
+      end
+      e = Time.now
+      @logger.debug("PxHttpClient[post]: runtime: #{e-s}")
+      return response
     end
-    e = Time.now
-    L.info("PxHttpClient[post]: runtime: #{e-s}")
-    return response
-  end
 
+    def async_post(path, body, headers, api_timeout = 0, timeoute = 0)
+      @logger.debug("PxHttpClient[async_post]: posting to #{path} headers {#{headers.to_json()}} body: {#{body.to_json()}} ")
+      s = Time.now
+      begin
+        @logger.debug("PxHttpClient[post]: posting to #{path} headers {#{headers.to_json()}} body: {#{body.to_json()}} ")
+        response = @http_client.post_async(path,
+                    :header => headers,
+                    :body => body.to_json(),
+                    :timeout => api_timeout
+                  )
+      rescue Net::OpenTimeout, Net::ReadTimeout => error
+        @logger.warn("PerimeterxS2SValidator[verify]: request timedout")
+        return false
+      end
+      e = Time.now
+      @logger.debug("PxHttpClient[post]: runtime: #{e-s}")
+      return response
+    end
+
+  end
 end

data/lib/perimeterx/utils/px_logger.rb

@@ -1,11 +1,17 @@
 require 'logger'
+module PxModule
 
-class PxLogger
-  @@instance = Logger.new(STDOUT)
+  class PxLogger < Logger
 
-  def self.instance
-    return @@instance
-  end
+    def initialize(debug)
+      if debug
+        super(STDOUT)
+      else
+        super(nil)
+      end
+
+    end
 
-  private_class_method :new
+  end
+  
 end

data/lib/perimeterx/utils/px_template_factory.rb

@@ -0,0 +1,31 @@
+require 'mustache'
+require 'perimeterx/utils/px_constants'
+module PxModule
+  module PxTemplateFactory
+
+    def self.get_template(px_ctx, px_config)
+      logger = px_config[:logger]
+      if (px_config[:challenge_enabled] && px_ctx.context[:block_action] == "challenge")
+        logger.debug("PxTemplateFactory[get_template]: px challange triggered")
+        return px_ctx.context[:block_action_data].html_safe
+      end
+
+      logger.debug("PxTemplateFactory[get_template]: rendering template")
+      template_type = px_config[:captcha_enabled] ? PxModule::CAPTCHA_TEMPLATE : BLOCK_TEMPLATE
+
+      Mustache.template_file =  "#{File.dirname(__FILE__) }/templates/#{template_type}"
+      view = Mustache.new
+
+      view[PxModule::PROP_APP_ID] = px_config[:app_id]
+      view[PxModule::PROP_REF_ID] = px_ctx.context[:uuid]
+      view[PxModule::PROP_VID] = px_ctx.context[:vid]
+      view[PxModule::PROP_UUID] = px_ctx.context[:uuid]
+      view[PxModule::PROP_CUSTOM_LOGO] = px_config[:custom_logo]
+      view[PxModule::PROP_CSS_REF] = px_config[:css_ref]
+      view[PxModule::PROP_JS_REF] = px_config[:js_ref]
+      view[PxModule::PROP_LOGO_VISIBILITY] = px_config[:custom_logo] ? PxModule::VISIBLE : PxModule::HIDDEN
+
+      return view.render.html_safe
+    end
+  end #end class
+end #end module

data/lib/perimeterx/utils/templates/block.mustache

@@ -0,0 +1,146 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <title>Access to this page has been denied.</title>
+    <link href="https://fonts.googleapis.com/css?family=Open+Sans:300" rel="stylesheet">
+    <style>
+    html,body{
+      margin: 0;
+      padding: 0;
+      font-family: 'Open Sans', sans-serif;
+      color: #000;
+    }
+
+    a{
+      color: #c5c5c5;
+      text-decoration: none;
+    }
+
+    .container{
+      align-items: center;
+      display: flex;
+      flex: 1;
+      justify-content: space-between;
+      flex-direction: column;
+      height: 100%;
+    }
+
+    .container > div {
+      width: 100%;
+      display: flex;
+      justify-content:center;
+    }
+
+    .container > div > div {
+      display: flex;
+      width: 80%;
+    }
+
+    .customer-logo-wrapper{
+      padding-top: 2rem;
+      flex-grow: 0;
+      background-color: #fff;
+      visibility: {{logoVisibility}};
+    }
+
+    .customer-logo{
+      border-bottom: 1px solid #000;
+    }
+
+    .customer-logo > img{
+      padding-bottom: 1rem;
+      max-height: 50px;
+      max-width: auto;
+    }
+
+    .page-title-wrapper{
+      flex-grow: 2;
+    }
+    .page-title {
+      flex-direction: column-reverse;
+    }
+
+    .content-wrapper{
+      flex-grow: 5;
+    }
+    .content{
+      flex-direction: column;
+    }
+
+    .page-footer-wrapper{
+      align-items: center;
+      flex-grow: 0.2;
+      background-color: #000;
+      color: #c5c5c5;
+      font-size: 70%;
+  }
+  @media (min-width:768px){
+    html,body{
+      height: 100%;
+    }
+  }
+  </style>
+  <!-- Custom CSS -->
+  {{# cssRef }}
+    <link rel="stylesheet" type="text/css" href="{{cssRef}}" />
+  {{/ cssRef }}
+  </head>
+  <body>
+    <section class="container">
+      <div class="customer-logo-wrapper">
+        <div class="customer-logo">
+          <img src="{{customLogo}}" alt="Logo"/>
+        </div>
+      </div>
+      <div class="page-title-wrapper">
+        <div class="page-title">
+          <h1>Access to this page has been denied.</h1>
+        </div>
+      </div>
+      <div class="content-wrapper">
+        <div class="content">
+          <p>
+            You have been blocked because we believe you are using automation tools to browse the website.
+          </p>
+          <p>
+            Please note that Javascript and Cookies must be enabled on your browser to access the website.
+          </p>
+          <p>
+            If you think you have been blocked by mistake, please contact the website administrator with the reference ID below.
+          </p>
+          <p>
+            Reference ID: #{{refId}}
+          </p>
+        </div>
+      </div>
+      <div class="page-footer-wrapper">
+        <div class="page-footer">
+          <p>
+            Powered by
+            <a href="https://www.perimeterx.com">PerimeterX</a>
+            , Inc.
+          </p>
+        </div>
+      </div>
+    </section>
+    <!-- Px -->
+    <script>
+      (
+        function (){
+        window._pxAppId = '{{appId}}';
+        var p = document.getElementsByTagName("script")[0], s = document.createElement("script");
+
+        s.async = 1;
+        s.src = '//client.perimeterx.net/{{appId}}/main.min.js';
+        p.parentNode.insertBefore(s, p);
+       } ()
+      );
+    </script>
+    <!-- Custom Script -->
+    {{# jsRef }}
+      <script src="{{jsRef}}"></script>
+    {{/ jsRef }}
+  </body>
+</html>

data/lib/perimeterx/utils/templates/captcha.mustache

@@ -0,0 +1,185 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <title>Access to this page has been denied.</title>
+    <link href="https://fonts.googleapis.com/css?family=Open+Sans:300" rel="stylesheet">
+    <style>
+    html,body{
+      margin: 0;
+      padding: 0;
+      font-family: 'Open Sans', sans-serif;
+      color: #000;
+    }
+
+    a{
+      color: #c5c5c5;
+      text-decoration: none;
+    }
+
+    .container{
+      align-items: center;
+      display: flex;
+      flex: 1;
+      justify-content: space-between;
+      flex-direction: column;
+      height: 100%;
+    }
+
+    .container > div {
+      width: 100%;
+      display: flex;
+      justify-content:center;
+    }
+
+    .container > div > div {
+      display: flex;
+      width: 80%;
+    }
+
+    .customer-logo-wrapper{
+      padding-top: 2rem;
+      flex-grow: 0;
+      background-color: #fff;
+      visibility: {{logoVisibility}};
+    }
+
+    .customer-logo{
+      border-bottom: 1px solid #000;
+    }
+
+    .customer-logo > img{
+      padding-bottom: 1rem;
+      max-height: 50px;
+      max-width: auto;
+    }
+
+    .page-title-wrapper{
+      flex-grow: 2;
+    }
+    .page-title {
+      flex-direction: column-reverse;
+    }
+
+    .content-wrapper{
+      flex-grow: 5;
+    }
+    .content{
+      flex-direction: column;
+    }
+
+    .page-footer-wrapper{
+      align-items: center;
+      flex-grow: 0.2;
+      background-color: #000;
+      color: #c5c5c5;
+      font-size: 70%;
+  }
+
+  @media (min-width:768px){
+    html,body{
+      height: 100%;
+    }
+  }
+    </style>
+    <!-- Custom CSS -->
+    {{#cssRef}}
+      <link rel="stylesheet" type="text/css" href="{{cssRef}}" />
+    {{/cssRef}}
+    <script src="https://www.google.com/recaptcha/api.js" async defer></script>
+  </head>
+
+  <body>
+    <section class="container">
+      <div class="customer-logo-wrapper">
+        <div class="customer-logo">
+          <img src="{{customLogo}}" alt="Logo"/>
+        </div>
+      </div>
+      <div class="page-title-wrapper">
+        <div class="page-title">
+          <h1>Please verify you are a human</h1>
+        </div>
+      </div>
+      <div class="content-wrapper">
+        <div class="content">
+          <p>
+            Please click "I am not a robot" to continue
+          </p>
+          <div class="g-recaptcha" data-sitekey="6Lcj-R8TAAAAABs3FrRPuQhLMbp5QrHsHufzLf7b" data-callback="handleCaptcha" data-theme="dark">
+          </div>
+          <p>
+            Access to this page has been denied because we believe you are using automation tools to browse the website.
+          </p>
+          <p>
+            This may happen as a result of the following:
+          </p>
+          <ul>
+            <li>
+              Javascript is disabled or blocked by an extension (ad blockers for example)
+            </li>
+            <li>
+              Your browser does not support cookies
+            </li>
+          </ul>
+          <p>
+            Please make sure that Javascript and cookies are enabled on your browser and that you are not blocking them from loading.
+          </p>
+          <p>
+            Reference ID: #{{refId}}
+          </p>
+        </div>
+      </div>
+      <div class="page-footer-wrapper">
+        <div class="page-footer">
+          <p>
+            Powered by
+            <a href="https://www.perimeterx.com">PerimeterX</a>
+            , Inc.
+          </p>
+        </div>
+      </div>
+    </section>
+    <!-- Px -->
+    <script>
+      (
+        function (){
+        window._pxAppId = '{{appId}}';
+        var p = document.getElementsByTagName("script")[0], s = document.createElement("script");
+
+        s.async = 1;
+        s.src = '//client.perimeterx.net/{{appId}}/main.min.js';
+        p.parentNode.insertBefore(s, p);
+       } ()
+      );
+    </script>
+    <!-- Captcha -->
+    <script>
+      window.px_vid = '{{vid}}';
+      function handleCaptcha(response){
+        var vid = '{{vid}}';
+        var uuid = '{{uuid}}';
+        var name = "_pxCaptcha";
+
+        var expiryUtc = new Date(Date.now()+1000*10).toUTCString();
+
+        var cookieParts = [
+          name,
+          "=",
+          response+":"+vid+":"+uuid,
+          "; expires=",
+          expiryUtc,
+          "; path=/"
+        ];
+
+        document.cookie = cookieParts.join("");
+        location.reload();
+      }
+    </script>
+    <!-- Custom Script -->
+    {{#jsRef}}
+      <script src="{{jsRef}}"></script>
+    {{/jsRef}}
+  </body>
+</html>

data/lib/perimeterx/version.rb

@@ -1,3 +1,3 @@
-module PerimeterX
-  VERSION = '1.0.4-alpha'
+module PxModule
+  VERSION = '1.0.4'
 end

data/perimeter_x.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |gem|
   gem.description = "PerimeterX ruby module to monitor and block traffic according to PerimeterX risk score"
   gem.licenses    = ['MIT']
   gem.homepage    = "https://www.perimeterx.com"
-  gem.version     = PerimeterX::VERSION
+  gem.version     = PxModule::VERSION
 
   gem.authors     = ["Nitzan Goldfeder"]
   gem.email       = "nitzan@perimeterx.com"
@@ -31,4 +31,9 @@ Gem::Specification.new do |gem|
   gem.required_ruby_version = '>= 2.3'
 
   gem.add_dependency('httpclient', '2.8.2.4')
+  gem.add_dependency('mustache', '~> 1.0', '>= 1.0.3')
+  gem.add_dependency('activesupport', '>= 4.2.0')
+
+  gem.add_development_dependency 'rspec', '~> 3.0'
+  gem.add_development_dependency 'mocha', '~> 1.2', '>= 1.2.1'
 end