securenative 0.1.24 → 0.1.30

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (102) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +2 -2
  3. data/README.md +44 -30
  4. data/lib/securenative.rb +49 -0
  5. data/lib/securenative/api_manager.rb +10 -17
  6. data/lib/securenative/client.rb +75 -0
  7. data/lib/securenative/{models/client_token.rb → client_token.rb} +0 -0
  8. data/lib/securenative/config/configuration_builder.rb +22 -22
  9. data/lib/securenative/config/configuration_manager.rb +42 -43
  10. data/lib/securenative/context.rb +65 -0
  11. data/lib/securenative/{models/device.rb → device.rb} +0 -0
  12. data/lib/securenative/enums/api_route.rb +5 -3
  13. data/lib/securenative/enums/risk_level.rb +7 -5
  14. data/{out/production/securenative-ruby/errors/securenative_config_error.rb → lib/securenative/errors/config_error.rb} +0 -0
  15. data/{out/production/securenative-ruby/errors/securenative_http_error.rb → lib/securenative/errors/http_error.rb} +0 -0
  16. data/{out/production/securenative-ruby/errors/securenative_invalid_options_error.rb → lib/securenative/errors/invalid_options_error.rb} +0 -0
  17. data/lib/securenative/errors/{securenative_invalid_uri_error.rb → invalid_uri_error.rb} +0 -0
  18. data/lib/securenative/errors/{securenative_parse_error.rb → parse_error.rb} +0 -2
  19. data/{out/production/securenative-ruby/errors/securenative_sdk_Illegal_state_error.rb → lib/securenative/errors/sdk_Illegal_state_error.rb} +0 -0
  20. data/{out/production/securenative-ruby/errors/securenative_sdk_error.rb → lib/securenative/errors/sdk_error.rb} +0 -0
  21. data/lib/securenative/event_manager.rb +125 -128
  22. data/lib/securenative/{models/event_options.rb → event_options.rb} +3 -7
  23. data/lib/securenative/{enums/event_types.rb → event_types.rb} +0 -0
  24. data/lib/securenative/{enums/failover_strategy.rb → failover_strategy.rb} +0 -0
  25. data/lib/securenative/frameworks/hanami.rb +46 -0
  26. data/lib/securenative/frameworks/rails.rb +48 -0
  27. data/lib/securenative/frameworks/sinatra.rb +46 -0
  28. data/lib/securenative/{http/securenative_http_client.rb → http_client.rb} +7 -12
  29. data/lib/securenative/{http/secure_native_http_response.rb → http_response.rb} +1 -1
  30. data/lib/securenative/{config/securenative_options.rb → options.rb} +1 -3
  31. data/lib/securenative/{models/request_context.rb → request_context.rb} +0 -0
  32. data/lib/securenative/{models/request_options.rb → request_options.rb} +0 -0
  33. data/lib/securenative/{models/sdk_event.rb → sdk_event.rb} +4 -11
  34. data/lib/securenative/{models/user_traits.rb → user_traits.rb} +0 -0
  35. data/lib/securenative/utils/date_utils.rb +6 -4
  36. data/lib/securenative/utils/encryption_utils.rb +34 -37
  37. data/lib/securenative/utils/ip_utils.rb +15 -15
  38. data/lib/securenative/utils/{secure_native_logger.rb → log.rb} +1 -1
  39. data/lib/securenative/utils/request_utils.rb +55 -42
  40. data/lib/securenative/utils/signature_utils.rb +12 -12
  41. data/lib/securenative/utils/utils.rb +6 -4
  42. data/lib/securenative/utils/version_utils.rb +9 -7
  43. data/lib/securenative/{models/verify_result.rb → verify_result.rb} +0 -0
  44. data/lib/securenative/{errors/securenative_sdk_error.rb → version.rb} +1 -2
  45. data/securenative.gemspec +5 -2
  46. data/{out/test/securenative-ruby → spec}/spec_helper.rb +0 -0
  47. metadata +35 -83
  48. data/lib/securenative/context/hanami_context.rb +0 -44
  49. data/lib/securenative/context/rails_context.rb +0 -46
  50. data/lib/securenative/context/securenative_context.rb +0 -69
  51. data/lib/securenative/context/sinatra_context.rb +0 -44
  52. data/lib/securenative/errors/securenative_config_error.rb +0 -6
  53. data/lib/securenative/errors/securenative_http_error.rb +0 -6
  54. data/lib/securenative/errors/securenative_invalid_options_error.rb +0 -6
  55. data/lib/securenative/errors/securenative_sdk_Illegal_state_error.rb +0 -6
  56. data/lib/securenative/sdk.rb +0 -85
  57. data/out/production/securenative-ruby/api_manager.rb +0 -39
  58. data/out/production/securenative-ruby/config/configuration_builder.rb +0 -27
  59. data/out/production/securenative-ruby/config/configuration_manager.rb +0 -56
  60. data/out/production/securenative-ruby/config/securenative_options.rb +0 -23
  61. data/out/production/securenative-ruby/context/hanami_context.rb +0 -42
  62. data/out/production/securenative-ruby/context/rails_context.rb +0 -44
  63. data/out/production/securenative-ruby/context/securenative_context.rb +0 -67
  64. data/out/production/securenative-ruby/context/sinatra_context.rb +0 -42
  65. data/out/production/securenative-ruby/enums/api_route.rb +0 -6
  66. data/out/production/securenative-ruby/enums/event_types.rb +0 -23
  67. data/out/production/securenative-ruby/enums/failover_strategy.rb +0 -6
  68. data/out/production/securenative-ruby/enums/risk_level.rb +0 -7
  69. data/out/production/securenative-ruby/errors/securenative_invalid_uri_error.rb +0 -4
  70. data/out/production/securenative-ruby/errors/securenative_parse_error.rb +0 -4
  71. data/out/production/securenative-ruby/event_manager.rb +0 -157
  72. data/out/production/securenative-ruby/http/secure_native_http_response.rb +0 -12
  73. data/out/production/securenative-ruby/http/securenative_http_client.rb +0 -50
  74. data/out/production/securenative-ruby/models/client_token.rb +0 -12
  75. data/out/production/securenative-ruby/models/device.rb +0 -10
  76. data/out/production/securenative-ruby/models/event_options.rb +0 -37
  77. data/out/production/securenative-ruby/models/request_context.rb +0 -18
  78. data/out/production/securenative-ruby/models/request_options.rb +0 -12
  79. data/out/production/securenative-ruby/models/sdk_event.rb +0 -49
  80. data/out/production/securenative-ruby/models/user_traits.rb +0 -13
  81. data/out/production/securenative-ruby/models/verify_result.rb +0 -16
  82. data/out/production/securenative-ruby/securenative.rb +0 -83
  83. data/out/production/securenative-ruby/utils/date_utils.rb +0 -9
  84. data/out/production/securenative-ruby/utils/encryption_utils.rb +0 -49
  85. data/out/production/securenative-ruby/utils/ip_utils.rb +0 -23
  86. data/out/production/securenative-ruby/utils/request_utils.rb +0 -69
  87. data/out/production/securenative-ruby/utils/secure_native_logger.rb +0 -44
  88. data/out/production/securenative-ruby/utils/signature_utils.rb +0 -16
  89. data/out/production/securenative-ruby/utils/utils.rb +0 -9
  90. data/out/production/securenative-ruby/utils/version_utils.rb +0 -11
  91. data/out/test/securenative-ruby/spec_api_manager.rb +0 -87
  92. data/out/test/securenative-ruby/spec_context_builder.rb +0 -87
  93. data/out/test/securenative-ruby/spec_date_utils.rb +0 -13
  94. data/out/test/securenative-ruby/spec_encryption_utils.rb +0 -26
  95. data/out/test/securenative-ruby/spec_event_manager.rb +0 -93
  96. data/out/test/securenative-ruby/spec_ip_utils.rb +0 -41
  97. data/out/test/securenative-ruby/spec_request_utils.rb +0 -25
  98. data/out/test/securenative-ruby/spec_sdk_event.rb +0 -24
  99. data/out/test/securenative-ruby/spec_securenative.rb +0 -61
  100. data/out/test/securenative-ruby/spec_securenative_http_client.rb +0 -31
  101. data/out/test/securenative-ruby/spec_signature_utils.rb +0 -18
  102. data/out/test/securenative-ruby/spec_version_util.rb +0 -10
