YABGP is a yet another Python implementation for BGP Protocol. It can be used to establish BGP connections with all kinds of routers (include real Cisco/HuaWei/Juniper routers and some router simulators like GNS3) and receive/parse BGP messages for future analysis.
We write it in strict accordance with the specifications of RFCs.
This software can be used on Linux/Unix, Mac OS and Windows systems.
- It can establish BGP session based on IPv4 address (TCP Layer) in active mode(as TCP client);
- Support TCP MD5 authentication(IPv4 and does not support Windows now);
- BGP capabilities support: 4 Bytes ASN, IPv4 address family, Route Refresh(Cisco Route Refresh);
- Decode all BGP messages to human readable strings and write files to disk(configurable);
- Support basic RESTFUL API.
We recommend run yabgp
through python virtual-env from source code or pip install
Use yabgp from source code:
$ virtualenv yabgp-virl
$ source yabgp-virl/bin/activate
$ git clone https://github.com/smartbgp/yabgp
$ cd yabgp
$ pip install -r requirements.txt
$ cd bin
$ python yabgpd -h
Use pip install
$ virtualenv yabgp-virl
$ source yabgp-virl/bin/activate
$ pip install yabgp
$ which yabgpd
/home/yabgp/yabgp-virl/bin/yabgpd
$ yabgpd -h
For example:
$ yabgpd --bgp-local_addr=1.1.1.1 --bgp-local_as=65001 --bgp-remote_addr=1.1.1.2 --bgp-remote_as=65001 --bgp-md5=test --config-file=../etc/yabgp/yabgp.ini
BGP message example:
in yabgp.ini
, you can point out if you want to store the parsing BGP message to local disk and where you want to put them in.
More information please see the documentation http://yabgp.readthedocs.org
Send email to xiaoquwl@gmail.com, or use GitHub issue system.
- support more address family (flowspec, IPv6, VPNv4, VPNv6, etc.)
- more unittest
- others
Please create Github Pull Request https://github.com/smartbgp/yabgp/pulls
More details please read HACKING.rst.
For core files like fsm, protocol, we copy some of the code from https://github.com/wikimedia/PyBal/blob/master/pybal/bgp.py,
and message parsing, we reference from https://github.com/Exa-Networks/exabgp