mongo 2.12.1 → 2.13.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- checksums.yaml.gz.sig +0 -0
- data.tar.gz.sig +0 -0
- data/CONTRIBUTING.md +8 -36
- data/LICENSE +1 -1
- data/README.md +54 -54
- data/Rakefile +16 -10
- data/lib/mongo.rb +8 -3
- data/lib/mongo/active_support.rb +1 -1
- data/lib/mongo/address.rb +78 -37
- data/lib/mongo/address/ipv4.rb +32 -5
- data/lib/mongo/address/ipv6.rb +32 -5
- data/lib/mongo/address/unix.rb +3 -3
- data/lib/mongo/address/validator.rb +1 -1
- data/lib/mongo/auth.rb +36 -13
- data/lib/mongo/auth/aws.rb +37 -0
- data/lib/mongo/auth/aws/conversation.rb +128 -0
- data/lib/mongo/auth/aws/credentials_retriever.rb +219 -0
- data/lib/mongo/auth/aws/request.rb +283 -0
- data/lib/mongo/auth/base.rb +129 -0
- data/lib/mongo/auth/conversation_base.rb +52 -0
- data/lib/mongo/auth/cr.rb +9 -36
- data/lib/mongo/auth/cr/conversation.rb +24 -69
- data/lib/mongo/auth/credential_cache.rb +1 -1
- data/lib/mongo/auth/gssapi.rb +38 -0
- data/lib/mongo/auth/gssapi/conversation.rb +108 -0
- data/lib/mongo/auth/ldap.rb +9 -34
- data/lib/mongo/auth/ldap/conversation.rb +3 -43
- data/lib/mongo/auth/roles.rb +1 -1
- data/lib/mongo/auth/sasl_conversation_base.rb +111 -0
- data/lib/mongo/auth/scram.rb +39 -51
- data/lib/mongo/auth/scram/conversation.rb +12 -506
- data/lib/mongo/auth/scram256.rb +31 -0
- data/lib/mongo/auth/scram256/conversation.rb +63 -0
- data/lib/mongo/auth/scram_conversation_base.rb +402 -0
- data/lib/mongo/auth/stringprep.rb +5 -4
- data/lib/mongo/auth/stringprep/profiles/sasl.rb +2 -1
- data/lib/mongo/auth/stringprep/tables.rb +2 -1
- data/lib/mongo/auth/stringprep/unicode_normalize/normalize.rb +1 -0
- data/lib/mongo/auth/stringprep/unicode_normalize/tables.rb +1 -0
- data/lib/mongo/auth/user.rb +2 -2
- data/lib/mongo/auth/user/view.rb +1 -1
- data/lib/mongo/auth/x509.rb +14 -32
- data/lib/mongo/auth/x509/conversation.rb +15 -42
- data/lib/mongo/background_thread.rb +11 -2
- data/lib/mongo/bson.rb +1 -1
- data/lib/mongo/bulk_write.rb +62 -26
- data/lib/mongo/bulk_write/combineable.rb +20 -8
- data/lib/mongo/bulk_write/ordered_combiner.rb +1 -1
- data/lib/mongo/bulk_write/result.rb +1 -1
- data/lib/mongo/bulk_write/result_combiner.rb +1 -1
- data/lib/mongo/bulk_write/transformable.rb +9 -10
- data/lib/mongo/bulk_write/unordered_combiner.rb +1 -1
- data/lib/mongo/bulk_write/validatable.rb +5 -1
- data/lib/mongo/client.rb +214 -31
- data/lib/mongo/client_encryption.rb +1 -1
- data/lib/mongo/cluster.rb +177 -69
- data/lib/mongo/cluster/periodic_executor.rb +1 -1
- data/lib/mongo/cluster/reapers/cursor_reaper.rb +1 -1
- data/lib/mongo/cluster/reapers/socket_reaper.rb +1 -1
- data/lib/mongo/cluster/sdam_flow.rb +36 -17
- data/lib/mongo/cluster/topology.rb +19 -2
- data/lib/mongo/cluster/topology/base.rb +1 -1
- data/lib/mongo/cluster/topology/no_replica_set_options.rb +1 -1
- data/lib/mongo/cluster/topology/replica_set_no_primary.rb +4 -3
- data/lib/mongo/cluster/topology/replica_set_with_primary.rb +1 -1
- data/lib/mongo/cluster/topology/sharded.rb +2 -2
- data/lib/mongo/cluster/topology/single.rb +2 -2
- data/lib/mongo/cluster/topology/unknown.rb +1 -1
- data/lib/mongo/cluster_time.rb +1 -1
- data/lib/mongo/collection.rb +39 -15
- data/lib/mongo/collection/view.rb +6 -2
- data/lib/mongo/collection/view/aggregation.rb +6 -3
- data/lib/mongo/collection/view/builder.rb +1 -1
- data/lib/mongo/collection/view/builder/aggregation.rb +1 -1
- data/lib/mongo/collection/view/builder/find_command.rb +9 -1
- data/lib/mongo/collection/view/builder/flags.rb +1 -1
- data/lib/mongo/collection/view/builder/map_reduce.rb +1 -1
- data/lib/mongo/collection/view/builder/modifiers.rb +1 -1
- data/lib/mongo/collection/view/builder/op_query.rb +1 -1
- data/lib/mongo/collection/view/change_stream.rb +3 -6
- data/lib/mongo/collection/view/change_stream/retryable.rb +1 -1
- data/lib/mongo/collection/view/explainable.rb +1 -1
- data/lib/mongo/collection/view/immutable.rb +1 -1
- data/lib/mongo/collection/view/iterable.rb +8 -2
- data/lib/mongo/collection/view/map_reduce.rb +7 -4
- data/lib/mongo/collection/view/readable.rb +13 -3
- data/lib/mongo/collection/view/writable.rb +93 -13
- data/lib/mongo/crypt.rb +1 -1
- data/lib/mongo/crypt/auto_decryption_context.rb +1 -1
- data/lib/mongo/crypt/auto_encrypter.rb +1 -1
- data/lib/mongo/crypt/auto_encryption_context.rb +1 -1
- data/lib/mongo/crypt/binary.rb +1 -1
- data/lib/mongo/crypt/binding.rb +1 -1
- data/lib/mongo/crypt/context.rb +1 -1
- data/lib/mongo/crypt/data_key_context.rb +1 -1
- data/lib/mongo/crypt/encryption_io.rb +41 -24
- data/lib/mongo/crypt/explicit_decryption_context.rb +1 -1
- data/lib/mongo/crypt/explicit_encrypter.rb +1 -1
- data/lib/mongo/crypt/explicit_encryption_context.rb +1 -1
- data/lib/mongo/crypt/handle.rb +1 -1
- data/lib/mongo/crypt/hooks.rb +1 -1
- data/lib/mongo/crypt/kms_context.rb +1 -1
- data/lib/mongo/crypt/status.rb +1 -1
- data/lib/mongo/cursor.rb +3 -3
- data/lib/mongo/cursor/builder.rb +1 -1
- data/lib/mongo/cursor/builder/get_more_command.rb +1 -1
- data/lib/mongo/cursor/builder/kill_cursors_command.rb +1 -1
- data/lib/mongo/cursor/builder/op_get_more.rb +1 -1
- data/lib/mongo/cursor/builder/op_kill_cursors.rb +1 -1
- data/lib/mongo/database.rb +35 -5
- data/lib/mongo/database/view.rb +21 -6
- data/lib/mongo/dbref.rb +1 -1
- data/lib/mongo/distinguishing_semaphore.rb +55 -0
- data/lib/mongo/error.rb +28 -2
- data/lib/mongo/error/auth_error.rb +1 -1
- data/lib/mongo/error/bulk_write_error.rb +1 -1
- data/lib/mongo/error/change_stream_resumable.rb +1 -1
- data/lib/mongo/error/closed_stream.rb +1 -1
- data/lib/mongo/error/connection_check_out_timeout.rb +1 -1
- data/lib/mongo/error/connection_perished.rb +23 -0
- data/lib/mongo/error/credential_check_error.rb +26 -0
- data/lib/mongo/error/extra_file_chunk.rb +1 -1
- data/lib/mongo/error/file_not_found.rb +1 -1
- data/lib/mongo/error/handshake_error.rb +1 -1
- data/lib/mongo/error/insufficient_iteration_count.rb +1 -1
- data/lib/mongo/error/invalid_address.rb +1 -1
- data/lib/mongo/error/invalid_application_name.rb +1 -1
- data/lib/mongo/error/invalid_bulk_operation.rb +1 -1
- data/lib/mongo/error/invalid_bulk_operation_type.rb +1 -1
- data/lib/mongo/error/invalid_collection_name.rb +1 -1
- data/lib/mongo/error/invalid_cursor_operation.rb +1 -1
- data/lib/mongo/error/invalid_database_name.rb +1 -1
- data/lib/mongo/error/invalid_document.rb +1 -1
- data/lib/mongo/error/invalid_file.rb +1 -1
- data/lib/mongo/error/invalid_file_revision.rb +1 -1
- data/lib/mongo/error/invalid_min_pool_size.rb +1 -1
- data/lib/mongo/error/invalid_nonce.rb +2 -2
- data/lib/mongo/error/invalid_read_option.rb +1 -1
- data/lib/mongo/error/invalid_replacement_document.rb +1 -1
- data/lib/mongo/error/invalid_server_auth_host.rb +22 -0
- data/lib/mongo/error/invalid_server_auth_response.rb +23 -0
- data/lib/mongo/error/invalid_server_preference.rb +6 -1
- data/lib/mongo/error/invalid_session.rb +3 -2
- data/lib/mongo/error/invalid_signature.rb +1 -1
- data/lib/mongo/error/invalid_transaction_operation.rb +1 -1
- data/lib/mongo/error/invalid_txt_record.rb +1 -1
- data/lib/mongo/error/invalid_update_document.rb +1 -1
- data/lib/mongo/error/invalid_uri.rb +1 -1
- data/lib/mongo/error/invalid_write_concern.rb +1 -1
- data/lib/mongo/error/lint_error.rb +1 -1
- data/lib/mongo/error/max_bson_size.rb +1 -1
- data/lib/mongo/error/max_message_size.rb +1 -1
- data/lib/mongo/error/mismatched_domain.rb +1 -1
- data/lib/mongo/error/missing_file_chunk.rb +1 -1
- data/lib/mongo/error/missing_password.rb +1 -1
- data/lib/mongo/error/missing_resume_token.rb +1 -1
- data/lib/mongo/error/missing_scram_server_signature.rb +27 -0
- data/lib/mongo/error/multi_index_drop.rb +1 -1
- data/lib/mongo/error/need_primary_server.rb +1 -1
- data/lib/mongo/error/no_server_available.rb +1 -1
- data/lib/mongo/error/no_srv_records.rb +1 -1
- data/lib/mongo/error/notable.rb +18 -3
- data/lib/mongo/error/operation_failure.rb +63 -44
- data/lib/mongo/error/parser.rb +16 -5
- data/lib/mongo/error/pool_closed_error.rb +1 -1
- data/lib/mongo/error/raise_original_error.rb +29 -0
- data/lib/mongo/error/session_ended.rb +1 -1
- data/lib/mongo/error/sessions_not_supported.rb +35 -0
- data/lib/mongo/error/socket_error.rb +1 -1
- data/lib/mongo/error/socket_timeout_error.rb +1 -1
- data/lib/mongo/error/unchangeable_collection_option.rb +1 -1
- data/lib/mongo/error/unexpected_chunk_length.rb +1 -1
- data/lib/mongo/error/unexpected_response.rb +1 -1
- data/lib/mongo/error/unknown_payload_type.rb +1 -1
- data/lib/mongo/error/unsupported_array_filters.rb +7 -2
- data/lib/mongo/error/unsupported_collation.rb +7 -2
- data/lib/mongo/error/unsupported_features.rb +1 -1
- data/lib/mongo/error/unsupported_message_type.rb +1 -1
- data/lib/mongo/error/unsupported_option.rb +99 -0
- data/lib/mongo/error/write_retryable.rb +1 -1
- data/lib/mongo/event.rb +1 -1
- data/lib/mongo/event/base.rb +7 -1
- data/lib/mongo/event/listeners.rb +1 -1
- data/lib/mongo/event/publisher.rb +1 -1
- data/lib/mongo/event/subscriber.rb +1 -1
- data/lib/mongo/grid.rb +1 -1
- data/lib/mongo/grid/file.rb +6 -1
- data/lib/mongo/grid/file/chunk.rb +3 -1
- data/lib/mongo/grid/file/info.rb +1 -1
- data/lib/mongo/grid/fs_bucket.rb +22 -15
- data/lib/mongo/grid/stream.rb +1 -1
- data/lib/mongo/grid/stream/read.rb +1 -1
- data/lib/mongo/grid/stream/write.rb +10 -4
- data/lib/mongo/id.rb +1 -1
- data/lib/mongo/index.rb +2 -1
- data/lib/mongo/index/view.rb +61 -11
- data/lib/mongo/lint.rb +10 -0
- data/lib/mongo/loggable.rb +1 -1
- data/lib/mongo/logger.rb +1 -1
- data/lib/mongo/monitoring.rb +39 -1
- data/lib/mongo/monitoring/cmap_log_subscriber.rb +1 -1
- data/lib/mongo/monitoring/command_log_subscriber.rb +20 -5
- data/lib/mongo/monitoring/event.rb +1 -1
- data/lib/mongo/monitoring/event/cmap.rb +1 -1
- data/lib/mongo/monitoring/event/cmap/base.rb +1 -1
- data/lib/mongo/monitoring/event/cmap/connection_check_out_failed.rb +1 -1
- data/lib/mongo/monitoring/event/cmap/connection_check_out_started.rb +1 -1
- data/lib/mongo/monitoring/event/cmap/connection_checked_in.rb +1 -1
- data/lib/mongo/monitoring/event/cmap/connection_checked_out.rb +1 -1
- data/lib/mongo/monitoring/event/cmap/connection_closed.rb +1 -1
- data/lib/mongo/monitoring/event/cmap/connection_created.rb +1 -1
- data/lib/mongo/monitoring/event/cmap/connection_ready.rb +1 -1
- data/lib/mongo/monitoring/event/cmap/pool_cleared.rb +1 -1
- data/lib/mongo/monitoring/event/cmap/pool_closed.rb +1 -1
- data/lib/mongo/monitoring/event/cmap/pool_created.rb +1 -1
- data/lib/mongo/monitoring/event/command_failed.rb +12 -1
- data/lib/mongo/monitoring/event/command_started.rb +44 -3
- data/lib/mongo/monitoring/event/command_succeeded.rb +12 -1
- data/lib/mongo/monitoring/event/secure.rb +8 -2
- data/lib/mongo/monitoring/event/server_closed.rb +2 -2
- data/lib/mongo/monitoring/event/server_description_changed.rb +28 -5
- data/lib/mongo/monitoring/event/server_heartbeat_failed.rb +10 -3
- data/lib/mongo/monitoring/event/server_heartbeat_started.rb +10 -3
- data/lib/mongo/monitoring/event/server_heartbeat_succeeded.rb +10 -3
- data/lib/mongo/monitoring/event/server_opening.rb +2 -2
- data/lib/mongo/monitoring/event/topology_changed.rb +2 -2
- data/lib/mongo/monitoring/event/topology_closed.rb +2 -2
- data/lib/mongo/monitoring/event/topology_opening.rb +2 -2
- data/lib/mongo/monitoring/publishable.rb +9 -9
- data/lib/mongo/monitoring/sdam_log_subscriber.rb +1 -1
- data/lib/mongo/monitoring/server_closed_log_subscriber.rb +1 -1
- data/lib/mongo/monitoring/server_description_changed_log_subscriber.rb +10 -2
- data/lib/mongo/monitoring/server_opening_log_subscriber.rb +1 -1
- data/lib/mongo/monitoring/topology_changed_log_subscriber.rb +2 -2
- data/lib/mongo/monitoring/topology_closed_log_subscriber.rb +1 -1
- data/lib/mongo/monitoring/topology_opening_log_subscriber.rb +1 -1
- data/lib/mongo/monitoring/unified_sdam_log_subscriber.rb +1 -1
- data/lib/mongo/operation.rb +1 -0
- data/lib/mongo/operation/aggregate.rb +1 -1
- data/lib/mongo/operation/aggregate/command.rb +5 -5
- data/lib/mongo/operation/aggregate/op_msg.rb +1 -1
- data/lib/mongo/operation/aggregate/result.rb +1 -1
- data/lib/mongo/operation/collections_info.rb +3 -36
- data/lib/mongo/operation/collections_info/command.rb +40 -0
- data/lib/mongo/operation/collections_info/result.rb +1 -1
- data/lib/mongo/operation/command.rb +1 -1
- data/lib/mongo/operation/command/command.rb +3 -3
- data/lib/mongo/operation/command/op_msg.rb +1 -1
- data/lib/mongo/operation/count.rb +1 -1
- data/lib/mongo/operation/count/command.rb +3 -3
- data/lib/mongo/operation/count/op_msg.rb +1 -1
- data/lib/mongo/operation/create.rb +1 -1
- data/lib/mongo/operation/create/command.rb +3 -3
- data/lib/mongo/operation/create/op_msg.rb +1 -1
- data/lib/mongo/operation/create_index.rb +1 -1
- data/lib/mongo/operation/create_index/command.rb +4 -4
- data/lib/mongo/operation/create_index/op_msg.rb +6 -3
- data/lib/mongo/operation/create_user.rb +1 -1
- data/lib/mongo/operation/create_user/command.rb +4 -4
- data/lib/mongo/operation/create_user/op_msg.rb +2 -2
- data/lib/mongo/operation/delete.rb +1 -1
- data/lib/mongo/operation/delete/bulk_result.rb +1 -1
- data/lib/mongo/operation/delete/command.rb +4 -4
- data/lib/mongo/operation/delete/legacy.rb +2 -2
- data/lib/mongo/operation/delete/op_msg.rb +4 -4
- data/lib/mongo/operation/delete/result.rb +2 -2
- data/lib/mongo/operation/distinct.rb +1 -1
- data/lib/mongo/operation/distinct/command.rb +3 -3
- data/lib/mongo/operation/distinct/op_msg.rb +1 -1
- data/lib/mongo/operation/drop.rb +1 -1
- data/lib/mongo/operation/drop/command.rb +3 -3
- data/lib/mongo/operation/drop/op_msg.rb +1 -1
- data/lib/mongo/operation/drop_database.rb +1 -1
- data/lib/mongo/operation/drop_database/command.rb +3 -3
- data/lib/mongo/operation/drop_database/op_msg.rb +1 -1
- data/lib/mongo/operation/drop_index.rb +1 -1
- data/lib/mongo/operation/drop_index/command.rb +4 -4
- data/lib/mongo/operation/drop_index/op_msg.rb +2 -2
- data/lib/mongo/operation/explain.rb +1 -1
- data/lib/mongo/operation/explain/command.rb +3 -3
- data/lib/mongo/operation/explain/legacy.rb +3 -3
- data/lib/mongo/operation/explain/op_msg.rb +1 -1
- data/lib/mongo/operation/explain/result.rb +1 -1
- data/lib/mongo/operation/find.rb +1 -1
- data/lib/mongo/operation/find/command.rb +3 -3
- data/lib/mongo/operation/find/legacy.rb +3 -3
- data/lib/mongo/operation/find/legacy/result.rb +1 -1
- data/lib/mongo/operation/find/op_msg.rb +2 -12
- data/lib/mongo/operation/find/result.rb +1 -1
- data/lib/mongo/operation/get_more.rb +1 -1
- data/lib/mongo/operation/get_more/command.rb +3 -3
- data/lib/mongo/operation/get_more/legacy.rb +2 -2
- data/lib/mongo/operation/get_more/op_msg.rb +2 -12
- data/lib/mongo/operation/get_more/result.rb +1 -1
- data/lib/mongo/operation/indexes.rb +1 -1
- data/lib/mongo/operation/indexes/command.rb +3 -3
- data/lib/mongo/operation/indexes/legacy.rb +4 -4
- data/lib/mongo/operation/indexes/op_msg.rb +1 -1
- data/lib/mongo/operation/indexes/result.rb +1 -1
- data/lib/mongo/operation/insert.rb +3 -2
- data/lib/mongo/operation/insert/bulk_result.rb +6 -2
- data/lib/mongo/operation/insert/command.rb +7 -7
- data/lib/mongo/operation/insert/legacy.rb +9 -5
- data/lib/mongo/operation/insert/op_msg.rb +6 -6
- data/lib/mongo/operation/insert/result.rb +7 -4
- data/lib/mongo/operation/kill_cursors.rb +1 -1
- data/lib/mongo/operation/kill_cursors/command.rb +3 -3
- data/lib/mongo/operation/kill_cursors/legacy.rb +2 -2
- data/lib/mongo/operation/kill_cursors/op_msg.rb +1 -1
- data/lib/mongo/operation/list_collections.rb +1 -1
- data/lib/mongo/operation/list_collections/command.rb +4 -4
- data/lib/mongo/operation/list_collections/op_msg.rb +2 -2
- data/lib/mongo/operation/list_collections/result.rb +1 -1
- data/lib/mongo/operation/map_reduce.rb +1 -1
- data/lib/mongo/operation/map_reduce/command.rb +3 -3
- data/lib/mongo/operation/map_reduce/op_msg.rb +1 -1
- data/lib/mongo/operation/map_reduce/result.rb +1 -1
- data/lib/mongo/operation/op_msg_base.rb +3 -3
- data/lib/mongo/operation/parallel_scan.rb +1 -1
- data/lib/mongo/operation/parallel_scan/command.rb +5 -5
- data/lib/mongo/operation/parallel_scan/op_msg.rb +2 -2
- data/lib/mongo/operation/parallel_scan/result.rb +1 -1
- data/lib/mongo/operation/remove_user.rb +1 -1
- data/lib/mongo/operation/remove_user/command.rb +4 -4
- data/lib/mongo/operation/remove_user/op_msg.rb +2 -2
- data/lib/mongo/operation/result.rb +28 -4
- data/lib/mongo/operation/shared/bypass_document_validation.rb +10 -4
- data/lib/mongo/operation/shared/causal_consistency_supported.rb +3 -3
- data/lib/mongo/operation/shared/collections_info_or_list_collections.rb +56 -0
- data/lib/mongo/operation/shared/executable.rb +46 -28
- data/lib/mongo/operation/shared/executable_no_validate.rb +3 -3
- data/lib/mongo/operation/shared/executable_transaction_label.rb +1 -1
- data/lib/mongo/operation/shared/idable.rb +1 -1
- data/lib/mongo/operation/shared/limited.rb +10 -2
- data/lib/mongo/operation/shared/object_id_generator.rb +1 -1
- data/lib/mongo/operation/shared/op_msg_or_command.rb +7 -5
- data/lib/mongo/operation/shared/op_msg_or_find_command.rb +8 -6
- data/lib/mongo/operation/shared/op_msg_or_list_indexes_command.rb +8 -6
- data/lib/mongo/operation/shared/polymorphic_lookup.rb +1 -1
- data/lib/mongo/operation/shared/polymorphic_result.rb +1 -1
- data/lib/mongo/operation/shared/read_preference_supported.rb +19 -16
- data/lib/mongo/operation/shared/response_handling.rb +83 -8
- data/lib/mongo/operation/shared/result/aggregatable.rb +1 -1
- data/lib/mongo/operation/shared/result/use_legacy_error_parser.rb +1 -1
- data/lib/mongo/operation/shared/sessions_supported.rb +50 -27
- data/lib/mongo/operation/shared/specifiable.rb +32 -20
- data/lib/mongo/operation/shared/write.rb +25 -19
- data/lib/mongo/operation/shared/write_concern_supported.rb +6 -6
- data/lib/mongo/operation/update.rb +1 -1
- data/lib/mongo/operation/update/bulk_result.rb +1 -1
- data/lib/mongo/operation/update/command.rb +4 -4
- data/lib/mongo/operation/update/legacy.rb +2 -2
- data/lib/mongo/operation/update/legacy/result.rb +1 -1
- data/lib/mongo/operation/update/op_msg.rb +4 -4
- data/lib/mongo/operation/update/result.rb +2 -2
- data/lib/mongo/operation/update_user.rb +1 -1
- data/lib/mongo/operation/update_user/command.rb +4 -4
- data/lib/mongo/operation/update_user/op_msg.rb +2 -2
- data/lib/mongo/operation/users_info.rb +1 -1
- data/lib/mongo/operation/users_info/command.rb +4 -4
- data/lib/mongo/operation/users_info/op_msg.rb +2 -2
- data/lib/mongo/operation/users_info/result.rb +1 -1
- data/lib/mongo/options.rb +1 -1
- data/lib/mongo/options/mapper.rb +1 -1
- data/lib/mongo/options/redacted.rb +1 -1
- data/lib/mongo/protocol/bit_vector.rb +1 -1
- data/lib/mongo/protocol/compressed.rb +1 -1
- data/lib/mongo/protocol/delete.rb +1 -1
- data/lib/mongo/protocol/get_more.rb +1 -1
- data/lib/mongo/protocol/insert.rb +1 -1
- data/lib/mongo/protocol/kill_cursors.rb +1 -1
- data/lib/mongo/protocol/message.rb +37 -9
- data/lib/mongo/protocol/msg.rb +37 -4
- data/lib/mongo/protocol/query.rb +1 -1
- data/lib/mongo/protocol/registry.rb +1 -1
- data/lib/mongo/protocol/reply.rb +1 -1
- data/lib/mongo/protocol/serializers.rb +6 -3
- data/lib/mongo/protocol/update.rb +1 -1
- data/lib/mongo/retryable.rb +23 -10
- data/lib/mongo/semaphore.rb +1 -1
- data/lib/mongo/server.rb +40 -8
- data/lib/mongo/server/app_metadata.rb +44 -7
- data/lib/mongo/server/connection.rb +37 -133
- data/lib/mongo/server/connection_base.rb +56 -15
- data/lib/mongo/server/connection_common.rb +75 -1
- data/lib/mongo/server/connection_pool.rb +20 -1
- data/lib/mongo/server/connection_pool/populator.rb +1 -1
- data/lib/mongo/server/context.rb +1 -1
- data/lib/mongo/server/description.rb +49 -2
- data/lib/mongo/server/description/features.rb +12 -3
- data/lib/mongo/server/monitor.rb +145 -69
- data/lib/mongo/server/monitor/app_metadata.rb +1 -1
- data/lib/mongo/server/monitor/connection.rb +110 -80
- data/lib/mongo/server/pending_connection.rb +215 -3
- data/lib/mongo/server/push_monitor.rb +173 -0
- data/{spec/runners/transactions/context.rb → lib/mongo/server/push_monitor/connection.rb} +9 -14
- data/lib/mongo/server/round_trip_time_averager.rb +12 -3
- data/lib/mongo/server_selector.rb +2 -2
- data/lib/mongo/server_selector/{selectable.rb → base.rb} +159 -86
- data/lib/mongo/server_selector/nearest.rb +26 -21
- data/lib/mongo/server_selector/primary.rb +24 -28
- data/lib/mongo/server_selector/primary_preferred.rb +32 -25
- data/lib/mongo/server_selector/secondary.rb +26 -21
- data/lib/mongo/server_selector/secondary_preferred.rb +29 -34
- data/lib/mongo/session.rb +14 -1
- data/lib/mongo/session/server_session.rb +1 -1
- data/lib/mongo/session/session_pool.rb +1 -1
- data/lib/mongo/socket.rb +121 -41
- data/lib/mongo/socket/ssl.rb +98 -35
- data/lib/mongo/socket/tcp.rb +39 -31
- data/lib/mongo/socket/unix.rb +14 -6
- data/lib/mongo/srv.rb +1 -1
- data/lib/mongo/srv/monitor.rb +1 -1
- data/lib/mongo/srv/resolver.rb +1 -1
- data/lib/mongo/srv/result.rb +1 -1
- data/lib/mongo/timeout.rb +9 -9
- data/lib/mongo/topology_version.rb +89 -0
- data/lib/mongo/uri.rb +61 -47
- data/lib/mongo/uri/srv_protocol.rb +9 -1
- data/lib/mongo/utils.rb +62 -0
- data/lib/mongo/version.rb +2 -2
- data/lib/mongo/write_concern.rb +1 -1
- data/lib/mongo/write_concern/acknowledged.rb +1 -1
- data/lib/mongo/write_concern/base.rb +1 -1
- data/lib/mongo/write_concern/unacknowledged.rb +1 -1
- data/mongo.gemspec +1 -1
- data/spec/NOTES.aws-auth.md +291 -0
- data/spec/README.aws-auth.md +318 -0
- data/spec/README.md +64 -17
- data/spec/integration/auth_spec.rb +29 -9
- data/spec/integration/awaited_ismaster_spec.rb +28 -0
- data/spec/integration/aws_auth_request_spec.rb +74 -0
- data/spec/integration/aws_credentials_retriever_spec.rb +103 -0
- data/spec/integration/bulk_write_spec.rb +19 -0
- data/spec/integration/change_stream_examples_spec.rb +6 -2
- data/spec/integration/change_stream_spec.rb +123 -51
- data/spec/integration/check_clean_slate_spec.rb +16 -0
- data/spec/integration/client_construction_aws_auth_spec.rb +191 -0
- data/spec/integration/client_construction_spec.rb +2 -1
- data/spec/integration/client_side_encryption/auto_encryption_bulk_writes_spec.rb +3 -3
- data/spec/integration/collection_indexes_prose_spec.rb +55 -0
- data/spec/integration/command_monitoring_spec.rb +30 -6
- data/spec/integration/command_spec.rb +11 -9
- data/spec/integration/connect_single_rs_name_spec.rb +10 -5
- data/spec/integration/connection_spec.rb +7 -3
- data/spec/integration/crud_spec.rb +32 -4
- data/spec/integration/cursor_reaping_spec.rb +14 -10
- data/spec/integration/docs_examples_spec.rb +6 -0
- data/spec/integration/fork_reconnect_spec.rb +143 -0
- data/spec/integration/get_more_spec.rb +10 -3
- data/spec/integration/grid_fs_bucket_spec.rb +48 -0
- data/spec/integration/heartbeat_events_spec.rb +5 -24
- data/spec/integration/read_concern_spec.rb +1 -1
- data/spec/integration/read_preference_spec.rb +41 -11
- data/spec/integration/reconnect_spec.rb +2 -3
- data/spec/integration/retryable_errors_spec.rb +33 -14
- data/spec/integration/{retryable_writes_spec.rb → retryable_writes/retryable_writes_36_and_older_spec.rb} +55 -51
- data/spec/integration/retryable_writes/retryable_writes_40_and_newer_spec.rb +401 -0
- data/spec/integration/retryable_writes/shared/adds_diagnostics.rb +15 -0
- data/spec/integration/retryable_writes/shared/does_not_support_retries.rb +24 -0
- data/spec/integration/retryable_writes/shared/only_supports_legacy_retries.rb +25 -0
- data/spec/integration/retryable_writes/shared/performs_legacy_retries.rb +215 -0
- data/spec/integration/retryable_writes/shared/performs_modern_retries.rb +232 -0
- data/spec/integration/retryable_writes/shared/performs_no_retries.rb +110 -0
- data/spec/integration/retryable_writes/shared/supports_legacy_retries.rb +19 -0
- data/spec/integration/retryable_writes/shared/supports_modern_retries.rb +25 -0
- data/spec/integration/retryable_writes/shared/supports_retries.rb +16 -0
- data/spec/integration/sdam_error_handling_spec.rb +142 -22
- data/spec/integration/sdam_events_spec.rb +77 -5
- data/spec/integration/sdam_prose_spec.rb +64 -0
- data/spec/integration/server_monitor_spec.rb +25 -1
- data/spec/integration/server_spec.rb +42 -26
- data/spec/integration/size_limit_spec.rb +26 -9
- data/spec/integration/ssl_uri_options_spec.rb +2 -2
- data/spec/integration/step_down_spec.rb +15 -15
- data/spec/integration/transactions_api_examples_spec.rb +59 -0
- data/spec/integration/transactions_examples_spec.rb +5 -2
- data/spec/integration/x509_auth_spec.rb +109 -0
- data/spec/integration/zlib_compression_spec.rb +25 -0
- data/spec/kerberos/kerberos_spec.rb +10 -6
- data/spec/lite_spec_helper.rb +31 -22
- data/spec/mongo/address/ipv4_spec.rb +1 -1
- data/spec/mongo/address_spec.rb +2 -2
- data/spec/mongo/auth/aws/request_region_spec.rb +42 -0
- data/spec/mongo/auth/aws/request_spec.rb +76 -0
- data/spec/mongo/auth/cr_spec.rb +7 -7
- data/spec/mongo/auth/gssapi/conversation_spec.rb +121 -0
- data/spec/mongo/auth/invalid_mechanism_spec.rb +1 -1
- data/spec/mongo/auth/ldap/conversation_spec.rb +1 -1
- data/spec/mongo/auth/ldap_spec.rb +3 -3
- data/spec/mongo/auth/scram/conversation_spec.rb +119 -334
- data/spec/mongo/auth/scram256/conversation_spec.rb +171 -0
- data/spec/mongo/auth/{scram/negotiation_spec.rb → scram_negotiation_spec.rb} +13 -8
- data/spec/mongo/auth/scram_spec.rb +29 -69
- data/spec/mongo/auth/user_spec.rb +1 -1
- data/spec/mongo/auth/x509/conversation_spec.rb +1 -1
- data/spec/mongo/auth/x509_spec.rb +8 -8
- data/spec/mongo/auth_spec.rb +4 -4
- data/spec/mongo/bulk_write_spec.rb +206 -2
- data/spec/mongo/client_construction_spec.rb +609 -86
- data/spec/mongo/client_spec.rb +59 -5
- data/spec/mongo/cluster/topology/replica_set_spec.rb +52 -9
- data/spec/mongo/cluster/topology/single_spec.rb +4 -2
- data/spec/mongo/cluster_spec.rb +37 -36
- data/spec/mongo/collection/view/aggregation_spec.rb +6 -2
- data/spec/mongo/collection/view/builder/find_command_spec.rb +17 -6
- data/spec/mongo/collection/view/change_stream_resume_spec.rb +392 -0
- data/spec/mongo/collection/view/change_stream_spec.rb +0 -318
- data/spec/mongo/collection/view/iterable_spec.rb +38 -0
- data/spec/mongo/collection/view/map_reduce_spec.rb +6 -2
- data/spec/mongo/collection/view/readable_spec.rb +15 -1
- data/spec/mongo/collection/view/writable_spec.rb +208 -1
- data/spec/mongo/collection_spec.rb +531 -43
- data/spec/mongo/cursor/builder/get_more_command_spec.rb +6 -1
- data/spec/mongo/cursor/builder/op_get_more_spec.rb +6 -1
- data/spec/mongo/cursor/builder/op_kill_cursors_spec.rb +6 -1
- data/spec/mongo/cursor_spec.rb +9 -1
- data/spec/mongo/database_spec.rb +251 -10
- data/spec/mongo/distinguishing_semaphore_spec.rb +63 -0
- data/spec/mongo/error/operation_failure_heavy_spec.rb +58 -0
- data/spec/mongo/error/operation_failure_spec.rb +167 -69
- data/spec/mongo/error/unsupported_option_spec.rb +54 -0
- data/spec/mongo/grid/fs_bucket_spec.rb +18 -0
- data/spec/mongo/grid/stream/write_spec.rb +32 -0
- data/spec/mongo/index/view_spec.rb +312 -0
- data/spec/mongo/monitoring/event/server_description_changed_spec.rb +1 -4
- data/spec/mongo/operation/aggregate/result_spec.rb +6 -1
- data/spec/mongo/operation/delete/bulk_spec.rb +18 -6
- data/spec/mongo/operation/delete/op_msg_spec.rb +22 -14
- data/spec/mongo/operation/find/legacy_spec.rb +27 -7
- data/spec/mongo/operation/get_more_spec.rb +6 -1
- data/spec/mongo/operation/insert/bulk_spec.rb +21 -7
- data/spec/mongo/operation/insert/command_spec.rb +4 -0
- data/spec/mongo/operation/insert/op_msg_spec.rb +22 -14
- data/spec/mongo/operation/limited_spec.rb +5 -3
- data/spec/mongo/operation/read_preference_legacy_spec.rb +16 -4
- data/spec/mongo/operation/read_preference_op_msg_spec.rb +115 -5
- data/spec/mongo/operation/result_spec.rb +6 -1
- data/spec/mongo/operation/update/bulk_spec.rb +18 -6
- data/spec/mongo/operation/update/command_spec.rb +4 -0
- data/spec/mongo/operation/update/op_msg_spec.rb +22 -14
- data/spec/mongo/protocol/msg_spec.rb +10 -0
- data/spec/mongo/retryable_spec.rb +71 -70
- data/spec/mongo/semaphore_spec.rb +51 -0
- data/spec/mongo/server/app_metadata_shared.rb +136 -0
- data/spec/mongo/server/app_metadata_spec.rb +8 -1
- data/spec/mongo/server/connection_auth_spec.rb +33 -14
- data/spec/mongo/server/connection_pool_spec.rb +0 -31
- data/spec/mongo/server/connection_spec.rb +118 -71
- data/spec/mongo/server/monitor/app_metadata_spec.rb +8 -1
- data/spec/mongo/server/monitor/connection_spec.rb +1 -82
- data/spec/mongo/server/monitor_spec.rb +76 -17
- data/spec/mongo/server/round_trip_time_averager_spec.rb +5 -3
- data/spec/mongo/server_selector/nearest_spec.rb +24 -23
- data/spec/mongo/server_selector/primary_preferred_spec.rb +27 -26
- data/spec/mongo/server_selector/primary_spec.rb +27 -9
- data/spec/mongo/server_selector/secondary_preferred_spec.rb +40 -23
- data/spec/mongo/server_selector/secondary_spec.rb +19 -18
- data/spec/mongo/server_selector_spec.rb +4 -5
- data/spec/mongo/session/session_pool_spec.rb +7 -3
- data/spec/mongo/session_spec.rb +35 -0
- data/spec/mongo/socket/ssl_spec.rb +2 -2
- data/spec/mongo/socket/tcp_spec.rb +2 -2
- data/spec/mongo/socket/unix_spec.rb +2 -2
- data/spec/mongo/socket_spec.rb +9 -9
- data/spec/mongo/timeout_spec.rb +22 -68
- data/spec/mongo/uri_spec.rb +21 -6
- data/spec/runners/auth.rb +5 -6
- data/spec/runners/change_streams/outcome.rb +42 -0
- data/spec/runners/change_streams/spec.rb +57 -0
- data/spec/runners/change_streams/test.rb +229 -0
- data/spec/runners/cmap.rb +1 -1
- data/spec/runners/cmap/verifier.rb +1 -1
- data/spec/runners/command_monitoring.rb +4 -35
- data/spec/runners/connection_string.rb +3 -2
- data/spec/runners/crud.rb +2 -2
- data/spec/runners/crud/context.rb +10 -6
- data/spec/runners/crud/operation.rb +177 -55
- data/spec/runners/crud/outcome.rb +1 -1
- data/spec/runners/crud/spec.rb +0 -7
- data/spec/runners/crud/test.rb +8 -26
- data/spec/runners/crud/test_base.rb +47 -0
- data/spec/runners/crud/verifier.rb +21 -3
- data/spec/runners/gridfs.rb +1 -1
- data/spec/runners/{server_discovery_and_monitoring.rb → sdam.rb} +41 -22
- data/spec/runners/sdam/verifier.rb +26 -8
- data/spec/runners/server_selection.rb +242 -28
- data/spec/runners/transactions.rb +13 -14
- data/spec/runners/transactions/operation.rb +155 -25
- data/spec/runners/transactions/spec.rb +1 -1
- data/spec/runners/transactions/test.rb +103 -65
- data/spec/spec_tests/auth_spec.rb +2 -0
- data/spec/spec_tests/change_streams_spec.rb +39 -4
- data/spec/spec_tests/client_side_encryption_spec.rb +3 -0
- data/spec/spec_tests/cmap_spec.rb +5 -0
- data/spec/spec_tests/command_monitoring_spec.rb +25 -12
- data/spec/spec_tests/connection_string_spec.rb +2 -0
- data/spec/spec_tests/crud_spec.rb +3 -1
- data/spec/spec_tests/data/auth/connection-string.yml +57 -1
- data/spec/spec_tests/data/change_streams/change-streams-errors.yml +27 -1
- data/spec/spec_tests/data/change_streams/change-streams-resume-errorLabels.yml +1105 -0
- data/spec/spec_tests/data/change_streams/change-streams-resume-whitelist.yml +1173 -0
- data/spec/spec_tests/data/change_streams/change-streams.yml +5 -4
- data/spec/spec_tests/data/crud_v2/aggregate-merge.yml +1 -1
- data/spec/spec_tests/data/crud_v2/bulkWrite-arrayFilters.yml +33 -11
- data/spec/spec_tests/data/crud_v2/bulkWrite-delete-hint-clientError.yml +63 -0
- data/spec/spec_tests/data/crud_v2/bulkWrite-delete-hint-serverError.yml +92 -0
- data/spec/spec_tests/data/crud_v2/bulkWrite-delete-hint.yml +103 -0
- data/spec/spec_tests/data/crud_v2/bulkWrite-update-hint-clientError.yml +90 -0
- data/spec/spec_tests/data/crud_v2/bulkWrite-update-hint-serverError.yml +147 -0
- data/spec/spec_tests/data/crud_v2/bulkWrite-update-hint.yml +164 -0
- data/spec/spec_tests/data/crud_v2/deleteMany-hint-clientError.yml +43 -0
- data/spec/spec_tests/data/crud_v2/deleteMany-hint-serverError.yml +62 -0
- data/spec/spec_tests/data/crud_v2/deleteMany-hint.yml +58 -0
- data/spec/spec_tests/data/crud_v2/deleteOne-hint-clientError.yml +41 -0
- data/spec/spec_tests/data/crud_v2/deleteOne-hint-serverError.yml +60 -0
- data/spec/spec_tests/data/crud_v2/deleteOne-hint.yml +57 -0
- data/spec/spec_tests/data/crud_v2/find-allowdiskuse-clientError.yml +28 -0
- data/spec/spec_tests/data/crud_v2/find-allowdiskuse-serverError.yml +44 -0
- data/spec/spec_tests/data/crud_v2/find-allowdiskuse.yml +50 -0
- data/spec/spec_tests/data/crud_v2/findOneAndDelete-hint-clientError.yml +45 -0
- data/spec/spec_tests/data/crud_v2/findOneAndDelete-hint-serverError.yml +60 -0
- data/spec/spec_tests/data/crud_v2/findOneAndDelete-hint.yml +56 -0
- data/spec/spec_tests/data/crud_v2/findOneAndReplace-hint-clientError.yml +40 -0
- data/spec/spec_tests/data/crud_v2/findOneAndReplace-hint-serverError.yml +59 -0
- data/spec/spec_tests/data/crud_v2/findOneAndReplace-hint.yml +55 -0
- data/spec/spec_tests/data/crud_v2/findOneAndUpdate-hint-clientError.yml +40 -0
- data/spec/spec_tests/data/crud_v2/findOneAndUpdate-hint-serverError.yml +58 -0
- data/spec/spec_tests/data/crud_v2/findOneAndUpdate-hint.yml +55 -0
- data/spec/spec_tests/data/crud_v2/replaceOne-hint.yml +61 -0
- data/spec/spec_tests/data/crud_v2/unacknowledged-bulkWrite-delete-hint-clientError.yml +60 -0
- data/spec/spec_tests/data/crud_v2/unacknowledged-bulkWrite-update-hint-clientError.yml +88 -0
- data/spec/spec_tests/data/crud_v2/unacknowledged-deleteMany-hint-clientError.yml +40 -0
- data/spec/spec_tests/data/crud_v2/unacknowledged-deleteOne-hint-clientError.yml +38 -0
- data/spec/spec_tests/data/crud_v2/unacknowledged-findOneAndDelete-hint-clientError.yml +42 -0
- data/spec/spec_tests/data/crud_v2/unacknowledged-findOneAndReplace-hint-clientError.yml +40 -0
- data/spec/spec_tests/data/crud_v2/unacknowledged-findOneAndUpdate-hint-clientError.yml +40 -0
- data/spec/spec_tests/data/crud_v2/unacknowledged-replaceOne-hint-clientError.yml +40 -0
- data/spec/spec_tests/data/crud_v2/unacknowledged-updateMany-hint-clientError.yml +43 -0
- data/spec/spec_tests/data/crud_v2/unacknowledged-updateOne-hint-clientError.yml +40 -0
- data/spec/spec_tests/data/crud_v2/updateMany-hint-clientError.yml +45 -0
- data/spec/spec_tests/data/crud_v2/updateMany-hint-serverError.yml +66 -0
- data/spec/spec_tests/data/crud_v2/updateMany-hint.yml +65 -0
- data/spec/spec_tests/data/crud_v2/updateOne-hint-clientError.yml +43 -0
- data/spec/spec_tests/data/crud_v2/updateOne-hint-serverError.yml +62 -0
- data/spec/spec_tests/data/crud_v2/updateOne-hint.yml +61 -0
- data/spec/spec_tests/data/crud_v2/updateWithPipelines.yml +65 -0
- data/spec/spec_tests/data/dns_seedlist_discovery/direct-connection-false.yml +10 -0
- data/spec/spec_tests/data/dns_seedlist_discovery/direct-connection-true.yml +5 -0
- data/spec/spec_tests/data/max_staleness/ReplicaSetNoPrimary/MaxStalenessTooSmall.yml +15 -0
- data/spec/spec_tests/data/max_staleness/ReplicaSetNoPrimary/NoKnownServers.yml +4 -3
- data/spec/spec_tests/data/max_staleness/Unknown/SmallMaxStaleness.yml +1 -0
- data/spec/spec_tests/data/read_write_concern/operation/default-write-concern-2.6.yml +215 -0
- data/spec/spec_tests/data/read_write_concern/operation/default-write-concern-3.2.yml +58 -0
- data/spec/spec_tests/data/read_write_concern/operation/default-write-concern-3.4.yml +95 -0
- data/spec/spec_tests/data/read_write_concern/operation/default-write-concern-4.2.yml +36 -0
- data/spec/spec_tests/data/retryable_writes/bulkWrite-errorLabels.yml +77 -0
- data/spec/spec_tests/data/retryable_writes/bulkWrite-serverErrors.yml +37 -0
- data/spec/spec_tests/data/retryable_writes/deleteOne-errorLabels.yml +48 -0
- data/spec/spec_tests/data/retryable_writes/deleteOne-serverErrors.yml +22 -0
- data/spec/spec_tests/data/retryable_writes/findOneAndDelete-errorLabels.yml +49 -0
- data/spec/spec_tests/data/retryable_writes/findOneAndDelete-serverErrors.yml +23 -0
- data/spec/spec_tests/data/retryable_writes/findOneAndReplace-errorLabels.yml +52 -0
- data/spec/spec_tests/data/retryable_writes/findOneAndReplace-serverErrors.yml +25 -0
- data/spec/spec_tests/data/retryable_writes/findOneAndUpdate-errorLabels.yml +52 -0
- data/spec/spec_tests/data/retryable_writes/findOneAndUpdate-serverErrors.yml +24 -0
- data/spec/spec_tests/data/retryable_writes/insertMany-errorLabels.yml +54 -0
- data/spec/spec_tests/data/retryable_writes/insertMany-serverErrors.yml +24 -0
- data/spec/spec_tests/data/retryable_writes/insertOne-errorLabels.yml +44 -0
- data/spec/spec_tests/data/retryable_writes/insertOne-serverErrors.yml +69 -0
- data/spec/spec_tests/data/retryable_writes/replaceOne-errorLabels.yml +53 -0
- data/spec/spec_tests/data/retryable_writes/replaceOne-serverErrors.yml +23 -0
- data/spec/spec_tests/data/retryable_writes/updateOne-errorLabels.yml +53 -0
- data/spec/spec_tests/data/retryable_writes/updateOne-serverErrors.yml +23 -0
- data/spec/spec_tests/data/sdam/errors/error_handling_handshake.yml +54 -0
- data/spec/spec_tests/data/sdam/errors/non-stale-network-error.yml +46 -0
- data/spec/spec_tests/data/sdam/errors/non-stale-network-timeout-error.yml +37 -0
- data/spec/spec_tests/data/sdam/errors/non-stale-topologyVersion-greater-InterruptedAtShutdown.yml +60 -0
- data/spec/spec_tests/data/sdam/errors/non-stale-topologyVersion-greater-InterruptedDueToReplStateChange.yml +60 -0
- data/spec/spec_tests/data/sdam/errors/non-stale-topologyVersion-greater-NotMaster.yml +60 -0
- data/spec/spec_tests/data/sdam/errors/non-stale-topologyVersion-greater-NotMasterNoSlaveOk.yml +60 -0
- data/spec/spec_tests/data/sdam/errors/non-stale-topologyVersion-greater-NotMasterOrSecondary.yml +60 -0
- data/spec/spec_tests/data/sdam/errors/non-stale-topologyVersion-greater-PrimarySteppedDown.yml +60 -0
- data/spec/spec_tests/data/sdam/errors/non-stale-topologyVersion-greater-ShutdownInProgress.yml +60 -0
- data/spec/spec_tests/data/sdam/errors/non-stale-topologyVersion-missing-InterruptedAtShutdown.yml +51 -0
- data/spec/spec_tests/data/sdam/errors/non-stale-topologyVersion-missing-InterruptedDueToReplStateChange.yml +51 -0
- data/spec/spec_tests/data/sdam/errors/non-stale-topologyVersion-missing-NotMaster.yml +51 -0
- data/spec/spec_tests/data/sdam/errors/non-stale-topologyVersion-missing-NotMasterNoSlaveOk.yml +51 -0
- data/spec/spec_tests/data/sdam/errors/non-stale-topologyVersion-missing-NotMasterOrSecondary.yml +51 -0
- data/spec/spec_tests/data/sdam/errors/non-stale-topologyVersion-missing-PrimarySteppedDown.yml +51 -0
- data/spec/spec_tests/data/sdam/errors/non-stale-topologyVersion-missing-ShutdownInProgress.yml +51 -0
- data/spec/spec_tests/data/sdam/errors/non-stale-topologyVersion-proccessId-changed-InterruptedAtShutdown.yml +60 -0
- data/spec/spec_tests/data/sdam/errors/non-stale-topologyVersion-proccessId-changed-InterruptedDueToReplStateChange.yml +60 -0
- data/spec/spec_tests/data/sdam/errors/non-stale-topologyVersion-proccessId-changed-NotMaster.yml +60 -0
- data/spec/spec_tests/data/sdam/errors/non-stale-topologyVersion-proccessId-changed-NotMasterNoSlaveOk.yml +60 -0
- data/spec/spec_tests/data/sdam/errors/non-stale-topologyVersion-proccessId-changed-NotMasterOrSecondary.yml +60 -0
- data/spec/spec_tests/data/sdam/errors/non-stale-topologyVersion-proccessId-changed-PrimarySteppedDown.yml +60 -0
- data/spec/spec_tests/data/sdam/errors/non-stale-topologyVersion-proccessId-changed-ShutdownInProgress.yml +60 -0
- data/spec/spec_tests/data/sdam/errors/post-42-InterruptedAtShutdown.yml +46 -0
- data/spec/spec_tests/data/sdam/errors/post-42-InterruptedDueToReplStateChange.yml +46 -0
- data/spec/spec_tests/data/sdam/errors/post-42-NotMaster.yml +46 -0
- data/spec/spec_tests/data/sdam/errors/post-42-NotMasterNoSlaveOk.yml +46 -0
- data/spec/spec_tests/data/sdam/errors/post-42-NotMasterOrSecondary.yml +46 -0
- data/spec/spec_tests/data/sdam/errors/post-42-PrimarySteppedDown.yml +46 -0
- data/spec/spec_tests/data/sdam/errors/post-42-ShutdownInProgress.yml +46 -0
- data/spec/spec_tests/data/sdam/errors/pre-42-InterruptedAtShutdown.yml +46 -0
- data/spec/spec_tests/data/sdam/errors/pre-42-InterruptedDueToReplStateChange.yml +46 -0
- data/spec/spec_tests/data/sdam/errors/pre-42-NotMaster.yml +46 -0
- data/spec/spec_tests/data/sdam/errors/pre-42-NotMasterNoSlaveOk.yml +46 -0
- data/spec/spec_tests/data/sdam/errors/pre-42-NotMasterOrSecondary.yml +46 -0
- data/spec/spec_tests/data/sdam/errors/pre-42-PrimarySteppedDown.yml +46 -0
- data/spec/spec_tests/data/sdam/errors/pre-42-ShutdownInProgress.yml +46 -0
- data/spec/spec_tests/data/sdam/errors/stale-generation-InterruptedAtShutdown.yml +89 -0
- data/spec/spec_tests/data/sdam/errors/stale-generation-InterruptedDueToReplStateChange.yml +89 -0
- data/spec/spec_tests/data/sdam/errors/stale-generation-NotMaster.yml +89 -0
- data/spec/spec_tests/data/sdam/errors/stale-generation-NotMasterNoSlaveOk.yml +89 -0
- data/spec/spec_tests/data/sdam/errors/stale-generation-NotMasterOrSecondary.yml +89 -0
- data/spec/spec_tests/data/sdam/errors/stale-generation-PrimarySteppedDown.yml +89 -0
- data/spec/spec_tests/data/sdam/errors/stale-generation-ShutdownInProgress.yml +89 -0
- data/spec/spec_tests/data/sdam/errors/stale-generation-afterHandshakeCompletes-InterruptedAtShutdown.yml +89 -0
- data/spec/spec_tests/data/sdam/errors/stale-generation-afterHandshakeCompletes-InterruptedDueToReplStateChange.yml +89 -0
- data/spec/spec_tests/data/sdam/errors/stale-generation-afterHandshakeCompletes-NotMaster.yml +89 -0
- data/spec/spec_tests/data/sdam/errors/stale-generation-afterHandshakeCompletes-NotMasterNoSlaveOk.yml +89 -0
- data/spec/spec_tests/data/sdam/errors/stale-generation-afterHandshakeCompletes-NotMasterOrSecondary.yml +89 -0
- data/spec/spec_tests/data/sdam/errors/stale-generation-afterHandshakeCompletes-PrimarySteppedDown.yml +89 -0
- data/spec/spec_tests/data/sdam/errors/stale-generation-afterHandshakeCompletes-ShutdownInProgress.yml +89 -0
- data/spec/spec_tests/data/sdam/errors/stale-generation-afterHandshakeCompletes-network.yml +80 -0
- data/spec/spec_tests/data/sdam/errors/stale-generation-afterHandshakeCompletes-timeout.yml +80 -0
- data/spec/spec_tests/data/sdam/errors/stale-generation-beforeHandshakeCompletes-InterruptedAtShutdown.yml +89 -0
- data/spec/spec_tests/data/sdam/errors/stale-generation-beforeHandshakeCompletes-InterruptedDueToReplStateChange.yml +89 -0
- data/spec/spec_tests/data/sdam/errors/stale-generation-beforeHandshakeCompletes-NotMaster.yml +89 -0
- data/spec/spec_tests/data/sdam/errors/stale-generation-beforeHandshakeCompletes-NotMasterNoSlaveOk.yml +89 -0
- data/spec/spec_tests/data/sdam/errors/stale-generation-beforeHandshakeCompletes-NotMasterOrSecondary.yml +89 -0
- data/spec/spec_tests/data/sdam/errors/stale-generation-beforeHandshakeCompletes-PrimarySteppedDown.yml +89 -0
- data/spec/spec_tests/data/sdam/errors/stale-generation-beforeHandshakeCompletes-ShutdownInProgress.yml +89 -0
- data/spec/spec_tests/data/sdam/errors/stale-generation-beforeHandshakeCompletes-network.yml +80 -0
- data/spec/spec_tests/data/sdam/errors/stale-generation-beforeHandshakeCompletes-timeout.yml +80 -0
- data/spec/spec_tests/data/sdam/errors/stale-topologyVersion-InterruptedAtShutdown.yml +64 -0
- data/spec/spec_tests/data/sdam/errors/stale-topologyVersion-InterruptedDueToReplStateChange.yml +64 -0
- data/spec/spec_tests/data/sdam/errors/stale-topologyVersion-NotMaster.yml +64 -0
- data/spec/spec_tests/data/sdam/errors/stale-topologyVersion-NotMasterNoSlaveOk.yml +64 -0
- data/spec/spec_tests/data/sdam/errors/stale-topologyVersion-NotMasterOrSecondary.yml +64 -0
- data/spec/spec_tests/data/sdam/errors/stale-topologyVersion-PrimarySteppedDown.yml +64 -0
- data/spec/spec_tests/data/sdam/errors/stale-topologyVersion-ShutdownInProgress.yml +64 -0
- data/spec/spec_tests/data/sdam/rs/compatible.yml +2 -0
- data/spec/spec_tests/data/sdam/rs/compatible_unknown.yml +2 -0
- data/spec/spec_tests/data/sdam/rs/discover_arbiters.yml +2 -2
- data/spec/spec_tests/data/sdam/rs/discover_arbiters_replicaset.yml +43 -0
- data/spec/spec_tests/data/sdam/rs/discover_ghost.yml +35 -0
- data/spec/spec_tests/data/sdam/rs/{ghost_discovered.yml → discover_ghost_replicaset.yml} +1 -1
- data/spec/spec_tests/data/sdam/rs/discover_hidden.yml +50 -0
- data/spec/spec_tests/data/sdam/rs/discover_hidden_replicaset.yml +50 -0
- data/spec/spec_tests/data/sdam/rs/discover_passives.yml +2 -2
- data/spec/spec_tests/data/sdam/rs/discover_passives_replicaset.yml +81 -0
- data/spec/spec_tests/data/sdam/rs/discover_primary.yml +2 -2
- data/spec/spec_tests/data/sdam/rs/discover_primary_replicaset.yml +42 -0
- data/spec/spec_tests/data/sdam/rs/discover_rsother.yml +49 -0
- data/spec/spec_tests/data/sdam/rs/{rsother_discovered.yml → discover_rsother_replicaset.yml} +1 -1
- data/spec/spec_tests/data/sdam/rs/discover_secondary.yml +2 -2
- data/spec/spec_tests/data/sdam/rs/discover_secondary_replicaset.yml +43 -0
- data/spec/spec_tests/data/sdam/rs/incompatible_arbiter.yml +2 -0
- data/spec/spec_tests/data/sdam/rs/incompatible_ghost.yml +2 -0
- data/spec/spec_tests/data/sdam/rs/incompatible_other.yml +2 -0
- data/spec/spec_tests/data/sdam/rs/primary_mismatched_me.yml +23 -27
- data/spec/spec_tests/data/sdam/rs/primary_to_no_primary_mismatched_me.yml +79 -55
- data/spec/spec_tests/data/sdam/rs/replicaset_rsnp.yml +20 -0
- data/spec/spec_tests/data/sdam/rs/secondary_mismatched_me.yml +3 -2
- data/spec/spec_tests/data/sdam/rs/too_new.yml +2 -0
- data/spec/spec_tests/data/sdam/rs/topology_version_equal.yml +66 -0
- data/spec/spec_tests/data/sdam/rs/topology_version_greater.yml +189 -0
- data/spec/spec_tests/data/sdam/rs/topology_version_less.yml +62 -0
- data/spec/spec_tests/data/sdam/sharded/discover_single_mongos.yml +23 -0
- data/spec/spec_tests/data/sdam/single/direct_connection_external_ip.yml +1 -1
- data/spec/spec_tests/data/sdam/single/direct_connection_mongos.yml +2 -2
- data/spec/spec_tests/data/sdam/single/direct_connection_replicaset.yml +22 -0
- data/spec/spec_tests/data/sdam/single/direct_connection_rsarbiter.yml +2 -2
- data/spec/spec_tests/data/sdam/single/direct_connection_rsprimary.yml +2 -2
- data/spec/spec_tests/data/sdam/single/direct_connection_rssecondary.yml +2 -2
- data/spec/spec_tests/data/sdam/single/direct_connection_slave.yml +1 -1
- data/spec/spec_tests/data/sdam/single/direct_connection_standalone.yml +2 -2
- data/spec/spec_tests/data/sdam/single/{unavailable_seed.yml → direct_connection_unavailable_seed.yml} +2 -2
- data/spec/spec_tests/data/sdam/single/direct_connection_wrong_set_name.yml +38 -0
- data/spec/spec_tests/data/sdam/single/discover_standalone.yml +34 -0
- data/spec/spec_tests/data/sdam/single/discover_unavailable_seed.yml +28 -0
- data/spec/spec_tests/data/sdam/single/too_old_then_upgraded.yml +46 -0
- data/spec/spec_tests/data/sdam_integration/cancel-server-check.yml +96 -0
- data/spec/spec_tests/data/sdam_integration/connectTimeoutMS.yml +88 -0
- data/spec/spec_tests/data/sdam_integration/find-network-error.yml +83 -0
- data/spec/spec_tests/data/sdam_integration/find-shutdown-error.yml +116 -0
- data/spec/spec_tests/data/sdam_integration/insert-network-error.yml +86 -0
- data/spec/spec_tests/data/sdam_integration/insert-shutdown-error.yml +115 -0
- data/spec/spec_tests/data/sdam_integration/isMaster-command-error.yml +168 -0
- data/spec/spec_tests/data/sdam_integration/isMaster-network-error.yml +162 -0
- data/spec/spec_tests/data/sdam_integration/isMaster-timeout.yml +229 -0
- data/spec/spec_tests/data/sdam_integration/rediscover-quickly-after-step-down.yml +87 -0
- data/spec/spec_tests/data/transactions/create-collection.yml +131 -0
- data/spec/spec_tests/data/transactions/create-index.yml +152 -0
- data/spec/spec_tests/data/transactions/error-labels.yml +87 -21
- data/spec/spec_tests/data/transactions/mongos-recovery-token.yml +1 -0
- data/spec/spec_tests/data/transactions/retryable-abort-errorLabels.yml +124 -0
- data/spec/spec_tests/data/transactions/retryable-abort.yml +17 -2
- data/spec/spec_tests/data/transactions/retryable-commit-errorLabels.yml +132 -0
- data/spec/spec_tests/data/transactions/retryable-commit.yml +24 -9
- data/spec/spec_tests/data/uri_options/connection-options.yml +43 -0
- data/spec/spec_tests/data/uri_options/ruby-auth-options.yml +12 -0
- data/spec/spec_tests/data/uri_options/ruby-connection-options.yml +57 -0
- data/spec/spec_tests/dns_seedlist_discovery_spec.rb +3 -1
- data/spec/spec_tests/gridfs_spec.rb +2 -0
- data/spec/spec_tests/max_staleness_spec.rb +5 -141
- data/spec/spec_tests/read_write_concern_connection_string_spec.rb +2 -0
- data/spec/spec_tests/read_write_concern_operaton_spec.rb +10 -0
- data/spec/spec_tests/retryable_reads_spec.rb +4 -2
- data/spec/spec_tests/retryable_writes_spec.rb +8 -1
- data/spec/spec_tests/sdam_integration_spec.rb +13 -0
- data/spec/spec_tests/sdam_monitoring_spec.rb +3 -2
- data/spec/spec_tests/sdam_spec.rb +70 -1
- data/spec/spec_tests/server_selection_rtt_spec.rb +2 -0
- data/spec/spec_tests/server_selection_spec.rb +5 -115
- data/spec/spec_tests/transactions_api_spec.rb +5 -0
- data/spec/spec_tests/transactions_spec.rb +5 -0
- data/spec/spec_tests/uri_options_spec.rb +2 -0
- data/spec/stress/cleanup_spec.rb +58 -0
- data/spec/stress/connection_pool_stress_spec.rb +11 -13
- data/spec/stress/connection_pool_timing_spec.rb +3 -6
- data/spec/stress/fork_reconnect_stress_spec.rb +109 -0
- data/spec/support/authorization.rb +1 -11
- data/spec/support/aws_utils.rb +62 -0
- data/spec/support/aws_utils/base.rb +134 -0
- data/spec/support/aws_utils/inspector.rb +224 -0
- data/spec/support/aws_utils/orchestrator.rb +370 -0
- data/spec/support/aws_utils/provisioner.rb +360 -0
- data/spec/support/background_thread_registry.rb +6 -2
- data/spec/support/child_process_helper.rb +78 -0
- data/spec/support/client_registry.rb +6 -24
- data/spec/support/cluster_config.rb +5 -0
- data/spec/support/common_shortcuts.rb +43 -0
- data/spec/support/constraints.rb +27 -7
- data/spec/support/crypt.rb +1 -1
- data/spec/support/event_subscriber.rb +184 -84
- data/spec/support/keyword_struct.rb +26 -0
- data/spec/support/lite_constraints.rb +47 -0
- data/spec/support/shared/scram_conversation.rb +100 -0
- data/spec/support/shared/server_selector.rb +93 -1
- data/spec/support/shared/session.rb +29 -21
- data/spec/support/spec_config.rb +76 -21
- data/spec/support/spec_organizer.rb +129 -0
- data/spec/support/spec_setup.rb +9 -5
- data/spec/support/utils.rb +161 -24
- metadata +1189 -742
- metadata.gz.sig +0 -0
- data/lib/mongo/server/connectable.rb +0 -107
- data/spec/runners/change_streams.rb +0 -262
- data/spec/runners/change_streams/operation.rb +0 -89
- data/spec/runners/sdam_monitoring.rb +0 -89
- data/spec/spec_tests/data/sdam/sharded/ruby_discovered_single_mongos.yml +0 -27
@@ -1,4 +1,4 @@
|
|
1
|
-
# Copyright (C) 2017-
|
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.
|
@@ -224,6 +224,14 @@ module Mongo
|
|
224
224
|
txt_options
|
225
225
|
end
|
226
226
|
end
|
227
|
+
|
228
|
+
def validate_uri_options!
|
229
|
+
if uri_options[:direct_connection]
|
230
|
+
raise_invalid_error_no_fmt!("directConnection=true is incompatible with SRV URIs")
|
231
|
+
end
|
232
|
+
|
233
|
+
super
|
234
|
+
end
|
227
235
|
end
|
228
236
|
end
|
229
237
|
end
|
data/lib/mongo/utils.rb
ADDED
@@ -0,0 +1,62 @@
|
|
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
|
+
|
17
|
+
# @api private
|
18
|
+
module Utils
|
19
|
+
|
20
|
+
class LocalLogger
|
21
|
+
include Loggable
|
22
|
+
|
23
|
+
def initialize(**opts)
|
24
|
+
@options = opts
|
25
|
+
end
|
26
|
+
|
27
|
+
attr_reader :options
|
28
|
+
end
|
29
|
+
|
30
|
+
# @option opts [ true | false | nil | Integer ] :bg_error_backtrace
|
31
|
+
# Experimental. Set to true to log complete backtraces for errors in
|
32
|
+
# background threads. Set to false or nil to not log backtraces. Provide
|
33
|
+
# a positive integer to log up to that many backtrace lines.
|
34
|
+
# @option opts [ Logger ] :logger A custom logger to use.
|
35
|
+
# @option opts [ String ] :log_prefix A custom log prefix to use when
|
36
|
+
# logging.
|
37
|
+
module_function def warn_monitor_exception(msg, exc, **opts)
|
38
|
+
bt_excerpt = excerpt_backtrace(exc, **opts)
|
39
|
+
logger = LocalLogger.new(**opts)
|
40
|
+
logger.log_warn("#{msg}: #{exc.class}: #{exc}#{bt_excerpt}")
|
41
|
+
end
|
42
|
+
|
43
|
+
# @option opts [ true | false | nil | Integer ] :bg_error_backtrace
|
44
|
+
# Experimental. Set to true to log complete backtraces for errors in
|
45
|
+
# background threads. Set to false or nil to not log backtraces. Provide
|
46
|
+
# a positive integer to log up to that many backtrace lines.
|
47
|
+
module_function def excerpt_backtrace(exc, **opts)
|
48
|
+
case lines = opts[:bg_error_backtrace]
|
49
|
+
when Integer
|
50
|
+
":\n#{exc.backtrace[0..lines].join("\n")}"
|
51
|
+
when false, nil
|
52
|
+
nil
|
53
|
+
else
|
54
|
+
":\n#{exc.backtrace.join("\n")}"
|
55
|
+
end
|
56
|
+
end
|
57
|
+
|
58
|
+
module_function def shallow_symbolize_keys(hash)
|
59
|
+
Hash[hash.map { |k, v| [k.to_sym, v] }]
|
60
|
+
end
|
61
|
+
end
|
62
|
+
end
|
data/lib/mongo/version.rb
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
# Copyright (C) 2014-
|
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.
|
@@ -17,5 +17,5 @@ module Mongo
|
|
17
17
|
# The current version of the driver.
|
18
18
|
#
|
19
19
|
# @since 2.0.0
|
20
|
-
VERSION = '2.
|
20
|
+
VERSION = '2.13.0'.freeze
|
21
21
|
end
|
data/lib/mongo/write_concern.rb
CHANGED
data/mongo.gemspec
CHANGED
@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
|
|
21
21
|
'source_code_uri' => 'https://github.com/mongodb/mongo-ruby-driver',
|
22
22
|
}
|
23
23
|
|
24
|
-
if File.
|
24
|
+
if File.exist?('gem-private_key.pem')
|
25
25
|
s.signing_key = 'gem-private_key.pem'
|
26
26
|
s.cert_chain = ['gem-public_cert.pem']
|
27
27
|
else
|
@@ -0,0 +1,291 @@
|
|
1
|
+
# AWS Authentication Implementation Notes
|
2
|
+
|
3
|
+
## AWS Account
|
4
|
+
|
5
|
+
Per [its documentation](https://docs.aws.amazon.com/STS/latest/APIReference/API_GetCallerIdentity.html,
|
6
|
+
the GetCallerIdentity API call that the server makes to STS to authenticate
|
7
|
+
the user using MONGODB-AWS auth mechanism requires no privileges. This means
|
8
|
+
in order to test authentication using non-temporary credentials (i.e.,
|
9
|
+
AWS access key id and secret access key only) it is sufficient to create an
|
10
|
+
IAM user that has no permissions but does have programmatic access enabled
|
11
|
+
(i.e. has an access key id and secret access key).
|
12
|
+
|
13
|
+
## AWS Signature V4
|
14
|
+
|
15
|
+
The driver implements the AWS signature v4 internally rather than relying on
|
16
|
+
a third-party library (such as the
|
17
|
+
[AWS SDK for Ruby](https://docs.aws.amazon.com/sdk-for-ruby/v3/api/index.html))
|
18
|
+
to provide the signature implementation. The implementation is quite compact
|
19
|
+
but getting it working took some effort due to:
|
20
|
+
|
21
|
+
1. [The server not logging AWS responses when authentication fails
|
22
|
+
](https://jira.mongodb.org/browse/SERVER-46909)
|
23
|
+
2. Some of the messages from STS being quite cryptic (I could not figure out
|
24
|
+
what the problem was for either "Request is missing Authentication Token" or
|
25
|
+
"Request must contain a signature that conforms to AWS standards", and
|
26
|
+
ultimately resolved these problems by comparing my requests to those produced
|
27
|
+
by the AWS SDK).
|
28
|
+
3. Amazon's own documentation not providing an example signature calculation
|
29
|
+
that could be followed to verify correctness, especially since this is a
|
30
|
+
multi-step process and all kinds of subtle errors are possible in many of the
|
31
|
+
steps like using a date instead of a time, hex-encoding a MAC in an
|
32
|
+
intermediate step or not separating header values from the list of signed
|
33
|
+
headers by two newlines.
|
34
|
+
|
35
|
+
### Reference Implementation - AWS SDK
|
36
|
+
|
37
|
+
To see actual working STS requests I used Amazon's
|
38
|
+
[AWS SDK for Ruby](https://docs.aws.amazon.com/sdk-for-ruby/v3/api/index.html)
|
39
|
+
([API docs for STS client](https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EC2/Client.html),
|
40
|
+
[configuration documentation](https://docs.aws.amazon.com/sdk-for-ruby/v3/developer-guide/setup-config.html))
|
41
|
+
as follows:
|
42
|
+
|
43
|
+
1. Set the credentials in the environment (note that the region must be
|
44
|
+
explicitly provided):
|
45
|
+
|
46
|
+
export AWS_ACCESS_KEY_ID=AKIAREALKEY
|
47
|
+
export AWS_SECRET_ACCESS_KEY=Sweee/realsecret
|
48
|
+
export AWS_REGION=us-east-1
|
49
|
+
|
50
|
+
2. Install the correct gem and launch IRb:
|
51
|
+
|
52
|
+
gem install aws-sdk-core
|
53
|
+
irb -raws-sdk-core -Iaws/sts
|
54
|
+
|
55
|
+
3. Send a GetCallerIdentity request, as used by MongoDB server:
|
56
|
+
|
57
|
+
Aws::STS::Client.new(
|
58
|
+
logger: Logger.new(STDERR, level: :debug),
|
59
|
+
http_wire_trace: true,
|
60
|
+
).get_caller_identity
|
61
|
+
|
62
|
+
This call enables HTTP request and response logging and produces output
|
63
|
+
similar to the following:
|
64
|
+
|
65
|
+
opening connection to sts.amazonaws.com:443...
|
66
|
+
opened
|
67
|
+
starting SSL for sts.amazonaws.com:443...
|
68
|
+
SSL established, protocol: TLSv1.2, cipher: ECDHE-RSA-AES128-SHA
|
69
|
+
<- "POST / HTTP/1.1\r\nContent-Type: application/x-www-form-urlencoded; charset=utf-8\r\nAccept-Encoding: \r\nUser-Agent: aws-sdk-ruby3/3.91.1 ruby/2.7.0 x86_64-linux aws-sdk-core/3.91.1\r\nHost: sts.amazonaws.com\r\nX-Amz-Date: 20200317T194745Z\r\nX-Amz-Content-Sha256: ab821ae955788b0e33ebd34c208442ccfc2d406e2edc5e7a39bd6458fbb4f843\r\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIAREALKEY/20200317/us-east-1/sts/aws4_request, SignedHeaders=content-type;host;x-amz-content-sha256;x-amz-date, Signature=6cd3a60a2d7dfba0dcd17f9c4c42d0186de5830cf99545332253a327bba14131\r\nContent-Length: 43\r\nAccept: */*\r\n\r\n"
|
70
|
+
-> "HTTP/1.1 200 OK\r\n"
|
71
|
+
-> "x-amzn-RequestId: c56f5d68-8763-4032-a835-fd95efd83fa6\r\n"
|
72
|
+
-> "Content-Type: text/xml\r\n"
|
73
|
+
-> "Content-Length: 401\r\n"
|
74
|
+
-> "Date: Tue, 17 Mar 2020 19:47:44 GMT\r\n"
|
75
|
+
-> "\r\n"
|
76
|
+
reading 401 bytes...
|
77
|
+
-> ""
|
78
|
+
-> "<GetCallerIdentityResponse xmlns=\"https://sts.amazonaws.com/doc/2011-06-15/\">\n <GetCallerIdentityResult>\n <Arn>arn:aws:iam::5851234356:user/test</Arn>\n <UserId>AIDAREALUSERID</UserId>\n <Account>5851234356</Account>\n </GetCallerIdentityResult>\n <ResponseMetadata>\n <RequestId>c56f5d68-8763-4032-a835-fd95efd83fa6</RequestId>\n </ResponseMetadata>\n</GetCallerIdentityResponse>\n"
|
79
|
+
read 401 bytes
|
80
|
+
Conn keep-alive
|
81
|
+
I, [2020-03-17T15:47:45.275421 #9815] INFO -- : [Aws::STS::Client 200 0.091573 0 retries] get_caller_identity()
|
82
|
+
|
83
|
+
=> #<struct Aws::STS::Types::GetCallerIdentityResponse user_id="AIDAREALUSERID", account="5851234356", arn="arn:aws:iam::5851234356:user/test">
|
84
|
+
|
85
|
+
Note that:
|
86
|
+
|
87
|
+
1. The set of headers sent by the AWS SDK differs from the set
|
88
|
+
of headers that the MONGODB-AWS auth mechanism specification mentions.
|
89
|
+
I used the AWS SDK implementation as a guide to determine the correct shape
|
90
|
+
of the request to STS and in particular the `Authorization` header.
|
91
|
+
The source code of Amazon's implementation is
|
92
|
+
[here](https://github.com/aws/aws-sdk-ruby/blob/master/gems/aws-sigv4/lib/aws-sigv4/signer.rb)
|
93
|
+
and it generates, in particular, the x-amz-content-sha256` header
|
94
|
+
which the MONGODB-AWS auth mechanism specification does not mention.
|
95
|
+
2. This is a working request which can be replayed, making it possible
|
96
|
+
to send this request that was created by the AWS SDK repeatedly with minor
|
97
|
+
alterations to study STS error reporting behavior. STS as of this writing
|
98
|
+
allows a 15 minute window during which a request may be replayed.
|
99
|
+
3. The printed request only shows the headers and not the request body.
|
100
|
+
In case of the GetCallerIdentity, the payload is fixed and is the same as
|
101
|
+
what the MONGODB-AWS auth mechanism specification requires
|
102
|
+
(`Action=GetCallerIdentity&Version=2011-06-15`).
|
103
|
+
|
104
|
+
Because the AWS SDK includes a different set of headers in its requests,
|
105
|
+
it not feasible to compare the canonical requests generated by AWS SDK
|
106
|
+
verbatim to the canonical requests generated by the driver.
|
107
|
+
|
108
|
+
### Manual Requests
|
109
|
+
|
110
|
+
It is possible to manually send requests to STS using OpenSSL `s_client`
|
111
|
+
tool in combination with the [printf](https://linux.die.net/man/3/printf)
|
112
|
+
utility to transform the newline escapes. A sample command replaying the
|
113
|
+
request printed above is as follows:
|
114
|
+
|
115
|
+
(printf "POST / HTTP/1.1\r\nContent-Type: application/x-www-form-urlencoded; charset=utf-8\r\nAccept-Encoding: \r\nUser-Agent: aws-sdk-ruby3/3.91.1 ruby/2.7.0 x86_64-linux aws-sdk-core/3.91.1\r\nHost: sts.amazonaws.com\r\nX-Amz-Date: 20200317T194745Z\r\nX-Amz-Content-Sha256: ab821ae955788b0e33ebd34c208442ccfc2d406e2edc5e7a39bd6458fbb4f843\r\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIAREALKEY/20200317/us-east-1/sts/aws4_request, SignedHeaders=content-type;host;x-amz-content-sha256;x-amz-date, Signature=6cd3a60a2d7dfba0dcd17f9c4c42d0186de5830cf99545332253a327bba14131\r\nContent-Length: 43\r\nAccept: */*\r\n\r\n" &&
|
116
|
+
echo "Action=GetCallerIdentity&Version=2011-06-15" &&
|
117
|
+
sleep 5) |openssl s_client -connect sts.amazonaws.com:443
|
118
|
+
|
119
|
+
Note the sleep call - `s_client` does not wait for the remote end to provide
|
120
|
+
a response before exiting, thus the sleep on the input side allows 5 seconds
|
121
|
+
for STS to process the request and respond.
|
122
|
+
|
123
|
+
For reference, Amazon provides [GetCallerIdentity API documentation
|
124
|
+
](https://docs.aws.amazon.com/STS/latest/APIReference/API_GetCallerIdentity.html).
|
125
|
+
|
126
|
+
### Integration Test - Signature Generation
|
127
|
+
|
128
|
+
The Ruby driver includes an integration test for signature generation, where
|
129
|
+
the driver makes the call to `GetCallerIdentity` STS endpoint using the
|
130
|
+
provided AWS credentials. This test is in
|
131
|
+
`spec/integration/aws_auth_request_spec.rb`.
|
132
|
+
|
133
|
+
### STS Error Responses
|
134
|
+
|
135
|
+
The error responses produced by STS sometimes do not clearly indicate the
|
136
|
+
problem. Below are some of the puzzling responses I encountered:
|
137
|
+
|
138
|
+
- *Request is missing Authentication Token*: request is missing the
|
139
|
+
`Authorization` header, or the value of the header does not begin with
|
140
|
+
`AWS4-`. For example, this error is produced if the signature algorithm
|
141
|
+
is erroneously given as `AWS-HMAC-SHA256` instead of `AWS4-HMAC-SHA256`
|
142
|
+
with the remainder of the header value being correctly constructed.
|
143
|
+
This error is also produced if the value of the header erroneously includes
|
144
|
+
the name of the header (i.e. the header name is specified twice in the header
|
145
|
+
line) but the value is otherwise completely valid. This error has no relation
|
146
|
+
to the "session token" or "security token" as used with temporary AWS
|
147
|
+
credentials.
|
148
|
+
- *The security token included in the request is invalid*: this error is
|
149
|
+
produced when the AWS access key id, as specified in the scope part of the
|
150
|
+
`Authorization` header, is not a valid access key id. In the case of
|
151
|
+
non-temporary credentials being used for authentication, the error refers to
|
152
|
+
a "security token" but the authentication process does not actually use a
|
153
|
+
security token as this term is used in the AWS documentation describing
|
154
|
+
temporary credentials.
|
155
|
+
- *Signature expired: 20200317T000000Z is now earlier than 20200317T222541Z
|
156
|
+
(20200317T224041Z - 15 min.)*: This error happens when `x-amz-date` header
|
157
|
+
value is the formatted date (`YYYYMMDD`) rather than the ISO8601 formatted
|
158
|
+
time (`YYYYMMDDTHHMMSSZ`). Note that the string `20200317T000000Z` is never
|
159
|
+
explicitly provided in the request - it is derived by AWS from the provided
|
160
|
+
header `x-amz-date: 20200317`.
|
161
|
+
- *The request signature we calculated does not match the signature
|
162
|
+
you provided. Check your AWS Secret Access Key and signing method. Consult
|
163
|
+
the service documentation for details*: this is the error produced when
|
164
|
+
the signature is not calculated correctly but everything else in the
|
165
|
+
request is valid. If a different error is produced, most likely the problem
|
166
|
+
is in something other than signature calculation.
|
167
|
+
- *The security token included in the request is expired*: this error is
|
168
|
+
produced when temporary credentials are used and the credentials have
|
169
|
+
expired.
|
170
|
+
|
171
|
+
### Resources
|
172
|
+
|
173
|
+
Generally I found Amazon's own documentation to be the best for implementing
|
174
|
+
the signature calculation. The following documents should be read in order:
|
175
|
+
|
176
|
+
- [Signing AWS requests overview](https://docs.aws.amazon.com/general/latest/gr/sigv4_signing.html)
|
177
|
+
- [Creating canonical request](https://docs.aws.amazon.com/general/latest/gr/sigv4-create-canonical-request.html)
|
178
|
+
- [Creating string to sign](https://docs.aws.amazon.com/general/latest/gr/sigv4-create-string-to-sign.html)
|
179
|
+
- [Calculating signature](https://docs.aws.amazon.com/general/latest/gr/sigv4-calculate-signature.html)
|
180
|
+
|
181
|
+
### Signature Debugger
|
182
|
+
|
183
|
+
The most excellent [awssignature.com](http://www.awssignature.com/) was
|
184
|
+
indispensable in debugging the actual signature calculation process.
|
185
|
+
|
186
|
+
### MongoDB Server
|
187
|
+
|
188
|
+
MongoDB server internally defines the set of headers that it is prepared to
|
189
|
+
handle when it is processing AWS authentication. Headers that are not part
|
190
|
+
of that set cause the server to reject driver's payloads.
|
191
|
+
|
192
|
+
The error reporting when additional headers are provided and when the
|
193
|
+
correct set of headers is provided but the headers are not ordered
|
194
|
+
lexicographically [can be misleading](https://jira.mongodb.org/browse/SERVER-47488).
|
195
|
+
|
196
|
+
## Direct AWS Requests
|
197
|
+
|
198
|
+
[STS GetCallerIdentity API docs](https://docs.aws.amazon.com/STS/latest/APIReference/API_GetCallerIdentity.html)
|
199
|
+
|
200
|
+
When making direct requests to AWS, adding `Accept: application/json`
|
201
|
+
header will return the results in the JSON format, including the errors.
|
202
|
+
|
203
|
+
## AWS CLI
|
204
|
+
|
205
|
+
[Configuration reference](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html)
|
206
|
+
|
207
|
+
Note that AWS CLI uses `AWS_DEFAULT_REGION` environment variable to configure
|
208
|
+
the region used for operations.
|
209
|
+
|
210
|
+
## AWS Ruby SDK
|
211
|
+
|
212
|
+
[Configuration reference](https://docs.aws.amazon.com/sdk-for-ruby/v3/developer-guide/setup-config.html)
|
213
|
+
|
214
|
+
Note that AWS Ruby SDK uses `AWS_REGION` environment variable to configure
|
215
|
+
the region used for operations.
|
216
|
+
|
217
|
+
[STS::Client#assume_role documentation](https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/STS/Client.html#assume_role-instance_method)
|
218
|
+
|
219
|
+
## IMDSv2
|
220
|
+
|
221
|
+
`X-aws-ec2-metadata-token-ttl-seconds` is a required header when using
|
222
|
+
IMDSv2 EC2 instance metadata requests. This header is used in the examples
|
223
|
+
on [Amazon's page describing
|
224
|
+
IMDSv2](https://aws.amazon.com/blogs/security/defense-in-depth-open-firewalls-reverse-proxies-ssrf-vulnerabilities-ec2-instance-metadata-service/),
|
225
|
+
but is not explicitly stated as being required.
|
226
|
+
|
227
|
+
Not providing this header fails the PUT requests with HTTP code 400.
|
228
|
+
|
229
|
+
## IAM Roles For EC2 Instances
|
230
|
+
|
231
|
+
### Metadata Rate Limit
|
232
|
+
|
233
|
+
[Amazon documentation](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instancedata-data-retrieval.html#instancedata-throttling)
|
234
|
+
states that the EC2 instance metadata endpoint is rate limited. Since the
|
235
|
+
driver accesses it to obtain credentials whenever a connection is established,
|
236
|
+
rate limits may adversely affect the driver's ability to establish connections.
|
237
|
+
|
238
|
+
### Instance Profile Assignment
|
239
|
+
|
240
|
+
It can take over 5 seconds for an instance to see its instance profile change
|
241
|
+
reflected in the instance metadata. Evergreen test runs seem to experience
|
242
|
+
this delay to a significantly larger extent than testing in a standalone
|
243
|
+
AWS account.
|
244
|
+
|
245
|
+
## IAM Roles For ECS Tasks
|
246
|
+
|
247
|
+
### ECS Task Roles
|
248
|
+
|
249
|
+
When an ECS task (or more precisely, the task definition) is created,
|
250
|
+
it is possible to specify an *execution role* and a *task role*. The two are
|
251
|
+
completely separate; an execution role is required to, for example, be
|
252
|
+
able to send container logs to CloudWatch if the container is running in
|
253
|
+
Fargate, and a task role is required for AWS authentication purposes.
|
254
|
+
|
255
|
+
The ECS task role is also separate from EC2 instance role and the IAM role
|
256
|
+
for a user to assume a role - these roles all require different configuration.
|
257
|
+
|
258
|
+
### `AWS_CONTAINER_CREDENTIALS_RELATIVE_URI` Scope
|
259
|
+
|
260
|
+
As stated in [this Amazon support document](https://aws.amazon.com/premiumsupport/knowledge-center/ecs-iam-task-roles-config-errors/),
|
261
|
+
the `AWS_CONTAINER_CREDENTIALS_RELATIVE_URI` environment variable is only
|
262
|
+
available to the PID 1 process in the container. Other processes need to
|
263
|
+
extract it from PID 1's environment:
|
264
|
+
|
265
|
+
strings /proc/1/environment
|
266
|
+
|
267
|
+
### Other ECS Metadata
|
268
|
+
|
269
|
+
`strings /proc/1/environment` also shows a number of other enviroment
|
270
|
+
variables available in the container with metadata. For example a test
|
271
|
+
container yields:
|
272
|
+
|
273
|
+
HOSTNAME=f893c90ec4bd
|
274
|
+
ECS_CONTAINER_METADATA_URI=http://169.254.170.2/v3/5fb0b11b-c4c8-4cdb-b68b-edf70b3f4937
|
275
|
+
AWS_DEFAULT_REGION=us-east-2
|
276
|
+
AWS_EXECUTION_ENV=AWS_ECS_FARGATE
|
277
|
+
AWS_REGION=us-east-2
|
278
|
+
AWS_CONTAINER_CREDENTIALS_RELATIVE_URI=/v2/credentials/f17b5770-9a0d-498c-8d26-eea69f8d0924
|
279
|
+
|
280
|
+
### Metadata Rate Limit
|
281
|
+
|
282
|
+
[Amazon documentation](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/troubleshoot-task-iam-roles.html)
|
283
|
+
states that ECS task metadata endpoint is subject to rate limiting,
|
284
|
+
which is configured via [ECS_TASK_METADATA_RPS_LIMIT container agent
|
285
|
+
parameter](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html).
|
286
|
+
When the rate limit is reached, requests fail with `429 Too Many Requests`
|
287
|
+
HTTP status code.
|
288
|
+
|
289
|
+
Since the driver accesses this endpoint to obtain credentials whenever
|
290
|
+
a connection is established, rate limits may adversely affect the driver's
|
291
|
+
ability to establish connections.
|
@@ -0,0 +1,318 @@
|
|
1
|
+
# Testing AWS Authentication
|
2
|
+
|
3
|
+
## Server Configuration
|
4
|
+
|
5
|
+
AWS authentication requires the following to be done on the server side:
|
6
|
+
|
7
|
+
1. The AWS authentication mechanism must be enabled on the server. This
|
8
|
+
is done by adding `MONGODB-AWS` to the values in `authenticationMechanisms`
|
9
|
+
server parameter.
|
10
|
+
|
11
|
+
2. A user must be created in the `$external` database with the ARN matching
|
12
|
+
the IAM user or role that the client will authenticate as.
|
13
|
+
|
14
|
+
Note that the server does not need to have AWS keys provided to it - it
|
15
|
+
uses the keys that the client provides during authentication.
|
16
|
+
|
17
|
+
An easy way to configure the deployment in the required fashion is to
|
18
|
+
configure the deployment to accept both password authentication and
|
19
|
+
AWS authentication, and add a bootstrap user:
|
20
|
+
|
21
|
+
mlaunch init --single --auth --username root --password toor \
|
22
|
+
--setParameter authenticationMechanisms=MONGODB-AWS,SCRAM-SHA-1,SCRAM-SHA-256 \
|
23
|
+
--dir /tmp/db
|
24
|
+
|
25
|
+
Then connect as the bootstrap user and create AWS-mapped users:
|
26
|
+
|
27
|
+
mongo mongodb://root:toor@localhost:27017
|
28
|
+
|
29
|
+
# In the mongo shell:
|
30
|
+
use $external
|
31
|
+
db.createUser({
|
32
|
+
user: 'arn:aws:iam::1234567890:user/test',
|
33
|
+
roles: [{role:'root', db:'admin'}]})
|
34
|
+
|
35
|
+
The ARN can be retrieved from the AWS management console. Alternatively,
|
36
|
+
if the IAM user's access and secret keys are known, trying to authenticate
|
37
|
+
as the user will log the user's ARN into the server log when authentication
|
38
|
+
fails; this ARN can be then used to create the server user.
|
39
|
+
|
40
|
+
With the server user created, it is possible to authenticate using AWS.
|
41
|
+
The following example uses regular user credentials for an IAM user
|
42
|
+
created as described in the next section;
|
43
|
+
|
44
|
+
mongo 'mongodb://AKIAAAAAAAAAAAA:t9t2mawssecretkey@localhost:27017/?authMechanism=MONGODB-AWS&authsource=$external'
|
45
|
+
|
46
|
+
To authenticate, provide the IAM user's access key id as the username and
|
47
|
+
secret access key as the password. Note that the username and the password
|
48
|
+
must be percent-escaped when they are passed in the URI as the examples here
|
49
|
+
show. Also note that the user's ARN is not explicitly specified by the client
|
50
|
+
during authentication - the server determines the ARN from the acess
|
51
|
+
key id and the secret access key provided by the client.
|
52
|
+
|
53
|
+
## Provisioning Tools
|
54
|
+
|
55
|
+
The Ruby driver includes tools that set up the resources needed to test
|
56
|
+
AWS authentication. These are exposed by the `.evergreen/aws` script.
|
57
|
+
To use this script, it must be provided AWS credentials and the region
|
58
|
+
to operate in. The credentials and region can be given as command-line
|
59
|
+
arguments or set in the environment, as follows:
|
60
|
+
|
61
|
+
export AWS_ACCESS_KEY_ID=AKIAYOURACCESSKEY
|
62
|
+
export AWS_SECRET_ACCESS_KEY=YOURSECRETACCESSKEY
|
63
|
+
export AWS_REGION=us-east-1
|
64
|
+
|
65
|
+
If you also perform manual testing (for example by following some of the
|
66
|
+
instructions in this file), ensure AWS_SESSION_TOKEN is not set
|
67
|
+
unless you are intending to invoke the `.evergreen/aws` script with
|
68
|
+
temporary credentials:
|
69
|
+
|
70
|
+
unset AWS_SESSION_TOKEN
|
71
|
+
|
72
|
+
Note that [AWS CLI](https://aws.amazon.com/cli/) uses a different environment
|
73
|
+
variable for the region - `AWS_DEFAULT_REGION` rather than `AWS_REGION`.
|
74
|
+
If you also intend to use the AWS CLI, execute:
|
75
|
+
|
76
|
+
export AWS_DEFAULT_REGION=$AWS_REGION
|
77
|
+
|
78
|
+
To verify that credentials are correctly set in the environment, you can
|
79
|
+
perform the following operations:
|
80
|
+
|
81
|
+
# Test driver tooling
|
82
|
+
./.evergreen/aws key-pairs
|
83
|
+
|
84
|
+
# Test AWS CLI
|
85
|
+
aws sts get-caller-identity
|
86
|
+
|
87
|
+
Alternatively, to provide the credentials on each call to the driver's
|
88
|
+
`aws` script, use the `-a` and `-s` arguments as follows:
|
89
|
+
|
90
|
+
./.evergreen/aws -a KEY-ID -s SECRET-KEY key-pairs
|
91
|
+
|
92
|
+
## Common Setup
|
93
|
+
|
94
|
+
In order to test all AWS authentication scenarios, a large number of AWS
|
95
|
+
objects needs to be configured. This configuration is split into two parts:
|
96
|
+
common setup and scenario-specific setup.
|
97
|
+
|
98
|
+
The common setup is performed by running:
|
99
|
+
|
100
|
+
./.evergreen/aws setup-resources
|
101
|
+
|
102
|
+
This creates resources like security groups, IAM users and CloudWatch
|
103
|
+
log groups that do not cost money. It is possible to test authentication
|
104
|
+
with regular credentials and temporary credentials obtained via an
|
105
|
+
AssumeRole request using these resources. In order to test authentication
|
106
|
+
from an EC2 instance or an ECS task, the instance and/or the task need
|
107
|
+
to be started which costs money and is performed as separate steps as
|
108
|
+
detailed below.
|
109
|
+
|
110
|
+
## Regular Credentials - IAM User
|
111
|
+
|
112
|
+
AWS authentication as a regular IAM user requires having an IAM user to
|
113
|
+
authenticate as. This user can be created using the AWS management console.
|
114
|
+
The IAM user requires no permissions, but it must have the programmatic
|
115
|
+
access enabled (i.e. have an access key ID and the secret access key).
|
116
|
+
|
117
|
+
An IAM user is created as part of the common setup described earlier.
|
118
|
+
To reset and retrieve the access key ID and secret access key for the
|
119
|
+
created user, run:
|
120
|
+
|
121
|
+
./.evergreen/aws reset-keys
|
122
|
+
|
123
|
+
Note that if the user already had an access key, the old credentials are
|
124
|
+
removed and replaced with new credentials.
|
125
|
+
|
126
|
+
Given the credentials for the test user, the URI for running the driver
|
127
|
+
test suite can be formed as follows:
|
128
|
+
|
129
|
+
export "MONGODB_URI=mongodb://$AWS_ACCESS_KEY_ID:$AWS_SECRET_ACCESS_KEY@localhost:27017/?authMechanism=MONGODB-AWS&authsource=$external"
|
130
|
+
|
131
|
+
## Temporary Credentials - AssumeRole Request
|
132
|
+
|
133
|
+
To test a user authenticating with an assumed role, you can follow
|
134
|
+
[the example provided in Amazon documentation](https://aws.amazon.com/premiumsupport/knowledge-center/iam-assume-role-cli/)
|
135
|
+
to set up the assumed role and related objects and obtain temporary credentials
|
136
|
+
or use the driver's tooling using the commands given below.
|
137
|
+
Since the temporary credentials expire, the role needs to be re-assumed
|
138
|
+
periodically during testing and the new credentials and session token retrieved.
|
139
|
+
|
140
|
+
If following the example in Amazon's documentation,
|
141
|
+
[jq](https://stedolan.github.io/jq/) can be used to efficiently place the
|
142
|
+
credentials from the AssumeRole request into the environment, as follows:
|
143
|
+
|
144
|
+
# Call given in the example guide
|
145
|
+
aws sts assume-role --role-arn arn:aws:iam::YOUR-ACCOUNT-ID:role/example-role --role-session-name AWSCLI-Session >~/.aws-assumed-role.json
|
146
|
+
|
147
|
+
# Extract the credentials
|
148
|
+
export AWS_ACCESS_KEY_ID=`jq .Credentials.AccessKeyId ~/.aws-assumed-role.json -r`
|
149
|
+
export AWS_SECRET_ACCESS_KEY=`jq .Credentials.SecretAccessKey ~/.aws-assumed-role.json -r`
|
150
|
+
export AWS_SESSION_TOKEN=`jq .Credentials.SessionToken ~/.aws-assumed-role.json -r`
|
151
|
+
|
152
|
+
Alternatively, the `./evergreen/aws` script can be used to assume the role.
|
153
|
+
By default, it will assume the role that `setup-resources` action configured.
|
154
|
+
|
155
|
+
Note: The ability to assume this role is granted to the
|
156
|
+
[IAM user](#regular-credentials-iam-user) that the provisioning tool creates.
|
157
|
+
Therefore the shell must be configured with credentials of the test user,
|
158
|
+
not with credentials of the master user that performed the provisioning.
|
159
|
+
|
160
|
+
To assume the role created by the common setup, run:
|
161
|
+
|
162
|
+
./.evergreen/aws assume-role
|
163
|
+
|
164
|
+
It is also possible to specify the ARN of the role to assume manually, if
|
165
|
+
you created the role using other means:
|
166
|
+
|
167
|
+
./.evergreen/aws assume-role ASSUME-ROLE-ARN
|
168
|
+
|
169
|
+
To place the credentials into the environment:
|
170
|
+
|
171
|
+
eval $(./.evergreen/aws assume-role)
|
172
|
+
export AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_SESSION_TOKEN
|
173
|
+
|
174
|
+
With the credentials in the environment, to verify that the role was assumed
|
175
|
+
and the credentials are complete and correct, perform a `GetCallerIdentity`
|
176
|
+
call:
|
177
|
+
|
178
|
+
aws sts get-caller-identity
|
179
|
+
|
180
|
+
Given the credentials for the test user, the URI for running the driver
|
181
|
+
test suite can be formed as follows:
|
182
|
+
|
183
|
+
export "MONGODB_URI=mongodb://$AWS_ACCESS_KEY_ID:$AWS_SECRET_ACCESS_KEY@localhost:27017/?authMechanism=MONGODB-AWS&authsource=$external&authMechanismProperties=AWS_SESSION_TOKEN:$AWS_SESSION_TOKEN"
|
184
|
+
|
185
|
+
## Temporary Credentials - EC2 Instance Role
|
186
|
+
|
187
|
+
To test authentication [using temporary credentials for an EC2 instance
|
188
|
+
role](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2.html),
|
189
|
+
an EC2 instance launched with an IAM role or an EC2 instance configured
|
190
|
+
with an instance profile is required. No permissions are needed for the
|
191
|
+
IAM role used with the EC2 instance.
|
192
|
+
|
193
|
+
To create an EC2 instance with an attached role using the AWS console:
|
194
|
+
|
195
|
+
1. Crate an IAM role that the instance will use. It is not necessary to
|
196
|
+
specify any permissions.
|
197
|
+
2. Launch an instance, choosing the IAM role created in the launch wizard.
|
198
|
+
|
199
|
+
To define an instance profile which allows adding and removing an IAM role
|
200
|
+
to/from an instance at runtime, follow Amazon documentation
|
201
|
+
[here](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html#attach-iam-role).
|
202
|
+
To test temporary credentials obtained via an EC2 instance role in Evergreen,
|
203
|
+
an instance profile must be associated with the running instance as per
|
204
|
+
this guide.
|
205
|
+
|
206
|
+
The driver provides tooling to configure a suitable instance profile and
|
207
|
+
launch an EC2 instance that can have this instance profile attached to it.
|
208
|
+
|
209
|
+
The instance profile and associated IAM role are created by the common
|
210
|
+
setup described above. To launch an EC2 instance suitable for testing
|
211
|
+
authentication via an EC2 role, run:
|
212
|
+
|
213
|
+
./.evergreen/aws launch-ec2 path/to/ssh.key.pub
|
214
|
+
|
215
|
+
The `launch-ec2` command takes one argument which is the path to the
|
216
|
+
public key for the key pair to use for SSH access to the instance.
|
217
|
+
|
218
|
+
This script will output the instance ID of the launched instance. The
|
219
|
+
instance initially does not have an instance profile assigned; to assign
|
220
|
+
the instance profile created in the common setup to the instance, run:
|
221
|
+
|
222
|
+
./.evergreen/aws set-instance-profile i-instanceid
|
223
|
+
|
224
|
+
To remove the instance profile from the instance, run:
|
225
|
+
|
226
|
+
./.evergreen/aws clear-instance-profile i-instanceid
|
227
|
+
|
228
|
+
To provision the instance for running the driver's test suite via Docker, run:
|
229
|
+
|
230
|
+
ip=12.34.56.78
|
231
|
+
./.evergreen/provision-remote ubuntu@$ip docker
|
232
|
+
|
233
|
+
To run the AWS auth tests using the EC2 instance role credentials, run:
|
234
|
+
|
235
|
+
./.evergreen/test-docker-remote ubuntu@$ip \
|
236
|
+
MONGODB_VERSION=4.4 AUTH=aws-ec2 \
|
237
|
+
-s .evergreen/run-tests-aws-auth.sh \
|
238
|
+
-a .env.private
|
239
|
+
|
240
|
+
Note that if if you are not using MongoDB AWS account for testing, you
|
241
|
+
would need to specify MONGO_RUBY_DRIVER_AWS_AUTH_USER_ARN in your
|
242
|
+
`.env.private` file with the ARN of the user to add to MongoDB. The easiest
|
243
|
+
way to find out this value is to run the tests and note which username the
|
244
|
+
test suite is trying to authenticate as.
|
245
|
+
|
246
|
+
To terminate the instance, run:
|
247
|
+
|
248
|
+
./.evergreen/aws stop-ec2
|
249
|
+
|
250
|
+
## Temporary Credentials - ECS Task Role
|
251
|
+
|
252
|
+
The basic procedure for setting up an ECS cluster is described in
|
253
|
+
[this guide](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ECS_AWSCLI_Fargate.html).
|
254
|
+
For testing AWS auth, the ECS task must have a role assigned to it which is
|
255
|
+
covered in [this guide](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html)
|
256
|
+
and additionally [here](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html).
|
257
|
+
|
258
|
+
Although not required for testing AWS auth specifically, it is very helpful
|
259
|
+
for general troubleshooting of ECS provisioning to have log output from the
|
260
|
+
tasks. Logging to CloudWatch is covered by [this Amazon guide](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/QuickStartEC2Instance.html)
|
261
|
+
with these potentially helpful [additional](https://stackoverflow.com/questions/50397217/how-to-determine-the-cloudwatch-log-stream-for-a-fargate-service#50704804)
|
262
|
+
[resources](https://help.sumologic.com/03Send-Data/Collect-from-Other-Data-Sources/AWS_Fargate_log_collection).
|
263
|
+
A log group must be manually created, the steps for which are described
|
264
|
+
[here](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html).
|
265
|
+
|
266
|
+
Additional references:
|
267
|
+
|
268
|
+
- [Task definition CPU and memory values](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/create-task-definition.html)
|
269
|
+
|
270
|
+
The common setup creates all of the necessary prerequisites to test
|
271
|
+
authentication using ECS task credentials, which includes an empty ECS
|
272
|
+
cluster. To test authentication, a service needs to be created in the
|
273
|
+
ECS cluster that runs the SSH daemon, which can be done by running:
|
274
|
+
|
275
|
+
./.evergreen/aws launch-ecs path/to/ssh.key.pub
|
276
|
+
|
277
|
+
The `launch-ecs` command takes one argument which is the path to the
|
278
|
+
public key for the key pair to use for SSH access to the instance.
|
279
|
+
|
280
|
+
This script generally produces no output if it succeeds. As the service takes
|
281
|
+
some time to start, run the following command to check its status:
|
282
|
+
|
283
|
+
./.evergreen/aws ecs-status
|
284
|
+
|
285
|
+
The status output shows the tasks running in the ECS cluster ordered by their
|
286
|
+
generation, with the newest ones first. Event log for the cluster is displayed,
|
287
|
+
as well as event stream for the running task of the latest available generation
|
288
|
+
which includes the Docker execution output collected via CloudWatch.
|
289
|
+
The status output includes the public IP of the running task once it is
|
290
|
+
available, which can be used to SSH into the container and run the tests.
|
291
|
+
|
292
|
+
Note that when AWS auth from an ECS task is tested in Evergreen, the task is
|
293
|
+
accessed via its private IP; when the test is performed using the provisioning
|
294
|
+
tooling described in this document, the task is accessed via its public IP.
|
295
|
+
|
296
|
+
If the public IP address is in the `IP` shell variable, provision the task:
|
297
|
+
|
298
|
+
./.evergreen/provision-remote root@$IP local
|
299
|
+
|
300
|
+
To run the credentials retrieval test on the ECS task, execute:
|
301
|
+
|
302
|
+
./.evergreen/test-remote root@$IP env AUTH=aws-ecs RVM_RUBY=ruby-2.7 MONGODB_VERSION=4.4 TEST_CMD='rspec spec/integration/aws*spec.rb' .evergreen/run-tests.sh
|
303
|
+
|
304
|
+
To run the test again without rebuilding the remote environment, execute:
|
305
|
+
|
306
|
+
./.evergreen/test-remote -e root@$IP \
|
307
|
+
env AUTH=aws-ecs RVM_RUBY=ruby-2.7 sh -c '\
|
308
|
+
export PATH=`pwd`/rubies/ruby-2.7/bin:$PATH && \
|
309
|
+
eval export `strings /proc/1/environ |grep ^AWS_CONTAINER_CREDENTIALS_RELATIVE_URI` && \
|
310
|
+
bundle exec rspec spec/integration/aws*spec.rb'
|
311
|
+
|
312
|
+
Note that this command retrieves the value of `AWS_CONTAINER_CREDENTIALS_RELATIVE_URI`
|
313
|
+
from the PID 1 environment and places it into the current environment prior to
|
314
|
+
running the tests.
|
315
|
+
|
316
|
+
To terminate the AWS auth-related ECS tasks, run:
|
317
|
+
|
318
|
+
./.evergreen/aws stop-ecs
|