diff --git a/README.md b/README.md index 9173056..398407c 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,8 @@ Bird-lg-go An alternative implementation for [bird-lg](https://github.com/sileht/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 -------- @@ -18,11 +20,16 @@ Features implemented: 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") +| 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. @@ -50,18 +57,18 @@ The proxy directory contains the code for the "proxy" for bird commands and trac 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 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. -- --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") -- --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") +| 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: @@ -69,7 +76,7 @@ Example: start proxy with default configuration, should work "out of the box" on Example: start proxy with custom bird socket location: - ./proxy --bird /run/bird.ctl --bird6 /run/bird6.ctl + ./proxy --bird /run/bird.ctl Example: the following docker-compose.yml entry does the same as above, but by starting a Docker container: @@ -79,7 +86,6 @@ Example: the following docker-compose.yml entry does the same as above, but by s 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" @@ -88,6 +94,7 @@ You can use source IP restriction to increase security. You should also bind the Credits ------- +- Everyone who contributed to this project (see Contributors section on the right) - Mehdi Abaakouk for creating [the original bird-lg project](https://github.com/sileht/bird-lg) - [Bootstrap](https://getbootstrap.com/) as web UI framework @@ -95,4 +102,3 @@ License ------- GPL 3.0 - diff --git a/frontend/go.mod b/frontend/go.mod new file mode 100644 index 0000000..5be1cab --- /dev/null +++ b/frontend/go.mod @@ -0,0 +1,5 @@ +module github.com/xddxdd/bird-lg-go/frontend + +go 1.15 + +require github.com/gorilla/handlers v1.5.1 diff --git a/frontend/go.sum b/frontend/go.sum new file mode 100644 index 0000000..f27a04f --- /dev/null +++ b/frontend/go.sum @@ -0,0 +1,4 @@ +github.com/felixge/httpsnoop v1.0.1 h1:lvB5Jl89CsZtGIWuTcDM1E/vkVs49/Ml7JJe07l8SPQ= +github.com/felixge/httpsnoop v1.0.1/go.mod h1:m8KPJKqk1gH5J9DgRY2ASl2lWCfGKXixSwevea8zH2U= +github.com/gorilla/handlers v1.5.1 h1:9lRY6j8DEeeBT10CvO9hGW0gmky0BprnvDI5vfhUHH4= +github.com/gorilla/handlers v1.5.1/go.mod h1:t8XrUpc4KVXb7HGyJ4/cEnwQiaxrX/hz1Zv/4g96P1Q= diff --git a/frontend/render.go b/frontend/render.go index c917967..26e123b 100644 --- a/frontend/render.go +++ b/frontend/render.go @@ -9,20 +9,20 @@ import ( func renderTemplate(w http.ResponseWriter, r *http.Request, title string, content string) { path := r.URL.Path[1:] - split := strings.SplitN(path, "/", 4) + split := strings.SplitN(path, "/", 3) isWhois := strings.ToLower(split[0]) == "whois" whoisTarget := strings.Join(split[1:], "/") // Use a default URL if the request URL is too short - // The URL is for return to IPv4 summary page - if len(split) < 3 { - path = "ipv4/summary/" + strings.Join(setting.servers, "+") + "/" - } else if len(split) == 3 { + // The URL is for return to summary page + if len(split) < 2 { + path = "summary/" + strings.Join(setting.servers, "+") + "/" + } else if len(split) == 2 { path += "/" } - split = strings.SplitN(path, "/", 4) + split = strings.SplitN(path, "/", 3) var args tmplArguments args.Options = map[string]string{ @@ -40,24 +40,20 @@ func renderTemplate(w http.ResponseWriter, r *http.Request, title string, conten "traceroute": "traceroute ...", } args.Servers = setting.servers - args.AllServersLinkActive = strings.ToLower(split[2]) == strings.ToLower(strings.Join(setting.servers, "+")) + args.AllServersLinkActive = strings.ToLower(split[1]) == strings.ToLower(strings.Join(setting.servers, "+")) args.AllServersURL = strings.Join(setting.servers, "+") args.IsWhois = isWhois args.WhoisTarget = whoisTarget - args.URLProto = strings.ToLower(split[0]) - args.URLOption = strings.ToLower(split[1]) - args.URLServer = strings.ToLower(split[2]) - args.URLCommand = split[3] + args.URLOption = strings.ToLower(split[0]) + args.URLServer = strings.ToLower(split[1]) + args.URLCommand = split[2] args.Title = setting.titleBrand + title args.Brand = setting.navBarBrand args.Content = content - err := tmpl.Execute(w, args) - if err != nil { - panic(err) - } + tmpl.Execute(w, args) } // Write the given text to http response, and add whois links for @@ -87,7 +83,7 @@ type summaryTableArguments struct { } // Output a table for the summary page -func summaryTable(isIPv6 bool, data string, serverName string) string { +func summaryTable(data string, serverName string) string { var result string // Sort the table, excluding title row @@ -152,11 +148,7 @@ func summaryTable(isIPv6 bool, data string, serverName string) string { "passive": "table-info", })[row[3]] + `">` // Add link to detail for first column - if isIPv6 { - result += `` + row[0] + `` - } else { - result += `` + row[0] + `` - } + result += `` + row[0] + `` // Draw the other cells for i := 1; i < 6; i++ { result += "" + row[i] + "" diff --git a/frontend/telegram_bot.go b/frontend/telegram_bot.go index 67edc35..446e89a 100644 --- a/frontend/telegram_bot.go +++ b/frontend/telegram_bot.go @@ -87,17 +87,13 @@ func webHandlerTelegramBot(w http.ResponseWriter, r *http.Request) { commandResult := "" // - traceroute - if telegramIsCommand(request.Message.Text, "trace") || telegramIsCommand(request.Message.Text, "trace4") { + if telegramIsCommand(request.Message.Text, "trace") { commandResult = telegramBatchRequestFormat(servers, "traceroute", target, telegramDefaultPostProcess) - } else if telegramIsCommand(request.Message.Text, "trace6") { - commandResult = telegramBatchRequestFormat(servers, "traceroute6", target, telegramDefaultPostProcess) - } else if telegramIsCommand(request.Message.Text, "route") || telegramIsCommand(request.Message.Text, "route4") { + } else if telegramIsCommand(request.Message.Text, "route") { commandResult = telegramBatchRequestFormat(servers, "bird", "show route for "+target+" primary", telegramDefaultPostProcess) - } else if telegramIsCommand(request.Message.Text, "route6") { - commandResult = telegramBatchRequestFormat(servers, "bird6", "show route for "+target+" primary", telegramDefaultPostProcess) - } else if telegramIsCommand(request.Message.Text, "path") || telegramIsCommand(request.Message.Text, "path4") { + } else if telegramIsCommand(request.Message.Text, "path") { commandResult = telegramBatchRequestFormat(servers, "bird", "show route for "+target+" all primary", func(result string) string { for _, s := range strings.Split(result, "\n") { if strings.Contains(s, "BGP.as_path: ") { @@ -106,15 +102,6 @@ func webHandlerTelegramBot(w http.ResponseWriter, r *http.Request) { } return "" }) - } else if telegramIsCommand(request.Message.Text, "path6") { - commandResult = telegramBatchRequestFormat(servers, "bird6", "show route for "+target+" all primary", func(result string) string { - for _, s := range strings.Split(result, "\n") { - if strings.Contains(s, "BGP.as_path: ") { - return strings.TrimSpace(strings.Split(s, ":")[1]) - } - } - return "" - }) } else if telegramIsCommand(request.Message.Text, "whois") { if setting.netSpecificMode == "dn42" { @@ -137,9 +124,9 @@ func webHandlerTelegramBot(w http.ResponseWriter, r *http.Request) { } else if telegramIsCommand(request.Message.Text, "help") { commandResult = ` -/[path|path6] -/[route|route6] -/[trace|trace6] +/path +/route +/trace /whois ` } else { diff --git a/frontend/template.go b/frontend/template.go index 853a072..2dcfac4 100644 --- a/frontend/template.go +++ b/frontend/template.go @@ -17,7 +17,6 @@ type tmplArguments struct { IsWhois bool WhoisTarget string - URLProto string URLOption string URLServer string URLCommand string @@ -49,34 +48,37 @@ var tmpl = template.Must(template.New("tmpl").Parse(`