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

Jump to bottom

Add datasource name validation #281

Merged
merged 1 commit into from
May 3, 2023
Merged

Add datasource name validation #281

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
43 changes: 43 additions & 0 deletions src/main/java/org/opensearch/geospatial/ip2geo/action/PutDatasourceRequest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
package org.opensearch.geospatial.ip2geo.action;

import java.io.IOException;
import java.io.UnsupportedEncodingException;
import java.net.MalformedURLException;
import java.net.URISyntaxException;
import java.net.URL;
Expand All @@ -19,8 +20,10 @@
import lombok.Setter;
import lombok.extern.log4j.Log4j2;

import org.opensearch.OpenSearchException;
import org.opensearch.action.ActionRequestValidationException;
import org.opensearch.action.support.master.AcknowledgedRequest;
import org.opensearch.common.Strings;
import org.opensearch.common.io.stream.StreamInput;
import org.opensearch.common.io.stream.StreamOutput;
import org.opensearch.common.unit.TimeValue;
Expand All @@ -38,6 +41,7 @@
public class PutDatasourceRequest extends AcknowledgedRequest<PutDatasourceRequest> {
private static final ParseField ENDPOINT_FIELD = new ParseField("endpoint");
private static final ParseField UPDATE_INTERVAL_IN_DAYS_FIELD = new ParseField("update_interval_in_days");
private static final int MAX_DATASOURCE_NAME_BYTES = 255;
/**
* @param datasourceName the datasource name
* @return the datasource name
Expand Down Expand Up @@ -95,11 +99,50 @@ public void writeTo(final StreamOutput out) throws IOException {
@Override
public ActionRequestValidationException validate() {
ActionRequestValidationException errors = new ActionRequestValidationException();
validateDatasourceName(errors);
validateEndpoint(errors);
validateUpdateInterval(errors);
return errors.validationErrors().isEmpty() ? null : errors;
}

private void validateDatasourceName(final ActionRequestValidationException errors) {
if (!Strings.validFileName(datasourceName)) {
errors.addValidationError("Datasource name must not contain the following characters " + Strings.INVALID_FILENAME_CHARS);
return;
}
if (datasourceName.isEmpty()) {
errors.addValidationError("Datasource name must not be empty");
return;
}
if (datasourceName.contains("#")) {
errors.addValidationError("Datasource name must not contain '#'");
return;
}
if (datasourceName.contains(":")) {
errors.addValidationError("Datasource name must not contain ':'");
return;
}
if (datasourceName.charAt(0) == '_' || datasourceName.charAt(0) == '-' || datasourceName.charAt(0) == '+') {
errors.addValidationError("Datasource name must not start with '_', '-', or '+'");
return;
}
int byteCount = 0;
try {
byteCount = datasourceName.getBytes("UTF-8").length;
} catch (UnsupportedEncodingException e) {
// UTF-8 should always be supported, but rethrow this if it is not for some reason
throw new OpenSearchException("Unable to determine length of datasource name", e);
}
if (byteCount > MAX_DATASOURCE_NAME_BYTES) {
errors.addValidationError("Datasource name is too long, (" + byteCount + " > " + MAX_DATASOURCE_NAME_BYTES + ")");
return;
}
if (datasourceName.equals(".") || datasourceName.equals("..")) {
errors.addValidationError("Datasource name must not be '.' or '..'");
return;
}
}

/**
* Conduct following validation on endpoint
* 1. endpoint format complies with RFC-2396
Expand Down
57 changes: 57 additions & 0 deletions src/test/java/org/opensearch/geospatial/ip2geo/action/PutDatasourceRequestTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,13 @@

package org.opensearch.geospatial.ip2geo.action;

import java.util.Arrays;
import java.util.Locale;
import java.util.Map;

import org.opensearch.action.ActionRequestValidationException;
import org.opensearch.common.Randomness;
import org.opensearch.common.Strings;
import org.opensearch.common.io.stream.BytesStreamInput;
import org.opensearch.common.io.stream.BytesStreamOutput;
import org.opensearch.common.unit.TimeValue;
Expand Down Expand Up @@ -97,6 +100,60 @@ public void testValidateWithInvalidUrlInsideManifest() throws Exception {
assertTrue(exception.validationErrors().get(0).contains("Invalid URL format"));
}

public void testValidateDatasourceNames() throws Exception {
String validDatasourceName = GeospatialTestHelper.randomLowerCaseString();
String domain = GeospatialTestHelper.randomLowerCaseString();
PutDatasourceRequest request = new PutDatasourceRequest(validDatasourceName);
request.setEndpoint(sampleManifestUrl());
request.setUpdateInterval(TimeValue.timeValueDays(Randomness.get().nextInt(30) + 1));

// Run
ActionRequestValidationException exception = request.validate();

// Verify
assertNull(exception);

String fileNameChar = validDatasourceName + Strings.INVALID_FILENAME_CHARS.stream()
.skip(Randomness.get().nextInt(Strings.INVALID_FILENAME_CHARS.size() - 1))
.findFirst();
String startsWith = Arrays.asList("_", "-", "+").get(Randomness.get().nextInt(3)) + validDatasourceName;
String empty = "";
String hash = validDatasourceName + "#";
String colon = validDatasourceName + ":";
StringBuilder longName = new StringBuilder();
while (longName.length() < 256) {
longName.append(GeospatialTestHelper.randomLowerCaseString());
}
String point = Arrays.asList(".", "..").get(Randomness.get().nextInt(2));
Map<String, String> nameToError = Map.of(
fileNameChar,
"not contain the following characters",
empty,
"must not be empty",
hash,
"must not contain '#'",
colon,
"must not contain ':'",
startsWith,
"must not start with",
longName.toString(),
"name is too long",
point,
"must not be '.' or '..'"
);

for (Map.Entry<String, String> entry : nameToError.entrySet()) {
request.setDatasourceName(entry.getKey());

// Run
exception = request.validate();

// Verify
assertEquals(1, exception.validationErrors().size());
assertTrue(exception.validationErrors().get(0).contains(entry.getValue()));
}
}

public void testStreamInOut() throws Exception {
String datasourceName = GeospatialTestHelper.randomLowerCaseString();
String domain = GeospatialTestHelper.randomLowerCaseString();
Expand Down