Skip to content

Commit

Permalink
Fixed auth0#726
Browse files Browse the repository at this point in the history
  • Loading branch information
@monochkov
monochkov committed Apr 24, 2024
1 parent 48d9364 commit 8c1c900
Show file tree
Hide file tree
Showing 2 changed files with 179 additions and 4 deletions.
5 changes: 3 additions & 2 deletions auth0/src/main/java/com/auth0/android/authentication/storage/CredentialsManager.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -284,8 +284,9 @@ public class CredentialsManager @VisibleForTesting(otherwise = VisibleForTesting
}
val request = authenticationClient.renewAuth(refreshToken)
request.addParameters(parameters)
if (scope != null) {
request.addParameter("scope", scope)
val scopeForRenew = scope ?: storedScope
if (scopeForRenew != null) {
request.addParameter("scope", scopeForRenew)
}

for (header in headers) {
Expand Down
178 changes: 176 additions & 2 deletions auth0/src/test/java/com/auth0/android/authentication/storage/CredentialsManagerTest.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -555,6 +555,180 @@ public class CredentialsManagerTest {
MatcherAssert.assertThat(retrievedCredentials.scope, Is.`is`("newScope"))
}

@Test
public fun shouldRenewExpiredCredentialsIfSavedScopeIsNotNullAndRequiredScopeIsNull() {
Mockito.`when`(storage.retrieveString("com.auth0.id_token")).thenReturn("idToken")
Mockito.`when`(storage.retrieveString("com.auth0.access_token")).thenReturn("accessToken")
Mockito.`when`(storage.retrieveString("com.auth0.refresh_token")).thenReturn("refreshToken")
Mockito.`when`(storage.retrieveString("com.auth0.token_type")).thenReturn("type")
val expirationTime = CredentialsMock.CURRENT_TIME_MS // expired credentials
Mockito.`when`(storage.retrieveLong("com.auth0.expires_at")).thenReturn(expirationTime)
Mockito.`when`(storage.retrieveLong("com.auth0.cache_expires_at"))
.thenReturn(expirationTime)
Mockito.`when`(storage.retrieveString("com.auth0.scope")).thenReturn("saved scope")
Mockito.`when`(
client.renewAuth("refreshToken")
).thenReturn(request)
val newDate = Date(CredentialsMock.ONE_HOUR_AHEAD_MS + ONE_HOUR_SECONDS * 1000)
val jwtMock = mock<Jwt>()
Mockito.`when`(jwtMock.expiresAt).thenReturn(newDate)
Mockito.`when`(jwtDecoder.decode("newId")).thenReturn(jwtMock)

// Trigger success
val newRefresh: String? = null
val renewedCredentials =
Credentials("newId", "newAccess", "newType", newRefresh, newDate, "newScope")
Mockito.`when`(request.execute()).thenReturn(renewedCredentials)
manager.getCredentials(null, 0, callback)
verify(callback).onSuccess(
credentialsCaptor.capture()
)
verify(request)
.addParameter(eq("scope"), eq("saved scope"))

// Verify the credentials are property stored
verify(storage).store("com.auth0.id_token", renewedCredentials.idToken)
verify(storage).store("com.auth0.access_token", renewedCredentials.accessToken)
// RefreshToken should not be replaced
verify(storage, never()).store("com.auth0.refresh_token", newRefresh)
verify(storage).store("com.auth0.refresh_token", "refreshToken")
verify(storage).store("com.auth0.token_type", renewedCredentials.type)
verify(storage).store(
"com.auth0.expires_at", renewedCredentials.expiresAt.time
)
verify(storage).store("com.auth0.scope", renewedCredentials.scope)
verify(storage).store(
"com.auth0.cache_expires_at", renewedCredentials.expiresAt.time
)
verify(storage, never()).remove(ArgumentMatchers.anyString())

// Verify the returned credentials are the latest
val retrievedCredentials = credentialsCaptor.firstValue
MatcherAssert.assertThat(retrievedCredentials, Is.`is`(Matchers.notNullValue()))
MatcherAssert.assertThat(retrievedCredentials.idToken, Is.`is`("newId"))
MatcherAssert.assertThat(retrievedCredentials.accessToken, Is.`is`("newAccess"))
MatcherAssert.assertThat(retrievedCredentials.type, Is.`is`("newType"))
MatcherAssert.assertThat(retrievedCredentials.refreshToken, Is.`is`("refreshToken"))
MatcherAssert.assertThat(retrievedCredentials.expiresAt, Is.`is`(newDate))
MatcherAssert.assertThat(retrievedCredentials.scope, Is.`is`("newScope"))
}

@Test
public fun shouldRenewExpiredCredentialsIfSavedScopeIsNullAndRequiredScopeIsNotNull() {
Mockito.`when`(storage.retrieveString("com.auth0.id_token")).thenReturn("idToken")
Mockito.`when`(storage.retrieveString("com.auth0.access_token")).thenReturn("accessToken")
Mockito.`when`(storage.retrieveString("com.auth0.refresh_token")).thenReturn("refreshToken")
Mockito.`when`(storage.retrieveString("com.auth0.token_type")).thenReturn("type")
val expirationTime = CredentialsMock.CURRENT_TIME_MS // expired credentials
Mockito.`when`(storage.retrieveLong("com.auth0.expires_at")).thenReturn(expirationTime)
Mockito.`when`(storage.retrieveLong("com.auth0.cache_expires_at"))
.thenReturn(expirationTime)
Mockito.`when`(storage.retrieveString("com.auth0.scope")).thenReturn(null)
Mockito.`when`(
client.renewAuth("refreshToken")
).thenReturn(request)
val newDate = Date(CredentialsMock.ONE_HOUR_AHEAD_MS + ONE_HOUR_SECONDS * 1000)
val jwtMock = mock<Jwt>()
Mockito.`when`(jwtMock.expiresAt).thenReturn(newDate)
Mockito.`when`(jwtDecoder.decode("newId")).thenReturn(jwtMock)

// Trigger success
val newRefresh: String? = null
val renewedCredentials =
Credentials("newId", "newAccess", "newType", newRefresh, newDate, "newScope")
Mockito.`when`(request.execute()).thenReturn(renewedCredentials)
manager.getCredentials("required scope", 0, callback)
verify(callback).onSuccess(
credentialsCaptor.capture()
)
verify(request)
.addParameter(eq("scope"), eq("required scope"))

// Verify the credentials are property stored
verify(storage).store("com.auth0.id_token", renewedCredentials.idToken)
verify(storage).store("com.auth0.access_token", renewedCredentials.accessToken)
// RefreshToken should not be replaced
verify(storage, never()).store("com.auth0.refresh_token", newRefresh)
verify(storage).store("com.auth0.refresh_token", "refreshToken")
verify(storage).store("com.auth0.token_type", renewedCredentials.type)
verify(storage).store(
"com.auth0.expires_at", renewedCredentials.expiresAt.time
)
verify(storage).store("com.auth0.scope", renewedCredentials.scope)
verify(storage).store(
"com.auth0.cache_expires_at", renewedCredentials.expiresAt.time
)
verify(storage, never()).remove(ArgumentMatchers.anyString())

// Verify the returned credentials are the latest
val retrievedCredentials = credentialsCaptor.firstValue
MatcherAssert.assertThat(retrievedCredentials, Is.`is`(Matchers.notNullValue()))
MatcherAssert.assertThat(retrievedCredentials.idToken, Is.`is`("newId"))
MatcherAssert.assertThat(retrievedCredentials.accessToken, Is.`is`("newAccess"))
MatcherAssert.assertThat(retrievedCredentials.type, Is.`is`("newType"))
MatcherAssert.assertThat(retrievedCredentials.refreshToken, Is.`is`("refreshToken"))
MatcherAssert.assertThat(retrievedCredentials.expiresAt, Is.`is`(newDate))
MatcherAssert.assertThat(retrievedCredentials.scope, Is.`is`("newScope"))
}

@Test
public fun shouldRenewExpiredCredentialsWhenScopesAreNull() {
Mockito.`when`(storage.retrieveString("com.auth0.id_token")).thenReturn("idToken")
Mockito.`when`(storage.retrieveString("com.auth0.access_token")).thenReturn("accessToken")
Mockito.`when`(storage.retrieveString("com.auth0.refresh_token")).thenReturn("refreshToken")
Mockito.`when`(storage.retrieveString("com.auth0.token_type")).thenReturn("type")
val expirationTime = CredentialsMock.CURRENT_TIME_MS // expired credentials
Mockito.`when`(storage.retrieveLong("com.auth0.expires_at")).thenReturn(expirationTime)
Mockito.`when`(storage.retrieveLong("com.auth0.cache_expires_at"))
.thenReturn(expirationTime)
Mockito.`when`(storage.retrieveString("com.auth0.scope")).thenReturn(null)
Mockito.`when`(
client.renewAuth("refreshToken")
).thenReturn(request)
val newDate = Date(CredentialsMock.ONE_HOUR_AHEAD_MS + ONE_HOUR_SECONDS * 1000)
val jwtMock = mock<Jwt>()
Mockito.`when`(jwtMock.expiresAt).thenReturn(newDate)
Mockito.`when`(jwtDecoder.decode("newId")).thenReturn(jwtMock)

// Trigger success
val newRefresh: String? = null
val renewedCredentials =
Credentials("newId", "newAccess", "newType", newRefresh, newDate, "newScope")
Mockito.`when`(request.execute()).thenReturn(renewedCredentials)
manager.getCredentials(null, 0, callback)
verify(callback).onSuccess(
credentialsCaptor.capture()
)
verify(request, never())
.addParameter(eq("scope"), ArgumentMatchers.anyString())

// Verify the credentials are property stored
verify(storage).store("com.auth0.id_token", renewedCredentials.idToken)
verify(storage).store("com.auth0.access_token", renewedCredentials.accessToken)
// RefreshToken should not be replaced
verify(storage, never()).store("com.auth0.refresh_token", newRefresh)
verify(storage).store("com.auth0.refresh_token", "refreshToken")
verify(storage).store("com.auth0.token_type", renewedCredentials.type)
verify(storage).store(
"com.auth0.expires_at", renewedCredentials.expiresAt.time
)
verify(storage).store("com.auth0.scope", renewedCredentials.scope)
verify(storage).store(
"com.auth0.cache_expires_at", renewedCredentials.expiresAt.time
)
verify(storage, never()).remove(ArgumentMatchers.anyString())

// Verify the returned credentials are the latest
val retrievedCredentials = credentialsCaptor.firstValue
MatcherAssert.assertThat(retrievedCredentials, Is.`is`(Matchers.notNullValue()))
MatcherAssert.assertThat(retrievedCredentials.idToken, Is.`is`("newId"))
MatcherAssert.assertThat(retrievedCredentials.accessToken, Is.`is`("newAccess"))
MatcherAssert.assertThat(retrievedCredentials.type, Is.`is`("newType"))
MatcherAssert.assertThat(retrievedCredentials.refreshToken, Is.`is`("refreshToken"))
MatcherAssert.assertThat(retrievedCredentials.expiresAt, Is.`is`(newDate))
MatcherAssert.assertThat(retrievedCredentials.scope, Is.`is`("newScope"))
}

@Test
public fun shouldRenewCredentialsWithMinTtl() {
Mockito.`when`(storage.retrieveString("com.auth0.id_token")).thenReturn("idToken")
Expand Down Expand Up @@ -642,8 +816,8 @@ public class CredentialsManagerTest {
verify(callback).onSuccess(
credentialsCaptor.capture()
)
verify(request, never())
.addParameter(eq("scope"), ArgumentMatchers.anyString())
verify(request)
.addParameter(eq("scope"), eq("scope"))

// Verify the credentials are property stored
verify(storage).store("com.auth0.id_token", renewedCredentials.idToken)
Expand Down

0 comments on commit 8c1c900

Please sign in to comment.