Skip to content
BGP route collector written in C
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
etc large/ext communities partial implementation Oct 23, 2017
inc NEXTHOP export Oct 30, 2017
man Initial v1.1.0 Oct 21, 2017
src Fixes #12 Nov 2, 2017
test Fixes #11 Nov 2, 2017
utils remove vi temp file that should not have been there Oct 31, 2017
web updated README and added logo Oct 22, 2017
CNAME Update CNAME Oct 22, 2017
LICENSE Initial v1.1.0 Oct 21, 2017
Makefile add configurable dump interval Oct 24, 2017
README.md issue #9 Nov 1, 2017
_config.yml Set theme jekyll-theme-tactile Oct 22, 2017
configure typo in configure Oct 24, 2017

README.md

Piranha

alt text

A highly efficient, multi-threaded, BGP route collector written in C.

Piranha collects routes and dumps them into files for the purpose of analysis. Piranha is NOT a BGP router and does NOT have the capability to announce routes nor does it interact with the kernel routing table(s).

Piranha supports:

  • BGP capabilities negociation.
  • BGP 4 octets ASN and AS_PATHs.
  • TCP MD5 BGP session protection.
  • IPv6 routes over IPv6 sockets.
  • IPv4 routes over IPv4 sockets.
  • Decoding of BGP Attributes (ORIGIN_AS, AS_PATH, COMMUNITIES, LARGE_COMMUNITIES)

Installation

Download

Download the latest version

user@piranha$ wget https://github.com/spale75/piranha/archive/piranha-x.x.x.tar.gz

Unpack

Unpack the TGZ file. Don't worry, all files contained in the TGZ are in a subfolder.

user@piranha$ tar -zxvf piranha-x.x.x.tar.gz

Configure

Default settings should be fine, but if you feel you need to tune something, there are a few options to choose from.

user@piranha$ ./configure --help
Usage ./configure [--debug] [--verbose] [--prefix=</path/to/piranha>] [--dumpint=<seconds>] [--help]
  --help    : show help
  --debug   : enable debug code
  --verbose : enable verbose compilation
  --prefix  : set base installation directory (default: /opt/piranha)
  --dumpint : set dump interval in seconds (default: 60)

NOTE for debug mode: Piranha will output a lot of debugging messages. Do NOT run this on production. Connect only one neighbor, in debugging mode you will not be able to understand the output if multiple peers are connected.

Example
user@piranha$ ./configure
Piranha configuration script

Detected Arch       : x86_64
Detected OS         : DARWIN 15.6.0
Detected Compiler   : /usr/bin/gcc
Installation prefix : /opt/piranha
Debug code          : disabled
Verbose compilation : disabled

user@piranha$

Compile and Install

user@piranha$ make
  // stripped fancy banner //
  MKDIR   obj bin
  CC      src/p_tools.c             -> obj/p_tools.o
  CC      src/p_config.c            -> obj/p_config.o
  CC      src/p_socket.c            -> obj/p_socket.o
  CC      src/p_log.c               -> obj/p_log.o
  CC      src/p_dump.c              -> obj/p_dump.o
  CC      src/p_piranha.c           -> obj/p_piranha.o
  LINK    bin/piranha               -> obj/p_tools.o obj/p_config.o obj/p_socket.o obj/p_log.o obj/p_dump.o obj/p_piranha.o
  INFO    Compilation done          -> bin/piranha
  CC      src/p_undump.c            -> obj/p_undump.o
  CC      src/p_ptoa.c              -> obj/p_ptoa.o
  LINK    bin/ptoa                  -> obj/p_tools.o obj/p_undump.o obj/p_ptoa.o
  INFO    Compilation done          -> bin/ptoa
  SED     utils/piranhactl.in       -> bin/piranhactl
  INFO    Compilation done
root@piranha$ spale$ make install
  MKDIR   /opt/piranha/bin
mkdir: /opt/piranha/bin: Permission denied
make: *** [install] Error 1
user@piranha$ sudo make install
Password:
  MKDIR   /opt/piranha/bin
  MKDIR   /opt/piranha/etc
  MKDIR   /opt/piranha/var/dump
  CP      bin/piranha               -> /opt/piranha/bin/
  CP      bin/ptoa                  -> /opt/piranha/bin/
  CP      etc/piranha_sample.conf   -> /opt/piranha/etc/
  CP      bin/piranhactl            -> /opt/piranha/bin/
  CP      man                       -> /opt/piranha/
  INFO    Installation done
user@piranha$

NOTE: You might need to sudo if your destination is not writable by the user.

Testing

There is a test function in the Makefile. It will test the decoding of sample dump files and compare the output to reference files located in the folder 'test'.

user@piranha$ make test
  TEST    test/test.sh
Testing ipv4 in mode H: OK
Testing ipv4 in mode m: OK
Testing ipv4 in mode j: OK
Testing ipv6 in mode H: OK
Testing ipv6 in mode m: OK
Testing ipv6 in mode j: OK
user@piranha$

Configuration

