dalli 5.0.10 → 5.0.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 64bc18f470e5b97d87b6531a968a9252c4ff46ba715d927c74b66e52f7549683
4
- data.tar.gz: 70fc9db7148b82932b9f3323ac74a2c59dd7ed8b72bd9543dc160c5026d33880
3
+ metadata.gz: 237c6d61c07c784fab08e871f5ec95e05a56f280a738bd2a060176ea49885198
4
+ data.tar.gz: 846bb56b3ce9e7a7c1b9c2bfd91faa907c5b8974e686a0767d4437343dadd2b3
5
5
  SHA512:
6
- metadata.gz: a2c3def53ce7c5c4bf4d929bc45c5d1ff7f000db6b59abea3ac9ef3eb81e7f706ab8d0b01021b7002ff2b2153014b17c018c5060935e022f867b4981318afc06
7
- data.tar.gz: f63a580cc08950f6da91213f0c4b9ecd2cb75961fe4467e06c11ecb434d2b13ff5950fceb31d43f8b8c42d8997fec3fd1bd40eebc1aa59dda41b2c1092a5e253
6
+ metadata.gz: 8ef4bca995d5ed6d1d0d47b460a21f9ac99db727d3a60fe60f168760b11e7b1c2e139903b5d2b3b8d8ce0869ff252b5b77acdf422db8d07456301e83e87e9e94
7
+ data.tar.gz: 5b272117c00c7ce7e077ad5137a708a9ce06a842408b75f8efd1248c72a29b3fc739cfe7347dd475229158c3cd0869989c89b57f51d91bc8794c277a4324a0a9
data/CHANGELOG.md CHANGED
@@ -4,6 +4,42 @@ Dalli Changelog
4
4
  Unreleased
5
5
  ==========
6
6
 
