contrast-agent 6.7.0 → 6.9.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (280) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +0 -2
  3. data/.simplecov +0 -1
  4. data/Rakefile +0 -1
  5. data/ext/cs__assess_array/cs__assess_array.c +41 -10
  6. data/ext/cs__assess_array/cs__assess_array.h +4 -1
  7. data/lib/contrast/agent/assess/policy/trigger_method.rb +3 -3
  8. data/lib/contrast/agent/assess/policy/trigger_validation/redos_validator.rb +1 -1
  9. data/lib/contrast/agent/assess/policy/trigger_validation/ssrf_validator.rb +1 -1
  10. data/lib/contrast/agent/assess/policy/trigger_validation/xss_validator.rb +1 -1
  11. data/lib/contrast/agent/assess/property/evented.rb +11 -11
  12. data/lib/contrast/agent/assess.rb +0 -1
  13. data/lib/contrast/agent/excluder.rb +53 -35
  14. data/lib/contrast/agent/exclusion_matcher.rb +21 -9
  15. data/lib/contrast/agent/middleware.rb +12 -6
  16. data/lib/contrast/agent/patching/policy/after_load_patcher.rb +6 -0
  17. data/lib/contrast/agent/protect/input_analyzer/input_analyzer.rb +146 -127
  18. data/lib/contrast/agent/protect/input_analyzer/worth_watching_analyzer.rb +116 -0
  19. data/lib/contrast/agent/protect/policy/applies_path_traversal_rule.rb +20 -0
  20. data/lib/contrast/agent/protect/policy/rule_applicator.rb +1 -1
  21. data/lib/contrast/agent/protect/rule/base.rb +47 -55
  22. data/lib/contrast/agent/protect/rule/base_service.rb +48 -24
  23. data/lib/contrast/agent/protect/rule/bot_blocker/bot_blocker_input_classification.rb +98 -0
  24. data/lib/contrast/agent/protect/rule/bot_blocker.rb +81 -0
  25. data/lib/contrast/agent/protect/rule/cmd_injection.rb +20 -2
  26. data/lib/contrast/agent/protect/rule/cmdi/cmdi_backdoors.rb +8 -5
  27. data/lib/contrast/agent/protect/rule/cmdi/cmdi_base_rule.rb +22 -22
  28. data/lib/contrast/agent/protect/rule/cmdi/cmdi_chained_command.rb +64 -0
  29. data/lib/contrast/agent/protect/rule/cmdi/cmdi_dangerous_path.rb +63 -0
  30. data/lib/contrast/agent/protect/rule/cmdi/cmdi_input_classification.rb +2 -58
  31. data/lib/contrast/agent/protect/rule/default_scanner.rb +1 -1
  32. data/lib/contrast/agent/protect/rule/deserialization.rb +3 -14
  33. data/lib/contrast/agent/protect/rule/http_method_tampering/http_method_tampering_input_classification.rb +2 -2
  34. data/lib/contrast/agent/protect/rule/http_method_tampering.rb +0 -11
  35. data/lib/contrast/agent/protect/rule/no_sqli/no_sqli_input_classification.rb +29 -34
  36. data/lib/contrast/agent/protect/rule/no_sqli.rb +25 -18
  37. data/lib/contrast/agent/protect/rule/path_traversal/path_traversal_input_classification.rb +61 -0
  38. data/lib/contrast/agent/protect/rule/path_traversal/path_traversal_semantic_security_bypass.rb +114 -0
  39. data/lib/contrast/agent/protect/rule/path_traversal.rb +40 -13
  40. data/lib/contrast/agent/protect/rule/sql_sample_builder.rb +33 -15
  41. data/lib/contrast/agent/protect/rule/sqli/sqli_base_rule.rb +0 -14
  42. data/lib/contrast/agent/protect/rule/sqli/sqli_input_classification.rb +2 -62
  43. data/lib/contrast/agent/protect/rule/sqli.rb +74 -3
  44. data/lib/contrast/agent/protect/rule/unsafe_file_upload/unsafe_file_upload_input_classification.rb +39 -63
  45. data/lib/contrast/agent/protect/rule/unsafe_file_upload.rb +6 -33
  46. data/lib/contrast/agent/protect/rule/xss/reflected_xss_input_classification.rb +58 -0
  47. data/lib/contrast/agent/protect/rule/xss.rb +15 -20
  48. data/lib/contrast/agent/protect/rule/xxe.rb +4 -24
  49. data/lib/contrast/agent/reporting/attack_result/rasp_rule_sample.rb +19 -40
  50. data/lib/contrast/agent/reporting/attack_result/response_type.rb +9 -9
  51. data/lib/contrast/agent/reporting/details/ip_denylist_details.rb +10 -2
  52. data/lib/contrast/agent/reporting/details/virtual_patch_details.rb +8 -2
  53. data/lib/contrast/agent/reporting/input_analysis/details/bot_blocker_details.rb +27 -0
  54. data/lib/contrast/agent/reporting/input_analysis/details/protect_rule_details.rb +15 -0
  55. data/lib/contrast/agent/reporting/input_analysis/input_analysis.rb +1 -2
  56. data/lib/contrast/agent/reporting/input_analysis/input_analysis_result.rb +16 -2
  57. data/lib/contrast/agent/reporting/masker/masker.rb +2 -0
  58. data/lib/contrast/agent/reporting/report.rb +1 -0
  59. data/lib/contrast/agent/reporting/reporter.rb +35 -14
  60. data/lib/contrast/agent/reporting/reporter_heartbeat.rb +3 -9
  61. data/lib/contrast/agent/reporting/reporting_events/application_activity.rb +16 -13
  62. data/lib/contrast/agent/reporting/reporting_events/application_defend_activity.rb +12 -7
  63. data/lib/contrast/agent/reporting/reporting_events/application_defend_attack_activity.rb +3 -3
  64. data/lib/contrast/agent/reporting/reporting_events/application_defend_attack_sample.rb +1 -2
  65. data/lib/contrast/agent/reporting/reporting_events/application_inventory_activity.rb +6 -1
  66. data/lib/contrast/agent/reporting/reporting_events/application_update.rb +0 -2
  67. data/lib/contrast/agent/reporting/reporting_events/architecture_component.rb +0 -1
  68. data/lib/contrast/agent/reporting/reporting_events/finding.rb +6 -6
  69. data/lib/contrast/agent/reporting/reporting_events/finding_event.rb +239 -93
  70. data/lib/contrast/agent/reporting/reporting_events/finding_event_signature.rb +10 -23
  71. data/lib/contrast/agent/reporting/reporting_events/finding_event_source.rb +10 -9
  72. data/lib/contrast/agent/reporting/reporting_events/finding_request.rb +0 -5
  73. data/lib/contrast/agent/reporting/reporting_events/library_discovery.rb +0 -1
  74. data/lib/contrast/agent/reporting/reporting_events/observed_route.rb +12 -0
  75. data/lib/contrast/agent/reporting/reporting_events/poll.rb +1 -11
  76. data/lib/contrast/agent/reporting/reporting_events/route_discovery.rb +0 -1
  77. data/lib/contrast/agent/reporting/reporting_events/route_discovery_observation.rb +0 -1
  78. data/lib/contrast/agent/reporting/reporting_events/server_reporting_event.rb +8 -0
  79. data/lib/contrast/agent/reporting/reporting_events/server_settings.rb +40 -0
  80. data/lib/contrast/agent/reporting/reporting_utilities/audit.rb +2 -2
  81. data/lib/contrast/agent/reporting/reporting_utilities/endpoints.rb +6 -0
  82. data/lib/contrast/agent/reporting/reporting_utilities/reporter_client.rb +43 -1
  83. data/lib/contrast/agent/reporting/reporting_utilities/reporter_client_utils.rb +8 -4
  84. data/lib/contrast/agent/reporting/reporting_utilities/response.rb +1 -1
  85. data/lib/contrast/agent/reporting/reporting_utilities/response_extractor.rb +58 -4
  86. data/lib/contrast/agent/reporting/reporting_utilities/response_handler.rb +4 -6
  87. data/lib/contrast/agent/reporting/reporting_utilities/response_handler_utils.rb +77 -16
  88. data/lib/contrast/agent/reporting/server_settings_worker.rb +44 -0
  89. data/lib/contrast/agent/reporting/settings/assess_server_feature.rb +14 -2
  90. data/lib/contrast/agent/reporting/settings/code_exclusion.rb +6 -1
  91. data/lib/contrast/agent/reporting/settings/exclusion_base.rb +18 -0
  92. data/lib/contrast/agent/reporting/settings/exclusions.rb +2 -1
  93. data/lib/contrast/agent/reporting/settings/helpers.rb +7 -0
  94. data/lib/contrast/agent/reporting/settings/input_exclusion.rb +9 -3
  95. data/lib/contrast/agent/reporting/settings/protect.rb +15 -15
  96. data/lib/contrast/agent/reporting/settings/protect_server_feature.rb +39 -2
  97. data/lib/contrast/agent/reporting/settings/rule_definition.rb +3 -0
  98. data/lib/contrast/agent/reporting/settings/security_logger.rb +77 -0
  99. data/lib/contrast/agent/reporting/settings/server_features.rb +9 -0
  100. data/lib/contrast/agent/reporting/settings/syslog.rb +34 -5
  101. data/lib/contrast/agent/request.rb +3 -14
  102. data/lib/contrast/agent/request_context.rb +6 -9
  103. data/lib/contrast/agent/request_context_extend.rb +9 -148
  104. data/lib/contrast/agent/request_handler.rb +5 -10
  105. data/lib/contrast/agent/telemetry/events/exceptions/telemetry_exception_event.rb +1 -1
  106. data/lib/contrast/agent/thread_watcher.rb +37 -18
  107. data/lib/contrast/agent/version.rb +1 -1
  108. data/lib/contrast/agent.rb +6 -11
  109. data/lib/contrast/agent_lib/api/command_injection.rb +46 -0
  110. data/lib/contrast/agent_lib/api/init.rb +101 -0
  111. data/lib/contrast/agent_lib/api/input_tracing.rb +267 -0
  112. data/lib/contrast/agent_lib/api/method_tempering.rb +29 -0
  113. data/lib/contrast/agent_lib/api/panic.rb +87 -0
  114. data/lib/contrast/agent_lib/api/path_semantic_file_security_bypass.rb +40 -0
  115. data/lib/contrast/agent_lib/interface.rb +260 -0
  116. data/lib/contrast/agent_lib/interface_base.rb +118 -0
  117. data/lib/contrast/agent_lib/return_types/eval_result.rb +44 -0
  118. data/lib/contrast/agent_lib/test.rb +29 -0
  119. data/lib/contrast/api/communication/connection_status.rb +20 -5
  120. data/lib/contrast/components/agent.rb +34 -14
  121. data/lib/contrast/components/api.rb +23 -0
  122. data/lib/contrast/components/app_context.rb +23 -5
  123. data/lib/contrast/components/app_context_extend.rb +0 -25
  124. data/lib/contrast/components/assess.rb +34 -4
  125. data/lib/contrast/components/assess_rules.rb +18 -0
  126. data/lib/contrast/components/base.rb +40 -0
  127. data/lib/contrast/components/config/sources.rb +95 -0
  128. data/lib/contrast/components/config.rb +19 -19
  129. data/lib/contrast/components/heap_dump.rb +10 -0
  130. data/lib/contrast/components/inventory.rb +15 -2
  131. data/lib/contrast/components/logger.rb +18 -0
  132. data/lib/contrast/components/polling.rb +36 -0
  133. data/lib/contrast/components/protect.rb +52 -2
  134. data/lib/contrast/components/ruby_component.rb +16 -1
  135. data/lib/contrast/components/sampling.rb +70 -13
  136. data/lib/contrast/components/security_logger.rb +13 -0
  137. data/lib/contrast/components/settings.rb +105 -90
  138. data/lib/contrast/config/certification_configuration.rb +14 -0
  139. data/lib/contrast/config/config.rb +46 -0
  140. data/lib/contrast/config/diagnostics.rb +114 -0
  141. data/lib/contrast/config/diagnostics_tools.rb +98 -0
  142. data/lib/contrast/config/effective_config.rb +65 -0
  143. data/lib/contrast/config/effective_config_value.rb +32 -0
  144. data/lib/contrast/config/exception_configuration.rb +12 -0
  145. data/lib/contrast/config/protect_rule_configuration.rb +8 -8
  146. data/lib/contrast/config/protect_rules_configuration.rb +23 -60
  147. data/lib/contrast/config/request_audit_configuration.rb +13 -0
  148. data/lib/contrast/config/server_configuration.rb +41 -2
  149. data/lib/contrast/configuration.rb +29 -12
  150. data/lib/contrast/extension/assess/array.rb +9 -0
  151. data/lib/contrast/extension/assess/erb.rb +1 -1
  152. data/lib/contrast/extension/delegator.rb +2 -0
  153. data/lib/contrast/framework/manager.rb +3 -1
  154. data/lib/contrast/framework/rails/railtie.rb +0 -1
  155. data/lib/contrast/framework/rails/support.rb +0 -1
  156. data/lib/contrast/tasks/config.rb +1 -8
  157. data/lib/contrast/utils/assess/event_limit_utils.rb +31 -9
  158. data/lib/contrast/utils/assess/trigger_method_utils.rb +5 -4
  159. data/lib/contrast/utils/duck_utils.rb +1 -0
  160. data/lib/contrast/utils/hash_digest.rb +2 -2
  161. data/lib/contrast/utils/input_classification_base.rb +155 -0
  162. data/lib/contrast/utils/os.rb +0 -20
  163. data/lib/contrast/utils/reporting/application_activity_batch_utils.rb +81 -0
  164. data/lib/contrast/utils/response_utils.rb +0 -16
  165. data/lib/contrast/utils/routes_sent.rb +60 -0
  166. data/lib/contrast/utils/stack_trace_utils.rb +3 -15
  167. data/lib/contrast/utils/string_utils.rb +10 -7
  168. data/lib/contrast/utils/telemetry_client.rb +1 -2
  169. data/lib/contrast/utils/timer.rb +16 -0
  170. data/lib/contrast.rb +5 -4
  171. data/resources/protect/policy.json +1 -2
  172. data/ruby-agent.gemspec +7 -6
  173. metadata +69 -130
  174. data/exe/contrast_service +0 -23
  175. data/lib/contrast/agent/assess/contrast_event.rb +0 -157
  176. data/lib/contrast/agent/assess/events/event_factory.rb +0 -34
  177. data/lib/contrast/agent/assess/events/source_event.rb +0 -46
  178. data/lib/contrast/agent/protect/rule/cmdi/cmdi_worth_watching.rb +0 -64
  179. data/lib/contrast/agent/protect/rule/sqli/sqli_worth_watching.rb +0 -118
  180. data/lib/contrast/agent/protect/rule/unsafe_file_upload/unsafe_file_upload_matcher.rb +0 -45
  181. data/lib/contrast/agent/reaction_processor.rb +0 -47
  182. data/lib/contrast/agent/reporting/reporting_events/server_activity.rb +0 -36
  183. data/lib/contrast/agent/service_heartbeat.rb +0 -35
  184. data/lib/contrast/api/communication/messaging_queue.rb +0 -128
  185. data/lib/contrast/api/communication/response_processor.rb +0 -90
  186. data/lib/contrast/api/communication/service_lifecycle.rb +0 -77
  187. data/lib/contrast/api/communication/socket.rb +0 -44
  188. data/lib/contrast/api/communication/socket_client.rb +0 -130
  189. data/lib/contrast/api/communication/speedracer.rb +0 -138
  190. data/lib/contrast/api/communication/tcp_socket.rb +0 -32
  191. data/lib/contrast/api/communication/unix_socket.rb +0 -28
  192. data/lib/contrast/api/communication.rb +0 -20
  193. data/lib/contrast/api/decorators/address.rb +0 -59
  194. data/lib/contrast/api/decorators/agent_startup.rb +0 -56
  195. data/lib/contrast/api/decorators/application_settings.rb +0 -43
  196. data/lib/contrast/api/decorators/application_startup.rb +0 -56
  197. data/lib/contrast/api/decorators/bot_blocker.rb +0 -37
  198. data/lib/contrast/api/decorators/http_request.rb +0 -137
  199. data/lib/contrast/api/decorators/input_analysis.rb +0 -18
  200. data/lib/contrast/api/decorators/instrumentation_mode.rb +0 -35
  201. data/lib/contrast/api/decorators/ip_denylist.rb +0 -37
  202. data/lib/contrast/api/decorators/message.rb +0 -67
  203. data/lib/contrast/api/decorators/rasp_rule_sample.rb +0 -52
  204. data/lib/contrast/api/decorators/response_type.rb +0 -17
  205. data/lib/contrast/api/decorators/server_features.rb +0 -25
  206. data/lib/contrast/api/decorators/user_input.rb +0 -51
  207. data/lib/contrast/api/decorators/virtual_patch.rb +0 -34
  208. data/lib/contrast/api/decorators.rb +0 -22
  209. data/lib/contrast/api/dtm.pb.rb +0 -363
  210. data/lib/contrast/api/settings.pb.rb +0 -500
  211. data/lib/contrast/api.rb +0 -16
  212. data/lib/contrast/components/contrast_service.rb +0 -88
  213. data/lib/contrast/components/service.rb +0 -55
  214. data/lib/contrast/tasks/service.rb +0 -84
  215. data/lib/contrast/utils/input_classification.rb +0 -73
  216. data/lib/protobuf/code_generator.rb +0 -129
  217. data/lib/protobuf/decoder.rb +0 -28
  218. data/lib/protobuf/deprecation.rb +0 -117
  219. data/lib/protobuf/descriptors/google/protobuf/compiler/plugin.pb.rb +0 -79
  220. data/lib/protobuf/descriptors/google/protobuf/descriptor.pb.rb +0 -360
  221. data/lib/protobuf/descriptors.rb +0 -3
  222. data/lib/protobuf/encoder.rb +0 -11
  223. data/lib/protobuf/enum.rb +0 -365
  224. data/lib/protobuf/exceptions.rb +0 -9
  225. data/lib/protobuf/field/base_field.rb +0 -380
  226. data/lib/protobuf/field/base_field_object_definitions.rb +0 -504
  227. data/lib/protobuf/field/bool_field.rb +0 -64
  228. data/lib/protobuf/field/bytes_field.rb +0 -67
  229. data/lib/protobuf/field/double_field.rb +0 -25
  230. data/lib/protobuf/field/enum_field.rb +0 -56
  231. data/lib/protobuf/field/field_array.rb +0 -102
  232. data/lib/protobuf/field/field_hash.rb +0 -122
  233. data/lib/protobuf/field/fixed32_field.rb +0 -25
  234. data/lib/protobuf/field/fixed64_field.rb +0 -28
  235. data/lib/protobuf/field/float_field.rb +0 -43
  236. data/lib/protobuf/field/int32_field.rb +0 -21
  237. data/lib/protobuf/field/int64_field.rb +0 -34
  238. data/lib/protobuf/field/integer_field.rb +0 -23
  239. data/lib/protobuf/field/message_field.rb +0 -51
  240. data/lib/protobuf/field/sfixed32_field.rb +0 -27
  241. data/lib/protobuf/field/sfixed64_field.rb +0 -28
  242. data/lib/protobuf/field/signed_integer_field.rb +0 -29
  243. data/lib/protobuf/field/sint32_field.rb +0 -21
  244. data/lib/protobuf/field/sint64_field.rb +0 -21
  245. data/lib/protobuf/field/string_field.rb +0 -51
  246. data/lib/protobuf/field/uint32_field.rb +0 -21
  247. data/lib/protobuf/field/uint64_field.rb +0 -21
  248. data/lib/protobuf/field/varint_field.rb +0 -77
  249. data/lib/protobuf/field.rb +0 -74
  250. data/lib/protobuf/generators/base.rb +0 -85
  251. data/lib/protobuf/generators/enum_generator.rb +0 -39
  252. data/lib/protobuf/generators/extension_generator.rb +0 -27
  253. data/lib/protobuf/generators/field_generator.rb +0 -193
  254. data/lib/protobuf/generators/file_generator.rb +0 -262
  255. data/lib/protobuf/generators/group_generator.rb +0 -122
  256. data/lib/protobuf/generators/message_generator.rb +0 -104
  257. data/lib/protobuf/generators/option_generator.rb +0 -17
  258. data/lib/protobuf/generators/printable.rb +0 -160
  259. data/lib/protobuf/generators/service_generator.rb +0 -50
  260. data/lib/protobuf/lifecycle.rb +0 -33
  261. data/lib/protobuf/logging.rb +0 -39
  262. data/lib/protobuf/message/fields.rb +0 -233
  263. data/lib/protobuf/message/serialization.rb +0 -85
  264. data/lib/protobuf/message.rb +0 -241
  265. data/lib/protobuf/optionable.rb +0 -72
  266. data/lib/protobuf/tasks/compile.rake +0 -80
  267. data/lib/protobuf/tasks.rb +0 -1
  268. data/lib/protobuf/varint.rb +0 -20
  269. data/lib/protobuf/varint_pure.rb +0 -31
  270. data/lib/protobuf/version.rb +0 -3
  271. data/lib/protobuf/wire_type.rb +0 -10
  272. data/lib/protobuf.rb +0 -91
  273. data/proto/dynamic_discovery.proto +0 -46
  274. data/proto/google/protobuf/compiler/plugin.proto +0 -183
  275. data/proto/google/protobuf/descriptor.proto +0 -911
  276. data/proto/rpc.proto +0 -71
  277. data/service_executables/.gitkeep +0 -0
  278. data/service_executables/VERSION +0 -1
  279. data/service_executables/linux/contrast-service +0 -0
  280. data/service_executables/mac/contrast-service +0 -0
