| /* |
| * Copyright 2015-present Open Networking Foundation |
| * |
| * 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 org.onlab.packet.ndp; |
| |
| import org.onlab.packet.BasePacket; |
| import org.onlab.packet.Deserializer; |
| import org.onlab.packet.Ethernet; |
| import org.onlab.packet.ICMP6; |
| import org.onlab.packet.IPv6; |
| import org.onlab.packet.Ip6Address; |
| import org.onlab.packet.MacAddress; |
| import org.onlab.packet.VlanId; |
| |
| import java.nio.ByteBuffer; |
| import java.util.Arrays; |
| import java.util.List; |
| |
| import static com.google.common.base.MoreObjects.toStringHelper; |
| import static com.google.common.base.Preconditions.checkNotNull; |
| import static org.onlab.packet.PacketUtils.checkInput; |
| |
| /** |
| * Implements ICMPv6 Neighbor Solicitation packet format. (RFC 4861) |
| */ |
| public class NeighborSolicitation extends BasePacket { |
| public static final byte HEADER_LENGTH = 20; // bytes |
| // Constants for NDP reply |
| protected static final byte NDP_HOP_LIMIT = (byte) 255; |
| protected static final byte RESERVED_CODE = (byte) 0x0; |
| |
| protected byte[] targetAddress = new byte[Ip6Address.BYTE_LENGTH]; |
| |
| private final NeighborDiscoveryOptions options = |
| new NeighborDiscoveryOptions(); |
| |
| /** |
| * Gets target address. |
| * |
| * @return the target IPv6 address |
| */ |
| public byte[] getTargetAddress() { |
| return this.targetAddress; |
| } |
| |
| /** |
| * Sets target address. |
| * |
| * @param targetAddress the target IPv6 address to set |
| * @return this |
| */ |
| public NeighborSolicitation setTargetAddress(final byte[] targetAddress) { |
| this.targetAddress = |
| Arrays.copyOfRange(targetAddress, 0, Ip6Address.BYTE_LENGTH); |
| return this; |
| } |
| |
| /** |
| * Gets the Neighbor Discovery Protocol packet options. |
| * |
| * @return the Neighbor Discovery Protocol packet options |
| */ |
| public List<NeighborDiscoveryOptions.Option> getOptions() { |
| return this.options.options(); |
| } |
| |
| /** |
| * Adds a Neighbor Discovery Protocol packet option. |
| * |
| * @param type the option type |
| * @param data the option data |
| * @return this |
| */ |
| public NeighborSolicitation addOption(final byte type, |
| final byte[] data) { |
| this.options.addOption(type, data); |
| return this; |
| } |
| |
| @Override |
| public byte[] serialize() { |
| byte[] optionsData = null; |
| if (this.options.hasOptions()) { |
| optionsData = this.options.serialize(); |
| } |
| |
| int optionsLength = 0; |
| if (optionsData != null) { |
| optionsLength = optionsData.length; |
| } |
| |
| final byte[] data = new byte[HEADER_LENGTH + optionsLength]; |
| final ByteBuffer bb = ByteBuffer.wrap(data); |
| |
| bb.putInt(0); |
| bb.put(this.targetAddress, 0, Ip6Address.BYTE_LENGTH); |
| if (optionsData != null) { |
| bb.put(optionsData); |
| } |
| |
| return data; |
| } |
| |
| |
| |
| /* |
| * (non-Javadoc) |
| * |
| * @see java.lang.Object#hashCode() |
| */ |
| @Override |
| public int hashCode() { |
| final int prime = 5807; |
| int result = super.hashCode(); |
| ByteBuffer bb; |
| bb = ByteBuffer.wrap(this.targetAddress); |
| for (int i = 0; i < this.targetAddress.length / 4; i++) { |
| result = prime * result + bb.getInt(); |
| } |
| result = prime * result + this.options.hashCode(); |
| return result; |
| } |
| |
| /* |
| * (non-Javadoc) |
| * |
| * @see java.lang.Object#equals(java.lang.Object) |
| */ |
| @Override |
| public boolean equals(final Object obj) { |
| if (this == obj) { |
| return true; |
| } |
| if (!super.equals(obj)) { |
| return false; |
| } |
| if (!(obj instanceof NeighborSolicitation)) { |
| return false; |
| } |
| final NeighborSolicitation other = (NeighborSolicitation) obj; |
| if (!Arrays.equals(this.targetAddress, other.targetAddress)) { |
| return false; |
| } |
| if (!this.options.equals(other.options)) { |
| return false; |
| } |
| return true; |
| } |
| |
| /** |
| * Deserializer function for neighbor solicitation packets. |
| * |
| * @return deserializer function |
| */ |
| public static Deserializer<NeighborSolicitation> deserializer() { |
| return (data, offset, length) -> { |
| checkInput(data, offset, length, HEADER_LENGTH); |
| |
| NeighborSolicitation neighborSolicitation = new NeighborSolicitation(); |
| |
| ByteBuffer bb = ByteBuffer.wrap(data, offset, length); |
| |
| bb.getInt(); |
| bb.get(neighborSolicitation.targetAddress, 0, Ip6Address.BYTE_LENGTH); |
| |
| if (bb.limit() - bb.position() > 0) { |
| NeighborDiscoveryOptions options = NeighborDiscoveryOptions.deserializer() |
| .deserialize(data, bb.position(), bb.limit() - bb.position()); |
| |
| for (NeighborDiscoveryOptions.Option option : options.options()) { |
| neighborSolicitation.addOption(option.type(), option.data()); |
| } |
| } |
| |
| return neighborSolicitation; |
| }; |
| } |
| |
| @Override |
| public String toString() { |
| return toStringHelper(getClass()) |
| .add("targetAddress", Arrays.toString(targetAddress)) |
| .toString(); |
| // TODO: need to handle options |
| } |
| |
| /** |
| * Builds a NDP solicitation using the supplied parameters. |
| * |
| * @param targetIp the target ip |
| * @param sourceIp the source ip |
| * @param destinationIp the destination ip |
| * @param sourceMac the source mac address |
| * @param destinationMac the destination mac address |
| * @param vlan the vlan id |
| * @return the ethernet packet containing the ndp solicitation |
| */ |
| public static Ethernet buildNdpSolicit(Ip6Address targetIp, |
| Ip6Address sourceIp, |
| Ip6Address destinationIp, |
| MacAddress sourceMac, |
| MacAddress destinationMac, |
| VlanId vlan) { |
| |
| checkNotNull(targetIp, "Target IP address cannot be null"); |
| checkNotNull(sourceIp, "Source IP address cannot be null"); |
| checkNotNull(destinationIp, "Destination IP address cannot be null"); |
| checkNotNull(sourceMac, "Source MAC address cannot be null"); |
| checkNotNull(destinationMac, "Destination MAC address cannot be null"); |
| checkNotNull(vlan, "Vlan cannot be null"); |
| |
| // Here we craft the Ethernet packet. |
| Ethernet ethernet = new Ethernet(); |
| ethernet.setEtherType(Ethernet.TYPE_IPV6) |
| .setDestinationMACAddress(destinationMac) |
| .setSourceMACAddress(sourceMac); |
| ethernet.setVlanID(vlan.id()); |
| // IPv6 packet is created. |
| IPv6 ipv6 = new IPv6(); |
| ipv6.setSourceAddress(sourceIp.toOctets()); |
| ipv6.setDestinationAddress(destinationIp.toOctets()); |
| ipv6.setHopLimit(NDP_HOP_LIMIT); |
| // Create the ICMPv6 packet. |
| ICMP6 icmp6 = new ICMP6(); |
| icmp6.setIcmpType(ICMP6.NEIGHBOR_SOLICITATION); |
| icmp6.setIcmpCode(RESERVED_CODE); |
| // Create the Neighbor Solicitation packet. |
| NeighborSolicitation ns = new NeighborSolicitation(); |
| ns.setTargetAddress(targetIp.toOctets()); |
| // DAD packets should not contain SRC_LL_ADDR option |
| if (!Arrays.equals(sourceIp.toOctets(), Ip6Address.ZERO.toOctets())) { |
| ns.addOption(NeighborDiscoveryOptions.TYPE_SOURCE_LL_ADDRESS, sourceMac.toBytes()); |
| } |
| // Set the payloads |
| icmp6.setPayload(ns); |
| ipv6.setPayload(icmp6); |
| ethernet.setPayload(ipv6); |
| |
| return ethernet; |
| } |
| } |