[BWA-182] Add mTLS support for Glide image loading #6125
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
|
Great job! No new security vulnerabilities introduced in this pull request |
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #6125 +/- ##
==========================================
- Coverage 84.96% 84.94% -0.03%
==========================================
Files 724 725 +1
Lines 52758 52898 +140
Branches 7659 7681 +22
==========================================
+ Hits 44826 44934 +108
- Misses 5249 5281 +32
Partials 2683 2683 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
| private class OkHttpDataFetcher( | ||
| private val client: OkHttpClient, | ||
| private val url: GlideUrl, | ||
| ) : com.bumptech.glide.load.data.DataFetcher<InputStream> { |
Collaborator
There was a problem hiding this comment.
Can we add an import for this instead of having the full path here?
| private var call: Call? = null | ||
|
|
||
| override fun loadData( | ||
| priority: com.bumptech.glide.Priority, |
| * This wraps our CertificateProvider to handle client certificate selection during | ||
| * the TLS handshake. | ||
| */ | ||
| private fun createSslContext(certificateProvider: CertificateProvider): SSLContext = |
Collaborator
There was a problem hiding this comment.
This exact logic already exists in the app. Can we pull it out as a common extension method on CertificateProvider and use it in multiple places. I think we can probably do that with a lot of this.
fun CertificateProvider.createSslContext(): SSLContext =
SSLContext.getInstance("TLS").apply {
init(
arrayOf(
CertificateProviderKeyManager(certificateProvider = certificateProvider),
),
createSslTrustManagers(),
null,
)
}
fun CertificateProvider.createMtlsOkHttpClient(): OkHttpClient {
val sslContext = createSslContext(certificateProvider)
val trustManagers = createSslTrustManagers()
return OkHttpClient.Builder()
.sslSocketFactory(
sslContext.socketFactory,
trustManagers.first() as X509TrustManager,
)
.build()
}
private fun createSslTrustManagers(): Array<TrustManager> =
TrustManagerFactory
.getInstance(TrustManagerFactory.getDefaultAlgorithm())
.apply { init(null as KeyStore?) }
.trustManagers
| import com.bumptech.glide.module.AppGlideModule | ||
| import org.junit.Assert.assertNotNull | ||
| import org.junit.Assert.assertTrue | ||
| import org.junit.Test |
Collaborator
There was a problem hiding this comment.
Can we make sure these use Junit 5
1 task
| override fun getDataClass(): Class<InputStream> = InputStream::class.java | ||
|
|
||
| override fun getDataSource(): com.bumptech.glide.load.DataSource = | ||
| com.bumptech.glide.load.DataSource.REMOTE |
Collaborator
There was a problem hiding this comment.
Can we just pull in the import for this?
| val sslContext = createSslContext() | ||
| val trustManagers = createSslTrustManagers() | ||
|
|
||
| return OkHttpClient.Builder() |
| width: Int, | ||
| height: Int, | ||
| options: Options, | ||
| ): ModelLoader.LoadData<InputStream>? { |
Collaborator
There was a problem hiding this comment.
Can we make this return type nonnull.
| if (response?.isSuccessful == true) { | ||
| callback.onDataReady(response.body?.byteStream()) | ||
| } else { | ||
| callback.onLoadFailed(Exception("HTTP ${response?.code}: ${response?.message}")) |
Collaborator
There was a problem hiding this comment.
Can we simplify some of this.
- We can make a
localCallthat is nonnull to avoid weird nullability issues. - Move the try catch around only the function that can throw.
- We can also use the
HttpExceptionfrom Glide.
val localCall = client.newCall(request).also { call = it }
val response = try {
localCall.execute()
} catch (e: IOException) {
callback.onLoadFailed(e)
return
}
if (response.isSuccessful) {
callback.onDataReady(response.body.byteStream())
} else {
callback.onLoadFailed(HttpException(response.message, response.code))
}
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🎟️ Tracking
https://bitwarden.atlassian.net/browse/BWA-182
📔 Objective
This PR adds mTLS (mutual TLS) support to Glide image loading.
This allows image requests to pass through Cloudflare's mTLS validation.
⏰ Reminders before review
🦮 Reviewer guidelines
:+1:) or similar for great changes:memo:) or ℹ️ (:information_source:) for notes or general info:question:) for questions:thinking:) or 💭 (:thought_balloon:) for more open inquiry that's not quite a confirmed issue and could potentially benefit from discussion:art:) for suggestions / improvements:x:) or:warning:) for more significant problems or concerns needing attention:seedling:) or ♻️ (:recycle:) for future improvements or indications of technical debt:pick:) for minor or nitpick changes