contrast-agent 4.14.1 → 5.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (389) hide show
  1. checksums.yaml +4 -4
  2. data/.simplecov +1 -1
  3. data/Gemfile +1 -1
  4. data/LICENSE.txt +1 -1
  5. data/Rakefile +1 -1
  6. data/exe/contrast_service +1 -1
  7. data/ext/build_funchook.rb +1 -1
  8. data/ext/cs__assess_array/cs__assess_array.c +1 -1
  9. data/ext/cs__assess_array/extconf.rb +1 -1
  10. data/ext/cs__assess_basic_object/cs__assess_basic_object.c +1 -1
  11. data/ext/cs__assess_basic_object/extconf.rb +1 -1
  12. data/ext/cs__assess_fiber_track/cs__assess_fiber_track.c +1 -1
  13. data/ext/cs__assess_fiber_track/extconf.rb +1 -1
  14. data/ext/cs__assess_hash/cs__assess_hash.c +1 -1
  15. data/ext/cs__assess_hash/extconf.rb +1 -1
  16. data/ext/cs__assess_kernel/cs__assess_kernel.c +1 -1
  17. data/ext/cs__assess_kernel/extconf.rb +1 -1
  18. data/ext/cs__assess_marshal_module/cs__assess_marshal_module.c +1 -1
  19. data/ext/cs__assess_marshal_module/extconf.rb +1 -1
  20. data/ext/cs__assess_module/cs__assess_module.c +1 -1
  21. data/ext/cs__assess_module/extconf.rb +1 -1
  22. data/ext/cs__assess_regexp/cs__assess_regexp.c +1 -1
  23. data/ext/cs__assess_regexp/extconf.rb +1 -1
  24. data/ext/cs__assess_string/cs__assess_string.c +1 -1
  25. data/ext/cs__assess_string/extconf.rb +1 -1
  26. data/ext/cs__assess_string_interpolation26/cs__assess_string_interpolation26.c +1 -1
  27. data/ext/cs__assess_string_interpolation26/extconf.rb +1 -1
  28. data/ext/cs__assess_yield_track/cs__assess_yield_track.c +1 -1
  29. data/ext/cs__assess_yield_track/extconf.rb +1 -1
  30. data/ext/cs__common/cs__common.c +1 -1
  31. data/ext/cs__common/extconf.rb +1 -1
  32. data/ext/cs__contrast_patch/cs__contrast_patch.c +1 -1
  33. data/ext/cs__contrast_patch/extconf.rb +1 -1
  34. data/ext/cs__os_information/cs__os_information.c +1 -1
  35. data/ext/cs__os_information/extconf.rb +1 -1
  36. data/ext/extconf_common.rb +1 -1
  37. data/lib/contrast/agent/assess/contrast_event.rb +7 -11
  38. data/lib/contrast/agent/assess/contrast_object.rb +1 -1
  39. data/lib/contrast/agent/assess/events/event_data.rb +30 -0
  40. data/lib/contrast/agent/assess/events/event_factory.rb +14 -6
  41. data/lib/contrast/agent/assess/events/source_event.rb +22 -3
  42. data/lib/contrast/agent/assess/finalizers/freeze.rb +1 -1
  43. data/lib/contrast/agent/assess/finalizers/hash.rb +1 -1
  44. data/lib/contrast/agent/assess/policy/dynamic_source_factory.rb +7 -7
  45. data/lib/contrast/agent/assess/policy/patcher.rb +1 -35
  46. data/lib/contrast/agent/assess/policy/policy.rb +1 -1
  47. data/lib/contrast/agent/assess/policy/policy_node.rb +2 -2
  48. data/lib/contrast/agent/assess/policy/policy_scanner.rb +1 -1
  49. data/lib/contrast/agent/assess/policy/preshift.rb +1 -1
  50. data/lib/contrast/agent/assess/policy/propagation_method.rb +55 -28
  51. data/lib/contrast/agent/assess/policy/propagation_node.rb +1 -1
  52. data/lib/contrast/agent/assess/policy/propagator/append.rb +1 -1
  53. data/lib/contrast/agent/assess/policy/propagator/base.rb +1 -1
  54. data/lib/contrast/agent/assess/policy/propagator/center.rb +1 -1
  55. data/lib/contrast/agent/assess/policy/propagator/custom.rb +1 -1
  56. data/lib/contrast/agent/assess/policy/propagator/database_write.rb +6 -2
  57. data/lib/contrast/agent/assess/policy/propagator/insert.rb +5 -2
  58. data/lib/contrast/agent/assess/policy/propagator/keep.rb +1 -1
  59. data/lib/contrast/agent/assess/policy/propagator/match_data.rb +7 -3
  60. data/lib/contrast/agent/assess/policy/propagator/next.rb +1 -1
  61. data/lib/contrast/agent/assess/policy/propagator/prepend.rb +1 -1
  62. data/lib/contrast/agent/assess/policy/propagator/rack_protection.rb +1 -1
  63. data/lib/contrast/agent/assess/policy/propagator/remove.rb +1 -1
  64. data/lib/contrast/agent/assess/policy/propagator/replace.rb +1 -1
  65. data/lib/contrast/agent/assess/policy/propagator/reverse.rb +1 -1
  66. data/lib/contrast/agent/assess/policy/propagator/select.rb +3 -2
  67. data/lib/contrast/agent/assess/policy/propagator/splat.rb +1 -1
  68. data/lib/contrast/agent/assess/policy/propagator/split.rb +27 -25
  69. data/lib/contrast/agent/assess/policy/propagator/substitution.rb +3 -5
  70. data/lib/contrast/agent/assess/policy/propagator/substitution_utils.rb +190 -0
  71. data/lib/contrast/agent/assess/policy/propagator/trim.rb +9 -4
  72. data/lib/contrast/agent/assess/policy/propagator.rb +1 -1
  73. data/lib/contrast/agent/assess/policy/source_method.rb +39 -26
  74. data/lib/contrast/agent/assess/policy/source_node.rb +1 -1
  75. data/lib/contrast/agent/assess/policy/source_validation/cross_site_validator.rb +1 -1
  76. data/lib/contrast/agent/assess/policy/source_validation/source_validation.rb +1 -1
  77. data/lib/contrast/agent/assess/policy/trigger/reflected_xss.rb +7 -2
  78. data/lib/contrast/agent/assess/policy/trigger/xpath.rb +1 -1
  79. data/lib/contrast/agent/assess/policy/trigger_method.rb +37 -24
  80. data/lib/contrast/agent/assess/policy/trigger_node.rb +1 -1
  81. data/lib/contrast/agent/assess/policy/trigger_validation/redos_validator.rb +1 -1
  82. data/lib/contrast/agent/assess/policy/trigger_validation/ssrf_validator.rb +1 -1
  83. data/lib/contrast/agent/assess/policy/trigger_validation/trigger_validation.rb +1 -1
  84. data/lib/contrast/agent/assess/policy/trigger_validation/xss_validator.rb +1 -1
  85. data/lib/contrast/agent/assess/properties.rb +1 -1
  86. data/lib/contrast/agent/assess/property/evented.rb +25 -12
  87. data/lib/contrast/agent/assess/property/tagged.rb +1 -1
  88. data/lib/contrast/agent/assess/property/updated.rb +1 -1
  89. data/lib/contrast/agent/assess/rule/provider/hardcoded_key.rb +1 -19
  90. data/lib/contrast/agent/assess/rule/provider/hardcoded_password.rb +1 -13
  91. data/lib/contrast/agent/assess/rule/provider/hardcoded_value_rule.rb +7 -59
  92. data/lib/contrast/agent/assess/rule/provider.rb +1 -1
  93. data/lib/contrast/agent/assess/rule/response/autocomplete_rule.rb +130 -0
  94. data/lib/contrast/agent/assess/rule/response/base_rule.rb +117 -0
  95. data/lib/contrast/agent/assess/tag.rb +1 -1
  96. data/lib/contrast/agent/assess/tracker.rb +1 -1
  97. data/lib/contrast/agent/assess.rb +1 -2
  98. data/lib/contrast/agent/at_exit_hook.rb +1 -1
  99. data/lib/contrast/agent/deadzone/policy/deadzone_node.rb +13 -8
  100. data/lib/contrast/agent/deadzone/policy/policy.rb +1 -1
  101. data/lib/contrast/agent/disable_reaction.rb +1 -1
  102. data/lib/contrast/agent/exclusion_matcher.rb +1 -1
  103. data/lib/contrast/agent/inventory/database_config.rb +115 -77
  104. data/lib/contrast/agent/inventory/dependencies.rb +1 -1
  105. data/lib/contrast/agent/inventory/dependency_analysis.rb +1 -1
  106. data/lib/contrast/agent/inventory/dependency_usage_analysis.rb +3 -3
  107. data/lib/contrast/agent/inventory/policy/datastores.rb +1 -1
  108. data/lib/contrast/agent/inventory/policy/policy.rb +1 -1
  109. data/lib/contrast/agent/inventory/policy/trigger_node.rb +1 -1
  110. data/lib/contrast/agent/inventory.rb +1 -1
  111. data/lib/contrast/agent/metric_telemetry_event.rb +1 -1
  112. data/lib/contrast/agent/middleware.rb +3 -2
  113. data/lib/contrast/agent/module_data.rb +1 -1
  114. data/lib/contrast/agent/patching/policy/after_load_patch.rb +1 -1
  115. data/lib/contrast/agent/patching/policy/after_load_patcher.rb +1 -1
  116. data/lib/contrast/agent/patching/policy/method_policy.rb +28 -15
  117. data/lib/contrast/agent/patching/policy/method_policy_extend.rb +12 -10
  118. data/lib/contrast/agent/patching/policy/module_policy.rb +1 -1
  119. data/lib/contrast/agent/patching/policy/patch.rb +1 -1
  120. data/lib/contrast/agent/patching/policy/patch_status.rb +2 -26
  121. data/lib/contrast/agent/patching/policy/patcher.rb +1 -5
  122. data/lib/contrast/agent/patching/policy/policy.rb +1 -1
  123. data/lib/contrast/agent/patching/policy/policy_node.rb +1 -1
  124. data/lib/contrast/agent/patching/policy/trigger_node.rb +1 -1
  125. data/lib/contrast/agent/protect/policy/applies_command_injection_rule.rb +1 -1
  126. data/lib/contrast/agent/protect/policy/applies_deserialization_rule.rb +1 -1
  127. data/lib/contrast/agent/protect/policy/applies_no_sqli_rule.rb +1 -1
  128. data/lib/contrast/agent/protect/policy/applies_path_traversal_rule.rb +1 -1
  129. data/lib/contrast/agent/protect/policy/applies_sqli_rule.rb +1 -1
  130. data/lib/contrast/agent/protect/policy/applies_xxe_rule.rb +1 -1
  131. data/lib/contrast/agent/protect/policy/policy.rb +1 -1
  132. data/lib/contrast/agent/protect/policy/rule_applicator.rb +1 -1
  133. data/lib/contrast/agent/protect/policy/trigger_node.rb +1 -1
  134. data/lib/contrast/agent/protect/rule/base.rb +1 -1
  135. data/lib/contrast/agent/protect/rule/base_service.rb +1 -1
  136. data/lib/contrast/agent/protect/rule/cmd_injection.rb +1 -1
  137. data/lib/contrast/agent/protect/rule/default_scanner.rb +1 -1
  138. data/lib/contrast/agent/protect/rule/deserialization.rb +1 -1
  139. data/lib/contrast/agent/protect/rule/http_method_tampering.rb +1 -1
  140. data/lib/contrast/agent/protect/rule/no_sqli/mongo_no_sql_scanner.rb +1 -1
  141. data/lib/contrast/agent/protect/rule/no_sqli.rb +1 -1
  142. data/lib/contrast/agent/protect/rule/path_traversal.rb +1 -1
  143. data/lib/contrast/agent/protect/rule/sql_sample_builder.rb +1 -1
  144. data/lib/contrast/agent/protect/rule/sqli/default_sql_scanner.rb +1 -1
  145. data/lib/contrast/agent/protect/rule/sqli/mysql_sql_scanner.rb +1 -1
  146. data/lib/contrast/agent/protect/rule/sqli/postgres_sql_scanner.rb +2 -2
  147. data/lib/contrast/agent/protect/rule/sqli/sqlite_sql_scanner.rb +1 -1
  148. data/lib/contrast/agent/protect/rule/sqli.rb +1 -1
  149. data/lib/contrast/agent/protect/rule/unsafe_file_upload.rb +1 -1
  150. data/lib/contrast/agent/protect/rule/xss.rb +1 -1
  151. data/lib/contrast/agent/protect/rule/xxe/entity_wrapper.rb +1 -1
  152. data/lib/contrast/agent/protect/rule/xxe.rb +1 -1
  153. data/lib/contrast/agent/protect/rule.rb +1 -1
  154. data/lib/contrast/agent/reaction_processor.rb +1 -1
  155. data/lib/contrast/agent/reporting/report.rb +7 -1
  156. data/lib/contrast/agent/reporting/reporter.rb +21 -48
  157. data/lib/contrast/agent/reporting/reporting_events/application_inventory.rb +49 -0
  158. data/lib/contrast/agent/reporting/reporting_events/application_update.rb +82 -0
  159. data/lib/contrast/agent/reporting/reporting_events/architecture_component.rb +80 -0
  160. data/lib/contrast/agent/reporting/reporting_events/discovered_route.rb +59 -0
  161. data/lib/contrast/agent/reporting/reporting_events/finding.rb +138 -43
  162. data/lib/contrast/agent/reporting/reporting_events/finding_event.rb +264 -0
  163. data/lib/contrast/agent/reporting/reporting_events/finding_event_source.rb +57 -0
  164. data/lib/contrast/agent/reporting/reporting_events/finding_object.rb +90 -0
  165. data/lib/contrast/agent/reporting/reporting_events/finding_request.rb +121 -0
  166. data/lib/contrast/agent/reporting/reporting_events/finding_signature.rb +105 -0
  167. data/lib/contrast/agent/reporting/reporting_events/finding_stack.rb +67 -0
  168. data/lib/contrast/agent/reporting/reporting_events/finding_taint_range.rb +58 -0
  169. data/lib/contrast/agent/reporting/reporting_events/library_discovery.rb +93 -0
  170. data/lib/contrast/agent/reporting/reporting_events/library_usage_observation.rb +50 -0
  171. data/lib/contrast/agent/reporting/reporting_events/observed_library_usage.rb +54 -0
  172. data/lib/contrast/agent/reporting/reporting_events/observed_route.rb +66 -0
  173. data/lib/contrast/agent/reporting/reporting_events/preflight.rb +20 -6
  174. data/lib/contrast/agent/reporting/reporting_events/preflight_message.rb +36 -17
  175. data/lib/contrast/agent/reporting/reporting_events/reporting_event.rb +28 -18
  176. data/lib/contrast/agent/reporting/reporting_events/route_coverage.rb +76 -0
  177. data/lib/contrast/agent/reporting/reporting_events/route_discovery.rb +66 -0
  178. data/lib/contrast/agent/reporting/reporting_events/route_discovery_observation.rb +65 -0
  179. data/lib/contrast/agent/reporting/reporting_events/server_activity.rb +52 -0
  180. data/lib/contrast/agent/reporting/reporting_events/trace_event_source.rb +30 -0
  181. data/lib/contrast/agent/reporting/reporting_utilities/audit.rb +22 -12
  182. data/lib/contrast/agent/reporting/reporting_utilities/dtm_message.rb +67 -0
  183. data/lib/contrast/agent/reporting/reporting_utilities/endpoints.rb +165 -0
  184. data/lib/contrast/agent/reporting/reporting_utilities/headers.rb +55 -0
  185. data/lib/contrast/agent/reporting/reporting_utilities/reporter_client.rb +74 -156
  186. data/lib/contrast/agent/reporting/reporting_utilities/reporter_client_utils.rb +154 -0
  187. data/lib/contrast/agent/reporting/reporting_utilities/reporting_storage.rb +1 -1
  188. data/lib/contrast/agent/reporting/reporting_utilities/response.rb +30 -0
  189. data/lib/contrast/agent/reporting/reporting_utilities/response_handler.rb +57 -0
  190. data/lib/contrast/agent/reporting/reporting_utilities/response_handler_utils.rb +196 -0
  191. data/lib/contrast/agent/reporting/settings/application_settings.rb +67 -0
  192. data/lib/contrast/agent/reporting/settings/assess.rb +45 -0
  193. data/lib/contrast/agent/reporting/settings/assess_server_feature.rb +136 -0
  194. data/lib/contrast/agent/reporting/settings/exclusions.rb +123 -0
  195. data/lib/contrast/agent/reporting/settings/protect.rb +89 -0
  196. data/lib/contrast/agent/reporting/settings/protect_server_feature.rb +243 -0
  197. data/lib/contrast/agent/reporting/settings/reaction.rb +30 -0
  198. data/lib/contrast/agent/reporting/settings/server_features.rb +78 -0
  199. data/lib/contrast/agent/request.rb +44 -3
  200. data/lib/contrast/agent/request_context.rb +20 -7
  201. data/lib/contrast/agent/request_context_extend.rb +26 -1
  202. data/lib/contrast/agent/request_handler.rb +41 -5
  203. data/lib/contrast/agent/response.rb +23 -15
  204. data/lib/contrast/agent/rule_set.rb +1 -1
  205. data/lib/contrast/agent/scope.rb +1 -1
  206. data/lib/contrast/agent/service_heartbeat.rb +1 -1
  207. data/lib/contrast/agent/startup_metrics_telemetry_event.rb +34 -7
  208. data/lib/contrast/agent/static_analysis.rb +13 -3
  209. data/lib/contrast/agent/telemetry.rb +1 -1
  210. data/lib/contrast/agent/telemetry_event.rb +1 -1
  211. data/lib/contrast/agent/thread.rb +1 -1
  212. data/lib/contrast/agent/thread_watcher.rb +3 -3
  213. data/lib/contrast/agent/tracepoint_hook.rb +1 -4
  214. data/lib/contrast/agent/version.rb +2 -2
  215. data/lib/contrast/agent/worker_thread.rb +1 -1
  216. data/lib/contrast/agent.rb +4 -4
  217. data/lib/contrast/api/communication/connection_status.rb +1 -1
  218. data/lib/contrast/api/communication/messaging_queue.rb +4 -4
  219. data/lib/contrast/api/communication/response_processor.rb +9 -5
  220. data/lib/contrast/api/communication/service_lifecycle.rb +1 -1
  221. data/lib/contrast/api/communication/socket.rb +1 -1
  222. data/lib/contrast/api/communication/socket_client.rb +4 -1
  223. data/lib/contrast/api/communication/speedracer.rb +1 -1
  224. data/lib/contrast/api/communication/tcp_socket.rb +1 -1
  225. data/lib/contrast/api/communication/unix_socket.rb +1 -1
  226. data/lib/contrast/api/communication.rb +1 -1
  227. data/lib/contrast/api/decorators/address.rb +1 -1
  228. data/lib/contrast/api/decorators/agent_startup.rb +1 -1
  229. data/lib/contrast/api/decorators/application_settings.rb +1 -1
  230. data/lib/contrast/api/decorators/application_startup.rb +1 -1
  231. data/lib/contrast/api/decorators/application_update.rb +1 -1
  232. data/lib/contrast/api/decorators/architecture_component.rb +36 -0
  233. data/lib/contrast/api/decorators/finding.rb +1 -17
  234. data/lib/contrast/api/decorators/http_request.rb +3 -2
  235. data/lib/contrast/api/decorators/input_analysis.rb +1 -1
  236. data/lib/contrast/api/decorators/instrumentation_mode.rb +1 -1
  237. data/lib/contrast/api/decorators/library.rb +1 -1
  238. data/lib/contrast/api/decorators/library_usage_update.rb +1 -1
  239. data/lib/contrast/api/decorators/message.rb +1 -1
  240. data/lib/contrast/api/decorators/rasp_rule_sample.rb +1 -1
  241. data/lib/contrast/api/decorators/route_coverage.rb +1 -1
  242. data/lib/contrast/api/decorators/server_features.rb +1 -1
  243. data/lib/contrast/api/decorators/trace_event.rb +1 -1
  244. data/lib/contrast/api/decorators/trace_event_object.rb +1 -1
  245. data/lib/contrast/api/decorators/trace_event_signature.rb +1 -1
  246. data/lib/contrast/api/decorators/trace_taint_range.rb +1 -1
  247. data/lib/contrast/api/decorators/trace_taint_range_tags.rb +1 -1
  248. data/lib/contrast/api/decorators/user_input.rb +1 -1
  249. data/lib/contrast/api/decorators.rb +2 -1
  250. data/lib/contrast/api.rb +1 -1
  251. data/lib/contrast/components/agent.rb +5 -24
  252. data/lib/contrast/components/api.rb +18 -9
  253. data/lib/contrast/components/app_context.rb +2 -1
  254. data/lib/contrast/components/app_context_extend.rb +1 -1
  255. data/lib/contrast/components/assess.rb +12 -8
  256. data/lib/contrast/components/base.rb +1 -1
  257. data/lib/contrast/components/config.rb +30 -15
  258. data/lib/contrast/components/contrast_service.rb +1 -1
  259. data/lib/contrast/components/heap_dump.rb +1 -1
  260. data/lib/contrast/components/inventory.rb +5 -1
  261. data/lib/contrast/components/logger.rb +1 -1
  262. data/lib/contrast/components/protect.rb +6 -2
  263. data/lib/contrast/components/sampling.rb +1 -1
  264. data/lib/contrast/components/scope.rb +1 -1
  265. data/lib/contrast/components/settings.rb +25 -12
  266. data/lib/contrast/config/agent_configuration.rb +1 -1
  267. data/lib/contrast/config/api_configuration.rb +2 -2
  268. data/lib/contrast/config/api_proxy_configuration.rb +1 -1
  269. data/lib/contrast/config/application_configuration.rb +1 -1
  270. data/lib/contrast/config/assess_configuration.rb +1 -1
  271. data/lib/contrast/config/assess_rules_configuration.rb +1 -1
  272. data/lib/contrast/config/base_configuration.rb +1 -1
  273. data/lib/contrast/config/certification_configuration.rb +1 -1
  274. data/lib/contrast/config/env_variables.rb +1 -1
  275. data/lib/contrast/config/exception_configuration.rb +1 -1
  276. data/lib/contrast/config/heap_dump_configuration.rb +1 -1
  277. data/lib/contrast/config/inventory_configuration.rb +1 -1
  278. data/lib/contrast/config/logger_configuration.rb +1 -1
  279. data/lib/contrast/config/protect_configuration.rb +1 -1
  280. data/lib/contrast/config/protect_rule_configuration.rb +1 -1
  281. data/lib/contrast/config/protect_rules_configuration.rb +1 -1
  282. data/lib/contrast/config/request_audit_configuration.rb +1 -1
  283. data/lib/contrast/config/root_configuration.rb +1 -1
  284. data/lib/contrast/config/ruby_configuration.rb +4 -1
  285. data/lib/contrast/config/sampling_configuration.rb +1 -1
  286. data/lib/contrast/config/server_configuration.rb +1 -1
  287. data/lib/contrast/config/service_configuration.rb +1 -1
  288. data/lib/contrast/config.rb +1 -1
  289. data/lib/contrast/configuration.rb +1 -1
  290. data/lib/contrast/extension/assess/array.rb +4 -2
  291. data/lib/contrast/extension/assess/erb.rb +15 -5
  292. data/lib/contrast/extension/assess/eval_trigger.rb +3 -1
  293. data/lib/contrast/extension/assess/exec_trigger.rb +2 -1
  294. data/lib/contrast/extension/assess/fiber.rb +6 -3
  295. data/lib/contrast/extension/assess/hash.rb +1 -1
  296. data/lib/contrast/extension/assess/kernel.rb +8 -3
  297. data/lib/contrast/extension/assess/marshal.rb +6 -2
  298. data/lib/contrast/extension/assess/regexp.rb +8 -2
  299. data/lib/contrast/extension/assess/string.rb +8 -2
  300. data/lib/contrast/extension/assess.rb +1 -1
  301. data/lib/contrast/extension/delegator.rb +1 -1
  302. data/lib/contrast/extension/extension.rb +2 -4
  303. data/lib/contrast/extension/inventory.rb +1 -1
  304. data/lib/contrast/extension/kernel.rb +1 -1
  305. data/lib/contrast/extension/module.rb +1 -1
  306. data/lib/contrast/extension/protect/psych.rb +1 -1
  307. data/lib/contrast/extension/protect.rb +1 -1
  308. data/lib/contrast/extension/thread.rb +1 -1
  309. data/lib/contrast/framework/base_support.rb +5 -1
  310. data/lib/contrast/framework/grape/support.rb +25 -1
  311. data/lib/contrast/framework/manager.rb +26 -5
  312. data/lib/contrast/framework/manager_extend.rb +1 -1
  313. data/lib/contrast/framework/platform_version.rb +1 -1
  314. data/lib/contrast/framework/rack/patch/session_cookie.rb +1 -1
  315. data/lib/contrast/framework/rack/patch/support.rb +1 -1
  316. data/lib/contrast/framework/rack/support.rb +1 -1
  317. data/lib/contrast/framework/rails/patch/action_controller_live_buffer.rb +1 -1
  318. data/lib/contrast/framework/rails/patch/assess_configuration.rb +1 -1
  319. data/lib/contrast/framework/rails/patch/rails_application_configuration.rb +1 -1
  320. data/lib/contrast/framework/rails/patch/support.rb +1 -1
  321. data/lib/contrast/framework/rails/railtie.rb +1 -1
  322. data/lib/contrast/framework/rails/support.rb +46 -2
  323. data/lib/contrast/framework/sinatra/support.rb +24 -2
  324. data/lib/contrast/funchook/funchook.rb +21 -18
  325. data/lib/contrast/logger/application.rb +1 -1
  326. data/lib/contrast/logger/format.rb +1 -1
  327. data/lib/contrast/logger/log.rb +1 -1
  328. data/lib/contrast/logger/request.rb +1 -1
  329. data/lib/contrast/logger/time.rb +1 -1
  330. data/lib/contrast/security_exception.rb +1 -1
  331. data/lib/contrast/tasks/config.rb +1 -1
  332. data/lib/contrast/tasks/service.rb +1 -1
  333. data/lib/contrast/utils/assess/propagation_method_utils.rb +1 -1
  334. data/lib/contrast/utils/assess/property/tagged_utils.rb +1 -1
  335. data/lib/contrast/utils/assess/sampling_util.rb +4 -4
  336. data/lib/contrast/utils/assess/source_method_utils.rb +1 -1
  337. data/lib/contrast/utils/assess/split_utils.rb +23 -0
  338. data/lib/contrast/utils/assess/tracking_util.rb +1 -1
  339. data/lib/contrast/utils/assess/trigger_method_utils.rb +3 -2
  340. data/lib/contrast/utils/class_util.rb +1 -1
  341. data/lib/contrast/utils/duck_utils.rb +1 -1
  342. data/lib/contrast/utils/env_configuration_item.rb +2 -2
  343. data/lib/contrast/utils/exclude_key.rb +1 -1
  344. data/lib/contrast/utils/findings.rb +5 -2
  345. data/lib/contrast/utils/hash_digest.rb +36 -6
  346. data/lib/contrast/utils/hash_digest_extend.rb +44 -1
  347. data/lib/contrast/utils/head_dump_utils_extend.rb +1 -1
  348. data/lib/contrast/utils/heap_dump_util.rb +1 -1
  349. data/lib/contrast/utils/invalid_configuration_util.rb +6 -5
  350. data/lib/contrast/utils/io_util.rb +1 -1
  351. data/lib/contrast/utils/job_servers_running.rb +1 -1
  352. data/lib/contrast/utils/log_utils.rb +1 -1
  353. data/lib/contrast/utils/lru_cache.rb +1 -1
  354. data/lib/contrast/utils/metrics_hash.rb +2 -2
  355. data/lib/contrast/utils/middleware_utils.rb +1 -1
  356. data/lib/contrast/utils/net_http_base.rb +14 -7
  357. data/lib/contrast/utils/object_share.rb +1 -6
  358. data/lib/contrast/utils/os.rb +9 -5
  359. data/lib/contrast/utils/patching/policy/patch_utils.rb +63 -99
  360. data/lib/contrast/utils/patching/policy/patcher_utils.rb +1 -1
  361. data/lib/contrast/utils/preflight_util.rb +1 -1
  362. data/lib/contrast/utils/request_utils.rb +9 -1
  363. data/lib/contrast/utils/resource_loader.rb +1 -1
  364. data/lib/contrast/utils/response_utils.rb +1 -1
  365. data/lib/contrast/utils/sha256_builder.rb +1 -1
  366. data/lib/contrast/utils/stack_trace_utils.rb +1 -1
  367. data/lib/contrast/utils/string_utils.rb +69 -67
  368. data/lib/contrast/utils/tag_util.rb +2 -1
  369. data/lib/contrast/utils/telemetry.rb +1 -1
  370. data/lib/contrast/utils/telemetry_client.rb +1 -1
  371. data/lib/contrast/utils/telemetry_identifier.rb +1 -1
  372. data/lib/contrast/utils/thread_tracker.rb +1 -1
  373. data/lib/contrast/utils/timer.rb +1 -1
  374. data/lib/contrast-agent.rb +1 -1
  375. data/lib/contrast.rb +1 -1
  376. data/ruby-agent.gemspec +4 -5
  377. metadata +58 -30
  378. data/ext/cs__assess_active_record_named/cs__active_record_named.c +0 -46
  379. data/ext/cs__assess_active_record_named/cs__active_record_named.h +0 -11
  380. data/ext/cs__assess_active_record_named/extconf.rb +0 -5
  381. data/lib/contrast/agent/assess/policy/rewriter_patch.rb +0 -95
  382. data/lib/contrast/agent/class_reopener.rb +0 -258
  383. data/lib/contrast/agent/rewriter.rb +0 -259
  384. data/lib/contrast/framework/rails/rewrite/action_controller_railties_helper_inherited.rb +0 -37
  385. data/lib/contrast/framework/rails/rewrite/active_record_attribute_methods_read.rb +0 -41
  386. data/lib/contrast/framework/rails/rewrite/active_record_named.rb +0 -75
  387. data/lib/contrast/framework/rails/rewrite/active_record_time_zone_inherited.rb +0 -35
  388. data/lib/contrast/utils/ruby_ast_rewriter.rb +0 -82
  389. data/lib/contrast/utils/substitution_utils.rb +0 -167
