[client-v1,client-v2, auth] Implemented authentication via http basic auth #1892
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mzitnik
reviewed
Oct 30, 2024
| } else if (!ClickHouseChecker.isNullOrEmpty(credentials.getPassword())) { | ||
| map.put("x-clickhouse-key", credentials.getPassword()); | ||
| } else { | ||
| String password = credentials.getPassword() == null ? "" : credentials.getPassword(); |
There was a problem hiding this comment.
Just to understand you have changed the logic to use Basic authorization to avoid the illegal characters.
There was a problem hiding this comment.
Yes, I've changed this logic to avoid problem with different characters.
So even sequence =? is getting problem.
Additionally it does things more standard.
Javascript Client uses this approach as default - https://github.com/ClickHouse/clickhouse-js/blob/main/packages/client-node/src/connection/node_base_connection.ts#L87
mzitnik
approved these changes
Oct 30, 2024
|
@chernser please validate discussed |
|
mzitnik
approved these changes
Oct 31, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Password can be passed as value of the
X-ClickHouse-Keyheader docs. But header values have some limitations about what characters can be used (learned from practical tests and https://www.rfc-editor.org/rfc/rfc7230#section-3.2.6) what would require escaping special chars. Basic authentication helps to avoid all this and is standard authentication mechanism.This PR changes both clients (v1, v2).
New configuration parameter is added:
com.clickhouse.client.http.config.ClickHouseHttpOption#USE_BASIC_AUTHENTICATION- allows to switch using ClickHouseX-headers to authenticate. Default is using basic auth.Closes: #1305
Checklist
Delete items not relevant to your PR: