bgpmanager/impl/src/main/java/org/opendaylight/netvirt/bgpmanager/ConfigureBgpCli.java

   1 /*
   2  * Copyright © 2015, 2017 Ericsson India Global Services Pvt Ltd. 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.netvirt.bgpmanager;
  10
  11 import java.net.InetAddress;
  12 import java.net.UnknownHostException;
  13 import java.util.List;
  14 import org.apache.karaf.shell.commands.Command;
  15 import org.apache.karaf.shell.commands.Option;
  16 import org.apache.karaf.shell.console.OsgiCommandSupport;
  17 import org.opendaylight.netvirt.bgpmanager.thrift.gen.af_afi;
  18 import org.opendaylight.netvirt.bgpmanager.thrift.gen.af_safi;
  19 import org.opendaylight.netvirt.bgpmanager.thrift.gen.protocol_type;
  20 import org.opendaylight.yang.gen.v1.urn.ericsson.params.xml.ns.yang.ebgp.rev150901.Bgp;
  21 import org.opendaylight.yang.gen.v1.urn.ericsson.params.xml.ns.yang.ebgp.rev150901.TcpMd5SignaturePasswordType;
  22 import org.opendaylight.yang.gen.v1.urn.ericsson.params.xml.ns.yang.ebgp.rev150901.bgp.neighborscontainer.Neighbors;
  23 import org.opendaylight.yangtools.yang.common.Uint32;
  24
  25 @Command(scope = "odl", name = "configure-bgp", description = "")
  26 public class ConfigureBgpCli extends OsgiCommandSupport {
  27     private static final long AS_MIN = 0;
  28     private static final long AS_MAX = 4294967295L;//2^32-1
  29
  30     @Option(name = "-op", aliases = {"--operation", "--op"}, description = "[start-bgp-server, stop-bgp-server, "
  31             + "add-neighbor, delete-neighbor, add-route, delete-route,graceful-restart, enable-log ]",
  32             required = false, multiValued = false)
  33     String op;
  34
  35     //exec configure-bgp  add-neighbor --ip <neighbor-ip> --as-num <as-num> --address-family <af> --use-source-ip
  36     // <sip> --ebgp-multihops <em> --next-hop <nh>
  37     //exec configure-bgp --op add-route/delete-route --rd <rd> --prefix <prefix> --nexthop <nexthop>
  38     // --mac <mac> --l2vni <l2vni> --l3vni <l3vni>
  39
  40     @Option(name = "--as-num", description = "as number of the bgp neighbor", required = false, multiValued = false)
  41     String asNumber = null;
  42
  43     @Option(name = "--ip", description = "ip of the bgp neighbor", required = false, multiValued = false)
  44     String ip = null;
  45
  46     @Option(name = "--tcp-md5-password", description = "RFC2385 TCP MD5 Signature Option shared secret",
  47             required = false, multiValued = false)
  48     String md5passwordOption = null;
  49
  50     @Option(name = "--address-family", description = "address family of the bgp neighbor "
  51             + "lu|evpn|vpnv4|vpnv6",
  52             required = false, multiValued = false)
  53     String addressFamily = null;
  54
  55     @Option(name = "--use-source-ip", description = "source ip to be used for neighborship connection establishment",
  56             required = false, multiValued = false)
  57     String sourceIp = null;
  58
  59     @Option(name = "--ebgp-multihops", description = "ebgp multihops of the bgp neighbor",
  60             required = false, multiValued = false)
  61     String ebgpMultihops = null;
  62
  63     @Option(name = "--router-id", description = "router id of the bgp instance",
  64             required = false, multiValued = false)
  65     String routerId = null;
  66
  67     @Option(name = "--rd", description = "rd of the route",
  68             required = false, multiValued = false)
  69     String rd = null;
  70
  71     @Option(name = "--prefix", description = "prefix of the route",
  72             required = false, multiValued = false)
  73     String prefix = null;
  74
  75     @Option(name = "--nexthop", description = "nexthop of the route",
  76             required = false, multiValued = false)
  77     String nexthop = null;
  78
  79     @Option(name = "--mac", description = "mac of the route",
  80             required = false, multiValued = false)
  81     String mac = null;
  82
  83     @Option(name = "--l2vni", description = "l2vni of the route",
  84             required = false, multiValued = false)
  85     Uint32 l2vni = Uint32.ZERO;
  86
  87     @Option(name = "--l3vni", description = "l3vni",
  88             required = false, multiValued = false)
  89     Uint32 l3vni = Uint32.ZERO;
  90
  91     @Option(name = "--stalepath-time", description = "the time delay after bgp restart stalepaths are cleaned",
  92             required = false, multiValued = false)
  93     String stalePathTime = null;
  94
  95     @Option(name = "--log-file-path", description = "bgp log file path",
  96             required = false, multiValued = false)
  97     String logFile = null;
  98
  99     @Option(name = "--log-level", description = "log level emergencies,alerts,critical,errors,warnings,notifications,"
 100             + "informational,debugging",
 101             required = false, multiValued = false)
 102     String logLevel = null;
 103
 104     enum LogLevels {
 105         emergencies, alerts, critical, errors, warnings, notifications, informational, debugging
 106     }
 107
 108     private final BgpManager bgpManager;
 109     private final BgpConfigurationManager bgpConfigurationManager;
 110
 111     public ConfigureBgpCli(BgpManager bgpManager, BgpConfigurationManager bgpConfigurationManager) {
 112         this.bgpManager = bgpManager;
 113         this.bgpConfigurationManager = bgpConfigurationManager;
 114     }
 115
 116     @Override
 117     protected Object doExecute() throws Exception {
 118         if (op == null) {
 119             session.getConsole().println("Please provide valid operation");
 120             usage();
 121             session.getConsole().println(
 122                     "exec configure-bgp -op [start-bgp-server | stop-bgp-server | add-neighbor | delete-neighbor|"
 123                             + " add-route | delete-route | graceful-restart| enable-log ]");
 124             return null;
 125         }
 126         switch (op) {
 127             case "start-bgp-server":
 128                 startBgp();
 129                 break;
 130             case "stop-bgp-server":
 131                 stopBgp();
 132                 break;
 133             case "add-neighbor":
 134                 addNeighbor();
 135                 break;
 136             case "delete-neighbor":
 137                 deleteNeighbor();
 138                 break;
 139             case "add-route":
 140                 addRoute();
 141                 break;
 142             case "delete-route":
 143                 deleteRoute();
 144                 break;
 145             case "graceful-restart":
 146                 configureGR();
 147                 break;
 148             case "enable-log":
 149                 enableBgpLogLevel();
 150                 break;
 151             default:
 152                 session.getConsole().println("invalid operation");
 153                 usage();
 154                 session.getConsole().println(
 155                         "exec configure-bgp -op [start-bgp-server | stop-bgp-server | add-neighbor | "
 156                                 + "delete-neighbor| graceful-restart| enable-log ]");
 157         }
 158         return null;
 159     }
 160
 161     public boolean validateStalepathTime() {
 162         try {
 163             int time = Integer.parseInt(stalePathTime);
 164             if (time < 30 || time > 3600) {
 165                 session.getConsole().println("invalid stale path time valid range [30-3600]" + stalePathTime);
 166                 printGracefulRestartHelp();
 167                 return false;
 168             }
 169         } catch (NumberFormatException e) {
 170             session.getConsole().println("invalid stale path time" + stalePathTime);
 171             printGracefulRestartHelp();
 172             return false;
 173         }
 174         return true;
 175     }
 176
 177     private void configureGR() {
 178         boolean validStalepathTime = validateStalepathTime();
 179         if (!validStalepathTime) {
 180             return;
 181         }
 182         bgpManager.configureGR(Integer.parseInt(stalePathTime));
 183     }
 184
 185     private void deleteNeighbor() {
 186         if (ip == null || !validateIp(ip)) {
 187             session.getConsole().println("invalid neighbor ip");
 188             printDeleteNeighborHelp();
 189             return;
 190         }
 191         long asNo = getAsNumber(ip);
 192         if (asNo < 0) {
 193             session.getConsole().println("neighbor does not exist");
 194             printDeleteNeighborHelp();
 195             return;
 196         }
 197         bgpManager.deleteNeighbor(ip);
 198     }
 199
 200     public long getAsNumber(String nbrIp) {
 201         Bgp conf = bgpManager.getConfig();
 202         if (conf == null) {
 203             return -1;
 204         }
 205         List<Neighbors> nbrs = conf.getNeighborsContainer() == null ? null
 206                 : conf.getNeighborsContainer().getNeighbors();
 207         if (nbrs == null) {
 208             return -1;
 209         }
 210         for (Neighbors nbr : nbrs) {
 211             if (nbrIp.equals(nbr.getAddress().getValue())) {
 212                 return nbr.getRemoteAs().toJava();
 213             }
 214         }
 215         return -1;
 216     }
 217
 218     private void stopBgp() {
 219         Bgp conf = bgpManager.getConfig();
 220         if (conf == null) {
 221             return;
 222         }
 223         List<Neighbors> nbrs = conf.getNeighborsContainer() == null ? null
 224                 : conf.getNeighborsContainer().getNeighbors();
 225         if (nbrs != null && nbrs.size() > 0) {
 226             session.getConsole().println(
 227                     "error: all BGP congiguration must be deleted before stopping the router instance");
 228             return;
 229         }
 230         bgpManager.stopBgp();
 231     }
 232
 233     private void usage() {
 234         session.getConsole().println("usage:");
 235     }
 236
 237     private void printStartBgpHelp() {
 238         usage();
 239         session.getConsole().println(
 240                 "exec configure-bgp -op start-bgp-server --as-num <asnum> --router-id <routerid> [--stalepath-time "
 241                         + "<time>]");
 242     }
 243
 244     private void printAddNeighborHelp() {
 245         usage();
 246         session.getConsole().println(
 247                 "exec configure-bgp -op add-neighbor --ip <neighbor-ip> --as-num <as-num> [--address-family <af>] "
 248                         + "[--tcp-md5-password <password>] "
 249                         + "[--use-source-ip <sip>] [--ebgp-multihops <em> ]");
 250     }
 251
 252     private void printDeleteNeighborHelp() {
 253         usage();
 254         session.getConsole().println("exec configure-bgp -op delete-neighbor --ip <neighbor-ip>");
 255     }
 256
 257     void printEnableLogHelp() {
 258         usage();
 259         session.getConsole().println(
 260                 "exec configure-bgp -op enable-logging --filename <filename> --log-level "
 261                         + "[emergencies|alerts|critical|errors|warnings|notifications|informational|debugging]");
 262     }
 263
 264     private void printGracefulRestartHelp() {
 265         usage();
 266         session.getConsole().println("exec configure-bgp -op graceful-restart --stalepath-time <30-3600>");
 267     }
 268
 269     private void startBgp() {
 270         boolean validRouterId = false;
 271
 272         if (bgpManager.getConfig() != null && bgpManager.getConfig().getAsId() != null) {
 273             session.getConsole().println("bgp is already started please use stop-bgp-server and start again");
 274             return;
 275         }
 276         if (!validateAsNumber(asNumber)) {
 277             printStartBgpHelp();
 278             return;
 279         }
 280         validRouterId = validateIp(routerId);
 281         if (!validRouterId) {
 282             session.getConsole().println("invalid router id please supply valid ip address");
 283             printStartBgpHelp();
 284             return;
 285         }
 286
 287         if (stalePathTime != null) {
 288             boolean validStalepathTime = validateStalepathTime();
 289             if (!validStalepathTime) {
 290                 return;
 291             }
 292         }
 293         bgpManager.startBgp(Long.parseLong(asNumber), routerId,
 294                 stalePathTime == null ? 0 : Integer.parseInt(stalePathTime), false);
 295     }
 296
 297     protected void addNeighbor() {
 298         if (!validateAsNumber(asNumber)) {
 299             printAddNeighborHelp();
 300             return;
 301         }
 302
 303         boolean validIp = validateIp(ip);
 304         if (!validIp) {
 305             session.getConsole().println("invalid neighbor ip");
 306             printAddNeighborHelp();
 307             return;
 308         }
 309
 310         TcpMd5SignaturePasswordType md5secret = null;
 311         if (md5passwordOption != null) {
 312             try {
 313                 md5secret = new TcpMd5SignaturePasswordType(md5passwordOption);
 314             } catch (IllegalArgumentException e) {
 315                 session.getConsole().println(
 316                         new StringBuilder("invalid MD5 password: ").append(e.getMessage()).toString());
 317                 printAddNeighborHelp();
 318                 return;
 319             }
 320         }
 321
 322         if (sourceIp != null) {
 323             validIp = validateIp(sourceIp);
 324             if (!validIp) {
 325                 session.getConsole().println("invalid source ip");
 326                 printAddNeighborHelp();
 327                 return;
 328             }
 329         }
 330
 331         if (ebgpMultihops != null) {
 332             try {
 333                 long val = Long.parseLong(ebgpMultihops);
 334                 if (val < 1 || val > 255) {
 335                     session.getConsole().println("invalid ebgpMultihops number , valid range [1,255] "
 336                             + ebgpMultihops);
 337                     printAddNeighborHelp();
 338                     return;
 339                 }
 340             } catch (NumberFormatException e) {
 341                 session.getConsole().println("invalid ebgpMultihops number, valid range [1-255]"
 342                         + ebgpMultihops);
 343                 printAddNeighborHelp();
 344                 return;
 345             }
 346         }
 347         if (addressFamily != null) {
 348             if (!addressFamily.equals("lu") && !addressFamily.equals("vpnv4")
 349                     && !addressFamily.equals("vpnv6")
 350                     && !addressFamily.equals("evpn")) {
 351                 session.getConsole().println("error: Address family must be lu/evpn/vpnv4/vpnv6 ");
 352                 return;
 353             }
 354
 355             int afi ;
 356             int safi ;
 357             if (addressFamily.equals("vpnv6")) {
 358                 afi = 2;
 359                 safi = 5;
 360             } else if (addressFamily.equals("evpn")) {
 361                 afi = 3;
 362                 safi = 6;
 363             } else if (addressFamily.equals("lu")) {
 364                 afi = 1;
 365                 safi = 4;
 366             } else if  (addressFamily.equals("vpnv4")) {
 367                 afi = 1;
 368                 safi = 5;
 369             } else {
 370                 session.getConsole().println(
 371                         "invalid addressFamily valid values lu/evpn/vpnv4/vpnv6");
 372                 printAddNeighborHelp();
 373                 return ;
 374             }
 375         }
 376         if (getAsNumber(ip) != -1) {
 377             session.getConsole().println("neighbor with ip " + ip + " already exists");
 378             return;
 379         }
 380         bgpConfigurationManager.addNeighbor(ip, Long.parseLong(asNumber), md5secret);
 381         if (addressFamily != null) {
 382             bgpConfigurationManager.addAddressFamily(ip, af_afi.AFI_IP.getValue(),
 383                     af_safi.valueOf(addressFamily).getValue());
 384         }
 385         if (ebgpMultihops != null) {
 386             bgpConfigurationManager.addEbgpMultihop(ip, Integer.parseInt(ebgpMultihops));
 387         }
 388         if (sourceIp != null) {
 389             bgpConfigurationManager.addUpdateSource(ip, sourceIp);
 390         }
 391     }
 392
 393     protected void addRoute() {
 394         bgpConfigurationManager.onUpdatePushRoute(protocol_type.PROTOCOL_L3VPN, rd, prefix,
 395                 0, nexthop, mac, l3vni, l2vni, null, null);
 396     }
 397
 398     protected void deleteRoute() {
 399         bgpConfigurationManager.onUpdateWithdrawRoute(protocol_type.PROTOCOL_L3VPN, rd, prefix,
 400                 0, nexthop, mac);
 401     }
 402
 403     private boolean validateIp(String inputIp) {
 404         boolean validIp = false;
 405         try {
 406             if (inputIp != null) {
 407                 InetAddress addr = InetAddress.getByName(inputIp);
 408                 if (addr.isMulticastAddress()) {
 409                     session.getConsole().println("ip cannot be multicast address");
 410                     return false;
 411                 }
 412                 if (addr.isLoopbackAddress()) {
 413                     session.getConsole().println("ip cannot be loopback address");
 414                     return false;
 415                 }
 416                 byte[] addrBytes = addr.getAddress();
 417                 int lastPart = addrBytes[3] & 0xFF;
 418                 int firstPart = addrBytes[0] & 0xFF;
 419                 if (firstPart == 0) {
 420                     return false;//cannot start with 0 "0.1.2.3"
 421                 }
 422                 if (lastPart == 0 || lastPart == 255) {
 423                     return false;
 424                 }
 425                 validIp = true;
 426             }
 427         } catch (UnknownHostException e) {
 428             // Ignored?
 429         }
 430         return validIp;
 431     }
 432
 433     private void enableBgpLogLevel() {
 434         if (logFile == null) {
 435             session.getConsole().println("Please provide log file name ");
 436             usage();
 437             session.getConsole().println(
 438                     "exec configure-bgp -op enable-log --log-file-path <logfile> --log-level <level>");
 439             return;
 440         }
 441         boolean validLoglevel = false;
 442         try {
 443             LogLevels.valueOf(logLevel);
 444             validLoglevel = true;
 445         } catch (IllegalArgumentException e) {
 446             // Ignored?
 447         }
 448         if (!validLoglevel) {
 449             session.getConsole().println(
 450                     "Please provide valid log level "
 451                             + "emergencies|alerts|critical|errors|warnings|notifications|informational|debugging");
 452             usage();
 453             session.getConsole().println(
 454                     "exec configure-bgp -op enable-log --log-file-path <logfile> --log-level <level>");
 455             return;
 456         }
 457         bgpManager.setQbgpLog(logFile, logLevel);
 458     }
 459
 460     private boolean validateAsNumber(String strAsnum) {
 461
 462         try {
 463             long asNum = Long.parseLong(strAsnum);
 464             if (asNum == 0L || asNum == 65535L || asNum == 23456L) {
 465                 session.getConsole().println("reserved AS Number supplied ");
 466                 return false;
 467             }
 468             if (asNum <= AS_MIN || asNum > AS_MAX) {
 469                 session.getConsole().println("invalid AS Number , supported range [1," + AS_MAX + "]");
 470                 return false;
 471             }
 472         } catch (NumberFormatException e) {
 473             session.getConsole().println("invalid AS Number " + asNumber);
 474             return false;
 475         }
 476         return true;
 477     }
 478 }