securenative 0.1.20 → 0.1.26

data/lib/securenative/config/configuration_builder.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'securenative/enums/failover_strategy'
+
+module SecureNative
+  class ConfigurationBuilder
+    attr_reader :api_key, :api_url, :interval, :max_events, :timeout, :auto_send, :disable, :log_level, :fail_over_strategy, :proxy_headers
+    attr_writer :api_key, :api_url, :interval, :max_events, :timeout, :auto_send, :disable, :log_level, :fail_over_strategy, :proxy_headers
+
+    def initialize(api_key: nil, api_url: 'https://api.securenative.com/collector/api/v1', interval: 1000,
+                   max_events: 1000, timeout: 1500, auto_send: true, disable: false, log_level: 'FATAL',
+                   fail_over_strategy: FailOverStrategy::FAIL_OPEN, proxy_headers: nil)
+      @api_key = api_key
+      @api_url = api_url
+      @interval = interval
+      @max_events = max_events
+      @timeout = timeout
+      @auto_send = auto_send
+      @disable = disable
+      @log_level = log_level
+      @fail_over_strategy = fail_over_strategy
+      @proxy_headers = proxy_headers
+    end
+
+    def self.default_securenative_options
+      SecureNativeOptions.new
+    end
+  end
+end

data/lib/securenative/config/configuration_manager.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'securenative/config/configuration_builder'
+
+module SecureNative
+  class ConfigurationManager
+    DEFAULT_CONFIG_FILE = 'securenative.yml'
+    CUSTOM_CONFIG_FILE_ENV_NAME = 'SECURENATIVE_CONFIG_FILE'
+    @config = nil
+
+    def self.read_resource_file(resource_path)
+      properties = {}
+      begin
+        @config = YAML.load_file(resource_path)
+        properties = @config unless @config.nil?
+      rescue StandardError => e
+        SecureNativeLogger.error("Could not parse securenative.config file #{resource_path}; #{e}")
+      end
+      properties
+    end
+
+    def self._get_resource_path(env_name)
+      Env.fetch(env_name, ENV[DEFAULT_CONFIG_FILE])
+    end
+
+    def self.config_builder
+      ConfigurationBuilder.new
+    end
+
+    def self._get_env_or_default(properties, key, default)
+      return ENV[key] if ENV[key]
+      return properties[key] if properties[key]
+
+      default
+    end
+
+    def self.load_config
+      options = ConfigurationBuilder.default_securenative_options
+
+      resource_path = DEFAULT_CONFIG_FILE
+      resource_path = ENV[CUSTOM_CONFIG_FILE_ENV_NAME] unless ENV[CUSTOM_CONFIG_FILE_ENV_NAME].nil?
+
+      properties = read_resource_file(resource_path)
+
+      ConfigurationBuilder.new(api_key: _get_env_or_default(properties, 'SECURENATIVE_API_KEY', options.api_key),
+                               api_url: _get_env_or_default(properties, 'SECURENATIVE_API_URL', options.api_url),
+                               interval: _get_env_or_default(properties, 'SECURENATIVE_INTERVAL', options.interval),
+                               max_events: _get_env_or_default(properties, 'SECURENATIVE_MAX_EVENTS', options.max_events),
+                               timeout: _get_env_or_default(properties, 'SECURENATIVE_TIMEOUT', options.timeout),
+                               auto_send: _get_env_or_default(properties, 'SECURENATIVE_AUTO_SEND', options.auto_send),
+                               disable: _get_env_or_default(properties, 'SECURENATIVE_DISABLE', options.disable),
+                               log_level: _get_env_or_default(properties, 'SECURENATIVE_LOG_LEVEL', options.log_level),
+                               fail_over_strategy: _get_env_or_default(properties, 'SECURENATIVE_FAILOVER_STRATEGY', options.fail_over_strategy),
+                               proxy_headers: _get_env_or_default(properties, 'SECURENATIVE_PROXY_HEADERS', options.proxy_headers))
+    end
+  end
+end

data/lib/securenative/config/securenative_options.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'securenative/enums/failover_strategy'
+
+module SecureNative
+  class SecureNativeOptions
+    attr_reader :api_key, :api_url, :interval, :max_events, :timeout, :auto_send, :disable, :log_level, :fail_over_strategy, :proxy_headers
+    attr_writer :api_key, :api_url, :interval, :max_events, :timeout, :auto_send, :disable, :log_level, :fail_over_strategy, :proxy_headers
+
+    def initialize(api_key: nil, api_url: "https://api.securenative.com/collector/api/v1", interval: 1000,
+                   max_events: 1000, timeout: 1500, auto_send: true, disable: false, log_level: "FATAL",
+                   fail_over_strategy: FailOverStrategy::FAIL_OPEN, proxy_headers: nil)
+      @api_key = api_key
+      @api_url = api_url
+      @interval = interval
+      @max_events = max_events
+      @timeout = timeout
+      @auto_send = auto_send
+      @disable = disable
+      @log_level = log_level
+      @fail_over_strategy = fail_over_strategy
+      @proxy_headers = proxy_headers
+    end
+  end
+end

