mongo 2.12.4 → 2.14.0.rc1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (900) hide show
  1. checksums.yaml +4 -4
  2. checksums.yaml.gz.sig +0 -0
  3. data.tar.gz.sig +0 -0
  4. data/CONTRIBUTING.md +8 -36
  5. data/LICENSE +1 -1
  6. data/README.md +54 -54
  7. data/Rakefile +16 -10
  8. data/lib/mongo.rb +17 -3
  9. data/lib/mongo/active_support.rb +1 -1
  10. data/lib/mongo/address.rb +40 -13
  11. data/lib/mongo/address/ipv4.rb +32 -5
  12. data/lib/mongo/address/ipv6.rb +32 -5
  13. data/lib/mongo/address/unix.rb +3 -3
  14. data/lib/mongo/address/validator.rb +1 -1
  15. data/lib/mongo/auth.rb +36 -13
  16. data/lib/mongo/auth/aws.rb +37 -0
  17. data/lib/mongo/auth/aws/conversation.rb +128 -0
  18. data/lib/mongo/auth/aws/credentials_retriever.rb +219 -0
  19. data/lib/mongo/auth/aws/request.rb +283 -0
  20. data/lib/mongo/auth/base.rb +129 -0
  21. data/lib/mongo/auth/conversation_base.rb +52 -0
  22. data/lib/mongo/auth/cr.rb +9 -36
  23. data/lib/mongo/auth/cr/conversation.rb +24 -69
  24. data/lib/mongo/auth/credential_cache.rb +1 -1
  25. data/lib/mongo/auth/gssapi.rb +38 -0
  26. data/lib/mongo/auth/gssapi/conversation.rb +108 -0
  27. data/lib/mongo/auth/ldap.rb +9 -34
  28. data/lib/mongo/auth/ldap/conversation.rb +3 -43
  29. data/lib/mongo/auth/roles.rb +1 -1
  30. data/lib/mongo/auth/sasl_conversation_base.rb +111 -0
  31. data/lib/mongo/auth/scram.rb +39 -51
  32. data/lib/mongo/auth/scram/conversation.rb +12 -506
  33. data/lib/mongo/auth/scram256.rb +31 -0
  34. data/lib/mongo/auth/scram256/conversation.rb +63 -0
  35. data/lib/mongo/auth/scram_conversation_base.rb +402 -0
  36. data/lib/mongo/auth/stringprep.rb +5 -4
  37. data/lib/mongo/auth/stringprep/profiles/sasl.rb +2 -1
  38. data/lib/mongo/auth/stringprep/tables.rb +2 -1
  39. data/lib/mongo/auth/stringprep/unicode_normalize/normalize.rb +1 -0
  40. data/lib/mongo/auth/stringprep/unicode_normalize/tables.rb +1 -0
  41. data/lib/mongo/auth/user.rb +2 -2
  42. data/lib/mongo/auth/user/view.rb +1 -1
  43. data/lib/mongo/auth/x509.rb +14 -32
  44. data/lib/mongo/auth/x509/conversation.rb +15 -42
  45. data/lib/mongo/background_thread.rb +11 -2
  46. data/lib/mongo/bson.rb +1 -1
  47. data/lib/mongo/bulk_write.rb +79 -26
  48. data/lib/mongo/bulk_write/combineable.rb +20 -8
  49. data/lib/mongo/bulk_write/ordered_combiner.rb +1 -1
  50. data/lib/mongo/bulk_write/result.rb +1 -1
  51. data/lib/mongo/bulk_write/result_combiner.rb +1 -1
  52. data/lib/mongo/bulk_write/transformable.rb +9 -10
  53. data/lib/mongo/bulk_write/unordered_combiner.rb +1 -1
  54. data/lib/mongo/bulk_write/validatable.rb +5 -1
  55. data/lib/mongo/caching_cursor.rb +74 -0
  56. data/lib/mongo/client.rb +261 -39
  57. data/lib/mongo/client_encryption.rb +1 -1
  58. data/lib/mongo/cluster.rb +180 -72
  59. data/lib/mongo/cluster/periodic_executor.rb +1 -1
  60. data/lib/mongo/cluster/reapers/cursor_reaper.rb +1 -1
  61. data/lib/mongo/cluster/reapers/socket_reaper.rb +1 -1
  62. data/lib/mongo/cluster/sdam_flow.rb +36 -17
  63. data/lib/mongo/cluster/topology.rb +19 -2
  64. data/lib/mongo/cluster/topology/base.rb +1 -1
  65. data/lib/mongo/cluster/topology/no_replica_set_options.rb +1 -1
  66. data/lib/mongo/cluster/topology/replica_set_no_primary.rb +4 -3
  67. data/lib/mongo/cluster/topology/replica_set_with_primary.rb +1 -1
  68. data/lib/mongo/cluster/topology/sharded.rb +2 -2
  69. data/lib/mongo/cluster/topology/single.rb +3 -3
  70. data/lib/mongo/cluster/topology/unknown.rb +1 -1
  71. data/lib/mongo/cluster_time.rb +1 -1
  72. data/lib/mongo/collection.rb +77 -24
  73. data/lib/mongo/collection/view.rb +30 -22
  74. data/lib/mongo/collection/view/aggregation.rb +31 -7
  75. data/lib/mongo/collection/view/builder.rb +1 -1
  76. data/lib/mongo/collection/view/builder/aggregation.rb +1 -1
  77. data/lib/mongo/collection/view/builder/find_command.rb +47 -19
  78. data/lib/mongo/collection/view/builder/flags.rb +1 -1
  79. data/lib/mongo/collection/view/builder/map_reduce.rb +1 -1
  80. data/lib/mongo/collection/view/builder/modifiers.rb +1 -1
  81. data/lib/mongo/collection/view/builder/op_query.rb +1 -1
  82. data/lib/mongo/collection/view/change_stream.rb +3 -6
  83. data/lib/mongo/collection/view/change_stream/retryable.rb +1 -1
  84. data/lib/mongo/collection/view/explainable.rb +28 -9
  85. data/lib/mongo/collection/view/immutable.rb +1 -1
  86. data/lib/mongo/collection/view/iterable.rb +80 -14
  87. data/lib/mongo/collection/view/map_reduce.rb +7 -4
  88. data/lib/mongo/collection/view/readable.rb +22 -4
  89. data/lib/mongo/collection/view/writable.rb +107 -13
  90. data/lib/mongo/crypt.rb +1 -1
  91. data/lib/mongo/crypt/auto_decryption_context.rb +1 -1
  92. data/lib/mongo/crypt/auto_encrypter.rb +1 -1
  93. data/lib/mongo/crypt/auto_encryption_context.rb +1 -1
  94. data/lib/mongo/crypt/binary.rb +1 -1
  95. data/lib/mongo/crypt/binding.rb +1 -1
  96. data/lib/mongo/crypt/context.rb +1 -1
  97. data/lib/mongo/crypt/data_key_context.rb +1 -1
  98. data/lib/mongo/crypt/encryption_io.rb +45 -28
  99. data/lib/mongo/crypt/explicit_decryption_context.rb +1 -1
  100. data/lib/mongo/crypt/explicit_encrypter.rb +1 -1
  101. data/lib/mongo/crypt/explicit_encryption_context.rb +1 -1
  102. data/lib/mongo/crypt/handle.rb +1 -1
  103. data/lib/mongo/crypt/hooks.rb +1 -1
  104. data/lib/mongo/crypt/kms_context.rb +1 -1
  105. data/lib/mongo/crypt/status.rb +1 -1
  106. data/lib/mongo/cursor.rb +4 -3
  107. data/lib/mongo/cursor/builder.rb +1 -1
  108. data/lib/mongo/cursor/builder/get_more_command.rb +1 -1
  109. data/lib/mongo/cursor/builder/kill_cursors_command.rb +1 -1
  110. data/lib/mongo/cursor/builder/op_get_more.rb +1 -1
  111. data/lib/mongo/cursor/builder/op_kill_cursors.rb +1 -1
  112. data/lib/mongo/database.rb +41 -5
  113. data/lib/mongo/database/view.rb +21 -6
  114. data/lib/mongo/dbref.rb +1 -1
  115. data/lib/mongo/distinguishing_semaphore.rb +55 -0
  116. data/lib/mongo/error.rb +30 -2
  117. data/lib/mongo/error/auth_error.rb +1 -1
  118. data/lib/mongo/error/bulk_write_error.rb +1 -1
  119. data/lib/mongo/error/change_stream_resumable.rb +1 -1
  120. data/lib/mongo/error/closed_stream.rb +1 -1
  121. data/lib/mongo/error/connection_check_out_timeout.rb +1 -1
  122. data/lib/mongo/error/connection_perished.rb +23 -0
  123. data/lib/mongo/error/credential_check_error.rb +26 -0
  124. data/lib/mongo/error/extra_file_chunk.rb +1 -1
  125. data/lib/mongo/error/file_not_found.rb +1 -1
  126. data/lib/mongo/error/handshake_error.rb +1 -1
  127. data/lib/mongo/error/insufficient_iteration_count.rb +1 -1
  128. data/lib/mongo/error/invalid_address.rb +1 -1
  129. data/lib/mongo/error/invalid_application_name.rb +1 -1
  130. data/lib/mongo/error/invalid_bulk_operation.rb +1 -1
  131. data/lib/mongo/error/invalid_bulk_operation_type.rb +1 -1
  132. data/lib/mongo/error/invalid_collection_name.rb +1 -1
  133. data/lib/mongo/error/invalid_cursor_operation.rb +1 -1
  134. data/lib/mongo/error/invalid_database_name.rb +1 -1
  135. data/lib/mongo/error/invalid_document.rb +1 -1
  136. data/lib/mongo/error/invalid_file.rb +1 -1
  137. data/lib/mongo/error/invalid_file_revision.rb +1 -1
  138. data/lib/mongo/error/invalid_min_pool_size.rb +1 -1
  139. data/lib/mongo/error/invalid_nonce.rb +2 -2
  140. data/lib/mongo/error/invalid_read_concern.rb +28 -0
  141. data/lib/mongo/error/invalid_read_option.rb +1 -1
  142. data/lib/mongo/error/invalid_replacement_document.rb +1 -1
  143. data/lib/mongo/error/invalid_server_auth_host.rb +22 -0
  144. data/lib/mongo/error/invalid_server_auth_response.rb +23 -0
  145. data/lib/mongo/error/invalid_server_preference.rb +6 -1
  146. data/lib/mongo/error/invalid_session.rb +3 -2
  147. data/lib/mongo/error/invalid_signature.rb +1 -1
  148. data/lib/mongo/error/invalid_transaction_operation.rb +1 -1
  149. data/lib/mongo/error/invalid_txt_record.rb +1 -1
  150. data/lib/mongo/error/invalid_update_document.rb +1 -1
  151. data/lib/mongo/error/invalid_uri.rb +1 -1
  152. data/lib/mongo/error/invalid_write_concern.rb +1 -1
  153. data/lib/mongo/error/lint_error.rb +1 -1
  154. data/lib/mongo/error/max_bson_size.rb +1 -1
  155. data/lib/mongo/error/max_message_size.rb +1 -1
  156. data/lib/mongo/error/mismatched_domain.rb +1 -1
  157. data/lib/mongo/error/missing_file_chunk.rb +1 -1
  158. data/lib/mongo/error/missing_password.rb +1 -1
  159. data/lib/mongo/error/missing_resume_token.rb +1 -1
  160. data/lib/mongo/error/missing_scram_server_signature.rb +27 -0
  161. data/lib/mongo/error/multi_index_drop.rb +1 -1
  162. data/lib/mongo/error/need_primary_server.rb +1 -1
  163. data/lib/mongo/error/no_server_available.rb +1 -1
  164. data/lib/mongo/error/no_srv_records.rb +1 -1
  165. data/lib/mongo/error/notable.rb +18 -3
  166. data/lib/mongo/error/operation_failure.rb +63 -44
  167. data/lib/mongo/error/parser.rb +16 -5
  168. data/lib/mongo/error/pool_closed_error.rb +1 -1
  169. data/lib/mongo/error/raise_original_error.rb +29 -0
  170. data/lib/mongo/error/server_certificate_revoked.rb +22 -0
  171. data/lib/mongo/error/session_ended.rb +1 -1
  172. data/lib/mongo/error/sessions_not_supported.rb +35 -0
  173. data/lib/mongo/error/socket_error.rb +1 -1
  174. data/lib/mongo/error/socket_timeout_error.rb +1 -1
  175. data/lib/mongo/error/unchangeable_collection_option.rb +1 -1
  176. data/lib/mongo/error/unexpected_chunk_length.rb +1 -1
  177. data/lib/mongo/error/unexpected_response.rb +1 -1
  178. data/lib/mongo/error/unknown_payload_type.rb +1 -1
  179. data/lib/mongo/error/unsupported_array_filters.rb +7 -2
  180. data/lib/mongo/error/unsupported_collation.rb +7 -2
  181. data/lib/mongo/error/unsupported_features.rb +1 -1
  182. data/lib/mongo/error/unsupported_message_type.rb +1 -1
  183. data/lib/mongo/error/unsupported_option.rb +101 -0
  184. data/lib/mongo/error/write_retryable.rb +1 -1
  185. data/lib/mongo/event.rb +1 -1
  186. data/lib/mongo/event/base.rb +7 -1
  187. data/lib/mongo/event/listeners.rb +1 -1
  188. data/lib/mongo/event/publisher.rb +1 -1
  189. data/lib/mongo/event/subscriber.rb +1 -1
  190. data/lib/mongo/grid.rb +1 -1
  191. data/lib/mongo/grid/file.rb +1 -1
  192. data/lib/mongo/grid/file/chunk.rb +1 -1
  193. data/lib/mongo/grid/file/info.rb +1 -1
  194. data/lib/mongo/grid/fs_bucket.rb +9 -4
  195. data/lib/mongo/grid/stream.rb +1 -1
  196. data/lib/mongo/grid/stream/read.rb +1 -1
  197. data/lib/mongo/grid/stream/write.rb +1 -1
  198. data/lib/mongo/id.rb +1 -1
  199. data/lib/mongo/index.rb +2 -1
  200. data/lib/mongo/index/view.rb +61 -11
  201. data/lib/mongo/lint.rb +11 -0
  202. data/lib/mongo/loggable.rb +1 -1
  203. data/lib/mongo/logger.rb +4 -4
  204. data/lib/mongo/monitoring.rb +39 -1
  205. data/lib/mongo/monitoring/cmap_log_subscriber.rb +1 -1
  206. data/lib/mongo/monitoring/command_log_subscriber.rb +20 -5
  207. data/lib/mongo/monitoring/event.rb +1 -1
  208. data/lib/mongo/monitoring/event/cmap.rb +1 -1
  209. data/lib/mongo/monitoring/event/cmap/base.rb +1 -1
  210. data/lib/mongo/monitoring/event/cmap/connection_check_out_failed.rb +1 -1
  211. data/lib/mongo/monitoring/event/cmap/connection_check_out_started.rb +1 -1
  212. data/lib/mongo/monitoring/event/cmap/connection_checked_in.rb +1 -1
  213. data/lib/mongo/monitoring/event/cmap/connection_checked_out.rb +1 -1
  214. data/lib/mongo/monitoring/event/cmap/connection_closed.rb +1 -1
  215. data/lib/mongo/monitoring/event/cmap/connection_created.rb +1 -1
  216. data/lib/mongo/monitoring/event/cmap/connection_ready.rb +1 -1
  217. data/lib/mongo/monitoring/event/cmap/pool_cleared.rb +1 -1
  218. data/lib/mongo/monitoring/event/cmap/pool_closed.rb +1 -1
  219. data/lib/mongo/monitoring/event/cmap/pool_created.rb +1 -1
  220. data/lib/mongo/monitoring/event/command_failed.rb +12 -1
  221. data/lib/mongo/monitoring/event/command_started.rb +44 -3
  222. data/lib/mongo/monitoring/event/command_succeeded.rb +12 -1
  223. data/lib/mongo/monitoring/event/secure.rb +8 -2
  224. data/lib/mongo/monitoring/event/server_closed.rb +2 -2
  225. data/lib/mongo/monitoring/event/server_description_changed.rb +28 -5
  226. data/lib/mongo/monitoring/event/server_heartbeat_failed.rb +10 -3
  227. data/lib/mongo/monitoring/event/server_heartbeat_started.rb +10 -3
  228. data/lib/mongo/monitoring/event/server_heartbeat_succeeded.rb +10 -3
  229. data/lib/mongo/monitoring/event/server_opening.rb +2 -2
  230. data/lib/mongo/monitoring/event/topology_changed.rb +2 -2
  231. data/lib/mongo/monitoring/event/topology_closed.rb +2 -2
  232. data/lib/mongo/monitoring/event/topology_opening.rb +2 -2
  233. data/lib/mongo/monitoring/publishable.rb +9 -9
  234. data/lib/mongo/monitoring/sdam_log_subscriber.rb +1 -1
  235. data/lib/mongo/monitoring/server_closed_log_subscriber.rb +1 -1
  236. data/lib/mongo/monitoring/server_description_changed_log_subscriber.rb +10 -2
  237. data/lib/mongo/monitoring/server_opening_log_subscriber.rb +1 -1
  238. data/lib/mongo/monitoring/topology_changed_log_subscriber.rb +2 -2
  239. data/lib/mongo/monitoring/topology_closed_log_subscriber.rb +1 -1
  240. data/lib/mongo/monitoring/topology_opening_log_subscriber.rb +1 -1
  241. data/lib/mongo/monitoring/unified_sdam_log_subscriber.rb +1 -1
  242. data/lib/mongo/operation.rb +3 -0
  243. data/lib/mongo/operation/aggregate.rb +1 -1
  244. data/lib/mongo/operation/aggregate/command.rb +5 -5
  245. data/lib/mongo/operation/aggregate/op_msg.rb +1 -1
  246. data/lib/mongo/operation/aggregate/result.rb +10 -9
  247. data/lib/mongo/operation/collections_info.rb +3 -36
  248. data/lib/mongo/operation/collections_info/command.rb +40 -0
  249. data/lib/mongo/operation/collections_info/result.rb +3 -1
  250. data/lib/mongo/operation/command.rb +1 -1
  251. data/lib/mongo/operation/command/command.rb +3 -3
  252. data/lib/mongo/operation/command/op_msg.rb +1 -1
  253. data/lib/mongo/operation/count.rb +1 -1
  254. data/lib/mongo/operation/count/command.rb +3 -3
  255. data/lib/mongo/operation/count/op_msg.rb +1 -1
  256. data/lib/mongo/operation/create.rb +1 -1
  257. data/lib/mongo/operation/create/command.rb +3 -3
  258. data/lib/mongo/operation/create/op_msg.rb +1 -1
  259. data/lib/mongo/operation/create_index.rb +1 -1
  260. data/lib/mongo/operation/create_index/command.rb +4 -4
  261. data/lib/mongo/operation/create_index/op_msg.rb +6 -3
  262. data/lib/mongo/operation/create_user.rb +1 -1
  263. data/lib/mongo/operation/create_user/command.rb +4 -4
  264. data/lib/mongo/operation/create_user/op_msg.rb +2 -2
  265. data/lib/mongo/operation/delete.rb +1 -1
  266. data/lib/mongo/operation/delete/bulk_result.rb +3 -1
  267. data/lib/mongo/operation/delete/command.rb +4 -4
  268. data/lib/mongo/operation/delete/legacy.rb +2 -2
  269. data/lib/mongo/operation/delete/op_msg.rb +4 -4
  270. data/lib/mongo/operation/delete/result.rb +5 -2
  271. data/lib/mongo/operation/distinct.rb +1 -1
  272. data/lib/mongo/operation/distinct/command.rb +3 -3
  273. data/lib/mongo/operation/distinct/op_msg.rb +1 -1
  274. data/lib/mongo/operation/drop.rb +1 -1
  275. data/lib/mongo/operation/drop/command.rb +3 -3
  276. data/lib/mongo/operation/drop/op_msg.rb +1 -1
  277. data/lib/mongo/operation/drop_database.rb +1 -1
  278. data/lib/mongo/operation/drop_database/command.rb +3 -3
  279. data/lib/mongo/operation/drop_database/op_msg.rb +1 -1
  280. data/lib/mongo/operation/drop_index.rb +1 -1
  281. data/lib/mongo/operation/drop_index/command.rb +4 -4
  282. data/lib/mongo/operation/drop_index/op_msg.rb +2 -2
  283. data/lib/mongo/operation/explain.rb +1 -1
  284. data/lib/mongo/operation/explain/command.rb +7 -3
  285. data/lib/mongo/operation/explain/legacy.rb +7 -3
  286. data/lib/mongo/operation/explain/op_msg.rb +7 -1
  287. data/lib/mongo/operation/explain/result.rb +4 -1
  288. data/lib/mongo/operation/find.rb +1 -1
  289. data/lib/mongo/operation/find/command.rb +3 -3
  290. data/lib/mongo/operation/find/legacy.rb +3 -3
  291. data/lib/mongo/operation/find/legacy/result.rb +3 -1
  292. data/lib/mongo/operation/find/op_msg.rb +2 -12
  293. data/lib/mongo/operation/find/result.rb +4 -1
  294. data/lib/mongo/operation/get_more.rb +1 -1
  295. data/lib/mongo/operation/get_more/command.rb +3 -3
  296. data/lib/mongo/operation/get_more/legacy.rb +2 -2
  297. data/lib/mongo/operation/get_more/op_msg.rb +2 -12
  298. data/lib/mongo/operation/get_more/result.rb +4 -1
  299. data/lib/mongo/operation/indexes.rb +1 -1
  300. data/lib/mongo/operation/indexes/command.rb +3 -3
  301. data/lib/mongo/operation/indexes/legacy.rb +4 -4
  302. data/lib/mongo/operation/indexes/op_msg.rb +1 -1
  303. data/lib/mongo/operation/indexes/result.rb +6 -1
  304. data/lib/mongo/operation/insert.rb +3 -2
  305. data/lib/mongo/operation/insert/bulk_result.rb +11 -2
  306. data/lib/mongo/operation/insert/command.rb +7 -7
  307. data/lib/mongo/operation/insert/legacy.rb +9 -5
  308. data/lib/mongo/operation/insert/op_msg.rb +6 -6
  309. data/lib/mongo/operation/insert/result.rb +12 -4
  310. data/lib/mongo/operation/kill_cursors.rb +1 -1
  311. data/lib/mongo/operation/kill_cursors/command.rb +3 -3
  312. data/lib/mongo/operation/kill_cursors/legacy.rb +2 -2
  313. data/lib/mongo/operation/kill_cursors/op_msg.rb +1 -1
  314. data/lib/mongo/operation/list_collections.rb +1 -1
  315. data/lib/mongo/operation/list_collections/command.rb +4 -4
  316. data/lib/mongo/operation/list_collections/op_msg.rb +2 -2
  317. data/lib/mongo/operation/list_collections/result.rb +6 -1
  318. data/lib/mongo/operation/map_reduce.rb +1 -1
  319. data/lib/mongo/operation/map_reduce/command.rb +3 -3
  320. data/lib/mongo/operation/map_reduce/op_msg.rb +1 -1
  321. data/lib/mongo/operation/map_reduce/result.rb +11 -1
  322. data/lib/mongo/operation/op_msg_base.rb +3 -3
  323. data/lib/mongo/operation/parallel_scan.rb +1 -1
  324. data/lib/mongo/operation/parallel_scan/command.rb +5 -5
  325. data/lib/mongo/operation/parallel_scan/op_msg.rb +2 -2
  326. data/lib/mongo/operation/parallel_scan/result.rb +5 -1
  327. data/lib/mongo/operation/remove_user.rb +1 -1
  328. data/lib/mongo/operation/remove_user/command.rb +4 -4
  329. data/lib/mongo/operation/remove_user/op_msg.rb +2 -2
  330. data/lib/mongo/operation/result.rb +63 -10
  331. data/lib/mongo/operation/shared/bypass_document_validation.rb +11 -4
  332. data/lib/mongo/operation/shared/causal_consistency_supported.rb +4 -3
  333. data/lib/mongo/operation/shared/collections_info_or_list_collections.rb +58 -0
  334. data/lib/mongo/operation/shared/executable.rb +47 -28
  335. data/lib/mongo/operation/shared/executable_no_validate.rb +3 -3
  336. data/lib/mongo/operation/shared/executable_transaction_label.rb +1 -1
  337. data/lib/mongo/operation/shared/idable.rb +3 -2
  338. data/lib/mongo/operation/shared/limited.rb +11 -2
  339. data/lib/mongo/operation/shared/object_id_generator.rb +2 -1
  340. data/lib/mongo/operation/shared/op_msg_or_command.rb +7 -5
  341. data/lib/mongo/operation/shared/op_msg_or_find_command.rb +8 -6
  342. data/lib/mongo/operation/shared/op_msg_or_list_indexes_command.rb +8 -6
  343. data/lib/mongo/operation/shared/polymorphic_lookup.rb +1 -1
  344. data/lib/mongo/operation/shared/polymorphic_result.rb +1 -1
  345. data/lib/mongo/operation/shared/read_preference_supported.rb +19 -16
  346. data/lib/mongo/operation/shared/response_handling.rb +83 -8
  347. data/lib/mongo/operation/shared/result/aggregatable.rb +2 -1
  348. data/lib/mongo/operation/shared/result/use_legacy_error_parser.rb +1 -1
  349. data/lib/mongo/operation/shared/sessions_supported.rb +51 -27
  350. data/lib/mongo/operation/shared/specifiable.rb +33 -20
  351. data/lib/mongo/operation/shared/write.rb +26 -19
  352. data/lib/mongo/operation/shared/write_concern_supported.rb +7 -6
  353. data/lib/mongo/operation/update.rb +1 -1
  354. data/lib/mongo/operation/update/bulk_result.rb +1 -1
  355. data/lib/mongo/operation/update/command.rb +4 -4
  356. data/lib/mongo/operation/update/legacy.rb +2 -2
  357. data/lib/mongo/operation/update/legacy/result.rb +8 -1
  358. data/lib/mongo/operation/update/op_msg.rb +4 -4
  359. data/lib/mongo/operation/update/result.rb +10 -2
  360. data/lib/mongo/operation/update_user.rb +1 -1
  361. data/lib/mongo/operation/update_user/command.rb +4 -4
  362. data/lib/mongo/operation/update_user/op_msg.rb +2 -2
  363. data/lib/mongo/operation/users_info.rb +1 -1
  364. data/lib/mongo/operation/users_info/command.rb +4 -4
  365. data/lib/mongo/operation/users_info/op_msg.rb +2 -2
  366. data/lib/mongo/operation/users_info/result.rb +4 -1
  367. data/lib/mongo/options.rb +1 -1
  368. data/lib/mongo/options/mapper.rb +1 -1
  369. data/lib/mongo/options/redacted.rb +1 -1
  370. data/lib/mongo/protocol/bit_vector.rb +1 -1
  371. data/lib/mongo/protocol/compressed.rb +1 -1
  372. data/lib/mongo/protocol/delete.rb +1 -1
  373. data/lib/mongo/protocol/get_more.rb +1 -1
  374. data/lib/mongo/protocol/insert.rb +1 -1
  375. data/lib/mongo/protocol/kill_cursors.rb +1 -1
  376. data/lib/mongo/protocol/message.rb +35 -7
  377. data/lib/mongo/protocol/msg.rb +18 -4
  378. data/lib/mongo/protocol/query.rb +1 -1
  379. data/lib/mongo/protocol/registry.rb +1 -1
  380. data/lib/mongo/protocol/reply.rb +1 -1
  381. data/lib/mongo/protocol/serializers.rb +1 -1
  382. data/lib/mongo/protocol/update.rb +1 -1
  383. data/lib/mongo/query_cache.rb +242 -0
  384. data/lib/mongo/retryable.rb +31 -11
  385. data/lib/mongo/semaphore.rb +1 -1
  386. data/lib/mongo/server.rb +45 -9
  387. data/lib/mongo/server/app_metadata.rb +44 -7
  388. data/lib/mongo/server/connection.rb +37 -133
  389. data/lib/mongo/server/connection_base.rb +22 -7
  390. data/lib/mongo/server/connection_common.rb +75 -1
  391. data/lib/mongo/server/connection_pool.rb +23 -1
  392. data/lib/mongo/server/connection_pool/populator.rb +1 -1
  393. data/lib/mongo/server/context.rb +1 -1
  394. data/lib/mongo/server/description.rb +49 -2
  395. data/lib/mongo/server/description/features.rb +12 -3
  396. data/lib/mongo/server/monitor.rb +145 -69
  397. data/lib/mongo/server/monitor/app_metadata.rb +1 -1
  398. data/lib/mongo/server/monitor/connection.rb +110 -80
  399. data/lib/mongo/server/pending_connection.rb +215 -3
  400. data/lib/mongo/server/push_monitor.rb +173 -0
  401. data/{spec/runners/transactions/context.rb → lib/mongo/server/push_monitor/connection.rb} +9 -14
  402. data/lib/mongo/server/round_trip_time_averager.rb +12 -3
  403. data/lib/mongo/server_selector.rb +2 -2
  404. data/lib/mongo/server_selector/{selectable.rb → base.rb} +164 -87
  405. data/lib/mongo/server_selector/nearest.rb +26 -21
  406. data/lib/mongo/server_selector/primary.rb +24 -28
  407. data/lib/mongo/server_selector/primary_preferred.rb +32 -25
  408. data/lib/mongo/server_selector/secondary.rb +26 -21
  409. data/lib/mongo/server_selector/secondary_preferred.rb +29 -34
  410. data/lib/mongo/session.rb +17 -1
  411. data/lib/mongo/session/server_session.rb +1 -1
  412. data/lib/mongo/session/session_pool.rb +1 -1
  413. data/lib/mongo/socket.rb +127 -45
  414. data/lib/mongo/socket/ocsp_cache.rb +97 -0
  415. data/lib/mongo/socket/ocsp_verifier.rb +368 -0
  416. data/lib/mongo/socket/ssl.rb +141 -57
  417. data/lib/mongo/socket/tcp.rb +39 -31
  418. data/lib/mongo/socket/unix.rb +14 -6
  419. data/lib/mongo/srv.rb +1 -1
  420. data/lib/mongo/srv/monitor.rb +8 -14
  421. data/lib/mongo/srv/resolver.rb +15 -11
  422. data/lib/mongo/srv/result.rb +1 -1
  423. data/lib/mongo/timeout.rb +11 -9
  424. data/lib/mongo/topology_version.rb +89 -0
  425. data/lib/mongo/uri.rb +52 -407
  426. data/lib/mongo/uri/options_mapper.rb +582 -0
  427. data/lib/mongo/uri/srv_protocol.rb +12 -3
  428. data/lib/mongo/utils.rb +73 -0
  429. data/lib/mongo/version.rb +2 -2
  430. data/lib/mongo/write_concern.rb +1 -1
  431. data/lib/mongo/write_concern/acknowledged.rb +1 -1
  432. data/lib/mongo/write_concern/base.rb +1 -1
  433. data/lib/mongo/write_concern/unacknowledged.rb +1 -1
  434. data/mongo.gemspec +1 -1
  435. data/spec/NOTES.aws-auth.md +296 -0
  436. data/spec/README.aws-auth.md +318 -0
  437. data/spec/README.md +120 -18
  438. data/spec/integration/auth_spec.rb +29 -9
  439. data/spec/integration/awaited_ismaster_spec.rb +28 -0
  440. data/spec/integration/aws_auth_request_spec.rb +74 -0
  441. data/spec/integration/aws_credentials_retriever_spec.rb +103 -0
  442. data/spec/integration/bulk_write_spec.rb +48 -0
  443. data/spec/integration/change_stream_examples_spec.rb +6 -2
  444. data/spec/integration/change_stream_spec.rb +123 -51
  445. data/spec/integration/check_clean_slate_spec.rb +16 -0
  446. data/spec/integration/client_authentication_options_spec.rb +55 -28
  447. data/spec/integration/client_construction_aws_auth_spec.rb +191 -0
  448. data/spec/integration/client_construction_spec.rb +2 -1
  449. data/spec/integration/collection_indexes_prose_spec.rb +55 -0
  450. data/spec/integration/command_monitoring_spec.rb +30 -6
  451. data/spec/integration/command_spec.rb +11 -9
  452. data/spec/integration/connect_single_rs_name_spec.rb +10 -5
  453. data/spec/integration/connection_pool_populator_spec.rb +3 -1
  454. data/spec/integration/connection_spec.rb +7 -3
  455. data/spec/integration/crud_spec.rb +32 -4
  456. data/spec/integration/cursor_reaping_spec.rb +67 -27
  457. data/spec/integration/docs_examples_spec.rb +6 -0
  458. data/spec/integration/fork_reconnect_spec.rb +143 -0
  459. data/spec/integration/get_more_spec.rb +10 -3
  460. data/spec/integration/heartbeat_events_spec.rb +5 -24
  461. data/spec/integration/ocsp_connectivity_spec.rb +26 -0
  462. data/spec/integration/ocsp_verifier_cache_spec.rb +188 -0
  463. data/spec/integration/ocsp_verifier_spec.rb +334 -0
  464. data/spec/integration/query_cache_spec.rb +1045 -0
  465. data/spec/integration/query_cache_transactions_spec.rb +179 -0
  466. data/spec/integration/read_concern_spec.rb +1 -1
  467. data/spec/integration/read_preference_spec.rb +41 -11
  468. data/spec/integration/reconnect_spec.rb +2 -3
  469. data/spec/integration/retryable_errors_spec.rb +33 -14
  470. data/spec/integration/{retryable_writes_spec.rb → retryable_writes/retryable_writes_36_and_older_spec.rb} +55 -51
  471. data/spec/integration/retryable_writes/retryable_writes_40_and_newer_spec.rb +402 -0
  472. data/spec/integration/retryable_writes/shared/adds_diagnostics.rb +15 -0
  473. data/spec/integration/retryable_writes/shared/does_not_support_retries.rb +24 -0
  474. data/spec/integration/retryable_writes/shared/only_supports_legacy_retries.rb +25 -0
  475. data/spec/integration/retryable_writes/shared/performs_legacy_retries.rb +217 -0
  476. data/spec/integration/retryable_writes/shared/performs_modern_retries.rb +232 -0
  477. data/spec/integration/retryable_writes/shared/performs_no_retries.rb +110 -0
  478. data/spec/integration/retryable_writes/shared/supports_legacy_retries.rb +19 -0
  479. data/spec/integration/retryable_writes/shared/supports_modern_retries.rb +25 -0
  480. data/spec/integration/retryable_writes/shared/supports_retries.rb +16 -0
  481. data/spec/integration/sdam_error_handling_spec.rb +210 -22
  482. data/spec/integration/sdam_events_spec.rb +77 -5
  483. data/spec/integration/sdam_prose_spec.rb +64 -0
  484. data/spec/integration/server_monitor_spec.rb +25 -1
  485. data/spec/integration/server_selection_spec.rb +36 -0
  486. data/spec/integration/server_spec.rb +42 -26
  487. data/spec/integration/size_limit_spec.rb +3 -3
  488. data/spec/integration/srv_monitoring_spec.rb +38 -3
  489. data/spec/integration/srv_spec.rb +56 -0
  490. data/spec/integration/ssl_uri_options_spec.rb +2 -2
  491. data/spec/integration/step_down_spec.rb +15 -15
  492. data/spec/integration/transactions_api_examples_spec.rb +59 -0
  493. data/spec/integration/transactions_examples_spec.rb +5 -2
  494. data/spec/integration/x509_auth_spec.rb +109 -0
  495. data/spec/kerberos/kerberos_spec.rb +10 -6
  496. data/spec/lite_spec_helper.rb +34 -23
  497. data/spec/mongo/address/ipv4_spec.rb +1 -1
  498. data/spec/mongo/address_spec.rb +3 -3
  499. data/spec/mongo/auth/aws/request_region_spec.rb +42 -0
  500. data/spec/mongo/auth/aws/request_spec.rb +76 -0
  501. data/spec/mongo/auth/cr_spec.rb +7 -7
  502. data/spec/mongo/auth/gssapi/conversation_spec.rb +121 -0
  503. data/spec/mongo/auth/invalid_mechanism_spec.rb +1 -1
  504. data/spec/mongo/auth/ldap/conversation_spec.rb +1 -1
  505. data/spec/mongo/auth/ldap_spec.rb +3 -3
  506. data/spec/mongo/auth/scram/conversation_spec.rb +119 -334
  507. data/spec/mongo/auth/scram256/conversation_spec.rb +171 -0
  508. data/spec/mongo/auth/{scram/negotiation_spec.rb → scram_negotiation_spec.rb} +13 -8
  509. data/spec/mongo/auth/scram_spec.rb +29 -69
  510. data/spec/mongo/auth/user_spec.rb +1 -1
  511. data/spec/mongo/auth/x509/conversation_spec.rb +1 -1
  512. data/spec/mongo/auth/x509_spec.rb +8 -8
  513. data/spec/mongo/auth_spec.rb +4 -4
  514. data/spec/mongo/bulk_write_spec.rb +206 -2
  515. data/spec/mongo/caching_cursor_spec.rb +70 -0
  516. data/spec/mongo/client_construction_spec.rb +674 -87
  517. data/spec/mongo/client_spec.rb +99 -5
  518. data/spec/mongo/cluster/topology/replica_set_spec.rb +52 -9
  519. data/spec/mongo/cluster/topology/single_spec.rb +18 -7
  520. data/spec/mongo/cluster_spec.rb +40 -36
  521. data/spec/mongo/collection/view/aggregation_spec.rb +6 -2
  522. data/spec/mongo/collection/view/builder/find_command_spec.rb +17 -6
  523. data/spec/mongo/collection/view/change_stream_resume_spec.rb +392 -0
  524. data/spec/mongo/collection/view/change_stream_spec.rb +0 -318
  525. data/spec/mongo/collection/view/explainable_spec.rb +87 -4
  526. data/spec/mongo/collection/view/iterable_spec.rb +38 -0
  527. data/spec/mongo/collection/view/map_reduce_spec.rb +8 -2
  528. data/spec/mongo/collection/view/readable_spec.rb +15 -1
  529. data/spec/mongo/collection/view/writable_spec.rb +208 -1
  530. data/spec/mongo/collection_spec.rb +567 -43
  531. data/spec/mongo/crypt/auto_decryption_context_spec.rb +1 -1
  532. data/spec/mongo/crypt/auto_encryption_context_spec.rb +1 -1
  533. data/spec/mongo/crypt/explicit_decryption_context_spec.rb +1 -1
  534. data/spec/mongo/crypt/explicit_encryption_context_spec.rb +1 -1
  535. data/spec/mongo/cursor/builder/get_more_command_spec.rb +6 -1
  536. data/spec/mongo/cursor/builder/op_get_more_spec.rb +6 -1
  537. data/spec/mongo/cursor/builder/op_kill_cursors_spec.rb +6 -1
  538. data/spec/mongo/cursor_spec.rb +9 -1
  539. data/spec/mongo/database_spec.rb +295 -10
  540. data/spec/mongo/distinguishing_semaphore_spec.rb +63 -0
  541. data/spec/mongo/error/no_server_available_spec.rb +1 -1
  542. data/spec/mongo/error/operation_failure_heavy_spec.rb +58 -0
  543. data/spec/mongo/error/operation_failure_spec.rb +167 -69
  544. data/spec/mongo/error/unsupported_option_spec.rb +54 -0
  545. data/spec/mongo/grid/fs_bucket_spec.rb +18 -0
  546. data/spec/mongo/grid/stream/write_spec.rb +32 -0
  547. data/spec/mongo/index/view_spec.rb +312 -0
  548. data/spec/mongo/logger_spec.rb +13 -11
  549. data/spec/mongo/monitoring/event/server_description_changed_spec.rb +1 -4
  550. data/spec/mongo/operation/aggregate/result_spec.rb +6 -1
  551. data/spec/mongo/operation/delete/bulk_spec.rb +18 -6
  552. data/spec/mongo/operation/delete/op_msg_spec.rb +22 -14
  553. data/spec/mongo/operation/find/legacy_spec.rb +27 -7
  554. data/spec/mongo/operation/get_more_spec.rb +6 -1
  555. data/spec/mongo/operation/insert/bulk_spec.rb +21 -7
  556. data/spec/mongo/operation/insert/command_spec.rb +4 -0
  557. data/spec/mongo/operation/insert/op_msg_spec.rb +22 -14
  558. data/spec/mongo/operation/limited_spec.rb +5 -3
  559. data/spec/mongo/operation/read_preference_legacy_spec.rb +16 -4
  560. data/spec/mongo/operation/read_preference_op_msg_spec.rb +115 -5
  561. data/spec/mongo/operation/result_spec.rb +6 -1
  562. data/spec/mongo/operation/update/bulk_spec.rb +18 -6
  563. data/spec/mongo/operation/update/command_spec.rb +4 -0
  564. data/spec/mongo/operation/update/op_msg_spec.rb +22 -14
  565. data/spec/mongo/protocol/msg_spec.rb +10 -0
  566. data/spec/mongo/query_cache_spec.rb +279 -0
  567. data/spec/mongo/retryable_spec.rb +71 -70
  568. data/spec/mongo/semaphore_spec.rb +51 -0
  569. data/spec/mongo/server/app_metadata_shared.rb +136 -0
  570. data/spec/mongo/server/app_metadata_spec.rb +8 -1
  571. data/spec/mongo/server/connection_auth_spec.rb +33 -14
  572. data/spec/mongo/server/connection_pool_spec.rb +7 -34
  573. data/spec/mongo/server/connection_spec.rb +131 -77
  574. data/spec/mongo/server/monitor/app_metadata_spec.rb +8 -1
  575. data/spec/mongo/server/monitor/connection_spec.rb +1 -82
  576. data/spec/mongo/server/monitor_spec.rb +76 -17
  577. data/spec/mongo/server/round_trip_time_averager_spec.rb +5 -3
  578. data/spec/mongo/server_selector/nearest_spec.rb +24 -23
  579. data/spec/mongo/server_selector/primary_preferred_spec.rb +27 -26
  580. data/spec/mongo/server_selector/primary_spec.rb +27 -9
  581. data/spec/mongo/server_selector/secondary_preferred_spec.rb +40 -23
  582. data/spec/mongo/server_selector/secondary_spec.rb +19 -18
  583. data/spec/mongo/server_selector_spec.rb +4 -5
  584. data/spec/mongo/session/session_pool_spec.rb +7 -3
  585. data/spec/mongo/session_spec.rb +35 -0
  586. data/spec/mongo/socket/ssl_spec.rb +3 -3
  587. data/spec/mongo/socket/tcp_spec.rb +2 -2
  588. data/spec/mongo/socket/unix_spec.rb +2 -2
  589. data/spec/mongo/socket_spec.rb +10 -10
  590. data/spec/mongo/timeout_spec.rb +22 -68
  591. data/spec/mongo/uri/srv_protocol_spec.rb +64 -33
  592. data/spec/mongo/uri_option_parsing_spec.rb +11 -11
  593. data/spec/mongo/uri_spec.rb +85 -43
  594. data/spec/mongo/utils_spec.rb +39 -0
  595. data/spec/runners/auth.rb +8 -6
  596. data/spec/runners/change_streams/outcome.rb +42 -0
  597. data/spec/runners/change_streams/spec.rb +57 -0
  598. data/spec/runners/change_streams/test.rb +229 -0
  599. data/spec/runners/cmap.rb +1 -1
  600. data/spec/runners/cmap/verifier.rb +1 -1
  601. data/spec/runners/command_monitoring.rb +4 -35
  602. data/spec/runners/connection_string.rb +36 -124
  603. data/spec/runners/crud.rb +2 -2
  604. data/spec/runners/crud/context.rb +10 -6
  605. data/spec/runners/crud/operation.rb +177 -55
  606. data/spec/runners/crud/outcome.rb +1 -1
  607. data/spec/runners/crud/spec.rb +0 -7
  608. data/spec/runners/crud/test.rb +8 -26
  609. data/spec/runners/crud/test_base.rb +47 -0
  610. data/spec/runners/crud/verifier.rb +21 -3
  611. data/spec/runners/gridfs.rb +1 -1
  612. data/spec/runners/{server_discovery_and_monitoring.rb → sdam.rb} +41 -22
  613. data/spec/runners/sdam/verifier.rb +26 -8
  614. data/spec/runners/server_selection.rb +242 -28
  615. data/spec/runners/transactions.rb +13 -14
  616. data/spec/runners/transactions/operation.rb +155 -25
  617. data/spec/runners/transactions/spec.rb +1 -1
  618. data/spec/runners/transactions/test.rb +103 -65
  619. data/spec/spec_tests/auth_spec.rb +2 -0
  620. data/spec/spec_tests/change_streams_spec.rb +39 -4
  621. data/spec/spec_tests/client_side_encryption_spec.rb +3 -0
  622. data/spec/spec_tests/cmap_spec.rb +12 -3
  623. data/spec/spec_tests/command_monitoring_spec.rb +25 -12
  624. data/spec/spec_tests/connection_string_spec.rb +2 -0
  625. data/spec/spec_tests/crud_spec.rb +3 -1
  626. data/spec/spec_tests/data/auth/connection-string.yml +57 -1
  627. data/spec/spec_tests/data/change_streams/change-streams-errors.yml +27 -2
  628. data/spec/spec_tests/data/change_streams/change-streams-resume-errorLabels.yml +1105 -0
  629. data/spec/spec_tests/data/change_streams/change-streams-resume-whitelist.yml +1173 -0
  630. data/spec/spec_tests/data/change_streams/change-streams.yml +5 -5
  631. data/spec/spec_tests/data/cmap/pool-checkout-connection.yml +6 -2
  632. data/spec/spec_tests/data/cmap/pool-create-min-size.yml +3 -0
  633. data/spec/spec_tests/data/connection_string/valid-warnings.yml +24 -0
  634. data/spec/spec_tests/data/crud_v2/aggregate-merge.yml +1 -1
  635. data/spec/spec_tests/data/crud_v2/bulkWrite-arrayFilters.yml +33 -11
  636. data/spec/spec_tests/data/crud_v2/bulkWrite-delete-hint-clientError.yml +63 -0
  637. data/spec/spec_tests/data/crud_v2/bulkWrite-delete-hint-serverError.yml +92 -0
  638. data/spec/spec_tests/data/crud_v2/bulkWrite-delete-hint.yml +103 -0
  639. data/spec/spec_tests/data/crud_v2/bulkWrite-update-hint-clientError.yml +90 -0
  640. data/spec/spec_tests/data/crud_v2/bulkWrite-update-hint-serverError.yml +147 -0
  641. data/spec/spec_tests/data/crud_v2/bulkWrite-update-hint.yml +164 -0
  642. data/spec/spec_tests/data/crud_v2/deleteMany-hint-clientError.yml +43 -0
  643. data/spec/spec_tests/data/crud_v2/deleteMany-hint-serverError.yml +62 -0
  644. data/spec/spec_tests/data/crud_v2/deleteMany-hint.yml +58 -0
  645. data/spec/spec_tests/data/crud_v2/deleteOne-hint-clientError.yml +41 -0
  646. data/spec/spec_tests/data/crud_v2/deleteOne-hint-serverError.yml +60 -0
  647. data/spec/spec_tests/data/crud_v2/deleteOne-hint.yml +57 -0
  648. data/spec/spec_tests/data/crud_v2/find-allowdiskuse-clientError.yml +28 -0
  649. data/spec/spec_tests/data/crud_v2/find-allowdiskuse-serverError.yml +44 -0
  650. data/spec/spec_tests/data/crud_v2/find-allowdiskuse.yml +50 -0
  651. data/spec/spec_tests/data/crud_v2/findOneAndDelete-hint-clientError.yml +45 -0
  652. data/spec/spec_tests/data/crud_v2/findOneAndDelete-hint-serverError.yml +60 -0
  653. data/spec/spec_tests/data/crud_v2/findOneAndDelete-hint.yml +56 -0
  654. data/spec/spec_tests/data/crud_v2/findOneAndReplace-hint-clientError.yml +40 -0
  655. data/spec/spec_tests/data/crud_v2/findOneAndReplace-hint-serverError.yml +59 -0
  656. data/spec/spec_tests/data/crud_v2/findOneAndReplace-hint.yml +55 -0
  657. data/spec/spec_tests/data/crud_v2/findOneAndUpdate-hint-clientError.yml +40 -0
  658. data/spec/spec_tests/data/crud_v2/findOneAndUpdate-hint-serverError.yml +58 -0
  659. data/spec/spec_tests/data/crud_v2/findOneAndUpdate-hint.yml +55 -0
  660. data/spec/spec_tests/data/crud_v2/replaceOne-hint.yml +61 -0
  661. data/spec/spec_tests/data/crud_v2/unacknowledged-bulkWrite-delete-hint-clientError.yml +60 -0
  662. data/spec/spec_tests/data/crud_v2/unacknowledged-bulkWrite-update-hint-clientError.yml +88 -0
  663. data/spec/spec_tests/data/crud_v2/unacknowledged-deleteMany-hint-clientError.yml +40 -0
  664. data/spec/spec_tests/data/crud_v2/unacknowledged-deleteOne-hint-clientError.yml +38 -0
  665. data/spec/spec_tests/data/crud_v2/unacknowledged-findOneAndDelete-hint-clientError.yml +42 -0
  666. data/spec/spec_tests/data/crud_v2/unacknowledged-findOneAndReplace-hint-clientError.yml +40 -0
  667. data/spec/spec_tests/data/crud_v2/unacknowledged-findOneAndUpdate-hint-clientError.yml +40 -0
  668. data/spec/spec_tests/data/crud_v2/unacknowledged-replaceOne-hint-clientError.yml +40 -0
  669. data/spec/spec_tests/data/crud_v2/unacknowledged-updateMany-hint-clientError.yml +43 -0
  670. data/spec/spec_tests/data/crud_v2/unacknowledged-updateOne-hint-clientError.yml +40 -0
  671. data/spec/spec_tests/data/crud_v2/updateMany-hint-clientError.yml +45 -0
  672. data/spec/spec_tests/data/crud_v2/updateMany-hint-serverError.yml +66 -0
  673. data/spec/spec_tests/data/crud_v2/updateMany-hint.yml +65 -0
  674. data/spec/spec_tests/data/crud_v2/updateOne-hint-clientError.yml +43 -0
  675. data/spec/spec_tests/data/crud_v2/updateOne-hint-serverError.yml +62 -0
  676. data/spec/spec_tests/data/crud_v2/updateOne-hint.yml +61 -0
  677. data/spec/spec_tests/data/crud_v2/updateWithPipelines.yml +65 -0
  678. data/spec/spec_tests/data/dns_seedlist_discovery/direct-connection-false.yml +10 -0
  679. data/spec/spec_tests/data/dns_seedlist_discovery/direct-connection-true.yml +5 -0
  680. data/spec/spec_tests/data/max_staleness/ReplicaSetNoPrimary/MaxStalenessTooSmall.yml +15 -0
  681. data/spec/spec_tests/data/max_staleness/ReplicaSetNoPrimary/NoKnownServers.yml +4 -3
  682. data/spec/spec_tests/data/max_staleness/Unknown/SmallMaxStaleness.yml +1 -0
  683. data/spec/spec_tests/data/read_write_concern/operation/default-write-concern-2.6.yml +215 -0
  684. data/spec/spec_tests/data/read_write_concern/operation/default-write-concern-3.2.yml +58 -0
  685. data/spec/spec_tests/data/read_write_concern/operation/default-write-concern-3.4.yml +95 -0
  686. data/spec/spec_tests/data/read_write_concern/operation/default-write-concern-4.2.yml +36 -0
  687. data/spec/spec_tests/data/retryable_writes/bulkWrite-errorLabels.yml +77 -0
  688. data/spec/spec_tests/data/retryable_writes/bulkWrite-serverErrors.yml +37 -0
  689. data/spec/spec_tests/data/retryable_writes/deleteOne-errorLabels.yml +48 -0
  690. data/spec/spec_tests/data/retryable_writes/deleteOne-serverErrors.yml +22 -0
  691. data/spec/spec_tests/data/retryable_writes/findOneAndDelete-errorLabels.yml +49 -0
  692. data/spec/spec_tests/data/retryable_writes/findOneAndDelete-serverErrors.yml +23 -0
  693. data/spec/spec_tests/data/retryable_writes/findOneAndReplace-errorLabels.yml +52 -0
  694. data/spec/spec_tests/data/retryable_writes/findOneAndReplace-serverErrors.yml +25 -0
  695. data/spec/spec_tests/data/retryable_writes/findOneAndUpdate-errorLabels.yml +52 -0
  696. data/spec/spec_tests/data/retryable_writes/findOneAndUpdate-serverErrors.yml +24 -0
  697. data/spec/spec_tests/data/retryable_writes/insertMany-errorLabels.yml +54 -0
  698. data/spec/spec_tests/data/retryable_writes/insertMany-serverErrors.yml +24 -0
  699. data/spec/spec_tests/data/retryable_writes/insertOne-errorLabels.yml +44 -0
  700. data/spec/spec_tests/data/retryable_writes/insertOne-serverErrors.yml +69 -0
  701. data/spec/spec_tests/data/retryable_writes/replaceOne-errorLabels.yml +53 -0
  702. data/spec/spec_tests/data/retryable_writes/replaceOne-serverErrors.yml +23 -0
  703. data/spec/spec_tests/data/retryable_writes/updateOne-errorLabels.yml +53 -0
  704. data/spec/spec_tests/data/retryable_writes/updateOne-serverErrors.yml +23 -0
  705. data/spec/spec_tests/data/sdam/errors/error_handling_handshake.yml +54 -0
  706. data/spec/spec_tests/data/sdam/errors/non-stale-network-error.yml +46 -0
  707. data/spec/spec_tests/data/sdam/errors/non-stale-network-timeout-error.yml +37 -0
  708. data/spec/spec_tests/data/sdam/errors/non-stale-topologyVersion-greater-InterruptedAtShutdown.yml +60 -0
  709. data/spec/spec_tests/data/sdam/errors/non-stale-topologyVersion-greater-InterruptedDueToReplStateChange.yml +60 -0
  710. data/spec/spec_tests/data/sdam/errors/non-stale-topologyVersion-greater-NotMaster.yml +60 -0
  711. data/spec/spec_tests/data/sdam/errors/non-stale-topologyVersion-greater-NotMasterNoSlaveOk.yml +60 -0
  712. data/spec/spec_tests/data/sdam/errors/non-stale-topologyVersion-greater-NotMasterOrSecondary.yml +60 -0
  713. data/spec/spec_tests/data/sdam/errors/non-stale-topologyVersion-greater-PrimarySteppedDown.yml +60 -0
  714. data/spec/spec_tests/data/sdam/errors/non-stale-topologyVersion-greater-ShutdownInProgress.yml +60 -0
  715. data/spec/spec_tests/data/sdam/errors/non-stale-topologyVersion-missing-InterruptedAtShutdown.yml +51 -0
  716. data/spec/spec_tests/data/sdam/errors/non-stale-topologyVersion-missing-InterruptedDueToReplStateChange.yml +51 -0
  717. data/spec/spec_tests/data/sdam/errors/non-stale-topologyVersion-missing-NotMaster.yml +51 -0
  718. data/spec/spec_tests/data/sdam/errors/non-stale-topologyVersion-missing-NotMasterNoSlaveOk.yml +51 -0
  719. data/spec/spec_tests/data/sdam/errors/non-stale-topologyVersion-missing-NotMasterOrSecondary.yml +51 -0
  720. data/spec/spec_tests/data/sdam/errors/non-stale-topologyVersion-missing-PrimarySteppedDown.yml +51 -0
  721. data/spec/spec_tests/data/sdam/errors/non-stale-topologyVersion-missing-ShutdownInProgress.yml +51 -0
  722. data/spec/spec_tests/data/sdam/errors/non-stale-topologyVersion-proccessId-changed-InterruptedAtShutdown.yml +60 -0
  723. data/spec/spec_tests/data/sdam/errors/non-stale-topologyVersion-proccessId-changed-InterruptedDueToReplStateChange.yml +60 -0
  724. data/spec/spec_tests/data/sdam/errors/non-stale-topologyVersion-proccessId-changed-NotMaster.yml +60 -0
  725. data/spec/spec_tests/data/sdam/errors/non-stale-topologyVersion-proccessId-changed-NotMasterNoSlaveOk.yml +60 -0
  726. data/spec/spec_tests/data/sdam/errors/non-stale-topologyVersion-proccessId-changed-NotMasterOrSecondary.yml +60 -0
  727. data/spec/spec_tests/data/sdam/errors/non-stale-topologyVersion-proccessId-changed-PrimarySteppedDown.yml +60 -0
  728. data/spec/spec_tests/data/sdam/errors/non-stale-topologyVersion-proccessId-changed-ShutdownInProgress.yml +60 -0
  729. data/spec/spec_tests/data/sdam/errors/post-42-InterruptedAtShutdown.yml +46 -0
  730. data/spec/spec_tests/data/sdam/errors/post-42-InterruptedDueToReplStateChange.yml +46 -0
  731. data/spec/spec_tests/data/sdam/errors/post-42-NotMaster.yml +46 -0
  732. data/spec/spec_tests/data/sdam/errors/post-42-NotMasterNoSlaveOk.yml +46 -0
  733. data/spec/spec_tests/data/sdam/errors/post-42-NotMasterOrSecondary.yml +46 -0
  734. data/spec/spec_tests/data/sdam/errors/post-42-PrimarySteppedDown.yml +46 -0
  735. data/spec/spec_tests/data/sdam/errors/post-42-ShutdownInProgress.yml +46 -0
  736. data/spec/spec_tests/data/sdam/errors/pre-42-InterruptedAtShutdown.yml +46 -0
  737. data/spec/spec_tests/data/sdam/errors/pre-42-InterruptedDueToReplStateChange.yml +46 -0
  738. data/spec/spec_tests/data/sdam/errors/pre-42-NotMaster.yml +46 -0
  739. data/spec/spec_tests/data/sdam/errors/pre-42-NotMasterNoSlaveOk.yml +46 -0
  740. data/spec/spec_tests/data/sdam/errors/pre-42-NotMasterOrSecondary.yml +46 -0
  741. data/spec/spec_tests/data/sdam/errors/pre-42-PrimarySteppedDown.yml +46 -0
  742. data/spec/spec_tests/data/sdam/errors/pre-42-ShutdownInProgress.yml +46 -0
  743. data/spec/spec_tests/data/sdam/errors/stale-generation-InterruptedAtShutdown.yml +89 -0
  744. data/spec/spec_tests/data/sdam/errors/stale-generation-InterruptedDueToReplStateChange.yml +89 -0
  745. data/spec/spec_tests/data/sdam/errors/stale-generation-NotMaster.yml +89 -0
  746. data/spec/spec_tests/data/sdam/errors/stale-generation-NotMasterNoSlaveOk.yml +89 -0
  747. data/spec/spec_tests/data/sdam/errors/stale-generation-NotMasterOrSecondary.yml +89 -0
  748. data/spec/spec_tests/data/sdam/errors/stale-generation-PrimarySteppedDown.yml +89 -0
  749. data/spec/spec_tests/data/sdam/errors/stale-generation-ShutdownInProgress.yml +89 -0
  750. data/spec/spec_tests/data/sdam/errors/stale-generation-afterHandshakeCompletes-InterruptedAtShutdown.yml +89 -0
  751. data/spec/spec_tests/data/sdam/errors/stale-generation-afterHandshakeCompletes-InterruptedDueToReplStateChange.yml +89 -0
  752. data/spec/spec_tests/data/sdam/errors/stale-generation-afterHandshakeCompletes-NotMaster.yml +89 -0
  753. data/spec/spec_tests/data/sdam/errors/stale-generation-afterHandshakeCompletes-NotMasterNoSlaveOk.yml +89 -0
  754. data/spec/spec_tests/data/sdam/errors/stale-generation-afterHandshakeCompletes-NotMasterOrSecondary.yml +89 -0
  755. data/spec/spec_tests/data/sdam/errors/stale-generation-afterHandshakeCompletes-PrimarySteppedDown.yml +89 -0
  756. data/spec/spec_tests/data/sdam/errors/stale-generation-afterHandshakeCompletes-ShutdownInProgress.yml +89 -0
  757. data/spec/spec_tests/data/sdam/errors/stale-generation-afterHandshakeCompletes-network.yml +80 -0
  758. data/spec/spec_tests/data/sdam/errors/stale-generation-afterHandshakeCompletes-timeout.yml +80 -0
  759. data/spec/spec_tests/data/sdam/errors/stale-generation-beforeHandshakeCompletes-InterruptedAtShutdown.yml +89 -0
  760. data/spec/spec_tests/data/sdam/errors/stale-generation-beforeHandshakeCompletes-InterruptedDueToReplStateChange.yml +89 -0
  761. data/spec/spec_tests/data/sdam/errors/stale-generation-beforeHandshakeCompletes-NotMaster.yml +89 -0
  762. data/spec/spec_tests/data/sdam/errors/stale-generation-beforeHandshakeCompletes-NotMasterNoSlaveOk.yml +89 -0
  763. data/spec/spec_tests/data/sdam/errors/stale-generation-beforeHandshakeCompletes-NotMasterOrSecondary.yml +89 -0
  764. data/spec/spec_tests/data/sdam/errors/stale-generation-beforeHandshakeCompletes-PrimarySteppedDown.yml +89 -0
  765. data/spec/spec_tests/data/sdam/errors/stale-generation-beforeHandshakeCompletes-ShutdownInProgress.yml +89 -0
  766. data/spec/spec_tests/data/sdam/errors/stale-generation-beforeHandshakeCompletes-network.yml +80 -0
  767. data/spec/spec_tests/data/sdam/errors/stale-generation-beforeHandshakeCompletes-timeout.yml +80 -0
  768. data/spec/spec_tests/data/sdam/errors/stale-topologyVersion-InterruptedAtShutdown.yml +64 -0
  769. data/spec/spec_tests/data/sdam/errors/stale-topologyVersion-InterruptedDueToReplStateChange.yml +64 -0
  770. data/spec/spec_tests/data/sdam/errors/stale-topologyVersion-NotMaster.yml +64 -0
  771. data/spec/spec_tests/data/sdam/errors/stale-topologyVersion-NotMasterNoSlaveOk.yml +64 -0
  772. data/spec/spec_tests/data/sdam/errors/stale-topologyVersion-NotMasterOrSecondary.yml +64 -0
  773. data/spec/spec_tests/data/sdam/errors/stale-topologyVersion-PrimarySteppedDown.yml +64 -0
  774. data/spec/spec_tests/data/sdam/errors/stale-topologyVersion-ShutdownInProgress.yml +64 -0
  775. data/spec/spec_tests/data/sdam/rs/compatible.yml +2 -0
  776. data/spec/spec_tests/data/sdam/rs/compatible_unknown.yml +2 -0
  777. data/spec/spec_tests/data/sdam/rs/discover_arbiters.yml +2 -2
  778. data/spec/spec_tests/data/sdam/rs/discover_arbiters_replicaset.yml +43 -0
  779. data/spec/spec_tests/data/sdam/rs/discover_ghost.yml +35 -0
  780. data/spec/spec_tests/data/sdam/rs/{ghost_discovered.yml → discover_ghost_replicaset.yml} +1 -1
  781. data/spec/spec_tests/data/sdam/rs/discover_hidden.yml +50 -0
  782. data/spec/spec_tests/data/sdam/rs/discover_hidden_replicaset.yml +50 -0
  783. data/spec/spec_tests/data/sdam/rs/discover_passives.yml +2 -2
  784. data/spec/spec_tests/data/sdam/rs/discover_passives_replicaset.yml +81 -0
  785. data/spec/spec_tests/data/sdam/rs/discover_primary.yml +2 -2
  786. data/spec/spec_tests/data/sdam/rs/discover_primary_replicaset.yml +42 -0
  787. data/spec/spec_tests/data/sdam/rs/discover_rsother.yml +49 -0
  788. data/spec/spec_tests/data/sdam/rs/{rsother_discovered.yml → discover_rsother_replicaset.yml} +1 -1
  789. data/spec/spec_tests/data/sdam/rs/discover_secondary.yml +2 -2
  790. data/spec/spec_tests/data/sdam/rs/discover_secondary_replicaset.yml +43 -0
  791. data/spec/spec_tests/data/sdam/rs/incompatible_arbiter.yml +2 -0
  792. data/spec/spec_tests/data/sdam/rs/incompatible_ghost.yml +2 -0
  793. data/spec/spec_tests/data/sdam/rs/incompatible_other.yml +2 -0
  794. data/spec/spec_tests/data/sdam/rs/primary_mismatched_me.yml +23 -27
  795. data/spec/spec_tests/data/sdam/rs/primary_to_no_primary_mismatched_me.yml +79 -55
  796. data/spec/spec_tests/data/sdam/rs/replicaset_rsnp.yml +20 -0
  797. data/spec/spec_tests/data/sdam/rs/secondary_mismatched_me.yml +3 -2
  798. data/spec/spec_tests/data/sdam/rs/too_new.yml +2 -0
  799. data/spec/spec_tests/data/sdam/rs/topology_version_equal.yml +66 -0
  800. data/spec/spec_tests/data/sdam/rs/topology_version_greater.yml +189 -0
  801. data/spec/spec_tests/data/sdam/rs/topology_version_less.yml +62 -0
  802. data/spec/spec_tests/data/sdam/sharded/discover_single_mongos.yml +23 -0
  803. data/spec/spec_tests/data/sdam/single/direct_connection_external_ip.yml +1 -1
  804. data/spec/spec_tests/data/sdam/single/direct_connection_mongos.yml +2 -2
  805. data/spec/spec_tests/data/sdam/single/direct_connection_replicaset.yml +22 -0
  806. data/spec/spec_tests/data/sdam/single/direct_connection_rsarbiter.yml +2 -2
  807. data/spec/spec_tests/data/sdam/single/direct_connection_rsprimary.yml +2 -2
  808. data/spec/spec_tests/data/sdam/single/direct_connection_rssecondary.yml +2 -2
  809. data/spec/spec_tests/data/sdam/single/direct_connection_slave.yml +1 -1
  810. data/spec/spec_tests/data/sdam/single/direct_connection_standalone.yml +2 -2
  811. data/spec/spec_tests/data/sdam/single/{unavailable_seed.yml → direct_connection_unavailable_seed.yml} +2 -2
  812. data/spec/spec_tests/data/sdam/single/direct_connection_wrong_set_name.yml +38 -0
  813. data/spec/spec_tests/data/sdam/single/discover_standalone.yml +34 -0
  814. data/spec/spec_tests/data/sdam/single/discover_unavailable_seed.yml +28 -0
  815. data/spec/spec_tests/data/sdam/single/too_old_then_upgraded.yml +46 -0
  816. data/spec/spec_tests/data/sdam_integration/cancel-server-check.yml +96 -0
  817. data/spec/spec_tests/data/sdam_integration/connectTimeoutMS.yml +88 -0
  818. data/spec/spec_tests/data/sdam_integration/find-network-error.yml +83 -0
  819. data/spec/spec_tests/data/sdam_integration/find-shutdown-error.yml +116 -0
  820. data/spec/spec_tests/data/sdam_integration/insert-network-error.yml +86 -0
  821. data/spec/spec_tests/data/sdam_integration/insert-shutdown-error.yml +115 -0
  822. data/spec/spec_tests/data/sdam_integration/isMaster-command-error.yml +168 -0
  823. data/spec/spec_tests/data/sdam_integration/isMaster-network-error.yml +162 -0
  824. data/spec/spec_tests/data/sdam_integration/isMaster-timeout.yml +229 -0
  825. data/spec/spec_tests/data/sdam_integration/rediscover-quickly-after-step-down.yml +87 -0
  826. data/spec/spec_tests/data/sdam_monitoring/discovered_standalone.yml +1 -3
  827. data/spec/spec_tests/data/sdam_monitoring/standalone.yml +2 -2
  828. data/spec/spec_tests/data/sdam_monitoring/standalone_repeated.yml +2 -2
  829. data/spec/spec_tests/data/sdam_monitoring/standalone_suppress_equal_description_changes.yml +2 -2
  830. data/spec/spec_tests/data/sdam_monitoring/standalone_to_rs_with_me_mismatch.yml +2 -2
  831. data/spec/spec_tests/data/transactions/create-collection.yml +131 -0
  832. data/spec/spec_tests/data/transactions/create-index.yml +152 -0
  833. data/spec/spec_tests/data/transactions/error-labels.yml +87 -21
  834. data/spec/spec_tests/data/transactions/mongos-recovery-token.yml +1 -0
  835. data/spec/spec_tests/data/transactions/retryable-abort-errorLabels.yml +124 -0
  836. data/spec/spec_tests/data/transactions/retryable-abort.yml +17 -2
  837. data/spec/spec_tests/data/transactions/retryable-commit-errorLabels.yml +132 -0
  838. data/spec/spec_tests/data/transactions/retryable-commit.yml +24 -9
  839. data/spec/spec_tests/data/uri_options/auth-options.yml +25 -0
  840. data/spec/spec_tests/data/uri_options/compression-options.yml +6 -3
  841. data/spec/spec_tests/data/uri_options/connection-options.yml +43 -0
  842. data/spec/spec_tests/data/uri_options/read-preference-options.yml +24 -0
  843. data/spec/spec_tests/data/uri_options/ruby-auth-options.yml +12 -0
  844. data/spec/spec_tests/data/uri_options/ruby-connection-options.yml +58 -0
  845. data/spec/spec_tests/data/uri_options/tls-options.yml +160 -4
  846. data/spec/spec_tests/dns_seedlist_discovery_spec.rb +12 -2
  847. data/spec/spec_tests/gridfs_spec.rb +2 -0
  848. data/spec/spec_tests/max_staleness_spec.rb +5 -141
  849. data/spec/spec_tests/read_write_concern_connection_string_spec.rb +2 -0
  850. data/spec/spec_tests/read_write_concern_operaton_spec.rb +10 -0
  851. data/spec/spec_tests/retryable_reads_spec.rb +4 -2
  852. data/spec/spec_tests/retryable_writes_spec.rb +8 -1
  853. data/spec/spec_tests/sdam_integration_spec.rb +13 -0
  854. data/spec/spec_tests/sdam_monitoring_spec.rb +3 -2
  855. data/spec/spec_tests/sdam_spec.rb +70 -1
  856. data/spec/spec_tests/server_selection_rtt_spec.rb +2 -0
  857. data/spec/spec_tests/server_selection_spec.rb +5 -115
  858. data/spec/spec_tests/transactions_api_spec.rb +5 -0
  859. data/spec/spec_tests/transactions_spec.rb +5 -0
  860. data/spec/spec_tests/uri_options_spec.rb +33 -33
  861. data/spec/stress/cleanup_spec.rb +58 -0
  862. data/spec/stress/connection_pool_stress_spec.rb +11 -13
  863. data/spec/stress/connection_pool_timing_spec.rb +3 -6
  864. data/spec/stress/fork_reconnect_stress_spec.rb +109 -0
  865. data/spec/support/authorization.rb +1 -11
  866. data/spec/support/aws_utils.rb +62 -0
  867. data/spec/support/aws_utils/base.rb +134 -0
  868. data/spec/support/aws_utils/inspector.rb +224 -0
  869. data/spec/support/aws_utils/orchestrator.rb +370 -0
  870. data/spec/support/aws_utils/provisioner.rb +360 -0
  871. data/spec/support/background_thread_registry.rb +6 -2
  872. data/spec/support/certificates/atlas-ocsp-ca.crt +28 -0
  873. data/spec/support/certificates/atlas-ocsp.crt +41 -0
  874. data/spec/support/child_process_helper.rb +78 -0
  875. data/spec/support/client_registry.rb +6 -24
  876. data/spec/support/client_registry_macros.rb +11 -2
  877. data/spec/support/cluster_config.rb +5 -0
  878. data/spec/support/common_shortcuts.rb +88 -0
  879. data/spec/support/constraints.rb +50 -7
  880. data/spec/support/crypt.rb +1 -1
  881. data/spec/support/event_subscriber.rb +184 -84
  882. data/spec/support/keyword_struct.rb +26 -0
  883. data/spec/support/lite_constraints.rb +71 -0
  884. data/spec/support/matchers.rb +16 -0
  885. data/spec/support/ocsp +1 -0
  886. data/spec/support/session_registry.rb +52 -0
  887. data/spec/support/shared/scram_conversation.rb +100 -0
  888. data/spec/support/shared/server_selector.rb +93 -1
  889. data/spec/support/shared/session.rb +29 -21
  890. data/spec/support/spec_config.rb +98 -21
  891. data/spec/support/spec_organizer.rb +129 -0
  892. data/spec/support/spec_setup.rb +9 -5
  893. data/spec/support/utils.rb +180 -25
  894. metadata +1221 -745
  895. metadata.gz.sig +0 -0
  896. data/lib/mongo/server/connectable.rb +0 -107
  897. data/spec/runners/change_streams.rb +0 -262
  898. data/spec/runners/change_streams/operation.rb +0 -89
  899. data/spec/runners/sdam_monitoring.rb +0 -89
  900. data/spec/spec_tests/data/sdam/sharded/ruby_discovered_single_mongos.yml +0 -27