7
+ 5.0.12
8
+ ==========
9
+
10
+ Security:
11
+
12
+ - Keep a connection shared by several threads or fibers in step during a `quiet` block (GHSA-5xvx-r8rg-5qm2)
13
+ - A `quiet` (or `multi`) block is quiet only for the thread or fiber that runs it. memcached still replies to a quiet request that fails (for example an `add` of a key that exists), and another thread or fiber using the same client while the block was open read that reply as its own, so its later requests could return another key's value. A non-quiet request now reads any pending quiet replies first
14
+ - Don't let a `get_multi` that stopped early leave replies for a later request (GHSA-5xvx-r8rg-5qm2)
15
+ - A pipelined `get_multi` stopped by a non-network exception (its block raising or breaking, `Timeout.timeout`, or a value that can't be deserialized) left its unread replies in the response buffer, and a later `get_multi` large enough to use the interleaved path returned them as its own. The buffer is now cleared when a connection closes or a pipelined get starts, and unfinished pipelines are aborted
16
+ - Affects every supported line (the `get_multi` issue, 4.3 and later); fixed in 5.2.4, 5.1.6, 5.0.12, 4.3.9 and 3.2.15
17
+
18
+ Bug fixes:
19
+
20
+ - A per-request `raw: true` write no longer compresses the value (backport of #1213)
21
+ - Values at or above the compression threshold (4 KB by default) were compressed and flagged even with `raw: true`. Raw reads ignore flags, so reading them back with `raw: true` returned the compressed bytes
22
+ - Raw values are now stored exactly as given. Callers that pass `raw: true` without `compress: false` store large values uncompressed; Rails' `MemCacheStore` passes `compress: false` and isn't affected
23
+ - Handle failed TLS handshakes like other connection failures, and warn when TLS verification is off (backport of #1215)
24
+ - A failed or timed-out handshake left the TCP socket open until GC and raised `OpenSSL::SSL::SSLError` directly, so the server was never marked down. The socket is now closed, and the error goes through the usual retry and `socket_max_failures` handling, raising `Dalli::NetworkError` (or `Dalli::RingError` once no server is available)
25
+ - Certificate and hostname checks come only from the `ssl_context` you pass, and a bare `OpenSSL::SSL::SSLContext.new` checks neither. Dalli now logs a warning once per process when `verify_mode` doesn't include `VERIFY_PEER` or `verify_hostname` is false; see the new TLS section in the README
26
+ - A reply line longer than 8 KiB without a CRLF, or one cut short by the connection closing, is now a network error that closes the connection. Before, the line had no length limit (backport of #1216)
27
+ - One value that can't be stored no longer discards other buffered writes (backport of #1218)
28
+ - A value that raised `Dalli::MarshalError` or `Dalli::ValueOverMaxSize` closed the connection, which dropped writes still buffered from the same `quiet` block or `set_multi`. Multi-server `set_multi` did this without raising
29
+ - Both `set_multi` paths now store every other key, skip the bad one, and then raise. Single-server `set_multi` used to store nothing
30
+ - When single-server `set_multi` failed to marshal a value, the error log included every value in the batch. It now lists only the keys
31
+
32
+ 5.0.11
33
+ ==========
34
+
35
+ Security:
36
+
37
+ - Don't rely on memcached's auto-create for keys that need base64 encoding (GHSA-r47x-6p6r-mvcp)
38
+ - memcached stores an item made by auto-create (`ma` with `N`/`J`, or `mg` with `N`) for a base64-encoded key without its binary-key flag, and later replies name the item by its raw key bytes. A key containing spaces or CR/LF could then make a multi-get read the replies after it as different ones
39
+ - `incr` and `decr` with an initial value now create such counters with an add instead. Return values are unchanged
40
+ - The new `verify_reply_keys` option makes `get_multi` and `get_multi_cas` ignore replies for keys they didn't request, which guards against items created by older Dalli versions or other clients until memcached is upgraded. It's off by default, since it costs a multi-get about 15%
41
+ - Affects the meta protocol since 3.2.0; fixed in 5.2.3, 5.1.5, 5.0.11, 4.3.8 and 3.2.14. memcached 1.6.45 and earlier still name these items by their raw key bytes
42
+
7
43
  5.0.10
8
44
  ==========
9
45
 
data/README.md CHANGED
@@ -58,6 +58,29 @@ Per-request `raw: true` returns the stored bytes without deserializing or decomp
58
58
 
59
59
  See the [5.0-Upgrade.md](5.0-Upgrade.md) guide for upgrade information.
60
60
 
61
+ ### Counters and verify_reply_keys
62
+
63
+ memcached names an item made by auto-create for a base64-encoded key (one with whitespace, control or non-ASCII characters) by its raw key bytes in later replies. Since 5.0.11, Dalli creates counters for such keys with an add rather than auto-create. Items created before then, or by other clients, can still be named that way until memcached releases a fix (1.6.45 and earlier behave this way). If keys passed to `incr` or `decr` with an initial value can contain untrusted input, set `verify_reply_keys: true` until then: multi-gets then ignore replies for keys they didn't request, at a cost of about 15% per multi-get.
64
+
65
+ ## TLS
66
+
67
+ Pass an `OpenSSL::SSL::SSLContext` as `ssl_context:` to connect over TLS. Certificate and hostname verification come only from that context: Dalli adds no checks of its own. A bare `OpenSSL::SSL::SSLContext.new` verifies nothing, so it accepts any certificate from any server. Configure the context to verify both:
68
+
69
+ ```ruby
70
+ ssl_context = OpenSSL::SSL::SSLContext.new
71
+ ssl_context.set_params(
72
+ verify_mode: OpenSSL::SSL::VERIFY_PEER,
73
+ verify_hostname: true,
74
+ ca_file: '/path/to/ca.crt' # omit to use the system's trusted certificates
75
+ )
76
+
77
+ Dalli::Client.new('memcached.example.com:11211', ssl_context: ssl_context)
78
+ ```
79
+
80
+ Dalli logs a warning once per process when the context's `verify_mode` is `VERIFY_NONE`, or when it is `VERIFY_PEER` but `verify_hostname` is false.
81
+
82
+ A failed TLS handshake counts as a failed connection attempt, like a refused connection: once `socket_max_failures` attempts have failed, the server is marked down and requests fail over to the other servers.
83
+
61
84
  ## OpenTelemetry Tracing
62
85
 
63
86
  Dalli automatically instruments operations with [OpenTelemetry](https://opentelemetry.io/) when the SDK is present. No configuration is required - just add the OpenTelemetry gems to your application:
data/lib/dalli/client.rb CHANGED
@@ -41,15 +41,21 @@ module Dalli
41
41
  # #fetch operations.
42
42
  # - :raw - If set, disables serialization and compression entirely at the client level.
43
43
  # Only String values are supported. This is useful when the caller handles its own
44
- # serialization (e.g., Rails' ActiveSupport::Cache). Note: this is different from
45
- # the per-request :raw option which converts values to strings but still uses the
46
- # serialization pipeline.
44
+ # serialization (e.g., Rails' ActiveSupport::Cache). The per-request :raw option
45
+ # (e.g. set(key, value, ttl, raw: true)) does the same for a single call: String
46
+ # values are stored as-is, uncompressed, and non-String values raise
47
+ # Dalli::MarshalError.
47
48
  # - :digest_class - defaults to Digest::MD5, allows you to pass in an object that responds to the hexdigest method,
48
49
  # useful for injecting a FIPS compliant hash object.
49
50
  # - :otel_db_statement - controls the +db.query.text+ span attribute when OpenTelemetry is loaded.
50
51
  # +:include+ logs the full operation and key(s), +:obfuscate+ replaces keys with "?",
51
52
  # +nil+ (default) omits the attribute entirely.
52
53
  # - :otel_peer_service - when set, adds a +peer.service+ span attribute with this value for logical service naming.
54
+ # - :verify_reply_keys - defaults to false. When true, get_multi, get_multi_cas and get_multi_with_metadata only
55
+ # accept replies for the keys they requested; after a reply naming another key, the rest of
56
+ # that server's replies are treated as misses. memcached can name an item by its raw key
57
+ # bytes when the item was created by auto-create from a base64-encoded key, which Dalli no
58
+ # longer does. Costs a multi-get about 15%.
53
59
  #
54
60
  def initialize(servers = nil, options = {})
55
61
  @normalized_servers = ::Dalli::ServersArgNormalizer.normalize_servers(servers)
@@ -288,6 +294,11 @@ module Dalli
288
294
  # Any error replies will be discarded at the end of the block, and
289
295
  # Dalli client methods invoked inside the block will not
290
296
  # have return values
297
+ #
298
+ # The block is quiet only for the thread or fiber that runs it. Another
299
+ # thread or fiber sharing this client can make requests meanwhile; a
300
+ # non-quiet one first sends the block's buffered requests and discards
301
+ # their replies, so it reads only its own.
291
302
  def quiet
292
303
  old = Thread.current[::Dalli::QUIET]
293
304
  Thread.current[::Dalli::QUIET] = true
@@ -572,6 +583,9 @@ module Dalli
572
583
  result
573
584
  rescue Dalli::NetworkError
574
585
  {}
586
+ rescue Dalli::UnexpectedReplyKeyError => e
587
+ Dalli.logger.warn { e.message }
588
+ {}
575
589
  end
576
590
 
577
591
  def single_server_set_multi(hash, ttl, req_options)
data/lib/dalli/options.rb CHANGED
@@ -43,7 +43,7 @@ module Dalli
43
43
  end
44
44
  end
45
45
 
46
- def pipeline_abort
46
+ def pipeline_abort(...)
47
47
  @lock.synchronize do
48
48
  super
49
49
  end
@@ -24,15 +24,21 @@ module Dalli
24
24
  return {} if keys.empty?
25
25
 
26
26
  @ring.lock do
27
- # Stores partial results collected during interleaved send phase
28
- @partial_results = {}
29
- servers = setup_requests(keys)
30
- start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
27
+ # The servers with replies still to read, updated in place
28
+ servers = []
29
+ begin
30
+ # Stores partial results collected during interleaved send phase
31
+ @partial_results = {}
32
+ setup_requests(servers, keys)
33
+ start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
31
34
 
32
- # First yield any partial results collected during interleaved send
33
- yield_partial_results(&block)
35
+ # First yield any partial results collected during interleaved send
36
+ yield_partial_results(&block)
34
37
 
35
- servers = fetch_responses(servers, start_time, @ring.socket_timeout, &block) until servers.empty?
38
+ fetch_responses(servers, start_time, @ring.socket_timeout, &block) until servers.empty?
39
+ ensure
40
+ abort_unfinished(servers)
41
+ end
36
42
  end
37
43
  rescue Dalli::RetryableNetworkError => e
38
44
  Dalli.logger.debug { e.inspect }
@@ -49,12 +55,15 @@ module Dalli
49
55
  @partial_results.clear
50
56
  end
51
57
 
52
- def setup_requests(keys)
58
+ # Adds the servers with a pending response to servers before writing
59
+ # their queries, so #process can abort them if it stops early.
60
+ def setup_requests(servers, keys)
53
61
  groups = groups_for_keys(keys)
62
+ servers.concat(groups.keys)
54
63
  make_getkq_requests(groups)
55
64
 
56
65
  # TODO: How does this exit on a NetworkError
57
- finish_queries(groups.keys)
66
+ finish_queries(servers)
58
67
  end
59
68
 
60
69
  ##
@@ -116,29 +125,39 @@ module Dalli
116
125
  raise
117
126
  end
118
127
 
119
- # Swallows Dalli::NetworkError
128
+ # Swallows Dalli::NetworkError. Empties servers, so they aren't aborted
129
+ # again.
120
130
  def abort_without_timeout(servers)
121
131
  servers.each(&:pipeline_abort)
132
+ servers.clear
133
+ end
134
+
135
+ # When #process stops before reading every server's replies (the caller's
136
+ # block raises or breaks, a Timeout.timeout fires, a value can't be
137
+ # deserialized), the rest are still on the socket and some may be in the
138
+ # response buffer. Closing those connections keeps them from being read
139
+ # as a later request's replies. Aborts that #process already handled
140
+ # emptied servers.
141
+ def abort_unfinished(servers)
142
+ servers.each { |server| server.pipeline_abort(timed_out: false) }
143
+ servers.clear
122
144
  end
123
145
 
146
+ # Reads the replies available, removing finished servers from servers
124
147
  def fetch_responses(servers, start_time, timeout, &block)
125
148
  # Remove any servers which are not connected
126
149
  servers.select!(&:connected?)
127
- return [] if servers.empty?
150
+ return if servers.empty?
128
151
 
129
152
  time_left = remaining_time(start_time, timeout)
130
153
  readable_servers = servers_with_response(servers, time_left)
131
- if readable_servers.empty?
132
- abort_with_timeout(servers)
133
- return []
134
- end
154
+ return abort_with_timeout(servers) if readable_servers.empty?
135
155
 
136
156
  # Loop through the servers with responses, and
137
157
  # delete any from our list that are finished
138
158
  readable_servers.each do |server|
139
159
  servers.delete(server) if process_server(server, &block)
140
160
  end
141
- servers
142
161
  rescue NetworkError
143
162
  # Abort and raise if we encountered a network error. This triggers
144
163
  # a retry at the top level on RetryableNetworkError.
@@ -155,12 +174,10 @@ module Dalli
155
174
 
156
175
  # Swallows Dalli::NetworkError
157
176
  def abort_with_timeout(servers)
158
- abort_without_timeout(servers)
159
177
  servers.each do |server|
160
178
  Dalli.logger.debug { "memcached at #{server.name} did not response within timeout" }
161
179
  end
162
-
163
- true # Required to simplify caller
180
+ abort_without_timeout(servers)
164
181
  end
165
182
 
166
183
  # Processes responses from a server. Returns true if there are no
@@ -16,6 +16,9 @@ module Dalli
16
16
  # Writes multiple key-value pairs to memcached.
17
17
  # Raises an error if any server is unavailable.
18
18
  #
19
+ # A value that can't be marshalled or is over value_max_bytes is skipped;
20
+ # the other keys are still stored, then the first such error is raised.
21
+ #
19
22
  # @param hash [Hash] key-value pairs to set
20
23
  # @param ttl [Integer] time-to-live in seconds
21
24
  # @param req_options [Hash] options passed to each set operation
@@ -24,10 +27,12 @@ module Dalli
24
27
  def process(hash, ttl, req_options)
25
28
  return if hash.empty?
26
29
 
30
+ @value_error = nil
27
31
  @ring.lock do
28
32
  servers = setup_requests(hash, ttl, req_options)
29
33
  finish_requests(servers)
30
34
  end
35
+ raise @value_error if @value_error
31
36
  rescue Dalli::RetryableNetworkError => e
32
37
  Dalli.logger.debug { e.inspect }
33
38
  Dalli.logger.debug { 'retrying pipelined sets because of network error' }
@@ -52,6 +57,10 @@ module Dalli
52
57
  original_key = @key_manager.key_without_namespace(key)
53
58
  value = hash[original_key]
54
59
  server.request(:pipelined_set, key, value, ttl, req_options)
60
+ rescue Dalli::MarshalError, Dalli::ValueOverMaxSize => e
61
+ # Nothing was written for this key, so the server's other keys are
62
+ # unaffected; raised by #process once the batch is complete
63
+ @value_error ||= e
55
64
  rescue DalliError, NetworkError => e
56
65
  Dalli.logger.debug { e.inspect }
57
66
  Dalli.logger.debug { "unable to set key #{key} for server #{server.name}" }
@@ -25,6 +25,7 @@ module Dalli
25
25
  warn_uri_credentials(user_creds)
26
26
  @options = client_options.merge(user_creds)
27
27
  @raw_mode = client_options[:raw]
28
+ @verify_reply_keys = client_options[:verify_reply_keys] ? true : false
28
29
  @value_marshaller = @raw_mode ? StringMarshaller.new(@options) : ValueMarshaller.new(@options)
29
30
  @connection_manager = ConnectionManager.new(hostname, port, socket_type, @options)
30
31
  end
@@ -50,15 +51,25 @@ module Dalli
50
51
  begin
51
52
  request_completed = false
52
53
  @connection_manager.start_request!
54
+ drain_pending_quiet_responses(opkey)
53
55
  response = send(opkey, *args)
56
+ # Quiet requests can leave replies on the socket; remember that so a
57
+ # later non-quiet request knows to read them first
58
+ @connection_manager.mark_quiet_responses_pending! if quiet? && opkey != :noop
54
59
 
55
60
  # pipelined_get/pipelined_get_interleaved emit query but don't read the response(s)
56
61
  @connection_manager.finish_request! unless %i[pipelined_get pipelined_get_interleaved].include?(opkey)
57
62
 
58
63
  request_completed = true
59
64
  response
60
- rescue Dalli::MarshalError => e
61
- log_marshal_err(args.first, e)
65
+ rescue Dalli::MarshalError, Dalli::ValueOverMaxSize => e
66
+ log_marshal_err(args.first, e) if e.is_a?(Dalli::MarshalError)
67
+ # Raised only while the connection is clean: a value is marshalled
68
+ # before any of its request is written, and write_multi_req raises
69
+ # only after reading every reply. Closing the connection would
70
+ # discard earlier quiet writes still waiting in the write buffer.
71
+ @connection_manager.abort_request!
72
+ request_completed = true
62
73
  raise
63
74
  rescue Dalli::DalliError
64
75
  raise
@@ -105,7 +116,7 @@ module Dalli
105
116
  verify_pipelined_state(:getkq)
106
117
  write_noop
107
118
  # Use ensure_ready instead of reset to preserve any data already buffered
108
- # during interleaved pipelined get draining
119
+ # while this get_multi's interleaved requests were sent
109
120
  response_buffer.ensure_ready
110
121
  end
111
122
 
@@ -118,6 +129,8 @@ module Dalli
118
129
  # avoiding intermediate Hash allocation. Returns nil.
119
130
  # Without a block, returns a Hash of { key => [value, cas] }.
120
131
  def pipeline_next_responses(&block)
132
+ return abandon_pipeline if @pipeline_out_of_step
133
+
121
134
  reconnect_on_pipeline_complete!
122
135
  values = nil
123
136
 
@@ -139,6 +152,13 @@ module Dalli
139
152
  # to the noop at the end of the pipeline
140
153
  finish_pipeline && break if status && key.nil?
141
154
 
155
+ # A key that wasn't requested means the replies are out of step
156
+ # (see expect_reply_keys): keep what was read so far, drop the rest
157
+ if unexpected_reply_key?(key)
158
+ abandon_pipeline
159
+ break
160
+ end
161
+
142
162
  # If the status is ok and the key is not nil, then this is a
143
163
  # getkq response with a value that we want to set in the response hash
144
164
  unless key.nil?
@@ -150,6 +170,10 @@ module Dalli
150
170
  end
151
171
  end
152
172
 
173
+ # A request to this server from inside the block closes the
174
+ # connection, and with it the rest of this get_multi's replies
175
+ raise_pipeline_closed unless response_buffer.in_progress?
176
+
153
177
  # Get the next response from the buffer
154
178
  status, cas, key, value = response_buffer.process_single_getk_response
155
179
  end
@@ -159,21 +183,24 @@ module Dalli
159
183
  # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
160
184
 
161
185
  # Abort current pipelined get. Generally used to signal an external
162
- # timeout during pipelined get. The underlying socket is
186
+ # timeout during pipelined get, or that the get_multi stopped before
187
+ # reading all its replies (timed_out: false). The underlying socket is
163
188
  # disconnected, and the exception is swallowed.
164
189
  #
165
190
  # Returns nothing.
166
- def pipeline_abort
191
+ def pipeline_abort(timed_out: true)
167
192
  response_buffer.clear
193
+ @pipeline_out_of_step = false
194
+ @expected_reply_keys = nil
168
195
  @connection_manager.abort_request!
169
196
  return true unless connected?
170
197
 
171
198
  # Closes the connection, which ensures that our connection is in a
172
199
  # clean state for future requests. The get_multi ran out of time
173
- # overall rather than hitting a socket error, so it doesn't count
174
- # toward socket_max_failures: two slow get_multis in a row would
175
- # otherwise mark a healthy server down.
176
- Dalli.logger.warn { "#{name} didn't finish a get_multi within socket_timeout; closing the connection" }
200
+ # overall, or stopped early, rather than hitting a socket error, so it
201
+ # doesn't count toward socket_max_failures: two slow get_multis in a
202
+ # row would otherwise mark a healthy server down.
203
+ log_pipeline_abort(timed_out)
177
204
  @connection_manager.close
178
205
  true
179
206
  end
@@ -205,6 +232,18 @@ module Dalli
205
232
  ALLOWED_QUIET_OPS = %i[add replace set delete incr decr append prepend flush noop].freeze
206
233
  private_constant :ALLOWED_QUIET_OPS
207
234
 
235
+ # Reads the replies still pending from quiet requests before any
236
+ # non-quiet request, which reads a reply of its own. A quiet block reads
237
+ # them at its end, but the connection is shared: another thread or fiber
238
+ # (quiet? is fiber-local) can make a request while the block is still
239
+ # open, and would otherwise read the block's replies as its own. The
240
+ # noop also sends any quiet requests still buffered.
241
+ def drain_pending_quiet_responses(opkey)
242
+ return unless @connection_manager.quiet_responses_pending? && opkey != :noop && !quiet?
243
+
244
+ noop
245
+ end
246
+
208
247
  def verify_allowed_quiet!(opkey)
209
248
  return if ALLOWED_QUIET_OPS.include?(opkey)
210
249
 
@@ -265,6 +304,7 @@ module Dalli
265
304
  # Use clear (not reset) to keep pipeline_complete? = true, which is
266
305
  # the expected state before pipeline_response_setup is called.
267
306
  response_buffer.clear
307
+ expect_reply_keys(keys)
268
308
 
269
309
  req = +''
270
310
  keys.each do |key|
@@ -278,8 +318,10 @@ module Dalli
278
318
  # This prevents socket buffer deadlock when sending many keys.
279
319
  # Populates the provided results hash with any responses drained during send.
280
320
  def pipelined_get_interleaved(keys, chunk_size, results)
281
- # Initialize the response buffer for draining during send phase
282
- response_buffer.ensure_ready
321
+ # Start with an empty buffer for draining during the send phase. Bytes
322
+ # left by an earlier get_multi that stopped early belong to its replies.
323
+ response_buffer.reset
324
+ expect_reply_keys(keys)
283
325
 
284
326
  keys.each_slice(chunk_size) do |chunk|
285
327
  # Build and write this chunk of requests
@@ -312,6 +354,12 @@ module Dalli
312
354
  status, cas, key, value = response_buffer.process_single_getk_response
313
355
  break if status.nil? # No complete response available
314
356
 
357
+ # Handled by the next pipeline_next_responses, once sending is done
358
+ if unexpected_reply_key?(key)
359
+ @pipeline_out_of_step = true
360
+ break
361
+ end
362
+
315
363
  results[key] = [value, cas] unless key.nil?
316
364
  end
317
365
  rescue SystemCallError, Dalli::NetworkError
@@ -319,8 +367,48 @@ module Dalli
319
367
  nil
320
368
  end
321
369
 
370
+ # Registered with the connection manager, which clears it whenever the
371
+ # connection closes, so a new connection never parses an old one's bytes
322
372
  def response_buffer
323
- @response_buffer ||= ResponseBuffer.new(@connection_manager, response_processor)
373
+ @response_buffer ||= ResponseBuffer.new(@connection_manager, response_processor).tap do |buffer|
374
+ @connection_manager.response_buffer = buffer
375
+ end
376
+ end
377
+
378
+ # A multi-get only accepts replies for the keys it asked for. memcached
379
+ # names an item created by auto-create (ma or mg with N) for a
380
+ # base64-encoded key by its raw bytes, without the b flag; such a key
381
+ # can contain spaces or CR/LF, which split the reply header and make the
382
+ # replies after it parse as different ones. A key that wasn't requested
383
+ # is how that shows up.
384
+ # Only with the verify_reply_keys option, since building the set costs a
385
+ # multi-get about 15%. Dalli itself no longer creates such items (see
386
+ # Meta#decr_incr); the check guards against ones that older versions or
387
+ # other clients created, on memcached versions with the behavior.
388
+ def expect_reply_keys(keys)
389
+ @pipeline_out_of_step = false
390
+ @expected_reply_keys = (keys.to_set { |k| reply_key_form(k) } if @verify_reply_keys)
391
+ end
392
+
393
+ def unexpected_reply_key?(key)
394
+ !key.nil? && @expected_reply_keys && !@expected_reply_keys.include?(reply_key_form(key))
395
+ end
396
+
397
+ # Keys compared as bytes; ASCII keys compare equal in any encoding as is
398
+ def reply_key_form(key)
399
+ key.ascii_only? ? key : key.b
400
+ end
401
+
402
+ # Keeps what was read, drops the rest of this server's replies, and
403
+ # closes the connection so nothing unread is left on it. Not a socket
404
+ # failure, so it doesn't count toward socket_max_failures; the keys not
405
+ # read are simply missing from the result.
406
+ def abandon_pipeline
407
+ Dalli.logger.warn { "#{name} replied to a get_multi with a key that wasn't requested; closing the connection" }
408
+ @pipeline_out_of_step = false
409
+ response_buffer.clear
410
+ @connection_manager.close
411
+ {}
324
412
  end
325
413
 
326
414
  # Called after the noop response is received at the end of a set
@@ -336,7 +424,23 @@ module Dalli
336
424
  @connection_manager.reconnect! 'pipelined get has completed' if pipeline_complete?
337
425
  end
338
426
 
427
+ def raise_pipeline_closed
428
+ raise Dalli::DalliError, "The connection to #{name} closed while a get_multi was reading its replies " \
429
+ '(a request made from inside the get_multi block?)'
430
+ end
431
+
432
+ def log_pipeline_abort(timed_out)
433
+ if timed_out
434
+ Dalli.logger.warn { "#{name} didn't finish a get_multi within socket_timeout; closing the connection" }
435
+ else
436
+ Dalli.logger.debug { "#{name} get_multi stopped before reading all replies; closing the connection" }
437
+ end
438
+ end
439
+
440
+ # The single-server set_multi path passes its whole pairs hash as the
441
+ # first argument; log only its keys, never the values
339
442
  def log_marshal_err(key, err)
443
+ key = key.keys.join("', '") if key.is_a?(Hash)
340
444
  Dalli.logger.error "Marshalling error for key '#{key}': #{err.message}"
341
445
  Dalli.logger.error 'You are trying to cache a Ruby object which cannot be serialized to memcached.'
342
446
  end
@@ -26,6 +26,9 @@ module Dalli
26
26
 
27
27
  attr_accessor :hostname, :port, :socket_type, :options
28
28
  attr_reader :sock
29
+ # The buffer replies are read into (see Base#response_buffer). It's
30
+ # cleared with the write buffer whenever the connection closes.
31
+ attr_writer :response_buffer
29
32
 
30
33
  def initialize(hostname, port, socket_type, client_options)
31
34
  @hostname = hostname
@@ -33,10 +36,12 @@ module Dalli
33
36
  @socket_type = socket_type
34
37
  @options = DEFAULTS.merge(client_options)
35
38
  @request_in_progress = false
39
+ @quiet_responses_pending = false
36
40
  @sock = nil
37
41
  @pid = nil
38
42
  @write_buffer = []
39
43
  @write_buffer_bytes = 0
44
+ @response_buffer = nil
40
45
 
41
46
  @fail_count = 0
42
47
  reset_down_info
@@ -58,8 +63,9 @@ module Dalli
58
63
  @sock.sync = true
59
64
  @pid = Process.pid
60
65
  @request_in_progress = false
61
- rescue SystemCallError, *TIMEOUT_ERRORS, EOFError, SocketError => e
62
- # SocketError = DNS resolution failure
66
+ @quiet_responses_pending = false
67
+ rescue SystemCallError, *TIMEOUT_ERRORS, *SSL_ERRORS, EOFError, SocketError => e
68
+ # SocketError = DNS resolution failure; SSL_ERRORS = failed TLS handshake
63
69
  error_on_request!(e)
64
70
  end
65
71
 
@@ -129,7 +135,9 @@ module Dalli
129
135
  # @request_in_progress == true.
130
136
  @sock = nil
131
137
  @pid = nil
138
+ @quiet_responses_pending = false
132
139
  discard_write_buffer
140
+ @response_buffer&.clear
133
141
  abort_request!
134
142
  end
135
143
  end
@@ -145,6 +153,21 @@ module Dalli
145
153
  !@sock.nil?
146
154
  end
147
155
 
156
+ # True when a quiet request was written on this connection and its
157
+ # replies (memcached only suppresses some of them) haven't been
158
+ # consumed by a noop yet.
159
+ def quiet_responses_pending?
160
+ @quiet_responses_pending
161
+ end
162
+
163
+ def mark_quiet_responses_pending!
164
+ @quiet_responses_pending = true
165
+ end
166
+
167
+ def clear_quiet_responses_pending!
168
+ @quiet_responses_pending = false
169
+ end
170
+
148
171
  def request_in_progress?
149
172
  @request_in_progress
150
173
  end
@@ -170,10 +193,22 @@ module Dalli
170
193
  @request_in_progress = false
171
194
  end
172
195
 
196
+ # The longest reply line Dalli reads, in bytes, CRLF included. A meta
197
+ # reply header is at most about 500 bytes: "VA <size>" plus its flags,
198
+ # the largest being a 250-byte key base64-encoded to 336 bytes, a
199
+ # 20-digit CAS, a 32-byte opaque and a few numeric fields. The longest
200
+ # stats line (stats settings) carries a file path such as ext_path, up
201
+ # to PATH_MAX (4096). 8 KiB leaves room for both, while a server that
202
+ # never sends CRLF can't grow the read buffer without bound.
203
+ MAX_LINE_BYTES = 8 * 1024
204
+
173
205
  def read_line
174
206
  flush_write_buffer
175
- data = @sock.gets("\r\n")
207
+ data = @sock.gets("\r\n", MAX_LINE_BYTES)
176
208
  error_on_request!('EOF in read_line') if data.nil?
209
+ # Without its CRLF the line either ran past MAX_LINE_BYTES or was cut
210
+ # short by EOF; either way the connection is out of step
211
+ error_on_request!("Reply line without CRLF in the first #{MAX_LINE_BYTES} bytes") unless data.end_with?("\r\n")
177
212
  data
178
213
  rescue SystemCallError, *TIMEOUT_ERRORS, *SSL_ERRORS, EOFError => e
179
214
  error_on_request!(e)
@@ -193,12 +193,44 @@ module Dalli
193
193
 
194
194
  def decr_incr(incr, key, delta, ttl, initial)
195
195
  ttl = initial ? TtlSanitizer.sanitize(ttl) : nil # Only set a TTL if we want to set a value on miss
196
+ # memcached stores an item created by ma's auto-create (N/J) for a
197
+ # base64-encoded key without its binary-key flag, and later replies
198
+ # name it with the raw key bytes. Create such counters with an add.
199
+ return decr_incr_with_add(incr, key, delta, ttl, initial) if initial && KeyRegularizer.required?(key)
200
+
196
201
  write(RequestFormatter.meta_arithmetic(key: key, delta: delta, initial: initial, incr: incr, ttl: ttl,
197
202
  quiet: quiet?))
198
203
  @connection_manager.flush unless quiet?
199
204
  response_processor.decr_incr unless quiet?
200
205
  end
201
206
 
207
+ # Like decr_incr with an initial value, without memcached's auto-create:
208
+ # on a miss the counter is added with the initial value (which is
209
+ # returned, as auto-create would), and the add losing a race to another
210
+ # client means the counter now exists, so the incr is tried again. In a
211
+ # quiet block both requests are sent and whichever applies takes effect.
212
+ def decr_incr_with_add(incr, key, delta, ttl, initial)
213
+ add_options = { raw: true } # counters are stored raw
214
+ return quiet_decr_incr_with_add(incr, key, delta, ttl, initial, add_options) if quiet?
215
+
216
+ 2.times do
217
+ value = decr_incr(incr, key, delta, nil, nil)
218
+ return value unless value.nil?
219
+
220
+ write_storage_req(:add, key, initial.to_s, ttl, nil, add_options, quiet: false)
221
+ return initial if response_processor.meta_set_with_cas
222
+ end
223
+ decr_incr(incr, key, delta, nil, nil)
224
+ end
225
+
226
+ # rubocop:disable-next Metrics/ParameterLists
227
+ def quiet_decr_incr_with_add(incr, key, delta, ttl, initial, add_options)
228
+ write(RequestFormatter.meta_arithmetic(key: key, delta: delta, initial: nil, incr: incr, ttl: nil,
229
+ quiet: true))
230
+ # Sent with the rest of the quiet block, by its closing noop
231
+ write_storage_req(:add, key, initial.to_s, ttl, nil, add_options, quiet: true)
232
+ end
233
+
202
234
  # Other Commands
203
235
  def flush(delay = 0)
204
236
  write(RequestFormatter.flush(delay: delay))
@@ -210,7 +242,10 @@ module Dalli
210
242
  # We need to read all the responses at once.
211
243
  def noop
212
244
  write_noop
213
- response_processor.consume_all_responses_until_mn
245
+ result = response_processor.consume_all_responses_until_mn
246
+ # Everything up to and including the MN has been read
247
+ @connection_manager.clear_quiet_responses_pending!
248
+ result
214
249
  end
215
250
 
216
251
  def stats(info = nil)
@@ -240,10 +275,11 @@ module Dalli
240
275
  buffer = RequestFormatter.multi_meta_get(keys, skip_flags: is_raw)
241
276
  flushed_write(buffer)
242
277
  buffer.clear
243
- read_multi_get_responses(is_raw)
278
+ read_multi_get_responses(is_raw, keys)
244
279
  end
245
280
 
246
- def read_multi_get_responses(is_raw)
281
+ def read_multi_get_responses(is_raw, keys)
282
+ expect_reply_keys(keys)
247
283
  hash = {}
248
284
  key_index = is_raw ? 2 : 3
249
285
  while (line = @connection_manager.read_line)
@@ -251,11 +287,19 @@ module Dalli
251
287
  next unless line.start_with?('VA ')
252
288
 
253
289
  key, value = parse_multi_get_value(line, key_index, is_raw)
290
+ raise_unexpected_reply_key(key) if unexpected_reply_key?(key)
254
291
  hash[key] = value if key
255
292
  end
256
293
  hash
257
294
  end
258
295
 
296
+ # The replies after a key that wasn't requested can't be trusted (see
297
+ # Base#expect_reply_keys). Raising ends the request, which closes the
298
+ # connection; the caller treats this server's keys as missing.
299
+ def raise_unexpected_reply_key(key)
300
+ raise Dalli::UnexpectedReplyKeyError, "#{name} replied with a key that wasn't requested: #{key.inspect}"
301
+ end
302
+
259
303
  def parse_multi_get_value(line, key_index, is_raw)
260
304
  tokens = line.chomp!(TERMINATOR).split
261
305
  size = tokens[1].to_i
@@ -272,16 +316,27 @@ module Dalli
272
316
 
273
317
  # Single-server fast path for set_multi. Inlines request formatting to
274
318
  # minimize per-key overhead. Avoids PipelinedSetter server grouping.
319
+ #
320
+ # A value that can't be marshalled or is over value_max_bytes is skipped;
321
+ # the other keys are still stored, then the first such error is raised
322
+ # (as PipelinedSetter does on the multi-server path).
275
323
  def write_multi_req(pairs, ttl, req_options)
276
324
  ttl = TtlSanitizer.sanitize(ttl) if ttl
277
- entries = pairs.map do |key, raw_value|
325
+ value_error = nil
326
+ entries = pairs.filter_map do |key, raw_value|
278
327
  [key, @value_marshaller.store(key, raw_value, req_options)]
328
+ rescue Dalli::MarshalError, Dalli::ValueOverMaxSize => e
329
+ value_error ||= e
330
+ nil
279
331
  end
280
332
 
281
- buffer = RequestFormatter.multi_meta_set(entries, ttl: ttl)
282
- flushed_write(buffer)
283
- buffer.clear
284
- response_processor.consume_all_responses_until_mn
333
+ unless entries.empty?
334
+ buffer = RequestFormatter.multi_meta_set(entries, ttl: ttl)
335
+ flushed_write(buffer)
336
+ buffer.clear
337
+ response_processor.consume_all_responses_until_mn
338
+ end
339
+ raise value_error if value_error
285
340
  end
286
341
 
287
342
  # Single-server fast path for delete_multi. Writes all quiet delete requests
@@ -84,11 +84,13 @@ module Dalli
84
84
  end
85
85
 
86
86
  # Checks whether we should apply compression when serializing a value
87
- # based on the specified options. Returns false unless the value
88
- # is greater than the minimum compression size. Otherwise returns
89
- # based on a method-level option if specified, falling back to the
90
- # server default.
87
+ # based on the specified options. Returns false for a raw request
88
+ # (raw reads ignore bitflags, so the value must be stored as given) or
89
+ # unless the value is greater than the minimum compression size.
90
+ # Otherwise returns based on a method-level option if specified,
91
+ # falling back to the server default.
91
92
  def compress_value?(value, req_options)
93
+ return false if req_options&.dig(:raw)
92
94
  return false unless value.bytesize >= compression_min_size
93
95
  return compress_by_default? unless req_options && !req_options[:compress].nil?
94
96
 
@@ -1,5 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ require 'openssl'
3
4
  require 'timeout'
4
5
 
5
6
  module Dalli
@@ -16,14 +17,11 @@ module Dalli
16
17
  [Timeout::Error]
17
18
  end
18
19
 
19
- # SSL errors that occur during read/write operations (not during initial
20
- # handshake) should trigger reconnection. These indicate transient network
21
- # issues, not configuration problems.
22
- SSL_ERRORS =
23
- if defined?(OpenSSL::SSL::SSLError)
24
- [OpenSSL::SSL::SSLError]
25
- else
26
- []
27
- end
20
+ # SSL errors during the handshake or during read/write operations count as
21
+ # a failed request: they trigger reconnection and, after
22
+ # socket_max_failures, mark the server down.
23
+ # openssl is required above: this file loads before dalli/socket, so a
24
+ # defined? check here would find OpenSSL missing and leave this empty.
25
+ SSL_ERRORS = [OpenSSL::SSL::SSLError].freeze
28
26
  end
29
27
  end
data/lib/dalli/socket.rb CHANGED
@@ -203,12 +203,41 @@ module Dalli
203
203
  [seconds, microseconds].pack(timeval_pack_format(sock))
204
204
  end
205
205
 
206
+ # Closes the TCP socket if the handshake fails or times out, so a failed
207
+ # attempt doesn't hold a file descriptor until GC.
206
208
  def self.wrapping_ssl_socket(tcp_socket, host, ssl_context)
209
+ warn_if_unverified(ssl_context)
210
+ connected = false
207
211
  ssl_socket = Dalli::Socket::SSLSocket.new(tcp_socket, ssl_context)
208
212
  ssl_socket.hostname = host
209
213
  ssl_socket.sync_close = true
210
214
  ssl_socket.connect
215
+ connected = true
211
216
  ssl_socket
217
+ ensure
218
+ tcp_socket.close unless connected
219
+ end
220
+
221
+ # Class variable to track whether the TLS verification warning has been logged
222
+ @@ssl_verification_warning_logged = false # rubocop:disable Style/ClassVars
223
+
224
+ # Verification comes entirely from the caller's ssl_context, and a bare
225
+ # SSLContext.new verifies nothing, so warn (once per process) when the
226
+ # certificate or the hostname won't be checked.
227
+ def self.warn_if_unverified(ssl_context)
228
+ return if @@ssl_verification_warning_logged
229
+
230
+ problem = if !ssl_context.verify_mode.to_i.anybits?(::OpenSSL::SSL::VERIFY_PEER)
231
+ 'verify_mode is VERIFY_NONE, so the server certificate is not checked'
232
+ elsif !ssl_context.verify_hostname
233
+ 'verify_hostname is false, so the certificate is not checked against the hostname'
234
+ end
235
+ return unless problem
236
+
237
+ Dalli.logger.warn "SECURITY WARNING: Dalli's ssl_context #{problem}. " \
238
+ 'Use ssl_context.set_params(verify_mode: OpenSSL::SSL::VERIFY_PEER, ' \
239
+ 'verify_hostname: true) to verify the server.'
240
+ @@ssl_verification_warning_logged = true # rubocop:disable Style/ClassVars
212
241
  end
213
242
  end
214
243
 
data/lib/dalli/version.rb CHANGED
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Dalli
4
- VERSION = '5.0.10'
4
+ VERSION = '5.0.12'
5
5
 
6
6
  MIN_SUPPORTED_MEMCACHED_VERSION = '1.6'
7
7
  end
data/lib/dalli.rb CHANGED
@@ -31,6 +31,10 @@ module Dalli
31
31
  # socket/server communication error that can be retried
32
32
  class RetryableNetworkError < NetworkError; end
33
33
 
34
+ # a multi-get reply named a key that wasn't requested, so the rest of that
35
+ # server's replies can't be trusted
36
+ class UnexpectedReplyKeyError < DalliError; end
37
+
34
38
  # Implements the NullObject pattern to store an application-defined value for 'Key not found' responses.
35
39
  class NilObject; end # rubocop:disable Lint/EmptyClass
36
40
  NOT_FOUND = NilObject.new
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: dalli
3
3
  version: !ruby/object:Gem::Version
4
- version: 5.0.10
4
+ version: 5.0.12
5
5
  platform: ruby
6
6
  authors:
7
7
  - Peter M. Goldstein
@@ -88,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
88
88
  - !ruby/object:Gem::Version
89
89
  version: '0'
90
90
  requirements: []
91
- rubygems_version: 4.0.21
91
+ rubygems_version: 4.0.23
92
92
  specification_version: 4
93
93
  summary: High performance memcached client for Ruby
94
94
  test_files: []