Skip to content

HDDS-15958. Return InvalidURI for unreadable S3 object keys on GetObject #10860

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

Open
Gargi-jais11 wants to merge 1 commit into
base: master
Choose a base branch
from
+70 −0
Open

HDDS-15958. Return InvalidURI for unreadable S3 object keys on GetObject #10860

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
20 changes: 20 additions & 0 deletions ...tion-test-s3/src/test/java/org/apache/hadoop/ozone/s3/awssdk/v1/AbstractS3SDKV1Tests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1338,6 +1338,26 @@ public void testGetObject() throws Exception {
}
}

/**
* Adapted from ceph s3-tests test_object_read_unreadable.
*/
@Test
public void testGetObjectUnreadableKey() {
final String bucketName = getBucketName();
s3Client.createBucket(bucketName);

String unreadableKey = new String(new byte[] {(byte) 0xae, (byte) 0x8a, '-'},
StandardCharsets.ISO_8859_1);

AmazonServiceException ase = assertThrows(AmazonServiceException.class,
() -> s3Client.getObject(bucketName, unreadableKey));

assertEquals(ErrorType.Client, ase.getErrorType());
assertEquals(400, ase.getStatusCode());
assertEquals(S3ErrorTable.INVALID_URI.getCode(), ase.getErrorCode());
assertEquals(S3ErrorTable.INVALID_URI.getErrorMessage(), ase.getErrorMessage());
}

