-
Notifications
You must be signed in to change notification settings - Fork 581
fix(pd): resolve hostname entries in IpAuthHandler allowlist #2962
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.
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
Merged
imbajin
merged 7 commits into
apache:master
from
bitflicker64:fix-ipauthhandler-dns-resolution
Mar 17, 2026
Merged
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
9b9154b
Fix #2960: resolve hostname allowlist entries in IpAuthHandler at sta…
bitflicker64 0f2f00b
Fix IpAuthHandler hostname resolution and refresh allowlist after pee…
bitflicker64 1fca2c8
fix: refresh IpAuthHandler allowlist via updatePdRaft() bypass path
bitflicker64 980020a
Add TODO notes documenting current PD authentication limitations
bitflicker64 c888632
fix(test): add regression test for changePeerList -> IpAuthHandler.re…
bitflicker64 5d6e38e
fix: add timeout to changePeerList() and fix IPv6 flaky test
bitflicker64 0aa2d5f
fix: avoid changePeerList timeout race and update tests
bitflicker64 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
132 changes: 132 additions & 0 deletions
132
hugegraph-pd/hg-pd-test/src/main/java/org/apache/hugegraph/pd/raft/IpAuthHandlerTest.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,132 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to You under the Apache License, Version 2.0 | ||
| * (the "License"); you may not use this file except in compliance with | ||
| * the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package org.apache.hugegraph.pd.raft; | ||
|
|
||
| import java.net.InetAddress; | ||
| import java.util.Collections; | ||
| import java.util.HashSet; | ||
| import java.util.Set; | ||
|
|
||
| import org.apache.hugegraph.pd.raft.auth.IpAuthHandler; | ||
| import org.apache.hugegraph.testutil.Whitebox; | ||
| import org.junit.After; | ||
| import org.junit.Assert; | ||
| import org.junit.Before; | ||
| import org.junit.Test; | ||
|
|
||
| public class IpAuthHandlerTest { | ||
|
|
||
| @Before | ||
| public void setUp() { | ||
| // Must reset BEFORE each test — earlier suite classes (e.g. ConfigServiceTest) | ||
| // initialize RaftEngine which creates the IpAuthHandler singleton with their | ||
| // own peer IPs. Without this reset, our getInstance() calls return the stale | ||
| // singleton and ignore the allowlist passed by the test. | ||
| Whitebox.setInternalState(IpAuthHandler.class, "instance", null); | ||
| } | ||
|
|
||
| @After | ||
bitflicker64 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| public void tearDown() { | ||
| // Must reset AFTER each test — prevents our test singleton from leaking | ||
| // into later suite classes that also depend on IpAuthHandler state. | ||
| Whitebox.setInternalState(IpAuthHandler.class, "instance", null); | ||
| } | ||
bitflicker64 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| private boolean isIpAllowed(IpAuthHandler handler, String ip) { | ||
| return Whitebox.invoke(IpAuthHandler.class, | ||
| new Class[]{String.class}, | ||
| "isIpAllowed", handler, ip); | ||
| } | ||
|
|
||
| @Test | ||
| public void testHostnameResolvesToIp() throws Exception { | ||
| // "localhost" should resolve to one or more IPs via InetAddress.getAllByName() | ||
| // This verifies the core fix: hostname allowlists match numeric remote addresses | ||
| // Using dynamic resolution avoids hardcoding "127.0.0.1" which may not be | ||
| // returned on IPv6-only or custom resolver environments | ||
| IpAuthHandler handler = IpAuthHandler.getInstance( | ||
| Collections.singleton("localhost")); | ||
| InetAddress[] addresses = InetAddress.getAllByName("localhost"); | ||
| // All resolved addresses should be allowed — resolveAll() adds every address | ||
| // returned by getAllByName() so none should be blocked | ||
| Assert.assertTrue("Expected at least one resolved address", | ||
| addresses.length > 0); | ||
| for (InetAddress address : addresses) { | ||
| Assert.assertTrue( | ||
| "Expected " + address.getHostAddress() + " to be allowed", | ||
| isIpAllowed(handler, address.getHostAddress())); | ||
| } | ||
| } | ||
bitflicker64 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| @Test | ||
| public void testUnresolvableHostnameDoesNotCrash() { | ||
| // Should log a warning and skip — no exception thrown during construction | ||
| IpAuthHandler handler = IpAuthHandler.getInstance( | ||
| Collections.singleton("nonexistent.invalid.hostname")); | ||
| // Handler was still created successfully despite bad hostname | ||
| Assert.assertNotNull(handler); | ||
| // Unresolvable entry is skipped so no IPs should be allowed | ||
| Assert.assertFalse(isIpAllowed(handler, "127.0.0.1")); | ||
| Assert.assertFalse(isIpAllowed(handler, "192.168.0.1")); | ||
bitflicker64 marked this conversation as resolved.
Show resolved
Hide resolved
bitflicker64 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
|
|
||
| @Test | ||
| public void testRefreshUpdatesResolvedIps() { | ||
| // Start with 127.0.0.1 | ||
| IpAuthHandler handler = IpAuthHandler.getInstance( | ||
| Collections.singleton("127.0.0.1")); | ||
| Assert.assertTrue(isIpAllowed(handler, "127.0.0.1")); | ||
|
|
||
| // Refresh with a different IP — verifies refresh() swaps the set correctly | ||
| Set<String> newIps = new HashSet<>(); | ||
| newIps.add("192.168.0.1"); | ||
| handler.refresh(newIps); | ||
|
|
||
| // Old IP should no longer be allowed | ||
| Assert.assertFalse(isIpAllowed(handler, "127.0.0.1")); | ||
| // New IP should now be allowed | ||
| Assert.assertTrue(isIpAllowed(handler, "192.168.0.1")); | ||
| } | ||
|
|
||
| @Test | ||
| public void testEmptyAllowlistAllowsAll() { | ||
| // Empty allowlist = no restriction configured = allow all connections | ||
| // This is intentional fallback behavior and must be explicitly tested | ||
| // because it is a security-relevant boundary | ||
| IpAuthHandler handler = IpAuthHandler.getInstance( | ||
| Collections.emptySet()); | ||
| Assert.assertTrue(isIpAllowed(handler, "1.2.3.4")); | ||
| Assert.assertTrue(isIpAllowed(handler, "192.168.99.99")); | ||
| } | ||
|
|
||
| @Test | ||
| public void testGetInstanceReturnsSingletonIgnoresNewAllowlist() { | ||
| // First call creates the singleton with 127.0.0.1 | ||
| IpAuthHandler first = IpAuthHandler.getInstance( | ||
| Collections.singleton("127.0.0.1")); | ||
| // Second call with a different set must return the same instance | ||
| // and must NOT reinitialize or override the existing allowlist | ||
| IpAuthHandler second = IpAuthHandler.getInstance( | ||
| Collections.singleton("192.168.0.1")); | ||
| Assert.assertSame(first, second); | ||
| // Original allowlist still in effect | ||
| Assert.assertTrue(isIpAllowed(second, "127.0.0.1")); | ||
| // New set was ignored — 192.168.0.1 should not be allowed | ||
| Assert.assertFalse(isIpAllowed(second, "192.168.0.1")); | ||
| } | ||
bitflicker64 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.