@@ -1,50 +0,0 @@
1
- require 'protobuf/generators/base'
2
- require 'protobuf/generators/option_generator'
3
-
4
- module Protobuf
5
- module Generators
6
- class ServiceGenerator < Base
7
-
8
- def compile
9
- run_once(:compile) do
10
- print_class(descriptor.name, :service) do
11
- print OptionGenerator.new(descriptor.options, current_indent).to_s if descriptor.options
12
- descriptor.method.each do |method_descriptor|
13
- print_method(method_descriptor)
14
- end
15
- end
16
- end
17
- end
18
-
19
- private
20
-
21
- def print_method(method_descriptor)
22
- request_klass = modulize(method_descriptor.input_type)
23
- response_klass = modulize(method_descriptor.output_type)
24
- name = ENV.key?('PB_USE_RAW_RPC_NAMES') ? method_descriptor.name : method_descriptor.name.underscore
25
- options = {}
26
- if method_descriptor.options
27
- method_descriptor.options.each_field do |field_option|
28
- option_value = method_descriptor.options[field_option.name]
29
- next unless method_descriptor.options.field?(field_option.name)
30
- options[field_option.fully_qualified_name] = serialize_value(option_value)
31
- end
32
- end
33
-
34
- rpc = "rpc :#{name}, #{request_klass}, #{response_klass}"
35
-
36
- if options.empty?
37
- puts rpc
38
- return
39
- end
40
-
41
- puts rpc + " do"
42
- options.each do |option_name, value|
43
- indent { puts "set_option #{option_name.inspect}, #{value}" }
44
- end
45
- puts "end"
46
- end
47
-
48
- end
49
- end
50
- end
@@ -1,33 +0,0 @@
1
- module Protobuf
2
- class Lifecycle
3
- class << self
4
- def register(event_name)
5
- fail "Lifecycle register must have a block" unless block_given?
6
- event_name = normalized_event_name(event_name)
7
-
8
- ::ActiveSupport::Notifications.subscribe(event_name) do |_name, _start, _finish, _id, args|
9
- yield(*args)
10
- end
11
- end
12
- alias :on register
13
-
14
- def trigger(event_name, *args)
15
- event_name = normalized_event_name(event_name)
16
-
17
- ::ActiveSupport::Notifications.instrument(event_name, args)
18
- end
19
-
20
- replacement = ::ActiveSupport::Notifications
21
-
22
- ::Protobuf.deprecator.deprecate_methods(
23
- self,
24
- :register => "#{replacement}.#{replacement.method(:subscribe).name}".to_sym,
25
- :trigger => "#{replacement}.#{replacement.method(:instrument).name}".to_sym,
26
- )
27
-
28
- def normalized_event_name(event_name)
29
- event_name.to_s.downcase
30
- end
31
- end
32
- end
33
- end
@@ -1,39 +0,0 @@
1
- require 'logger'
2
-
3
- module Protobuf
4
- module Logging
5
- def self.initialize_logger(log_target = $stdout, log_level = ::Logger::INFO)
6
- @logger = Logger.new(log_target)
7
- @logger.level = log_level
8
- @logger
9
- end
10
-
11
- def self.logger
12
- defined?(@logger) ? @logger : initialize_logger
13
- end
14
-
15
- class << self
16
- attr_writer :logger
17
- end
18
-
19
- def logger
20
- ::Protobuf::Logging.logger
21
- end
22
-
23
- def log_exception(ex)
24
- logger.error { ex.message }
25
- logger.error { ex.backtrace[0..5].join("\n") }
26
- logger.debug { ex.backtrace.join("\n") }
27
- end
28
-
29
- def log_signature
30
- @_log_signature ||= "[#{self.class == Class ? name : self.class.name}]"
31
- end
32
-
33
- def sign_message(message)
34
- "#{log_signature} #{message}"
35
- end
36
- end
37
- end
38
-
39
- # Inspired by [mperham](https://github.com/mperham/sidekiq)
@@ -1,233 +0,0 @@
1
- require "set"
2
-
3
- module Protobuf
4
- class Message
5
- module Fields
6
-
7
- ACCESSOR_SUFFIXES = ["", "=", "!", "?"].freeze
8
-
9
- def self.extended(other)
10
- other.extend(ClassMethods)
11
- ::Protobuf.deprecator.define_deprecated_methods(
12
- other.singleton_class,
13
- :get_ext_field_by_name => :get_extension_field,
14
- :get_ext_field_by_tag => :get_extension_field,
15
- :get_field_by_name => :get_field,
16
- :get_field_by_tag => :get_field,
17
- )
18
- end
19
-
20
- module ClassMethods
21
- def inherited(subclass)
22
- inherit_fields!(subclass)
23
- subclass.const_set("PROTOBUF_MESSAGE_REQUIRED_FIELD_TAGS", subclass.required_field_tags)
24
- subclass.const_set("PROTOBUF_MESSAGE_GET_FIELD", subclass.field_store)
25
- subclass.class_eval <<-RUBY, __FILE__, __LINE__
26
- def _protobuf_message_field
27
- PROTOBUF_MESSAGE_GET_FIELD
28
- end
29
-
30
- def _protobuf_message_unset_required_field_tags
31
- @_protobuf_message_unset_required_field_tags ||= PROTOBUF_MESSAGE_REQUIRED_FIELD_TAGS.dup
32
- end
33
- RUBY
34
- end
35
-
36
- ##
37
- # Field Definition Methods
38
- #
39
-
40
- # Define an optional field.
41
- #
42
- def optional(type_class, name, tag, options = {})
43
- define_field(:optional, type_class, name, tag, options)
44
- end
45
-
46
- # Define a repeated field.
47
- #
48
- def repeated(type_class, name, tag, options = {})
49
- define_field(:repeated, type_class, name, tag, options)
50
- end
51
-
52
- # Define a required field.
53
- #
54
- def required(type_class, name, tag, options = {})
55
- required_field_tags << tag
56
- define_field(:required, type_class, name, tag, options)
57
- end
58
-
59
- # Define a map field.
60
- #
61
- def map(key_type_class, value_type_class, name, tag, options = {})
62
- # manufacture a message that represents the map entry, used for
63
- # serialization and deserialization
64
- entry_type = Class.new(::Protobuf::Message) do
65
- set_option :map_entry, true
66
- optional key_type_class, :key, 1
67
- optional value_type_class, :value, 2
68
- end
69
- define_field(:repeated, entry_type, name, tag, options)
70
- end
71
-
72
- # Define an extension range.
73
- #
74
- def extensions(range)
75
- extension_ranges << range
76
- end
77
-
78
- ##
79
- # Field Access Methods
80
- #
81
- def all_fields
82
- @all_fields ||= field_store.values.uniq.sort_by(&:tag)
83
- end
84
-
85
- def extension_fields
86
- @extension_fields ||= all_fields.select(&:extension?)
87
- end
88
-
89
- def extension_ranges
90
- @extension_ranges ||= []
91
- end
92
-
93
- def required_field_tags
94
- @required_field_tags ||= []
95
- end
96
-
97
- def extension_tag?(tag)
98
- tag.respond_to?(:to_i) && get_extension_field(tag).present?
99
- end
100
-
101
- def field_store
102
- @field_store ||= {}
103
- end
104
-
105
- def fields
106
- @fields ||= all_fields.reject(&:extension?)
107
- end
108
-
109
- def field_tag?(tag, allow_extension = false)
110
- tag.respond_to?(:to_i) && get_field(tag, allow_extension).present?
111
- end
112
-
113
- def get_extension_field(name_or_tag)
114
- field = field_store[name_or_tag]
115
- field if field.try(:extension?) { false }
116
- end
117
-
118
- def get_field(name_or_tag, allow_extension = false)
119
- field = field_store[name_or_tag]
120
-
121
- if field && (allow_extension || !field.extension?)
122
- field
123
- else
124
- nil
125
- end
126
- end
127
-
128
- def define_field(rule, type_class, fully_qualified_field_name, tag, options)
129
- raise_if_tag_collision(tag, fully_qualified_field_name)
130
- raise_if_name_collision(fully_qualified_field_name)
131
-
132
- # Determine appropirate accessor for fields depending on name collisions via extensions:
133
-
134
- # Case 1: Base field = "string_field" and no extensions of the same name
135
- # Result:
136
- # message.string_field #=> @values["string_field"]
137
- # message[:string_field] #=> @values["string_field"]
138
- # message['string_field'] #=> @values["string_field"]
139
-
140
- # Case 2: Base field = "string_field" and extension 1 = ".my_package.string_field", extension N = ".package_N.string_field"...
141
- # Result:
142
- # message.string_field #=> @values["string_field"]
143
- # message[:string_field] #=> @values["string_field"]
144
- # message['string_field'] #=> @values["string_field"]
145
- # message[:'.my_package.string_field'] #=> @values[".my_package.string_field"]
146
- # message['.my_package.string_field'] #=> @values[".my_package.string_field"]
147
-
148
- # Case 3: No base field, extension 1 = ".my_package.string_field", extension 2 = ".other_package.string_field", extension N...
149
- # Result:
150
- # message.string_field #=> raise NoMethodError (no simple accessor allowed)
151
- # message[:string_field] #=> raise NoMethodError (no simple accessor allowed)
152
- # message['string_field'] #=> raise NoMethodError (no simple accessor allowed)
153
- # message[:'.my_package.string_field'] #=> @values[".my_package.string_field"]
154
- # message['.my_package.string_field'] #=> @values[".my_package.string_field"]
155
- # message[:'.other_package.string_field'] #=> @values[".other_package.string_field"]
156
- # message['.other_package.string_field'] #=> @values[".other_package.string_field"]
157
-
158
- # Case 4: No base field, extension = ".my_package.string_field", no other extensions
159
- # Result:
160
- # message.string_field #=> @values[".my_package.string_field"]
161
- # message[:string_field] #=> @values[".my_package.string_field"]
162
- # message['string_field'] #=> @values[".my_package.string_field"]
163
- # message[:'.my_package.string_field'] #=> @values[".my_package.string_field"]
164
- # message[:'.my_package.string_field'] #=> @values[".my_package.string_field"]
165
-
166
- simple_name =
167
- if options[:extension]
168
- base_name = fully_qualified_field_name.to_s.split('.').last.to_sym
169
- if field_store[base_name]
170
- # Case 3
171
- if field_store[base_name].extension?
172
- remove_existing_accessors(base_name)
173
- end
174
- nil
175
- # Case 4
176
- else
177
- base_name
178
- end
179
- else
180
- # Case 1
181
- fully_qualified_field_name
182
- end
183
-
184
- field = ::Protobuf::Field.build(self, rule, type_class, fully_qualified_field_name,
185
- tag, simple_name, options)
186
- field_store[tag] = field
187
- field_store[fully_qualified_field_name.to_sym] = field
188
- field_store[fully_qualified_field_name.to_s] = field
189
- if simple_name && simple_name != fully_qualified_field_name
190
- field_store[simple_name.to_sym] = field
191
- field_store[simple_name.to_s] = field
192
- end
193
- # defining a new field for the message will cause cached @all_fields, @extension_fields,
194
- # and @fields to be incorrect; reset them
195
- @all_fields = @extension_fields = @fields = nil
196
- end
197
-
198
- def remove_existing_accessors(accessor)
199
- field_store.delete(accessor.to_sym).try(:fully_qualified_name_only!)
200
- field_store.delete(accessor.to_s)
201
- ACCESSOR_SUFFIXES.each do |modifier|
202
- begin
203
- remove_method("#{accessor}#{modifier}")
204
- # rubocop: disable Lint/HandleExceptions
205
- rescue NameError
206
- # Do not remove the method
207
- end
208
- end
209
- end
210
-
211
- def raise_if_tag_collision(tag, field_name)
212
- if get_field(tag, true)
213
- fail TagCollisionError, %(Field number #{tag} has already been used in "#{name}" by field "#{field_name}".)
214
- end
215
- end
216
-
217
- def raise_if_name_collision(field_name)
218
- if get_field(field_name, true)
219
- fail DuplicateFieldNameError, %(Field name #{field_name} has already been used in "#{name}".)
220
- end
221
- end
222
-
223
- def inherit_fields!(subclass)
224
- instance_variables.each do |iv|
225
- subclass.instance_variable_set(iv, instance_variable_get(iv))
226
- end
227
- end
228
- private :inherit_fields!
229
-
230
- end
231
- end
232
- end
233
- end
@@ -1,85 +0,0 @@
1
- require 'stringio'
2
- require 'protobuf/decoder'
3
- require 'protobuf/encoder'
4
-
5
- module Protobuf
6
- class Message
7
- module Serialization
8
-
9
- module ClassMethods
10
- def decode(bytes)
11
- new.decode(bytes)
12
- end
13
-
14
- def decode_from(stream)
15
- new.decode_from(stream)
16
- end
17
-
18
- # Create a new object with the given values and return the encoded bytes.
19
- def encode(fields = {})
20
- new(fields).encode
21
- end
22
- end
23
-
24
- def self.included(other)
25
- other.extend(ClassMethods)
26
- end
27
-
28
- ##
29
- # Instance Methods
30
- #
31
-
32
- # Decode the given non-stream bytes into this message.
33
- #
34
- def decode(bytes)
35
- decode_from(::StringIO.new(bytes))
36
- end
37
-
38
- # Decode the given stream into this message.
39
- #
40
- def decode_from(stream)
41
- ::Protobuf::Decoder.decode_each_field(stream) do |tag, bytes|
42
- set_field_bytes(tag, bytes)
43
- end
44
-
45
- self
46
- end
47
-
48
- # Encode this message
49
- #
50
- def encode
51
- stream = ::StringIO.new
52
- stream.set_encoding(::Protobuf::Field::BytesField::BYTES_ENCODING)
53
- encode_to(stream)
54
- stream.string
55
- end
56
-
57
- # Encode this message to the given stream.
58
- #
59
- def encode_to(stream)
60
- ::Protobuf::Encoder.encode(self, stream)
61
- end
62
-
63
- ##
64
- # Instance Aliases
65
- #
66
- alias :parse_from_string decode
67
- alias :deserialize decode
68
- alias :parse_from decode_from
69
- alias :deserialize_from decode_from
70
- alias :to_s encode
71
- alias :bytes encode
72
- alias :serialize encode
73
- alias :serialize_to_string encode
74
- alias :serialize_to encode_to
75
-
76
- private
77
-
78
- def set_field_bytes(tag, bytes)
79
- field = _protobuf_message_field[tag]
80
- field.set(self, bytes) if field
81
- end
82
-
83
- end
84
- end
85
- end
@@ -1,241 +0,0 @@
1
- require 'protobuf/message/fields'
2
- require 'protobuf/message/serialization'
3
- require 'protobuf/varint'
4
-
5
- module Protobuf
6
- class Message
7
-
8
- ##
9
- # Includes & Extends
10
- #
11
-
12
- extend ::Protobuf::Message::Fields
13
- include ::Protobuf::Message::Serialization
14
- ::Protobuf::Optionable.inject(self) { ::CSGoogle::Protobuf::MessageOptions }
15
-
16
- ##
17
- # Class Methods
18
- #
19
-
20
- def self.to_json
21
- name
22
- end
23
-
24
- ##
25
- # Constructor
26
- #
27
-
28
- def initialize(fields = {})
29
- @values = {}
30
- fields.to_hash.each do |name, value|
31
- set_field(name, value, true)
32
- end
33
-
34
- yield self if block_given?
35
- end
36
-
37
- ##
38
- # Public Instance Methods
39
- #
40
-
41
- def clear!
42
- @values.delete_if do |_, value|
43
- if value.is_a?(::Protobuf::Field::FieldArray) || value.is_a?(::Protobuf::Field::FieldHash)
44
- value.clear
45
- false
46
- else
47
- true
48
- end
49
- end
50
- self
51
- end
52
-
53
- def clone
54
- copy_to(super, :clone)
55
- end
56
-
57
- def dup
58
- copy_to(super, :dup)
59
- end
60
-
61
- # Iterate over every field, invoking the given block
62
- #
63
- def each_field
64
- return to_enum(:each_field) unless block_given?
65
-
66
- self.class.all_fields.each do |field|
67
- value = self[field.name]
68
- yield(field, value)
69
- end
70
- end
71
-
72
- def each_field_for_serialization
73
- _protobuf_message_unset_required_field_tags.each do |tag|
74
- fail ::Protobuf::SerializationError, "Required field #{self.class.name}##{_protobuf_message_field[tag].name} does not have a value."
75
- end
76
-
77
- @values.each_key do |fully_qualified_name|
78
- field = _protobuf_message_field[fully_qualified_name]
79
- yield(field, field.value_from_values_for_serialization(@values))
80
- end
81
- end
82
-
83
- def field?(name)
84
- field = _protobuf_message_field[name]
85
-
86
- if field
87
- field.field?(@values)
88
- else
89
- false
90
- end
91
- end
92
- alias :respond_to_has? field?
93
- ::Protobuf.deprecator.define_deprecated_methods(self, :has_field? => :field?)
94
-
95
- def inspect
96
- attrs = self.class.fields.map do |field|
97
- [field.name, self[field.name].inspect].join('=')
98
- end.join(' ')
99
-
100
- "#<#{self.class} #{attrs}>"
101
- end
102
-
103
- def respond_to_has_and_present?(key)
104
- field = _protobuf_message_field[key]
105
-
106
- if field
107
- field.field_and_present?(@values)
108
- else
109
- false
110
- end
111
- end
112
-
113
- # Return a hash-representation of the given fields for this message type.
114
- def to_hash
115
- result = {}
116
-
117
- @values.each_key do |field_name|
118
- field = _protobuf_message_field[field_name]
119
- field.to_message_hash(@values, result)
120
- end
121
-
122
- result
123
- end
124
-
125
- def to_hash_with_string_keys
126
- result = {}
127
-
128
- @values.each_key do |field_name|
129
- field = _protobuf_message_field[field_name]
130
- field.to_message_hash_with_string_key(@values, result)
131
- end
132
-
133
- result
134
- end
135
-
136
- def to_json(options = {})
137
- to_json_hash.to_json(options)
138
- end
139
-
140
- # Return a hash-representation of the given fields for this message type that
141
- # is safe to convert to JSON.
142
- def to_json_hash
143
- result = {}
144
-
145
- @values.each_key do |field_name|
146
- value = self[field_name]
147
- field = self.class.get_field(field_name, true)
148
-
149
- # NB: to_json_hash_value should come before json_encode so as to handle
150
- # repeated fields without extra logic.
151
- hashed_value = if value.respond_to?(:to_json_hash_value)
152
- value.to_json_hash_value
153
- elsif field.respond_to?(:json_encode)
154
- field.json_encode(value)
155
- else
156
- value
157
- end
158
-
159
- result[field.name] = hashed_value
160
- end
161
-
162
- result
163
- end
164
-
165
- def to_proto
166
- self
167
- end
168
-
169
- def ==(other)
170
- return false unless other.is_a?(self.class)
171
- each_field do |field, value|
172
- return false unless value == other[field.name]
173
- end
174
- true
175
- end
176
-
177
- def [](name)
178
- field = _protobuf_message_field[name]
179
- field.value_from_values(@values)
180
- rescue # not having a field should be the exceptional state
181
- raise if field
182
- fail ArgumentError, "invalid field name=#{name.inspect}"
183
- end
184
-
185
- def []=(name, value)
186
- set_field(name, value, true)
187
- end
188
-
189
- def set_field(name, value, ignore_nil_for_repeated, field = nil)
190
- field ||= _protobuf_message_field[name]
191
-
192
- if field
193
- field.set_field(@values, value, ignore_nil_for_repeated, self)
194
- else
195
- fail(::Protobuf::FieldNotDefinedError, name) unless ::Protobuf.ignore_unknown_fields?
196
- end
197
- end
198
-
199
- ##
200
- # Instance Aliases
201
- #
202
- alias :to_hash_value to_hash
203
- alias :to_json_hash_value to_json_hash
204
- alias :to_proto_hash to_hash
205
- alias :responds_to_has? respond_to_has?
206
- alias :respond_to_and_has? respond_to_has?
207
- alias :responds_to_and_has? respond_to_has?
208
- alias :respond_to_has_present? respond_to_has_and_present?
209
- alias :respond_to_and_has_present? respond_to_has_and_present?
210
- alias :respond_to_and_has_and_present? respond_to_has_and_present?
211
- alias :responds_to_has_present? respond_to_has_and_present?
212
- alias :responds_to_and_has_present? respond_to_has_and_present?
213
- alias :responds_to_and_has_and_present? respond_to_has_and_present?
214
-
215
- ##
216
- # Private Instance Methods
217
- #
218
-
219
- private
220
-
221
- def copy_to(object, method)
222
- duplicate = proc do |obj|
223
- case obj
224
- when Message, String then obj.__send__(method)
225
- else obj
226
- end
227
- end
228
-
229
- object.__send__(:initialize)
230
- @values.each do |name, value|
231
- if value.is_a?(::Protobuf::Field::FieldArray)
232
- object[name].replace(value.map { |v| duplicate.call(v) })
233
- else
234
- object[name] = duplicate.call(value)
235
- end
236
- end
237
- object
238
- end
239
-
240
- end
241
- end