static Stream<Arguments> onlyTagKeyCasesV1() {
Map<String, String> fooBarEmptyBar = new HashMap<>();
fooBarEmptyBar.put("foo", "bar");
Expand Down
19 changes: 19 additions & 0 deletions ...tion-test-s3/src/test/java/org/apache/hadoop/ozone/s3/awssdk/v2/AbstractS3SDKV2Tests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -588,6 +588,25 @@ public void testGetObjectIfModifiedSinceReturnsNotModified() {
assertEquals(304, exception.statusCode());
}

/**
* Adapted from ceph s3-tests test_object_read_unreadable.
*/
@Test
public void testGetObjectUnreadableKey() {
final String bucketName = getBucketName();
s3Client.createBucket(b -> b.bucket(bucketName));

String unreadableKey = new String(new byte[] {(byte) 0xae, (byte) 0x8a, '-'},
StandardCharsets.ISO_8859_1);

S3Exception exception = assertThrows(S3Exception.class,
() -> s3Client.getObjectAsBytes(b -> b.bucket(bucketName).key(unreadableKey)));

assertEquals(400, exception.statusCode());
assertEquals(S3ErrorTable.INVALID_URI.getCode(), exception.awsErrorDetails().errorCode());
assertEquals(S3ErrorTable.INVALID_URI.getErrorMessage(), exception.awsErrorDetails().errorMessage());
}

@Test
public void testHeadObjectIfMatch() {
final String bucketName = getBucketName();
Expand Down
18 changes: 18 additions & 0 deletions hadoop-ozone/s3gateway/src/main/java/org/apache/hadoop/ozone/s3/endpoint/EndpointBase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
import static org.apache.hadoop.ozone.s3.exception.S3ErrorTable.INVALID_ARGUMENT;
import static org.apache.hadoop.ozone.s3.exception.S3ErrorTable.INVALID_REQUEST;
import static org.apache.hadoop.ozone.s3.exception.S3ErrorTable.INVALID_TAG;
import static org.apache.hadoop.ozone.s3.exception.S3ErrorTable.INVALID_URI;
import static org.apache.hadoop.ozone.s3.exception.S3ErrorTable.newError;
import static org.apache.hadoop.ozone.s3.util.S3Consts.AWS_TAG_PREFIX;
import static org.apache.hadoop.ozone.s3.util.S3Consts.CUSTOM_METADATA_HEADER_PREFIX;
Expand Down Expand Up @@ -617,6 +618,23 @@ protected static boolean isAccessDenied(OMException ex) {
|| result == ResultCodes.INVALID_TOKEN;
}

/**
* Reject object keys that cannot be represented in a valid URI. AWS S3 returns
* InvalidURI for unreadable keys (non-printable ASCII 128-255) before lookup.
*/
protected void validateObjectKeyUri(String keyPath) throws OS3Exception {
if (keyPath == null || keyPath.indexOf('\uFFFD') >= 0) {
throw newError(INVALID_URI, keyPath);
}

for (int i = 0; i < keyPath.length(); i++) {
char c = keyPath.charAt(i);
if (c >= 0x80 && c <= 0xFF) {
throw newError(INVALID_URI, keyPath);
}
}
}

protected ReplicationConfig getReplicationConfig(OzoneBucket ozoneBucket) throws OS3Exception {
String storageType = getHeaders().getHeaderString(STORAGE_CLASS_HEADER);
String storageConfig = getHeaders().getHeaderString(CUSTOM_METADATA_HEADER_PREFIX + STORAGE_CONFIG_HEADER);
Expand Down
1 change: 1 addition & 0 deletions hadoop-ozone/s3gateway/src/main/java/org/apache/hadoop/ozone/s3/endpoint/ObjectEndpoint.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -364,6 +364,7 @@ public Response get(
) throws IOException, OS3Exception {
ObjectRequestContext context = new ObjectRequestContext(S3GAction.GET_KEY, bucketName);
try {
validateObjectKeyUri(keyPath);
return handler.handleGetRequest(context, keyPath);
} catch (OMException ex) {
throw newError(bucketName, keyPath, ex);
Expand Down
12 changes: 12 additions & 0 deletions hadoop-ozone/s3gateway/src/test/java/org/apache/hadoop/ozone/s3/endpoint/TestObjectGet.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,15 @@

package org.apache.hadoop.ozone.s3.endpoint;

import static java.nio.charset.StandardCharsets.ISO_8859_1;
import static java.nio.charset.StandardCharsets.UTF_8;
import static org.apache.hadoop.ozone.s3.S3GatewayConfigKeys.OZONE_S3G_FSO_DIRECTORY_CREATION_ENABLED;
import static org.apache.hadoop.ozone.s3.endpoint.EndpointTestUtils.assertErrorResponse;
import static org.apache.hadoop.ozone.s3.endpoint.EndpointTestUtils.assertSucceeds;
import static org.apache.hadoop.ozone.s3.endpoint.EndpointTestUtils.get;
import static org.apache.hadoop.ozone.s3.endpoint.EndpointTestUtils.put;
import static org.apache.hadoop.ozone.s3.exception.S3ErrorTable.INVALID_ARGUMENT;
import static org.apache.hadoop.ozone.s3.exception.S3ErrorTable.INVALID_URI;
import static org.apache.hadoop.ozone.s3.exception.S3ErrorTable.NO_SUCH_KEY;
import static org.apache.hadoop.ozone.s3.exception.S3ErrorTable.PRECOND_FAILED;
import static org.apache.hadoop.ozone.s3.util.S3Consts.CUSTOM_METADATA_HEADER_PREFIX;
Expand Down Expand Up @@ -118,6 +121,15 @@ public void testGetWithNegativePartNumber() throws Exception {
() -> get(rest, BUCKET_NAME, KEY_NAME));
}

@Test
public void testGetUnreadableKey() {
String unreadableKey = new String(new byte[] {(byte) 0xae, (byte) 0x8a, '-'}, ISO_8859_1);
assertErrorResponse(INVALID_URI, () -> get(rest, BUCKET_NAME, unreadableKey));

String malformedUtf8Key = new String(new byte[] {(byte) 0xae, (byte) 0x8a, '-'}, UTF_8);
assertErrorResponse(INVALID_URI, () -> get(rest, BUCKET_NAME, malformedUtf8Key));
}

@Test
public void testGet() throws IOException, OS3Exception {
//WHEN
Expand Down