You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Simon Marsh b441a2f3c4
missing quote in page.tpl
4 months ago
frontend missing quote in page.tpl 4 months ago
proxy Fix bindata build step and parameterize docker build 4 months ago
.gitignore - Use bindata to package static file content in to the frontend binary 4 months ago
.travis.yml Fix bindata build step and parameterize docker build 4 months ago
LICENSE add GPLv3 license file 11 months ago
README.md Remove BIRDv1 support 7 months ago

README.md

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.

The code on master branch no longer support BIRDv1. Branch "bird1" is the last version that supports BIRDv1.

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.

Parameter Environment Variable Description
--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")
--dns-interface BIRDLG_DNS_INTERFACE dns zone to query ASN information (default "asn.cymru.com")
--title-brand BIRDLG_TITLE_BRAND prefix of page titles in browser tabs (default "Bird-lg Go")
--navbar-brand BIRDLG_NAVBAR_BRAND brand to show in the navigation bar (default "Bird-lg Go")

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
  • Sending "restrict" command to BIRD to prevent unauthorized changes
  • Executing traceroute command on Linux, FreeBSD and OpenBSD
  • Source IP restriction

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

Parameter Environment Variable Description
--allowed ALLOWED_IPS IPs allowed to access this proxy, separated by commas. Don't set to allow all IPs. (default "")
--bird BIRD_SOCKET socket file for bird, set either in parameter or environment variable BIRD_SOCKET (default "/var/run/bird/bird.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

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"
  ports:
    - "192.168.0.1:8000:8000"

You can use source IP restriction to increase security. You should also bind the proxy to a specific interface and use an external firewall/iptables for added security.

Credits

License

GPL 3.0