airgapper / birdlg-go

Birdlg-Go is originally written by LanTian, and this is my arranged and customized edition. Original Author: https://github.com/xddxdd/bird-lg-go

Bird-lg-go

An alternative implementation for bird-lg written in Go. Both frontend and backend (proxy) are implemented, and can work with either the original Python implementation or the Go implementation.

Frontend

The frontend directory contains the code for the web frontend, where users see BGP states, do traceroutes and whois, etc. It's a replacement for "lg.py" in original bird-lg project.

Features implemented:

• Show peering status (show protocol command)
• Query route (show route for ..., show route where net ~ [ ... ])
• Whois and traceroute
• Work with both Python proxy (lgproxy.py) and Go proxy (proxy dir of this project)
• Visualize AS paths as picture (bgpmap feature)

Usage: all configuration is done via commandline parameters or environment variables, no config file.

• --servers / BIRDLG_SERVERS: server name prefixes, separated by comma
• --domain / BIRDLG_DOMAIN: server name domain suffixes
• --listen / BIRDLG_LISTEN: address bird-lg is listening on (default ":5000")
• --proxy-port / BIRDLG_PROXY_PORT: port bird-lgproxy is running on (default 8000)
• --whois / BIRDLG_WHOIS: whois server for queries (default "whois.verisign-grs.com")

Example: the following command starts the frontend with 2 BIRD nodes, with domain name "gigsgigscloud.dn42.lantian.pub" and "hostdare.dn42.lantian.pub", and proxies are running on port 8000 on both nodes.

./frontend --servers=gigsgigscloud,hostdare --domain=dn42.lantian.pub --proxy-port=8000

Example: the following docker-compose.yml entry does the same as above, but by starting a Docker container:

services:
  bird-lg:
    image: xddxdd/bird-lg-go
    container_name: bird-lg
    restart: always
    environment:
      - BIRDLG_SERVERS=gigsgigscloud,hostdare
      - BIRDLG_DOMAIN=dn42.lantian.pub
    ports:
      - "5000:5000"

Demo: https://lg.lantian.pub

Proxy

The proxy directory contains the code for the "proxy" for bird commands and traceroutes. It's a replacement for "lgproxy.py" in original bird-lg project.

Features implemented:

• Sending queries to BIRD and BIRD6
  • If you are using BIRDv2, simply point both --bird and --bird6 to the only socket file of BIRDv2
• Sending "restrict" command to BIRD to prevent unauthorized changes
• Executing traceroute command on Linux, FreeBSD and OpenBSD

Features not implemented yet:

• Source IP restriction

Usage: all configuration is done via commandline parameters or environment variables, no config file.

• --bird / BIRD_SOCKET: socket file for bird, set either in parameter or environment variable BIRD_SOCKET (default "/var/run/bird/bird.ctl")
• --bird6 / BIRD6_SOCKET: socket file for bird6, set either in parameter or environment variable BIRD6_SOCKET (default "/var/run/bird/bird6.ctl")
• --listen / BIRDLG_LISTEN: listen address, set either in parameter or environment variable BIRDLG_LISTEN (default ":8000")

Example: start proxy with default configuration, should work "out of the box" on Debian 9 with BIRDv1:

./proxy

Example: start proxy with custom bird socket location:

./proxy --bird /run/bird.ctl --bird6 /run/bird6.ctl

Example: the following docker-compose.yml entry does the same as above, but by starting a Docker container:

bird-lgproxy:
  image: xddxdd/bird-lgproxy-go
  container_name: bird-lgproxy
  restart: always
  volumes:
    - "/run/bird.ctl:/var/run/bird/bird.ctl"
    - "/run/bird6.ctl:/var/run/bird/bird6.ctl"
  ports:
    - "192.168.0.1:8000:8000"

(As the proxy doesn't have source IP restriction yet, you should only bind the proxy to a specific interface, or use external firewall for security)

Credits

• Mehdi Abaakouk for creating the original bird-lg project
• Bootstrap as web UI framework

License

GPL 3.0