@@ -1,4 +1,4 @@
1
- # Copyright (C) 2017-2019 MongoDB, Inc.
1
+ # Copyright (C) 2017-2020 MongoDB Inc.
2
2
  #
3
3
  # Licensed under the Apache License, Version 2.0 (the "License");
4
4
  # you may not use this file except in compliance with the License.
@@ -1,4 +1,4 @@
1
- # Copyright (C) 2017-2019 MongoDB, Inc.
1
+ # Copyright (C) 2017-2020 MongoDB Inc.
2
2
  #
3
3
  # Licensed under the Apache License, Version 2.0 (the "License");
4
4
  # you may not use this file except in compliance with the License.
@@ -1,4 +1,4 @@
1
- # Copyright (C) 2014-2019 MongoDB, Inc.
1
+ # Copyright (C) 2014-2020 MongoDB Inc.
2
2
  #
3
3
  # Licensed under the Apache License, Version 2.0 (the "License");
4
4
  # you may not use this file except in compliance with the License.
@@ -15,19 +15,22 @@
15
15
  require 'mongo/socket/ssl'
16
16
  require 'mongo/socket/tcp'
17
17
  require 'mongo/socket/unix'
18
+ require 'mongo/socket/ocsp_verifier'
19
+ require 'mongo/socket/ocsp_cache'
18
20
 
