Skip to content

Allow audit config PUT when document does not exist #6158

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
terryquigleysas wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Allow audit config PUT when document does not exist #6158

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
6c61bfc
Allow audit config PUT when document does not exist
terryquigleysas May 22, 2026
85cdad3
spotless
terryquigleysas May 22, 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
14 changes: 13 additions & 1 deletion src/main/java/org/opensearch/security/dlic/rest/api/AuditApiAction.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -267,12 +267,24 @@ private void auditApiRequestHandlers(RequestHandler.RequestHandlersBuilder reque
.onChangeRequest(RestRequest.Method.PATCH, request -> withEnabledAuditApi(request).map(this::processPatchRequest))
.onChangeRequest(
RestRequest.Method.PUT,
request -> withEnabledAuditApi(request).map(ignore -> processPutRequest("config", request))
request -> withCreateOrUpdateAuditApi(request).map(ignore -> processPutRequest("config", request))

@cwperks cwperks May 26, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Is it worth getting rid of withEnabledAuditApi entirely?

I see that there's this block which checks for doc existing in .opendistro_security.

I agree that hot reload being disabled should be intentional and not proxied by checking for the auditlog entry in the security index.

)
.override(RestRequest.Method.POST, methodNotImplementedHandler)
.override(RestRequest.Method.DELETE, methodNotImplementedHandler);
}

/**
* Allows PUT to bootstrap the audit config when the document does not exist,
* or to update it through normal validation when it does.
*/
ValidationResult<RestRequest> withCreateOrUpdateAuditApi(final RestRequest request) {
if (!securityApiDependencies.configurationRepository().isAuditHotReloadingEnabled()) {
// Document does not exist — allow PUT to bootstrap the audit config
return ValidationResult.success(request);
}
return withEnabledAuditApi(request);
}

ValidationResult<RestRequest> withEnabledAuditApi(final RestRequest request) {
if (!securityApiDependencies.configurationRepository().isAuditHotReloadingEnabled()) {
return ValidationResult.error(RestStatus.NOT_IMPLEMENTED, methodNotImplementedMessage(request.method()));
Expand Down
21 changes: 21 additions & 0 deletions src/test/java/org/opensearch/security/dlic/rest/api/AuditApiActionValidationTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@

import org.opensearch.common.settings.Settings;
import org.opensearch.core.rest.RestStatus;
import org.opensearch.rest.RestRequest;
import org.opensearch.security.auditlog.config.AuditConfig;
import org.opensearch.security.securityconf.impl.CType;
import org.opensearch.security.securityconf.impl.SecurityDynamicConfiguration;
Expand All @@ -42,6 +43,26 @@ public void disabledAuditApi() {
}
}

@Test
public void putAllowedWhenAuditConfigDocDoesNotExist() {
final var auditApiAction = new AuditApiAction(clusterService, threadPool, securityApiDependencies);
when(configurationRepository.isAuditHotReloadingEnabled()).thenReturn(false);

// PUT is allowed when the audit config document does not exist (bootstrap case)
final var result = auditApiAction.withCreateOrUpdateAuditApi(FakeRestRequest.builder().withMethod(RestRequest.Method.PUT).build());
assertTrue(result.isValid());
}

@Test
public void putAllowedWhenAuditConfigDocExists() {
final var auditApiAction = new AuditApiAction(clusterService, threadPool, securityApiDependencies);
when(configurationRepository.isAuditHotReloadingEnabled()).thenReturn(true);

// PUT is also allowed when the audit config document exists (update case)
final var result = auditApiAction.withCreateOrUpdateAuditApi(FakeRestRequest.builder().withMethod(RestRequest.Method.PUT).build());
assertTrue(result.isValid());
}

@Test
public void enabledAuditApi() {
final var auditApiAction = new AuditApiAction(clusterService, threadPool, securityApiDependencies);
Expand Down
Loading