Skip to content

Fix use of custom user salt when hashing the client id #30

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
merged 2 commits into from
Jun 25, 2024
Merged

Fix use of custom user salt when hashing the client id #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
23ef0aa
fix: use custom user salt when hashing the client id
kkostov Jun 25, 2024
7b89dbe
Merge branch 'main' into fix-custom-salt
winsmith Jun 25, 2024
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
2 changes: 2 additions & 0 deletions lib/src/main/java/com/telemetrydeck/sdk/TelemetryManager.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,8 +122,10 @@ class TelemetryManager(
enrichedPayload = provider.enrich(signalType, clientUser, enrichedPayload)
}
val userValue = clientUser ?: configuration.defaultUser ?: ""

val userValueWithSalt = userValue + (configuration.salt ?: "")
val hashedUser = hashString(userValue, "SHA-256")

val payload = SignalPayload(additionalPayload = enrichedPayload)
val signal = Signal(
appID = configuration.telemetryAppID,
Expand Down
11 changes: 11 additions & 0 deletions lib/src/test/java/com/telemetrydeck/sdk/TelemetryManagerTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,17 @@ class TelemetryManagerTest {
Assert.assertEquals("false", queuedSignal.isTestMode)
}

@Test
fun telemetryManager_applies_custom_salt() {
val appID = "32CB6574-6732-4238-879F-582FEBEB6536"
val config = TelemetryManagerConfiguration(appID)
config.salt = "my salt"
val manager = TelemetryManager.Builder().configuration(config).build(null)
manager.queue("type", "clientUser", emptyMap())
val queuedSignal = manager.cache?.empty()?.first()
Assert.assertEquals("9a68a3790deb1db66f80855b8e7c5a97df8002ef90d3039f9e16c94cfbd11d99", queuedSignal?.clientUser)
}

@Test
fun telemetryManager_builder_set_configuration() {
val appID = "32CB6574-6732-4238-879F-582FEBEB6536"
Expand Down