securenative 0.1.23 → 0.1.24

Sign up to get free protection for your applications and to get access to all the features.
Files changed (83) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +3 -5
  3. data/README.md +36 -36
  4. data/lib/securenative/api_manager.rb +41 -0
  5. data/lib/securenative/config/configuration_builder.rb +29 -0
  6. data/lib/securenative/config/configuration_manager.rb +58 -0
  7. data/lib/securenative/config/securenative_options.rb +25 -0
  8. data/lib/securenative/context/hanami_context.rb +44 -0
  9. data/lib/securenative/context/rails_context.rb +46 -0
  10. data/lib/securenative/context/securenative_context.rb +69 -0
  11. data/lib/securenative/context/sinatra_context.rb +44 -0
  12. data/lib/securenative/enums/api_route.rb +8 -0
  13. data/lib/securenative/enums/event_types.rb +25 -0
  14. data/lib/securenative/enums/failover_strategy.rb +8 -0
  15. data/lib/securenative/enums/risk_level.rb +9 -0
  16. data/lib/securenative/errors/securenative_config_error.rb +6 -0
  17. data/lib/securenative/errors/securenative_http_error.rb +6 -0
  18. data/lib/securenative/errors/securenative_invalid_options_error.rb +6 -0
  19. data/lib/securenative/errors/securenative_invalid_uri_error.rb +6 -0
  20. data/lib/securenative/errors/securenative_parse_error.rb +6 -0
  21. data/lib/securenative/errors/securenative_sdk_Illegal_state_error.rb +6 -0
  22. data/lib/securenative/errors/securenative_sdk_error.rb +6 -0
  23. data/lib/securenative/event_manager.rb +159 -0
  24. data/lib/securenative/http/secure_native_http_response.rb +14 -0
  25. data/lib/securenative/http/securenative_http_client.rb +52 -0
  26. data/lib/securenative/models/client_token.rb +14 -0
  27. data/lib/securenative/models/device.rb +12 -0
  28. data/lib/securenative/models/event_options.rb +39 -0
  29. data/lib/securenative/models/request_context.rb +20 -0
  30. data/lib/securenative/models/request_options.rb +14 -0
  31. data/lib/securenative/models/sdk_event.rb +51 -0
  32. data/lib/securenative/models/user_traits.rb +15 -0
  33. data/lib/securenative/models/verify_result.rb +18 -0
  34. data/lib/securenative/sdk.rb +85 -0
  35. data/lib/securenative/utils/date_utils.rb +11 -0
  36. data/lib/securenative/utils/encryption_utils.rb +51 -0
  37. data/lib/securenative/utils/ip_utils.rb +25 -0
  38. data/lib/securenative/utils/request_utils.rb +71 -0
  39. data/lib/securenative/utils/secure_native_logger.rb +46 -0
  40. data/lib/securenative/utils/signature_utils.rb +18 -0
  41. data/lib/securenative/utils/utils.rb +11 -0
  42. data/lib/securenative/utils/version_utils.rb +13 -0
  43. data/securenative.gemspec +16 -14
  44. metadata +40 -40
  45. data/lib/api_manager.rb +0 -39
  46. data/lib/config/configuration_builder.rb +0 -27
  47. data/lib/config/configuration_manager.rb +0 -56
  48. data/lib/config/securenative_options.rb +0 -23
  49. data/lib/context/hanami_context.rb +0 -42
  50. data/lib/context/rails_context.rb +0 -44
  51. data/lib/context/securenative_context.rb +0 -67
  52. data/lib/context/sinatra_context.rb +0 -42
  53. data/lib/enums/api_route.rb +0 -6
  54. data/lib/enums/event_types.rb +0 -23
  55. data/lib/enums/failover_strategy.rb +0 -6
  56. data/lib/enums/risk_level.rb +0 -7
  57. data/lib/errors/securenative_config_error.rb +0 -4
  58. data/lib/errors/securenative_http_error.rb +0 -4
  59. data/lib/errors/securenative_invalid_options_error.rb +0 -4
  60. data/lib/errors/securenative_invalid_uri_error.rb +0 -4
  61. data/lib/errors/securenative_parse_error.rb +0 -4
  62. data/lib/errors/securenative_sdk_Illegal_state_error.rb +0 -4
  63. data/lib/errors/securenative_sdk_error.rb +0 -4
  64. data/lib/event_manager.rb +0 -157
  65. data/lib/http/secure_native_http_response.rb +0 -12
  66. data/lib/http/securenative_http_client.rb +0 -50
  67. data/lib/models/client_token.rb +0 -12
  68. data/lib/models/device.rb +0 -10
  69. data/lib/models/event_options.rb +0 -37
  70. data/lib/models/request_context.rb +0 -18
  71. data/lib/models/request_options.rb +0 -12
  72. data/lib/models/sdk_event.rb +0 -49
  73. data/lib/models/user_traits.rb +0 -13
  74. data/lib/models/verify_result.rb +0 -16
  75. data/lib/securenative.rb +0 -83
  76. data/lib/utils/date_utils.rb +0 -9
  77. data/lib/utils/encryption_utils.rb +0 -49
  78. data/lib/utils/ip_utils.rb +0 -23
  79. data/lib/utils/request_utils.rb +0 -69
  80. data/lib/utils/secure_native_logger.rb +0 -44
  81. data/lib/utils/signature_utils.rb +0 -16
  82. data/lib/utils/utils.rb +0 -9
  83. data/lib/utils/version_utils.rb +0 -11
