Skip to content

Commit abc69cd

Browse files
AWSHurneytAWSHurneyt
authored
Added validation for the new clusters field. (#633)
* Added validation for the clusters field. Refactored ClusterMetricsInput validiation to throw 4xx-level CommonUtilsExceptions instead of 5xx-level IllegalArgumentException. Signed-off-by: AWSHurneyt <[email protected]> * Moved some regex from alerting plugin to common utils. Signed-off-by: AWSHurneyt <[email protected]> * Moved cluster-based regex to separate file. Signed-off-by: AWSHurneyt <[email protected]> * Fixed ktlint error. Signed-off-by: AWSHurneyt <[email protected]> * Fixed regex. Moved cluster-related regexes. Signed-off-by: AWSHurneyt <[email protected]> --------- Signed-off-by: AWSHurneyt <[email protected]>
1 parent 9beae87 commit abc69cd

File tree

5 files changed

+287
-46
lines changed

5 files changed

+287
-46
lines changed

‎src/main/kotlin/org/opensearch/commons/alerting/model/ClusterMetricsInput.kt

+46-29
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ package org.opensearch.commons.alerting.model
33
import org.apache.commons.validator.routines.UrlValidator
44
import org.apache.hc.core5.net.URIBuilder
55
import org.opensearch.common.CheckedFunction
6+
import org.opensearch.commons.alerting.util.CommonUtilsException
7+
import org.opensearch.commons.utils.CLUSTER_NAME_REGEX
68
import org.opensearch.core.ParseField
79
import org.opensearch.core.common.io.stream.StreamInput
810
import org.opensearch.core.common.io.stream.StreamOutput
@@ -31,35 +33,46 @@ data class ClusterMetricsInput(
3133

3234
// Verify parameters are valid during creation
3335
init {
34-
require(validateFields()) {
35-
"The uri.api_type field, uri.path field, or uri.uri field must be defined."
36-
}
36+
// Wrap any validation exceptions in CommonUtilsException.
37+
try {
38+
require(validateFields()) {
39+
"The uri.api_type field, uri.path field, or uri.uri field must be defined."
40+
}
3741

38-
// Create an UrlValidator that only accepts "http" and "https" as valid scheme and allows local URLs.
39-
val urlValidator = UrlValidator(arrayOf("http", "https"), UrlValidator.ALLOW_LOCAL_URLS)
42+
// Create an UrlValidator that only accepts "http" and "https" as valid scheme and allows local URLs.
43+
val urlValidator = UrlValidator(arrayOf("http", "https"), UrlValidator.ALLOW_LOCAL_URLS)
4044

41-
// Build url field by field if not provided as whole.
42-
constructedUri = toConstructedUri()
45+
// Build url field by field if not provided as whole.
46+
constructedUri = toConstructedUri()
4347

44-
require(urlValidator.isValid(constructedUri.toString())) {
45-
"Invalid URI constructed from the path and path_params inputs, or the url input."
46-
}
48+
require(urlValidator.isValid(constructedUri.toString())) {
49+
"Invalid URI constructed from the path and path_params inputs, or the url input."
50+
}
4751

48-
if (url.isNotEmpty() && validateFieldsNotEmpty()) {
49-
require(constructedUri == constructUrlFromInputs()) {
50-
"The provided URL and URI fields form different URLs."
52+
if (url.isNotEmpty() && validateFieldsNotEmpty()) {
53+
require(constructedUri == constructUrlFromInputs()) {
54+
"The provided URL and URI fields form different URLs."
55+
}
5156
}
52-
}
5357

54-
require(constructedUri.host.lowercase() == SUPPORTED_HOST) {
55-
"Only host '$SUPPORTED_HOST' is supported."
56-
}
57-
require(constructedUri.port == SUPPORTED_PORT) {
58-
"Only port '$SUPPORTED_PORT' is supported."
59-
}
58+
require(constructedUri.host.lowercase() == SUPPORTED_HOST) {
59+
"Only host '$SUPPORTED_HOST' is supported."
60+
}
61+
require(constructedUri.port == SUPPORTED_PORT) {
62+
"Only port '$SUPPORTED_PORT' is supported."
63+
}
6064

61-
clusterMetricType = findApiType(constructedUri.path)
62-
this.parseEmptyFields()
65+
if (clusters.isNotEmpty()) {
66+
require(clusters.all { CLUSTER_NAME_REGEX.matches(it) }) {
67+
"Cluster names are not valid."
68+
}
69+
}
70+
71+
clusterMetricType = findApiType(constructedUri.path)
72+
this.parseEmptyFields()
73+
} catch (exception: Exception) {
74+
throw CommonUtilsException.wrap(exception)
75+
}
6376
}
6477

6578
@Throws(IOException::class)
@@ -158,7 +171,7 @@ data class ClusterMetricsInput(
158171
/**
159172
* Isolates just the path parameters from the [ClusterMetricsInput] URI.
160173
* @return The path parameters portion of the [ClusterMetricsInput] URI.
161-
* @throws IllegalArgumentException if the [ClusterMetricType] requires path parameters, but none are supplied;
174+
* @throws CommonUtilsException if the [ClusterMetricType] requires path parameters, but none are supplied;
162175
* or when path parameters are provided for an [ClusterMetricType] that does not use path parameters.
163176
*/
164177
fun parsePathParams(): String {
@@ -178,18 +191,22 @@ data class ClusterMetricsInput(
178191
pathParams = pathParams.trim('/')
179192
ILLEGAL_PATH_PARAMETER_CHARACTERS.forEach { character ->
180193
if (pathParams.contains(character)) {
181-
throw IllegalArgumentException(
182-
"The provided path parameters contain invalid characters or spaces. Please omit: " + ILLEGAL_PATH_PARAMETER_CHARACTERS.joinToString(" ")
194+
throw CommonUtilsException.wrap(
195+
IllegalArgumentException(
196+
"The provided path parameters contain invalid characters or spaces. Please omit: " + ILLEGAL_PATH_PARAMETER_CHARACTERS.joinToString(
197+
" "
198+
)
199+
)
183200
)
184201
}
185202
}
186203
}
187204

188205
if (apiType.requiresPathParams && pathParams.isEmpty()) {
189-
throw IllegalArgumentException("The API requires path parameters.")
206+
throw CommonUtilsException.wrap(IllegalArgumentException("The API requires path parameters."))
190207
}
191208
if (!apiType.supportsPathParams && pathParams.isNotEmpty()) {
192-
throw IllegalArgumentException("The API does not use path parameters.")
209+
throw CommonUtilsException.wrap(IllegalArgumentException("The API does not use path parameters."))
193210
}
194211

195212
return pathParams
@@ -199,7 +216,7 @@ data class ClusterMetricsInput(
199216
* Examines the path of a [ClusterMetricsInput] to determine which API is being called.
200217
* @param uriPath The path to examine.
201218
* @return The [ClusterMetricType] associated with the [ClusterMetricsInput] monitor.
202-
* @throws IllegalArgumentException when the API to call cannot be determined from the URI.
219+
* @throws CommonUtilsException when the API to call cannot be determined from the URI.
203220
*/
204221
private fun findApiType(uriPath: String): ClusterMetricType {
205222
var apiType = ClusterMetricType.BLANK
@@ -211,7 +228,7 @@ data class ClusterMetricsInput(
211228
}
212229
}
213230
if (apiType.isBlank()) {
214-
throw IllegalArgumentException("The API could not be determined from the provided URI.")
231+
throw CommonUtilsException.wrap(IllegalArgumentException("The API could not be determined from the provided URI."))
215232
}
216233
return apiType
217234
}

‎src/main/kotlin/org/opensearch/commons/alerting/util/CommonUtilsException.kt

+71
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
/*
2+
* Copyright OpenSearch Contributors
3+
* SPDX-License-Identifier: Apache-2.0
4+
*/
5+
6+
package org.opensearch.commons.alerting.util
7+
8+
import org.apache.logging.log4j.LogManager
9+
import org.opensearch.OpenSearchException
10+
import org.opensearch.OpenSearchSecurityException
11+
import org.opensearch.OpenSearchStatusException
12+
import org.opensearch.core.common.Strings
13+
import org.opensearch.core.rest.RestStatus
14+
import org.opensearch.index.IndexNotFoundException
15+
import org.opensearch.index.engine.VersionConflictEngineException
16+
import org.opensearch.indices.InvalidIndexNameException
17+
18+
private val log = LogManager.getLogger(CommonUtilsException::class.java)
19+
20+
class CommonUtilsException(message: String, val status: RestStatus, ex: Exception) : OpenSearchException(message, ex) {
21+
22+
override fun status(): RestStatus {
23+
return status
24+
}
25+
26+
companion object {
27+
28+
@JvmStatic
29+
fun wrap(ex: Exception): OpenSearchException {
30+
log.error("Common utils error: $ex")
31+
32+
var friendlyMsg = "Unknown error"
33+
var status = RestStatus.INTERNAL_SERVER_ERROR
34+
when (ex) {
35+
is IndexNotFoundException -> {
36+
status = ex.status()
37+
friendlyMsg = "Configured indices are not found: ${ex.index}"
38+
}
39+
is OpenSearchSecurityException -> {
40+
status = ex.status()
41+
friendlyMsg = "User doesn't have permissions to execute this action. Contact administrator."
42+
}
43+
is OpenSearchStatusException -> {
44+
status = ex.status()
45+
friendlyMsg = ex.message as String
46+
}
47+
is IllegalArgumentException -> {
48+
status = RestStatus.BAD_REQUEST
49+
friendlyMsg = ex.message as String
50+
}
51+
is VersionConflictEngineException -> {
52+
status = ex.status()
53+
friendlyMsg = ex.message as String
54+
}
55+
is InvalidIndexNameException -> {
56+
status = RestStatus.BAD_REQUEST
57+
friendlyMsg = ex.message as String
58+
}
59+
else -> {
60+
if (!Strings.isNullOrEmpty(ex.message)) {
61+
friendlyMsg = ex.message as String
62+
}
63+
}
64+
}
65+
// Wrapping the origin exception as runtime to avoid it being formatted.
66+
// Currently, alerting-kibana is using `error.root_cause.reason` as text in the toast message.
67+
// Below logic is to set friendly message to error.root_cause.reason.
68+
return CommonUtilsException(friendlyMsg, status, Exception("${ex.javaClass.name}: ${ex.message}"))
69+
}
70+
}
71+
}

‎src/main/kotlin/org/opensearch/commons/alerting/util/IndexUtils.kt

+18
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,24 @@ import java.time.Instant
1111

1212
class IndexUtils {
1313
companion object {
14+
/**
15+
* This regex asserts that the string:
16+
* The index does not start with an underscore _, hyphen -, or plus sign +
17+
* The index does not contain two consecutive periods (e.g., `..`)
18+
* The index does not contain any whitespace characters, commas, backslashes, forward slashes, asterisks,
19+
* question marks, double quotes, less than or greater than signs, pipes, colons, or periods.
20+
* The length of the index must be between 1 and 255 characters
21+
*/
22+
val VALID_INDEX_NAME_REGEX = Regex("""^(?![_\-\+])(?!.*\.\.)[^\s,\\\/\*\?"<>|#:\.]{1,255}$""")
23+
24+
/**
25+
* This regex asserts that the string:
26+
* The index pattern can start with an optional period
27+
* The index pattern can contain lowercase letters, digits, underscores, hyphens, asterisks, and periods
28+
* The length of the index pattern must be between 1 and 255 characters
29+
*/
30+
val INDEX_PATTERN_REGEX = Regex("""^(?=.{1,255}$)\.?[a-z0-9_\-\*\.]+$""")
31+
1432
const val NO_SCHEMA_VERSION = 0
1533

1634
const val MONITOR_MAX_INPUTS = 1

‎src/main/kotlin/org/opensearch/commons/utils/ValidationHelpers.kt

+18
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,24 @@ package org.opensearch.commons.utils
88
import java.net.URL
99
import java.util.regex.Pattern
1010

11+
/**
12+
* This regex asserts that the string:
13+
* Starts with a lowercase letter, or digit
14+
* Contains a sequence of characters followed by an optional colon and another sequence of characters
15+
* The sequences of characters can include lowercase letters, uppercase letters, digits, underscores, or hyphens
16+
* The total length of the string can range from 1 to 255 characters
17+
*/
18+
val CLUSTER_NAME_REGEX = Regex("^(?=.{1,255}$)[a-z0-9]([a-zA-Z0-9_-]*:?[a-zA-Z0-9_-]*)$")
19+
20+
/**
21+
* This regex asserts that the string:
22+
* Starts with a lowercase letter, digit, or asterisk
23+
* Contains a sequence of characters followed by an optional colon and another sequence of characters
24+
* The sequences of characters can include lowercase letters, uppercase letters, digits, underscores, asterisks, or hyphens
25+
* The total length of the string can range from 1 to 255 characters
26+
*/
27+
val CLUSTER_PATTERN_REGEX = Regex("^(?=.{1,255}$)[a-z0-9*]([a-zA-Z0-9_*-]*:?[a-zA-Z0-9_*-]*)$")
28+
1129
// Valid ID characters = (All Base64 chars + "_-") to support UUID format and Base64 encoded IDs
1230
private val VALID_ID_CHARS: Set<Char> = (('a'..'z') + ('A'..'Z') + ('0'..'9') + '+' + '/' + '_' + '-').toSet()
1331

0 commit comments

Comments
 (0)