Skip to content

Commit d6b3afb

Browse files
authored
Add audit hooks for inter-node user data transfers (#18569)
* [Feature] Add audit hooks for inter-node user data transfers * [Feature] Address review for user data transfer audit hooks * [Feature] Address second-pass audit review * [Feature] Gate audit classification and filter snapshots * [Feature] Address audit transfer review feedback * [Feature] Reduce disabled transfer audit overhead * [Feature] Exclude audit database from IoTConsensusV2 audit * [Feature] Avoid duplicate IoTConsensusV2 audit classification
1 parent d130239 commit d6b3afb

41 files changed

Lines changed: 1734 additions & 36 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎iotdb-core/consensus/src/main/i18n/en/org/apache/iotdb/consensus/i18n/IoTConsensusMessages.java‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -333,5 +333,8 @@ private IoTConsensusMessages() {}
333333
public static final String LOG_RESERVED_ARG_BYTES_BATCH_ARG_ARG_CURRENT_TOTAL_USAGE_ARG_308AE9C2 = "Reserved {} bytes for batch {}-{}, current total usage {}";
334334
public static final String LOG_ARG_FAILED_SEND_IDLE_WRITER_SAFE_TIME_BARRIER_ARG_STATUS_AE047EAD = "{}: Failed to send idle writer safe-time barrier to {}. status={}";
335335
public static final String LOG_ARG_WRITE_OPERATION_FAILED_SEARCHINDEX_ARG_CODE_ARG_SUBSCRIPTIONQUEUES_ARG_THIS_ARG_F4B17576 = "{}: write operation failed. searchIndex: {}. Code: {}, subscriptionQueues: {}, this: {}";
336+
public static final String
337+
LOG_FAILED_TO_RECORD_A_USER_DATA_TRANSFER_AUDIT_EVENT_CONSENSUS_REPLICATION_WILL_CONTINUE_F215E222 =
338+
"Failed to record a user-data transfer audit event; consensus replication will continue.";
336339

337340
}

‎iotdb-core/consensus/src/main/i18n/zh/org/apache/iotdb/consensus/i18n/IoTConsensusMessages.java‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -331,5 +331,8 @@ private IoTConsensusMessages() {}
331331
public static final String LOG_RESERVED_ARG_BYTES_BATCH_ARG_ARG_CURRENT_TOTAL_USAGE_ARG_308AE9C2 = "预留 {} 字节给批次 {}-{},当前总使用量 {}";
332332
public static final String LOG_ARG_FAILED_SEND_IDLE_WRITER_SAFE_TIME_BARRIER_ARG_STATUS_AE047EAD = "{}:无法向 {} 发送 idle writer safe-time barrier。状态={}";
333333
public static final String LOG_ARG_WRITE_OPERATION_FAILED_SEARCHINDEX_ARG_CODE_ARG_SUBSCRIPTIONQUEUES_ARG_THIS_ARG_F4B17576 = "{}:写入操作失败。searchIndex: {}。Code: {},订阅队列:{},当前对象:{}";
334+
public static final String
335+
LOG_FAILED_TO_RECORD_A_USER_DATA_TRANSFER_AUDIT_EVENT_CONSENSUS_REPLICATION_WILL_CONTINUE_F215E222 =
336+
"记录用户数据传送审计事件失败;Consensus 复制将继续。";
334337

335338
}

