| /* |
| * Copyright 2017-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.onosproject.dhcprelay; |
| |
| import com.google.common.base.MoreObjects; |
| import com.google.common.collect.Sets; |
| import org.apache.felix.scr.annotations.Activate; |
| import org.apache.felix.scr.annotations.Component; |
| import org.apache.felix.scr.annotations.Deactivate; |
| import org.apache.felix.scr.annotations.Property; |
| import org.apache.felix.scr.annotations.Reference; |
| import org.apache.felix.scr.annotations.ReferenceCardinality; |
| import org.apache.felix.scr.annotations.Service; |
| import org.onlab.packet.BasePacket; |
| import org.onlab.packet.DHCP; |
| import org.onlab.packet.Ethernet; |
| import org.onlab.packet.IPv4; |
| import org.onlab.packet.Ip4Address; |
| import org.onlab.packet.IpAddress; |
| import org.onlab.packet.MacAddress; |
| import org.onlab.packet.UDP; |
| import org.onlab.packet.VlanId; |
| import org.onlab.packet.dhcp.CircuitId; |
| import org.onlab.packet.dhcp.DhcpOption; |
| import org.onlab.packet.dhcp.DhcpRelayAgentOption; |
| import org.onosproject.dhcprelay.api.DhcpHandler; |
| import org.onosproject.dhcprelay.config.DhcpServerConfig; |
| import org.onosproject.dhcprelay.store.DhcpRecord; |
| import org.onosproject.dhcprelay.store.DhcpRelayStore; |
| import org.onosproject.net.host.HostEvent; |
| import org.onosproject.net.host.HostListener; |
| import org.onosproject.net.host.HostProvider; |
| import org.onosproject.net.host.HostProviderRegistry; |
| import org.onosproject.net.host.HostProviderService; |
| import org.onosproject.net.intf.Interface; |
| import org.onosproject.net.intf.InterfaceService; |
| import org.onosproject.net.provider.ProviderId; |
| import org.onosproject.routeservice.Route; |
| import org.onosproject.routeservice.RouteStore; |
| import org.onosproject.net.ConnectPoint; |
| import org.onosproject.net.Host; |
| import org.onosproject.net.HostId; |
| import org.onosproject.net.HostLocation; |
| import org.onosproject.net.flow.DefaultTrafficTreatment; |
| import org.onosproject.net.flow.TrafficTreatment; |
| import org.onosproject.net.host.DefaultHostDescription; |
| import org.onosproject.net.host.HostDescription; |
| import org.onosproject.net.host.HostService; |
| import org.onosproject.net.host.InterfaceIpAddress; |
| import org.onosproject.net.packet.DefaultOutboundPacket; |
| import org.onosproject.net.packet.OutboundPacket; |
| import org.onosproject.net.packet.PacketContext; |
| import org.onosproject.net.packet.PacketService; |
| import org.slf4j.Logger; |
| import org.slf4j.LoggerFactory; |
| |
| import java.nio.ByteBuffer; |
| import java.util.Collection; |
| import java.util.Collections; |
| import java.util.List; |
| import java.util.Optional; |
| import java.util.Set; |
| import java.util.stream.Collectors; |
| |
| import static com.google.common.base.Preconditions.checkNotNull; |
| import static com.google.common.base.Preconditions.checkState; |
| import static org.onlab.packet.DHCP.DHCPOptionCode.OptionCode_CircuitID; |
| import static org.onlab.packet.DHCP.DHCPOptionCode.OptionCode_END; |
| import static org.onlab.packet.DHCP.DHCPOptionCode.OptionCode_MessageType; |
| import static org.onlab.packet.MacAddress.valueOf; |
| import static org.onlab.packet.dhcp.DhcpRelayAgentOption.RelayAgentInfoOptions.CIRCUIT_ID; |
| |
| @Component |
| @Service |
| @Property(name = "version", value = "4") |
| public class Dhcp4HandlerImpl implements DhcpHandler, HostProvider { |
| public static final String DHCP_V4_RELAY_APP = "org.onosproject.Dhcp4HandlerImpl"; |
| public static final ProviderId PROVIDER_ID = new ProviderId("dhcp4", DHCP_V4_RELAY_APP); |
| private static Logger log = LoggerFactory.getLogger(Dhcp4HandlerImpl.class); |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| protected DhcpRelayStore dhcpRelayStore; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| protected PacketService packetService; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| protected RouteStore routeStore; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| protected InterfaceService interfaceService; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| protected HostService hostService; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| protected HostProviderRegistry providerRegistry; |
| |
| protected HostProviderService providerService; |
| private InternalHostListener hostListener = new InternalHostListener(); |
| |
| private Ip4Address dhcpServerIp = null; |
| // dhcp server may be connected directly to the SDN network or |
| // via an external gateway. When connected directly, the dhcpConnectPoint, dhcpConnectMac, |
| // and dhcpConnectVlan refer to the server. When connected via the gateway, they refer |
| // to the gateway. |
| private ConnectPoint dhcpServerConnectPoint = null; |
| private MacAddress dhcpConnectMac = null; |
| private VlanId dhcpConnectVlan = null; |
| private Ip4Address dhcpGatewayIp = null; |
| private Ip4Address relayAgentIp = null; |
| |
| // Indirect case DHCP server |
| private Ip4Address indirectDhcpServerIp = null; |
| private ConnectPoint indirectDhcpServerConnectPoint = null; |
| private MacAddress indirectDhcpConnectMac = null; |
| private VlanId indirectDhcpConnectVlan = null; |
| private Ip4Address indirectDhcpGatewayIp = null; |
| private Ip4Address indirectRelayAgentIp = null; |
| |
| @Activate |
| protected void activate() { |
| hostService.addListener(hostListener); |
| providerService = providerRegistry.register(this); |
| } |
| |
| @Deactivate |
| protected void deactivate() { |
| providerRegistry.unregister(this); |
| hostService.removeListener(hostListener); |
| this.dhcpConnectMac = null; |
| this.dhcpConnectVlan = null; |
| |
| if (dhcpGatewayIp != null) { |
| hostService.stopMonitoringIp(dhcpGatewayIp); |
| } |
| if (dhcpServerIp != null) { |
| hostService.stopMonitoringIp(dhcpServerIp); |
| } |
| |
| if (indirectDhcpGatewayIp != null) { |
| hostService.stopMonitoringIp(indirectDhcpGatewayIp); |
| } |
| if (indirectDhcpServerIp != null) { |
| hostService.stopMonitoringIp(indirectDhcpServerIp); |
| } |
| |
| hostService.removeListener(hostListener); |
| this.dhcpConnectMac = null; |
| this.dhcpConnectVlan = null; |
| this.indirectDhcpConnectMac = null; |
| this.indirectDhcpConnectVlan = null; |
| } |
| |
| @Override |
| public void setDhcpServerIp(IpAddress dhcpServerIp) { |
| checkNotNull(dhcpServerIp, "DHCP server IP can't be null"); |
| checkState(dhcpServerIp.isIp4(), "Invalid server IP for DHCPv4 relay handler"); |
| this.dhcpServerIp = dhcpServerIp.getIp4Address(); |
| } |
| |
| @Override |
| public void setDhcpServerConnectPoint(ConnectPoint dhcpServerConnectPoint) { |
| checkNotNull(dhcpServerConnectPoint, "Server connect point can't null"); |
| this.dhcpServerConnectPoint = dhcpServerConnectPoint; |
| } |
| |
| @Override |
| public void setDhcpConnectMac(MacAddress dhcpConnectMac) { |
| this.dhcpConnectMac = dhcpConnectMac; |
| } |
| |
| @Override |
| public void setDhcpConnectVlan(VlanId dhcpConnectVlan) { |
| this.dhcpConnectVlan = dhcpConnectVlan; |
| } |
| |
| @Override |
| public void setDhcpGatewayIp(IpAddress dhcpGatewayIp) { |
| if (dhcpGatewayIp != null) { |
| checkState(dhcpGatewayIp.isIp4(), "Invalid gateway IP for DHCPv4 relay handler"); |
| this.dhcpGatewayIp = dhcpGatewayIp.getIp4Address(); |
| } else { |
| // removes gateway config |
| this.dhcpGatewayIp = null; |
| } |
| } |
| |
| @Override |
| public Optional<IpAddress> getDhcpServerIp() { |
| return Optional.ofNullable(dhcpServerIp); |
| } |
| |
| @Override |
| public Optional<IpAddress> getDhcpGatewayIp() { |
| return Optional.ofNullable(dhcpGatewayIp); |
| } |
| |
| @Override |
| public Optional<MacAddress> getDhcpConnectMac() { |
| return Optional.ofNullable(dhcpConnectMac); |
| } |
| |
| @Override |
| public void setDefaultDhcpServerConfigs(Collection<DhcpServerConfig> configs) { |
| if (configs.size() == 0) { |
| // no config to update |
| return; |
| } |
| |
| // TODO: currently we pick up first DHCP server config. |
| // Will use other server configs in the future for HA. |
| DhcpServerConfig serverConfig = configs.iterator().next(); |
| if (!serverConfig.getDhcpServerConnectPoint().isPresent()) { |
| log.warn("Connect point from server config not exists"); |
| return; |
| } |
| if (!serverConfig.getDhcpServerIp4().isPresent()) { |
| log.warn("IP from DHCP server config not exists"); |
| return; |
| } |
| Ip4Address oldServerIp = this.dhcpServerIp; |
| Ip4Address oldGatewayIp = this.dhcpGatewayIp; |
| |
| // stop monitoring gateway or server |
| if (oldGatewayIp != null) { |
| hostService.stopMonitoringIp(oldGatewayIp); |
| } else if (oldServerIp != null) { |
| hostService.stopMonitoringIp(oldServerIp); |
| } |
| |
| this.dhcpServerConnectPoint = serverConfig.getDhcpServerConnectPoint().get(); |
| this.dhcpServerIp = serverConfig.getDhcpServerIp4().get(); |
| this.dhcpGatewayIp = serverConfig.getDhcpGatewayIp4().orElse(null); |
| |
| // reset server mac and vlan |
| this.dhcpConnectMac = null; |
| this.dhcpConnectVlan = null; |
| |
| log.info("DHCP server connect point: " + this.dhcpServerConnectPoint); |
| log.info("DHCP server IP: " + this.dhcpServerIp); |
| |
| IpAddress ipToProbe = MoreObjects.firstNonNull(this.dhcpGatewayIp, this.dhcpServerIp); |
| String hostToProbe = this.dhcpGatewayIp != null ? "gateway" : "DHCP server"; |
| |
| if (ipToProbe == null) { |
| log.warn("Server IP not set, can't probe it"); |
| return; |
| } |
| |
| log.info("Probing to resolve {} IP {}", hostToProbe, ipToProbe); |
| hostService.startMonitoringIp(ipToProbe); |
| |
| Set<Host> hosts = hostService.getHostsByIp(ipToProbe); |
| if (!hosts.isEmpty()) { |
| Host host = hosts.iterator().next(); |
| this.dhcpConnectVlan = host.vlan(); |
| this.dhcpConnectMac = host.mac(); |
| } |
| |
| this.relayAgentIp = serverConfig.getRelayAgentIp4().orElse(null); |
| } |
| |
| @Override |
| public void setIndirectDhcpServerConfigs(Collection<DhcpServerConfig> configs) { |
| if (configs.size() == 0) { |
| // no config to update |
| return; |
| } |
| |
| // TODO: currently we pick up first indirect DHCP server config. |
| // Will use other server configs in the future for HA. |
| DhcpServerConfig serverConfig = configs.iterator().next(); |
| checkState(serverConfig.getDhcpServerConnectPoint().isPresent(), |
| "Connect point not exists"); |
| checkState(serverConfig.getDhcpServerIp4().isPresent(), |
| "IP of DHCP server not exists"); |
| Ip4Address oldServerIp = this.indirectDhcpServerIp; |
| Ip4Address oldGatewayIp = this.indirectDhcpGatewayIp; |
| |
| // stop monitoring gateway or server |
| if (oldGatewayIp != null) { |
| hostService.stopMonitoringIp(oldGatewayIp); |
| } else if (oldServerIp != null) { |
| hostService.stopMonitoringIp(oldServerIp); |
| } |
| |
| this.indirectDhcpServerConnectPoint = serverConfig.getDhcpServerConnectPoint().get(); |
| this.indirectDhcpServerIp = serverConfig.getDhcpServerIp4().get(); |
| this.indirectDhcpGatewayIp = serverConfig.getDhcpGatewayIp4().orElse(null); |
| |
| // reset server mac and vlan |
| this.indirectDhcpConnectMac = null; |
| this.indirectDhcpConnectVlan = null; |
| |
| log.info("Indirect DHCP server connect point: " + this.indirectDhcpServerConnectPoint); |
| log.info("Indirect DHCP server IP: " + this.indirectDhcpServerIp); |
| |
| IpAddress ipToProbe = MoreObjects.firstNonNull(this.indirectDhcpGatewayIp, this.indirectDhcpServerIp); |
| String hostToProbe = this.indirectDhcpGatewayIp != null ? "gateway" : "DHCP server"; |
| |
| log.info("Probing to resolve {} IP {}", hostToProbe, ipToProbe); |
| hostService.startMonitoringIp(ipToProbe); |
| |
| Set<Host> hosts = hostService.getHostsByIp(ipToProbe); |
| if (!hosts.isEmpty()) { |
| Host host = hosts.iterator().next(); |
| this.indirectDhcpConnectVlan = host.vlan(); |
| this.indirectDhcpConnectMac = host.mac(); |
| } |
| |
| this.indirectRelayAgentIp = serverConfig.getRelayAgentIp4().orElse(null); |
| } |
| |
| @Override |
| public void processDhcpPacket(PacketContext context, BasePacket payload) { |
| checkNotNull(payload, "DHCP payload can't be null"); |
| checkState(payload instanceof DHCP, "Payload is not a DHCP"); |
| DHCP dhcpPayload = (DHCP) payload; |
| if (!configured()) { |
| log.warn("Missing DHCP relay server config. Abort packet processing"); |
| return; |
| } |
| |
| ConnectPoint inPort = context.inPacket().receivedFrom(); |
| checkNotNull(dhcpPayload, "Can't find DHCP payload"); |
| Ethernet packet = context.inPacket().parsed(); |
| DHCP.MsgType incomingPacketType = dhcpPayload.getOptions().stream() |
| .filter(dhcpOption -> dhcpOption.getCode() == OptionCode_MessageType.getValue()) |
| .map(DhcpOption::getData) |
| .map(data -> DHCP.MsgType.getType(data[0])) |
| .findFirst() |
| .orElse(null); |
| checkNotNull(incomingPacketType, "Can't get message type from DHCP payload {}", dhcpPayload); |
| switch (incomingPacketType) { |
| case DHCPDISCOVER: |
| // Add the gateway IP as virtual interface IP for server to understand |
| // the lease to be assigned and forward the packet to dhcp server. |
| Ethernet ethernetPacketDiscover = |
| processDhcpPacketFromClient(context, packet); |
| if (ethernetPacketDiscover != null) { |
| writeRequestDhcpRecord(inPort, packet, dhcpPayload); |
| handleDhcpDiscoverAndRequest(ethernetPacketDiscover, dhcpPayload); |
| } |
| break; |
| case DHCPOFFER: |
| //reply to dhcp client. |
| Ethernet ethernetPacketOffer = processDhcpPacketFromServer(packet); |
| if (ethernetPacketOffer != null) { |
| writeResponseDhcpRecord(ethernetPacketOffer, dhcpPayload); |
| sendResponseToClient(ethernetPacketOffer, dhcpPayload); |
| } |
| break; |
| case DHCPREQUEST: |
| // add the gateway ip as virtual interface ip for server to understand |
| // the lease to be assigned and forward the packet to dhcp server. |
| Ethernet ethernetPacketRequest = |
| processDhcpPacketFromClient(context, packet); |
| if (ethernetPacketRequest != null) { |
| writeRequestDhcpRecord(inPort, packet, dhcpPayload); |
| handleDhcpDiscoverAndRequest(ethernetPacketRequest, dhcpPayload); |
| } |
| break; |
| case DHCPACK: |
| // reply to dhcp client. |
| Ethernet ethernetPacketAck = processDhcpPacketFromServer(packet); |
| if (ethernetPacketAck != null) { |
| writeResponseDhcpRecord(ethernetPacketAck, dhcpPayload); |
| handleDhcpAck(ethernetPacketAck, dhcpPayload); |
| sendResponseToClient(ethernetPacketAck, dhcpPayload); |
| } |
| break; |
| case DHCPRELEASE: |
| // TODO: release the ip address from client |
| break; |
| default: |
| break; |
| } |
| } |
| |
| /** |
| * Checks if this app has been configured. |
| * |
| * @return true if all information we need have been initialized |
| */ |
| private boolean configured() { |
| return dhcpServerConnectPoint != null && dhcpServerIp != null; |
| } |
| |
| /** |
| * Returns the first interface ip from interface. |
| * |
| * @param iface interface of one connect point |
| * @return the first interface IP; null if not exists an IP address in |
| * these interfaces |
| */ |
| private Ip4Address getFirstIpFromInterface(Interface iface) { |
| checkNotNull(iface, "Interface can't be null"); |
| return iface.ipAddressesList().stream() |
| .map(InterfaceIpAddress::ipAddress) |
| .filter(IpAddress::isIp4) |
| .map(IpAddress::getIp4Address) |
| .findFirst() |
| .orElse(null); |
| } |
| |
| /** |
| * Gets Interface facing to the server for default host. |
| * |
| * @return the Interface facing to the server; null if not found |
| */ |
| private Interface getServerInterface() { |
| if (dhcpServerConnectPoint == null || dhcpConnectVlan == null) { |
| return null; |
| } |
| return interfaceService.getInterfacesByPort(dhcpServerConnectPoint) |
| .stream() |
| .filter(iface -> interfaceContainsVlan(iface, dhcpConnectVlan)) |
| .findFirst() |
| .orElse(null); |
| } |
| |
| /** |
| * Gets Interface facing to the server for indirect hosts. |
| * Use default server Interface if indirect server not configured. |
| * |
| * @return the Interface facing to the server; null if not found |
| */ |
| private Interface getIndirectServerInterface() { |
| if (indirectDhcpServerConnectPoint == null || indirectDhcpConnectVlan == null) { |
| return getServerInterface(); |
| } |
| return interfaceService.getInterfacesByPort(indirectDhcpServerConnectPoint) |
| .stream() |
| .filter(iface -> interfaceContainsVlan(iface, indirectDhcpConnectVlan)) |
| .findFirst() |
| .orElse(null); |
| } |
| |
| /** |
| * Determind if an Interface contains a vlan id. |
| * |
| * @param iface the Interface |
| * @param vlanId the vlan id |
| * @return true if the Interface contains the vlan id |
| */ |
| private boolean interfaceContainsVlan(Interface iface, VlanId vlanId) { |
| if (vlanId.equals(VlanId.NONE)) { |
| // untagged packet, check if vlan untagged or vlan native is not NONE |
| return !iface.vlanUntagged().equals(VlanId.NONE) || |
| !iface.vlanNative().equals(VlanId.NONE); |
| } |
| // tagged packet, check if the interface contains the vlan |
| return iface.vlanTagged().contains(vlanId); |
| } |
| |
| /** |
| * Build the DHCP discover/request packet with gateway IP(unicast packet). |
| * |
| * @param context the packet context |
| * @param ethernetPacket the ethernet payload to process |
| * @return processed packet |
| */ |
| private Ethernet processDhcpPacketFromClient(PacketContext context, |
| Ethernet ethernetPacket) { |
| // get dhcp header. |
| Ethernet etherReply = (Ethernet) ethernetPacket.clone(); |
| IPv4 ipv4Packet = (IPv4) etherReply.getPayload(); |
| UDP udpPacket = (UDP) ipv4Packet.getPayload(); |
| DHCP dhcpPacket = (DHCP) udpPacket.getPayload(); |
| |
| Ip4Address clientInterfaceIp = |
| interfaceService.getInterfacesByPort(context.inPacket().receivedFrom()) |
| .stream() |
| .map(Interface::ipAddressesList) |
| .flatMap(Collection::stream) |
| .map(InterfaceIpAddress::ipAddress) |
| .filter(IpAddress::isIp4) |
| .map(IpAddress::getIp4Address) |
| .findFirst() |
| .orElse(null); |
| if (clientInterfaceIp == null) { |
| log.warn("Can't find interface IP for client interface for port {}", |
| context.inPacket().receivedFrom()); |
| return null; |
| } |
| boolean isDirectlyConnected = directlyConnected(dhcpPacket); |
| Interface serverInterface = isDirectlyConnected ? getServerInterface() : getIndirectServerInterface(); |
| if (serverInterface == null) { |
| log.warn("Can't get {} server interface, ignore", isDirectlyConnected ? "direct" : "indirect"); |
| return null; |
| } |
| Ip4Address ipFacingServer = getFirstIpFromInterface(serverInterface); |
| MacAddress macFacingServer = serverInterface.mac(); |
| if (ipFacingServer == null || macFacingServer == null) { |
| log.warn("No IP address for server Interface {}", serverInterface); |
| return null; |
| } |
| if (dhcpConnectMac == null) { |
| log.warn("DHCP {} not yet resolved .. Aborting DHCP " |
| + "packet processing from client on port: {}", |
| (dhcpGatewayIp == null) ? "server IP " + dhcpServerIp |
| : "gateway IP " + dhcpGatewayIp, |
| context.inPacket().receivedFrom()); |
| return null; |
| } |
| |
| etherReply.setSourceMACAddress(macFacingServer); |
| ipv4Packet.setSourceAddress(ipFacingServer.toInt()); |
| |
| if (isDirectlyConnected) { |
| etherReply.setDestinationMACAddress(dhcpConnectMac); |
| etherReply.setVlanID(dhcpConnectVlan.toShort()); |
| ipv4Packet.setDestinationAddress(dhcpServerIp.toInt()); |
| |
| ConnectPoint inPort = context.inPacket().receivedFrom(); |
| VlanId vlanId = VlanId.vlanId(ethernetPacket.getVlanID()); |
| // add connected in port and vlan |
| CircuitId cid = new CircuitId(inPort.toString(), vlanId); |
| byte[] circuitId = cid.serialize(); |
| DhcpOption circuitIdSubOpt = new DhcpOption(); |
| circuitIdSubOpt |
| .setCode(CIRCUIT_ID.getValue()) |
| .setLength((byte) circuitId.length) |
| .setData(circuitId); |
| |
| DhcpRelayAgentOption newRelayAgentOpt = new DhcpRelayAgentOption(); |
| newRelayAgentOpt.setCode(OptionCode_CircuitID.getValue()); |
| newRelayAgentOpt.addSubOption(circuitIdSubOpt); |
| |
| // Removes END option first |
| List<DhcpOption> options = dhcpPacket.getOptions().stream() |
| .filter(opt -> opt.getCode() != OptionCode_END.getValue()) |
| .collect(Collectors.toList()); |
| |
| // push relay agent option |
| options.add(newRelayAgentOpt); |
| |
| // make sure option 255(End) is the last option |
| DhcpOption endOption = new DhcpOption(); |
| endOption.setCode(OptionCode_END.getValue()); |
| options.add(endOption); |
| |
| dhcpPacket.setOptions(options); |
| |
| // Sets relay agent IP |
| int effectiveRelayAgentIp = relayAgentIp != null ? |
| relayAgentIp.toInt() : clientInterfaceIp.toInt(); |
| dhcpPacket.setGatewayIPAddress(effectiveRelayAgentIp); |
| } else { |
| if (indirectDhcpServerIp != null) { |
| // Use indirect server config for indirect packets if configured |
| etherReply.setDestinationMACAddress(indirectDhcpConnectMac); |
| etherReply.setVlanID(indirectDhcpConnectVlan.toShort()); |
| ipv4Packet.setDestinationAddress(indirectDhcpServerIp.toInt()); |
| |
| // Set giaddr if indirect relay agent IP is configured |
| if (indirectRelayAgentIp != null) { |
| dhcpPacket.setGatewayIPAddress(indirectRelayAgentIp.toInt()); |
| } |
| } else { |
| // Otherwise, use default server config for indirect packets |
| etherReply.setDestinationMACAddress(dhcpConnectMac); |
| etherReply.setVlanID(dhcpConnectVlan.toShort()); |
| ipv4Packet.setDestinationAddress(dhcpServerIp.toInt()); |
| |
| // Set giaddr if direct relay agent IP is configured |
| if (relayAgentIp != null) { |
| dhcpPacket.setGatewayIPAddress(relayAgentIp.toInt()); |
| } |
| } |
| } |
| |
| // Remove broadcast flag |
| dhcpPacket.setFlags((short) 0); |
| |
| udpPacket.setPayload(dhcpPacket); |
| // As a DHCP relay, the source port should be server port( instead |
| // of client port. |
| udpPacket.setSourcePort(UDP.DHCP_SERVER_PORT); |
| udpPacket.setDestinationPort(UDP.DHCP_SERVER_PORT); |
| ipv4Packet.setPayload(udpPacket); |
| ipv4Packet.setTtl((byte) 64); |
| etherReply.setPayload(ipv4Packet); |
| return etherReply; |
| } |
| |
| /** |
| * Writes DHCP record to the store according to the request DHCP packet (Discover, Request). |
| * |
| * @param location the location which DHCP packet comes from |
| * @param ethernet the DHCP packet |
| * @param dhcpPayload the DHCP payload |
| */ |
| private void writeRequestDhcpRecord(ConnectPoint location, |
| Ethernet ethernet, |
| DHCP dhcpPayload) { |
| VlanId vlanId = VlanId.vlanId(ethernet.getVlanID()); |
| MacAddress macAddress = MacAddress.valueOf(dhcpPayload.getClientHardwareAddress()); |
| HostId hostId = HostId.hostId(macAddress, vlanId); |
| DhcpRecord record = dhcpRelayStore.getDhcpRecord(hostId).orElse(null); |
| if (record == null) { |
| record = new DhcpRecord(HostId.hostId(macAddress, vlanId)); |
| } else { |
| record = record.clone(); |
| } |
| record.addLocation(new HostLocation(location, System.currentTimeMillis())); |
| record.ip4Status(dhcpPayload.getPacketType()); |
| record.setDirectlyConnected(directlyConnected(dhcpPayload)); |
| if (!directlyConnected(dhcpPayload)) { |
| // Update gateway mac address if the host is not directly connected |
| record.nextHop(ethernet.getSourceMAC()); |
| } |
| record.updateLastSeen(); |
| dhcpRelayStore.updateDhcpRecord(HostId.hostId(macAddress, vlanId), record); |
| } |
| |
| /** |
| * Writes DHCP record to the store according to the response DHCP packet (Offer, Ack). |
| * |
| * @param ethernet the DHCP packet |
| * @param dhcpPayload the DHCP payload |
| */ |
| private void writeResponseDhcpRecord(Ethernet ethernet, |
| DHCP dhcpPayload) { |
| Optional<Interface> outInterface = getClientInterface(ethernet, dhcpPayload); |
| if (!outInterface.isPresent()) { |
| log.warn("Failed to determine where to send {}", dhcpPayload.getPacketType()); |
| return; |
| } |
| |
| Interface outIface = outInterface.get(); |
| ConnectPoint location = outIface.connectPoint(); |
| VlanId vlanId = getVlanIdFromRelayAgentOption(dhcpPayload); |
| if (vlanId == null) { |
| vlanId = outIface.vlan(); |
| } |
| MacAddress macAddress = MacAddress.valueOf(dhcpPayload.getClientHardwareAddress()); |
| HostId hostId = HostId.hostId(macAddress, vlanId); |
| DhcpRecord record = dhcpRelayStore.getDhcpRecord(hostId).orElse(null); |
| if (record == null) { |
| record = new DhcpRecord(HostId.hostId(macAddress, vlanId)); |
| } else { |
| record = record.clone(); |
| } |
| record.addLocation(new HostLocation(location, System.currentTimeMillis())); |
| if (dhcpPayload.getPacketType() == DHCP.MsgType.DHCPACK) { |
| record.ip4Address(Ip4Address.valueOf(dhcpPayload.getYourIPAddress())); |
| } |
| record.ip4Status(dhcpPayload.getPacketType()); |
| record.setDirectlyConnected(directlyConnected(dhcpPayload)); |
| record.updateLastSeen(); |
| dhcpRelayStore.updateDhcpRecord(HostId.hostId(macAddress, vlanId), record); |
| } |
| |
| /** |
| * Build the DHCP offer/ack with proper client port. |
| * |
| * @param ethernetPacket the original packet comes from server |
| * @return new packet which will send to the client |
| */ |
| private Ethernet processDhcpPacketFromServer(Ethernet ethernetPacket) { |
| // get dhcp header. |
| Ethernet etherReply = (Ethernet) ethernetPacket.clone(); |
| IPv4 ipv4Packet = (IPv4) etherReply.getPayload(); |
| UDP udpPacket = (UDP) ipv4Packet.getPayload(); |
| DHCP dhcpPayload = (DHCP) udpPacket.getPayload(); |
| |
| // determine the vlanId of the client host - note that this vlan id |
| // could be different from the vlan in the packet from the server |
| Interface clientInterface = getClientInterface(ethernetPacket, dhcpPayload).orElse(null); |
| |
| if (clientInterface == null) { |
| log.warn("Cannot find the interface for the DHCP {}", dhcpPayload); |
| return null; |
| } |
| VlanId vlanId; |
| if (clientInterface.vlanTagged().isEmpty()) { |
| vlanId = clientInterface.vlan(); |
| } else { |
| // might be multiple vlan in same interface |
| vlanId = getVlanIdFromRelayAgentOption(dhcpPayload); |
| } |
| if (vlanId == null) { |
| vlanId = VlanId.NONE; |
| } |
| etherReply.setVlanID(vlanId.toShort()); |
| etherReply.setSourceMACAddress(clientInterface.mac()); |
| |
| if (!directlyConnected(dhcpPayload)) { |
| // if client is indirectly connected, try use next hop mac address |
| MacAddress macAddress = MacAddress.valueOf(dhcpPayload.getClientHardwareAddress()); |
| HostId hostId = HostId.hostId(macAddress, vlanId); |
| DhcpRecord record = dhcpRelayStore.getDhcpRecord(hostId).orElse(null); |
| if (record != null) { |
| // if next hop can be found, use mac address of next hop |
| record.nextHop().ifPresent(etherReply::setDestinationMACAddress); |
| } else { |
| // otherwise, discard the packet |
| log.warn("Can't find record for host id {}, discard packet", hostId); |
| return null; |
| } |
| } else { |
| etherReply.setDestinationMACAddress(dhcpPayload.getClientHardwareAddress()); |
| } |
| |
| // we leave the srcMac from the original packet |
| // figure out the relay agent IP corresponding to the original request |
| Ip4Address ipFacingClient = getFirstIpFromInterface(clientInterface); |
| if (ipFacingClient == null) { |
| log.warn("Cannot determine relay agent interface Ipv4 addr for host {}/{}. " |
| + "Aborting relay for dhcp packet from server {}", |
| etherReply.getDestinationMAC(), clientInterface.vlan(), |
| ethernetPacket); |
| return null; |
| } |
| // SRC_IP: relay agent IP |
| // DST_IP: offered IP |
| ipv4Packet.setSourceAddress(ipFacingClient.toInt()); |
| ipv4Packet.setDestinationAddress(dhcpPayload.getYourIPAddress()); |
| udpPacket.setSourcePort(UDP.DHCP_SERVER_PORT); |
| if (directlyConnected(dhcpPayload)) { |
| udpPacket.setDestinationPort(UDP.DHCP_CLIENT_PORT); |
| } else { |
| // forward to another dhcp relay |
| // FIXME: Currently we assume the DHCP comes from a L2 relay with |
| // Option 82, this might not work if DHCP message comes from |
| // L3 relay. |
| udpPacket.setDestinationPort(UDP.DHCP_CLIENT_PORT); |
| } |
| |
| udpPacket.setPayload(dhcpPayload); |
| ipv4Packet.setPayload(udpPacket); |
| etherReply.setPayload(ipv4Packet); |
| return etherReply; |
| } |
| |
| /** |
| * Extracts VLAN ID from relay agent option. |
| * |
| * @param dhcpPayload the DHCP payload |
| * @return VLAN ID from DHCP payload; null if not exists |
| */ |
| private VlanId getVlanIdFromRelayAgentOption(DHCP dhcpPayload) { |
| DhcpRelayAgentOption option = (DhcpRelayAgentOption) dhcpPayload.getOption(OptionCode_CircuitID); |
| if (option == null) { |
| return null; |
| } |
| DhcpOption circuitIdSubOption = option.getSubOption(CIRCUIT_ID.getValue()); |
| if (circuitIdSubOption == null) { |
| return null; |
| } |
| try { |
| CircuitId circuitId = CircuitId.deserialize(circuitIdSubOption.getData()); |
| return circuitId.vlanId(); |
| } catch (IllegalArgumentException e) { |
| // can't deserialize the circuit ID |
| return null; |
| } |
| } |
| |
| /** |
| * Removes DHCP relay agent information option (option 82) from DHCP payload. |
| * Also reset giaddr to 0 |
| * |
| * @param ethPacket the Ethernet packet to be processed |
| * @return Ethernet packet processed |
| */ |
| private Ethernet removeRelayAgentOption(Ethernet ethPacket) { |
| Ethernet ethernet = (Ethernet) ethPacket.clone(); |
| IPv4 ipv4 = (IPv4) ethernet.getPayload(); |
| UDP udp = (UDP) ipv4.getPayload(); |
| DHCP dhcpPayload = (DHCP) udp.getPayload(); |
| |
| // removes relay agent information option |
| List<DhcpOption> options = dhcpPayload.getOptions(); |
| options = options.stream() |
| .filter(option -> option.getCode() != OptionCode_CircuitID.getValue()) |
| .collect(Collectors.toList()); |
| dhcpPayload.setOptions(options); |
| dhcpPayload.setGatewayIPAddress(0); |
| |
| udp.setPayload(dhcpPayload); |
| ipv4.setPayload(udp); |
| ethernet.setPayload(ipv4); |
| return ethernet; |
| } |
| |
| |
| /** |
| * Check if the host is directly connected to the network or not. |
| * |
| * @param dhcpPayload the dhcp payload |
| * @return true if the host is directly connected to the network; false otherwise |
| */ |
| private boolean directlyConnected(DHCP dhcpPayload) { |
| DhcpRelayAgentOption relayAgentOption = |
| (DhcpRelayAgentOption) dhcpPayload.getOption(OptionCode_CircuitID); |
| |
| // Doesn't contains relay option |
| if (relayAgentOption == null) { |
| return true; |
| } |
| |
| // check circuit id, if circuit id is invalid, we say it is an indirect host |
| DhcpOption circuitIdOpt = relayAgentOption.getSubOption(CIRCUIT_ID.getValue()); |
| |
| try { |
| CircuitId.deserialize(circuitIdOpt.getData()); |
| return true; |
| } catch (Exception e) { |
| // invalid circuit id |
| return false; |
| } |
| } |
| |
| |
| /** |
| * Send the DHCP ack to the requester host. |
| * Modify Host or Route store according to the type of DHCP. |
| * |
| * @param ethernetPacketAck the packet |
| * @param dhcpPayload the DHCP data |
| */ |
| private void handleDhcpAck(Ethernet ethernetPacketAck, DHCP dhcpPayload) { |
| Optional<Interface> outInterface = getClientInterface(ethernetPacketAck, dhcpPayload); |
| if (!outInterface.isPresent()) { |
| log.warn("Can't find output interface for dhcp: {}", dhcpPayload); |
| return; |
| } |
| |
| Interface outIface = outInterface.get(); |
| HostLocation hostLocation = new HostLocation(outIface.connectPoint(), System.currentTimeMillis()); |
| MacAddress macAddress = MacAddress.valueOf(dhcpPayload.getClientHardwareAddress()); |
| VlanId vlanId = getVlanIdFromRelayAgentOption(dhcpPayload); |
| if (vlanId == null) { |
| vlanId = outIface.vlan(); |
| } |
| HostId hostId = HostId.hostId(macAddress, vlanId); |
| Ip4Address ip = Ip4Address.valueOf(dhcpPayload.getYourIPAddress()); |
| |
| if (directlyConnected(dhcpPayload)) { |
| // Add to host store if it connect to network directly |
| Set<IpAddress> ips = Sets.newHashSet(ip); |
| Host host = hostService.getHost(hostId); |
| |
| Set<HostLocation> hostLocations = Sets.newHashSet(hostLocation); |
| if (host != null) { |
| // Dual homing support: |
| // if host exists, use old locations and new location |
| hostLocations.addAll(host.locations()); |
| } |
| HostDescription desc = new DefaultHostDescription(macAddress, vlanId, |
| hostLocations, ips, false); |
| // Add IP address when dhcp server give the host new ip address |
| providerService.hostDetected(hostId, desc, false); |
| } else { |
| // Add to route store if it does not connect to network directly |
| // Get gateway host IP according to host mac address |
| // TODO: remove relay store here |
| DhcpRecord record = dhcpRelayStore.getDhcpRecord(hostId).orElse(null); |
| |
| if (record == null) { |
| log.warn("Can't find DHCP record of host {}", hostId); |
| return; |
| } |
| |
| MacAddress gwMac = record.nextHop().orElse(null); |
| if (gwMac == null) { |
| log.warn("Can't find gateway mac address from record {}", record); |
| return; |
| } |
| |
| HostId gwHostId = HostId.hostId(gwMac, record.vlanId()); |
| Host gwHost = hostService.getHost(gwHostId); |
| |
| if (gwHost == null) { |
| log.warn("Can't find gateway host {}", gwHostId); |
| return; |
| } |
| |
| Ip4Address nextHopIp = gwHost.ipAddresses() |
| .stream() |
| .filter(IpAddress::isIp4) |
| .map(IpAddress::getIp4Address) |
| .findFirst() |
| .orElse(null); |
| |
| if (nextHopIp == null) { |
| log.warn("Can't find IP address of gateway {}", gwHost); |
| return; |
| } |
| |
| Route route = new Route(Route.Source.STATIC, ip.toIpPrefix(), nextHopIp); |
| routeStore.updateRoute(route); |
| } |
| } |
| |
| /** |
| * forward the packet to ConnectPoint where the DHCP server is attached. |
| * |
| * @param packet the packet |
| */ |
| private void handleDhcpDiscoverAndRequest(Ethernet packet, DHCP dhcpPayload) { |
| ConnectPoint portToFotward = dhcpServerConnectPoint; |
| if (!directlyConnected(dhcpPayload) && indirectDhcpServerConnectPoint != null) { |
| portToFotward = indirectDhcpServerConnectPoint; |
| } |
| // send packet to dhcp server connect point. |
| if (portToFotward != null) { |
| TrafficTreatment t = DefaultTrafficTreatment.builder() |
| .setOutput(portToFotward.port()).build(); |
| OutboundPacket o = new DefaultOutboundPacket( |
| portToFotward.deviceId(), t, ByteBuffer.wrap(packet.serialize())); |
| if (log.isTraceEnabled()) { |
| log.trace("Relaying packet to dhcp server {}", packet); |
| } |
| packetService.emit(o); |
| } else { |
| log.warn("Can't find DHCP server connect point, abort."); |
| } |
| } |
| |
| |
| /** |
| * Gets output interface of a dhcp packet. |
| * If option 82 exists in the dhcp packet and the option was sent by |
| * ONOS (circuit format is correct), use the connect |
| * point and vlan id from circuit id; otherwise, find host by destination |
| * address and use vlan id from sender (dhcp server). |
| * |
| * @param ethPacket the ethernet packet |
| * @param dhcpPayload the dhcp packet |
| * @return an interface represent the output port and vlan; empty value |
| * if the host or circuit id not found |
| */ |
| private Optional<Interface> getClientInterface(Ethernet ethPacket, DHCP dhcpPayload) { |
| VlanId originalPacketVlanId = VlanId.vlanId(ethPacket.getVlanID()); |
| DhcpRelayAgentOption option = (DhcpRelayAgentOption) dhcpPayload.getOption(OptionCode_CircuitID); |
| |
| DhcpOption circuitIdSubOption = option.getSubOption(CIRCUIT_ID.getValue()); |
| try { |
| CircuitId circuitId = CircuitId.deserialize(circuitIdSubOption.getData()); |
| ConnectPoint connectPoint = ConnectPoint.deviceConnectPoint(circuitId.connectPoint()); |
| VlanId vlanId = circuitId.vlanId(); |
| return interfaceService.getInterfacesByPort(connectPoint) |
| .stream() |
| .filter(iface -> interfaceContainsVlan(iface, vlanId)) |
| .findFirst(); |
| } catch (IllegalArgumentException ex) { |
| // invalid circuit format, didn't sent by ONOS |
| log.debug("Invalid circuit {}, use information from dhcp payload", |
| circuitIdSubOption.getData()); |
| } |
| |
| // Use Vlan Id from DHCP server if DHCP relay circuit id was not |
| // sent by ONOS or circuit Id can't be parsed |
| // TODO: remove relay store from this method |
| MacAddress dstMac = valueOf(dhcpPayload.getClientHardwareAddress()); |
| Optional<DhcpRecord> dhcpRecord = dhcpRelayStore.getDhcpRecord(HostId.hostId(dstMac, originalPacketVlanId)); |
| ConnectPoint clientConnectPoint = dhcpRecord |
| .map(DhcpRecord::locations) |
| .orElse(Collections.emptySet()) |
| .stream() |
| .reduce((hl1, hl2) -> { |
| // find latest host connect point |
| if (hl1 == null || hl2 == null) { |
| return hl1 == null ? hl2 : hl1; |
| } |
| return hl1.time() > hl2.time() ? hl1 : hl2; |
| }) |
| .orElse(null); |
| |
| if (clientConnectPoint != null) { |
| return interfaceService.getInterfacesByPort(clientConnectPoint) |
| .stream() |
| .filter(iface -> interfaceContainsVlan(iface, originalPacketVlanId)) |
| .findFirst(); |
| } |
| return Optional.empty(); |
| } |
| |
| /** |
| * Send the response DHCP to the requester host. |
| * |
| * @param ethPacket the packet |
| * @param dhcpPayload the DHCP data |
| */ |
| private void sendResponseToClient(Ethernet ethPacket, DHCP dhcpPayload) { |
| Optional<Interface> outInterface = getClientInterface(ethPacket, dhcpPayload); |
| if (directlyConnected(dhcpPayload)) { |
| ethPacket = removeRelayAgentOption(ethPacket); |
| } |
| if (!outInterface.isPresent()) { |
| log.warn("Can't find output interface for client, ignore"); |
| return; |
| } |
| Interface outIface = outInterface.get(); |
| TrafficTreatment treatment = DefaultTrafficTreatment.builder() |
| .setOutput(outIface.connectPoint().port()) |
| .build(); |
| OutboundPacket o = new DefaultOutboundPacket( |
| outIface.connectPoint().deviceId(), |
| treatment, |
| ByteBuffer.wrap(ethPacket.serialize())); |
| if (log.isTraceEnabled()) { |
| log.trace("Relaying packet to DHCP client {} via {}, vlan {}", |
| ethPacket, |
| outIface.connectPoint(), |
| outIface.vlan()); |
| } |
| packetService.emit(o); |
| } |
| |
| @Override |
| public void triggerProbe(Host host) { |
| // Do nothing here |
| } |
| |
| @Override |
| public ProviderId id() { |
| return PROVIDER_ID; |
| } |
| |
| class InternalHostListener implements HostListener { |
| @Override |
| public void event(HostEvent event) { |
| switch (event.type()) { |
| case HOST_ADDED: |
| case HOST_UPDATED: |
| hostUpdated(event.subject()); |
| break; |
| case HOST_REMOVED: |
| hostRemoved(event.subject()); |
| break; |
| case HOST_MOVED: |
| hostMoved(event.subject()); |
| break; |
| default: |
| break; |
| } |
| } |
| } |
| |
| /** |
| * Handle host move. |
| * If the host DHCP server or gateway and it moved to the location different |
| * to user configured, unsets the connect mac and vlan |
| * |
| * @param host the host |
| */ |
| private void hostMoved(Host host) { |
| if (this.dhcpGatewayIp != null) { |
| if (host.ipAddresses().contains(this.dhcpGatewayIp) && |
| !host.locations().contains(this.dhcpServerConnectPoint)) { |
| this.dhcpConnectMac = null; |
| this.dhcpConnectVlan = null; |
| } |
| } |
| if (this.dhcpServerIp != null) { |
| if (host.ipAddresses().contains(this.dhcpServerIp) && |
| !host.locations().contains(this.dhcpServerConnectPoint)) { |
| this.dhcpConnectMac = null; |
| this.dhcpConnectVlan = null; |
| } |
| } |
| if (this.indirectDhcpGatewayIp != null) { |
| if (host.ipAddresses().contains(this.indirectDhcpGatewayIp) && |
| !host.locations().contains(this.indirectDhcpServerConnectPoint)) { |
| this.indirectDhcpConnectMac = null; |
| this.indirectDhcpConnectVlan = null; |
| } |
| } |
| if (this.indirectDhcpServerIp != null) { |
| if (host.ipAddresses().contains(this.indirectDhcpServerIp) && |
| !host.locations().contains(this.indirectDhcpServerConnectPoint)) { |
| this.indirectDhcpConnectMac = null; |
| this.indirectDhcpConnectVlan = null; |
| } |
| } |
| } |
| |
| /** |
| * Handle host updated. |
| * If the host is DHCP server or gateway, update connect mac and vlan. |
| * |
| * @param host the host |
| */ |
| private void hostUpdated(Host host) { |
| if (this.dhcpGatewayIp != null) { |
| if (host.ipAddresses().contains(this.dhcpGatewayIp)) { |
| this.dhcpConnectMac = host.mac(); |
| this.dhcpConnectVlan = host.vlan(); |
| } |
| } |
| if (this.dhcpServerIp != null) { |
| if (host.ipAddresses().contains(this.dhcpServerIp)) { |
| this.dhcpConnectMac = host.mac(); |
| this.dhcpConnectVlan = host.vlan(); |
| } |
| } |
| if (this.indirectDhcpGatewayIp != null) { |
| if (host.ipAddresses().contains(this.indirectDhcpGatewayIp)) { |
| this.indirectDhcpConnectMac = host.mac(); |
| this.indirectDhcpConnectVlan = host.vlan(); |
| } |
| } |
| if (this.indirectDhcpServerIp != null) { |
| if (host.ipAddresses().contains(this.indirectDhcpServerIp)) { |
| this.indirectDhcpConnectMac = host.mac(); |
| this.indirectDhcpConnectVlan = host.vlan(); |
| } |
| } |
| } |
| |
| /** |
| * Handle host removed. |
| * If the host is DHCP server or gateway, unset connect mac and vlan. |
| * |
| * @param host the host |
| */ |
| private void hostRemoved(Host host) { |
| if (this.dhcpGatewayIp != null) { |
| if (host.ipAddresses().contains(this.dhcpGatewayIp)) { |
| this.dhcpConnectMac = null; |
| this.dhcpConnectVlan = null; |
| } |
| } |
| if (this.dhcpServerIp != null) { |
| if (host.ipAddresses().contains(this.dhcpServerIp)) { |
| this.dhcpConnectMac = null; |
| this.dhcpConnectVlan = null; |
| } |
| } |
| if (this.indirectDhcpGatewayIp != null) { |
| if (host.ipAddresses().contains(this.indirectDhcpGatewayIp)) { |
| this.indirectDhcpConnectMac = null; |
| this.indirectDhcpConnectVlan = null; |
| } |
| } |
| if (this.indirectDhcpServerIp != null) { |
| if (host.ipAddresses().contains(this.indirectDhcpServerIp)) { |
| this.indirectDhcpConnectMac = null; |
| this.indirectDhcpConnectVlan = null; |
| } |
| } |
| } |
| } |