Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Foundation |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 3 | * |
| 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 |
| 7 | * |
| 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. |
| 15 | */ |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 16 | package org.onosproject.bgpio.protocol.ver4; |
| 17 | |
| 18 | import java.util.LinkedList; |
| 19 | import java.util.ListIterator; |
| 20 | |
| 21 | import org.jboss.netty.buffer.ChannelBuffer; |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 22 | import org.onosproject.bgpio.exceptions.BgpParseException; |
| 23 | import org.onosproject.bgpio.protocol.BgpMessageReader; |
| 24 | import org.onosproject.bgpio.protocol.BgpMessageWriter; |
| 25 | import org.onosproject.bgpio.protocol.BgpOpenMsg; |
| 26 | import org.onosproject.bgpio.protocol.BgpType; |
| 27 | import org.onosproject.bgpio.protocol.BgpVersion; |
| 28 | import org.onosproject.bgpio.types.BgpErrorType; |
| 29 | import org.onosproject.bgpio.types.BgpHeader; |
| 30 | import org.onosproject.bgpio.types.BgpValueType; |
Vidyashree Rama | f49b22c | 2015-10-13 15:30:24 +0530 | [diff] [blame] | 31 | import org.onosproject.bgpio.types.FourOctetAsNumCapabilityTlv; |
| 32 | import org.onosproject.bgpio.types.MultiProtocolExtnCapabilityTlv; |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 33 | import org.onosproject.bgpio.util.Validation; |
Shashikanth VH | 44967ec | 2016-02-04 19:46:16 +0530 | [diff] [blame] | 34 | import org.onosproject.bgpio.util.Constants; |
Shashikanth VH | b58cfd5 | 2016-04-21 16:45:50 +0530 | [diff] [blame] | 35 | import org.onosproject.bgpio.types.RpdCapabilityTlv; |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 36 | import org.slf4j.Logger; |
| 37 | import org.slf4j.LoggerFactory; |
| 38 | |
| 39 | import com.google.common.base.MoreObjects; |
| 40 | |
| 41 | /** |
| 42 | * Provides BGP open message. |
| 43 | */ |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 44 | public class BgpOpenMsgVer4 implements BgpOpenMsg { |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 45 | |
| 46 | /* |
| 47 | 0 1 2 3 |
| 48 | 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 |
| 49 | +-+-+-+-+-+-+-+-+ |
| 50 | | Version | |
| 51 | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 52 | | My Autonomous System | |
| 53 | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 54 | | Hold Time | |
| 55 | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 56 | | BGP Identifier | |
| 57 | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 58 | | Opt Parm Len | |
| 59 | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 60 | | Optional Parameters (variable) | |
| 61 | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 62 | OPEN Message Format |
| 63 | REFERENCE : RFC 4271 |
| 64 | */ |
| 65 | |
Ray Milkey | 9c9cde4 | 2018-01-12 14:22:06 -0800 | [diff] [blame] | 66 | private static final Logger log = LoggerFactory.getLogger(BgpOpenMsgVer4.class); |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 67 | |
| 68 | public static final byte PACKET_VERSION = 4; |
| 69 | public static final int OPEN_MSG_MINIMUM_LENGTH = 10; |
| 70 | public static final int MSG_HEADER_LENGTH = 19; |
| 71 | public static final int MARKER_LENGTH = 16; |
| 72 | public static final int DEFAULT_HOLD_TIME = 120; |
Vidyashree Rama | f49b22c | 2015-10-13 15:30:24 +0530 | [diff] [blame] | 73 | public static final short AS_TRANS = 23456; |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 74 | public static final int OPT_PARA_TYPE_CAPABILITY = 2; |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 75 | public static final BgpType MSG_TYPE = BgpType.OPEN; |
Vidyashree Rama | f49b22c | 2015-10-13 15:30:24 +0530 | [diff] [blame] | 76 | public static final short AFI = 16388; |
| 77 | public static final byte SAFI = 71; |
| 78 | public static final byte RES = 0; |
| 79 | public static final int FOUR_OCTET_AS_NUM_CAPA_TYPE = 65; |
Ray Milkey | 2e27ec5 | 2018-01-31 17:21:40 -0800 | [diff] [blame^] | 80 | private static final byte[] MARKER = new byte[]{(byte) 0xff, (byte) 0xff, (byte) 0xff, (byte) 0xff, (byte) 0xff, |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 81 | (byte) 0xff, (byte) 0xff, (byte) 0xff, (byte) 0xff, (byte) 0xff, (byte) 0xff, (byte) 0xff, |
| 82 | (byte) 0xff, (byte) 0xff, (byte) 0xff, (byte) 0xff}; |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 83 | public static final BgpHeader DEFAULT_OPEN_HEADER = new BgpHeader(MARKER, |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 84 | (short) OPEN_MSG_MINIMUM_LENGTH, (byte) 0X01); |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 85 | private BgpHeader bgpMsgHeader; |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 86 | private byte version; |
Shashikanth VH | 09792f0 | 2016-05-10 16:59:57 +0530 | [diff] [blame] | 87 | private long asNumber; |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 88 | private short holdTime; |
| 89 | private int bgpId; |
Vidyashree Rama | f49b22c | 2015-10-13 15:30:24 +0530 | [diff] [blame] | 90 | private boolean isLargeAsCapabilitySet; |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 91 | private LinkedList<BgpValueType> capabilityTlv; |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 92 | |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 93 | public static final BgpOpenMsgVer4.Reader READER = new Reader(); |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 94 | |
| 95 | /** |
| 96 | * reset variables. |
| 97 | */ |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 98 | public BgpOpenMsgVer4() { |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 99 | this.bgpMsgHeader = null; |
| 100 | this.version = 0; |
| 101 | this.holdTime = 0; |
| 102 | this.asNumber = 0; |
| 103 | this.bgpId = 0; |
| 104 | this.capabilityTlv = null; |
| 105 | } |
| 106 | |
| 107 | /** |
| 108 | * Constructor to initialize all variables of BGP Open message. |
| 109 | * |
Vidyashree Rama | f49b22c | 2015-10-13 15:30:24 +0530 | [diff] [blame] | 110 | * @param bgpMsgHeader BGP Header in open message |
| 111 | * @param version BGP version in open message |
| 112 | * @param holdTime hold time in open message |
| 113 | * @param asNumber AS number in open message |
| 114 | * @param bgpId BGP identifier in open message |
| 115 | * @param capabilityTlv capabilities in open message |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 116 | */ |
Shashikanth VH | 09792f0 | 2016-05-10 16:59:57 +0530 | [diff] [blame] | 117 | public BgpOpenMsgVer4(BgpHeader bgpMsgHeader, byte version, long asNumber, short holdTime, |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 118 | int bgpId, LinkedList<BgpValueType> capabilityTlv) { |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 119 | this.bgpMsgHeader = bgpMsgHeader; |
| 120 | this.version = version; |
| 121 | this.asNumber = asNumber; |
| 122 | this.holdTime = holdTime; |
| 123 | this.bgpId = bgpId; |
| 124 | this.capabilityTlv = capabilityTlv; |
| 125 | } |
| 126 | |
| 127 | @Override |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 128 | public BgpHeader getHeader() { |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 129 | return this.bgpMsgHeader; |
| 130 | } |
| 131 | |
| 132 | @Override |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 133 | public BgpVersion getVersion() { |
| 134 | return BgpVersion.BGP_4; |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 135 | } |
| 136 | |
| 137 | @Override |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 138 | public BgpType getType() { |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 139 | return MSG_TYPE; |
| 140 | } |
| 141 | |
| 142 | @Override |
| 143 | public short getHoldTime() { |
| 144 | return this.holdTime; |
| 145 | } |
| 146 | |
| 147 | @Override |
Shashikanth VH | 09792f0 | 2016-05-10 16:59:57 +0530 | [diff] [blame] | 148 | public long getAsNumber() { |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 149 | return this.asNumber; |
| 150 | } |
| 151 | |
| 152 | @Override |
| 153 | public int getBgpId() { |
| 154 | return this.bgpId; |
| 155 | } |
| 156 | |
| 157 | @Override |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 158 | public LinkedList<BgpValueType> getCapabilityTlv() { |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 159 | return this.capabilityTlv; |
| 160 | } |
| 161 | |
| 162 | /** |
| 163 | * Reader class for reading BGP open message from channel buffer. |
| 164 | */ |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 165 | public static class Reader implements BgpMessageReader<BgpOpenMsg> { |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 166 | |
| 167 | @Override |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 168 | public BgpOpenMsg readFrom(ChannelBuffer cb, BgpHeader bgpHeader) throws BgpParseException { |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 169 | |
| 170 | byte version; |
| 171 | short holdTime; |
Shashikanth VH | 09792f0 | 2016-05-10 16:59:57 +0530 | [diff] [blame] | 172 | long asNumber; |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 173 | int bgpId; |
| 174 | byte optParaLen = 0; |
| 175 | byte optParaType; |
| 176 | byte capParaLen = 0; |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 177 | LinkedList<BgpValueType> capabilityTlv = new LinkedList<>(); |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 178 | |
| 179 | if (cb.readableBytes() < OPEN_MSG_MINIMUM_LENGTH) { |
| 180 | log.error("[readFrom] Invalid length: Packet size is less than the minimum length "); |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 181 | Validation.validateLen(BgpErrorType.OPEN_MESSAGE_ERROR, BgpErrorType.BAD_MESSAGE_LENGTH, |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 182 | cb.readableBytes()); |
| 183 | } |
| 184 | |
| 185 | // Read version |
| 186 | version = cb.readByte(); |
| 187 | if (version != PACKET_VERSION) { |
| 188 | log.error("[readFrom] Invalid version: " + version); |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 189 | throw new BgpParseException(BgpErrorType.OPEN_MESSAGE_ERROR, |
| 190 | BgpErrorType.UNSUPPORTED_VERSION_NUMBER, null); |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 191 | } |
| 192 | |
| 193 | // Read AS number |
Shashikanth VH | 09792f0 | 2016-05-10 16:59:57 +0530 | [diff] [blame] | 194 | asNumber = cb.getUnsignedShort(cb.readerIndex()); |
| 195 | cb.readShort(); |
mohamedrahil | 00f6f26 | 2016-11-24 20:20:41 +0530 | [diff] [blame] | 196 | log.debug("AS number read"); |
| 197 | |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 198 | // Read Hold timer |
| 199 | holdTime = cb.readShort(); |
mohamedrahil | 00f6f26 | 2016-11-24 20:20:41 +0530 | [diff] [blame] | 200 | log.debug("Holding time read"); |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 201 | |
| 202 | // Read BGP Identifier |
| 203 | bgpId = cb.readInt(); |
mohamedrahil | 00f6f26 | 2016-11-24 20:20:41 +0530 | [diff] [blame] | 204 | log.debug("BGP identifier read"); |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 205 | |
| 206 | // Read optional parameter length |
| 207 | optParaLen = cb.readByte(); |
mohamedrahil | 00f6f26 | 2016-11-24 20:20:41 +0530 | [diff] [blame] | 208 | log.debug("OPtional parameter length read"); |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 209 | |
| 210 | // Read Capabilities if optional parameter length is greater than 0 |
| 211 | if (optParaLen != 0) { |
Shashikanth VH | 3479fd4 | 2017-11-15 11:45:09 +0530 | [diff] [blame] | 212 | while (cb.readableBytes() > 0) { |
| 213 | // Read optional parameter type |
| 214 | optParaType = cb.readByte(); |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 215 | |
Shashikanth VH | 3479fd4 | 2017-11-15 11:45:09 +0530 | [diff] [blame] | 216 | // Read optional parameter length |
| 217 | capParaLen = cb.readByte(); |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 218 | |
Shashikanth VH | 3479fd4 | 2017-11-15 11:45:09 +0530 | [diff] [blame] | 219 | if (cb.readableBytes() < capParaLen) { |
| 220 | throw new BgpParseException(BgpErrorType.OPEN_MESSAGE_ERROR, (byte) 0, null); |
| 221 | } |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 222 | |
Shashikanth VH | 3479fd4 | 2017-11-15 11:45:09 +0530 | [diff] [blame] | 223 | ChannelBuffer capaCb = cb.readBytes(capParaLen); |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 224 | |
Shashikanth VH | 3479fd4 | 2017-11-15 11:45:09 +0530 | [diff] [blame] | 225 | // Parse capabilities only if optional parameter type is 2 |
| 226 | if ((optParaType == OPT_PARA_TYPE_CAPABILITY) && (capParaLen != 0)) { |
| 227 | capabilityTlv = parseCapabilityTlv(capaCb); |
| 228 | } else { |
| 229 | throw new BgpParseException(BgpErrorType.OPEN_MESSAGE_ERROR, |
| 230 | BgpErrorType.UNSUPPORTED_OPTIONAL_PARAMETER, null); |
| 231 | } |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 232 | } |
| 233 | } |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 234 | return new BgpOpenMsgVer4(bgpHeader, version, asNumber, holdTime, bgpId, capabilityTlv); |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 235 | } |
| 236 | } |
| 237 | |
| 238 | /** |
| 239 | * Parsing capabilities. |
| 240 | * |
| 241 | * @param cb of type channel buffer |
| 242 | * @return capabilityTlv of open message |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 243 | * @throws BgpParseException while parsing capabilities |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 244 | */ |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 245 | protected static LinkedList<BgpValueType> parseCapabilityTlv(ChannelBuffer cb) throws BgpParseException { |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 246 | |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 247 | LinkedList<BgpValueType> capabilityTlv = new LinkedList<>(); |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 248 | |
Vidyashree Rama | f49b22c | 2015-10-13 15:30:24 +0530 | [diff] [blame] | 249 | while (cb.readableBytes() > 0) { |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 250 | BgpValueType tlv; |
Vidyashree Rama | f49b22c | 2015-10-13 15:30:24 +0530 | [diff] [blame] | 251 | short type = cb.readByte(); |
| 252 | short length = cb.readByte(); |
| 253 | |
| 254 | switch (type) { |
| 255 | case FourOctetAsNumCapabilityTlv.TYPE: |
| 256 | log.debug("FourOctetAsNumCapabilityTlv"); |
| 257 | if (FourOctetAsNumCapabilityTlv.LENGTH != length) { |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 258 | throw new BgpParseException("Invalid length received for FourOctetAsNumCapabilityTlv."); |
Vidyashree Rama | f49b22c | 2015-10-13 15:30:24 +0530 | [diff] [blame] | 259 | } |
| 260 | if (length > cb.readableBytes()) { |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 261 | throw new BgpParseException("Four octet as num tlv length" |
Vidyashree Rama | f49b22c | 2015-10-13 15:30:24 +0530 | [diff] [blame] | 262 | + " is more than readableBytes."); |
| 263 | } |
| 264 | int as4Num = cb.readInt(); |
| 265 | tlv = new FourOctetAsNumCapabilityTlv(as4Num); |
| 266 | break; |
Shashikanth VH | b58cfd5 | 2016-04-21 16:45:50 +0530 | [diff] [blame] | 267 | case RpdCapabilityTlv.TYPE: |
| 268 | log.debug("RpdCapability"); |
| 269 | if (RpdCapabilityTlv.LENGTH != length) { |
| 270 | throw new BgpParseException("Invalid length received for RpdCapability."); |
| 271 | } |
| 272 | if (length > cb.readableBytes()) { |
mohamedrahil | 00f6f26 | 2016-11-24 20:20:41 +0530 | [diff] [blame] | 273 | throw new BgpParseException("Four octet as num TLV length" |
Shashikanth VH | b58cfd5 | 2016-04-21 16:45:50 +0530 | [diff] [blame] | 274 | + " is more than readableBytes."); |
| 275 | } |
| 276 | short rpdAfi = cb.readShort(); |
| 277 | byte rpdAsafi = cb.readByte(); |
| 278 | byte sendReceive = cb.readByte(); |
| 279 | tlv = new RpdCapabilityTlv(sendReceive); |
| 280 | break; |
| 281 | |
Vidyashree Rama | f49b22c | 2015-10-13 15:30:24 +0530 | [diff] [blame] | 282 | case MultiProtocolExtnCapabilityTlv.TYPE: |
| 283 | log.debug("MultiProtocolExtnCapabilityTlv"); |
Shashikanth VH | b650bfa | 2016-04-18 12:54:03 +0530 | [diff] [blame] | 284 | |
Shashikanth VH | b58cfd5 | 2016-04-21 16:45:50 +0530 | [diff] [blame] | 285 | if (MultiProtocolExtnCapabilityTlv.LENGTH != length) { |
| 286 | throw new BgpParseException("Invalid length received for MultiProtocolExtnCapabilityTlv."); |
| 287 | } |
| 288 | |
Vidyashree Rama | f49b22c | 2015-10-13 15:30:24 +0530 | [diff] [blame] | 289 | if (length > cb.readableBytes()) { |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 290 | throw new BgpParseException("BGP LS tlv length is more than readableBytes."); |
Vidyashree Rama | f49b22c | 2015-10-13 15:30:24 +0530 | [diff] [blame] | 291 | } |
| 292 | short afi = cb.readShort(); |
| 293 | byte res = cb.readByte(); |
| 294 | byte safi = cb.readByte(); |
Shashikanth VH | b58cfd5 | 2016-04-21 16:45:50 +0530 | [diff] [blame] | 295 | tlv = new MultiProtocolExtnCapabilityTlv(afi, res, safi); |
| 296 | |
Vidyashree Rama | f49b22c | 2015-10-13 15:30:24 +0530 | [diff] [blame] | 297 | break; |
| 298 | default: |
| 299 | log.debug("Warning: Unsupported TLV: " + type); |
| 300 | cb.skipBytes(length); |
| 301 | continue; |
| 302 | } |
| 303 | capabilityTlv.add(tlv); |
| 304 | } |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 305 | return capabilityTlv; |
| 306 | } |
| 307 | |
| 308 | /** |
| 309 | * Builder class for BGP open message. |
| 310 | */ |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 311 | static class Builder implements BgpOpenMsg.Builder { |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 312 | |
| 313 | private boolean isHeaderSet = false; |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 314 | private BgpHeader bgpMsgHeader; |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 315 | private boolean isHoldTimeSet = false; |
Vidyashree Rama | f49b22c | 2015-10-13 15:30:24 +0530 | [diff] [blame] | 316 | private short holdTime; |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 317 | private boolean isAsNumSet = false; |
| 318 | private short asNumber; |
| 319 | private boolean isBgpIdSet = false; |
| 320 | private int bgpId; |
Shashikanth VH | f04ab49 | 2016-02-10 11:35:11 +0530 | [diff] [blame] | 321 | private boolean isIpV4UnicastCapabilityTlvSet = true; |
Vidyashree Rama | f49b22c | 2015-10-13 15:30:24 +0530 | [diff] [blame] | 322 | private boolean isLargeAsCapabilityTlvSet = false; |
| 323 | private boolean isLsCapabilityTlvSet = false; |
Shashikanth VH | 44967ec | 2016-02-04 19:46:16 +0530 | [diff] [blame] | 324 | private boolean isFlowSpecCapabilityTlvSet = false; |
| 325 | private boolean isVpnFlowSpecCapabilityTlvSet = false; |
Shashikanth VH | b650bfa | 2016-04-18 12:54:03 +0530 | [diff] [blame] | 326 | private boolean isFlowSpecRpdCapabilityTlvSet = false; |
Mohammad Shahid | 30fedc5 | 2017-08-09 11:49:40 +0530 | [diff] [blame] | 327 | private boolean isEvpnCapabilityTlvSet = false; |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 328 | |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 329 | LinkedList<BgpValueType> capabilityTlv = new LinkedList<>(); |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 330 | |
| 331 | @Override |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 332 | public BgpOpenMsg build() throws BgpParseException { |
| 333 | BgpHeader bgpMsgHeader = this.isHeaderSet ? this.bgpMsgHeader : DEFAULT_OPEN_HEADER; |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 334 | short holdTime = this.isHoldTimeSet ? this.holdTime : DEFAULT_HOLD_TIME; |
| 335 | |
| 336 | if (!this.isAsNumSet) { |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 337 | throw new BgpParseException("BGP AS number is not set (mandatory)"); |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 338 | } |
| 339 | |
| 340 | if (!this.isBgpIdSet) { |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 341 | throw new BgpParseException("BGPID is not set (mandatory)"); |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 342 | } |
| 343 | |
Shashikanth VH | f04ab49 | 2016-02-10 11:35:11 +0530 | [diff] [blame] | 344 | if (this.isIpV4UnicastCapabilityTlvSet) { |
| 345 | BgpValueType tlv; |
| 346 | tlv = new MultiProtocolExtnCapabilityTlv((short) Constants.AFI_IPV4_UNICAST, RES, |
| 347 | (byte) Constants.SAFI_IPV4_UNICAST); |
| 348 | this.capabilityTlv.add(tlv); |
| 349 | } |
| 350 | |
Vidyashree Rama | f49b22c | 2015-10-13 15:30:24 +0530 | [diff] [blame] | 351 | if (this.isLargeAsCapabilityTlvSet) { |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 352 | BgpValueType tlv; |
Vidyashree Rama | afbbff9 | 2015-11-02 14:45:17 +0530 | [diff] [blame] | 353 | int value = this.asNumber; |
| 354 | tlv = new FourOctetAsNumCapabilityTlv(value); |
Vidyashree Rama | f49b22c | 2015-10-13 15:30:24 +0530 | [diff] [blame] | 355 | this.capabilityTlv.add(tlv); |
| 356 | } |
| 357 | |
| 358 | if (this.isLsCapabilityTlvSet) { |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 359 | BgpValueType tlv; |
Vidyashree Rama | f49b22c | 2015-10-13 15:30:24 +0530 | [diff] [blame] | 360 | tlv = new MultiProtocolExtnCapabilityTlv(AFI, RES, SAFI); |
| 361 | this.capabilityTlv.add(tlv); |
| 362 | } |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 363 | |
Shashikanth VH | 44967ec | 2016-02-04 19:46:16 +0530 | [diff] [blame] | 364 | if (this.isFlowSpecCapabilityTlvSet) { |
| 365 | BgpValueType tlv; |
| 366 | tlv = new MultiProtocolExtnCapabilityTlv(Constants.AFI_FLOWSPEC_VALUE, |
| 367 | RES, Constants.SAFI_FLOWSPEC_VALUE); |
| 368 | this.capabilityTlv.add(tlv); |
| 369 | } |
| 370 | |
| 371 | if (this.isVpnFlowSpecCapabilityTlvSet) { |
| 372 | BgpValueType tlv; |
| 373 | tlv = new MultiProtocolExtnCapabilityTlv(Constants.AFI_FLOWSPEC_VALUE, |
| 374 | RES, Constants.VPN_SAFI_FLOWSPEC_VALUE); |
| 375 | this.capabilityTlv.add(tlv); |
| 376 | } |
| 377 | |
Shashikanth VH | b650bfa | 2016-04-18 12:54:03 +0530 | [diff] [blame] | 378 | if (this.isFlowSpecRpdCapabilityTlvSet) { |
| 379 | BgpValueType tlv; |
Shashikanth VH | b58cfd5 | 2016-04-21 16:45:50 +0530 | [diff] [blame] | 380 | tlv = new RpdCapabilityTlv(Constants.RPD_CAPABILITY_SEND_VALUE); |
Shashikanth VH | b650bfa | 2016-04-18 12:54:03 +0530 | [diff] [blame] | 381 | this.capabilityTlv.add(tlv); |
| 382 | } |
| 383 | |
Mohammad Shahid | 30fedc5 | 2017-08-09 11:49:40 +0530 | [diff] [blame] | 384 | if (this.isEvpnCapabilityTlvSet) { |
| 385 | BgpValueType tlv; |
| 386 | tlv = new MultiProtocolExtnCapabilityTlv(Constants.AFI_EVPN_VALUE, |
| 387 | RES, Constants.SAFI_EVPN_VALUE); |
| 388 | this.capabilityTlv.add(tlv); |
| 389 | } |
Shashikanth VH | b650bfa | 2016-04-18 12:54:03 +0530 | [diff] [blame] | 390 | |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 391 | return new BgpOpenMsgVer4(bgpMsgHeader, PACKET_VERSION, this.asNumber, holdTime, this.bgpId, |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 392 | this.capabilityTlv); |
| 393 | } |
| 394 | |
| 395 | @Override |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 396 | public Builder setHeader(BgpHeader bgpMsgHeader) { |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 397 | this.bgpMsgHeader = bgpMsgHeader; |
| 398 | return this; |
| 399 | } |
| 400 | |
| 401 | @Override |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 402 | public Builder setHoldTime(short holdTime) { |
| 403 | this.holdTime = holdTime; |
| 404 | this.isHoldTimeSet = true; |
| 405 | return this; |
| 406 | } |
| 407 | |
| 408 | @Override |
| 409 | public Builder setAsNumber(short asNumber) { |
| 410 | this.asNumber = asNumber; |
| 411 | this.isAsNumSet = true; |
| 412 | return this; |
| 413 | } |
| 414 | |
| 415 | @Override |
| 416 | public Builder setBgpId(int bgpId) { |
| 417 | this.bgpId = bgpId; |
| 418 | this.isBgpIdSet = true; |
| 419 | return this; |
| 420 | } |
| 421 | |
| 422 | @Override |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 423 | public Builder setCapabilityTlv(LinkedList<BgpValueType> capabilityTlv) { |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 424 | this.capabilityTlv = capabilityTlv; |
| 425 | return this; |
| 426 | } |
Vidyashree Rama | f49b22c | 2015-10-13 15:30:24 +0530 | [diff] [blame] | 427 | |
| 428 | @Override |
| 429 | public Builder setLargeAsCapabilityTlv(boolean isLargeAsCapabilitySet) { |
| 430 | this.isLargeAsCapabilityTlvSet = isLargeAsCapabilitySet; |
| 431 | return this; |
| 432 | } |
| 433 | |
| 434 | @Override |
| 435 | public Builder setLsCapabilityTlv(boolean isLsCapabilitySet) { |
| 436 | this.isLsCapabilityTlvSet = isLsCapabilitySet; |
| 437 | return this; |
| 438 | } |
Shashikanth VH | 44967ec | 2016-02-04 19:46:16 +0530 | [diff] [blame] | 439 | |
| 440 | @Override |
| 441 | public Builder setFlowSpecCapabilityTlv(boolean isFlowSpecCapabilitySet) { |
| 442 | this.isFlowSpecCapabilityTlvSet = isFlowSpecCapabilitySet; |
| 443 | return this; |
| 444 | } |
| 445 | |
| 446 | @Override |
| 447 | public Builder setVpnFlowSpecCapabilityTlv(boolean isVpnFlowSpecCapabilitySet) { |
| 448 | this.isVpnFlowSpecCapabilityTlvSet = isVpnFlowSpecCapabilitySet; |
| 449 | return this; |
| 450 | } |
Shashikanth VH | b650bfa | 2016-04-18 12:54:03 +0530 | [diff] [blame] | 451 | |
| 452 | @Override |
| 453 | public Builder setFlowSpecRpdCapabilityTlv(boolean isFlowSpecRpdCapabilityTlvSet) { |
| 454 | this.isFlowSpecRpdCapabilityTlvSet = isFlowSpecRpdCapabilityTlvSet; |
| 455 | return this; |
| 456 | } |
Mohammad Shahid | 30fedc5 | 2017-08-09 11:49:40 +0530 | [diff] [blame] | 457 | |
| 458 | @Override |
| 459 | public Builder setEvpnCapabilityTlv(boolean isEvpnCapabilitySet) { |
| 460 | this.isEvpnCapabilityTlvSet = isEvpnCapabilitySet; |
| 461 | return this; |
| 462 | } |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 463 | } |
| 464 | |
| 465 | @Override |
| 466 | public void writeTo(ChannelBuffer cb) { |
| 467 | try { |
| 468 | WRITER.write(cb, this); |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 469 | } catch (BgpParseException e) { |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 470 | log.debug("[writeTo] Error: " + e.toString()); |
| 471 | } |
| 472 | } |
| 473 | |
| 474 | public static final Writer WRITER = new Writer(); |
| 475 | |
| 476 | /** |
| 477 | * Writer class for writing BGP open message to channel buffer. |
| 478 | */ |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 479 | public static class Writer implements BgpMessageWriter<BgpOpenMsgVer4> { |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 480 | |
| 481 | @Override |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 482 | public void write(ChannelBuffer cb, BgpOpenMsgVer4 message) throws BgpParseException { |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 483 | |
| 484 | int optParaLen = 0; |
Vidyashree Rama | f49b22c | 2015-10-13 15:30:24 +0530 | [diff] [blame] | 485 | int as4num = 0; |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 486 | |
| 487 | int startIndex = cb.writerIndex(); |
| 488 | |
| 489 | // write common header and get msg length index |
| 490 | int msgLenIndex = message.bgpMsgHeader.write(cb); |
| 491 | |
| 492 | if (msgLenIndex <= 0) { |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 493 | throw new BgpParseException("Unable to write message header."); |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 494 | } |
| 495 | |
| 496 | // write version in 1-octet |
| 497 | cb.writeByte(message.version); |
| 498 | |
Vidyashree Rama | f49b22c | 2015-10-13 15:30:24 +0530 | [diff] [blame] | 499 | // get as4num if LS Capability is set |
| 500 | if (message.isLargeAsCapabilitySet) { |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 501 | LinkedList<BgpValueType> capabilityTlv = message |
Vidyashree Rama | f49b22c | 2015-10-13 15:30:24 +0530 | [diff] [blame] | 502 | .getCapabilityTlv(); |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 503 | ListIterator<BgpValueType> listIterator = capabilityTlv |
Vidyashree Rama | f49b22c | 2015-10-13 15:30:24 +0530 | [diff] [blame] | 504 | .listIterator(); |
| 505 | |
| 506 | while (listIterator.hasNext()) { |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 507 | BgpValueType tlv = listIterator.next(); |
Vidyashree Rama | f49b22c | 2015-10-13 15:30:24 +0530 | [diff] [blame] | 508 | if (tlv.getType() == FOUR_OCTET_AS_NUM_CAPA_TYPE) { |
| 509 | as4num = ((FourOctetAsNumCapabilityTlv) tlv).getInt(); |
| 510 | break; |
| 511 | } |
| 512 | } |
| 513 | } |
| 514 | |
| 515 | if ((message.isLargeAsCapabilitySet) && (as4num > 65535)) { |
| 516 | // write As number as AS_TRANS |
| 517 | cb.writeShort(AS_TRANS); |
| 518 | } else { |
| 519 | // write AS number in next 2-octet |
Shashikanth VH | 09792f0 | 2016-05-10 16:59:57 +0530 | [diff] [blame] | 520 | cb.writeShort((short) message.asNumber); |
Vidyashree Rama | f49b22c | 2015-10-13 15:30:24 +0530 | [diff] [blame] | 521 | } |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 522 | |
| 523 | // write HoldTime in next 2-octet |
| 524 | cb.writeShort(message.holdTime); |
| 525 | |
| 526 | // write BGP Identifier in next 4-octet |
| 527 | cb.writeInt(message.bgpId); |
| 528 | |
| 529 | // store the index of Optional parameter length |
| 530 | int optParaLenIndex = cb.writerIndex(); |
| 531 | |
| 532 | // set optional parameter length as 0 |
| 533 | cb.writeByte(0); |
| 534 | |
| 535 | // Pack capability TLV |
| 536 | optParaLen = message.packCapabilityTlv(cb, message); |
| 537 | |
| 538 | if (optParaLen != 0) { |
| 539 | // Update optional parameter length |
| 540 | cb.setByte(optParaLenIndex, (byte) (optParaLen + 2)); //+2 for optional parameter type. |
| 541 | } |
| 542 | |
| 543 | // write OPEN Object Length |
| 544 | int length = cb.writerIndex() - startIndex; |
| 545 | cb.setShort(msgLenIndex, (short) length); |
| 546 | message.bgpMsgHeader.setLength((short) length); |
| 547 | } |
| 548 | } |
| 549 | |
| 550 | /** |
| 551 | * returns length of capability tlvs. |
| 552 | * |
| 553 | * @param cb of type channel buffer |
| 554 | * @param message of type BGPOpenMsgVer4 |
| 555 | * @return capParaLen of open message |
| 556 | */ |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 557 | protected int packCapabilityTlv(ChannelBuffer cb, BgpOpenMsgVer4 message) { |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 558 | int startIndex = cb.writerIndex(); |
| 559 | int capParaLen = 0; |
| 560 | int capParaLenIndex = 0; |
| 561 | |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 562 | LinkedList<BgpValueType> capabilityTlv = message.capabilityTlv; |
| 563 | ListIterator<BgpValueType> listIterator = capabilityTlv.listIterator(); |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 564 | |
| 565 | if (listIterator.hasNext()) { |
| 566 | // Set optional parameter type as 2 |
| 567 | cb.writeByte(OPT_PARA_TYPE_CAPABILITY); |
| 568 | |
| 569 | // Store the index of capability parameter length and update length at the end |
| 570 | capParaLenIndex = cb.writerIndex(); |
| 571 | |
| 572 | // Set capability parameter length as 0 |
| 573 | cb.writeByte(0); |
| 574 | |
| 575 | // Update the startIndex to know the length of capability tlv |
| 576 | startIndex = cb.writerIndex(); |
| 577 | } |
| 578 | |
| 579 | while (listIterator.hasNext()) { |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 580 | BgpValueType tlv = listIterator.next(); |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 581 | if (tlv == null) { |
mohamedrahil | 00f6f26 | 2016-11-24 20:20:41 +0530 | [diff] [blame] | 582 | log.debug("Warning: TLV is null from CapabilityTlv list"); |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 583 | continue; |
| 584 | } |
| 585 | tlv.write(cb); |
| 586 | } |
| 587 | |
| 588 | capParaLen = cb.writerIndex() - startIndex; |
| 589 | |
| 590 | if (capParaLen != 0) { |
| 591 | // Update capability parameter length |
| 592 | cb.setByte(capParaLenIndex, (byte) capParaLen); |
| 593 | } |
| 594 | return capParaLen; |
| 595 | } |
| 596 | |
| 597 | @Override |
| 598 | public String toString() { |
| 599 | return MoreObjects.toStringHelper(getClass()) |
| 600 | .add("bgpMsgHeader", bgpMsgHeader) |
| 601 | .add("version", version) |
| 602 | .add("holdTime", holdTime) |
| 603 | .add("asNumber", asNumber) |
| 604 | .add("bgpId", bgpId) |
| 605 | .add("capabilityTlv", capabilityTlv) |
| 606 | .toString(); |
| 607 | } |
| 608 | } |