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.18] Added catch for unexpected inputs. #1449

Open
wants to merge 1 commit into
base: 2.18
Choose a base branch
from
Open

[Backport 2.18] Added catch for unexpected inputs. #1449

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
10 changes: 9 additions & 1 deletion src/main/java/org/opensearch/securityanalytics/threatIntel/model/Source.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,10 @@
import org.apache.logging.log4j.Logger;
import org.opensearch.core.common.io.stream.StreamInput;
import org.opensearch.core.common.io.stream.StreamOutput;
import org.opensearch.core.rest.RestStatus;
import org.opensearch.core.xcontent.XContentParser;
import org.opensearch.core.xcontent.XContentParserUtils;
import org.opensearch.securityanalytics.util.SecurityAnalyticsException;

import java.io.IOException;
import java.util.Locale;
Expand Down Expand Up @@ -36,7 +38,7 @@ static Source readFrom(StreamInput sin) throws IOException {
}
}

static Source parse(XContentParser xcp) throws IOException {
public static Source parse(XContentParser xcp) throws IOException {
Source source = null;

ensureExpectedToken(XContentParser.Token.START_OBJECT, xcp.currentToken(), xcp);
Expand All @@ -53,6 +55,12 @@ static Source parse(XContentParser xcp) throws IOException {
case URL_DOWNLOAD_FIELD:
source = UrlDownloadSource.parse(xcp);
break;
default:
throw new SecurityAnalyticsException(
"Unexpected input in 'source' field when reading ioc store config.",
RestStatus.BAD_REQUEST,
new IllegalArgumentException()
);
}
}
return source;
Expand Down
73 changes: 73 additions & 0 deletions src/test/java/org/opensearch/securityanalytics/threatIntel/model/ThreatIntelSourceTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
/*
* Copyright OpenSearch Contributors
* SPDX-License-Identifier: Apache-2.0
*/

package org.opensearch.securityanalytics.threatIntel.model;

import org.junit.Test;
import org.opensearch.core.rest.RestStatus;
import org.opensearch.securityanalytics.TestHelpers;
import org.opensearch.securityanalytics.util.SecurityAnalyticsException;
import org.opensearch.test.OpenSearchTestCase;

import java.io.IOException;

public class ThreatIntelSourceTests extends OpenSearchTestCase {

@Test
public void testParseWithS3Source() throws IOException {
String sourceString = "{\n" +
" \"s3\": {\n" +
" \"bucket_name\": \"bucket-name\",\n" +
" \"object_key\": \"object-key\",\n" +
" \"region\": \"us-west-2\",\n" +
" \"role_arn\": \"arn:aws:iam::123456789012:role/test_role\"\n" +
" }\n" +
" }";
Source source = Source.parse(TestHelpers.parser(sourceString));
assertSame(source.getClass(), S3Source.class);
assertEquals("bucket-name", ((S3Source) source).getBucketName());
assertEquals("object-key", ((S3Source) source).getObjectKey());
assertEquals("us-west-2", ((S3Source) source).getRegion());
assertEquals("arn:aws:iam::123456789012:role/test_role", ((S3Source) source).getRoleArn());
}

@Test
public void testParseWithIocUploadSource() throws IOException {
String sourceString = "{\n" +
" \"ioc_upload\" : {\n" +
" \"iocs\": []\n" +
" }\n" +
" }";
Source source = Source.parse(TestHelpers.parser(sourceString));
assertSame(source.getClass(), IocUploadSource.class);
assertTrue(((IocUploadSource) source).getIocs().isEmpty());
}

@Test
public void testParseWithUrlDownloadSource() throws IOException {
String sourceString = "{\n" +
" \"url_download\": {\n" +
" \"url\": \"https://reputation.alienvault.com/reputation.generic\",\n" +
" \"feed_format\": \"csv\"\n" +
" }\n" +
" }";
Source source = Source.parse(TestHelpers.parser(sourceString));
assertSame(source.getClass(), UrlDownloadSource.class);
assertEquals("https://reputation.alienvault.com/reputation.generic", ((UrlDownloadSource) source).getUrl().toString());
assertEquals("csv", ((UrlDownloadSource) source).getFeedFormat());
}

@Test
public void testParseInvalidSourceField() {
String sourceString = "{\n" +
" \"invalid_field\" : {\n" +
" \"iocs\": []\n" +
" }";

SecurityAnalyticsException exception = assertThrows(SecurityAnalyticsException.class, () -> Source.parse(TestHelpers.parser(sourceString)));
assertEquals(RestStatus.BAD_REQUEST, exception.status());
assertTrue(exception.getMessage().contains("Unexpected input in 'source' field when reading ioc store config."));
}
}
Loading