19
21
  module Mongo
20
22
 
21
23
  # Provides additional data around sockets for the driver's use.
22
24
  #
23
25
  # @since 2.0.0
26
+ # @api private
24
27
  class Socket
25
28
  include ::Socket::Constants
26
29
 
27
- # Error message for SSL related exceptions.
30
+ # Error message for TLS related exceptions.
28
31
  #
29
32
  # @since 2.0.0
30
- SSL_ERROR = 'MongoDB may not be configured with SSL support'.freeze
33
+ SSL_ERROR = 'MongoDB may not be configured with TLS support'.freeze
31
34
 
32
35
  # Error message for timeouts on socket calls.
33
36
  #
@@ -45,6 +48,25 @@ module Mongo
45
48
  # @api private
46
49
  WRITE_CHUNK_SIZE = 65536
47
50
 
51
+ # Initializes common socket attributes.
52
+ #
53
+ # @param [ Float ] timeout The socket timeout value.
54
+ # @param [ Hash ] options The options.
55
+ #
56
+ # @option options [ Float ] :connect_timeout Connect timeout.
57
+ # @option options [ Address ] :connection_address Address of the
58
+ # connection that created this socket.
59
+ # @option options [ Integer ] :connection_generation Generation of the
60
+ # connection (for non-monitoring connections) that created this socket.
61
+ # @option options [ true | false ] :monitor Whether this socket was
62
+ # created by a monitoring connection.
63
+ #
64
+ # @api private
65
+ def initialize(timeout, options)
66
+ @timeout = timeout
67
+ @options = options
68
+ end
69
+
48
70
  # @return [ Integer ] family The type of host family.
