Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gamemann/ip-asn-list
A Go application that outputs prefixes to a text file and supports ASN lookups.
https://github.com/gamemann/ip-asn-list
asn go golang ip list
Last synced: 2 months ago
JSON representation
A Go application that outputs prefixes to a text file and supports ASN lookups.
- Host: GitHub
- URL: https://github.com/gamemann/ip-asn-list
- Owner: gamemann
- License: mit
- Created: 2020-06-02T20:53:52.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-12-09T12:22:15.000Z (about 2 years ago)
- Last Synced: 2024-10-11T02:25:18.198Z (3 months ago)
- Topics: asn, go, golang, ip, list
- Language: Go
- Homepage: https://moddingcommunity.com/
- Size: 22.5 KB
- Stars: 23
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# IP/ASN List
## Description
A Go program that acts as a web server. This program loops through all `.json` files in the `lists/` directory and parses each list. Each list can contain an array of prefixes and ASNs. There are lookups performed on the ASNs via [BGPView](https://bgpview.docs.apiary.io/#reference/0/asn-prefixes/view-asn-prefixes)'s API. Afterwards, it outputs all prefixes to a file in the `public/` directory where clients can view them assuming they have the correct authorization header set from the config.
## Why Did I Make This?
After implementing my own custom filters into [Compressor V1](https://github.com/Dreae/compressor/) to mitigate (D)DoS attacks against GFL's Anycast network, I decided to implement whitelisting functionality for specific services. However, I didn't want to update these files locally on each POP every time I had to add a prefix. Therefore, I decided to create this program and have each POP cURL each list for specific services (with the correct authorization header set) and save them locally every five - ten minutes.
## Config
You can change settings in the `settings.conf` file which is in JSON format. Here's the default config:
```
{"token": "CHANGEME", "port": 7030, "updatetime": 10, "maxitems": 10, "ignorefailure": false, "debug": false, "random": true}
```
* `token` => The authorization header that must be set when accessing the list publicly.
* `port` => The port the web server binds to.
* `updatetime` => How often to update all lists.
* `maxitems` => The maximum amount of lists to update at once.
* `ignorefailure` => If false, if an ASN lookup fails on a specific list, the list will not be written to. This is useful if you're facing rate limiting with BGPView.
* `debug` => Whether to enable debugging.
* `random` => If true, when scanning the `lists/` directory, will randomize the order of the lists to update.
## Lists
Each list config needs to have a file with the format `lists/.json`. Here's an example of the test list (`lists/test.json`):
```
{
"ASN": [
398129,
32590
],
"Prefix": [
"192.168.90.1/32",
"192.168.90.2/32"
]
}
```
The above configuration will output all prefixes from ASN's 398129 and 32590 along with the additional prefixes `192.168.90.1/32` and `192.168.90.2/32` to `public/test.txt`.
## REST API
This application supports a simple REST API for adding/removing prefixes/ASNs from specific lists.
For adding/removing a prefix, use the route `/prefix` (e.g. `https://api.example.com/prefix`). If you're adding a prefix, use the method type `PUT`. Otherwise, use the method type `DELETE`. Form values include `list` which is the list name without the file extension (e.g. `test` mapping to `lists/test.json`) and `prefix` which is a string containing the prefix you'd like to add/remove (e.g. `192.168.90.1/32`).
For adding/removing an ASN, use the route `/asn` (e.g. `https://api.example.com/asn`). If you're adding an ASN, use the method type `PUT`. Otherwise, use the method type `DELETE`. Form values include `list` which is the list name without the file extension (e.g. `test` mapping to `lists/test.json`) and `asn` which is an integer of the ASN you'd like to add/remove (e.g. `398129`).
**Note** - In order to use this API, the request must send an authorization header with a value equal to the `token` value in the `settings.conf` file. In the future, I may look into implementing a separate authorization key for using the REST API so you can separate read/write operations within the application. However, this suits my network's needs for now.
## Building
You may use the following commands to build this project.
```
cd src/
go build -o ../iplist
```
## Credits
* [Christian Deacon](https://www.linkedin.com/in/christian-deacon-902042186/) - Creator.
* [BGPView](https://bgpview.docs.apiary.io/#reference/0/asn-prefixes/view-asn-prefixes) - ASN lookup API.