@@ -0,0 +1,165 @@
1
+ # Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
2
+ # frozen_string_literal: true
3
+
4
+ require 'contrast/components/logger'
5
+ require 'contrast/utils/object_share'
6
+ require 'base64'
7
+
8
+ module Contrast
9
+ module Agent
10
+ module Reporting
11
+ # This is the class which will hold up all the Endpoints we use for the direct report from the agent. It builds
12
+ # the full URLs needed for communication.
13
+ module Endpoints
14
+ extend Contrast::Components::Logger::InstanceMethods
15
+
16
+ APP_LANGUAGE = Contrast::Utils::ObjectShare::RUBY.upcase.cs__freeze
17
+ ENDPOINT_VERSION = '/v1.0'.cs__freeze
18
+ NG_ENDPOINTS = {
19
+ application_activity: "#{ Contrast::API.api_url }/api/ng/activity/application",
20
+ application_create: "#{ Contrast::API.api_url }/api/ng/applications/create",
21
+ agent_startup: "#{ Contrast::API.api_url }/api/ng/servers/"
22
+ }.cs__freeze
23
+
24
+ class << self
25
+ # @return [String,nil]
26
+ def application_startup
27
+ with_rescue do
28
+ "#{ application_endpoint }/startup".cs__freeze
29
+ end
30
+ end
31
+
32
+ # @return [String,nil]
33
+ def application_settings
34
+ with_rescue do
35
+ "#{ application_endpoint }/settings".cs__freeze
36
+ end
37
+ end
38
+
39
+ # @return [String,nil]
40
+ def application_inventory
41
+ with_rescue do
42
+ "#{ application_endpoint }/inventory".cs__freeze
43
+ end
44
+ end
45
+
46
+ # @return [String,nil]
47
+ def library_usage
48
+ with_rescue do
49
+ "#{ application_endpoint }/library-usage".cs__freeze
50
+ end
51
+ end
52
+
53
+ # @return [String,nil]
54
+ def heartbeat
55
+ with_rescue do
56
+ "#{ application_endpoint }/heartbeat".cs__freeze
57
+ end
58
+ end
59
+
60
+ # @return [String,nil]
61
+ def observed_route
62
+ # "/v1.0/routes/localhost///rails/ruby/observed"
63
+ with_rescue do
64
+ "#{ route_endpoint }/observed".cs__freeze
65
+ end
66
+ end
67
+
68
+ # @return [String,nil]
69
+ def trace_observed
70
+ with_rescue do
71
+ "#{ trace_endpoint }/observed".cs__freeze
72
+ end
73
+ end
74
+
75
+ private
76
+
77
+ # Returns the URL needed to connect to endpoints in TeamServer required for application related information.
78
+ #
79
+ # @return [String]
80
+ def application_endpoint
81
+ @_application_endpoint ||= "#{ Contrast::API.api_url }/agents#{ ENDPOINT_VERSION }/applications"\
82
+ "#{ server_path_segment }#{ application_path_segment }"
83
+ end
84
+
85
+ # Returns the URL needed to connect to endpoints in TeamServer required for route related information.
86
+ #
87
+ # @return [String]
88
+ def route_endpoint
89
+ @_route_endpoint ||= "#{ Contrast::API.api_url }/agents#{ ENDPOINT_VERSION }/routes"\
90
+ "#{ server_path_segment }#{ application_path_segment }"
91
+ end
92
+
93
+ # Returns the URL needed to connect to endpoints in TeamServer required for server related information.
94
+ #
95
+ # @return [String]
96
+ def server_endpoint
97
+ @_server_endpoint ||= "#{ Contrast::API.api_url }/agents#{ ENDPOINT_VERSION }/servers"\
98
+ "#{ server_path_segment }"
99
+ end
100
+
101
+ # Returns the URL needed to connect to endpoints in TeamServer required for trace/finding related information.
102
+ #
103
+ # @return [String]
104
+ def trace_endpoint
105
+ @_trace_endpoint ||= "#{ Contrast::API.api_url }/agents#{ ENDPOINT_VERSION }/traces"\
106
+ "#{ server_path_segment }#{ application_path_segment }"
107
+ end
108
+
109
+ # The server host, path, and type; required for endpoints that are server specific.
110
+ #
111
+ # @return [String]
112
+ def server_path_segment
113
+ @_server_path_segment ||= "/#{ Base64.urlsafe_encode64(server_host_name, padding: false) }"\
114
+ "/#{ Base64.urlsafe_encode64(server_path, padding: false) }"\
115
+ "/#{ Base64.urlsafe_encode64(server_type, padding: false) }"
116
+ end
117
+
118
+ # The application language and name; required for endpoints that are application specific.
119
+ #
120
+ # @return [String]
121
+ def application_path_segment
122
+ @_application_path_segment ||= "/#{ Base64.urlsafe_encode64(APP_LANGUAGE, padding: false) }"\
123
+ "/#{ Base64.urlsafe_encode64(app_name, padding: false) }"
124
+ end
125
+
126
+ # @return [String,nil]
127
+ def server_host_name
128
+ return @_server_host_name unless @_server_host_name.nil?
129
+
130
+ @_server_host_name = ::Contrast::APP_CONTEXT.server_name
131
+ end
132
+
133
+ # @return [String,nil]
134
+ def server_path
135
+ return @_server_path unless @_server_path.nil?
136
+
137
+ @_server_path = ::Contrast::APP_CONTEXT.server_path
138
+ end
139
+
140
+ # @return [String,nil]
141
+ def server_type
142
+ return @_server_type unless @_server_type.nil?
143
+
144
+ @_server_type = ::Contrast::APP_CONTEXT.server_type
145
+ end
146
+
147
+ # @return [String,nil]
148
+ def app_name
149
+ return @_app_name unless @_app_name.nil?
150
+
151
+ @_app_name = ::Contrast::APP_CONTEXT.app_name
152
+ end
153
+
154
+ # @return [String,nil]
155
+ def with_rescue
156
+ yield
157
+ rescue StandardError => e
158
+ logger.debug('Endpoint failed with the following error', e)
159
+ Contrast::Utils::ObjectShare::EMPTY_STRING
160
+ end
161
+ end
162
+ end
163
+ end
164
+ end
165
+ end
@@ -0,0 +1,55 @@
1
+ # Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
2
+ # frozen_string_literal: true
3
+
4
+ require 'contrast/utils/object_share'
5
+ require 'contrast/agent/version'
6
+ require 'base64'
7
+
8
+ module Contrast
9
+ module Agent
10
+ module Reporting
11
+ # This class will build the required headers for agent reporting to TS
12
+ class Headers
13
+ attr_reader :app_name, :api_key, :agent_version, :app_language, :app_path, :app_version, :authorization,
14
+ :server_name, :server_path, :server_type, :content_type, :encoding
15
+
16
+ ENCODING = 'base64'
17
+ CONTENT_TYPE = 'application/json'
18
+
19
+ include Contrast::Utils::ObjectShare
20
+
21
+ def initialize
22
+ @app_name = Base64.strict_encode64(Contrast::APP_CONTEXT.app_name)
23
+ @api_key = Contrast::API.api_key
24
+ @agent_version = [RUBY, Contrast::Agent::VERSION].join(SPACE)
25
+ @app_language = RUBY
26
+ @app_path = Base64.strict_encode64(Contrast::APP_CONTEXT.path)
27
+ @app_version = Contrast::APP_CONTEXT.app_version
28
+ @authorization = Base64.strict_encode64("#{ Contrast::API.username }:#{ Contrast::API.service_key }")
29
+ @server_name = Base64.strict_encode64(Contrast::APP_CONTEXT.server_name)
30
+ @server_path = Base64.strict_encode64(Contrast::APP_CONTEXT.server_path)
31
+ @server_type = Base64.strict_encode64(Contrast::APP_CONTEXT.server_type)
32
+ @content_type = CONTENT_TYPE
33
+ @encoding = ENCODING
34
+ end
35
+
36
+ def to_hash
37
+ {
38
+ app_name: @app_name,
39
+ api_key: @api_key,
40
+ agent_version: @agent_version,
41
+ app_language: @app_language,
42
+ app_path: @app_path,
43
+ app_version: @app_version,
44
+ authorization: @authorization,
45
+ server_name: @server_name,
46
+ server_path: @server_path,
47
+ server_type: @server_type,
48
+ content_type: @content_type,
49
+ encoding: @encoding
50
+ }.cs__freeze
51
+ end
52
+ end
53
+ end
54
+ end
55
+ end
@@ -1,167 +1,85 @@
1
- # Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
1
+ # Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
2
2
  # frozen_string_literal: true
