Skip to content

Support scram-sha-256 out of the box #1481

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

Merged
merged 1 commit into from
May 6, 2025
Merged

Support scram-sha-256 out of the box #1481

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 0 additions & 1 deletion vertx-pg-client/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,6 @@
<groupId>com.ongres.scram</groupId>
<artifactId>scram-client</artifactId>
<version>3.1</version>
<optional>true</optional>
</dependency>

<!-- Testing purposes -->
Expand Down
23 changes: 2 additions & 21 deletions vertx-pg-client/src/main/asciidoc/index.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,28 +233,9 @@ $ PGUSER=user \

=== SASL SCRAM-SHA-256 authentication mechanism.

To use the SASL `SCRAM-SHA-256` authentication add the following dependency to the _dependencies_ section of your build descriptor:
The `vertx-pg-client` supports the `SCRAM-SHA-256` and `SCRAM-SHA-256-PLUS` SASL authentication. From version v5.0.0 on `vertx-pg-client` ships with the `com.ongres.scram` library dependency, when migrating from an older version `vertx-pg-client` users can remove the `com.ongres.scram` library from their `pom.xml` and `build.gradle` files.

* Maven (in your `pom.xml`):

[source,xml]
----
<dependency>
<groupId>com.ongres.scram</groupId>
<artifactId>scram-client</artifactId>
<version>3.1</version>
</dependency>
----
* Gradle (in your `build.gradle` file):

[source,groovy]
----
dependencies {
compile 'com.ongres.scram:scram-client:3.1'
}
----

When the database requires a scram authentication and the scram client jar is not on the class/module path, the connection will be closed by the client.
If a client uses other auth methods only then the transitive `com.ongres.scram` dependency can be excluded using maven `<exclusions>` or gradle `exclude` to reduce the software size.

include::queries.adoc[leveloffset=1]

Expand Down
Loading