Skip to content

Commit 07dd782

Browse files
osipxdosipxd
authored
KTOR-7775 Auth: Add clearToken method (#4645)
* Add clearToken to BasicAuthProvider * Add clearToken to DigestAuthProvider * Add KDoc comments to clearToken
1 parent 203c29c commit 07dd782

File tree

6 files changed

+84
-6
lines changed

6 files changed

+84
-6
lines changed

‎ktor-client/ktor-client-plugins/ktor-client-auth/api/ktor-client-auth.api

+2
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ public final class io/ktor/client/plugins/auth/providers/BasicAuthProvider : io/
5555
public fun <init> (Lkotlin/jvm/functions/Function1;Ljava/lang/String;Lkotlin/jvm/functions/Function1;)V
5656
public synthetic fun <init> (Lkotlin/jvm/functions/Function1;Ljava/lang/String;Lkotlin/jvm/functions/Function1;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
5757
public fun addRequestHeaders (Lio/ktor/client/request/HttpRequestBuilder;Lio/ktor/http/auth/HttpAuthHeader;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
58+
public final fun clearToken ()V
5859
public fun getSendWithoutRequest ()Z
5960
public fun isApplicable (Lio/ktor/http/auth/HttpAuthHeader;)Z
6061
public fun refreshToken (Lio/ktor/client/statement/HttpResponse;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
@@ -120,6 +121,7 @@ public final class io/ktor/client/plugins/auth/providers/DigestAuthProvider : io
120121
public fun <init> (Lkotlin/jvm/functions/Function1;Ljava/lang/String;Ljava/lang/String;)V
121122
public synthetic fun <init> (Lkotlin/jvm/functions/Function1;Ljava/lang/String;Ljava/lang/String;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
122123
public fun addRequestHeaders (Lio/ktor/client/request/HttpRequestBuilder;Lio/ktor/http/auth/HttpAuthHeader;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
124+
public final fun clearToken ()V
123125
public final fun getAlgorithmName ()Ljava/lang/String;
124126
public final fun getRealm ()Ljava/lang/String;
125127
public fun getSendWithoutRequest ()Z

‎ktor-client/ktor-client-plugins/ktor-client-auth/api/ktor-client-auth.klib.api

+2
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ final class io.ktor.client.plugins.auth.providers/BasicAuthProvider : io.ktor.cl
5252
final val sendWithoutRequest // io.ktor.client.plugins.auth.providers/BasicAuthProvider.sendWithoutRequest|{}sendWithoutRequest[0]
5353
final fun <get-sendWithoutRequest>(): kotlin/Boolean // io.ktor.client.plugins.auth.providers/BasicAuthProvider.sendWithoutRequest.<get-sendWithoutRequest>|<get-sendWithoutRequest>(){}[0]
5454

55+
final fun clearToken() // io.ktor.client.plugins.auth.providers/BasicAuthProvider.clearToken|clearToken(){}[0]
5556
final fun isApplicable(io.ktor.http.auth/HttpAuthHeader): kotlin/Boolean // io.ktor.client.plugins.auth.providers/BasicAuthProvider.isApplicable|isApplicable(io.ktor.http.auth.HttpAuthHeader){}[0]
5657
final fun sendWithoutRequest(io.ktor.client.request/HttpRequestBuilder): kotlin/Boolean // io.ktor.client.plugins.auth.providers/BasicAuthProvider.sendWithoutRequest|sendWithoutRequest(io.ktor.client.request.HttpRequestBuilder){}[0]
5758
final suspend fun addRequestHeaders(io.ktor.client.request/HttpRequestBuilder, io.ktor.http.auth/HttpAuthHeader?) // io.ktor.client.plugins.auth.providers/BasicAuthProvider.addRequestHeaders|addRequestHeaders(io.ktor.client.request.HttpRequestBuilder;io.ktor.http.auth.HttpAuthHeader?){}[0]
@@ -131,6 +132,7 @@ final class io.ktor.client.plugins.auth.providers/DigestAuthProvider : io.ktor.c
131132
final val sendWithoutRequest // io.ktor.client.plugins.auth.providers/DigestAuthProvider.sendWithoutRequest|{}sendWithoutRequest[0]
132133
final fun <get-sendWithoutRequest>(): kotlin/Boolean // io.ktor.client.plugins.auth.providers/DigestAuthProvider.sendWithoutRequest.<get-sendWithoutRequest>|<get-sendWithoutRequest>(){}[0]
133134

135+
final fun clearToken() // io.ktor.client.plugins.auth.providers/DigestAuthProvider.clearToken|clearToken(){}[0]
134136
final fun isApplicable(io.ktor.http.auth/HttpAuthHeader): kotlin/Boolean // io.ktor.client.plugins.auth.providers/DigestAuthProvider.isApplicable|isApplicable(io.ktor.http.auth.HttpAuthHeader){}[0]
135137
final fun sendWithoutRequest(io.ktor.client.request/HttpRequestBuilder): kotlin/Boolean // io.ktor.client.plugins.auth.providers/DigestAuthProvider.sendWithoutRequest|sendWithoutRequest(io.ktor.client.request.HttpRequestBuilder){}[0]
136138
final suspend fun addRequestHeaders(io.ktor.client.request/HttpRequestBuilder, io.ktor.http.auth/HttpAuthHeader?) // io.ktor.client.plugins.auth.providers/DigestAuthProvider.addRequestHeaders|addRequestHeaders(io.ktor.client.request.HttpRequestBuilder;io.ktor.http.auth.HttpAuthHeader?){}[0]

‎ktor-client/ktor-client-plugins/ktor-client-auth/common/src/io/ktor/client/plugins/auth/providers/BasicAuthProvider.kt

+19-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2014-2024 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
2+
* Copyright 2014-2025 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
33
*/
44

55
package io.ktor.client.plugins.auth.providers
@@ -162,6 +162,24 @@ public class BasicAuthProvider(
162162
tokensHolder.setToken(credentials)
163163
return true
164164
}
165+
166+
/**
167+
* Clears the currently stored authentication tokens from the cache.
168+
*
169+
* This method should be called in the following cases:
170+
* - When the credentials have been updated and need to take effect
171+
* - When you want to force re-authentication
172+
* - When you want to clear sensitive authentication data
173+
*
174+
* Note: The result of [credentials] invocation is cached internally.
175+
* Calling this method will force the next authentication attempt to fetch fresh credentials.
176+
*
177+
* [Report a problem](https://ktor.io/feedback/?fqname=io.ktor.client.plugins.auth.providers.BasicAuthProvider.clearToken)
178+
*/
179+
@InternalAPI // TODO KTOR-8180: Provide control over tokens to user code
180+
public fun clearToken() {
181+
tokensHolder.clearToken()
182+
}
165183
}
166184

167185
internal fun constructBasicAuthValue(credentials: BasicAuthCredentials): String {

‎ktor-client/ktor-client-plugins/ktor-client-auth/common/src/io/ktor/client/plugins/auth/providers/BearerAuthProvider.kt

+14-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2014-2024 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
2+
* Copyright 2014-2025 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
33
*/
44

55
package io.ktor.client.plugins.auth.providers
@@ -162,6 +162,19 @@ public class BearerAuthProvider(
162162
return newToken != null
163163
}
164164

165+
/**
166+
* Clears the currently stored authentication tokens from the cache.
167+
*
168+
* This method should be called in the following cases:
169+
* - When access or refresh tokens have been updated externally
170+
* - When you want to clear sensitive token data (for example, during logout)
171+
*
172+
* Note: The result of `loadTokens` invocation is cached internally.
173+
* Calling this method will force the next authentication attempt to fetch fresh tokens
174+
* through the configured `loadTokens` function.
175+
*
176+
* [Report a problem](https://ktor.io/feedback/?fqname=io.ktor.client.plugins.auth.providers.BearerAuthProvider.clearToken)
177+
*/
165178
public fun clearToken() {
166179
tokensHolder.clearToken()
167180
}

‎ktor-client/ktor-client-plugins/ktor-client-auth/common/src/io/ktor/client/plugins/auth/providers/DigestAuthProvider.kt

+19-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2014-2024 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
2+
* Copyright 2014-2025 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
33
*/
44

55
package io.ktor.client.plugins.auth.providers
@@ -13,7 +13,7 @@ import io.ktor.util.*
1313
import io.ktor.utils.io.*
1414
import io.ktor.utils.io.charsets.*
1515
import io.ktor.utils.io.core.*
16-
import kotlinx.atomicfu.*
16+
import kotlinx.atomicfu.atomic
1717

1818
/**
1919
* Installs the client's [DigestAuthProvider].
@@ -218,4 +218,21 @@ public class DigestAuthProvider(
218218
val digest = Digest(algorithmName)
219219
return digest.build(data.toByteArray(Charsets.UTF_8))
220220
}
221+
222+
/**
223+
* Clears the currently stored authentication tokens from the cache.
224+
*
225+
* This method should be called in the following cases:
226+
* - When the credentials have been updated and need to take effect
227+
* - When you want to clear sensitive authentication data
228+
*
229+
* Note: The result of [credentials] invocation is cached internally.
230+
* Calling this method will force the next authentication attempt to fetch fresh credentials.
231+
*
232+
* [Report a problem](https://ktor.io/feedback/?fqname=io.ktor.client.plugins.auth.providers.DigestAuthProvider.clearToken)
233+
*/
234+
@InternalAPI // TODO KTOR-8180: Provide control over tokens to user code
235+
public fun clearToken() {
236+
tokenHolder.clearToken()
237+
}
221238
}

‎ktor-client/ktor-client-plugins/ktor-client-auth/common/test/io/ktor/client/plugins/auth/BasicProviderTest.kt

+28-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,19 @@
11
/*
2-
* Copyright 2014-2019 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
2+
* Copyright 2014-2025 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
33
*/
44

55
package io.ktor.client.plugins.auth
66

77
import io.ktor.client.plugins.auth.providers.*
8+
import io.ktor.client.request.*
9+
import io.ktor.http.*
810
import io.ktor.http.auth.*
9-
import kotlin.test.*
11+
import io.ktor.utils.io.*
12+
import kotlinx.coroutines.test.runTest
13+
import kotlin.test.Test
14+
import kotlin.test.assertEquals
15+
import kotlin.test.assertNotNull
16+
import kotlin.test.assertTrue
1017

1118
class BasicProviderTest {
1219
@Test
@@ -44,6 +51,25 @@ class BasicProviderTest {
4451
assertTrue(provider.isApplicable(header), "Provider with capitalized scheme should be applicable")
4552
}
4653

54+
@OptIn(InternalAPI::class)
55+
@Test
56+
fun `update credentials after clearToken`() = runTest {
57+
var credentials = BasicAuthCredentials("admin", "admin")
58+
val provider = BasicAuthProvider(credentials = { credentials })
59+
60+
val requestBuilder = HttpRequestBuilder()
61+
suspend fun assertAuthorizationHeader(expected: String) {
62+
provider.addRequestHeaders(requestBuilder, authHeader = null)
63+
assertEquals(expected, requestBuilder.headers[HttpHeaders.Authorization])
64+
}
65+
66+
assertAuthorizationHeader("Basic YWRtaW46YWRtaW4=")
67+
credentials = BasicAuthCredentials("user", "qwerty")
68+
assertAuthorizationHeader("Basic YWRtaW46YWRtaW4=")
69+
provider.clearToken()
70+
assertAuthorizationHeader("Basic dXNlcjpxd2VydHk=")
71+
}
72+
4773
private fun buildAuthString(username: String, password: String): String =
4874
constructBasicAuthValue(BasicAuthCredentials(username, password))
4975
}

0 commit comments

Comments
 (0)