Skip to content

Add toString() to IpAddressMatcher.java #16804

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

Closed
wants to merge 1 commit into from
Closed

Add toString() to IpAddressMatcher.java #16804

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: 7 additions & 0 deletions web/src/main/java/org/springframework/security/web/util/matcher/IpAddressMatcher.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,4 +130,11 @@ private InetAddress parseAddress(String address) {
}
}

@Override
public String toString() {
String hostAddress = this.requiredAddress.getHostAddress();
return (this.nMaskBits < 0)
? "IpAddressMatcher[" + hostAddress + "]"
: "IpAddressMatcher[" + hostAddress + "/" + this.nMaskBits + "]";
}
}
19 changes: 19 additions & 0 deletions web/src/test/java/org/springframework/security/web/util/matcher/IpAddressMatcherTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,5 +152,24 @@ public void constructorWhenRequiredAddressIsEmptyThenThrowsIllegalArgumentExcept
assertThatIllegalArgumentException().isThrownBy(() -> new IpAddressMatcher(""))
.withMessage("ipAddress cannot be empty");
}
// gh-16795
@Test
public void toStringWhenCidrIsProvidedThenReturnsIpAddressWithCidr() {
IpAddressMatcher matcher = new IpAddressMatcher("192.168.1.0/24");

String result = matcher.toString();

assertThat(result).isEqualTo("IpAddressMatcher[192.168.1.0/24]");
}

// gh-16795
@Test
public void toStringWhenOnlyIpIsProvidedThenReturnsIpAddressOnly() {
IpAddressMatcher matcher = new IpAddressMatcher("127.0.0.1");

String result = matcher.toString();

assertThat(result).isEqualTo("IpAddressMatcher[127.0.0.1]");
}

}