From 1f192d789ad84d22ad71963ffd03f6b1d63dc6cb Mon Sep 17 00:00:00 2001 From: b1ron Date: Wed, 12 Jul 2023 00:56:47 +0200 Subject: [PATCH 1/7] add a note about setting the stable API version --- website/docs/security/authentication.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/website/docs/security/authentication.md b/website/docs/security/authentication.md index a53d2a666ba7..a334fe6a7bef 100644 --- a/website/docs/security/authentication.md +++ b/website/docs/security/authentication.md @@ -92,3 +92,11 @@ A client that specify username and password in MongoDB URI as below is authentic docker run --rm -it --network=ferretdb --entrypoint=mongosh \ mongo 'mongodb://user2:pass2@ferretdb/ferretdb?authMechanism=PLAIN' ``` + +## Driver Compatibility Issues + +**NOTE** Some drivers may use legacy opcodes during their authentication handshake. + +If you encounter any issues while authenticating with FerretDB using a driver, try setting the Stable API version to V1 on the client. Please refer to your specific driver documentation on how to set this field. + +If you encounter any other issues file a bug report [here](https://github.com/FerretDB/FerretDB/issues/new?assignees=ferretdb-bot&labels=code%2Fbug%2Cnot+ready&projects=&template=bug.yml). From eeae92da48b2a0d3fff857f5904d7f8742a29b53 Mon Sep 17 00:00:00 2001 From: b1ron Date: Wed, 12 Jul 2023 12:13:30 +0200 Subject: [PATCH 2/7] make wording better --- website/docs/security/authentication.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/website/docs/security/authentication.md b/website/docs/security/authentication.md index a334fe6a7bef..7c8256e59160 100644 --- a/website/docs/security/authentication.md +++ b/website/docs/security/authentication.md @@ -93,10 +93,8 @@ docker run --rm -it --network=ferretdb --entrypoint=mongosh \ mongo 'mongodb://user2:pass2@ferretdb/ferretdb?authMechanism=PLAIN' ``` -## Driver Compatibility Issues +## Authentication Handshake -**NOTE** Some drivers may use legacy opcodes during their authentication handshake. +An [authentication handshake](https://github.com/mongodb/specifications/blob/master/source/auth/auth.rst#authentication-handshake) consists of an initial `hello` or legacy `hello` command possibly followed by one or more authentication conversations. Some drivers may still use the legacy `hello` command to complete a handshake. If you encounter issues that indicate this behvavior, it may be possible to prevent the legacy `hello` command by setting the Stable API version to V1 on the client. Please refer to your specific driver documentation on how to set this field. -If you encounter any issues while authenticating with FerretDB using a driver, try setting the Stable API version to V1 on the client. Please refer to your specific driver documentation on how to set this field. - -If you encounter any other issues file a bug report [here](https://github.com/FerretDB/FerretDB/issues/new?assignees=ferretdb-bot&labels=code%2Fbug%2Cnot+ready&projects=&template=bug.yml). +If this does not resolve your issue please file a bug report [here](https://github.com/FerretDB/FerretDB/issues/new?assignees=ferretdb-bot&labels=code%2Fbug%2Cnot+ready&projects=&template=bug.yml). From 88c38714b5a9f612e58ad9c83bff10cf59fb15a2 Mon Sep 17 00:00:00 2001 From: b1ron Date: Wed, 12 Jul 2023 12:23:51 +0200 Subject: [PATCH 3/7] fix --- website/docs/security/authentication.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/security/authentication.md b/website/docs/security/authentication.md index 7c8256e59160..1c3a34376550 100644 --- a/website/docs/security/authentication.md +++ b/website/docs/security/authentication.md @@ -95,6 +95,6 @@ docker run --rm -it --network=ferretdb --entrypoint=mongosh \ ## Authentication Handshake -An [authentication handshake](https://github.com/mongodb/specifications/blob/master/source/auth/auth.rst#authentication-handshake) consists of an initial `hello` or legacy `hello` command possibly followed by one or more authentication conversations. Some drivers may still use the legacy `hello` command to complete a handshake. If you encounter issues that indicate this behvavior, it may be possible to prevent the legacy `hello` command by setting the Stable API version to V1 on the client. Please refer to your specific driver documentation on how to set this field. +An [authentication handshake](https://github.com/mongodb/specifications/blob/master/source/auth/auth.rst#authentication-handshake) consists of an initial `hello` or legacy `hello` command possibly followed by one or more authentication conversations. Some drivers may still use the legacy `hello` command to complete a handshake. If you are not able to authenticate with FerretDB this could indicate that the driver is using legacy Wire Protocol messages. In certain drivers it may be possible to prevent legacy behavior this by setting the Stable API version to V1 on the client. Please refer to your specific driver documentation on how to set this field. If this does not resolve your issue please file a bug report [here](https://github.com/FerretDB/FerretDB/issues/new?assignees=ferretdb-bot&labels=code%2Fbug%2Cnot+ready&projects=&template=bug.yml). From 1f968d6adfae848642722f7bc8b1df7732cf2f29 Mon Sep 17 00:00:00 2001 From: b1ron Date: Wed, 12 Jul 2023 12:30:44 +0200 Subject: [PATCH 4/7] fix --- website/docs/security/authentication.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/website/docs/security/authentication.md b/website/docs/security/authentication.md index 1c3a34376550..33a1f13be9a3 100644 --- a/website/docs/security/authentication.md +++ b/website/docs/security/authentication.md @@ -95,6 +95,8 @@ docker run --rm -it --network=ferretdb --entrypoint=mongosh \ ## Authentication Handshake -An [authentication handshake](https://github.com/mongodb/specifications/blob/master/source/auth/auth.rst#authentication-handshake) consists of an initial `hello` or legacy `hello` command possibly followed by one or more authentication conversations. Some drivers may still use the legacy `hello` command to complete a handshake. If you are not able to authenticate with FerretDB this could indicate that the driver is using legacy Wire Protocol messages. In certain drivers it may be possible to prevent legacy behavior this by setting the Stable API version to V1 on the client. Please refer to your specific driver documentation on how to set this field. +**NOTE** Some drivers may still use the legacy `hello` command to complete a handshake. + +If you encounter any issues while authenticating with FerretDB, try setting the Stable API version to V1 on the client as this may prevent legacy commands from being used. Please refer to your specific driver documentation on how to set this field. If this does not resolve your issue please file a bug report [here](https://github.com/FerretDB/FerretDB/issues/new?assignees=ferretdb-bot&labels=code%2Fbug%2Cnot+ready&projects=&template=bug.yml). From f0d1a682c6313a6661bcd374f8160c4c9b135e48 Mon Sep 17 00:00:00 2001 From: b1ron <80292536+b1ron@users.noreply.github.com> Date: Wed, 12 Jul 2023 12:53:48 +0200 Subject: [PATCH 5/7] Update website/docs/security/authentication.md Co-authored-by: Alexander Tobi Fashakin --- website/docs/security/authentication.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/website/docs/security/authentication.md b/website/docs/security/authentication.md index 33a1f13be9a3..bcfaa959015e 100644 --- a/website/docs/security/authentication.md +++ b/website/docs/security/authentication.md @@ -95,7 +95,9 @@ docker run --rm -it --network=ferretdb --entrypoint=mongosh \ ## Authentication Handshake -**NOTE** Some drivers may still use the legacy `hello` command to complete a handshake. +:::note +Some drivers may still use the legacy `hello` command to complete a handshake. +::: If you encounter any issues while authenticating with FerretDB, try setting the Stable API version to V1 on the client as this may prevent legacy commands from being used. Please refer to your specific driver documentation on how to set this field. From c72220534632dd77b095d89ba851f161daa2a93c Mon Sep 17 00:00:00 2001 From: b1ron Date: Wed, 12 Jul 2023 13:56:49 +0200 Subject: [PATCH 6/7] fix --- website/docs/security/authentication.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/website/docs/security/authentication.md b/website/docs/security/authentication.md index bcfaa959015e..befa7f8aa3d4 100644 --- a/website/docs/security/authentication.md +++ b/website/docs/security/authentication.md @@ -99,6 +99,7 @@ docker run --rm -it --network=ferretdb --entrypoint=mongosh \ Some drivers may still use the legacy `hello` command to complete a handshake. ::: -If you encounter any issues while authenticating with FerretDB, try setting the Stable API version to V1 on the client as this may prevent legacy commands from being used. Please refer to your specific driver documentation on how to set this field. +If you encounter any issues while authenticating with FerretDB, try setting the Stable API version to V1 on the client as this may prevent legacy commands from being used. +Please refer to your specific driver documentation on how to set this field. If this does not resolve your issue please file a bug report [here](https://github.com/FerretDB/FerretDB/issues/new?assignees=ferretdb-bot&labels=code%2Fbug%2Cnot+ready&projects=&template=bug.yml). From b6d89b267d48badb231be0fca6674ff0ff6e9d80 Mon Sep 17 00:00:00 2001 From: b1ron Date: Thu, 13 Jul 2023 13:50:55 +0200 Subject: [PATCH 7/7] fmt --- website/docs/security/authentication.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/security/authentication.md b/website/docs/security/authentication.md index befa7f8aa3d4..ddbfe79ab29c 100644 --- a/website/docs/security/authentication.md +++ b/website/docs/security/authentication.md @@ -99,7 +99,7 @@ docker run --rm -it --network=ferretdb --entrypoint=mongosh \ Some drivers may still use the legacy `hello` command to complete a handshake. ::: -If you encounter any issues while authenticating with FerretDB, try setting the Stable API version to V1 on the client as this may prevent legacy commands from being used. +If you encounter any issues while authenticating with FerretDB, try setting the Stable API version to V1 on the client as this may prevent legacy commands from being used. Please refer to your specific driver documentation on how to set this field. If this does not resolve your issue please file a bug report [here](https://github.com/FerretDB/FerretDB/issues/new?assignees=ferretdb-bot&labels=code%2Fbug%2Cnot+ready&projects=&template=bug.yml).