@@ -1,6 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module SecureNative
4
- class SecureNativeConfigError < StandardError
5
- end
6
- end
@@ -1,6 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module SecureNative
4
- class SecureNativeHttpError < StandardError
5
- end
6
- end
@@ -1,6 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module SecureNative
4
- class SecureNativeInvalidOptionsError < StandardError
5
- end
6
- end
@@ -1,6 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module SecureNative
4
- class SecureNativeSDKIllegalStateError < StandardError
5
- end
6
- end
@@ -1,85 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- require 'securenative/utils/secure_native_logger'
4
- require 'securenative/utils/signature_utils'
5
- require 'securenative/utils/utils'
6
- require 'securenative/errors/securenative_sdk_error'
7
- require 'securenative/errors/securenative_sdk_Illegal_state_error'
8
- require 'securenative/errors/securenative_config_error'
9
- require 'securenative/enums/failover_strategy'
10
- require 'securenative/config/configuration_builder'
11
- require 'securenative/config/configuration_manager'
12
- require 'securenative/event_manager'
13
- require 'securenative/api_manager'
14
-
15
- module SecureNative
16
- class SecureNative
17
- attr_reader :options
18
-
19
- def initialize(options)
20
- @securenative = nil
21
- raise SecureNativeSDKError, 'You must pass your SecureNative api key' if Utils.null_or_empty?(options.api_key)
22
-
23
- @options = options
24
- @event_manager = EventManager.new(@options)
25
-
26
- @event_manager.start_event_persist unless @options.api_url.nil?
27
-
28
- @api_manager = ApiManager.new(@event_manager, @options)
29
- SecureNativeLogger.init_logger(@options.log_level)
30
- end
31
-
32
- def self.init_with_options(options)
33
- if @securenative.nil?
34
- @securenative = SecureNative.new(options)
35
- @securenative
36
- else
37
- SecureNativeLogger.debug('This SDK was already initialized.')
38
- raise SecureNativeSDKError, 'This SDK was already initialized.'
39
- end
40
- end
41
-
42
- def self.init_with_api_key(api_key)
43
- raise SecureNativeConfigError, 'You must pass your SecureNative api key' if Utils.null_or_empty?(api_key)
44
-
45
- if @securenative.nil?
46
- options = ConfigurationBuilder.new(api_key: api_key)
47
- @securenative = SecureNative.new(options)
48
- @securenative
49
- else
50
- SecureNativeLogger.debug('This SDK was already initialized.')
51
- raise SecureNativeSDKError, 'This SDK was already initialized.'
52
- end
53
- end
54
-
55
- def self.init
56
- options = ConfigurationManager.load_config
57
- init_with_options(options)
58
- end
59
-
60
- def self.instance
61
- raise SecureNativeSDKIllegalStateError if @securenative.nil?
62
-
63
- @securenative
64
- end
65
-
66
- def track(event_options)
67
- @api_manager.track(event_options)
68
- end
69
-
70
- def verify(event_options)
71
- @api_manager.verify(event_options)
72
- end
73
-
74
- def self._flush
75
- @securenative = nil
76
- end
77
-
78
- def verify_request_payload(request)
79
- request_signature = request.header[SignatureUtils.SIGNATURE_HEADER]
80
- body = request.body
81
-
82
- SignatureUtils.valid_signature?(@options.api_key, body, request_signature)
83
- end
84
- end
85
- end
@@ -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: [])
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: [])
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
@@ -1,42 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- class SinatraContext
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_URI']
21
- rescue StandardError
22
- nil
23
- end
24
- end
25
-
26
- def self.get_method(request)
27
- begin
28
- request.env['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