3
3
 
4
4
  require 'json'
5
5
  require 'net/http'
6
6
  require 'contrast/components/logger'
7
7
  require 'contrast/utils/net_http_base'
8
- require 'contrast/agent/reporting/reporting_events/finding'
9
- require 'contrast/agent/reporting/reporting_events/preflight_message'
10
- require 'contrast/agent/reporting/reporting_events/reporting_event'
8
+ require 'contrast/api/communication/connection_status'
9
+ require 'contrast/agent/reporting/reporting_utilities/response_handler'
10
+ require 'contrast/agent/reporting/reporting_utilities/reporter_client_utils'
11
+ require 'contrast/agent/reporting/reporting_utilities/endpoints'
12
+ require 'contrast/agent/reporting/reporting_utilities/headers'
11
13
 
12
14
  module Contrast
13
- module Utils
14
- # This module creates a Net::HTTP client and initiates a connection to the provided result
15
- class ReporterClient < NetHttpBase
16
- include ObjectShare
17
- SERVICE_NAME = 'Reporter'
18
- ENDPOINTS = {
19
- application_activity: '/api/ng/activity/application',
20
- application_create: '/api/ng/applications/create',
21
- agent_startup: '/api/ng/servers/',
22
- preflight: '/api/ng/preflight/',
23
- report_vulnerability: '/api/ng/traces',
24
- server_activity: '/api/ng/servers/',
25
- server_update: '/api/ng/update/application'
26
- }.cs__freeze
27
- # EVENT_TYPES = {
28
- # agent_startup: Contrast::Api::Dtm::AgentStartup,
29
- # report_vulnerability: Contrast::Agent::Reporting::Finding,
30
- # preflight: Contrast::Agent::Reporting::Preflight
31
- # }.cs__freeze
32
- include Contrast::Components::Logger::InstanceMethods
33
- # This method initializes the Net::HTTP client we'll need. it will validate
34
- # the connection and make the first request. If connection is valid and response
35
- # is available then the open connection is returned.
36
- #
37
- # @return [Net::HTTP, nil] Return open connection or nil
38
- def initialize_connection
39
- # for this client we would use proxy and custom certificate file if available
40
- super(SERVICE_NAME, Contrast::API.api_url, true, true)
41
- end
42
-
43
- # @param headers [Hash] all the headers needed for communication with TS
44
- def initialize headers
45
- @headers = headers
46
- super()
47
- end
48
-
49
- # Send Agent Startup event
50
- #
51
- # @param event [Contrast::Api::Dtm] One of the DTMs valid for the event field of
52
- # Contrast::Api::Dtm::Message|Contrast::Api::Dtm::Activity
53
- # @param connection [Net::HTTP] open connection
54
- # @return response [Net::HTTP::Response] response from TS
55
- def send_agent_startup event, connection
56
- logger.debug('Preparing to send startup messages')
57
- request = build_request ENDPOINTS[:agent_startup], event
58
- response = connection.request(request)
59
- logger.debug('Successfully sent startup messages to service.') if response
60
- response
61
- end
62
-
63
- # Check event type and send it to appropriate TS endpoint
64
- #
65
- # @param event [Contrast::Api::Dtm,Contrast::Agent::Reporting::ReportingEvent] One of the DTMs valid for the event
66
- # field of Contrast::Api::Dtm::Message|Contrast::Api::Dtm::Activity
67
- # @param connection [Net::HTTP] open connection
68
- # @param send_immediately [Boolean] flag for the logger
69
- # @return response [Net::HTTP::Response, nil] response from TS if no response
70
- def send_event event, connection, send_immediately = false
71
- event_type = symbolized_event_type event.event_type
72
- @response = send_events event, event_type, connection
73
- log_send_event event if send_immediately
74
- @response
75
- end
76
-
77
- private
78
-
79
- # This method will build headers of the request required for TS communication
80
- #
81
- # @param request [Net::HTTP::Post]
82
- def build_headers request
83
- @app_version = @headers[:app_version]
84
- request['API-Key'] = @headers[:api_key]
85
- request['Application-Language'] = @headers[:app_language]
86
- request['Application-Name'] = @headers[:app_name]
87
- request['Application-Path'] = @headers[:app_path]
88
- request['Application-Version'] = @app_version if @app_version
89
- request['Authorization'] = @headers[:authorization]
90
- request['Content-Type'] = @headers[:content_type]
91
- request['Server-Name'] = @headers[:server_name]
92
- request['Server-Path'] = @headers[:server_path]
93
- request['Server-Type'] = @headers[:server_type]
94
- request['X-Contrast-Agent'] = @headers[:agent_version]
95
- request['X-Contrast-Header-Encoding'] = @headers[:encoding]
96
- request
97
- end
98
-
99
- # build the request headers and assign endpoint
100
- #
101
- # @param endpoint [String] endpoint to report to
102
- # @param event [Contrast::Api::Dtm,Contrast::Agent::Reporting::ReportingEvent]
103
- # One of the DTMs valid for the event field of Contrast::Api::Dtm::Message|Contrast::Api::Dtm::Activity
104
- # @return [Net::HTTP::Post]
105
- def build_request endpoint, event
106
- @request = build_headers Net::HTTP::Post.new(endpoint)
107
- @request.body = if event.cs__is_a?(Contrast::Agent::Reporting::ReportingEvent)
108
- event.to_controlled_hash.to_json
109
- else
110
- event.to_json
111
- end
112
- @request
113
- end
114
-
115
- # log the event sent immediately
116
- #
117
- # @param event [Contrast::Api::Dtm,Contrast::Agent::Reporting::ReportingEvent] One of the DTMs valid for the
118
- # event field of Contrast::Api::Dtm::Message|Contrast::Api::Dtm::Activity
119
- def log_send_event event
120
- logger.debug('Immediately sending event.', event_id: event.__id__, event_type: event.cs__class.cs__name)
121
- end
122
-
123
- # Sent different events to different endpoints
124
- #
125
- # @param event [Contrast::Api::Dtm,Contrast::Agent::Reporting::ReportingEvent] Main reporting event, all events
126
- # inherit it
127
- # @param event_type [Symbol] We'll use this symbol to match the urls
128
- # @param connection [Net::HTTP] open connection
129
- def send_events event, event_type, connection
130
- logger.debug("Preparing to send #{ event_type.to_s.capitalize } messages")
131
- request = build_request ENDPOINTS[event_type], event
132
- response = connection.request(request)
133
- logger.debug("Successfully sent #{ event_type.to_s.capitalize } messages to service.") if response
134
- response
135
- end
136
-
137
- # Eventually here we'll handle more response types and etc
138
-
139
- # @param event [Contrast::Agent::Reporting::Preflight] the preflight we handle here
140
- # @param response [Net::HTTP::Response,nil] The response we handle and read from
141
- # @param connection [Net::HTTP] open connection
142
- def handle_response event, response, connection
143
- return unless event || response || connection
144
-
145
- preflight_message = event.messages[0]
146
- event_type = symbolized_event_type preflight_message.event_type
147
- return unless event_type == :preflight_message
148
-
149
- # for handling multiple findings
150
- # we'll only extract the indexes without *
151
- # findings_to_return = response.body.split(',').delete_if { |el| el.include?('*') }
152
- # after that we'll do some magic and return them the same way we do for corresponding_finding
153
- corresponding_finding = Contrast::Agent::Reporting::ReportingStorage.delete(preflight_message.hash_code)
154
- return unless corresponding_finding
155
-
156
- send_event corresponding_finding, connection, true
157
- nil
158
- end
159
-
160
- def symbolized_event_type event_type
161
- return unless event_type
162
- return event_type unless event_type.cs__is_a?(String)
163
-
164
- event_type.downcase.to_sym
15
+ module Agent
16
+ module Reporting
17
+ # This class creates a Net::HTTP client and initiates a connection to the provided result
18
+ # @attr_reader headers [Contrast::Agent::Reporting::Headers]
19
+ class ReporterClient < Contrast::Utils::NetHttpBase
20
+ attr_reader :headers
21
+
22
+ include Contrast::Agent::Reporting::Endpoints
23
+ include Contrast::Agent::Reporting::ReporterClientUtils
24
+ SERVICE_NAME = 'Reporter'
25
+ include Contrast::Components::Logger::InstanceMethods
26
+ # This method initializes the Net::HTTP client we'll need. it will validate
27
+ # the connection and make the first request. If connection is valid and response
28
+ # is available then the open connection is returned.
29
+ #
30
+ # @return [Net::HTTP, nil] Return open connection or nil
31
+ def initialize_connection
32
+ # for this client we would use proxy and custom certificate file if available
33
+ super(SERVICE_NAME, Contrast::API.api_url, true, true)
34
+ end
35
+
36
+ def initialize
37
+ @headers = Contrast::Agent::Reporting::Headers.new
38
+ super()
39
+ end
40
+
41
+ # Start the client for first time and sent startup event
42
+ #
43
+ # @param connection [Net::HTTP] open connection
44
+ def startup! connection
45
+ return if status.startup_messages_sent?
46
+ return unless Contrast::Agent::Reporter.enabled?
47
+
48
+ send_agent_startup(connection)
49
+ end
50
+
51
+ # Check event type and send it to appropriate TS endpoint
52
+ #
53
+ # @param event [Contrast::Api::Dtm,Contrast::Agent::Reporting::ReportingEvent] One of the DTMs valid
54
+ # for the event field of Contrast::Api::Dtm::Message|Contrast::Api::Dtm::Activity
55
+ # @param connection [Net::HTTP] open connection
56
+ # @param send_immediately [Boolean] flag for the logger
57
+ # @return response [Net::HTTP::Response, nil] response from TS if no response
58
+ def send_event event, connection, send_immediately = false
59
+ return unless Contrast::Agent::Reporter.enabled?
60
+
61
+ response = send_events(event, connection)
62
+ log_send_event event if send_immediately
63
+ response
64
+ rescue StandardError => e
65
+ handle_error event, e
66
+ end
67
+
68
+ def status
69
+ @_status ||= Contrast::Api::Communication::ConnectionStatus.new
70
+ end
71
+
72
+ def response_handler
73
+ @_response_handler ||= Contrast::Agent::Reporting::ResponseHandler.new
74
+ end
75
+
76
+ def sleep?
77
+ response_handler.sleep?
78
+ end
79
+
80
+ def wake_up
81
+ response_handler.wake_up
82
+ end
165
83
  end