49
71
  attr_reader :family
50
72
 
@@ -57,6 +79,46 @@ module Mongo
57
79
  # @return [ Float ] timeout The socket timeout.
58
80
  attr_reader :timeout
59
81
 
82
+ # @return [ Address ] Address of the connection that created this socket.
83
+ #
84
+ # @api private
85
+ def connection_address
86
+ options[:connection_address]
87
+ end
88
+
89
+ # @return [ Integer ] Generation of the connection (for non-monitoring
90
+ # connections) that created this socket.
91
+ #
92
+ # @api private
93
+ def connection_generation
94
+ options[:connection_generation]
95
+ end
96
+
97
+ # @return [ true | false ] Whether this socket was created by a monitoring
98
+ # connection.
99
+ #
100
+ # @api private
101
+ def monitor?
102
+ !!options[:monitor]
103
+ end
104
+
105
+ # @return [ String ] Human-readable summary of the socket for debugging.
106
+ #
107
+ # @api private
108
+ def summary
109
+ fileno = @socket&.fileno rescue '<no socket>' || '<no socket>'
110
+ if monitor?
111
+ indicator = if options[:push]
112
+ 'pm'
113
+ else
114
+ 'm'
115
+ end
116
+ "#{connection_address};#{indicator};fd=#{fileno}"
117
+ else
118
+ "#{connection_address};c:#{connection_generation};fd=#{fileno}"
119
+ end
120
+ end
121
+
60
122
  # Is the socket connection alive?
