Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 1 | /* |
Brian O'Connor | 5ab426f | 2016-04-09 01:19:45 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Laboratory |
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 | |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 66 | protected 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; |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 80 | public static final byte[] MARKER = new byte[]{(byte) 0xff, (byte) 0xff, (byte) 0xff, (byte) 0xff, (byte) 0xff, |
| 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(); |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 196 | // Read Hold timer |
| 197 | holdTime = cb.readShort(); |
| 198 | |
| 199 | // Read BGP Identifier |
| 200 | bgpId = cb.readInt(); |
| 201 | |
| 202 | // Read optional parameter length |
| 203 | optParaLen = cb.readByte(); |
| 204 | |
| 205 | // Read Capabilities if optional parameter length is greater than 0 |
| 206 | if (optParaLen != 0) { |
| 207 | // Read optional parameter type |
| 208 | optParaType = cb.readByte(); |
| 209 | |
| 210 | // Read optional parameter length |
| 211 | capParaLen = cb.readByte(); |
| 212 | |
| 213 | if (cb.readableBytes() < capParaLen) { |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 214 | throw new BgpParseException(BgpErrorType.OPEN_MESSAGE_ERROR, (byte) 0, null); |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 215 | } |
| 216 | |
| 217 | ChannelBuffer capaCb = cb.readBytes(capParaLen); |
| 218 | |
| 219 | // Parse capabilities only if optional parameter type is 2 |
| 220 | if ((optParaType == OPT_PARA_TYPE_CAPABILITY) && (capParaLen != 0)) { |
| 221 | capabilityTlv = parseCapabilityTlv(capaCb); |
| 222 | } else { |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 223 | throw new BgpParseException(BgpErrorType.OPEN_MESSAGE_ERROR, |
| 224 | BgpErrorType.UNSUPPORTED_OPTIONAL_PARAMETER, null); |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 225 | } |
| 226 | } |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 227 | return new BgpOpenMsgVer4(bgpHeader, version, asNumber, holdTime, bgpId, capabilityTlv); |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 228 | } |
| 229 | } |
| 230 | |
| 231 | /** |
| 232 | * Parsing capabilities. |
| 233 | * |
| 234 | * @param cb of type channel buffer |
| 235 | * @return capabilityTlv of open message |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 236 | * @throws BgpParseException while parsing capabilities |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 237 | */ |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 238 | protected static LinkedList<BgpValueType> parseCapabilityTlv(ChannelBuffer cb) throws BgpParseException { |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 239 | |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 240 | LinkedList<BgpValueType> capabilityTlv = new LinkedList<>(); |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 241 | |
Vidyashree Rama | f49b22c | 2015-10-13 15:30:24 +0530 | [diff] [blame] | 242 | while (cb.readableBytes() > 0) { |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 243 | BgpValueType tlv; |
Vidyashree Rama | f49b22c | 2015-10-13 15:30:24 +0530 | [diff] [blame] | 244 | short type = cb.readByte(); |
| 245 | short length = cb.readByte(); |
| 246 | |
| 247 | switch (type) { |
| 248 | case FourOctetAsNumCapabilityTlv.TYPE: |
| 249 | log.debug("FourOctetAsNumCapabilityTlv"); |
| 250 | if (FourOctetAsNumCapabilityTlv.LENGTH != length) { |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 251 | throw new BgpParseException("Invalid length received for FourOctetAsNumCapabilityTlv."); |
Vidyashree Rama | f49b22c | 2015-10-13 15:30:24 +0530 | [diff] [blame] | 252 | } |
| 253 | if (length > cb.readableBytes()) { |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 254 | throw new BgpParseException("Four octet as num tlv length" |
Vidyashree Rama | f49b22c | 2015-10-13 15:30:24 +0530 | [diff] [blame] | 255 | + " is more than readableBytes."); |
| 256 | } |
| 257 | int as4Num = cb.readInt(); |
| 258 | tlv = new FourOctetAsNumCapabilityTlv(as4Num); |
| 259 | break; |
Shashikanth VH | b58cfd5 | 2016-04-21 16:45:50 +0530 | [diff] [blame] | 260 | case RpdCapabilityTlv.TYPE: |
| 261 | log.debug("RpdCapability"); |
| 262 | if (RpdCapabilityTlv.LENGTH != length) { |
| 263 | throw new BgpParseException("Invalid length received for RpdCapability."); |
| 264 | } |
| 265 | if (length > cb.readableBytes()) { |
| 266 | throw new BgpParseException("Four octet as num tlv length" |
| 267 | + " is more than readableBytes."); |
| 268 | } |
| 269 | short rpdAfi = cb.readShort(); |
| 270 | byte rpdAsafi = cb.readByte(); |
| 271 | byte sendReceive = cb.readByte(); |
| 272 | tlv = new RpdCapabilityTlv(sendReceive); |
| 273 | break; |
| 274 | |
Vidyashree Rama | f49b22c | 2015-10-13 15:30:24 +0530 | [diff] [blame] | 275 | case MultiProtocolExtnCapabilityTlv.TYPE: |
| 276 | log.debug("MultiProtocolExtnCapabilityTlv"); |
Shashikanth VH | b650bfa | 2016-04-18 12:54:03 +0530 | [diff] [blame] | 277 | |
Shashikanth VH | b58cfd5 | 2016-04-21 16:45:50 +0530 | [diff] [blame] | 278 | if (MultiProtocolExtnCapabilityTlv.LENGTH != length) { |
| 279 | throw new BgpParseException("Invalid length received for MultiProtocolExtnCapabilityTlv."); |
| 280 | } |
| 281 | |
Vidyashree Rama | f49b22c | 2015-10-13 15:30:24 +0530 | [diff] [blame] | 282 | if (length > cb.readableBytes()) { |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 283 | throw new BgpParseException("BGP LS tlv length is more than readableBytes."); |
Vidyashree Rama | f49b22c | 2015-10-13 15:30:24 +0530 | [diff] [blame] | 284 | } |
| 285 | short afi = cb.readShort(); |
| 286 | byte res = cb.readByte(); |
| 287 | byte safi = cb.readByte(); |
Shashikanth VH | b58cfd5 | 2016-04-21 16:45:50 +0530 | [diff] [blame] | 288 | tlv = new MultiProtocolExtnCapabilityTlv(afi, res, safi); |
| 289 | |
Vidyashree Rama | f49b22c | 2015-10-13 15:30:24 +0530 | [diff] [blame] | 290 | break; |
| 291 | default: |
| 292 | log.debug("Warning: Unsupported TLV: " + type); |
| 293 | cb.skipBytes(length); |
| 294 | continue; |
| 295 | } |
| 296 | capabilityTlv.add(tlv); |
| 297 | } |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 298 | return capabilityTlv; |
| 299 | } |
| 300 | |
| 301 | /** |
| 302 | * Builder class for BGP open message. |
| 303 | */ |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 304 | static class Builder implements BgpOpenMsg.Builder { |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 305 | |
| 306 | private boolean isHeaderSet = false; |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 307 | private BgpHeader bgpMsgHeader; |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 308 | private boolean isHoldTimeSet = false; |
Vidyashree Rama | f49b22c | 2015-10-13 15:30:24 +0530 | [diff] [blame] | 309 | private short holdTime; |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 310 | private boolean isAsNumSet = false; |
| 311 | private short asNumber; |
| 312 | private boolean isBgpIdSet = false; |
| 313 | private int bgpId; |
Shashikanth VH | f04ab49 | 2016-02-10 11:35:11 +0530 | [diff] [blame] | 314 | private boolean isIpV4UnicastCapabilityTlvSet = true; |
Vidyashree Rama | f49b22c | 2015-10-13 15:30:24 +0530 | [diff] [blame] | 315 | private boolean isLargeAsCapabilityTlvSet = false; |
| 316 | private boolean isLsCapabilityTlvSet = false; |
Shashikanth VH | 44967ec | 2016-02-04 19:46:16 +0530 | [diff] [blame] | 317 | private boolean isFlowSpecCapabilityTlvSet = false; |
| 318 | private boolean isVpnFlowSpecCapabilityTlvSet = false; |
Shashikanth VH | b650bfa | 2016-04-18 12:54:03 +0530 | [diff] [blame] | 319 | private boolean isFlowSpecRpdCapabilityTlvSet = false; |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 320 | |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 321 | LinkedList<BgpValueType> capabilityTlv = new LinkedList<>(); |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 322 | |
| 323 | @Override |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 324 | public BgpOpenMsg build() throws BgpParseException { |
| 325 | BgpHeader bgpMsgHeader = this.isHeaderSet ? this.bgpMsgHeader : DEFAULT_OPEN_HEADER; |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 326 | short holdTime = this.isHoldTimeSet ? this.holdTime : DEFAULT_HOLD_TIME; |
| 327 | |
| 328 | if (!this.isAsNumSet) { |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 329 | throw new BgpParseException("BGP AS number is not set (mandatory)"); |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 330 | } |
| 331 | |
| 332 | if (!this.isBgpIdSet) { |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 333 | throw new BgpParseException("BGPID is not set (mandatory)"); |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 334 | } |
| 335 | |
Shashikanth VH | f04ab49 | 2016-02-10 11:35:11 +0530 | [diff] [blame] | 336 | if (this.isIpV4UnicastCapabilityTlvSet) { |
| 337 | BgpValueType tlv; |
| 338 | tlv = new MultiProtocolExtnCapabilityTlv((short) Constants.AFI_IPV4_UNICAST, RES, |
| 339 | (byte) Constants.SAFI_IPV4_UNICAST); |
| 340 | this.capabilityTlv.add(tlv); |
| 341 | } |
| 342 | |
Vidyashree Rama | f49b22c | 2015-10-13 15:30:24 +0530 | [diff] [blame] | 343 | if (this.isLargeAsCapabilityTlvSet) { |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 344 | BgpValueType tlv; |
Vidyashree Rama | afbbff9 | 2015-11-02 14:45:17 +0530 | [diff] [blame] | 345 | int value = this.asNumber; |
| 346 | tlv = new FourOctetAsNumCapabilityTlv(value); |
Vidyashree Rama | f49b22c | 2015-10-13 15:30:24 +0530 | [diff] [blame] | 347 | this.capabilityTlv.add(tlv); |
| 348 | } |
| 349 | |
| 350 | if (this.isLsCapabilityTlvSet) { |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 351 | BgpValueType tlv; |
Vidyashree Rama | f49b22c | 2015-10-13 15:30:24 +0530 | [diff] [blame] | 352 | tlv = new MultiProtocolExtnCapabilityTlv(AFI, RES, SAFI); |
| 353 | this.capabilityTlv.add(tlv); |
| 354 | } |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 355 | |
Shashikanth VH | 44967ec | 2016-02-04 19:46:16 +0530 | [diff] [blame] | 356 | if (this.isFlowSpecCapabilityTlvSet) { |
| 357 | BgpValueType tlv; |
| 358 | tlv = new MultiProtocolExtnCapabilityTlv(Constants.AFI_FLOWSPEC_VALUE, |
| 359 | RES, Constants.SAFI_FLOWSPEC_VALUE); |
| 360 | this.capabilityTlv.add(tlv); |
| 361 | } |
| 362 | |
| 363 | if (this.isVpnFlowSpecCapabilityTlvSet) { |
| 364 | BgpValueType tlv; |
| 365 | tlv = new MultiProtocolExtnCapabilityTlv(Constants.AFI_FLOWSPEC_VALUE, |
| 366 | RES, Constants.VPN_SAFI_FLOWSPEC_VALUE); |
| 367 | this.capabilityTlv.add(tlv); |
| 368 | } |
| 369 | |
Shashikanth VH | b650bfa | 2016-04-18 12:54:03 +0530 | [diff] [blame] | 370 | if (this.isFlowSpecRpdCapabilityTlvSet) { |
| 371 | BgpValueType tlv; |
Shashikanth VH | b58cfd5 | 2016-04-21 16:45:50 +0530 | [diff] [blame] | 372 | tlv = new RpdCapabilityTlv(Constants.RPD_CAPABILITY_SEND_VALUE); |
Shashikanth VH | b650bfa | 2016-04-18 12:54:03 +0530 | [diff] [blame] | 373 | this.capabilityTlv.add(tlv); |
| 374 | } |
| 375 | |
| 376 | |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 377 | return new BgpOpenMsgVer4(bgpMsgHeader, PACKET_VERSION, this.asNumber, holdTime, this.bgpId, |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 378 | this.capabilityTlv); |
| 379 | } |
| 380 | |
| 381 | @Override |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 382 | public Builder setHeader(BgpHeader bgpMsgHeader) { |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 383 | this.bgpMsgHeader = bgpMsgHeader; |
| 384 | return this; |
| 385 | } |
| 386 | |
| 387 | @Override |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 388 | public Builder setHoldTime(short holdTime) { |
| 389 | this.holdTime = holdTime; |
| 390 | this.isHoldTimeSet = true; |
| 391 | return this; |
| 392 | } |
| 393 | |
| 394 | @Override |
| 395 | public Builder setAsNumber(short asNumber) { |
| 396 | this.asNumber = asNumber; |
| 397 | this.isAsNumSet = true; |
| 398 | return this; |
| 399 | } |
| 400 | |
| 401 | @Override |
| 402 | public Builder setBgpId(int bgpId) { |
| 403 | this.bgpId = bgpId; |
| 404 | this.isBgpIdSet = true; |
| 405 | return this; |
| 406 | } |
| 407 | |
| 408 | @Override |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 409 | public Builder setCapabilityTlv(LinkedList<BgpValueType> capabilityTlv) { |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 410 | this.capabilityTlv = capabilityTlv; |
| 411 | return this; |
| 412 | } |
Vidyashree Rama | f49b22c | 2015-10-13 15:30:24 +0530 | [diff] [blame] | 413 | |
| 414 | @Override |
| 415 | public Builder setLargeAsCapabilityTlv(boolean isLargeAsCapabilitySet) { |
| 416 | this.isLargeAsCapabilityTlvSet = isLargeAsCapabilitySet; |
| 417 | return this; |
| 418 | } |
| 419 | |
| 420 | @Override |
| 421 | public Builder setLsCapabilityTlv(boolean isLsCapabilitySet) { |
| 422 | this.isLsCapabilityTlvSet = isLsCapabilitySet; |
| 423 | return this; |
| 424 | } |
Shashikanth VH | 44967ec | 2016-02-04 19:46:16 +0530 | [diff] [blame] | 425 | |
| 426 | @Override |
| 427 | public Builder setFlowSpecCapabilityTlv(boolean isFlowSpecCapabilitySet) { |
| 428 | this.isFlowSpecCapabilityTlvSet = isFlowSpecCapabilitySet; |
| 429 | return this; |
| 430 | } |
| 431 | |
| 432 | @Override |
| 433 | public Builder setVpnFlowSpecCapabilityTlv(boolean isVpnFlowSpecCapabilitySet) { |
| 434 | this.isVpnFlowSpecCapabilityTlvSet = isVpnFlowSpecCapabilitySet; |
| 435 | return this; |
| 436 | } |
Shashikanth VH | b650bfa | 2016-04-18 12:54:03 +0530 | [diff] [blame] | 437 | |
| 438 | @Override |
| 439 | public Builder setFlowSpecRpdCapabilityTlv(boolean isFlowSpecRpdCapabilityTlvSet) { |
| 440 | this.isFlowSpecRpdCapabilityTlvSet = isFlowSpecRpdCapabilityTlvSet; |
| 441 | return this; |
| 442 | } |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 443 | } |
| 444 | |
| 445 | @Override |
| 446 | public void writeTo(ChannelBuffer cb) { |
| 447 | try { |
| 448 | WRITER.write(cb, this); |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 449 | } catch (BgpParseException e) { |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 450 | log.debug("[writeTo] Error: " + e.toString()); |
| 451 | } |
| 452 | } |
| 453 | |
| 454 | public static final Writer WRITER = new Writer(); |
| 455 | |
| 456 | /** |
| 457 | * Writer class for writing BGP open message to channel buffer. |
| 458 | */ |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 459 | public static class Writer implements BgpMessageWriter<BgpOpenMsgVer4> { |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 460 | |
| 461 | @Override |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 462 | public void write(ChannelBuffer cb, BgpOpenMsgVer4 message) throws BgpParseException { |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 463 | |
| 464 | int optParaLen = 0; |
Vidyashree Rama | f49b22c | 2015-10-13 15:30:24 +0530 | [diff] [blame] | 465 | int as4num = 0; |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 466 | |
| 467 | int startIndex = cb.writerIndex(); |
| 468 | |
| 469 | // write common header and get msg length index |
| 470 | int msgLenIndex = message.bgpMsgHeader.write(cb); |
| 471 | |
| 472 | if (msgLenIndex <= 0) { |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 473 | throw new BgpParseException("Unable to write message header."); |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 474 | } |
| 475 | |
| 476 | // write version in 1-octet |
| 477 | cb.writeByte(message.version); |
| 478 | |
Vidyashree Rama | f49b22c | 2015-10-13 15:30:24 +0530 | [diff] [blame] | 479 | // get as4num if LS Capability is set |
| 480 | if (message.isLargeAsCapabilitySet) { |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 481 | LinkedList<BgpValueType> capabilityTlv = message |
Vidyashree Rama | f49b22c | 2015-10-13 15:30:24 +0530 | [diff] [blame] | 482 | .getCapabilityTlv(); |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 483 | ListIterator<BgpValueType> listIterator = capabilityTlv |
Vidyashree Rama | f49b22c | 2015-10-13 15:30:24 +0530 | [diff] [blame] | 484 | .listIterator(); |
| 485 | |
| 486 | while (listIterator.hasNext()) { |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 487 | BgpValueType tlv = listIterator.next(); |
Vidyashree Rama | f49b22c | 2015-10-13 15:30:24 +0530 | [diff] [blame] | 488 | if (tlv.getType() == FOUR_OCTET_AS_NUM_CAPA_TYPE) { |
| 489 | as4num = ((FourOctetAsNumCapabilityTlv) tlv).getInt(); |
| 490 | break; |
| 491 | } |
| 492 | } |
| 493 | } |
| 494 | |
| 495 | if ((message.isLargeAsCapabilitySet) && (as4num > 65535)) { |
| 496 | // write As number as AS_TRANS |
| 497 | cb.writeShort(AS_TRANS); |
| 498 | } else { |
| 499 | // write AS number in next 2-octet |
Shashikanth VH | 09792f0 | 2016-05-10 16:59:57 +0530 | [diff] [blame^] | 500 | cb.writeShort((short) message.asNumber); |
Vidyashree Rama | f49b22c | 2015-10-13 15:30:24 +0530 | [diff] [blame] | 501 | } |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 502 | |
| 503 | // write HoldTime in next 2-octet |
| 504 | cb.writeShort(message.holdTime); |
| 505 | |
| 506 | // write BGP Identifier in next 4-octet |
| 507 | cb.writeInt(message.bgpId); |
| 508 | |
| 509 | // store the index of Optional parameter length |
| 510 | int optParaLenIndex = cb.writerIndex(); |
| 511 | |
| 512 | // set optional parameter length as 0 |
| 513 | cb.writeByte(0); |
| 514 | |
| 515 | // Pack capability TLV |
| 516 | optParaLen = message.packCapabilityTlv(cb, message); |
| 517 | |
| 518 | if (optParaLen != 0) { |
| 519 | // Update optional parameter length |
| 520 | cb.setByte(optParaLenIndex, (byte) (optParaLen + 2)); //+2 for optional parameter type. |
| 521 | } |
| 522 | |
| 523 | // write OPEN Object Length |
| 524 | int length = cb.writerIndex() - startIndex; |
| 525 | cb.setShort(msgLenIndex, (short) length); |
| 526 | message.bgpMsgHeader.setLength((short) length); |
| 527 | } |
| 528 | } |
| 529 | |
| 530 | /** |
| 531 | * returns length of capability tlvs. |
| 532 | * |
| 533 | * @param cb of type channel buffer |
| 534 | * @param message of type BGPOpenMsgVer4 |
| 535 | * @return capParaLen of open message |
| 536 | */ |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 537 | protected int packCapabilityTlv(ChannelBuffer cb, BgpOpenMsgVer4 message) { |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 538 | int startIndex = cb.writerIndex(); |
| 539 | int capParaLen = 0; |
| 540 | int capParaLenIndex = 0; |
| 541 | |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 542 | LinkedList<BgpValueType> capabilityTlv = message.capabilityTlv; |
| 543 | ListIterator<BgpValueType> listIterator = capabilityTlv.listIterator(); |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 544 | |
| 545 | if (listIterator.hasNext()) { |
| 546 | // Set optional parameter type as 2 |
| 547 | cb.writeByte(OPT_PARA_TYPE_CAPABILITY); |
| 548 | |
| 549 | // Store the index of capability parameter length and update length at the end |
| 550 | capParaLenIndex = cb.writerIndex(); |
| 551 | |
| 552 | // Set capability parameter length as 0 |
| 553 | cb.writeByte(0); |
| 554 | |
| 555 | // Update the startIndex to know the length of capability tlv |
| 556 | startIndex = cb.writerIndex(); |
| 557 | } |
| 558 | |
| 559 | while (listIterator.hasNext()) { |
Shashikanth VH | 5dd8dbe | 2015-11-26 13:22:18 +0530 | [diff] [blame] | 560 | BgpValueType tlv = listIterator.next(); |
Vidyashree Rama | 6d4f84e | 2015-09-21 20:01:02 +0530 | [diff] [blame] | 561 | if (tlv == null) { |
| 562 | log.debug("Warning: tlv is null from CapabilityTlv list"); |
| 563 | continue; |
| 564 | } |
| 565 | tlv.write(cb); |
| 566 | } |
| 567 | |
| 568 | capParaLen = cb.writerIndex() - startIndex; |
| 569 | |
| 570 | if (capParaLen != 0) { |
| 571 | // Update capability parameter length |
| 572 | cb.setByte(capParaLenIndex, (byte) capParaLen); |
| 573 | } |
| 574 | return capParaLen; |
| 575 | } |
| 576 | |
| 577 | @Override |
| 578 | public String toString() { |
| 579 | return MoreObjects.toStringHelper(getClass()) |
| 580 | .add("bgpMsgHeader", bgpMsgHeader) |
| 581 | .add("version", version) |
| 582 | .add("holdTime", holdTime) |
| 583 | .add("asNumber", asNumber) |
| 584 | .add("bgpId", bgpId) |
| 585 | .add("capabilityTlv", capabilityTlv) |
| 586 | .toString(); |
| 587 | } |
| 588 | } |