apache / apache/pulsar

Support invalidating client's OAuth2 token after receiving an authentication exception

Open
#20,107 3 comments 0 reactions 0 assignees View on GitHub
area/authn area/client Stale type/enhancement
Dominant language
Java
Stars
15.3k
Forks
3.8k
Avg merge
1d 14h
Merged PRs (30d)
160

Description

### Search before asking

- [X] I searched in the [issues](https://github.com/apache/pulsar/issues) and found nothing similar.

### Motivation

The `AuthenticationOAuth2` provider only retrieves a new token when the current one has expired.

https://github.com/apache/pulsar/blob/82237d3684fe506bcb6426b3b23f413422e6e4fb/pulsar-client/src/main/java/org/apache/pulsar/client/impl/auth/oauth2/AuthenticationOAuth2.java#L99-L106

However, when there is an unexpected signing key rotation, which can happen for several reasons, a client will fail to authenticate until the token expires.

### Solution

The client could invalidate the cached token and retrieve a new one. Note that this is happening when authentication has already failed, so the current token is already known to be invalid.

### Alternatives

_No response_

### Anything else?

_No response_

### Are you willing to submit a PR?

- [ ] I'm willing to submit a PR!

Contributor guide

Open the contributing guide

Research direction

Start in pulsar-client/src/main/java/org/apache/pulsar/client/impl/auth/oauth2/AuthenticationOAuth2.java, especially the token retrieval and caching code at the linked lines. Trace where authentication exceptions are handled and identify the relevant client tests before changing behavior. Done means a cached token is invalidated after the described authentication failure and a fresh token can be retrieved.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
authentication
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.