Piranha has one configuration file located in <destination folder>/etc/piranha.conf. In the same folder there is a sample configuration name piranha_sample.conf. Copy the file to piranha.conf and edit it.

piranha.conf

# your local AS number
local_as <ASN>

# Listening IP/Port for IPv4 peers. If omitted, piranha will not listen for IPv4 connections.
local_ip4 <local IPv4>
local_port4 <tcp port>

# Listening IP/Port for IPv6 peers. If omitted, piranha will not listen for IPv6 connections.
local_ip6 <local IPv6>
local_port6 <tcp port>

# Export options: Choose which route attributes will be exported to the dump files
export origin         # IGP/EGP/Unknown
export nexthop        # NEXT_HOP
export aspath         # AS_PATH
export community      # COMMUNITY
export extcommunity   # EXTENDED COMMUNITY
export largecommunity # LARGE COMMUNITY

# BGP Router Identifier. This MUST be set and may not be 0.0.0.0.
# If you don't know what to put in this option, just copy your public IPv4
# address.
bgp_router_id <ipv4>

# The user that piranha will run as. Because piranha needs
# tcp port 179, it must be started as root. Piranha will then
# operator a privilege downgrade to this use for obvious security
# reasons.
user nobody

# Finally you must configure your BGP neighbors
# You may configure up to 128 neighbors
# (this can be changed in inc/p_defs.h:#define MAX_PEERS 128)
# The password is optional and is implemented as defined in RFC5425
neighbor <IPv4 or IPv6 address> <asn> [password]
neighbor <IPv4 or IPv6 address> <asn> [password]
...

Usage

Start/Stop/Restart

<install dir>/bin/piranhactl <start|restart|stop>

Status (state of all neighbors)

cat <install dir>/var/piranha.status

MAN Pages

man -M <install dir>/man <ptoa|piranha|piranhactl|piranha.conf>

Reading Piranha DUMP

Piranha dumps the received BGP Updates into dump files located in <install dir>/var/dump/<neighbor IP>. Files are rotated by default every 60 seconds. If there was no BGP message during that time, the dump not created for performance reasons. The 60 seconds interval can be tuned with an option of ./configure Dump files ready to be read have the following format: YYYYMMddhhmmss. With the tool <install dir>/bin/ptoa data from the dump files can be exported in three different formats:

  • ./ptoa -H <dump file>: Human readable format
  • ./ptoa -m <dump file>: Machine readable format
  • ./ptoa -j <dump file>: JSON format

Examples

Human readable format

2017-10-21 21:31:54 peer ip 2a03:2260::5 AS 201701 TYPE eBGP
2017-10-21 21:31:54 prefix announce 2a06:dac0::/29 origin IGP aspath 201701 13030 25180 202939 community 5093:5349 6629:6885 7141:7397
2017-10-21 21:31:55 eof

Machine readable format

1508621514|P|2a03:2260::5|201701|eBGP
1508621514|A|2a06:dac0::|29|O|I|AP|201701 13030 25180 202939|C|5093:5349 5605:5861 6629:6885 7141:7397
1508621515|E

JSON format

When decoding JSON, you must decode each line individually. Because dump file can have millions of routes, it would use too much resouces for the decoder to decode them at once. This is why there is one JSON object per line.

{ "timestamp": 1508621514, "type": "peer", "msg": { "peer": { "proto": "ipv6", "ip": "2a03:2260::5", "asn": 201701, "type": "eBGP" } } }
{ "timestamp": 1508621514, "type": "announce", "msg": { "prefix": "2a06:dac0::/29", "origin": "IGP", "nexthop": "2a06:ffff::1", "aspath": [ 201701, 13030, 25180, 202939 ], "community": [ "5093:5349", "5605:5861", "6629:6885", "7141:7397" ] } }
{ "timestamp": 1508621515, "type": "footer" }

Message type tags in DUMPs

Colons can be used to align columns.

Human Machine JSON Description
peer P peer First message in any dump describing the neighbor
announce A announce BGP prefix announce, optional origin (O), nexthop (NH), aspath (AP), community (C) and extended community (EC) subcomponents
withdrawn W withdrawn BGP prefix withdrawn
eof E footer Last message in any dump, has no other value

Conformity

Piranha implements partially or completely the following RFCs:

  • RFC1997: BGP Communities Attribute
  • RFC4360: BGP Extended Communities Attribute
  • RFC4760: Multiprotocol Extensions for BGP-4
  • RFC4271: A Border Gateway Protocol 4 (BGP-4)
  • RFC5425: The TCP Authentication Option
  • RFC5492: Capabilities Advertisement with BGP-4
  • RFC6793: BGP Support for Four-Octet Autonomous System (AS) Number Space
  • RFC8092: BGP Large Communities Attribute

Limitations

  • Config reload does not work and may lead to a crash.
  • Extended communities are present in dump but not yet decoded.
  • Piranha is not able to communicate with BGP speakers not conforming to RFC5492 (old speakers).
  • MD5 protection is only supported on Linux Kernels.

Copyright

Copyright 2004-2017 Pascal Gloor Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

You can’t perform that action at this time.