@@ -0,0 +1,13 @@
1
+ # frozen_string_literal: true
2
+
3
+ module SecureNative
4
+ class VersionUtils
5
+ def self.version
6
+ begin
7
+ Gem.loaded_specs['securenative'].version.to_s
8
+ rescue StandardError
9
+ 'unknown'
10
+ end
11
+ end
12
+ end
13
+ end
@@ -1,28 +1,30 @@
1
- lib = File.expand_path("lib", __dir__)
1
+ # frozen_string_literal: true
2
+
3
+ lib = File.expand_path('lib', __dir__)
2
4
  $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
3
- require_relative "lib/utils/version_utils"
5
+ require_relative 'lib/securenative/utils/version_utils'
4
6
 
5
7
  Gem::Specification.new do |spec|
6
- spec.name = "securenative"
7
- spec.version = "0.1.23"
8
- spec.authors = ["SecureNative"]
9
- spec.email = ["support@securenative.com"]
8
+ spec.name = 'securenative'
9
+ spec.version = '0.1.24'
10
+ spec.authors = ['SecureNative']
11
+ spec.email = ['support@securenative.com']
10
12
 
11
- spec.summary = %q{SecureNative SDK for Ruby}
12
- spec.homepage = "https://www.securenative.com"
13
- spec.license = "MIT"
13
+ spec.summary = 'SecureNative SDK for Ruby'
14
+ spec.homepage = 'https://www.securenative.com'
15
+ spec.license = 'MIT'
14
16
 
15
- spec.metadata["homepage_uri"] = spec.homepage
17
+ spec.metadata['homepage_uri'] = spec.homepage
16
18
 
17
19
  # Specify which files should be added to the gem when it is released.
18
20
  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
19
21
  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
