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 1.x] [BACKPORT] Backports CVE fixes #1318

Merged
merged 1 commit into from
Dec 1, 2022
Merged

[Backport 1.x] [BACKPORT] Backports CVE fixes #1318

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
3 changes: 2 additions & 1 deletion opensearch-observability/build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ buildscript {
classpath "org.opensearch.gradle:build-tools:${opensearch_version}"
classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:${kotlin_version}"
classpath "org.jetbrains.kotlin:kotlin-allopen:${kotlin_version}"
classpath "io.gitlab.arturbosch.detekt:detekt-gradle-plugin:1.12.0"
classpath "io.gitlab.arturbosch.detekt:detekt-gradle-plugin:1.21.0"
classpath "org.jacoco:org.jacoco.agent:0.8.7"
}
}
Expand Down Expand Up @@ -81,6 +81,7 @@ configurations.all {
force "org.jetbrains.kotlin:kotlin-stdlib:${kotlin_version}"
force "org.jetbrains.kotlin:kotlin-stdlib-common:${kotlin_version}"
force "com.fasterxml.jackson.dataformat:jackson-dataformat-cbor:2.13.4"
force "org.yaml:snakeyaml:1.32"
}
}

Expand Down
5 changes: 5 additions & 0 deletions opensearch-observability/detekt.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,8 @@ style:
ReturnCount:
active: true
max: 10
complexity:
LongMethod:
threshold: 120
NestedBlockDepth:
threshold: 5
18 changes: 11 additions & 7 deletions ...ch-observability/src/main/kotlin/org/opensearch/observability/index/ObservabilityIndex.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,10 +102,12 @@ internal object ObservabilityIndex {
log.info("$LOG_PREFIX:Index $INDEX_NAME creation Acknowledged")
reindexNotebooks()
} else {
throw IllegalStateException("$LOG_PREFIX:Index $INDEX_NAME creation not Acknowledged")
error("$LOG_PREFIX:Index $INDEX_NAME creation not Acknowledged")
}
} catch (exception: ResourceAlreadyExistsException) {
log.warn("message: ${exception.message}")
} catch (exception: Exception) {
if (exception !is ResourceAlreadyExistsException && exception.cause !is ResourceAlreadyExistsException) {
if (exception.cause !is ResourceAlreadyExistsException) {
throw exception
}
}
Expand All @@ -130,7 +132,7 @@ internal object ObservabilityIndex {
if (response.isAcknowledged) {
log.info("$LOG_PREFIX:Index $INDEX_NAME update mapping Acknowledged")
} else {
throw IllegalStateException("$LOG_PREFIX:Index $INDEX_NAME update mapping not Acknowledged")
error("$LOG_PREFIX:Index $INDEX_NAME update mapping not Acknowledged")
}
this.mappingsUpdated = true
} catch (exception: IndexNotFoundException) {
Expand All @@ -153,11 +155,11 @@ internal object ObservabilityIndex {
.refresh(true)
.get()
if (reindexResponse.isTimedOut) {
throw IllegalStateException("$LOG_PREFIX:Index - reindex $NOTEBOOKS_INDEX_NAME timed out")
error("$LOG_PREFIX:Index - reindex $NOTEBOOKS_INDEX_NAME timed out")
} else if (reindexResponse.searchFailures.isNotEmpty()) {
throw IllegalStateException("$LOG_PREFIX:Index - reindex $NOTEBOOKS_INDEX_NAME failed with searchFailures")
error("$LOG_PREFIX:Index - reindex $NOTEBOOKS_INDEX_NAME failed with searchFailures")
} else if (reindexResponse.bulkFailures.isNotEmpty()) {
throw IllegalStateException("$LOG_PREFIX:Index - reindex $NOTEBOOKS_INDEX_NAME failed with bulkFailures")
error("$LOG_PREFIX:Index - reindex $NOTEBOOKS_INDEX_NAME failed with bulkFailures")
} else if (reindexResponse.total != reindexResponse.created + reindexResponse.updated) {
throw IllegalStateException(
"$LOG_PREFIX:Index - reindex number of docs created:${reindexResponse.created} + " +
Expand All @@ -168,8 +170,10 @@ internal object ObservabilityIndex {
"$LOG_PREFIX:Index - reindex ${reindexResponse.created} docs created " +
"and ${reindexResponse.updated} docs updated in $INDEX_NAME"
)
} catch (exception: ResourceNotFoundException) {
log.warn("message: ${exception.message}")
} catch (exception: Exception) {
if (exception !is ResourceNotFoundException && exception.cause !is ResourceNotFoundException) {
if (exception.cause !is ResourceNotFoundException) {
throw exception
}
}
Expand Down
4 changes: 0 additions & 4 deletions ...ervability/src/main/kotlin/org/opensearch/observability/index/ObservabilityQueryHelper.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,10 +113,6 @@ internal class ObservabilityQueryHelper(private val types: EnumSet<Observability
}
}

private fun addTermQueryBuilder(query: BoolQueryBuilder, queryKey: String, queryValue: String) {
prefixes.forEach { query.filter(QueryBuilders.termQuery("${it.tag}.$queryKey", queryValue)) }
}

private fun addTermsQueryBuilder(query: BoolQueryBuilder, queryKey: String, queryValue: String) {
prefixes.forEach { query.filter(QueryBuilders.termsQuery("${it.tag}.$queryKey", queryValue.split(","))) }
}
Expand Down
2 changes: 1 addition & 1 deletion ...rch-observability/src/main/kotlin/org/opensearch/observability/security/SecurityAccess.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ internal object SecurityAccess {
SpecialPermission.check()
return try {
AccessController.doPrivileged(operation)
} catch (e: PrivilegedActionException) {
} catch (@Suppress("SwallowedException") e: PrivilegedActionException) {
throw (e.cause as Exception?)!!
}
}
Expand Down
2 changes: 1 addition & 1 deletion ...rch-observability/src/main/kotlin/org/opensearch/observability/settings/PluginSettings.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,7 @@ internal object PluginSettings {
try {
settings = Settings.builder().loadFromPath(defaultSettingYmlFile).build()
} catch (exception: IOException) {
log.warn("$LOG_PREFIX:Failed to load ${defaultSettingYmlFile.toAbsolutePath()}")
log.warn("$LOG_PREFIX:Failed to load ${defaultSettingYmlFile.toAbsolutePath()} message:${exception.message}")
}
}
// Initialize the settings values to default values
Expand Down
12 changes: 0 additions & 12 deletions ...ch-observability/src/test/kotlin/org/opensearch/observability/ObservabilityPluginTests.kt
View file
Open in desktop

This file was deleted.

1 change: 1 addition & 0 deletions opensearch-observability/src/test/kotlin/org/opensearch/observability/PluginRestTestCase.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ abstract class PluginRestTestCase : OpenSearchRestTestCase() {
}

@Throws(IOException::class)
@Suppress("Detekt.TooGenericExceptionThrown")
protected open fun configureHttpsClient(builder: RestClientBuilder, settings: Settings) {
val headers = ThreadContext.buildDefaultHeaders(settings)
val defaultHeaders = arrayOfNulls<Header>(headers.size)
Expand Down
4 changes: 2 additions & 2 deletions opensearch-observability/src/test/kotlin/org/opensearch/observability/TestHelpers.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ fun constructNotebookRequest(name: String = "test notebook"): String {
}
""".trimIndent()
}

@Suppress("MaxLineLength")
fun constructSavedQueryRequest(name: String = "test saved query"): String {
return """
{
Expand Down Expand Up @@ -101,7 +101,7 @@ fun constructSavedQueryRequest(name: String = "test saved query"): String {
}
""".trimIndent()
}

@Suppress("MaxLineLength")
fun constructSavedVisualizationRequest(name: String = "test saved visualization"): String {
return """
{
Expand Down
6 changes: 4 additions & 2 deletions .../test/kotlin/org/opensearch/observability/action/CreateObservabilityObjectRequestTests.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,8 @@ internal class CreateObservabilityObjectRequestTests {
@Test
fun `Create object should deserialize json object using parser`() {
val jsonString =
"{\"timestamp\":{\"name\":\"test-timestamp\",\"index\":\"opensearch_dashboards_sample_data_logs\",\"type\":\"timestamp\",\"dsl_type\":\"date\"}}"
"{\"timestamp\":{\"name\":\"test-timestamp\",\"index\":\"opensearch_dashboards_sample_data_logs\"," +
"\"type\":\"timestamp\",\"dsl_type\":\"date\"}}"
val recreatedObject = createObjectFromJsonString(jsonString) { CreateObservabilityObjectRequest.parse(it) }
assertEquals(sampleTimestamp, recreatedObject.objectData)
}
Expand All @@ -59,7 +60,8 @@ internal class CreateObservabilityObjectRequestTests {
@Test
fun `Create object should safely ignore extra field in json object`() {
val jsonString =
"{\"timestamp\":{\"name\":\"test-timestamp\",\"index\":\"opensearch_dashboards_sample_data_logs\",\"type\":\"timestamp\",\"dsl_type\":\"date\",\"another\":\"field\"}}"
"{\"timestamp\":{\"name\":\"test-timestamp\",\"index\":\"opensearch_dashboards_sample_data_logs\"," +
"\"type\":\"timestamp\",\"dsl_type\":\"date\",\"another\":\"field\"}}"
val recreatedObject = createObjectFromJsonString(jsonString) { CreateObservabilityObjectRequest.parse(it) }
assertEquals(sampleTimestamp, recreatedObject.objectData)
}
Expand Down
12 changes: 10 additions & 2 deletions opensearch-observability/src/test/kotlin/org/opensearch/observability/model/NotebookTests.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,11 @@ internal class NotebookTests {
@Test
fun `Notebook should deserialize json object using parser`() {
val jsonString =
"{\"name\":\"test-notebook\",\"dateCreated\":\"2021-12-01T18:33:40.017Z\",\"dateModified\":\"2021-12-01T18:33:40.017Z\",\"backend\":\"Default\",\"paragraphs\":[{\"output\":[{\"result\":\"sample paragraph\",\"outputType\":\"MARKDOWN\",\"execution_time\":\"0 ms\"}],\"input\":{\"inputText\":\"%md sample paragraph\",\"inputType\":\"MARKDOWN\"},\"dateCreated\":\"2021-12-01T18:33:40.017Z\",\"dateModified\":\"2021-12-01T18:33:40.017Z\",\"id\":\"paragraph_bcd3c65c-91db-489d-b667-496fd378714e\"}]}"
"{\"name\":\"test-notebook\",\"dateCreated\":\"2021-12-01T18:33:40.017Z\",\"dateModified\":\"2021-12-01T18:33:40.017Z\"," +
"\"backend\":\"Default\",\"paragraphs\":[{\"output\":[{\"result\":\"sample paragraph\",\"outputType\":\"MARKDOWN\"," +
"\"execution_time\":\"0 ms\"}],\"input\":{\"inputText\":\"%md sample paragraph\",\"inputType\":\"MARKDOWN\"}," +
"\"dateCreated\":\"2021-12-01T18:33:40.017Z\",\"dateModified\":\"2021-12-01T18:33:40.017Z\"," +
"\"id\":\"paragraph_bcd3c65c-91db-489d-b667-496fd378714e\"}]}"
val recreatedObject = createObjectFromJsonString(jsonString) { Notebook.parse(it) }
assertEquals(sampleNotebook, recreatedObject)
}
Expand All @@ -62,7 +66,11 @@ internal class NotebookTests {
@Test
fun `Notebook should safely ignore extra field in json object`() {
val jsonString =
"{\"name\":\"test-notebook\",\"dateCreated\":\"2021-12-01T18:33:40.017Z\",\"dateModified\":\"2021-12-01T18:33:40.017Z\",\"backend\":\"Default\",\"paragraphs\":[{\"output\":[{\"result\":\"sample paragraph\",\"outputType\":\"MARKDOWN\",\"execution_time\":\"0 ms\"}],\"input\":{\"inputText\":\"%md sample paragraph\",\"inputType\":\"MARKDOWN\"},\"dateCreated\":\"2021-12-01T18:33:40.017Z\",\"dateModified\":\"2021-12-01T18:33:40.017Z\",\"id\":\"paragraph_bcd3c65c-91db-489d-b667-496fd378714e\"}],\"another\":\"field\"}"
"{\"name\":\"test-notebook\",\"dateCreated\":\"2021-12-01T18:33:40.017Z\",\"dateModified\":\"2021-12-01T18:33:40.017Z\"," +
"\"backend\":\"Default\",\"paragraphs\":[{\"output\":[{\"result\":\"sample paragraph\",\"outputType\":\"MARKDOWN\"," +
"\"execution_time\":\"0 ms\"}],\"input\":{\"inputText\":\"%md sample paragraph\",\"inputType\":\"MARKDOWN\"}," +
"\"dateCreated\":\"2021-12-01T18:33:40.017Z\",\"dateModified\":\"2021-12-01T18:33:40.017Z\"," +
"\"id\":\"paragraph_bcd3c65c-91db-489d-b667-496fd378714e\"}],\"another\":\"field\"}"
val recreatedObject = createObjectFromJsonString(jsonString) { Notebook.parse(it) }
assertEquals(sampleNotebook, recreatedObject)
}
Expand Down
8 changes: 6 additions & 2 deletions ...ability/src/test/kotlin/org/opensearch/observability/model/ObservabilityObjectDocTests.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,9 @@ internal class ObservabilityObjectDocTests {
@Test
fun `ObservabilityObjectDoc should deserialize json object using parser`() {
val jsonString =
"{\"objectId\":\"test-id\",\"lastUpdatedTimeMs\":1638482208790,\"createdTimeMs\":1638482208790,\"tenant\":\"test-tenant\",\"access\":[\"test-access\"],\"timestamp\":{\"name\":\"test object\",\"index\":\"opensearch_dashboards_sample_data_logs\",\"type\":\"timestamp\",\"dsl_type\":\"date\"}}"
"{\"objectId\":\"test-id\",\"lastUpdatedTimeMs\":1638482208790,\"createdTimeMs\":1638482208790,\"tenant\":" +
"\"test-tenant\",\"access\":[\"test-access\"],\"timestamp\":{\"name\":\"test object\"," +
"\"index\":\"opensearch_dashboards_sample_data_logs\",\"type\":\"timestamp\",\"dsl_type\":\"date\"}}"
val recreatedObject = createObjectFromJsonString(jsonString) { ObservabilityObjectDoc.parse(it) }
assertEquals(sampleObservabilityObjectDoc, recreatedObject)
}
Expand All @@ -49,7 +51,9 @@ internal class ObservabilityObjectDocTests {
@Test
fun `ObservabilityObjectDoc should safely ignore extra field in json object`() {
val jsonString =
"{\"objectId\":\"test-id\",\"lastUpdatedTimeMs\":1638482208790,\"createdTimeMs\":1638482208790,\"tenant\":\"test-tenant\",\"access\":[\"test-access\"],\"timestamp\":{\"name\":\"test object\",\"index\":\"opensearch_dashboards_sample_data_logs\",\"type\":\"timestamp\",\"dsl_type\":\"date\"},\"another\":\"field\"}"
"{\"objectId\":\"test-id\",\"lastUpdatedTimeMs\":1638482208790,\"createdTimeMs\":1638482208790,\"tenant\":" +
"\"test-tenant\",\"access\":[\"test-access\"],\"timestamp\":{\"name\":\"test object\",\"index\":" +
"\"opensearch_dashboards_sample_data_logs\",\"type\":\"timestamp\",\"dsl_type\":\"date\"},\"another\":\"field\"}"
val recreatedObject = createObjectFromJsonString(jsonString) { ObservabilityObjectDoc.parse(it) }
assertEquals(sampleObservabilityObjectDoc, recreatedObject)
}
Expand Down
8 changes: 6 additions & 2 deletions ...observability/src/test/kotlin/org/opensearch/observability/model/OperationalPanelTests.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,9 @@ internal class OperationalPanelTests {
@Test
fun `OperationalPanel should deserialize json object using parser`() {
val jsonString =
"{\"name\":\"test-operational-panel\",\"visualizations\":[{\"id\":\"panelViz_7ba28e34-6fd8-489d-9b9f-1f83e006fb17\",\"savedVisualizationId\":\"oyuecXwBYVazWqOOde0o\",\"x\":0,\"y\":0,\"w\":10,\"h\":10}],\"timeRange\":{\"to\":\"now\",\"from\":\"now-1d\"},\"queryFilter\":{\"query\":\"| where Carrier='OpenSearch-Air'\",\"language\":\"ppl\"}}"
"{\"name\":\"test-operational-panel\",\"visualizations\":[{\"id\":\"panelViz_7ba28e34-6fd8-489d-9b9f-1f83e006fb17\"," +
"\"savedVisualizationId\":\"oyuecXwBYVazWqOOde0o\",\"x\":0,\"y\":0,\"w\":10,\"h\":10}],\"timeRange\":{\"to\":" +
"\"now\",\"from\":\"now-1d\"},\"queryFilter\":{\"query\":\"| where Carrier='OpenSearch-Air'\",\"language\":\"ppl\"}}"
val recreatedObject = createObjectFromJsonString(jsonString) { OperationalPanel.parse(it) }
assertEquals(sampleOperationalPanel, recreatedObject)
}
Expand All @@ -62,7 +64,9 @@ internal class OperationalPanelTests {
@Test
fun `OperationalPanel should safely ignore extra field in json object`() {
val jsonString =
"{\"name\":\"test-operational-panel\",\"visualizations\":[{\"id\":\"panelViz_7ba28e34-6fd8-489d-9b9f-1f83e006fb17\",\"savedVisualizationId\":\"oyuecXwBYVazWqOOde0o\",\"x\":0,\"y\":0,\"w\":10,\"h\":10}],\"timeRange\":{\"to\":\"now\",\"from\":\"now-1d\"},\"queryFilter\":{\"query\":\"| where Carrier='OpenSearch-Air'\",\"language\":\"ppl\"},\"another\":\"field\"}"
"{\"name\":\"test-operational-panel\",\"visualizations\":[{\"id\":\"panelViz_7ba28e34-6fd8-489d-9b9f-1f83e006fb17\",\"" +
"savedVisualizationId\":\"oyuecXwBYVazWqOOde0o\",\"x\":0,\"y\":0,\"w\":10,\"h\":10}],\"timeRange\":{\"to\":\"now\"," +
"\"from\":\"now-1d\"},\"queryFilter\":{\"query\":\"| where Carrier='OpenSearch-Air'\",\"language\":\"ppl\"},\"another\":\"field\"}"
val recreatedObject = createObjectFromJsonString(jsonString) { OperationalPanel.parse(it) }
assertEquals(sampleOperationalPanel, recreatedObject)
}
Expand Down
14 changes: 12 additions & 2 deletions ...earch-observability/src/test/kotlin/org/opensearch/observability/model/SavedQueryTests.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,12 @@ internal class SavedQueryTests {
@Test
fun `SavedQuery should deserialize json object using parser`() {
val jsonString =
"{\"name\":\"test-saved-query\",\"description\":\"test description\",\"query\":\"source=index | where utc_time > timestamp('2021-07-01 00:00:00') and utc_time < timestamp('2021-07-02 00:00:00')\",\"selected_date_range\":{\"start\":\"now/15m\",\"end\":\"now\",\"text\":\"utc_time > timestamp('2021-07-01 00:00:00') and utc_time < timestamp('2021-07-02 00:00:00')\"},\"selected_timestamp\":{\"name\":\"utc_time\",\"type\":\"timestamp\"},\"selected_fields\":{\"text\":\"| fields clientip, bytes, memory, host\",\"tokens\":[{\"name\":\"utc_time\",\"type\":\"timestamp\"}]}}"
"{\"name\":\"test-saved-query\",\"description\":\"test description\",\"query\":\"source=index | " +
"where utc_time > timestamp('2021-07-01 00:00:00') and utc_time < timestamp('2021-07-02 00:00:00')\"," +
"\"selected_date_range\":{\"start\":\"now/15m\",\"end\":\"now\",\"text\":\"utc_time > " +
"timestamp('2021-07-01 00:00:00') and utc_time < timestamp('2021-07-02 00:00:00')\"}," +
"\"selected_timestamp\":{\"name\":\"utc_time\",\"type\":\"timestamp\"},\"selected_fields\":{\"text\":" +
"\"| fields clientip, bytes, memory, host\",\"tokens\":[{\"name\":\"utc_time\",\"type\":\"timestamp\"}]}}"
val recreatedObject = createObjectFromJsonString(jsonString) { SavedQuery.parse(it) }
assertEquals(sampleSavedQuery, recreatedObject)
}
Expand All @@ -62,7 +67,12 @@ internal class SavedQueryTests {
@Test
fun `SavedQuery should safely ignore extra field in json object`() {
val jsonString =
"{\"name\":\"test-saved-query\",\"description\":\"test description\",\"query\":\"source=index | where utc_time > timestamp('2021-07-01 00:00:00') and utc_time < timestamp('2021-07-02 00:00:00')\",\"selected_date_range\":{\"start\":\"now/15m\",\"end\":\"now\",\"text\":\"utc_time > timestamp('2021-07-01 00:00:00') and utc_time < timestamp('2021-07-02 00:00:00')\"},\"selected_timestamp\":{\"name\":\"utc_time\",\"type\":\"timestamp\"},\"selected_fields\":{\"text\":\"| fields clientip, bytes, memory, host\",\"tokens\":[{\"name\":\"utc_time\",\"type\":\"timestamp\"}]},\"another\":\"field\"}"
"{\"name\":\"test-saved-query\",\"description\":\"test description\",\"query\":\"source=index | where" +
" utc_time > timestamp('2021-07-01 00:00:00') and utc_time < timestamp('2021-07-02 00:00:00')\"," +
"\"selected_date_range\":{\"start\":\"now/15m\",\"end\":\"now\",\"text\":\"utc_time > timestamp" +
"('2021-07-01 00:00:00') and utc_time < timestamp('2021-07-02 00:00:00')\"},\"selected_timestamp\"" +
":{\"name\":\"utc_time\",\"type\":\"timestamp\"},\"selected_fields\":{\"text\":\"| fields clientip, " +
"bytes, memory, host\",\"tokens\":[{\"name\":\"utc_time\",\"type\":\"timestamp\"}]},\"another\":\"field\"}"
val recreatedObject = createObjectFromJsonString(jsonString) { SavedQuery.parse(it) }
assertEquals(sampleSavedQuery, recreatedObject)
}
Expand Down
Loading