‎iotdb-core/consensus/src/main/java/org/apache/iotdb/consensus/common/request/IndexedConsensusRequest.java‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ public class IndexedConsensusRequest implements IConsensusRequest {
4949
private long memorySize = 0;
5050
private long retainedMemorySize = 0;
5151
private boolean serializedRequestsBuilt = false;
52+
private boolean containsUserData = false;
5253
private final AtomicLong referenceCnt = new AtomicLong();
5354

5455
public IndexedConsensusRequest(long searchIndex, List<IConsensusRequest> requests) {
@@ -171,6 +172,15 @@ public IndexedConsensusRequest setNodeId(int nodeId) {
171172
return this;
172173
}
173174

175+
public boolean containsUserData() {
176+
return containsUserData;
177+
}
178+
179+
public IndexedConsensusRequest setContainsUserData(boolean containsUserData) {
180+
this.containsUserData = containsUserData;
181+
return this;
182+
}
183+
174184
public long getLocalSeq() {
175185
return searchIndex;
176186
}

‎iotdb-core/consensus/src/main/java/org/apache/iotdb/consensus/config/ConsensusConfig.java‎

Lines changed: 39 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
import org.apache.iotdb.common.rpc.thrift.TConsensusGroupType;
2323
import org.apache.iotdb.common.rpc.thrift.TEndPoint;
2424
import org.apache.iotdb.commons.audit.TrustedChannelFailureHandler;
25+
import org.apache.iotdb.commons.audit.UserDataTransferAuditHandler;
2526
import org.apache.iotdb.commons.disk.strategy.DirectoryStrategyType;
2627

2728
import java.util.List;
@@ -39,6 +40,8 @@ public class ConsensusConfig {
3940
private final IoTConsensusV2Config iotConsensusV2Config;
4041
private final DirectoryStrategyType directoryStrategyType;
4142
private final TrustedChannelFailureHandler trustedChannelFailureHandler;
43+
private final UserDataTransferAuditHandler userDataTransferAuditHandler;
44+
private final UserDataTransferAuditClassifier userDataTransferAuditClassifier;
4245

4346
private ConsensusConfig(
4447
TEndPoint thisNode,
@@ -50,7 +53,9 @@ private ConsensusConfig(
5053
IoTConsensusConfig iotConsensusConfig,
5154
IoTConsensusV2Config iotConsensusV2Config,
5255
DirectoryStrategyType directoryStrategyType,
53-
TrustedChannelFailureHandler trustedChannelFailureHandler) {
56+
TrustedChannelFailureHandler trustedChannelFailureHandler,
57+
UserDataTransferAuditHandler userDataTransferAuditHandler,
58+
UserDataTransferAuditClassifier userDataTransferAuditClassifier) {
5459
this.thisNodeEndPoint = thisNode;
5560
this.thisNodeId = thisNodeId;
5661
this.storageDir = storageDir;
@@ -61,6 +66,8 @@ private ConsensusConfig(
6166
this.iotConsensusV2Config = iotConsensusV2Config;
6267
this.directoryStrategyType = directoryStrategyType;
6368
this.trustedChannelFailureHandler = trustedChannelFailureHandler;
69+
this.userDataTransferAuditHandler = userDataTransferAuditHandler;
70+
this.userDataTransferAuditClassifier = userDataTransferAuditClassifier;
6471
}
6572

6673
public TEndPoint getThisNodeEndPoint() {
@@ -103,6 +110,14 @@ public TrustedChannelFailureHandler getTrustedChannelFailureHandler() {
103110
return trustedChannelFailureHandler;
104111
}
105112

113+
public UserDataTransferAuditHandler getUserDataTransferAuditHandler() {
114+
return userDataTransferAuditHandler;
115+
}
116+
117+
public UserDataTransferAuditClassifier getUserDataTransferAuditClassifier() {
118+
return userDataTransferAuditClassifier;
119+
}
120+
106121
public static ConsensusConfig.Builder newBuilder() {
107122
return new ConsensusConfig.Builder();
108123
}
@@ -121,6 +136,10 @@ public static class Builder {
121136
DirectoryStrategyType.MIN_FOLDER_OCCUPIED_SPACE_FIRST_STRATEGY;
122137
private TrustedChannelFailureHandler trustedChannelFailureHandler =
123138
TrustedChannelFailureHandler.NO_OP;
139+
private UserDataTransferAuditHandler userDataTransferAuditHandler =
140+
UserDataTransferAuditHandler.NO_OP;
141+
private UserDataTransferAuditClassifier userDataTransferAuditClassifier =
142+
UserDataTransferAuditClassifier.NO_USER_DATA;
124143

125144
public ConsensusConfig build() {
126145
return new ConsensusConfig(
@@ -135,7 +154,9 @@ public ConsensusConfig build() {
135154
Optional.ofNullable(iotConsensusV2Config)
136155
.orElseGet(() -> IoTConsensusV2Config.newBuilder().build()),
137156
directoryStrategyType,
138-
trustedChannelFailureHandler);
157+
trustedChannelFailureHandler,
158+
userDataTransferAuditHandler,
159+
userDataTransferAuditClassifier);
139160
}
140161

141162
public Builder setThisNode(TEndPoint thisNode) {
@@ -190,5 +211,21 @@ public Builder setTrustedChannelFailureHandler(
190211
.orElse(TrustedChannelFailureHandler.NO_OP);
191212
return this;
192213
}
214+
215+
public Builder setUserDataTransferAuditHandler(
216+
UserDataTransferAuditHandler userDataTransferAuditHandler) {
217+
this.userDataTransferAuditHandler =
218+
Optional.ofNullable(userDataTransferAuditHandler)
219+
.orElse(UserDataTransferAuditHandler.NO_OP);
220+
return this;
221+
}
222+
223+
public Builder setUserDataTransferAuditClassifier(
224+
UserDataTransferAuditClassifier userDataTransferAuditClassifier) {
225+
this.userDataTransferAuditClassifier =
226+
Optional.ofNullable(userDataTransferAuditClassifier)
227+
.orElse(UserDataTransferAuditClassifier.NO_USER_DATA);
228+
return this;
229+
}
193230
}
194231
}
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
/*
2+
* Licensed to the Apache Software Foundation (ASF) under one
3+
* or more contributor license agreements. See the NOTICE file
4+
* distributed with this work for additional information
5+
* regarding copyright ownership. The ASF licenses this file
6+
* to you under the Apache License, Version 2.0 (the
7+
* "License"); you may not use this file except in compliance
8+
* with the License. You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing,
13+
* software distributed under the License is distributed on an
14+
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
* KIND, either express or implied. See the License for the
16+
* specific language governing permissions and limitations
17+
* under the License.
18+
*/
19+
20+
package org.apache.iotdb.consensus.config;
21+
22+
import org.apache.iotdb.commons.consensus.ConsensusGroupId;
23+
import org.apache.iotdb.commons.request.IConsensusRequest;
24+
25+
@FunctionalInterface
26+
public interface UserDataTransferAuditClassifier {
27+
28+
UserDataTransferAuditClassifier NO_USER_DATA =
29+
new UserDataTransferAuditClassifier() {
30+
@Override
31+
public boolean containsUserData(ConsensusGroupId groupId, IConsensusRequest request) {
32+
return false;
33+
}
34+
35+
@Override
36+
public boolean containsUserData(ConsensusGroupId groupId) {
37+
return false;
38+
}
39+
};
40+
41+
boolean containsUserData(ConsensusGroupId groupId, IConsensusRequest request);
42+
43+
/** Classifies a whole consensus group when the transfer has no individual request to inspect. */
44+
default boolean containsUserData(ConsensusGroupId groupId) {
45+
return true;
46+
}
47+
}

‎iotdb-core/consensus/src/main/java/org/apache/iotdb/consensus/iot/IoTConsensus.java‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121

2222
import org.apache.iotdb.common.rpc.thrift.TEndPoint;
2323
import org.apache.iotdb.common.rpc.thrift.TSStatus;
24+
import org.apache.iotdb.commons.audit.UserDataTransferAuditHandler;
2425
import org.apache.iotdb.commons.client.IClientManager;
2526
import org.apache.iotdb.commons.concurrent.IoTDBThreadPoolFactory;
2627
import org.apache.iotdb.commons.concurrent.ThreadName;
@@ -45,6 +46,7 @@
4546
import org.apache.iotdb.consensus.common.Peer;
4647
import org.apache.iotdb.consensus.config.ConsensusConfig;
4748
import org.apache.iotdb.consensus.config.IoTConsensusConfig;
49+
import org.apache.iotdb.consensus.config.UserDataTransferAuditClassifier;
4850
import org.apache.iotdb.consensus.exception.ConsensusException;
4951
import org.apache.iotdb.consensus.exception.ConsensusGroupAlreadyExistException;
5052
import org.apache.iotdb.consensus.exception.ConsensusGroupModifyPeerException;
@@ -104,6 +106,8 @@ public class IoTConsensus implements IConsensus {
104106
new ConcurrentHashMap<>();
105107
private final IoTConsensusRPCService service;
106108
private final RegisterManager registerManager = new RegisterManager();
109+
private final UserDataTransferAuditHandler userDataTransferAuditHandler;
110+
private final UserDataTransferAuditClassifier userDataTransferAuditClassifier;
107111
private volatile IoTConsensusConfig config;
108112

109113
/**
@@ -131,6 +135,8 @@ public IoTConsensus(ConsensusConfig config, Registry registry) {
131135
this.recvSnapshotDirs = config.getRecvSnapshotDirs();
132136
this.recvFolderStrategyType = config.getDirectoryStrategyType();
133137
this.config = config.getIotConsensusConfig();
138+
this.userDataTransferAuditHandler = config.getUserDataTransferAuditHandler();
139+
this.userDataTransferAuditClassifier = config.getUserDataTransferAuditClassifier();
134140
this.registry = registry;
135141
this.service =
136142
new IoTConsensusRPCService(
@@ -207,7 +213,9 @@ private void initAndRecover() throws IOException {
207213
backgroundTaskService,
208214
clientManager,
209215
syncClientManager,
210-
config);
216+
config,
217+
userDataTransferAuditHandler,
218+
userDataTransferAuditClassifier);
211219
stateMachineMap.put(consensusGroupId, consensus);
212220
}
213221
} catch (DiskSpaceInsufficientException e) {
@@ -322,7 +330,9 @@ public void createLocalPeer(ConsensusGroupId groupId, List<Peer> peers)
322330
backgroundTaskService,
323331
clientManager,
324332
syncClientManager,
325-
config);
333+
config,
334+
userDataTransferAuditHandler,
335+
userDataTransferAuditClassifier);
326336
} catch (DiskSpaceInsufficientException e) {
327337
throw new RuntimeException(e);
328338
}

0 commit comments

Comments
 (0)