Skip to content

ZOOKEEPER-5113: Audit log keys, mntr peer_state and admin zabstate are lower-cased with the JVM default locale #2481

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
sharanggupta wants to merge 1 commit into
base: master
Choose a base branch
from
+31 −9
Open

ZOOKEEPER-5113: Audit log keys, mntr peer_state and admin zabstate are lower-cased with the JVM default locale #2481

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
7 changes: 4 additions & 3 deletions zookeeper-server/src/main/java/org/apache/zookeeper/audit/AuditEvent.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
package org.apache.zookeeper.audit;

import java.util.LinkedHashMap;
import java.util.Locale;
import java.util.Map;
import java.util.Set;
import org.apache.zookeeper.common.StringUtils;
Expand All @@ -44,12 +45,12 @@ public Set<Map.Entry<String, String>> getLogEntries() {

void addEntry(FieldName fieldName, String value) {
if (value != null) {
logEntries.put(fieldName.name().toLowerCase(), value);
logEntries.put(fieldName.name().toLowerCase(Locale.ROOT), value);
}
}

public String getValue(FieldName fieldName) {
return logEntries.get(fieldName.name().toLowerCase());
return logEntries.get(fieldName.name().toLowerCase(Locale.ROOT));
}

public Result getResult() {
Expand Down Expand Up @@ -84,7 +85,7 @@ public String toString() {
buffer.append(PAIR_SEPARATOR);
}
buffer.append("result").append(KEY_VAL_SEPARATOR)
.append(result.name().toLowerCase());
.append(result.name().toLowerCase(Locale.ROOT));
return buffer.toString();
}

Expand Down
3 changes: 2 additions & 1 deletion zookeeper-server/src/main/java/org/apache/zookeeper/audit/AuditHelper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@

import java.io.IOException;
import java.util.HashMap;
import java.util.Locale;
import java.util.Map;
import org.apache.zookeeper.CreateMode;
import org.apache.zookeeper.KeeperException;
Expand Down Expand Up @@ -182,7 +183,7 @@ private static void log(String user, String operation, String znode, String acl,
}

private static String getCreateMode(int createFlags) throws KeeperException {
return CreateMode.fromFlag(createFlags).toString().toLowerCase();
return CreateMode.fromFlag(createFlags).toString().toLowerCase(Locale.ROOT);
}

private static Map<String, String> getCreateModes(Request request)
Expand Down
3 changes: 2 additions & 1 deletion zookeeper-server/src/main/java/org/apache/zookeeper/server/admin/Commands.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Properties;
import java.util.Set;
Expand Down Expand Up @@ -1213,7 +1214,7 @@ public CommandResponse runGet(ZooKeeperServer zkServer, Map<String, String> kwar
response.put("last_zxid", "0x" + ZxidUtils.zxidToString(lastProcessedZxid));
response.put("zab_epoch", ZxidUtils.getEpochFromZxid(lastProcessedZxid));
response.put("zab_counter", ZxidUtils.getCounterFromZxid(lastProcessedZxid));
response.put("zabstate", zabState.name().toLowerCase());
response.put("zabstate", zabState.name().toLowerCase(Locale.ROOT));
} else {
response.put("voting", false);
response.put("zabstate", "");
Expand Down
9 changes: 5 additions & 4 deletions zookeeper-server/src/main/java/org/apache/zookeeper/server/quorum/QuorumPeer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
import java.util.HashSet;
import java.util.LinkedList;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Properties;
Expand Down Expand Up @@ -282,7 +283,7 @@ public void recreateSocketAddresses() {
}

private LearnerType getType(String s) throws ConfigException {
switch (s.trim().toLowerCase()) {
switch (s.trim().toLowerCase(Locale.ROOT)) {
case "observer":
return LearnerType.OBSERVER;
case "participant":
Expand Down Expand Up @@ -1004,14 +1005,14 @@ public long getLeaderId() {
}

public String getDetailedPeerState() {
final StringBuilder sb = new StringBuilder(getPeerState().toString().toLowerCase());
final StringBuilder sb = new StringBuilder(getPeerState().toString().toLowerCase(Locale.ROOT));
final ZabState zabState = getZabState();
if (!ZabState.ELECTION.equals(zabState)) {
sb.append(" - ").append(zabState.toString().toLowerCase());
sb.append(" - ").append(zabState.toString().toLowerCase(Locale.ROOT));
}
final SyncMode syncMode = getSyncMode();
if (!SyncMode.NONE.equals(syncMode)) {
sb.append(" - ").append(syncMode.toString().toLowerCase());
sb.append(" - ").append(syncMode.toString().toLowerCase(Locale.ROOT));
}
return sb.toString();
}
Expand Down
18 changes: 18 additions & 0 deletions zookeeper-server/src/test/java/org/apache/zookeeper/audit/AuditEventTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
package org.apache.zookeeper.audit;

import static org.junit.jupiter.api.Assertions.assertEquals;
import java.util.Locale;
import org.apache.zookeeper.audit.AuditEvent.Result;
import org.junit.jupiter.api.Test;

Expand Down Expand Up @@ -52,4 +53,21 @@ public void testSanitizeInvalidOutput() {
String expected = "user=Value1\toperation=fakeoperation=deleteznode=/forged:pw\tresult=success";
assertEquals(expected, actual);
}

@Test
public void testFormatRegardlessOfDefaultLocale() {
Locale defaultLocale = Locale.getDefault();
Locale.setDefault(Locale.forLanguageTag("tr-TR"));
try {
AuditEvent auditEvent = new AuditEvent(Result.INVOKED);
auditEvent.addEntry(AuditEvent.FieldName.SESSION, "0x1000");
auditEvent.addEntry(AuditEvent.FieldName.IP, "10.0.0.7");
auditEvent.addEntry(AuditEvent.FieldName.OPERATION, "create");
String expected = "session=0x1000\tip=10.0.0.7\toperation=create\tresult=invoked";
assertEquals(expected, auditEvent.toString());
assertEquals("10.0.0.7", auditEvent.getValue(AuditEvent.FieldName.IP));
} finally {
Locale.setDefault(defaultLocale);
}
}
}