61
123
  #
62
124
  # @example Is the socket alive?
@@ -69,7 +131,7 @@ module Mongo
69
131
  sock_arr = [ @socket ]
70
132
  if Kernel::select(sock_arr, nil, sock_arr, 0)
71
133
  # The eof? call is supposed to return immediately since select
72
- # indicated the socket is readable. However, if @socket is an SSL
134
+ # indicated the socket is readable. However, if @socket is a TLS
73
135
  # socket, eof? can block anyway - see RUBY-2140.
74
136
  begin
75
137
  Timeout.timeout(0.1) do
@@ -107,7 +169,9 @@ module Mongo
107
169
  #
108
170
  # @since 2.0.0
109
171
  def gets(*args)
110
- handle_errors { @socket.gets(*args) }
172
+ map_exceptions do
173
+ @socket.gets(*args)
174
+ end
111
175
  end
112
176
 
113
177
  # Will read all data from the socket for the provided number of bytes.
@@ -117,20 +181,21 @@ module Mongo
117
181
  # socket.read(4096)
118
182
  #
119
183
  # @param [ Integer ] length The number of bytes to read.
184
+ # @param [ Numeric ] timeout The timeout to use for each chunk read.
120
185
  #
121
186
  # @raise [ Mongo::SocketError ] If not all data is returned.
