renderers/ofoverlay/src/main/java/org/opendaylight/groupbasedpolicy/renderer/ofoverlay/flow/PortSecurity.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8
   9 package org.opendaylight.groupbasedpolicy.renderer.ofoverlay.flow;
  10
  11 import java.util.Set;
  12
  13 import org.opendaylight.groupbasedpolicy.renderer.ofoverlay.OfContext;
  14 import org.opendaylight.groupbasedpolicy.renderer.ofoverlay.PolicyManager.FlowMap;
  15 import org.opendaylight.groupbasedpolicy.resolver.EgKey;
  16 import org.opendaylight.groupbasedpolicy.resolver.PolicyInfo;
  17 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv4Prefix;
  18 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv6Prefix;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowId;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.FlowBuilder;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.MatchBuilder;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.endpoint.rev140421.endpoint.fields.L3Address;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.endpoint.rev140421.endpoints.Endpoint;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.ofoverlay.rev140528.EndpointLocation.LocationType;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.ofoverlay.rev140528.OfOverlayContext;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.Layer3Match;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._3.match.ArpMatchBuilder;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._3.match.Ipv4MatchBuilder;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._3.match.Ipv6MatchBuilder;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.overlay.rev150105.TunnelTypeVxlan;
  34 import org.slf4j.Logger;
  35 import org.slf4j.LoggerFactory;
  36
  37 /**
  38  * Manage the table that enforces port security
  39  *
  40  */
  41 public class PortSecurity extends FlowTable {
  42     protected static final Logger LOG =
  43             LoggerFactory.getLogger(PortSecurity.class);
  44
  45     public static short TABLE_ID;
  46
  47     public PortSecurity(OfContext ctx, short tableId) {
  48         super(ctx);
  49         this.TABLE_ID=tableId;
  50     }
  51
  52     @Override
  53     public short getTableId() {
  54         return TABLE_ID;
  55     }
  56
  57     @Override
  58     public void sync(NodeId nodeId, PolicyInfo policyInfo, FlowMap flowMap) {
  59
  60         // Allow traffic from tunnel and external ports
  61         NodeConnectorId tunnelIf = ctx.getSwitchManager().getTunnelPort(nodeId, TunnelTypeVxlan.class);
  62         if (tunnelIf != null)
  63             flowMap.writeFlow(nodeId, TABLE_ID, allowFromPort(tunnelIf));
  64         Set<NodeConnectorId> external =
  65                 ctx.getSwitchManager().getExternalPorts(nodeId);
  66         for (NodeConnectorId extIf : external) {
  67             flowMap.writeFlow(nodeId, TABLE_ID, allowFromPort(extIf));
  68         }
  69
  70         // Default drop all
  71         flowMap.writeFlow(nodeId, TABLE_ID, dropFlow(Integer.valueOf(1), null));
  72
  73         // Drop IP traffic that doesn't match a source IP rule
  74         flowMap.writeFlow(nodeId, TABLE_ID, dropFlow(Integer.valueOf(110), FlowUtils.ARP));
  75         flowMap.writeFlow(nodeId, TABLE_ID, dropFlow(Integer.valueOf(111), FlowUtils.IPv4));
  76         flowMap.writeFlow(nodeId, TABLE_ID, dropFlow(Integer.valueOf(112), FlowUtils.IPv6));
  77
  78         for (Endpoint ep : ctx.getEndpointManager().getEndpointsForNode(nodeId)) {
  79             OfOverlayContext ofc = ep.getAugmentation(OfOverlayContext.class);
  80
  81             if (ofc != null && ofc.getNodeConnectorId() != null
  82                     && (ofc.getLocationType() == null || LocationType.Internal.equals(ofc.getLocationType()))) {
  83                 // Allow layer 3 traffic (ARP and IP) with the correct
  84                 // source IP, MAC, and source port
  85                 l3flow(flowMap, nodeId, ep, ofc, 120, false);
  86                 l3flow(flowMap, nodeId, ep, ofc, 121, true);
  87                 flowMap.writeFlow(nodeId, TABLE_ID, l3DhcpDoraFlow(ep, ofc, 115));
  88
  89                 // Allow layer 2 traffic with the correct source MAC and
  90                 // source port (note lower priority than drop IP rules)
  91                 flowMap.writeFlow(nodeId, TABLE_ID, l2flow(ep, ofc, 100));
  92             }
  93         }
  94     }
  95
  96     private Flow allowFromPort(
  97             NodeConnectorId port) {
  98         FlowId flowid = new FlowId(new StringBuilder()
  99                 .append("allow|")
 100                 .append(port.getValue())
 101                 .toString());
 102         FlowBuilder flowb = base()
 103                 .setId(flowid)
 104                 .setPriority(Integer.valueOf(200))
 105                 .setMatch(new MatchBuilder()
 106                         .setInPort(port)
 107                         .build())
 108                 .setInstructions(FlowUtils.gotoTableInstructions(ctx.getPolicyManager().getTABLEID_SOURCE_MAPPER()));
 109         return flowb.build();
 110
 111     }
 112
 113     private Flow l2flow(Endpoint ep, OfOverlayContext ofc, Integer priority) {
 114         FlowId flowid = new FlowId(new StringBuilder()
 115                 .append(ofc.getNodeConnectorId().getValue())
 116                 .append("|")
 117                 .append(ep.getMacAddress().getValue())
 118                 .toString());
 119         FlowBuilder flowb = base()
 120                 .setPriority(priority)
 121                 .setId(flowid)
 122                 .setMatch(new MatchBuilder()
 123                         .setEthernetMatch(FlowUtils.ethernetMatch(ep.getMacAddress(),
 124                                 null, null))
 125                         .setInPort(ofc.getNodeConnectorId())
 126                         .build())
 127                 .setInstructions(FlowUtils.gotoTableInstructions(ctx.getPolicyManager().getTABLEID_SOURCE_MAPPER()));
 128
 129         return flowb.build();
 130     }
 131
 132     private Flow l3DhcpDoraFlow(Endpoint ep, OfOverlayContext ofc, Integer priority) {
 133
 134         //TODO: Handle IPv6 DORA
 135         Long etherType = FlowUtils.IPv4;
 136         // DHCP DORA destination is broadcast
 137         String ikey = "255.255.255.255/32";
 138         Layer3Match m = new Ipv4MatchBuilder().setIpv4Destination(new Ipv4Prefix(ikey)).build();
 139
 140         FlowId flowid = new FlowId(new StringBuilder()
 141                 .append(ofc.getNodeConnectorId().getValue())
 142                 .append("|")
 143                 .append(ep.getMacAddress().getValue())
 144                 .append("|dhcp|")
 145                 .append(etherType)
 146                 .toString());
 147         Flow flow = base()
 148                 .setPriority(priority)
 149                 .setId(flowid)
 150                 .setMatch(new MatchBuilder()
 151                         .setEthernetMatch(FlowUtils.ethernetMatch(ep.getMacAddress(),
 152                                 null,
 153                                 etherType))
 154                         .setLayer3Match(m)
 155                         .setInPort(ofc.getNodeConnectorId())
 156                         .build())
 157                 .setInstructions(FlowUtils.gotoTableInstructions(ctx.getPolicyManager().getTABLEID_SOURCE_MAPPER()))
 158                 .build();
 159
 160         return flow;
 161     }
 162
 163     private void l3flow(FlowMap flowMap, NodeId nodeId,
 164                         Endpoint ep, OfOverlayContext ofc,
 165                         Integer priority, boolean arp) {
 166         if (ep.getL3Address() == null)
 167             return;
 168         for (L3Address l3 : ep.getL3Address()) {
 169             if (l3.getIpAddress() == null)
 170                 continue;
 171             Layer3Match m = null;
 172             Long etherType = null;
 173             String ikey = null;
 174             if (l3.getIpAddress().getIpv4Address() != null) {
 175                 ikey = l3.getIpAddress().getIpv4Address().getValue() + "/32";
 176                 if (arp) {
 177                     m = new ArpMatchBuilder()
 178                             .setArpSourceTransportAddress(new Ipv4Prefix(ikey))
 179                             .build();
 180                     etherType = FlowUtils.ARP;
 181                 } else {
 182                     m = new Ipv4MatchBuilder()
 183                             .setIpv4Source(new Ipv4Prefix(ikey))
 184                             .build();
 185                     etherType = FlowUtils.IPv4;
 186                 }
 187             } else if (l3.getIpAddress().getIpv6Address() != null) {
 188                 if (arp)
 189                     continue;
 190                 ikey = l3.getIpAddress().getIpv6Address().getValue() + "/128";
 191                 m = new Ipv6MatchBuilder()
 192                         .setIpv6Source(new Ipv6Prefix(ikey))
 193                         .build();
 194                 etherType = FlowUtils.IPv6;
 195             } else {
 196                 continue;
 197             }
 198             FlowId flowid = new FlowId(new StringBuilder()
 199                     .append(ofc.getNodeConnectorId().getValue())
 200                     .append("|")
 201                     .append(ep.getMacAddress().getValue())
 202                     .append("|")
 203                     .append(ikey)
 204                     .append("|")
 205                     .append(etherType)
 206                     .toString());
 207             Flow flow = base()
 208                     .setPriority(priority)
 209                     .setId(flowid)
 210                     .setMatch(new MatchBuilder()
 211                             .setEthernetMatch(FlowUtils.ethernetMatch(ep.getMacAddress(),
 212                                     null,
 213                                     etherType))
 214                             .setLayer3Match(m)
 215                             .setInPort(ofc.getNodeConnectorId())
 216                             .build())
 217                     .setInstructions(FlowUtils.gotoTableInstructions(ctx.getPolicyManager().getTABLEID_SOURCE_MAPPER()))
 218                     .build();
 219
 220             flowMap.writeFlow(nodeId, TABLE_ID,flow);
 221         }
 222     }
 223 }