Skip to content

Commit 7294508

Browse files
Remove dead code related to auditing (#94114)
This PR removes: * the CompositeAuditTrail which is designed to fan-out auditing events to multiple logger implementation types. This is not needed because since v7.0 there's only one audit logger implementation, the logfile. * any traces of the index-based logger implementation, namely the permission of the internal _xpack user to read the audit log index. Related: #37707
1 parent ded6f3d commit 7294508

File tree

18 files changed

+62
-434
lines changed

18 files changed

+62
-434
lines changed

x-pack/plugin/core/src/main/java/module-info.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,6 @@
154154
exports org.elasticsearch.xpack.core.security.authz.store;
155155
exports org.elasticsearch.xpack.core.security.authz.support;
156156
exports org.elasticsearch.xpack.core.security.authz;
157-
exports org.elasticsearch.xpack.core.security.index;
158157
exports org.elasticsearch.xpack.core.security.support;
159158
exports org.elasticsearch.xpack.core.security.user;
160159
exports org.elasticsearch.xpack.core.security.xcontent;

x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/security/index/IndexAuditTrailField.java

Lines changed: 0 additions & 13 deletions
This file was deleted.

x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/security/user/XPackUser.java

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@
88

99
import org.elasticsearch.common.Strings;
1010
import org.elasticsearch.xpack.core.security.authz.RoleDescriptor;
11-
import org.elasticsearch.xpack.core.security.index.IndexAuditTrailField;
1211
import org.elasticsearch.xpack.core.security.support.MetadataUtils;
1312

1413
/**
@@ -25,8 +24,7 @@ public class XPackUser extends User {
2524
.indices("/@&~(\\.security.*)&~(\\.async-search.*)/")
2625
.privileges("all")
2726
.allowRestrictedIndices(true)
28-
.build(),
29-
RoleDescriptor.IndicesPrivileges.builder().indices(IndexAuditTrailField.INDEX_NAME_PREFIX + "-*").privileges("read").build() },
27+
.build() },
3028
new String[] { "*" },
3129
MetadataUtils.DEFAULT_RESERVED_METADATA
3230
);

x-pack/plugin/security/src/internalClusterTest/java/org/elasticsearch/xpack/security/audit/logfile/AuditTrailSettingsUpdateTests.java

Lines changed: 5 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -88,9 +88,7 @@ public void testDynamicFilterSettings() throws Exception {
8888
final String actual = ((LoggingAuditTrail) internalCluster().getInstances(AuditTrailService.class)
8989
.iterator()
9090
.next()
91-
.getAuditTrails()
92-
.iterator()
93-
.next()).eventFilterPolicyRegistry.toString();
91+
.getAuditTrail()).eventFilterPolicyRegistry.toString();
9492
assertEquals(expected, actual);
9593
}
9694

@@ -112,7 +110,6 @@ public void testInvalidFilterSettings() throws Exception {
112110
}
113111

114112
public void testDynamicHostSettings() {
115-
final boolean persistent = randomBoolean();
116113
final Settings.Builder settingsBuilder = Settings.builder();
117114
settingsBuilder.put(LoggingAuditTrail.EMIT_HOST_ADDRESS_SETTING.getKey(), true);
118115
settingsBuilder.put(LoggingAuditTrail.EMIT_HOST_NAME_SETTING.getKey(), true);
@@ -122,9 +119,7 @@ public void testDynamicHostSettings() {
122119
final LoggingAuditTrail loggingAuditTrail = (LoggingAuditTrail) internalCluster().getInstances(AuditTrailService.class)
123120
.iterator()
124121
.next()
125-
.getAuditTrails()
126-
.iterator()
127-
.next();
122+
.getAuditTrail();
128123
assertThat(loggingAuditTrail.entryCommonFields.commonFields.get(LoggingAuditTrail.NODE_NAME_FIELD_NAME), startsWith("node_"));
129124
assertThat(loggingAuditTrail.entryCommonFields.commonFields.containsKey(LoggingAuditTrail.NODE_ID_FIELD_NAME), is(true));
130125
assertThat(loggingAuditTrail.entryCommonFields.commonFields.get(LoggingAuditTrail.HOST_ADDRESS_FIELD_NAME), is("127.0.0.1"));
@@ -159,9 +154,7 @@ public void testDynamicClusterSettings() {
159154
final LoggingAuditTrail loggingAuditTrail = (LoggingAuditTrail) internalCluster().getInstances(AuditTrailService.class)
160155
.iterator()
161156
.next()
162-
.getAuditTrails()
163-
.iterator()
164-
.next();
157+
.getAuditTrail();
165158

166159
final Settings.Builder settingsBuilder = Settings.builder();
167160
settingsBuilder.put(LoggingAuditTrail.EMIT_CLUSTER_NAME_SETTING.getKey(), true);
@@ -197,9 +190,7 @@ public void testDynamicRequestBodySettings() {
197190
final LoggingAuditTrail loggingAuditTrail = (LoggingAuditTrail) internalCluster().getInstances(AuditTrailService.class)
198191
.iterator()
199192
.next()
200-
.getAuditTrails()
201-
.iterator()
202-
.next();
193+
.getAuditTrail();
203194
assertEquals(enableRequestBody, loggingAuditTrail.includeRequestBody);
204195
settingsBuilder.put(LoggingAuditTrail.INCLUDE_REQUEST_BODY.getKey(), enableRequestBody == false);
205196
updateSettings(settingsBuilder.build());
@@ -230,9 +221,7 @@ public void testDynamicEventsSettings() {
230221
final LoggingAuditTrail loggingAuditTrail = (LoggingAuditTrail) internalCluster().getInstances(AuditTrailService.class)
231222
.iterator()
232223
.next()
233-
.getAuditTrails()
234-
.iterator()
235-
.next();
224+
.getAuditTrail();
236225
assertEquals(AuditLevel.parse(includedEvents, excludedEvents), loggingAuditTrail.events);
237226
}
238227

x-pack/plugin/security/src/internalClusterTest/java/org/elasticsearch/xpack/security/authz/SecuritySearchOperationListenerTests.java

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,6 @@
3838
import org.junit.Before;
3939

4040
import java.util.Collections;
41-
import java.util.List;
4241

4342
import static org.elasticsearch.xpack.core.security.authz.AuthorizationServiceField.AUTHORIZATION_INFO_KEY;
4443
import static org.elasticsearch.xpack.core.security.authz.AuthorizationServiceField.ORIGINATING_ACTION_KEY;
@@ -126,7 +125,7 @@ public void testValidateSearchContext() throws Exception {
126125
ThreadContext threadContext = new ThreadContext(Settings.EMPTY);
127126
final SecurityContext securityContext = new SecurityContext(Settings.EMPTY, threadContext);
128127
AuditTrail auditTrail = mock(AuditTrail.class);
129-
AuditTrailService auditTrailService = new AuditTrailService(Collections.singletonList(auditTrail), licenseState);
128+
AuditTrailService auditTrailService = new AuditTrailService(auditTrail, licenseState);
130129

131130
SecuritySearchOperationListener listener = new SecuritySearchOperationListener(securityContext, auditTrailService);
132131
try (StoredContext ignore = threadContext.newStoredContext()) {
@@ -261,7 +260,7 @@ public void testValidateResourceAccessCheck() throws Exception {
261260
when(licenseState.isAllowed(Security.AUDITING_FEATURE)).thenReturn(true);
262261
final SecurityContext securityContext = new SecurityContext(Settings.EMPTY, new ThreadContext(Settings.EMPTY));
263262
final AuditTrail auditTrail = mock(AuditTrail.class);
264-
final AuditTrailService auditTrailService = new AuditTrailService(List.of(auditTrail), licenseState);
263+
final AuditTrailService auditTrailService = new AuditTrailService(auditTrail, licenseState);
265264

266265
final SecuritySearchOperationListener listener = new SecuritySearchOperationListener(securityContext, auditTrailService);
267266
final TransportRequest request = mock(TransportRequest.class);

x-pack/plugin/security/src/main/java/org/elasticsearch/xpack/security/Security.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -626,10 +626,10 @@ Collection<Object> createComponents(
626626
final RestrictedIndices restrictedIndices = new RestrictedIndices(expressionResolver);
627627

628628
// audit trail service construction
629-
final List<AuditTrail> auditTrails = XPackSettings.AUDIT_ENABLED.get(settings)
630-
? Collections.singletonList(new LoggingAuditTrail(settings, clusterService, threadPool))
631-
: Collections.emptyList();
632-
final AuditTrailService auditTrailService = new AuditTrailService(auditTrails, getLicenseState());
629+
final AuditTrail auditTrail = XPackSettings.AUDIT_ENABLED.get(settings)
630+
? new LoggingAuditTrail(settings, clusterService, threadPool)
631+
: null;
632+
final AuditTrailService auditTrailService = new AuditTrailService(auditTrail, getLicenseState());
633633
components.add(auditTrailService);
634634
this.auditTrailService.set(auditTrailService);
635635

0 commit comments

Comments
 (0)