122
187
  #
123
188
  # @return [ Object ] The data from the socket.
124
189
  #
125
190
  # @since 2.0.0
126
- def read(length)
127
- handle_errors do
128
- data = read_from_socket(length)
191
+ def read(length, timeout: nil)
192
+ map_exceptions do
193
+ data = read_from_socket(length, timeout: timeout)
129
194
  unless (data.length > 0 || length == 0)
130
195
  raise IOError, "Expected to read > 0 bytes but read 0 bytes"
131
196
  end
132
197
  while data.length < length
133
- chunk = read_from_socket(length - data.length)
198
+ chunk = read_from_socket(length - data.length, timeout: timeout)
134
199
  unless (chunk.length > 0 || length == 0)
135
200
  raise IOError, "Expected to read > 0 bytes but read 0 bytes"
136
201
  end
@@ -149,42 +214,21 @@ module Mongo
149
214
  #
150
215
  # @since 2.0.0
151
216
  def readbyte
152
- handle_errors { @socket.readbyte }
217
+ map_exceptions do
218
+ @socket.readbyte
219
+ end
153
220
  end
154
221
 
155
222
  # Writes data to the socket instance.
156
223
  #
157
- # @example Write to the socket.
158
- # socket.write(data)
159
- #
160
224
  # @param [ Array<Object> ] args The data to be written.
