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,380 +0,0 @@
1
- require 'active_support/core_ext/hash/slice'
2
- require 'protobuf/field/field_array'
3
- require 'protobuf/field/field_hash'
4
- require 'protobuf/field/base_field_object_definitions'
5
-
6
- module Protobuf
7
- module Field
8
- class BaseField
9
- include ::Protobuf::Logging
10
- ::Protobuf::Optionable.inject(self, false) { ::CSGoogle::Protobuf::FieldOptions }
11
-
12
- ##
13
- # Constants
14
- #
15
- OBJECT_MODULE = ::Protobuf::Field::BaseFieldObjectDefinitions
16
- PACKED_TYPES = [
17
- ::Protobuf::WireType::VARINT,
18
- ::Protobuf::WireType::FIXED32,
19
- ::Protobuf::WireType::FIXED64,
20
- ].freeze
21
-
22
- ##
23
- # Attributes
24
- #
25
- attr_reader :default_value, :message_class, :name, :fully_qualified_name, :options, :rule, :tag, :type_class
26
-
27
- ##
28
- # Class Methods
29
- #
30
-
31
- def self.default
32
- nil
33
- end
34
-
35
- ##
36
- # Constructor
37
- #
38
-
39
- def initialize(message_class, rule, type_class, fully_qualified_name, tag, simple_name, options)
40
- @message_class = message_class
41
- @name = simple_name || fully_qualified_name
42
- @fully_qualified_name = fully_qualified_name
43
- @rule = rule
44
- @tag = tag
45
- @type_class = type_class
46
- # Populate the option hash with all the original default field options, for backwards compatibility.
47
- # However, both default and custom options should ideally be accessed through the Optionable .{get,get!}_option functions.
48
- @options = options.slice(:ctype, :packed, :deprecated, :lazy, :jstype, :weak, :uninterpreted_option, :default, :extension)
49
- options.each do |option_name, value|
50
- set_option(option_name, value)
51
- end
52
-
53
- @extension = options.key?(:extension)
54
- @deprecated = options.key?(:deprecated)
55
- @required = rule == :required
56
- @repeated = rule == :repeated
57
- @optional = rule == :optional
58
- @packed = @repeated && options.key?(:packed)
59
-
60
- validate_packed_field if packed?
61
- define_accessor(simple_name, fully_qualified_name) if simple_name
62
- set_repeated_message!
63
- set_map!
64
- @value_from_values = nil
65
- @value_from_values_for_serialization = nil
66
- @field_predicate = nil
67
- @field_and_present_predicate = nil
68
- @set_field = nil
69
- @set_method = nil
70
- @to_message_hash = nil
71
- @to_message_hash_string_keys = nil
72
- @encode_to_stream = nil
73
-
74
- define_value_from_values!
75
- define_value_from_values_for_serialization!
76
- define_field_predicate!
77
- define_field_and_present_predicate!
78
- define_set_field!
79
- define_set_method!
80
- define_to_message_hash!
81
- define_encode_to_stream!
82
- set_default_value!
83
- end
84
-
85
- ##
86
- # Public Instance Methods
87
- #
88
-
89
- def acceptable?(_value)
90
- true
91
- end
92
-
93
- def coerce!(value)
94
- value
95
- end
96
-
97
- def decode(_bytes)
98
- fail NotImplementedError, "#{self.class.name}##{__method__}"
99
- end
100
-
101
- def default
102
- options[:default]
103
- end
104
-
105
- def set_default_value!
106
- @default_value ||= if optional? || required?
107
- typed_default_value
108
- elsif map?
109
- ::Protobuf::Field::FieldHash.new(self).freeze
110
- elsif repeated?
111
- ::Protobuf::Field::FieldArray.new(self).freeze
112
- else
113
- fail "Unknown field label -- something went very wrong"
114
- end
115
- end
116
-
117
- def define_encode_to_stream!
118
- @encode_to_stream = if repeated? && packed?
119
- OBJECT_MODULE::RepeatedPackedEncodeToStream.new(self)
120
- elsif repeated?
121
- OBJECT_MODULE::RepeatedNotPackedEncodeToStream.new(self)
122
- elsif message? || type_class == ::Protobuf::Field::BytesField
123
- OBJECT_MODULE::BytesEncodeToStream.new(self)
124
- elsif type_class == ::Protobuf::Field::StringField
125
- OBJECT_MODULE::StringEncodeToStream.new(self)
126
- else
127
- OBJECT_MODULE::BaseEncodeToStream.new(self)
128
- end
129
- end
130
-
131
- def encode_to_stream(value, stream)
132
- @encode_to_stream.call(value, stream)
133
- end
134
-
135
- def define_field_predicate!
136
- @field_predicate = if repeated?
137
- OBJECT_MODULE::RepeatedFieldPredicate.new(self)
138
- else
139
- OBJECT_MODULE::BaseFieldPredicate.new(self)
140
- end
141
- end
142
-
143
- def field?(values)
144
- @field_predicate.call(values)
145
- end
146
-
147
- def define_field_and_present_predicate!
148
- @field_and_present_predicate = if !repeated? && type_class == ::Protobuf::Field::BoolField # boolean present check
149
- OBJECT_MODULE::BoolFieldAndPresentPredicate.new(self)
150
- else
151
- OBJECT_MODULE::BaseFieldAndPresentPredicate.new(self)
152
- end
153
- end
154
-
155
- def field_and_present?(values)
156
- @field_and_present_predicate.call(values)
157
- end
158
-
159
- def define_value_from_values!
160
- @value_from_values = if map?
161
- OBJECT_MODULE::MapValueFromValues.new(self)
162
- elsif repeated?
163
- OBJECT_MODULE::RepeatedFieldValueFromValues.new(self)
164
- elsif type_class == ::Protobuf::Field::BoolField # boolean present check
165
- OBJECT_MODULE::BoolFieldValueFromValues.new(self)
166
- else
167
- OBJECT_MODULE::BaseFieldValueFromValues.new(self)
168
- end
169
- end
170
-
171
- def value_from_values(values)
172
- @value_from_values.call(values)
173
- end
174
-
175
- def define_value_from_values_for_serialization!
176
- @value_from_values_for_serialization = if map?
177
- OBJECT_MODULE::MapValueFromValuesForSerialization.new(self)
178
- elsif repeated?
179
- OBJECT_MODULE::RepeatedFieldValueFromValuesForSerialization.new(self)
180
- elsif type_class == ::Protobuf::Field::BoolField # boolean present check
181
- OBJECT_MODULE::BoolFieldValueFromValuesForSerialization.new(self)
182
- else
183
- OBJECT_MODULE::BaseFieldValueFromValuesForSerialization.new(self)
184
- end
185
- end
186
-
187
- def value_from_values_for_serialization(values)
188
- @value_from_values_for_serialization.call(values)
189
- end
190
-
191
- def define_set_field!
192
- @set_field = if map? && required?
193
- OBJECT_MODULE::RequiredMapSetField.new(self)
194
- elsif repeated? && required?
195
- OBJECT_MODULE::RequiredRepeatedSetField.new(self)
196
- elsif type_class == ::Protobuf::Field::StringField && required?
197
- OBJECT_MODULE::RequiredStringSetField.new(self)
198
- elsif required?
199
- OBJECT_MODULE::RequiredBaseSetField.new(self)
200
- elsif map?
201
- OBJECT_MODULE::MapSetField.new(self)
202
- elsif repeated?
203
- OBJECT_MODULE::RepeatedSetField.new(self)
204
- elsif type_class == ::Protobuf::Field::StringField
205
- OBJECT_MODULE::StringSetField.new(self)
206
- else
207
- OBJECT_MODULE::BaseSetField.new(self)
208
- end
209
- end
210
-
211
- def set_field(values, value, ignore_nil_for_repeated, message_instance)
212
- @set_field.call(values, value, ignore_nil_for_repeated, message_instance)
213
- end
214
-
215
- def define_to_message_hash!
216
- if message? || enum? || repeated? || map?
217
- @to_message_hash = OBJECT_MODULE::ToHashValueToMessageHash.new(self)
218
- @to_message_hash_string_keys = OBJECT_MODULE::ToHashValueToMessageHashWithStringKey.new(self)
219
- else
220
- @to_message_hash = OBJECT_MODULE::BaseToMessageHash.new(self)
221
- @to_message_hash_string_keys = OBJECT_MODULE::BaseToMessageHashWithStringKey.new(self)
222
- end
223
- end
224
-
225
- def to_message_hash(values, result)
226
- @to_message_hash.call(values, result)
227
- end
228
-
229
- def to_message_hash_with_string_key(values, result)
230
- @to_message_hash_string_keys.call(values, result)
231
- end
232
-
233
- def deprecated?
234
- @deprecated
235
- end
236
-
237
- def encode(_value)
238
- fail NotImplementedError, "#{self.class.name}##{__method__}"
239
- end
240
-
241
- def extension?
242
- @extension
243
- end
244
-
245
- def enum?
246
- false
247
- end
248
-
249
- def message?
250
- false
251
- end
252
-
253
- def set_map!
254
- set_repeated_message!
255
- @is_map = repeated_message? && type_class.get_option!(:map_entry)
256
- end
257
-
258
- def map?
259
- @is_map
260
- end
261
-
262
- def optional?
263
- @optional
264
- end
265
-
266
- def packed?
267
- @packed
268
- end
269
-
270
- def repeated?
271
- @repeated
272
- end
273
-
274
- def set_repeated_message!
275
- @repeated_message = repeated? && message?
276
- end
277
-
278
- def repeated_message?
279
- @repeated_message
280
- end
281
-
282
- def required?
283
- @required
284
- end
285
-
286
- def define_set_method!
287
- @set_method = if map?
288
- OBJECT_MODULE::MapSetMethod.new(self)
289
- elsif repeated? && packed?
290
- OBJECT_MODULE::RepeatedPackedSetMethod.new(self)
291
- elsif repeated?
292
- OBJECT_MODULE::RepeatedNotPackedSetMethod.new(self)
293
- else
294
- OBJECT_MODULE::BaseSetMethod.new(self)
295
- end
296
- end
297
-
298
- def set(message_instance, bytes)
299
- @set_method.call(message_instance, bytes)
300
- end
301
-
302
- def tag_encoded
303
- @tag_encoded ||= begin
304
- case
305
- when repeated? && packed?
306
- ::Protobuf::Field::VarintField.encode((tag << 3) | ::Protobuf::WireType::LENGTH_DELIMITED)
307
- else
308
- ::Protobuf::Field::VarintField.encode((tag << 3) | wire_type)
309
- end
310
- end
311
- end
312
-
313
- # FIXME: add packed, deprecated, extension options to to_s output
314
- def to_s
315
- "#{rule} #{type_class} #{name} = #{tag} #{default ? "[default=#{default.inspect}]" : ''}"
316
- end
317
-
318
- ::Protobuf.deprecator.define_deprecated_methods(self, :type => :type_class)
319
-
320
- def wire_type
321
- ::Protobuf::WireType::VARINT
322
- end
323
-
324
- def fully_qualified_name_only!
325
- @name = @fully_qualified_name
326
-
327
- ##
328
- # Recreate all of the meta methods as they may have used the original `name` value
329
- #
330
- define_value_from_values!
331
- define_value_from_values_for_serialization!
332
- define_field_predicate!
333
- define_field_and_present_predicate!
334
- define_set_field!
335
- define_set_method!
336
- define_to_message_hash!
337
- define_encode_to_stream!
338
- end
339
-
340
- private
341
-
342
- ##
343
- # Private Instance Methods
344
- #
345
-
346
- def define_accessor(simple_field_name, fully_qualified_field_name)
347
- message_class.class_eval do
348
- define_method("#{simple_field_name}!") do
349
- @values[fully_qualified_field_name] if field?(fully_qualified_field_name)
350
- end
351
- end
352
-
353
- message_class.class_eval do
354
- define_method(simple_field_name) { self[fully_qualified_field_name] }
355
- define_method("#{simple_field_name}=") { |v| set_field(fully_qualified_field_name, v, false) }
356
- end
357
-
358
- return unless deprecated?
359
-
360
- ::Protobuf.field_deprecator.deprecate_method(message_class, simple_field_name)
361
- ::Protobuf.field_deprecator.deprecate_method(message_class, "#{simple_field_name}!")
362
- ::Protobuf.field_deprecator.deprecate_method(message_class, "#{simple_field_name}=")
363
- end
364
-
365
- def typed_default_value
366
- if default.nil?
367
- self.class.default
368
- else
369
- default
370
- end
371
- end
372
-
373
- def validate_packed_field
374
- if packed? && ! ::Protobuf::Field::BaseField::PACKED_TYPES.include?(wire_type)
375
- fail "Can't use packed encoding for '#{type_class}' type"
376
- end
377
- end
378
- end
379
- end
380
- end