[auth] Support refresh tokens for OAuth
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 45/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- java
- Domain
- api, authentication, backend
Research direction
The issue describes adding OAuth refresh token support to the ClickHouse Java client. Start by examining the existing authentication and connection handling code, likely in packages related to client configuration and HTTP/API communication. Look for where JWT tokens are currently managed and where token expiration errors are thrown. The solution involves designing a callback interface, a default implementation, and integrating this with the JDBC driver. Check for existing tests around authentication to understand the current behavior and add tests for the new refresh flow.
Written by the indexing model from the issue text.
Description
Description
ClickHouse Cloud supports JWT for Authentication. This opens a way to support OAuth 2.0. This standard is used to authenticate users for accessing service (and more). There is a thing called "Refresh token" that helps to reduce life of access token and avoid frequent user interactions. It is all needed because JWT is signed "key" to access something and by designed it cannot be invalidated in real time until it expires. So short TTL would solve problem of invalidating tokens faster but it creates problem of requesting new access token too frequently. Thus another "refresh" token comes into play - it is used to request next pair of access token / refresh token from authentication provider without user interaction. If user has no more access to resources / service it tries to reach then refresh fails.
Read more https://auth0.com/docs/secure/tokens/refresh-tokens
There is a mostly standard procedure of getting tokens described here
Client should handled expired token error from ClickHouse Cloud and call the procedure.
Documentation should state that if operation has some timeout this refresh will make request to fail but anyway.
Design
- there should be callback for token expiration errors. Just a callback that can be implemented by user
- there should be a default callback implementation with own config that can do "standard" refresh. config should be prefixed with "ouath_refresh_".
- when callback is not set exception is thrown to application
- token refresh code should be usable to run in timer when application want to avoid expiration of a previous JWT (useful when need to have strict timeout on operation and handle auto-refresh)
- there should be a solution for JDBC
- Dominant language
- Java
- Stars
- 1.6k
- Forks
- 637
- Avg merge
- 2d 17h
- Merged PRs (30d)
- 29
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from ClickHouse/clickhouse-java
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
ClickHouse/clickhouse-java#3111 ·
-
area:data-type bug
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
ClickHouse/clickhouse-java#3098 · 1 comment ·
-
bug client-api-v2 test
Difficulty 2/5 1-3 hours Newbie friendliness 92/100
ClickHouse/clickhouse-java#3076 ·
-
area:sql-parser bug client-v1
Difficulty 1/5 1-3 hours Newbie friendliness 92/100
ClickHouse/clickhouse-java#3066 ·
-
area:general bug client-api-v2 jdbc jdbc-v2
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
ClickHouse/clickhouse-java#3063 ·
All issues in ClickHouse/clickhouse-java
Similar issues
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
inu-appcenter/memorIN-backend#288 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
frontend maui-pilot pilot-ask question
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
area/plugin
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
kestra-io/plugin-kestra#190 ·