2 * Copyright (c) 2014 Cisco Systems, Inc. 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
9 package org.opendaylight.groupbasedpolicy.renderer.ofoverlay.flow;
11 import java.util.Collection;
14 import org.opendaylight.groupbasedpolicy.renderer.ofoverlay.OfContext;
15 import org.opendaylight.groupbasedpolicy.renderer.ofoverlay.PolicyManager.FlowMap;
16 import org.opendaylight.groupbasedpolicy.resolver.EgKey;
17 import org.opendaylight.groupbasedpolicy.resolver.PolicyInfo;
18 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv4Prefix;
19 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv6Prefix;
20 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowId;
21 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow;
22 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.FlowBuilder;
23 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.Match;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.MatchBuilder;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.endpoint.rev140421.endpoint.fields.L3Address;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.endpoint.rev140421.endpoints.Endpoint;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.ofoverlay.rev140528.EndpointLocation.LocationType;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.ofoverlay.rev140528.OfOverlayContext;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.Layer3Match;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._3.match.ArpMatchBuilder;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._3.match.Ipv4MatchBuilder;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._3.match.Ipv6MatchBuilder;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.overlay.rev150105.TunnelTypeVxlan;
36 import org.slf4j.Logger;
37 import org.slf4j.LoggerFactory;
40 * Manage the table that enforces port security
43 public class PortSecurity extends FlowTable {
44 protected static final Logger LOG =
45 LoggerFactory.getLogger(PortSecurity.class);
47 public static short TABLE_ID;
49 public PortSecurity(OfContext ctx, short tableId) {
51 this.TABLE_ID=tableId;
55 public short getTableId() {
60 public void sync(NodeId nodeId, PolicyInfo policyInfo, FlowMap flowMap) {
62 // Allow traffic from tunnel ports
63 NodeConnectorId tunnelIf = ctx.getSwitchManager().getTunnelPort(nodeId, TunnelTypeVxlan.class);
65 flowMap.writeFlow(nodeId, TABLE_ID, allowFromPort(tunnelIf));
67 // Allow traffic from tunnel ports
68 //TODO Bug 3546 - Difficult: External port is unrelated to Tenant, L3C, L2BD..
70 Set<NodeConnectorId> external =
71 ctx.getSwitchManager().getExternalPorts(nodeId);
72 for (NodeConnectorId extIf : external) {
73 flowMap.writeFlow(nodeId, TABLE_ID, allowFromExternalPort(extIf));
77 flowMap.writeFlow(nodeId, TABLE_ID, dropFlow(Integer.valueOf(1), null, TABLE_ID));
79 // Drop IP traffic that doesn't match a source IP rule
80 flowMap.writeFlow(nodeId, TABLE_ID, dropFlow(Integer.valueOf(110), FlowUtils.ARP, TABLE_ID));
81 flowMap.writeFlow(nodeId, TABLE_ID, dropFlow(Integer.valueOf(111), FlowUtils.IPv4, TABLE_ID));
82 flowMap.writeFlow(nodeId, TABLE_ID, dropFlow(Integer.valueOf(112), FlowUtils.IPv6, TABLE_ID));
84 for (Endpoint ep : ctx.getEndpointManager().getEndpointsForNode(nodeId)) {
85 OfOverlayContext ofc = ep.getAugmentation(OfOverlayContext.class);
87 if (ofc != null && ofc.getNodeConnectorId() != null
88 && (ofc.getLocationType() == null || LocationType.Internal.equals(ofc.getLocationType()))) {
89 // Allow layer 3 traffic (ARP and IP) with the correct
90 // source IP, MAC, and source port
91 l3flow(flowMap, nodeId, ep, ofc, 120, false);
92 l3flow(flowMap, nodeId, ep, ofc, 121, true);
93 flowMap.writeFlow(nodeId, TABLE_ID, l3DhcpDoraFlow(ep, ofc, 115));
95 // Allow layer 2 traffic with the correct source MAC and
96 // source port (note lower priority than drop IP rules)
97 flowMap.writeFlow(nodeId, TABLE_ID, l2flow(ep, ofc, 100));
102 private Flow allowFromPort(NodeConnectorId port) {
103 Match match = new MatchBuilder()
106 FlowId flowid = FlowIdUtils.newFlowId(TABLE_ID, "allow", match);
107 FlowBuilder flowb = base()
109 .setPriority(Integer.valueOf(200))
111 .setInstructions(FlowUtils.gotoTableInstructions(ctx.getPolicyManager().getTABLEID_SOURCE_MAPPER()));
112 return flowb.build();
115 private Flow allowFromExternalPort(NodeConnectorId port) {
116 Match match = new MatchBuilder()
119 FlowId flowid = FlowIdUtils.newFlowId(TABLE_ID, "allowExternal", match);
120 FlowBuilder flowb = base()
122 .setPriority(Integer.valueOf(200))
124 .setInstructions(FlowUtils.gotoTableInstructions(ctx.getPolicyManager().getTABLEID_INGRESS_NAT()));
125 return flowb.build();
128 private Flow l2flow(Endpoint ep, OfOverlayContext ofc, Integer priority) {
129 Match match = new MatchBuilder()
131 FlowUtils.ethernetMatch(ep.getMacAddress(), null, null))
132 .setInPort(ofc.getNodeConnectorId())
134 FlowId flowid = FlowIdUtils.newFlowId(TABLE_ID, "L2", match);
135 FlowBuilder flowb = base()
136 .setPriority(priority)
139 .setInstructions(FlowUtils.gotoTableInstructions(ctx.getPolicyManager().getTABLEID_SOURCE_MAPPER()));
141 return flowb.build();
144 private Flow l3DhcpDoraFlow(Endpoint ep, OfOverlayContext ofc, Integer priority) {
146 //TODO: Handle IPv6 DORA
147 Long etherType = FlowUtils.IPv4;
148 // DHCP DORA destination is broadcast
149 String ikey = "255.255.255.255/32";
150 Layer3Match m = new Ipv4MatchBuilder().setIpv4Destination(new Ipv4Prefix(ikey)).build();
152 Match match = new MatchBuilder()
154 FlowUtils.ethernetMatch(ep.getMacAddress(),
158 .setInPort(ofc.getNodeConnectorId())
160 FlowId flowid = FlowIdUtils.newFlowId(TABLE_ID, "dhcp", match);
162 .setPriority(priority)
165 .setInstructions(FlowUtils.gotoTableInstructions(ctx.getPolicyManager().getTABLEID_SOURCE_MAPPER()))
171 private void l3flow(FlowMap flowMap, NodeId nodeId,
172 Endpoint ep, OfOverlayContext ofc,
173 Integer priority, boolean arp) {
174 if (ep.getL3Address() == null)
176 for (L3Address l3 : ep.getL3Address()) {
177 if (l3.getIpAddress() == null)
179 Layer3Match m = null;
180 Long etherType = null;
182 if (l3.getIpAddress().getIpv4Address() != null) {
183 ikey = l3.getIpAddress().getIpv4Address().getValue() + "/32";
185 m = new ArpMatchBuilder()
186 .setArpSourceTransportAddress(new Ipv4Prefix(ikey))
188 etherType = FlowUtils.ARP;
190 m = new Ipv4MatchBuilder()
191 .setIpv4Source(new Ipv4Prefix(ikey))
193 etherType = FlowUtils.IPv4;
195 } else if (l3.getIpAddress().getIpv6Address() != null) {
198 ikey = l3.getIpAddress().getIpv6Address().getValue() + "/128";
199 m = new Ipv6MatchBuilder()
200 .setIpv6Source(new Ipv6Prefix(ikey))
202 etherType = FlowUtils.IPv6;
206 Match match = new MatchBuilder()
208 FlowUtils.ethernetMatch(ep.getMacAddress(),
212 .setInPort(ofc.getNodeConnectorId())
214 FlowId flowid = FlowIdUtils.newFlowId(TABLE_ID, "L3", match);
216 .setPriority(priority)
219 .setInstructions(FlowUtils.gotoTableInstructions(ctx.getPolicyManager().getTABLEID_SOURCE_MAPPER()))
222 flowMap.writeFlow(nodeId, TABLE_ID,flow);