Skip to content

Update socks5.md to remove conversion artifacts #1811

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Update socks5.md to remove conversion artifacts #1811

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b532749
Update socks5.md to remove conversion artifacts
papafe Jun 23, 2025
89b28d0
Update source/socks5-support/socks5.md
papafe Jun 23, 2025
75ad423
Corrections according to mdformat.
papafe Jun 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 13 additions & 12 deletions source/socks5-support/socks5.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,18 +47,18 @@ the level of a `MongoClient`. Drivers MUST error if this option was specified an
#### proxyUsername

To specify to the driver to connect using a SOCKS5 proxy requiring username/password authentication, a connection string
option of - Code:`proxyUsername=username` MUST be added to the connection string or passed through an equivalent
`MongoClient` option. This option specifies a string of non-zero length. Drivers MUST ignore this option if it specifies
a zero-length string. Drivers MUST error if this option was specified and `proxyHost` was not specified or
`proxyPassword` was not specified.
option of `proxyUsername=username` MUST be added to the connection string or passed through an equivalent `MongoClient`
option. This option specifies a string of non-zero length. Drivers MUST ignore this option if it specifies a zero-length
string. Drivers MUST error if this option was specified and `proxyHost` was not specified or `proxyPassword` was not
specified.

#### proxyPassword

To specify to the driver to connect using a SOCKS5 proxy requiring username/password authentication, a connection string
option of - Code:`proxyPassword=password` MUST be added to the connection string or passed through an equivalent
`MongoClient` option. This option specifies a string of non-zero length. Drivers MUST ignore this option if it specifies
a zero-length string. Drivers MUST error if this option was specified and `proxyHost` was not specified or
`proxyUsername` was not specified.
option of `proxyPassword=password` MUST be added to the connection string or passed through an equivalent `MongoClient`
option. This option specifies a string of non-zero length. Drivers MUST ignore this option if it specifies a zero-length
string. Drivers MUST error if this option was specified and `proxyHost` was not specified or `proxyUsername` was not
specified.

### Connection Pooling

Expand All @@ -82,17 +82,17 @@ When establishing a new outgoing TCP connection, drivers MUST perform the follow
Drivers MUST use the SOCKS5 proxy for connections to MongoDB services and
[client-side field-level encryption KMS servers](../client-side-encryption/client-side-encryption.md#kms-provider).

Drivers MUST NOT use the SOCKS5 proxy for connections to - Code:`mongocryptd` processes spawned for automatic
client-side field-level encryption.
Drivers MUST NOT use the SOCKS5 proxy for connections to `mongocryptd` processes spawned for automatic client-side
field-level encryption.

Drivers MUST treat a connection failure when connecting to the SOCKS5 proxy or a SOCKS5 handshake or authentication
failure the same as a network error (e.g. `ECONNREFUSED`).

### Events

SOCKS5 proxies are fully transparent to connection monitoring events. In particular, in `CommandStartedEvent`,
`CommandSucceededEvent`, and - Code:`CommandFailedEvent`, the driver SHOULD NOT reference the SOCKS5 proxy as part of
the `connectionId` field or other fields.
`CommandSucceededEvent`, and `CommandFailedEvent`, the driver SHOULD NOT reference the SOCKS5 proxy as part of the
`connectionId` field or other fields.

### Q&A

Expand Down Expand Up @@ -128,5 +128,6 @@ with enabling other authentication methods.

## Changelog

- 2025-06-23: Removed artifacts from conversion to Markdown.
- 2024-09-04: Migrated from reStructuredText to Markdown.
- 2022-10-05: Remove spec front matter
Loading