20
22
  `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
21
23
  end
22
- spec.bindir = "exe"
24
+ spec.bindir = 'exe'
23
25
  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
24
- spec.require_paths = ["lib"]
26
+ spec.require_paths = ['lib']
25
27
 
26
- spec.add_development_dependency "bundler", "~> 2.0"
27
- spec.add_development_dependency "rake", "~> 12.3.3"
28
+ spec.add_development_dependency 'bundler', '~> 2.0'
29
+ spec.add_development_dependency 'rake', '~> 12.3.3'
28
30
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: securenative
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.23
4
+ version: 0.1.24
5
5
  platform: ruby
6
6
  authors:
7
7
  - SecureNative
@@ -58,45 +58,45 @@ files:
58
58
  - Rakefile
59
59
  - bin/console
60
60
  - bin/setup
61
- - lib/api_manager.rb
62
- - lib/config/configuration_builder.rb
63
- - lib/config/configuration_manager.rb
64
- - lib/config/securenative_options.rb
65
- - lib/context/hanami_context.rb
66
- - lib/context/rails_context.rb
67
- - lib/context/securenative_context.rb
68
- - lib/context/sinatra_context.rb
69
- - lib/enums/api_route.rb
70
- - lib/enums/event_types.rb
71
- - lib/enums/failover_strategy.rb
72
- - lib/enums/risk_level.rb
73
- - lib/errors/securenative_config_error.rb
74
- - lib/errors/securenative_http_error.rb
75
- - lib/errors/securenative_invalid_options_error.rb
76
- - lib/errors/securenative_invalid_uri_error.rb
77
- - lib/errors/securenative_parse_error.rb
78
- - lib/errors/securenative_sdk_Illegal_state_error.rb
79
- - lib/errors/securenative_sdk_error.rb
80
- - lib/event_manager.rb
81
- - lib/http/secure_native_http_response.rb
82
- - lib/http/securenative_http_client.rb
83
- - lib/models/client_token.rb
84
- - lib/models/device.rb
85
- - lib/models/event_options.rb
86
- - lib/models/request_context.rb
87
- - lib/models/request_options.rb
88
- - lib/models/sdk_event.rb
89
- - lib/models/user_traits.rb
90
- - lib/models/verify_result.rb
91
- - lib/securenative.rb
92
- - lib/utils/date_utils.rb
93
- - lib/utils/encryption_utils.rb
94
- - lib/utils/ip_utils.rb
95
- - lib/utils/request_utils.rb
96
- - lib/utils/secure_native_logger.rb
97
- - lib/utils/signature_utils.rb
98
- - lib/utils/utils.rb
99
- - lib/utils/version_utils.rb
61
+ - lib/securenative/api_manager.rb
62
+ - lib/securenative/config/configuration_builder.rb
63
+ - lib/securenative/config/configuration_manager.rb
64
+ - lib/securenative/config/securenative_options.rb
65
+ - lib/securenative/context/hanami_context.rb
66
+ - lib/securenative/context/rails_context.rb
67
+ - lib/securenative/context/securenative_context.rb
68
+ - lib/securenative/context/sinatra_context.rb
69
+ - lib/securenative/enums/api_route.rb
70
+ - lib/securenative/enums/event_types.rb
71
+ - lib/securenative/enums/failover_strategy.rb
72
+ - lib/securenative/enums/risk_level.rb
73
+ - lib/securenative/errors/securenative_config_error.rb
74
+ - lib/securenative/errors/securenative_http_error.rb
75
+ - lib/securenative/errors/securenative_invalid_options_error.rb
76
+ - lib/securenative/errors/securenative_invalid_uri_error.rb
77
+ - lib/securenative/errors/securenative_parse_error.rb
78
+ - lib/securenative/errors/securenative_sdk_Illegal_state_error.rb
79
+ - lib/securenative/errors/securenative_sdk_error.rb
80
+ - lib/securenative/event_manager.rb
81
+ - lib/securenative/http/secure_native_http_response.rb
82
+ - lib/securenative/http/securenative_http_client.rb
83
+ - lib/securenative/models/client_token.rb
84
+ - lib/securenative/models/device.rb
85
+ - lib/securenative/models/event_options.rb
86
+ - lib/securenative/models/request_context.rb
87
+ - lib/securenative/models/request_options.rb
88
+ - lib/securenative/models/sdk_event.rb
89
+ - lib/securenative/models/user_traits.rb
90
+ - lib/securenative/models/verify_result.rb
91
+ - lib/securenative/sdk.rb
92
+ - lib/securenative/utils/date_utils.rb
93
+ - lib/securenative/utils/encryption_utils.rb
94
+ - lib/securenative/utils/ip_utils.rb
95
+ - lib/securenative/utils/request_utils.rb
96
+ - lib/securenative/utils/secure_native_logger.rb
97
+ - lib/securenative/utils/signature_utils.rb
98
+ - lib/securenative/utils/utils.rb
99
+ - lib/securenative/utils/version_utils.rb
100
100
  - out/production/securenative-ruby/api_manager.rb
101
101
  - out/production/securenative-ruby/config/configuration_builder.rb
102
102
  - out/production/securenative-ruby/config/configuration_manager.rb
@@ -1,39 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- require 'models/sdk_event'
4
- require 'enums/failover_strategy'
5
- require 'enums/risk_level'
6
- require 'enums/api_route'
7
- require 'models/verify_result'
8
- require 'json'
9
-
10
- class ApiManager
11
- def initialize(event_manager, securenative_options)
12
- @event_manager = event_manager
13
- @options = securenative_options
14
- end
15
-
16
- def track(event_options)
17
- SecureNativeLogger.debug('Track event call')
18
- event = SDKEvent.new(event_options, @options)
19
- @event_manager.send_async(event, ApiRoute::TRACK)
20
- end
21
-
22
- def verify(event_options)
23
- SecureNativeLogger.debug('Verify event call')
24
- event = SDKEvent.new(event_options, @options)
25
-
26
- begin
27
- res = @event_manager.send_sync(event, ApiRoute::VERIFY, false)
28
- ver_result = JSON.parse(res.body)
29
- return VerifyResult.new(risk_level: ver_result['riskLevel'], score: ver_result['score'], triggers: ver_result['triggers'])
30
- rescue StandardError => e
31
- SecureNativeLogger.debug("Failed to call verify; #{e}")
32
- end
33
- if @options.fail_over_strategy == FailOverStrategy::FAIL_OPEN
34
- return VerifyResult.new(risk_level: RiskLevel::LOW, score: 0, triggers: nil)
35
- end
36
-
37
- VerifyResult.new(risk_level: RiskLevel::HIGH, score: 1, triggers: nil)
38
- end
39
- end
@@ -1,27 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- require 'enums/failover_strategy'
4
-
5
- class ConfigurationBuilder
6
- attr_reader :api_key, :api_url, :interval, :max_events, :timeout, :auto_send, :disable, :log_level, :fail_over_strategy, :proxy_headers
7
- attr_writer :api_key, :api_url, :interval, :max_events, :timeout, :auto_send, :disable, :log_level, :fail_over_strategy, :proxy_headers
8
-
9
- def initialize(api_key: nil, api_url: 'https://api.securenative.com/collector/api/v1', interval: 1000,
10
- max_events: 1000, timeout: 1500, auto_send: true, disable: false, log_level: 'FATAL',
11
- fail_over_strategy: FailOverStrategy::FAIL_OPEN, proxy_headers: nil)
12
- @api_key = api_key
13
- @api_url = api_url
14
- @interval = interval
15
- @max_events = max_events
16
- @timeout = timeout
17
- @auto_send = auto_send
18
- @disable = disable
19
- @log_level = log_level
20
- @fail_over_strategy = fail_over_strategy
21
- @proxy_headers = proxy_headers
22
- end
23
-
24
- def self.default_securenative_options
25
- SecureNativeOptions.new
26
- end
27
- end
@@ -1,56 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- require 'yaml'
4
- require 'config/configuration_builder'
5
-
6
- class ConfigurationManager
7
- DEFAULT_CONFIG_FILE = 'securenative.yml'
8
- CUSTOM_CONFIG_FILE_ENV_NAME = 'SECURENATIVE_CONFIG_FILE'
9
- @config = nil
10
-
11
- def self.read_resource_file(resource_path)
12
- properties = {}
13
- begin
14
- @config = YAML.load_file(resource_path)
15
- properties = @config unless @config.nil?
16
- rescue StandardError => e
17
- SecureNativeLogger.error("Could not parse config file #{resource_path}; #{e}")
18
- end
19
- properties
20
- end
21
-
22
- def self._get_resource_path(env_name)
23
- Env.fetch(env_name, ENV[DEFAULT_CONFIG_FILE])
24
- end
25
-
26
- def self.config_builder
27
- ConfigurationBuilder.new
28
- end
29
-
30
- def self._get_env_or_default(properties, key, default)
31
- return ENV[key] if ENV[key]
32
- return properties[key] if properties[key]
33
-
34
- default
35
- end
36
-
37
- def self.load_config
38
- options = ConfigurationBuilder.default_securenative_options
39
-
40
- resource_path = DEFAULT_CONFIG_FILE
41
- resource_path = ENV[CUSTOM_CONFIG_FILE_ENV_NAME] unless ENV[CUSTOM_CONFIG_FILE_ENV_NAME].nil?
42
-
43
- properties = read_resource_file(resource_path)
44
-
45
- ConfigurationBuilder.new(api_key: _get_env_or_default(properties, 'SECURENATIVE_API_KEY', options.api_key),
46
- api_url: _get_env_or_default(properties, 'SECURENATIVE_API_URL', options.api_url),
47
- interval: _get_env_or_default(properties, 'SECURENATIVE_INTERVAL', options.interval),
48
- max_events: _get_env_or_default(properties, 'SECURENATIVE_MAX_EVENTS', options.max_events),
49
- timeout: _get_env_or_default(properties, 'SECURENATIVE_TIMEOUT', options.timeout),
50
- auto_send: _get_env_or_default(properties, 'SECURENATIVE_AUTO_SEND', options.auto_send),
51
- disable: _get_env_or_default(properties, 'SECURENATIVE_DISABLE', options.disable),
52
- log_level: _get_env_or_default(properties, 'SECURENATIVE_LOG_LEVEL', options.log_level),
53
- fail_over_strategy: _get_env_or_default(properties, 'SECURENATIVE_FAILOVER_STRATEGY', options.fail_over_strategy),
54
- proxy_headers: _get_env_or_default(properties, 'SECURENATIVE_PROXY_HEADERS', options.proxy_headers))
55
- end
56
- end
@@ -1,23 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- require 'enums/failover_strategy'
4
-
5
- class SecureNativeOptions
6
- attr_reader :api_key, :api_url, :interval, :max_events, :timeout, :auto_send, :disable, :log_level, :fail_over_strategy, :proxy_headers
7
- attr_writer :api_key, :api_url, :interval, :max_events, :timeout, :auto_send, :disable, :log_level, :fail_over_strategy, :proxy_headers
8
-
9
- def initialize(api_key: nil, api_url: "https://api.securenative.com/collector/api/v1", interval: 1000,
10
- max_events: 1000, timeout: 1500, auto_send: true, disable: false, log_level: "FATAL",
11
- fail_over_strategy: FailOverStrategy::FAIL_OPEN, proxy_headers: nil)
12
- @api_key = api_key
13
- @api_url = api_url
14
- @interval = interval
15
- @max_events = max_events
16
- @timeout = timeout
17
- @auto_send = auto_send
18
- @disable = disable
19
- @log_level = log_level
20
- @fail_over_strategy = fail_over_strategy
21
- @proxy_headers = proxy_headers
22
- end
23
- end
@@ -1,42 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- class HanamiContext
4
- SECURENATIVE_COOKIE = '_sn'
5
-
6
- def self.get_client_token(request)
7
- begin
8
- request.env[SECURENATIVE_COOKIE]
9
- rescue StandardError
10
- begin
11
- request.cookies[SECURENATIVE_COOKIE]
12
- rescue StandardError
13
- nil
14
- end
15
- end
16
- end
17
-
18
- def self.get_url(request)
19
- begin
20
- request.env['REQUEST_PATH']
21
- rescue StandardError
22
- nil
23
- end
24
- end
25
-
26
- def self.get_method(request)
27
- begin
28
- request.request_method
29
- rescue StandardError
30
- nil
31
- end
32
- end
33
-
34
- def self.get_headers(request)
35
- begin
36
- # Note: At the moment we're filtering out everything but user-agent since ruby's payload is way too big
37
- { 'user-agent' => request.env['HTTP_USER_AGENT'] }
38
- rescue StandardError
39
- nil
40
- end
41
- end
42
- end
@@ -1,44 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- class RailsContext
4
- SECURENATIVE_COOKIE = '_sn'
5
-
6
- def self.get_client_token(request)
7
- begin
8
- request.cookies[SECURENATIVE_COOKIE]
9
- rescue StandardError
10
- nil
11
- end
12
- end
13
-
14
- def self.get_url(request)
15
- begin
16
- # Rails >= 3.x
17
- request.fullpath
18
- rescue StandardError
19
- begin
20
- # Rails < 3.x & Sinatra
21
- request.url if url.nil?
22
- rescue StandardError
23
- nil
24
- end
25
- end
26
- end
27
-
28
- def self.get_method(request)
29
- begin
30
- request.method
31
- rescue StandardError
32
- nil
33
- end
34
- end
35
-
36
- def self.get_headers(request)
37
- begin
38
- # Note: At the moment we're filtering out everything but user-agent since ruby's payload is way too big
39
- { 'user-agent' => request.env['HTTP_USER_AGENT'] }
40
- rescue StandardError
41
- nil
42
- end
43
- end
44
- end
@@ -1,67 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- require 'utils/request_utils'
4
- require 'utils/utils'
5
- require 'context/rails_context'
6
- require 'context/hanami_context'
7
- require 'context/sinatra_context'
8
-
9
- class SecureNativeContext
10
- attr_reader :client_token, :ip, :remote_ip, :headers, :url, :http_method, :body
11
- attr_writer :client_token, :ip, :remote_ip, :headers, :url, :http_method, :body
12
-
13
- SECURENATIVE_COOKIE = '_sn'
14
-
15
- def initialize(client_token: '', ip: '', remote_ip: '', headers: nil, url: '', http_method: '', body: '')
16
- @client_token = client_token
17
- @ip = ip
18
- @remote_ip = remote_ip
19
- @headers = headers
20
- @url = url
21
- @http_method = http_method
22
- @body = body
23
- end
24
-
25
- def self.default_context_builder
26
- SecureNativeContext.new
27
- end
28
-
29
- def self.from_http_request(request)
30
- client_token = RailsContext.get_client_token(request)
31
- client_token = SinatraContext.get_client_token(request) if client_token.nil?
32
- client_token = HanamiContext.get_client_token(request) if client_token.nil?
33
-
34
- begin
35
- headers = RailsContext.get_headers(request)
36
- headers = SinatraContext.get_headers(request) if headers.nil?
37
- headers = HanamiContext.get_headers(request) if headers.nil?
38
-
39
- # Standard Ruby request
40
- headers = request.header.to_hash if headers.nil?
41
- rescue StandardError
42
- headers = []
43
- end
44
-
45
- url = RailsContext.get_url(request)
46
- url = SinatraContext.get_url(request) if url.nil?
47
- url = HanamiContext.get_url(request) if url.nil?
48
- url = '' if url.nil?
49
-
50
- method = RailsContext.get_method(request)
51
- method = SinatraContext.get_method(request) if method.nil?
52
- method = HanamiContext.get_method(request) if method.nil?
53
- method = '' if method.nil?
54
-
55
- begin
56
- body = request.body.to_s
57
- rescue StandardError
58
- body = ''
59
- end
60
-
61
- client_token = RequestUtils.get_secure_header_from_request(headers) if Utils.null_or_empty?(client_token)
62
-
63
- SecureNativeContext.new(client_token: client_token, ip: RequestUtils.get_client_ip_from_request(request),
64
- remote_ip: RequestUtils.get_remote_ip_from_request(request),
65
- headers: headers, url: url, http_method: method || '', body: body)
66
- end
67
- end