Skip to content

fix(security): redact auth headers from OkHttp logging #4816

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

Open
IvanBila wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(security): redact auth headers from OkHttp logging #4816

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
1 change: 1 addition & 0 deletions app/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -276,6 +276,7 @@ dependencies {
implementation(libs.github.fancyshowcase)
implementation(libs.lottie)
implementation(libs.network.okhttp)
implementation(libs.network.okhttp.logging)
implementation(libs.analytics.matomo)
implementation(libs.analytics.rxlint)
implementation(libs.analytics.customactivityoncrash)
Expand Down
15 changes: 15 additions & 0 deletions app/src/main/java/org/dhis2/data/server/ServerModule.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import dagger.Provides
import dhis2.org.analytics.charts.Charts
import dhis2.org.analytics.charts.DhisAnalyticCharts
import okhttp3.Interceptor
import okhttp3.logging.HttpLoggingInterceptor
import org.dhis2.BuildConfig
import org.dhis2.R
import org.dhis2.bindings.app
Expand Down Expand Up @@ -181,6 +182,7 @@ class ServerModule {
AnalyticsHelper(context.app().appComponent().matomoController()),
),
)
interceptors.add(redactingLoggingInterceptor())
return D2Configuration
.builder()
.appName(BuildConfig.APPLICATION_ID)
Expand All @@ -192,6 +194,19 @@ class ServerModule {
.context(context)
.build()
}

private fun redactingLoggingInterceptor(): HttpLoggingInterceptor =
HttpLoggingInterceptor().apply {
level = if (BuildConfig.DEBUG) {
HttpLoggingInterceptor.Level.BASIC
} else {
HttpLoggingInterceptor.Level.NONE
}
redactHeader("Authorization")
redactHeader("Cookie")
redactHeader("Set-Cookie")
redactHeader("Proxy-Authorization")
}
}

@Provides
Expand Down
1 change: 1 addition & 0 deletions gradle/libs.versions.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,7 @@ google-material3-themeadapter = { group = "com.google.accompanist", name = "acco
google-gson = { group = "com.google.code.gson", name = "gson", version.ref = "gson" }
kotlinx-datetime = { module = "org.jetbrains.kotlinx:kotlinx-datetime", version.ref = "kotlinxDatetime" }
network-okhttp = { group = "com.squareup.okhttp3", name = "okhttp", version.ref = "okhttp" }
network-okhttp-logging = { group = "com.squareup.okhttp3", name = "logging-interceptor", version.ref = "okhttp" }
dates-jodatime = { group = "joda-time", name = "joda-time", version.ref = "jodatime" }
dagger = { group = "com.google.dagger", name = "dagger", version.ref = "dagger" }
dagger-compiler = { group = "com.google.dagger", name = "dagger-compiler", version.ref = "dagger" }
Expand Down