2 * Copyright (c) 2016 Pantheon Technologies s.r.o. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.mdsal.model.ietf.util;
10 import com.google.common.base.Preconditions;
11 import com.google.common.net.InetAddresses;
12 import java.net.Inet4Address;
13 import java.net.InetAddress;
16 * IPv6 address parsing for ietf-inet-types ipv6-address and ipv6-prefix. This is an internal implementation
17 * class, not meant to be exposed in any shape or form to the outside world, as the code relies on the fact that
18 * the strings presented to it have been previously validated to conform to the regular expressions defined in
22 * v6 routines added by Anton Ivanov on 14.6.2015
23 * revised by Robert Varga
26 * Read all of the following before you touch any v6 code or decide to
27 * optimize it by invoking a "simple" Guava call
29 * Java IPv6 is fundamentally broken and Google libraries do not fix it.
30 * 1. Java will allways implicitly rewrite v4 mapped into v6 as a v4 address
31 * and there is absolutely no way to override this behaviour
32 * 2. Guava libraries cannot parse non-canonical IPv6. They will throw an
33 * exception. Even if they did, they re-use the same broken java code
36 * This is why we have to parse v6 by ourselves.
38 * The following conversion code is based on inet_cidr_pton_ipv6 in NetBSD
40 * The original BSD code is licensed under standard BSD license. While we
41 * are not obliged to provide an attribution, credit where credit is due.
42 * As far as why it is similar to Sun's sun.net.util please ask Sun why
43 * their code has the same variable names, comments and code flow.
45 final class Ipv6Utils {
46 private static final int INADDR4SZ = 4;
47 private static final int INADDR6SZ = 16;
48 private static final int INT16SZ = Short.BYTES;
51 throw new UnsupportedOperationException();
55 * Convert Ipv6Address object to a valid Canonical v6 address in byte format
57 * @param ipv6Address - v6 Address object
59 * FIXME: rovarga: this looks wrong
60 * @return - byte array of size 16. Last byte contains netmask
62 public static byte[] bytesForString(final String ipv6Address) {
64 * Do not modify this routine to take direct strings input!!!
65 * Key checks have been removed based on the assumption that
66 * the input is validated via regexps in Ipv6Prefix()
69 String [] address = (ipv6Address).split("%");
75 /* Isn't it fun - the above variable names are the same in BSD and Sun sources */
79 char[] src = address[0].toCharArray();
81 byte[] dst = new byte[INADDR6SZ];
83 int src_length = src.length;
88 /* Leading :: requires some special handling. */
90 /* Isn't it fun - the above comment is again the same in BSD and Sun sources,
91 * We will derive our code from BSD. Shakespear always sounds better
92 * in original Clingon. So does Dilbert.
96 Preconditions.checkArgument(src[++i] == ':', "Invalid v6 address");
104 while (i < src_length) {
106 int chval = Character.digit(ch, 16);
108 /* Business as usual - ipv6 address digit.
109 * We can remove all checks from the original BSD code because
110 * the regexp has already verified that we are not being fed
111 * anything bigger than 0xffff between the separators.
126 /* no need to check separator position validity - regexp does that */
131 /* removed overrun check - the regexp checks for valid data */
133 dst[j++] = (byte) ((val >>> 8) & 0xff);
134 dst[j++] = (byte) (val & 0xff);
140 /* frankenstein - v4 attached to v6, mixed notation */
142 if (ch == '.' && ((j + INADDR4SZ) <= INADDR6SZ)) {
144 /* this has passed the regexp so it is fairly safe to parse it
145 * straight away. As v4 addresses do not suffer from the same
146 * defficiencies as the java v6 implementation we can invoke it
147 * straight away and be done with it
150 Preconditions.checkArgument(j != (INADDR6SZ - INADDR4SZ - 1), "Invalid v4 in v6 mapping");
152 InetAddress _inet_form = InetAddresses.forString(address[0].substring(curtok, src_length));
154 Preconditions.checkArgument(_inet_form instanceof Inet4Address);
155 System.arraycopy(_inet_form.getAddress(), 0, dst, j, INADDR4SZ);
161 /* removed parser exit on invalid char - no need to do it, regexp checks it */
164 Preconditions.checkArgument(j + INT16SZ <= INADDR6SZ, "Overrun in v6 parsing, should not occur");
165 dst[j++] = (byte) ((val >> 8) & 0xff);
166 dst[j++] = (byte) (val & 0xff);
172 Preconditions.checkArgument(j != INADDR6SZ, "Overrun in v6 parsing, should not occur");
173 for (i = 1; i <= n; i++) {
174 dst[INADDR6SZ - i] = dst[colonp + n - i];
175 dst[colonp + n - i] = 0;
180 Preconditions.checkArgument(j == INADDR6SZ, "Overrun in v6 parsing, should not occur");