Thomas Vachuska | 781d18b | 2014-10-27 10:31:25 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | 5ab426f | 2016-04-09 01:19:45 -0700 | [diff] [blame] | 2 | * Copyright 2014-present Open Networking Laboratory |
Thomas Vachuska | 781d18b | 2014-10-27 10:31:25 -0700 | [diff] [blame] | 3 | * |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
Thomas Vachuska | 781d18b | 2014-10-27 10:31:25 -0700 | [diff] [blame] | 7 | * |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
Thomas Vachuska | 781d18b | 2014-10-27 10:31:25 -0700 | [diff] [blame] | 15 | */ |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 16 | package org.onosproject.proxyarp; |
alshabib | c274c90 | 2014-10-03 14:58:27 -0700 | [diff] [blame] | 17 | |
alshabib | c274c90 | 2014-10-03 14:58:27 -0700 | [diff] [blame] | 18 | import org.apache.felix.scr.annotations.Activate; |
| 19 | import org.apache.felix.scr.annotations.Component; |
| 20 | import org.apache.felix.scr.annotations.Deactivate; |
Pavlin Radoslavov | 93b606b | 2015-02-25 17:28:39 -0800 | [diff] [blame] | 21 | import org.apache.felix.scr.annotations.Modified; |
| 22 | import org.apache.felix.scr.annotations.Property; |
alshabib | c274c90 | 2014-10-03 14:58:27 -0700 | [diff] [blame] | 23 | import org.apache.felix.scr.annotations.Reference; |
| 24 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 25 | import org.onlab.packet.Ethernet; |
Brian O'Connor | bc865f6 | 2015-10-08 21:39:53 -0700 | [diff] [blame] | 26 | import org.onlab.packet.ICMP6; |
| 27 | import org.onlab.packet.IPv6; |
Jian Li | d9b5f55 | 2016-03-11 18:15:31 -0800 | [diff] [blame] | 28 | import org.onlab.util.Tools; |
Thomas Vachuska | 6519e6f | 2015-03-11 02:29:31 -0700 | [diff] [blame] | 29 | import org.onosproject.cfg.ComponentConfigService; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 30 | import org.onosproject.core.ApplicationId; |
| 31 | import org.onosproject.core.CoreService; |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 32 | import org.onosproject.net.flow.DefaultTrafficSelector; |
| 33 | import org.onosproject.net.flow.TrafficSelector; |
Ayaka Koshibe | bfbe1d7 | 2015-03-16 16:51:41 -0700 | [diff] [blame] | 34 | import org.onosproject.net.packet.InboundPacket; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 35 | import org.onosproject.net.packet.PacketContext; |
| 36 | import org.onosproject.net.packet.PacketProcessor; |
| 37 | import org.onosproject.net.packet.PacketService; |
| 38 | import org.onosproject.net.proxyarp.ProxyArpService; |
Pavlin Radoslavov | 93b606b | 2015-02-25 17:28:39 -0800 | [diff] [blame] | 39 | import org.osgi.service.component.ComponentContext; |
alshabib | c274c90 | 2014-10-03 14:58:27 -0700 | [diff] [blame] | 40 | import org.slf4j.Logger; |
| 41 | |
Thomas Vachuska | 6519e6f | 2015-03-11 02:29:31 -0700 | [diff] [blame] | 42 | import java.util.Dictionary; |
| 43 | |
Aaron Kruglikov | 07a923d | 2015-07-03 13:30:57 -0700 | [diff] [blame] | 44 | import static org.onlab.packet.Ethernet.TYPE_ARP; |
| 45 | import static org.onlab.packet.Ethernet.TYPE_IPV6; |
| 46 | import static org.onlab.packet.ICMP6.NEIGHBOR_ADVERTISEMENT; |
| 47 | import static org.onlab.packet.ICMP6.NEIGHBOR_SOLICITATION; |
| 48 | import static org.onlab.packet.IPv6.PROTOCOL_ICMP6; |
| 49 | import static org.onosproject.net.packet.PacketPriority.CONTROL; |
alshabib | 78baaf2 | 2015-02-18 18:55:45 -0800 | [diff] [blame] | 50 | import static org.slf4j.LoggerFactory.getLogger; |
| 51 | |
alshabib | c274c90 | 2014-10-03 14:58:27 -0700 | [diff] [blame] | 52 | /** |
| 53 | * Sample reactive proxy arp application. |
| 54 | */ |
| 55 | @Component(immediate = true) |
| 56 | public class ProxyArp { |
| 57 | |
alshabib | c274c90 | 2014-10-03 14:58:27 -0700 | [diff] [blame] | 58 | private final Logger log = getLogger(getClass()); |
| 59 | |
| 60 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 61 | protected PacketService packetService; |
| 62 | |
| 63 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 64 | protected ProxyArpService proxyArpService; |
| 65 | |
| 66 | private ProxyArpProcessor processor = new ProxyArpProcessor(); |
| 67 | |
alshabib | 92c65ad | 2014-10-08 21:56:05 -0700 | [diff] [blame] | 68 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 69 | protected CoreService coreService; |
| 70 | |
Thomas Vachuska | 6519e6f | 2015-03-11 02:29:31 -0700 | [diff] [blame] | 71 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 72 | protected ComponentConfigService cfgService; |
| 73 | |
alshabib | c274c90 | 2014-10-03 14:58:27 -0700 | [diff] [blame] | 74 | private ApplicationId appId; |
| 75 | |
Pavlin Radoslavov | 93b606b | 2015-02-25 17:28:39 -0800 | [diff] [blame] | 76 | @Property(name = "ipv6NeighborDiscovery", boolValue = false, |
Thomas Vachuska | 6519e6f | 2015-03-11 02:29:31 -0700 | [diff] [blame] | 77 | label = "Enable IPv6 Neighbor Discovery; default is false") |
Ayaka Koshibe | bfbe1d7 | 2015-03-16 16:51:41 -0700 | [diff] [blame] | 78 | protected boolean ipv6NeighborDiscovery = false; |
Pavlin Radoslavov | 93b606b | 2015-02-25 17:28:39 -0800 | [diff] [blame] | 79 | |
alshabib | c274c90 | 2014-10-03 14:58:27 -0700 | [diff] [blame] | 80 | @Activate |
Pavlin Radoslavov | 93b606b | 2015-02-25 17:28:39 -0800 | [diff] [blame] | 81 | public void activate(ComponentContext context) { |
Thomas Vachuska | 6519e6f | 2015-03-11 02:29:31 -0700 | [diff] [blame] | 82 | cfgService.registerProperties(getClass()); |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 83 | appId = coreService.registerApplication("org.onosproject.proxyarp"); |
Pavlin Radoslavov | 93b606b | 2015-02-25 17:28:39 -0800 | [diff] [blame] | 84 | |
Brian O'Connor | 3b78326 | 2015-07-29 17:49:24 -0700 | [diff] [blame] | 85 | packetService.addProcessor(processor, PacketProcessor.director(1)); |
Charles M.C. Chan | e148de8 | 2015-05-06 12:38:21 +0800 | [diff] [blame] | 86 | readComponentConfiguration(context); |
Jonathan Hart | 39ee648 | 2015-08-31 16:00:19 +0200 | [diff] [blame] | 87 | requestPackets(); |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 88 | |
Charles M.C. Chan | e148de8 | 2015-05-06 12:38:21 +0800 | [diff] [blame] | 89 | log.info("Started with Application ID {}", appId.id()); |
| 90 | } |
| 91 | |
| 92 | @Deactivate |
| 93 | public void deactivate() { |
Charles M.C. Chan | e148de8 | 2015-05-06 12:38:21 +0800 | [diff] [blame] | 94 | cfgService.unregisterProperties(getClass(), false); |
Aaron Kruglikov | 07a923d | 2015-07-03 13:30:57 -0700 | [diff] [blame] | 95 | withdrawIntercepts(); |
Charles M.C. Chan | e148de8 | 2015-05-06 12:38:21 +0800 | [diff] [blame] | 96 | packetService.removeProcessor(processor); |
| 97 | processor = null; |
| 98 | log.info("Stopped"); |
| 99 | } |
| 100 | |
| 101 | @Modified |
| 102 | public void modified(ComponentContext context) { |
Charles M.C. Chan | e148de8 | 2015-05-06 12:38:21 +0800 | [diff] [blame] | 103 | readComponentConfiguration(context); |
Jonathan Hart | 39ee648 | 2015-08-31 16:00:19 +0200 | [diff] [blame] | 104 | requestPackets(); |
Charles M.C. Chan | e148de8 | 2015-05-06 12:38:21 +0800 | [diff] [blame] | 105 | } |
| 106 | |
| 107 | /** |
| 108 | * Request packet in via PacketService. |
| 109 | */ |
Jonathan Hart | 39ee648 | 2015-08-31 16:00:19 +0200 | [diff] [blame] | 110 | private void requestPackets() { |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 111 | TrafficSelector.Builder selectorBuilder = |
| 112 | DefaultTrafficSelector.builder(); |
Aaron Kruglikov | 07a923d | 2015-07-03 13:30:57 -0700 | [diff] [blame] | 113 | selectorBuilder.matchEthType(TYPE_ARP); |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 114 | packetService.requestPackets(selectorBuilder.build(), |
Aaron Kruglikov | 07a923d | 2015-07-03 13:30:57 -0700 | [diff] [blame] | 115 | CONTROL, appId); |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 116 | |
Aaron Kruglikov | 07a923d | 2015-07-03 13:30:57 -0700 | [diff] [blame] | 117 | selectorBuilder = DefaultTrafficSelector.builder(); |
| 118 | selectorBuilder.matchEthType(TYPE_IPV6); |
| 119 | selectorBuilder.matchIPProtocol(PROTOCOL_ICMP6); |
| 120 | selectorBuilder.matchIcmpv6Type(NEIGHBOR_SOLICITATION); |
Pavlin Radoslavov | 93b606b | 2015-02-25 17:28:39 -0800 | [diff] [blame] | 121 | if (ipv6NeighborDiscovery) { |
| 122 | // IPv6 Neighbor Solicitation packet. |
Pavlin Radoslavov | 93b606b | 2015-02-25 17:28:39 -0800 | [diff] [blame] | 123 | packetService.requestPackets(selectorBuilder.build(), |
Aaron Kruglikov | 07a923d | 2015-07-03 13:30:57 -0700 | [diff] [blame] | 124 | CONTROL, appId); |
| 125 | } else { |
| 126 | packetService.cancelPackets(selectorBuilder.build(), |
| 127 | CONTROL, appId); |
Pavlin Radoslavov | 93b606b | 2015-02-25 17:28:39 -0800 | [diff] [blame] | 128 | } |
Aaron Kruglikov | 07a923d | 2015-07-03 13:30:57 -0700 | [diff] [blame] | 129 | |
| 130 | // IPv6 Neighbor Advertisement packet. |
| 131 | selectorBuilder = DefaultTrafficSelector.builder(); |
| 132 | selectorBuilder.matchEthType(TYPE_IPV6); |
| 133 | selectorBuilder.matchIPProtocol(PROTOCOL_ICMP6); |
| 134 | selectorBuilder.matchIcmpv6Type(NEIGHBOR_ADVERTISEMENT); |
| 135 | if (ipv6NeighborDiscovery) { |
| 136 | packetService.requestPackets(selectorBuilder.build(), |
| 137 | CONTROL, appId); |
| 138 | } else { |
| 139 | packetService.cancelPackets(selectorBuilder.build(), |
| 140 | CONTROL, appId); |
| 141 | } |
| 142 | |
| 143 | |
| 144 | } |
| 145 | |
| 146 | /** |
| 147 | * Cancel requested packet in via packet service. |
| 148 | */ |
| 149 | private void withdrawIntercepts() { |
| 150 | TrafficSelector.Builder selectorBuilder = |
| 151 | DefaultTrafficSelector.builder(); |
| 152 | selectorBuilder.matchEthType(TYPE_ARP); |
| 153 | packetService.cancelPackets(selectorBuilder.build(), CONTROL, appId); |
| 154 | selectorBuilder = DefaultTrafficSelector.builder(); |
| 155 | selectorBuilder.matchEthType(TYPE_IPV6); |
| 156 | selectorBuilder.matchIPProtocol(PROTOCOL_ICMP6); |
| 157 | selectorBuilder.matchIcmpv6Type(NEIGHBOR_SOLICITATION); |
| 158 | packetService.cancelPackets(selectorBuilder.build(), CONTROL, appId); |
| 159 | selectorBuilder = DefaultTrafficSelector.builder(); |
| 160 | selectorBuilder.matchEthType(TYPE_IPV6); |
| 161 | selectorBuilder.matchIPProtocol(PROTOCOL_ICMP6); |
| 162 | selectorBuilder.matchIcmpv6Type(NEIGHBOR_ADVERTISEMENT); |
| 163 | packetService.cancelPackets(selectorBuilder.build(), CONTROL, appId); |
| 164 | |
Pavlin Radoslavov | 93b606b | 2015-02-25 17:28:39 -0800 | [diff] [blame] | 165 | } |
| 166 | |
| 167 | /** |
| 168 | * Extracts properties from the component configuration context. |
| 169 | * |
| 170 | * @param context the component context |
| 171 | */ |
| 172 | private void readComponentConfiguration(ComponentContext context) { |
| 173 | Dictionary<?, ?> properties = context.getProperties(); |
| 174 | Boolean flag; |
| 175 | |
Jian Li | d9b5f55 | 2016-03-11 18:15:31 -0800 | [diff] [blame] | 176 | flag = Tools.isPropertyEnabled(properties, "ipv6NeighborDiscovery"); |
Pavlin Radoslavov | 93b606b | 2015-02-25 17:28:39 -0800 | [diff] [blame] | 177 | if (flag == null) { |
| 178 | log.info("IPv6 Neighbor Discovery is not configured, " + |
Thomas Vachuska | 6519e6f | 2015-03-11 02:29:31 -0700 | [diff] [blame] | 179 | "using current value of {}", ipv6NeighborDiscovery); |
Pavlin Radoslavov | 93b606b | 2015-02-25 17:28:39 -0800 | [diff] [blame] | 180 | } else { |
| 181 | ipv6NeighborDiscovery = flag; |
| 182 | log.info("Configured. IPv6 Neighbor Discovery is {}", |
| 183 | ipv6NeighborDiscovery ? "enabled" : "disabled"); |
| 184 | } |
| 185 | } |
| 186 | |
| 187 | /** |
alshabib | c274c90 | 2014-10-03 14:58:27 -0700 | [diff] [blame] | 188 | * Packet processor responsible for forwarding packets along their paths. |
| 189 | */ |
| 190 | private class ProxyArpProcessor implements PacketProcessor { |
| 191 | |
| 192 | @Override |
| 193 | public void process(PacketContext context) { |
| 194 | // Stop processing if the packet has been handled, since we |
| 195 | // can't do any more to it. |
| 196 | if (context.isHandled()) { |
| 197 | return; |
| 198 | } |
Brian O'Connor | bc865f6 | 2015-10-08 21:39:53 -0700 | [diff] [blame] | 199 | |
Ayaka Koshibe | bfbe1d7 | 2015-03-16 16:51:41 -0700 | [diff] [blame] | 200 | InboundPacket pkt = context.inPacket(); |
| 201 | Ethernet ethPkt = pkt.parsed(); |
| 202 | if (ethPkt == null) { |
| 203 | return; |
| 204 | } |
Brian O'Connor | bc865f6 | 2015-10-08 21:39:53 -0700 | [diff] [blame] | 205 | |
| 206 | if (ethPkt.getEtherType() == TYPE_ARP) { |
| 207 | //handle the arp packet. |
| 208 | proxyArpService.handlePacket(context); |
| 209 | } else if (ipv6NeighborDiscovery && ethPkt.getEtherType() == TYPE_IPV6) { |
| 210 | IPv6 ipv6Pkt = (IPv6) ethPkt.getPayload(); |
| 211 | if (ipv6Pkt.getNextHeader() == IPv6.PROTOCOL_ICMP6) { |
| 212 | ICMP6 icmp6Pkt = (ICMP6) ipv6Pkt.getPayload(); |
| 213 | if (icmp6Pkt.getIcmpType() == NEIGHBOR_SOLICITATION || |
| 214 | icmp6Pkt.getIcmpType() == NEIGHBOR_ADVERTISEMENT) { |
| 215 | // handle ICMPv6 solicitations and advertisements |
| 216 | proxyArpService.handlePacket(context); |
| 217 | } |
| 218 | } |
Ayaka Koshibe | bfbe1d7 | 2015-03-16 16:51:41 -0700 | [diff] [blame] | 219 | } |
Rusty Eddy | 29acad6 | 2015-07-07 19:33:47 -0700 | [diff] [blame] | 220 | |
Brian O'Connor | bc865f6 | 2015-10-08 21:39:53 -0700 | [diff] [blame] | 221 | // FIXME why were we listening to IPv4 frames at all? |
Rusty Eddy | 29acad6 | 2015-07-07 19:33:47 -0700 | [diff] [blame] | 222 | // Do not ARP for multicast packets. Let mfwd handle them. |
| 223 | if (ethPkt.getEtherType() == Ethernet.TYPE_IPV4) { |
| 224 | if (ethPkt.getDestinationMAC().isMulticast()) { |
| 225 | return; |
| 226 | } |
| 227 | } |
alshabib | c274c90 | 2014-10-03 14:58:27 -0700 | [diff] [blame] | 228 | } |
| 229 | } |
| 230 | } |