1 /*
2 * ====================================================================
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements. See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership. The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License. You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied. See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 * ====================================================================
20 *
21 * This software consists of voluntary contributions made by many
22 * individuals on behalf of the Apache Software Foundation. For more
23 * information on the Apache Software Foundation, please see
24 * <http://www.apache.org/>.
25 *
26 */
27
28 package org.apache.http.conn.util;
29
30 import java.util.regex.Pattern;
31
32 /**
33 * A collection of utilities relating to InetAddresses.
34 *
35 * @since 4.0
36 */
37 public class InetAddressUtils {
38
39 private InetAddressUtils() {
40 }
41
42 private static final String IPV4_BASIC_PATTERN_STRING =
43 "(([1-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){1}" + // initial first field, 1-255
44 "(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){2}" + // following 2 fields, 0-255 followed by .
45 "([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])"; // final field, 0-255
46
47 private static final Pattern IPV4_PATTERN =
48 Pattern.compile("^" + IPV4_BASIC_PATTERN_STRING + "$");
49
50 private static final Pattern IPV4_MAPPED_IPV6_PATTERN = // TODO does not allow for redundant leading zeros
51 Pattern.compile("^::[fF]{4}:" + IPV4_BASIC_PATTERN_STRING + "$");
52
53 private static final Pattern IPV6_STD_PATTERN =
54 Pattern.compile(
55 "^[0-9a-fA-F]{1,4}(:[0-9a-fA-F]{1,4}){7}$");
56
57 private static final Pattern IPV6_HEX_COMPRESSED_PATTERN =
58 Pattern.compile(
59 "^(([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?)" + // 0-6 hex fields
60 "::" +
61 "(([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?)$"); // 0-6 hex fields
62
63 /*
64 * The above pattern is not totally rigorous as it allows for more than 7 hex fields in total
65 */
66 private static final char COLON_CHAR = ':';
67
68 // Must not have more than 7 colons (i.e. 8 fields)
69 private static final int MAX_COLON_COUNT = 7;
70
71 /**
72 * Checks whether the parameter is a valid IPv4 address
73 *
74 * @param input the address string to check for validity
75 * @return true if the input parameter is a valid IPv4 address
76 */
77 public static boolean isIPv4Address(final String input) {
78 return IPV4_PATTERN.matcher(input).matches();
79 }
80
81 public static boolean isIPv4MappedIPv64Address(final String input) {
82 return IPV4_MAPPED_IPV6_PATTERN.matcher(input).matches();
83 }
84
85 /**
86 * Checks whether the parameter is a valid standard (non-compressed) IPv6 address
87 *
88 * @param input the address string to check for validity
89 * @return true if the input parameter is a valid standard (non-compressed) IPv6 address
90 */
91 public static boolean isIPv6StdAddress(final String input) {
92 return IPV6_STD_PATTERN.matcher(input).matches();
93 }
94
95 /**
96 * Checks whether the parameter is a valid compressed IPv6 address
97 *
98 * @param input the address string to check for validity
99 * @return true if the input parameter is a valid compressed IPv6 address
100 */
101 public static boolean isIPv6HexCompressedAddress(final String input) {
102 int colonCount = 0;
103 for(int i = 0; i < input.length(); i++) {
104 if (input.charAt(i) == COLON_CHAR) {
105 colonCount++;
106 }
107 }
108 return colonCount <= MAX_COLON_COUNT && IPV6_HEX_COMPRESSED_PATTERN.matcher(input).matches();
109 }
110
111 /**
112 * Checks whether the parameter is a valid IPv6 address (including compressed).
113 *
114 * @param input the address string to check for validity
115 * @return true if the input parameter is a valid standard or compressed IPv6 address
116 */
117 public static boolean isIPv6Address(final String input) {
118 return isIPv6StdAddress(input) || isIPv6HexCompressedAddress(input);
119 }
120
121 }