KAFAK-14604: SASL session expiration time will be overflowed when calculation #16
Conversation
…culation Signed-off-by: PoAn Yang <[email protected]>
|
This PR is being marked as stale since it has not had any activity in 90 days. If you If you are having difficulty finding a reviewer, please reach out on the [mailing list](https://kafka.apache.org/contact). If this PR is no longer valid or desired, please feel free to close it. If no activity occurs in the next 30 days, it will be automatically closed. |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hello @arvi18, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
Summary of Changes
This pull request addresses a potential overflow issue in the calculation of SASL session expiration time. The issue arises when a large session lifetime is configured, potentially leading to an ArithmeticException. To resolve this, I've implemented a change that uses Math.addExact and Utils.msToNs to perform the calculation, which throws an exception if an overflow occurs. Additionally, I've added a test case to verify the fix and ensure that the channel closes when a large re-authentication value is used.
Highlights
- Overflow Prevention: The core change involves replacing the direct multiplication and addition with
Math.addExact(authenticationEndNanos, Utils.msToNs(sessionLifetimeMsToUse))to prevent potential overflow when calculatingclientSessionReauthenticationTimeNanosinSaslClientAuthenticator.javaandsessionExpirationTimeNanosinSaslServerAuthenticator.java. - Utility Function: A new utility function
msToNsis introduced inUtils.javato convert milliseconds to nanoseconds, throwing anIllegalArgumentExceptionif an arithmetic overflow occurs during the conversion. - Test Case: A new test case
testReauthenticateWithLargeReauthValueis added inSaslAuthenticatorTest.javato simulate the overflow scenario and verify that the connection channel is closed as expected.
Changelog
Click here to see the changelog
- clients/src/main/java/org/apache/kafka/common/security/authenticator/SaslClientAuthenticator.java
- Replaced direct calculation of
clientSessionReauthenticationTimeNanoswithMath.addExactandUtils.msToNsto prevent overflow.
- Replaced direct calculation of
- clients/src/main/java/org/apache/kafka/common/security/authenticator/SaslServerAuthenticator.java
- Replaced direct calculation of
sessionExpirationTimeNanoswithMath.addExactandUtils.msToNsto prevent overflow.
- Replaced direct calculation of
- clients/src/main/java/org/apache/kafka/common/utils/Utils.java
- Added
msToNsutility function to convert milliseconds to nanoseconds with overflow check.
- Added
- clients/src/test/java/org/apache/kafka/common/security/authenticator/SaslAuthenticatorTest.java
- Added
needLargeExpirationflag to control the lifetime of the token. - Added
testReauthenticateWithLargeReauthValuetest case to verify overflow handling during re-authentication with a large re-authentication value. - Modified
createClientConnectionto usecreateCustomClientConnection.
- Added
- clients/src/test/java/org/apache/kafka/common/security/authenticator/SaslServerAuthenticatorTest.java
- Added
testSessionWontExpireWithLargeExpirationTimetest case to verify the overflow exception is thrown when a large expiration time is configured.
- Added
- clients/src/test/java/org/apache/kafka/common/utils/UtilsTest.java
- Added
testMsToNstest case to verify themsToNsutility function.
- Added
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
In nanoseconds' dance,
Overflow's a risky chance,
Guard with Math's embrace,
Exceptions find their place,
Code's safety, we enhance.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
The pull request addresses a potential overflow issue in the calculation of SASL session expiration time. The fix involves using Math.addExact and Utils.msToNs to prevent overflow and throwing an exception if overflow occurs. Additionally, a test case is added to verify the fix. Overall, the changes seem reasonable and well-structured.
Summary of Findings
- Exception handling: The code throws an
IllegalArgumentExceptionwhen an arithmetic overflow occurs during the conversion of milliseconds to nanoseconds. While this addresses the immediate issue, consider whether a more specific exception type might be appropriate to provide better context to callers. - Test coverage: The added test case
testReauthenticateWithLargeReauthValueinSaslAuthenticatorTest.javaeffectively tests the overflow scenario. However, consider adding additional test cases with different large values to ensure robustness.
Merge Readiness
The pull request addresses a critical issue and includes a test case to verify the fix. However, before merging, it's recommended to consider the exception type and add more test cases for robustness. I am unable to approve this pull request, and users should have others review and approve this code before merging.
| @@ -681,7 +681,7 @@ else if (!maxReauthSet) | |||
| else | |||
| retvalSessionLifetimeMs = zeroIfNegative(Math.min(credentialExpirationMs - authenticationEndMs, connectionsMaxReauthMs)); | |||
|
|
|||
| sessionExpirationTimeNanos = authenticationEndNanos + 1000 * 1000 * retvalSessionLifetimeMs; | |||
| sessionExpirationTimeNanos = Math.addExact(authenticationEndNanos, Utils.msToNs(retvalSessionLifetimeMs)); | |||
There was a problem hiding this comment.
Similar to the change in SaslClientAuthenticator.java, this change uses Math.addExact and Utils.msToNs to prevent potential overflow. This is consistent and correct.
| sessionExpirationTimeNanos = Math.addExact(authenticationEndNanos, Utils.msToNs(retvalSessionLifetimeMs)); | |
| sessionExpirationTimeNanos = Math.addExact(authenticationEndNanos, Utils.msToNs(retvalSessionLifetimeMs)); |
| public static long msToNs(long timeMs) { | ||
| try { | ||
| return Math.multiplyExact(1000 * 1000, timeMs); | ||
| } catch (ArithmeticException e) { | ||
| throw new IllegalArgumentException("Cannot convert " + timeMs + " millisecond to nanosecond due to arithmetic overflow", e); | ||
| } |
There was a problem hiding this comment.
The msToNs method converts milliseconds to nanoseconds and throws an IllegalArgumentException if an arithmetic overflow occurs. Consider using a more specific exception type, such as ArithmeticException, to provide better context to callers.
| public static long msToNs(long timeMs) { | |
| try { | |
| return Math.multiplyExact(1000 * 1000, timeMs); | |
| } catch (ArithmeticException e) { | |
| throw new IllegalArgumentException("Cannot convert " + timeMs + " millisecond to nanosecond due to arithmetic overflow", e); | |
| } | |
| public static long msToNs(long timeMs) { | |
| try { | |
| return Math.multiplyExact(1000 * 1000, timeMs); | |
| } catch (ArithmeticException e) { | |
| throw e; // re-throw the ArithmeticException | |
| } | |
| } |
| public void testMsToNs() { | ||
| assertEquals(1000000, Utils.msToNs(1)); | ||
| assertEquals(0, Utils.msToNs(0)); | ||
| assertThrows(IllegalArgumentException.class, () -> Utils.msToNs(Long.MAX_VALUE)); |
There was a problem hiding this comment.
This test case verifies that an IllegalArgumentException is thrown when msToNs is called with Long.MAX_VALUE. Consider adding additional test cases with different large values to ensure robustness.
assertThrows(IllegalArgumentException.class, () -> Utils.msToNs(Long.MAX_VALUE));
assertThrows(IllegalArgumentException.class, () -> Utils.msToNs(Long.MAX_VALUE - 1));
assertThrows(IllegalArgumentException.class, () -> Utils.msToNs(Long.MAX_VALUE / 2));
|
Warning Rate limit exceeded@visz11 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 18 minutes and 18 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (6)
✨ Finishing Touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
@coderabbitai full review |
✅ Actions performedFull review triggered. |
The timeout value may be overflowed if users set a large expiration time.
Fixed it by throwing exception if the value is overflowed.
Committer Checklist (excluded from commit message)