data/lib/securenative/context/hanami_context.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module SecureNative
+  class HanamiContext
+    SECURENATIVE_COOKIE = '_sn'
+
+    def self.get_client_token(request)
+      begin
+        request.env[SECURENATIVE_COOKIE]
+      rescue StandardError
+        begin
+          request.cookies[SECURENATIVE_COOKIE]
+        rescue StandardError
+          nil
+        end
+      end
+    end
+
+    def self.get_url(request)
+      begin
+        request.env['REQUEST_PATH']
+      rescue StandardError
+        nil
+      end
+    end
+
+    def self.get_method(request)
+      begin
+        request.request_method
+      rescue StandardError
+        nil
+      end
+    end
+
+    def self.get_headers(request)
+      begin
+        # Note: At the moment we're filtering out everything but user-agent since ruby's payload is way too big
+        { 'user-agent' => request.env['HTTP_USER_AGENT'] }
+      rescue StandardError
+        nil
+      end
+    end
+  end
+end

data/lib/securenative/context/rails_context.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module SecureNative
+  class RailsContext
+    SECURENATIVE_COOKIE = '_sn'
+
+    def self.get_client_token(request)
+      begin
+        request.cookies[SECURENATIVE_COOKIE]
+      rescue StandardError
+        nil
+      end
+    end
+
+    def self.get_url(request)
+      begin
+        # Rails >= 3.x
+        request.fullpath
+      rescue StandardError
+        begin
+          # Rails < 3.x & Sinatra
+          request.url if url.nil?
+        rescue StandardError
+          nil
+        end
+      end
+    end
+
+    def self.get_method(request)
+      begin
+        request.method
+      rescue StandardError
+        nil
+      end
+    end
+
+    def self.get_headers(request)
+      begin
+        # Note: At the moment we're filtering out everything but user-agent since ruby's payload is way too big
+        {'user-agent' => request.env['HTTP_USER_AGENT']}
+      rescue StandardError
+        nil
+      end
+    end
+  end
+end

data/lib/securenative/context/securenative_context.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'securenative/utils/request_utils'
+require 'securenative/utils/utils'
+require 'securenative/context/rails_context'
+require 'securenative/context/hanami_context'
+require 'securenative/context/sinatra_context'
+
+module SecureNative
+  class SecureNativeContext
+    attr_reader :client_token, :ip, :remote_ip, :headers, :url, :http_method, :body
+    attr_writer :client_token, :ip, :remote_ip, :headers, :url, :http_method, :body
+
+    SECURENATIVE_COOKIE = '_sn'
+
+    def initialize(client_token: '', ip: '', remote_ip: '', headers: nil, url: '', http_method: '', body: '')
+      @client_token = client_token
+      @ip = ip
+      @remote_ip = remote_ip
+      @headers = headers
+      @url = url
+      @http_method = http_method
+      @body = body
+    end
+
+    def self.default_context_builder
+      SecureNativeContext.new
+    end
+
+    def self.from_http_request(request)
+      client_token = RailsContext.get_client_token(request)
+      client_token = SinatraContext.get_client_token(request) if client_token.nil?
+      client_token = HanamiContext.get_client_token(request) if client_token.nil?
+
+      begin
+        headers = RailsContext.get_headers(request)
+        headers = SinatraContext.get_headers(request) if headers.nil?
+        headers = HanamiContext.get_headers(request) if headers.nil?
+
+        # Standard Ruby request
+        headers = request.header.to_hash if headers.nil?
+      rescue StandardError
+        headers = []
+      end
+
+      url = RailsContext.get_url(request)
+      url = SinatraContext.get_url(request) if url.nil?
+      url = HanamiContext.get_url(request) if url.nil?
+      url = '' if url.nil?
+
+      method = RailsContext.get_method(request)
+      method = SinatraContext.get_method(request) if method.nil?
+      method = HanamiContext.get_method(request) if method.nil?
+      method = '' if method.nil?
+
+      begin
+        body = request.body.to_s
+      rescue StandardError
+        body = ''
+      end
+
+      client_token = RequestUtils.get_secure_header_from_request(headers) if Utils.null_or_empty?(client_token)
+
+      SecureNativeContext.new(client_token: client_token, ip: RequestUtils.get_client_ip_from_request(request),
+                              remote_ip: RequestUtils.get_remote_ip_from_request(request),
+                              headers: headers, url: url, http_method: method || '', body: body)
+    end
+  end
+end

