Skip to content
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

KNOX-3075 - Handling unlimited token expiration in JDBC TSS properly #970

Merged
merged 1 commit into from
Nov 26, 2024
Merged

KNOX-3075 - Handling unlimited token expiration in JDBC TSS properly #970

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
8 changes: 4 additions & 4 deletions ...rver/src/main/java/org/apache/knox/gateway/services/token/impl/JDBCTokenStateService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,21 +158,21 @@ public long getTokenExpiration(String tokenId, boolean validate) throws UnknownT
validateToken(tokenId);
}

long expiration = 0;
try {
expiration = tokenDatabase.getTokenExpiration(tokenId);
if (expiration > 0) {
final Long expiration = tokenDatabase.getTokenExpiration(tokenId);
if (expiration != null) {
log.fetchedExpirationFromDatabase(Tokens.getTokenIDDisplayText(tokenId), expiration);

// Update the in-memory cache to avoid subsequent DB look-ups for the same state
super.updateExpiration(tokenId, expiration);
return expiration;
} else {
throw new UnknownTokenException(tokenId);
}
} catch (SQLException e) {
log.errorFetchingExpirationFromDatabase(Tokens.getTokenIDDisplayText(tokenId), e.getMessage(), e);
throw new TokenStateServiceException("An error occurred while fetching expiration for " + Tokens.getTokenIDDisplayText(tokenId) + " from the database", e);
}
return expiration;
}

@Override
Expand Down
4 changes: 2 additions & 2 deletions ...-server/src/main/java/org/apache/knox/gateway/services/token/impl/TokenStateDatabase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,11 +99,11 @@ long getTokenIssueTime(String tokenId) throws SQLException {
}
}

long getTokenExpiration(String tokenId) throws SQLException {
Long getTokenExpiration(String tokenId) throws SQLException {
try (Connection connection = dataSource.getConnection(); PreparedStatement getTokenExpirationStatement = connection.prepareStatement(GET_TOKEN_EXPIRATION_SQL)) {
getTokenExpirationStatement.setString(1, tokenId);
try (ResultSet rs = getTokenExpirationStatement.executeQuery()) {
return rs.next() ? rs.getLong(1) : -1;
return rs.next() ? rs.getLong(1) : null;
}
}
}
Expand Down
30 changes: 27 additions & 3 deletions .../src/test/java/org/apache/knox/gateway/services/token/impl/JDBCTokenStateServiceTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,7 @@ public void testAddTokensForMultipleUsers() throws Exception {
String id1 = "token1";
String id2 = "token2";
String id3 = "token3";
String id4 = "token4";
String createdBy3 = "createdBy3";

long issueTime1 = 1;
Expand All @@ -141,16 +142,22 @@ public void testAddTokensForMultipleUsers() throws Exception {
long expiration3 = 3;
String comment3 = "comment3";

long issueTime4 = 4;
long expiration4 = -1;
String comment4 = "comment4";

truncateDatabase();

saveToken(user1, id1, issueTime1, expiration1, comment1);
saveToken(user1, id2, issueTime2, expiration2, comment2);
saveToken(user2, id3, issueTime3, expiration3, comment3);
saveToken(user1, id4, issueTime4, expiration4, comment4);

List<KnoxToken> user1Tokens = new ArrayList<>(jdbcTokenStateService.getTokens(user1));
assertEquals(2, user1Tokens.size());
assertEquals(3, user1Tokens.size());
assertToken(user1Tokens.get(0), id1, expiration1, comment1, issueTime1);
assertToken(user1Tokens.get(1), id2, expiration2, comment2, issueTime2);
assertToken(user1Tokens.get(2), id4, expiration4, comment4, issueTime4);

List<KnoxToken> user2Tokens = new ArrayList<>(jdbcTokenStateService.getTokens(user2));
assertEquals(1, user2Tokens.size());
Expand All @@ -168,10 +175,27 @@ public void testAddTokensForMultipleUsers() throws Exception {

// check all tokens
List<KnoxToken> allTokens = new ArrayList<>(jdbcTokenStateService.getAllTokens());
assertEquals(3, allTokens.size());
assertEquals(4, allTokens.size());
assertToken(allTokens.get(0), id1, expiration1, comment1, issueTime1);
assertToken(allTokens.get(1), id2, expiration2, comment2, issueTime2);
assertToken(allTokens.get(2), id3, expiration3, comment3, issueTime3, createdBy3);
assertToken(allTokens.get(3), id4, expiration4, comment4, issueTime4);
}

@Test
public void testGetTokenExpiration() throws UnknownTokenException {
saveToken("tokenExpirationUser1", "token100", 123, 456, "comment");
long expiration = jdbcTokenStateService.getTokenExpiration("token100");
assertEquals(456, expiration);

saveToken("tokenExpirationUser1", "token101", 789, -1, "comment");
expiration = jdbcTokenStateService.getTokenExpiration("token101");
assertEquals(-1L, expiration);
}

@Test(expected = UnknownTokenException.class)
public void testGetUnknownTokenExpiration() throws UnknownTokenException {
jdbcTokenStateService.getTokenExpiration("unknownToken1");
}

private void assertToken(KnoxToken knoxToken, String tokenId, long expiration, String comment, long issueTime) {
Expand All @@ -182,7 +206,7 @@ private void assertToken(KnoxToken knoxToken, String tokenId, long expiration, S
SimpleDateFormat df = new SimpleDateFormat(KnoxToken.DATE_FORMAT, Locale.getDefault());
assertEquals(tokenId, knoxToken.getTokenId());
assertEquals(df.format(new Date(issueTime)), knoxToken.getIssueTime());
assertEquals(df.format(new Date(expiration)), knoxToken.getExpiration());
assertEquals(expiration < 0 ? "Never" : df.format(new Date(expiration)), knoxToken.getExpiration());
assertEquals(comment, knoxToken.getMetadata().getComment());
if (createdBy != null) {
assertEquals(createdBy, knoxToken.getMetadata().getCreatedBy());
Expand Down