Skip to content

HDDS-16115. Reject invalid lifecycle rule Status values #10980

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
F64116045 wants to merge 2 commits into
base: master
Choose a base branch
from
+37 −3
Open

HDDS-16115. Reject invalid lifecycle rule Status values #10980

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
212dde1
HDDS-16115. Reject invalid lifecycle rule Status values
F64116045 Aug 10, 2026
288c96e
HDDS-16115. Refine lifecycle status validation
F64116045 Aug 10, 2026
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
12 changes: 10 additions & 2 deletions ...s3gateway/src/main/java/org/apache/hadoop/ozone/s3/endpoint/S3LifecycleConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import org.apache.commons.lang3.StringUtils;
import org.apache.hadoop.ozone.client.OzoneBucket;
import org.apache.hadoop.ozone.client.OzoneLifecycleConfiguration;
import org.apache.hadoop.ozone.om.exceptions.OMException;
Expand All @@ -44,6 +45,9 @@
@XmlRootElement(name = "LifecycleConfiguration",
namespace = "http://s3.amazonaws.com/doc/2006-03-01/")
public class S3LifecycleConfiguration {
private static final String STATUS_ENABLED = "Enabled";
private static final String STATUS_DISABLED = "Disabled";

@XmlElement(name = "Rule")
private List<Rule> rules = new ArrayList<>();

Expand Down Expand Up @@ -312,13 +316,17 @@ public OmLifecycleConfiguration toOmLifecycleConfiguration(OzoneBucket ozoneBuck
* @return OmLCRule internal rule representation
*/
private OmLCRule convertToOmRule(Rule rule) throws OMException, OS3Exception {
if (rule.getStatus() == null || rule.getStatus().isEmpty()) {
String status = rule.getStatus();
if (StringUtils.isEmpty(status)) {
throw S3ErrorTable.newError(S3ErrorTable.MALFORMED_XML,
"The Status element is required in LifecycleConfiguration");

@F64116045 F64116045 Aug 10, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The second String argument here is actually resource, and OS3Exception serializes it as <Resource>. So this text does not replace <Message>; MALFORMED_XML already provides that. I think the one-argument overload is enough here.

This is in the existing missing-Status path, so I plan to follow it up separately with response coverage. If it makes more sense to include it here, I can update the patch.

}
if (!STATUS_ENABLED.equals(status) && !STATUS_DISABLED.equals(status)) {
throw S3ErrorTable.newError(S3ErrorTable.MALFORMED_XML);
}

OmLCRule.Builder builder = new OmLCRule.Builder()
.setEnabled("Enabled".equals(rule.getStatus()))
.setEnabled(STATUS_ENABLED.equals(status))
.setId(rule.getId())
.setPrefix(rule.getPrefix());

Expand Down
28 changes: 27 additions & 1 deletion ...ay/src/test/java/org/apache/hadoop/ozone/s3/endpoint/TestS3LifecycleConfigurationPut.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@
import org.apache.hadoop.ozone.s3.util.S3Consts;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.ValueSource;
import org.mockito.Mockito;

/**
Expand Down Expand Up @@ -137,6 +139,16 @@ public void testPutLifecycleConfigurationWithoutStatus() throws Exception {
}
}

@ParameterizedTest
@ValueSource(strings = {"enabled", "disabled", "invalid"})
public void testPutLifecycleConfigurationWithInvalidStatus(String status)
throws Exception {
OS3Exception ex = assertThrows(OS3Exception.class,
() -> bucketEndpoint.put("bucket1", withStatus(status)));
assertEquals(HTTP_BAD_REQUEST, ex.getHttpCode());
assertEquals(MALFORMED_XML.getCode(), ex.getCode());
}

private void testInvalidLifecycleConfiguration(Supplier<InputStream> inputStream,
int expectedHttpCode, String expectedErrorCode) throws Exception {
try {
Expand Down Expand Up @@ -170,7 +182,8 @@ public void testPutInvalidExpirationDateLCC() throws Exception {

@Test
public void testPutValidLifecycleConfiguration() throws Exception {
assertEquals(HTTP_OK, bucketEndpoint.put("bucket1", onePrefix()).getStatus());
assertEquals(HTTP_OK, bucketEndpoint.put("bucket1", withStatus("Enabled")).getStatus());
assertEquals(HTTP_OK, bucketEndpoint.put("bucket1", withStatus("Disabled")).getStatus());

@ashishkumar50 ashishkumar50 Aug 10, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Verify valid input for both Enabled and Disabled.

@F64116045 F64116045 Aug 10, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added the Enabled test, thanks.

assertEquals(HTTP_OK, bucketEndpoint.put("bucket1", emptyPrefix()).getStatus());
assertEquals(HTTP_OK, bucketEndpoint.put("bucket1", oneTag()).getStatus());
assertEquals(HTTP_OK, bucketEndpoint.put("bucket1", twoTagsInAndOperator()).getStatus());
Expand Down Expand Up @@ -304,6 +317,19 @@ private static InputStream withoutStatus() {
return new ByteArrayInputStream(xml.getBytes(StandardCharsets.UTF_8));
}

private static InputStream withStatus(String status) {
String xml =
"<LifecycleConfiguration xmlns=\"http://s3.amazonaws.com/doc/2006-03-01/\">" +
"<Rule>" +
"<ID>remove logs after 30 days</ID>" +
"<Prefix>prefix/</Prefix>" +
"<Status>" + status + "</Status>" +
"<Expiration><Days>30</Days></Expiration>" +
"</Rule>" +
"</LifecycleConfiguration>";
return new ByteArrayInputStream(xml.getBytes(StandardCharsets.UTF_8));
}

private static InputStream withoutFilter() {
String xml =
"<LifecycleConfiguration xmlns=\"http://s3.amazonaws.com/doc/2006-03-01/\">" +
Expand Down