data/lib/securenative/context/sinatra_context.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module SecureNative
+  class SinatraContext
+    SECURENATIVE_COOKIE = '_sn'
+
+    def self.get_client_token(request)
+      begin
+        request.env[SECURENATIVE_COOKIE]
+      rescue StandardError
+        begin
+          request.cookies[SECURENATIVE_COOKIE]
+        rescue StandardError
+          nil
+        end
+      end
+    end
+
+    def self.get_url(request)
+      begin
+        request.env['REQUEST_URI']
+      rescue StandardError
+        nil
+      end
+    end
+
+    def self.get_method(request)
+      begin
+        request.env['REQUEST_METHOD']
+      rescue StandardError
+        nil
+      end
+    end
+
+    def self.get_headers(request)
+      begin
+        # Note: At the moment we're filtering out everything but user-agent since ruby's payload is way too big
+        {'user-agent' => request.env['HTTP_USER_AGENT']}
+      rescue StandardError
+        nil
+      end
+    end
+  end
+end

data/lib/securenative/enums/api_route.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module SecureNative
+  module ApiRoute
+    TRACK = 'track'
+    VERIFY = 'verify'
+  end
+end

data/lib/securenative/enums/event_types.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module SecureNative
+  module EventTypes
+    LOG_IN = 'sn.user.login'
+    LOG_IN_CHALLENGE = 'sn.user.login.challenge'
+    LOG_IN_FAILURE = 'sn.user.login.failure'
+    LOG_OUT = 'sn.user.logout'
+    SIGN_UP = 'sn.user.signup'
+    AUTH_CHALLENGE = 'sn.user.auth.challenge'
+    AUTH_CHALLENGE_SUCCESS = 'sn.user.auth.challenge.success'
+    AUTH_CHALLENGE_FAILURE = 'sn.user.auth.challenge.failure'
+    TWO_FACTOR_DISABLE = 'sn.user.2fa.disable'
+    EMAIL_UPDATE = 'sn.user.email.update'
+    PASSWORD_REST = 'sn.user.password.reset'
+    PASSWORD_REST_SUCCESS = 'sn.user.password.reset.success'
+    PASSWORD_UPDATE = 'sn.user.password.update'
+    PASSWORD_REST_FAILURE = 'sn.user.password.reset.failure'
+    USER_INVITE = 'sn.user.invite'
+    ROLE_UPDATE = 'sn.user.role.update'
+    PROFILE_UPDATE = 'sn.user.profile.update'
+    PAGE_VIEW = 'sn.user.page.view'
+    VERIFY = 'sn.verify'
+  end
+end

data/lib/securenative/enums/failover_strategy.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module SecureNative
+  module FailOverStrategy
+    FAIL_OPEN = 'fail-open'
+    FAIL_CLOSED = 'fail-closed'
+  end
+end

data/lib/securenative/enums/risk_level.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module SecureNative
+  module RiskLevel
+    LOW = 'low'
+    MEDIUM = 'medium'
+    HIGH = 'high'
+  end
+end

data/lib/securenative/errors/securenative_config_error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module SecureNative
+  class SecureNativeConfigError < StandardError
+  end
+end

data/lib/securenative/errors/securenative_http_error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module SecureNative
+  class SecureNativeHttpError < StandardError
+  end
+end

data/lib/securenative/errors/securenative_invalid_options_error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module SecureNative
+  class SecureNativeInvalidOptionsError < StandardError
+  end
+end

data/lib/securenative/errors/securenative_invalid_uri_error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module SecureNative
+  class SecureNativeInvalidUriError < StandardError
+  end
+end

data/lib/securenative/errors/securenative_parse_error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module SecureNative
+  class SecureNativeParseError < StandardError
+  end
+end

data/lib/securenative/errors/securenative_sdk_Illegal_state_error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module SecureNative
+  class SecureNativeSDKIllegalStateError < StandardError
+  end
+end

data/lib/securenative/errors/securenative_sdk_error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module SecureNative
+  class SecureNativeSDKError < StandardError
+  end
+end