161
225
  #
162
226
  # @return [ Integer ] The length of bytes written to the socket.
163
227
  #
164
228
  # @since 2.0.0
165
229
  def write(*args)
166
- handle_errors do
167
- # This method used to forward arguments to @socket.write in a
168
- # single call like so:
169
- #
170
- # @socket.write(*args)
171
- #
172
- # Turns out, when each buffer to be written is large (e.g. 32 MiB),
173
- # this write call would take an extremely long time (20+ seconds)
174
- # while using 100% CPU. Splitting the writes into chunks produced
175
- # massively better performance (0.05 seconds to write the 32 MiB of
176
- # data on the same hardware). Unfortunately splitting the data,
177
- # one would assume, results in it being copied, but this seems to be
178
- # a much more minor issue compared to CPU cost of writing large buffers.
179
- args.each do |buf|
180
- buf = buf.to_s
181
- i = 0
182
- while i < buf.length
183
- chunk = buf[i...i+WRITE_CHUNK_SIZE]
184
- @socket.write(chunk)
185
- i += WRITE_CHUNK_SIZE
186
- end
187
- end
230
+ map_exceptions do
231
+ do_write(*args)
188
232
  end
189
233
  end
190
234
 
@@ -208,14 +252,19 @@ module Mongo
208
252
 
209
253
  private
210
254
 
211
- def read_from_socket(length)
255
+ def read_from_socket(length, timeout: nil)
212
256
  # Just in case
213
257
  if length == 0
214
258
  return ''.force_encoding('BINARY')
215
259
  end
216
260
 
217
- if _timeout = self.timeout
218
- deadline = Time.now + _timeout
261
+ _timeout = timeout || self.timeout
262
+ if _timeout
263
+ if _timeout > 0
264
+ deadline = Time.now + _timeout
265
+ elsif _timeout < 0
266
+ raise Errno::ETIMEDOUT, "Negative timeout #{_timeout} given to socket"
267
+ end
219
268
  end
220
269
 
221
270
  # We want to have a fixed and reasonably small size buffer for reads
@@ -295,11 +344,44 @@ module Mongo
295
344
  end
296
345
 
297
346
  def read_buffer_size
298
- # Buffer size for non-SSL reads
347
+ # Buffer size for non-TLS reads
299
348
  # 64kb
300
349
  65536
301
350
  end
302
351
 
352
+ # Writes data to the socket instance.
353
+ #
354
+ # This is a separate method from +write+ for ease of mocking in the tests.
355
+ # This method should not perform any exception mapping, upstream code
356
+ # sholud map exceptions.
357
+ #
358
+ # @param [ Array<Object> ] args The data to be written.
359
+ #
360
+ # @return [ Integer ] The length of bytes written to the socket.
361
+ def do_write(*args)
362
+ # This method used to forward arguments to @socket.write in a
363
+ # single call like so:
364
+ #
365
+ # @socket.write(*args)
366
+ #
367
+ # Turns out, when each buffer to be written is large (e.g. 32 MiB),
368
+ # this write call would take an extremely long time (20+ seconds)
369
+ # while using 100% CPU. Splitting the writes into chunks produced
370
+ # massively better performance (0.05 seconds to write the 32 MiB of
371
+ # data on the same hardware). Unfortunately splitting the data,
372
+ # one would assume, results in it being copied, but this seems to be
373
+ # a much more minor issue compared to CPU cost of writing large buffers.
374
+ args.each do |buf|
375
+ buf = buf.to_s
376
+ i = 0
377
+ while i < buf.length
378
+ chunk = buf[i...i+WRITE_CHUNK_SIZE]
379
+ @socket.write(chunk)
380
+ i += WRITE_CHUNK_SIZE
381
+ end
382
+ end
383
+ end
384
+
303
385
  def unix_socket?(sock)
304
386
  defined?(UNIXSocket) && sock.is_a?(UNIXSocket)
305
387
  end
@@ -308,7 +390,7 @@ module Mongo
308
390
 
309
391
  DEFAULT_TCP_KEEPCNT = 9
310
392
 
311
- DEFAULT_TCP_KEEPIDLE = 300
393
+ DEFAULT_TCP_KEEPIDLE = 120
312
394
 
313
395
  def set_keepalive_opts(sock)
314
396
  sock.setsockopt(SOL_SOCKET, SO_KEEPALIVE, true)
@@ -332,19 +414,19 @@ module Mongo
332
414
  set_keepalive_opts(sock)
333
415
  end
334
416
 
335
- def handle_errors
417
+ def map_exceptions
336
418
  begin
337
419
  yield
338
420
  rescue Errno::ETIMEDOUT => e
339
- raise Error::SocketTimeoutError, "#{e.class}: #{e} (for #{address})"
421
+ raise Error::SocketTimeoutError, "#{e.class}: #{e} (for #{human_address})"
340
422
  rescue IOError, SystemCallError => e
341
- raise Error::SocketError, "#{e.class}: #{e} (for #{address})"
423
+ raise Error::SocketError, "#{e.class}: #{e} (for #{human_address})"
342
424
  rescue OpenSSL::SSL::SSLError => e
343
- raise Error::SocketError, "#{e.class}: #{e} (for #{address}) (#{SSL_ERROR})"
425
+ raise Error::SocketError, "#{e.class}: #{e} (for #{human_address}) (#{SSL_ERROR})"
344
426
  end
345
427
  end
346
428
 
347
- def address
429
+ def human_address
348
430
  raise NotImplementedError
349
431
  end
350
432
  end
