Skip to content
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

[Backport 2.5] obfuscate ip addresses in alert error message #525

Merged
merged 1 commit into from
Apr 11, 2024
Merged

[Backport 2.5] obfuscate ip addresses in alert error message #525

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
11 changes: 10 additions & 1 deletion src/main/kotlin/org/opensearch/commons/alerting/alerts/AlertError.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,10 @@ import org.opensearch.commons.alerting.util.optionalTimeField
import java.io.IOException
import java.time.Instant

data class AlertError(val timestamp: Instant, val message: String) : Writeable, ToXContent {
data class AlertError(val timestamp: Instant, var message: String) : Writeable, ToXContent {
init {
this.message = obfuscateIPAddresses(message)
}

@Throws(IOException::class)
constructor(sin: StreamInput) : this(
Expand Down Expand Up @@ -55,6 +58,12 @@ data class AlertError(val timestamp: Instant, val message: String) : Writeable,
fun readFrom(sin: StreamInput): AlertError {
return AlertError(sin)
}

fun obfuscateIPAddresses(exceptionMessage: String): String {
val ipAddressPattern = "\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}"
val obfuscatedMessage = exceptionMessage.replace(ipAddressPattern.toRegex(), "x.x.x.x")
return obfuscatedMessage
}
}

override fun toXContent(builder: XContentBuilder, params: ToXContent.Params): XContentBuilder {
Expand Down
25 changes: 25 additions & 0 deletions src/test/kotlin/org/opensearch/commons/alerting/alerts/AlertErrorTests.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
package org.opensearch.commons.alerting.alerts

import org.junit.Assert
import org.junit.jupiter.api.Test
import java.time.Instant

class AlertErrorTests {

@Test
fun `test alertError obfuscates IP addresses in message`() {
val message =
"AlertingException[[5f32db4e2a4fa94f6778cb895dae7a24][10.212.77.91:9300][indices:admin/create]]; " +
"nested: Exception[org.opensearch.transport.RemoteTransportException: [5f32db4e2a4fa94f6778cb895dae7a24][10.212.77.91:9300]" +
"[indices:admin/create]];; java.lang.Exception: org.opensearch.transport.RemoteTransportException: [5f32db4e2a4fa94f6778cb895" +
"dae7a24][10.212.77.91:9300][indices:admin/create]"
val alertError = AlertError(Instant.now(), message = message)
Assert.assertEquals(
alertError.message,
"AlertingException[[5f32db4e2a4fa94f6778cb895dae7a24][x.x.x.x:9300][indices:admin/create]]; " +
"nested: Exception[org.opensearch.transport.RemoteTransportException: [5f32db4e2a4fa94f6778cb895dae7a24][x.x.x.x:9300]" +
"[indices:admin/create]];; java.lang.Exception: org.opensearch.transport.RemoteTransportException: " +
"[5f32db4e2a4fa94f6778cb895dae7a24][x.x.x.x:9300][indices:admin/create]"
)
}
}
Loading