166
84
  end
167
85
  end
@@ -0,0 +1,154 @@
1
+ # Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
2
+ # frozen_string_literal: true
3
+
4
+ require 'contrast/components/logger'
5
+ require 'contrast/components/scope'
6
+ require 'contrast/agent/reporting/reporting_utilities/reporter_client'
7
+ require 'contrast/agent/reporting/reporting_utilities/endpoints'
8
+
9
+ module Contrast
10
+ module Agent
11
+ module Reporting
12
+ # This module holds utilities required by the reporting service client
13
+ module ReporterClientUtils
14
+ include Contrast::Components::Logger::InstanceMethods
15
+ include Contrast::Components::Scope::InstanceMethods
16
+ include Contrast::Agent::Reporting::Endpoints
17
+
18
+ private
19
+
20
+ # This method will build headers of the request required for TS communication
21
+ #
22
+ # @param request [Net::HTTPRequest]
23
+ def build_headers request
24
+ app_version = @headers.app_version
25
+ request['API-Key'] = @headers.api_key
26
+ request['Application-Language'] = @headers.app_language
27
+ request['Application-Name'] = @headers.app_name
28
+ request['Application-Path'] = @headers.app_path
29
+ request['Application-Version'] = app_version if app_version
30
+ request['Authorization'] = @headers.authorization
31
+ request['Content-Type'] = @headers.content_type
32
+ request['Server-Name'] = @headers.server_name
33
+ request['Server-Path'] = @headers.server_path
34
+ request['Server-Type'] = @headers.server_type
35
+ request['X-Contrast-Agent'] = @headers.agent_version
36
+ request['X-Contrast-Header-Encoding'] = @headers.encoding
37
+ request
38
+ end
39
+
40
+ # log the event sent immediately
41
+ #
42
+ # @param event [Contrast::Api::Dtm,Contrast::Agent::Reporting::ReportingEvent] One of the DTMs valid for the
43
+ # event field of Contrast::Api::Dtm::Message|Contrast::Api::Dtm::Activity
44
+ def log_send_event event
45
+ logger.debug("#{ Contrast::Agent::Reporting::ReporterClient::SERVICE_NAME } immediately sending event.",
46
+ event_id: event.__id__, event_type: event.cs__class.cs__name)
47
+ end
48
+
49
+ # Handles standard error case, logs and set status for failure
50
+ #
51
+ # @param event [Contrast::Api::Dtm, Contrast::Agent::Reporting::ReportingEvent]
52
+ # One of the DTMs valid for the event field of Contrast::Api::Dtm::Message|Contrast::Api::Dtm::Activity
53
+ # @param error_msg [StandardError]
54
+ # @return nil [NilClass] to be passed as response
55
+ def handle_error event, error_msg
56
+ status.failure!
57
+ logger.error('Unable to send message.',
58
+ error_msg,
59
+ client: Contrast::Agent::Reporting::ReporterClient::SERVICE_NAME,
60
+ event_id: event&.__id__,
61
+ event_type: event&.cs__class&.cs__name)
62
+ nil
63
+ end
64
+
65
+ # Handles response processing and sets status
66
+ #
67
+ # @param response [Net::HTTP::Response]
68
+ # @return response [Net::HTTP::Response]
69
+ def process_response response
70
+ response_handler.process response
71
+ logger.debug('Successfully sent startup messages to service.')
72
+ status.success!
73
+ response
74
+ end
75
+
76
+ # build the request headers and assign endpoint
77
+ #
78
+ # @param event event [Contrast::Api::Dtm::AgentStartup, Contrast::Agent::Reporting::ReportingEvent]
79
+ # One of the DTMs valid for the event field of Contrast::Api::Dtm::Message|Contrast::Api::Dtm::Activity
80
+ # @return [Net::HTTP::Post,Net::HTTP::Put]
81
+ def build_request event
82
+ with_contrast_scope do
83
+ request = if event.cs__is_a?(Contrast::Agent::Reporting::ReportingEvent)
84
+ case event.event_method
85
+ when :PUT
86
+ Net::HTTP::Put.new(event.event_endpoint)
87
+ when :POST
88
+ Net::HTTP::Post.new(event.event_endpoint)
89
+ end
90
+ else # TODO: RUBY-1438 -- remove
91
+ Net::HTTP::Put.new(Contrast::Agent::Reporting::Endpoints::NG_ENDPOINTS[:agent_startup])
92
+ end
93
+ build_headers(request)
94
+ if event.cs__is_a?(Contrast::Agent::Reporting::ReportingEvent)
95
+ event.attach_headers(request)
96
+ request.body = event.to_controlled_hash.to_json
97
+ else
98
+ request.body = event.to_json
99
+ end
100
+ request
101
+ end
102
+ end
103
+
104
+ # Send Agent Startup event
105
+ #
106
+ # @param connection [Net::HTTP] open connection
107
+ # @return response [Net::HTTP::Response] response from TS
108
+ def send_agent_startup connection
109
+ logger.debug('Preparing to send startup messages')
110
+ startup = Contrast::APP_CONTEXT.build_agent_startup_message
111
+ request = build_request(startup)
112
+ response = connection.request(request)
113
+ process_response(response)
114
+ rescue StandardError => e
115
+ handle_error(startup, e)
116
+ end
117
+
118
+ # Sent different events to different endpoints
119
+ #
120
+ # @param event [Contrast::Api::Dtm,Contrast::Agent::Reporting::ReportingEvent] Main reporting event, all events
121
+ # inherit it
122
+ # @param connection [Net::HTTP] open connection
123
+ def send_events event, connection
124
+ request = build_request(event)
125
+ response = connection.request(request)
126
+ process_response(response)
127
+ rescue StandardError => e
128
+ handle_error(event, e)
129
+ end
130
+
131
+ # Eventually here we'll handle more response types and etc
132
+
133
+ # @param event [Contrast::Agent::Reporting::Preflight] the preflight we handle here
134
+ # @param response [Net::HTTP::Response,nil] The response we handle and read from
135
+ # @param connection [Net::HTTP] open connection
136
+ def handle_response event, response, connection
137
+ return unless event || response || connection
138
+ return unless event.cs__is_a?(Contrast::Agent::Reporting::Preflight)
139
+
140
+ preflight_message = event.messages[0]
141
+ # for handling multiple findings
142
+ # we'll only extract the indexes without *
143
+ # findings_to_return = response.body.split(',').delete_if { |el| el.include?('*') }
144
+ # after that we'll do some magic and return them the same way we do for corresponding_finding
145
+ corresponding_finding = Contrast::Agent::Reporting::ReportingStorage.delete(preflight_message.hash_code)
146
+ return unless corresponding_finding
147
+
148
+ send_event corresponding_finding, connection, true
149
+ nil
150
+ end
151
+ end
152
+ end
153
+ end
154
+ end
@@ -1,4 +1,4 @@
1
- # Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
1
+ # Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
2
2
  # frozen_string_literal: true
3
3
 
4
4
  require 'contrast/components/logger'
@@ -0,0 +1,30 @@
1
+ # Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
2
+ # frozen_string_literal: true
3
+
4
+ require 'contrast/agent/reporting/settings/application_settings'
5
+ require 'contrast/agent/reporting/settings/server_features'
6
+
7
+ module Contrast
8
+ module Agent
9
+ module Reporting
10
+ # this class will hold the response from TS
11
+ class Response
12
+ # All of the settings from TeamServer that apply at the application level.
13
+ # At least one, but not necessarily all, setting will differ from the agent's current set.
14
+ # Agents are able to replace all application settings with those in this message.
15
+ #
16
+ # @return application_settings [Contrast::Agent::Reporting::Settings::ApplicationSettings]
17
+ def application_settings
18
+ @_application_settings ||= Contrast::Agent::Reporting::Settings::ApplicationSettings.new
19
+ end
20
+
21
+ # All of the feature server_features
22
+ #
23
+ # @return server_features [Contrast::Agent::Reporting::Settings::FeatureSettings]
24
+ def server_features
25
+ @_server_features ||= Contrast::Agent::Reporting::Settings::ServerFeatures.new
26
+ end
27
+ end
28
+ end
29
+ end
30
+ end