@@ -0,0 +1,97 @@
1
+ # Copyright (C) 2020 MongoDB Inc.
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ module Mongo
16
+ class Socket
17
+
18
+ # This module caches OCSP responses for their indicated validity time.
19
+ #
20
+ # The key is the CertificateId used for the OCSP request.
21
+ # The value is the SingleResponse on Ruby 2.4+, or the OpenStruct
22
+ # emulation of it on Ruby 2.3.
23
+ #
24
+ # @api private
25
+ module OcspCache
26
+ module_function def set(cert_id, response)
27
+ delete(cert_id)
28
+ responses << response
29
+ end
30
+
31
+ # Retrieves a cached SingleResponse for the specified CertificateId.
32
+ #
33
+ # This method may return expired responses if they are revoked.
34
+ # Such responses were valid when they were first received.
35
+ #
36
+ # This method may also return responses that are valid but that may
37
+ # expire by the time caller uses them. The caller should not perform
38
+ # update time checks on the returned response.
39
+ #
40
+ # @return [ OpenSSL::OCSP::SingleResponse | OpenStruct ] The previously
41
+ # retrieved response.
42
+ module_function def get(cert_id)
43
+ resp = responses.detect do |resp|
44
+ resp.certid.cmp(cert_id)
45
+ end
46
+ if resp
47
+ # Only expire responses with good status.
48
+ # Once a certificate is revoked, it should stay revoked forever,
49
+ # hence we should be able to cache revoked responses indefinitely.
50
+ if resp.cert_status == OpenSSL::OCSP::V_CERTSTATUS_GOOD &&
51
+ resp.next_update < Time.now
52
+ then
53
+ responses.delete(resp)
54
+ resp = nil
55
+ end
56
+ end
57
+
58
+ # If we have connected to a server and cached the OCSP response for it,
59
+ # and then never connect to that server again, the cached OCSP response
60
+ # is going to remain in memory indefinitely. Periodically remove all
61
+ # expired OCSP responses, not just the ones matching the certificate id
62
+ # we are querying by.
63
+ if rand < 0.01
64
+ responses.delete_if do |resp|
65
+ resp.next_update < Time.now
66
+ end
67
+ end
68
+
69
+ resp
70
+ end
71
+
72
+ module_function def delete(cert_id)
73
+ responses.delete_if do |resp|
74
+ resp.certid.cmp(cert_id)
75
+ end
76
+ end
77
+
78
+ # Clears the driver's OCSP response cache.
79
+ #
80
+ # @note Use Mongo.clear_ocsp_cache from applications instead of invoking
81
+ # this method directly.
82
+ module_function def clear
83
+ responses.replace([])
84
+ end
85
+
86
+ private
87
+
88
+ LOCK = Mutex.new
89
+
90
+ module_function def responses
91
+ LOCK.synchronize do
92
+ @responses ||= []
93
+ end
94
+ end
95
+ end
96
+ end
97
+ end
@@ -0,0 +1,368 @@
1
+ # Copyright (C) 2020 MongoDB Inc.
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ module Net
16
+ autoload :HTTP, 'net/http'
17
+ end
18
+
19
+ module Mongo
20
+ class Socket
21
+
22
+ # OCSP endpoint verifier.
23
+ #
24
+ # After a TLS connection is established, this verifier inspects the
25
+ # certificate presented by the server, and if the certificate contains
26
+ # an OCSP URI, performs the OCSP status request to the specified URI
27
+ # (following up to 5 redirects) to verify the certificate status.
28
+ #
29
+ # @see https://ruby-doc.org/stdlib/libdoc/openssl/rdoc/OpenSSL/OCSP.html
30
+ #
31
+ # @api private
32
+ class OcspVerifier
33
+ include Loggable
34
+
35
+ # @param [ String ] host_name The host name being verified, for
36
+ # diagnostic output.
37
+ # @param [ OpenSSL::X509::Certificate ] cert The certificate presented by
38
+ # the server at host_name.
39
+ # @param [ OpenSSL::X509::Certificate ] ca_cert The CA certificate
40
+ # presented by the server or resolved locally from the server
41
+ # certificate.
42
+ # @param [ OpenSSL::X509::Store ] cert_store The certificate store to
43
+ # use for verifying OCSP response. This should be the same store as
44
+ # used in SSLContext used with the SSLSocket that we are verifying the
45
+ # certificate for. This must NOT be the CA certificate provided by
46
+ # the server (i.e. anything taken out of peer_cert) - otherwise the
47
+ # server would dictate which CA authorities the client trusts.
48
+ def initialize(host_name, cert, ca_cert, cert_store, **opts)
49
+ @host_name = host_name
50
+ @cert = cert
51
+ @ca_cert = ca_cert
52
+ @cert_store = cert_store
53
+ @options = opts
54
+ end
55
+
56
+ attr_reader :host_name
57
+ attr_reader :cert
58
+ attr_reader :ca_cert
59
+ attr_reader :cert_store
60
+ attr_reader :options
61
+
62
+ def timeout
63
+ options[:timeout] || 5
64
+ end
65
+
66
+ # @return [ Array<String> ] OCSP URIs in the specified server certificate.
67
+ def ocsp_uris
68
+ @ocsp_uris ||= begin
69
+ # https://tools.ietf.org/html/rfc3546#section-2.3
70
+ # prohibits multiple extensions with the same oid.
71
+ ext = cert.extensions.detect do |ext|
72
+ ext.oid == 'authorityInfoAccess'
73
+ end
74
+
75
+ if ext
76
+ # Our test certificates have multiple OCSP URIs.
77
+ ext.value.split("\n").select do |line|
78
+ line.start_with?('OCSP - URI:')
79
+ end.map do |line|
80
+ line.split(':', 2).last
81
+ end
82
+ else
83
+ []
84
+ end
85
+ end
86
+ end
87
+
88
+ def cert_id
89
+ @cert_id ||= OpenSSL::OCSP::CertificateId.new(
90
+ cert,
91
+ ca_cert,
92
+ OpenSSL::Digest::SHA1.new,
93
+ )
94
+ end
95
+
96
+ def verify_with_cache
97
+ handle_exceptions do
98
+ return false if ocsp_uris.empty?
99
+
100
+ resp = OcspCache.get(cert_id)
101
+ if resp
102
+ return return_ocsp_response(resp)
103
+ end
104
+
105
+ resp, errors = do_verify
106
+
107
+ if resp
108
+ OcspCache.set(cert_id, resp)
109
+ end
110
+
111
+ return_ocsp_response(resp, errors)
112
+ end
113
+ end
114
+
115
+ # @return [ true | false ] Whether the certificate was verified.
116
+ #
117
+ # @raise [ Error::ServerCertificateRevoked ] If the certificate was
118
+ # definitively revoked.
119
+ def verify
120
+ handle_exceptions do
121
+ return false if ocsp_uris.empty?
122
+
123
+ resp, errors = do_verify
124
+ return_ocsp_response(resp, errors)
125
+ end
126
+ end
127
+
128
+ private
129
+
130
+ def do_verify
131
+ # This synchronized array contains definitive pass/fail responses
132
+ # obtained from the responders. We'll take the first one but due to
133
+ # concurrency multiple responses may be produced and queued.
134
+ @resp_queue = Queue.new
135
+
136
+ # This synchronized array contains strings, one per responder, that
137
+ # explain why each responder hasn't produced a definitive response.
138
+ # These are concatenated and logged if none of the responders produced
139
+ # a definitive respnose, or if the main thread times out waiting for
140
+ # a definitive response (in which case some of the worker threads'
141
+ # diagnostics may be logged and some may not).
142
+ @resp_errors = Queue.new
143
+
144
+ @req = OpenSSL::OCSP::Request.new
145
+ @req.add_certid(cert_id)
146
+ @req.add_nonce
147
+ @serialized_req = @req.to_der
148
+
149
+ @outstanding_requests = ocsp_uris.count
150
+ @outstanding_requests_lock = Mutex.new
151
+
152
+ threads = ocsp_uris.map do |uri|
153
+ Thread.new do
154
+ verify_one_responder(uri)
155
+ end
156
+ end
157
+
158
+ resp = begin
159
+ ::Timeout.timeout(timeout) do
160
+ @resp_queue.shift
161
+ end
162
+ rescue ::Timeout::Error
163
+ nil
164
+ end
165
+
166
+ threads.map(&:kill)
167
+ threads.map(&:join)
168
+
169
+ [resp, @resp_errors]
170
+ end
171
+
172
+ def verify_one_responder(uri)
173
+ original_uri = uri
174
+ redirect_count = 0
175
+ http_response = nil
176
+ loop do
177
+ http_response = begin
178
+ uri = URI(uri)
179
+ Net::HTTP.start(uri.hostname, uri.port) do |http|
180
+ path = uri.path
181
+ if path.empty?
182
+ path = '/'
183
+ end
184
+ http.post(path, @serialized_req,
185
+ 'content-type' => 'application/ocsp-request')
186
+ end
187
+ rescue IOError, SystemCallError => e
188
+ @resp_errors << "OCSP request to #{report_uri(original_uri, uri)} failed: #{e.class}: #{e}"
189
+ return false
190
+ end
191
+
192
+ code = http_response.code.to_i
193
+ if (300..399).include?(code)
194
+ redirected_uri = http_response.header['location']
195
+ uri = ::URI.join(uri, redirected_uri)
196
+ redirect_count += 1
197
+ if redirect_count > 5
198
+ @resp_errors << "OCSP request to #{report_uri(original_uri, uri)} failed: too many redirects (6)"
199
+ return false
200
+ end
201
+ next
202
+ end
203
+
204
+ if code >= 400
205
+ @resp_errors << "OCSP request to #{report_uri(original_uri, uri)} failed with HTTP status code #{http_response.code}" + report_response_body(http_response.body)
206
+ return false
207
+ end
208
+
209
+ if code != 200
210
+ # There must be a body provided with the response, if one isn't
211
+ # provided the response cannot be verified.
212
+ @resp_errors << "OCSP request to #{report_uri(original_uri, uri)} failed with unexpected HTTP status code #{http_response.code}" + report_response_body(http_response.body)
213
+ return false
214
+ end
215
+
216
+ break
217
+ end
218
+
219
+ resp = OpenSSL::OCSP::Response.new(http_response.body).basic
220
+ unless resp.verify([ca_cert], cert_store)
221
+ # Ruby's OpenSSL binding discards error information - see
222
+ # https://github.com/ruby/openssl/issues/395
223
+ @resp_errors << "OCSP response from #{report_uri(original_uri, uri)} failed signature verification; set `OpenSSL.debug = true` to see why"
224
+ return false
225
+ end
226
+
227
+ if @req.check_nonce(resp) == 0
228
+ @resp_errors << "OCSP response from #{report_uri(original_uri, uri)} included invalid nonce"
229
+ return false
230
+ end
231
+
232
+ if resp.respond_to?(:find_response)
233
+ # Ruby 2.4+
234
+ resp = resp.find_response(cert_id)
235
+ # TODO make a new class instead of patching the stdlib one?
236
+ resp.instance_variable_set('@uri', uri)
237
+ resp.instance_variable_set('@original_uri', original_uri)
238
+ class << resp
239
+ attr_reader :uri, :original_uri
240
+ end
241
+ else
242
+ # Ruby 2.3
243
+ found = nil
244
+ resp.status.each do |_cert_id, cert_status, revocation_reason, revocation_time, this_update, next_update, extensions|
245
+ if _cert_id.cmp(cert_id)
246
+ found = OpenStruct.new(
247
+ cert_status: cert_status,
248
+ certid: _cert_id,
249
+ next_update: next_update,
250
+ this_update: this_update,
251
+ revocation_reason: revocation_reason,
252
+ revocation_time: revocation_time,
253
+ extensions: extensions,
254
+ uri: uri,
255
+ original_uri: original_uri,
256
+ )
257
+ class << found
258
+ # Unlike the stdlib method, this one doesn't accept
259
+ # any arguments.
260
+ def check_validity
261
+ now = Time.now
262
+ this_update <= now && next_update >= now
263
+ end
264
+ end
265
+ break
266
+ end
267
+ end
268
+ resp = found
269
+ end
270
+
271
+ unless resp
272
+ @resp_errors << "OCSP response from #{report_uri(original_uri, uri)} did not include information about the requested certificate"
273
+ return false
274
+ end
275
+
276
+ unless resp.check_validity
277
+ @resp_errors << "OCSP response from #{report_uri(original_uri, uri)} was invalid: this_update was in the future or next_update time has passed"
278
+ return false
279
+ end
280
+
281
+ unless [
282
+ OpenSSL::OCSP::V_CERTSTATUS_GOOD,
283
+ OpenSSL::OCSP::V_CERTSTATUS_REVOKED,
284
+ ].include?(resp.cert_status)
285
+ @resp_errors << "OCSP response from #{report_uri(original_uri, uri)} had a non-definitive status: #{resp.cert_status}"
286
+ return false
287
+ end
288
+
289
+ # Note this returns the redirected URI
290
+ @resp_queue << resp
291
+ rescue => exc
292
+ Utils.warn_bg_exception("Error performing OCSP verification for '#{host_name}' via '#{uri}'", exc,
293
+ logger: options[:logger],
294
+ log_prefix: options[:log_prefix],
295
+ bg_error_backtrace: options[:bg_error_backtrace],
296
+ )
297
+ false
298
+ ensure
299
+ @outstanding_requests_lock.synchronize do
300
+ @outstanding_requests -= 1
301
+ if @outstanding_requests == 0
302
+ @resp_queue << nil
303
+ end
304
+ end
305
+ end
306
+
307
+ def return_ocsp_response(resp, errors = nil)
308
+ if resp
309
+ if resp.cert_status == OpenSSL::OCSP::V_CERTSTATUS_REVOKED
310
+ raise_revoked_error(resp)
311
+ end
312
+ true
313
+ else
314
+ reasons = []
315
+ errors.length.times do
316
+ reasons << errors.shift
317
+ end
318
+ if reasons.empty?
319
+ msg = "No responses from responders: #{ocsp_uris.join(', ')} within #{timeout} seconds"
320
+ else
321
+ msg = "For responders #{ocsp_uris.join(', ')} with a timeout of #{timeout} seconds: #{reasons.join(', ')}"
322
+ end
323
+ log_warn("TLS certificate of '#{host_name}' could not be definitively verified via OCSP: #{msg}")
324
+ false
325
+ end
326
+ end
327
+
328
+ def handle_exceptions
329
+ begin
330
+ yield
331
+ rescue Error::ServerCertificateRevoked
332
+ raise
333
+ rescue => exc
334
+ Utils.warn_bg_exception(
335
+ "Error performing OCSP verification for '#{host_name}'",
336
+ exc,
337
+ **options)
338
+ false
339
+ end
340
+ end
341
+
342
+ def raise_revoked_error(resp)
343
+ if resp.uri == resp.original_uri
344
+ redirect = ''
345
+ else
346
+ redirect = " (redirected from #{resp.original_uri})"
347
+ end
348
+ raise Error::ServerCertificateRevoked, "TLS certificate of '#{host_name}' has been revoked according to '#{resp.uri}'#{redirect} for reason '#{resp.revocation_reason}' at '#{resp.revocation_time}'"
349
+ end
350
+
351
+ def report_uri(original_uri, uri)
352
+ if URI(uri) == URI(original_uri)
353
+ uri
354
+ else
355
+ "#{original_uri} (redirected to #{uri})"
356
+ end
357
+ end
358
+
359
+ def report_response_body(body)
360
+ if body
361
+ ": #{body}"
362
+ else
363
+ ''
364
+ end
365
+ end
366
+ end
367
+ end
368
+ end