Skip to content

fix(auth): bind X.509 bearer attachment to its mTLS transport #949

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

Merged
jbeckwith-oai merged 1 commit into from
Aug 28, 2026
+154 −7
Merged

fix(auth): bind X.509 bearer attachment to its mTLS transport #949

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
31 changes: 24 additions & 7 deletions ...ient-okhttp/src/main/kotlin/com/openai/client/okhttp/X509WorkloadIdentityAuthenticator.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,16 +30,29 @@ internal class X509WorkloadIdentityAuthenticator(
private var closed = false

override fun authenticate(request: HttpRequest): HttpRequest =
request.also {
requireAuthorizedOrigin(it)
synchronized(lock) {
check(!closed) { "X.509 workload identity authentication is closed" }
}
}

override fun authenticateAsync(request: HttpRequest): CompletableFuture<HttpRequest> =
try {
CompletableFuture.completedFuture(authenticate(request))
} catch (failure: Throwable) {
CompletableFuture<HttpRequest>().apply { completeExceptionally(failure) }
}

fun authenticateForBoundTransport(request: HttpRequest): HttpRequest =
try {
requireAuthorizedOrigin(request)
authenticated(request, token(async = false).join())
} catch (failure: CompletionException) {
throw failure.cause ?: failure
}

override fun authenticateAsync(request: HttpRequest): CompletableFuture<HttpRequest> =
fun authenticateForBoundTransportAsync(request: HttpRequest): CompletableFuture<HttpRequest> =
try {
requireAuthorizedOrigin(request)
token(async = true).thenApply { value -> authenticated(request, value) }
} catch (failure: Throwable) {
CompletableFuture<HttpRequest>().apply { completeExceptionally(failure) }
Expand Down Expand Up @@ -171,15 +184,19 @@ private class X509RefreshingHttpClient(
private val authenticator: X509WorkloadIdentityAuthenticator,
) : HttpClient {

override fun execute(request: HttpRequest, requestOptions: RequestOptions): HttpResponse =
checkResponse(request, delegate.execute(request, requestOptions))
override fun execute(request: HttpRequest, requestOptions: RequestOptions): HttpResponse {
val authenticated = authenticator.authenticateForBoundTransport(request)
return checkResponse(authenticated, delegate.execute(authenticated, requestOptions))
}

override fun executeAsync(
request: HttpRequest,
requestOptions: RequestOptions,
): CompletableFuture<HttpResponse> =
delegate.executeAsync(request, requestOptions).thenApply { response ->
checkResponse(request, response)
authenticator.authenticateForBoundTransportAsync(request).thenCompose { authenticated ->
delegate.executeAsync(authenticated, requestOptions).thenApply { response ->
checkResponse(authenticated, response)
}
}

private fun checkResponse(request: HttpRequest, response: HttpResponse): HttpResponse {
Expand Down
130 changes: 130 additions & 0 deletions ...nt-okhttp/src/test/kotlin/com/openai/client/okhttp/X509WorkloadIdentityIntegrationTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,18 @@
package com.openai.client.okhttp

import com.fasterxml.jackson.databind.ObjectMapper
import com.openai.core.RequestOptions
import com.openai.core.http.Headers
import com.openai.core.http.HttpClient
import com.openai.core.http.HttpRequest
import com.openai.core.http.HttpResponse
import com.openai.errors.OpenAIException
import com.openai.errors.OpenAIInvalidDataException
import java.io.ByteArrayInputStream
import java.net.InetSocketAddress
import java.net.Proxy
import java.time.Duration
import java.util.concurrent.CompletableFuture
import java.util.concurrent.ExecutionException
import java.util.concurrent.TimeUnit
import okhttp3.mockwebserver.MockResponse
Expand Down Expand Up @@ -62,6 +69,16 @@ internal class X509WorkloadIdentityIntegrationTest {
verifyClonedPublicClientRejectsUnauthorizedOrigin(async = true)
}

@Test
fun synchronousClonedPublicClientCannotExposeBearerToAReplacementTransport() {
verifyClonedPublicClientDoesNotExposeBearerToReplacementTransport(async = false)
}

@Test
fun asynchronousClonedPublicClientCannotExposeBearerToAReplacementTransport() {
verifyClonedPublicClientDoesNotExposeBearerToReplacementTransport(async = true)
}

@Test
fun synchronousPublicClientRefreshesTokensWithinTheConfiguredBuffer() {
verifyRefresh(async = false)
Expand Down Expand Up @@ -360,6 +377,92 @@ internal class X509WorkloadIdentityIntegrationTest {
}
}

private fun verifyClonedPublicClientDoesNotExposeBearerToReplacementTransport(async: Boolean) {
val identity = X509TestIdentity.create("transport-bound certificate identity")
X509TestPeer(AUTH_HOST, identity.root.certificate).use { authPeer ->
X509TestPeer(API_HOST, identity.root.certificate).use { apiPeer ->
authPeer.enqueue(tokenResponse(ACCESS_TOKEN))
apiPeer.enqueue(filesResponse())
apiPeer.server.enqueue(filesResponse())
val configuration =
configuration(
identity,
listOf(authPeer.serverRootCertificate, apiPeer.serverRootCertificate),
)
.withTestProxies(authPeer.proxy, apiPeer.proxy)
val replacement = RecordingReplacementHttpClient()

if (async) {
val original =
OpenAIOkHttpClientAsync.builder()
.x509WorkloadIdentity(configuration)
.maxRetries(0)
.build()
try {
val cloned = original.withOptions { it.httpClient(replacement) }
try {
cloned.files().list().get(5, TimeUnit.SECONDS)
assertThat(replacement.authorizationHeaders)
.containsExactly(emptyList())
assertThat(authPeer.server.requestCount).isZero()

original.files().list().get(5, TimeUnit.SECONDS)
cloned.files().list().get(5, TimeUnit.SECONDS)
original.files().list().get(5, TimeUnit.SECONDS)

original.close()
assertThatThrownBy { cloned.files().list().get(5, TimeUnit.SECONDS) }
.isInstanceOf(ExecutionException::class.java)
.hasRootCauseInstanceOf(IllegalStateException::class.java)
.hasMessageContaining("authentication is closed")
} finally {
cloned.close()
}
} finally {
original.close()
}
} else {
val original =
OpenAIOkHttpClient.builder()
.x509WorkloadIdentity(configuration)
.maxRetries(0)
.build()
try {
val cloned = original.withOptions { it.httpClient(replacement) }
try {
cloned.files().list()
assertThat(replacement.authorizationHeaders)
.containsExactly(emptyList())
assertThat(authPeer.server.requestCount).isZero()

original.files().list()
cloned.files().list()
original.files().list()

original.close()
assertThatThrownBy { cloned.files().list() }
.isInstanceOf(IllegalStateException::class.java)
.hasMessageContaining("authentication is closed")
} finally {
cloned.close()
}
} finally {
original.close()
}
}

assertThat(replacement.authorizationHeaders)
.containsExactly(emptyList(), emptyList())
assertThat(authPeer.server.requestCount).isEqualTo(2)
apiPeer.takeRequest()
repeat(2) {
assertThat(apiPeer.takeRequest().getHeader("Authorization"))
.isEqualTo("Bearer $ACCESS_TOKEN")
}
}
}
}

private fun verifyRefresh(async: Boolean) {
val identity = X509TestIdentity.create("refresh certificate identity")
X509TestPeer(AUTH_HOST, identity.root.certificate).use { authPeer ->
Expand Down Expand Up @@ -547,6 +650,33 @@ internal class X509WorkloadIdentityIntegrationTest {
.setHeader("Content-Type", "application/json")
.setBody("""{"object":"list","data":[]}""")

private class RecordingReplacementHttpClient : HttpClient {
val authorizationHeaders = mutableListOf<List<String>>()

override fun execute(request: HttpRequest, requestOptions: RequestOptions): HttpResponse {
authorizationHeaders.add(request.headers.values("Authorization"))
return object : HttpResponse {
override fun statusCode(): Int = 200

override fun headers(): Headers =
Headers.builder().put("Content-Type", "application/json").build()

override fun body() =
ByteArrayInputStream("""{"object":"list","data":[]}""".toByteArray())

override fun close() = Unit
}
}

override fun executeAsync(
request: HttpRequest,
requestOptions: RequestOptions,
): CompletableFuture<HttpResponse> =
CompletableFuture.completedFuture(execute(request, requestOptions))

override fun close() = Unit
}

private companion object {
const val AUTH_HOST = "mtls.auth.openai.com"
const val API_HOST = "mtls.api.openai.com"
Expand Down
Loading