This repository has been archived by the owner on Sep 26, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 130
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Validate enodeurl syntax from command line (#403)
* Creating EnodeURLProperty and custom converter * Replacing String for URI when parsing EnodeURL * Fixing acceptance test bootnode config * Removing invalid empty bootnode property from docker script * Validating nodeId in Enode URL * Adding final to method param
- Loading branch information
1 parent
7120c77
commit a4c50e5
Showing
13 changed files
with
389 additions
and
33 deletions.
There are no files selected for viewing
This file contains 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 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 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 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 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 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 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
110 changes: 110 additions & 0 deletions
110
pantheon/src/main/java/tech/pegasys/pantheon/cli/custom/EnodeToURIPropertyConverter.java
This file contains 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,110 @@ | ||
| /* | ||
| * Copyright 2018 ConsenSys AG. | ||
| * | ||
| * Licensed 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 tech.pegasys.pantheon.cli.custom; | ||
|
|
||
| import static com.google.common.base.Preconditions.checkArgument; | ||
|
|
||
| import tech.pegasys.pantheon.util.NetworkUtility; | ||
|
|
||
| import java.net.URI; | ||
| import java.util.regex.Matcher; | ||
| import java.util.regex.Pattern; | ||
|
|
||
| import picocli.CommandLine.ITypeConverter; | ||
|
|
||
| public class EnodeToURIPropertyConverter implements ITypeConverter<URI> { | ||
|
|
||
| private static final String IP_REPLACE_MARKER = "$$IP_PATTERN$$"; | ||
| private static final String IPV4_PATTERN = | ||
| "(25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(\\.(25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}"; | ||
| private static final String IPV6_PATTERN = "(?:[0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}"; | ||
| private static final String IPV6_COMPACT_PATTERN = | ||
| "((?:[0-9A-Fa-f]{1,4}(?::[0-9A-Fa-f]{1,4})*)?)::((?:[0-9A-Fa-f]{1,4}(?::[0-9A-Fa-f]{1,4})*)?)"; | ||
| private static final String DISCOVERY_PORT_PATTERN = "\\?discport=(?<discovery>\\d+)"; | ||
| private static final String HEX_STRING_PATTERN = "[0-9a-fA-F]+"; | ||
|
|
||
| private static final String ENODE_URL_PATTERN = | ||
| "enode://(?<nodeId>\\w+)@(?<ip>" + IP_REPLACE_MARKER + "):(?<listening>\\d+)"; | ||
|
|
||
| @Override | ||
| public URI convert(final String value) throws IllegalArgumentException { | ||
| checkArgument( | ||
| value != null && !value.isEmpty(), "Can't convert null/empty string to EnodeURLProperty."); | ||
|
|
||
| final boolean containsDiscoveryPort = value.contains("discport"); | ||
| final boolean isIPV4 = Pattern.compile(".*" + IPV4_PATTERN + ".*").matcher(value).matches(); | ||
| final boolean isIPV6 = Pattern.compile(".*" + IPV6_PATTERN + ".*").matcher(value).matches(); | ||
| final boolean isIPV6Compact = | ||
| Pattern.compile(".*" + IPV6_COMPACT_PATTERN + ".*").matcher(value).matches(); | ||
|
|
||
| String pattern = ENODE_URL_PATTERN; | ||
| if (isIPV4) { | ||
| pattern = pattern.replace(IP_REPLACE_MARKER, IPV4_PATTERN); | ||
| } else if (isIPV6) { | ||
| pattern = pattern.replace(IP_REPLACE_MARKER, IPV6_PATTERN); | ||
| } else if (isIPV6Compact) { | ||
| pattern = pattern.replace(IP_REPLACE_MARKER, IPV6_COMPACT_PATTERN); | ||
| } else { | ||
| throw new IllegalArgumentException("Invalid enode URL IP format."); | ||
| } | ||
|
|
||
| if (containsDiscoveryPort) { | ||
| pattern += DISCOVERY_PORT_PATTERN; | ||
| } | ||
| if (isIPV6) { | ||
| pattern = pattern.replace(IP_REPLACE_MARKER, IPV6_PATTERN); | ||
| } else { | ||
| pattern = pattern.replace(IP_REPLACE_MARKER, IPV4_PATTERN); | ||
| } | ||
|
|
||
| final Matcher matcher = Pattern.compile(pattern).matcher(value); | ||
| checkArgument( | ||
| matcher.matches(), | ||
| "Invalid enode URL syntax. Enode URL should have the following format 'enode://<node_id>@<ip>:<listening_port>[?discport=<discovery_port>]'."); | ||
|
|
||
| final String nodeId = getAndValidateNodeId(matcher); | ||
| final String ip = matcher.group("ip"); | ||
| final Integer listeningPort = getAndValidatePort(matcher, "listening"); | ||
|
|
||
| if (containsDiscoveryPort(value)) { | ||
| final Integer discoveryPort = getAndValidatePort(matcher, "discovery"); | ||
| return URI.create( | ||
| String.format("enode://%s@%s:%d?discport=%d", nodeId, ip, listeningPort, discoveryPort)); | ||
| } else { | ||
| return URI.create(String.format("enode://%s@%s:%d", nodeId, ip, listeningPort)); | ||
| } | ||
| } | ||
|
|
||
| private String getAndValidateNodeId(final Matcher matcher) { | ||
| final String invalidNodeIdErrorMsg = | ||
| "Enode URL contains an invalid node ID. Node ID must have 128 characters and shouldn't include the '0x' hex prefix."; | ||
| final String nodeId = matcher.group("nodeId"); | ||
|
|
||
| checkArgument(nodeId.matches(HEX_STRING_PATTERN), invalidNodeIdErrorMsg); | ||
| checkArgument(nodeId.length() == 128, invalidNodeIdErrorMsg); | ||
|
|
||
| return nodeId; | ||
| } | ||
|
|
||
| private Integer getAndValidatePort(final Matcher matcher, final String portName) { | ||
| int port = Integer.valueOf(matcher.group(portName)); | ||
| checkArgument( | ||
| NetworkUtility.isValidPort(port), | ||
| "Invalid " + portName + " port range. Port should be between 0 - 65535"); | ||
| return port; | ||
| } | ||
|
|
||
| private boolean containsDiscoveryPort(final String value) { | ||
| return value.contains("discport"); | ||
| } | ||
| } |
This file contains 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
Oops, something went wrong.