data/lib/securenative/event_manager.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+require 'securenative/utils/secure_native_logger'
+require 'securenative/config/securenative_options'
+require 'securenative/http/securenative_http_client'
+require 'securenative/errors/securenative_sdk_error'
+require 'securenative/errors/securenative_http_error'
+
+module SecureNative
+  class QueueItem
+    attr_reader :url, :body, :retry_sending
+    attr_writer :url, :body, :retry_sending
+
+    def initialize(url, body, retry_sending)
+      @url = url
+      @body = body
+      @retry = retry_sending
+    end
+  end
+
+  class EventManager
+    def initialize(options = SecureNativeOptions.new, http_client = nil)
+      if options.api_key.nil?
+        raise SecureNativeSDKError, 'API key cannot be None, please get your API key from SecureNative console.'
+      end
+
+      @http_client = if http_client.nil?
+                       SecureNativeHttpClient.new(options)
+                     else
+                       http_client
+                     end
+
+      @queue = []
+      @semaphore = Mutex.new
+      @interval = options.interval
+      @options = options
+      @send_enabled = false
+      @attempt = 0
+      @coefficients = [1, 1, 2, 3, 5, 8, 13]
+
+      @thread = Thread.new { run }
+    end
+
+    def send_async(event, resource_path)
+      if @options.disable
+        SecureNativeLogger.warning('SDK is disabled. no operation will be performed')
+        return
+      end
+
+      item = QueueItem.new(resource_path, EventManager.serialize(event).to_json, false)
+      @queue.append(item)
+    end
+
+    def flush
+      @queue.each do |item|
+        @http_client.post(item.url, item.body)
+      end
+    end
+
+    def send_sync(event, resource_path, retry_sending)
+      if @options.disable
+        SecureNativeLogger.warning('SDK is disabled. no operation will be performed')
+        return
+      end
+
+      SecureNativeLogger.debug("Attempting to send event #{event}")
+      res = @http_client.post(resource_path, EventManager.serialize(event).to_json)
+
+      if res.nil? || res.code != '200'
+        SecureNativeLogger.info("SecureNative failed to call endpoint #{resource_path} with event #{event}. adding back to queue")
+        item = QueueItem.new(resource_path, EventManager.serialize(event).to_json, retry_sending)
+        @queue.append(item)
+      end
+
+      res
+    end
+
+    def run
+      loop do
+        @semaphore.synchronize do
+          next unless !@queue.empty? && @send_enabled
+
+          @queue.each do |item|
+            begin
+              res = @http_client.post(item.url, item.body)
+              if res.code == '401'
+                item.retry_sending = false
+              elsif res.code != '200'
+                raise SecureNativeHttpError, res.status_code
+              end
+              SecureNativeLogger.debug("Event successfully sent; #{item.body}")
+              return res
+            rescue StandardError => e
+              SecureNativeLogger.error("Failed to send event; #{e}")
+              if item.retry_sending
+                @attempt = 0 if @coefficients.length == @attempt + 1
+
+                back_off = @coefficients[@attempt] * @options.interval
+                SecureNativeLogger.debug("Automatic back-off of #{back_off}")
+                @send_enabled = false
+                sleep back_off
+                @send_enabled = true
+              end
+            end
+          end
+        end
+        sleep @interval / 1000
+      end
+    end
+
+    def start_event_persist
+      SecureNativeLogger.debug('Starting automatic event persistence')
+      if @options.auto_send || @send_enabled
+        @send_enabled = true
+      else
+        SecureNativeLogger.debug('Automatic event persistence is disabled, you should persist events manually')
+      end
+    end
+
+    def stop_event_persist
+      if @send_enabled
+        SecureNativeLogger.debug('Attempting to stop automatic event persistence')
+        begin
+          flush
+          @thread&.stop?
+          SecureNativeLogger.debug('Stopped event persistence')
+        rescue StandardError => e
+          SecureNativeLogger.error("Could not stop event scheduler; #{e}")
+        end
+      end
+    end
+
+    def self.serialize(obj)
+      {
+          rid: obj.rid,
+          eventType: obj.event_type,
+          userId: obj.user_id,
+          userTraits: {
+              name: obj.user_traits.name,
+              email: obj.user_traits.email,
+              phone: obj.user_traits.phone,
+              createdAt: obj.user_traits.created_at
+          },
+          request: {
+              cid: obj.request.cid,
+              vid: obj.request.vid,
+              fp: obj.request.fp,
+              ip: obj.request.ip,
+              remoteIp: obj.request.remote_ip,
+              method: obj.request.http_method || '',
+              url: obj.request.url,
+              headers: obj.request.headers
+          },
+          timestamp: obj.timestamp,
+          properties: obj.properties
+      }
+    end
+  end
+end