Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/myzie/burrow

Burrow is a globally distributed HTTP proxy via AWS Lambda
https://github.com/myzie/burrow

aws aws-lambda golang http proxy proxy-server serverless

Last synced: 4 days ago
JSON representation

Burrow is a globally distributed HTTP proxy via AWS Lambda

Awesome Lists containing this project

README 

        
# Burrow



Burrow is a serverless and globally-distributed HTTP proxy for Go built on

AWS Lambda.



It is designed to be completely compatible with the standard Go `*http.Client`

which means it can be transparently added to many existing applications. Burrow

provides an implementation of the `http.RoundTripper` interface that proxies

requests through one or more AWS Lambda functions exposed with

[Function URLs](https://docs.aws.amazon.com/lambda/latest/dg/urls-configuration.html).



A round-robin transport is also provided which makes it trivial to automatically

rotate through multiple Lambda functions in different regions.



## Rationale



Burrow gives you a network of rotating IPs in different regions, which can be

useful in a variety of situations, including:



- Development: test how your app behaves when accessed from different regions.

- Load testing: simulate distributed global traffic for your services.

- Privacy: anonymous IP addresses when making web requests.

- Geo-restriction bypass: access region-limited content or services.

- API rate limiting: reduce the effects of IP address usage quotas when calling APIs.

- Web scraping: efficiently collect data in a distributed manner.

- Multi-region testing: Verify application behavior across different global regions.



Performance for individual requests through Burrow can be slow, especially when

routing through distant regions. However, Burrow is designed for highly concurrent

use in Go, where overall throughput matters more than individual request latency.



## Features



- Easy-to-use proxy via `http.RoundTripper` implementation

- Optional round-robin transport for rotating through multiple lambda proxies

- Terraform for one command deployment to 17 AWS regions



## Usage



Add burrow package to your Go project:



```bash

go get github.com/myzie/burrow

```



Enable on an `http.Client`:



```go

proxy := "https://randomprefix.lambda-url.eu-west-2.on.aws/"

client := &http.Client{Transport: burrow.NewTransport(proxy, "POST")}

// Now use the *http.Client as you would normally

```



Create a round-robin transport:



```go

proxies := []string{

    "https://randomprefix1.lambda-url.us-east-1.on.aws/",

    "https://randomprefix2.lambda-url.us-east-2.on.aws/",

    "https://randomprefix3.lambda-url.us-west-1.on.aws/",

}

var transports []http.RoundTripper

for _, u := range proxies {

    transports = append(transports, burrow.NewTransport(u, "POST"))

}

client := &http.Client{

    Transport: burrow.NewRoundRobinTransport(transports),

}

// Client will now rotate through the provided proxies for each request

```



Or use the `burrow.NewRoundRobinClient` helper:



```go

client := burrow.NewRoundRobinClient([]string{

    "https://randomprefix1.lambda-url.us-east-1.on.aws/",

    "https://randomprefix2.lambda-url.us-east-2.on.aws/",

    "https://randomprefix3.lambda-url.us-west-1.on.aws/",

})

```



## Multi-Region Deployment in AWS



Burrow includes Terraform configurations to deploy Burrow across the 17

default-enabled AWS regions in your account with a single command:



```bash

make deploy BUCKET_NAME=my-terraform-state-bucket

```



When the command completes, a `function_urls.json` file is written which contains

the URL for each Lambda function in each region. You can then read this file in

your Go program and pass the values to `burrow.NewRoundRobinClient`.



See the Makefile for more information. You'll need the following installed:



- terraform

- make

- go

- jq

- aws cli



The default-enabled AWS regions:



```

ap-northeast-1 - Tokyo

ap-northeast-2 - Seoul

ap-northeast-3 - Osaka

ap-south-1 - Mumbai

ap-southeast-1 - Singapore

ap-southeast-2 - Sydney

ca-central-1 - Canada Central

eu-central-1 - Frankfurt

eu-north-1 - Stockholm

eu-west-1 - Ireland

eu-west-2 - London

eu-west-3 - Paris

sa-east-1 - Sao Paulo

us-east-1 - N. Virginia

us-east-2 - Ohio

us-west-1 - N. California

us-west-2 - Oregon

```



## Future Enhancements



- Optional API key authentication in the Lambda proxy

- Tests

- Other suggestions?



## Examples



- [cmd/example_client/main.go](cmd/example_client/main.go)

- [cmd/example_multi_region/main.go](cmd/example_multi_region/main.go)



The multi-region example makes requests to `https://api.ipify.org?format=json`

to demonstrate how the proxy IP address changes across regions.



```bash

$ go run ./cmd/example_multi_region

{"ip":"13.36.171.187"}

{"ip":"13.208.187.84"}

{"ip":"18.142.184.58"}

{"ip":"3.106.212.219"}

{"ip":"13.60.11.169"}

{"ip":"43.200.183.53"}

{"ip":"3.127.170.76"}

{"ip":"3.238.225.252"}

{"ip":"54.185.130.119"}

{"ip":"54.168.55.243"}

{"ip":"13.201.18.225"}

{"ip":"15.222.11.134"}

{"ip":"54.247.221.168"}

{"ip":"13.40.174.185"}

{"ip":"15.228.175.92"}

{"ip":"3.137.163.176"}

{"ip":"54.177.165.5"}

{"ip":"13.36.171.187"} # Back to the first region

```



## Custom Development and Consulting



The author of Burrow [@myzie](https://github.com/myzie) is available for

contract work and consulting. Feel free to reach out on Github or Linkedin for

help with anything related to Go, AWS, Terraform, cloud security, or SaaS

development. See my [profile](https://github.com/myzie) for my Linkedin.



## Contributing



Contributions are welcome! Please feel free to submit a pull request.



## License



Apache License 2.0