mycfsg/api-proxy-gzip repository overview

Canonical documentation at: https://gitlab.com/mycf.sg/api-proxy-gzip⁠

⁠ProxyGzip

A proxy service that assists in compressing your requests via gzip.

⁠Why this exists

Some policies enforce analysis of ingoing and outgoing through decoding of body data. A method needed to be devised to re-encode this data upon exiting the internal network before hitting the final destination.

This is it.

⁠Usage

⁠How it works

This server takes in any request and transforms the request so that:

1. The body data is compressed with gzip
2. The Content-Length header will be set to the length of the gzipped content
3. The Content-Encoding header will be set to "gzip"
4. The Content-Type header will be derived from your data, or if the CONTENT_TYPE environment variable is set, that
5. All other headers sent are re-constructed from the original client request and forwarded to the next hop server AS-IS

The transformed request is then forwarded to the next hop server and a response is received. This response is processed such that:

1. The next hop response headers will be reflected in the response to the client AS-IS
2. The client request headers will be reflected in the response headers prefixed with pgz-request-*
3. The proxy server configuration will be reflected in the response headers prefixed with pgz-config-*

⁠Configuration

⁠Application Environment Variables

Use the following variables to configure the application.

⁠Deployment

⁠Docker Compose

See the example file⁠.

⁠Kubernetes

See the example manifests⁠.

⁠Response Interpretation

⁠Status Code

The status code will reflect the status code of the next hop response.

⁠Headers

Headers prefixed with pgz-config- display the configuration of the ProxyGzip server.

Headers prefixed with pgz-request- display headers from the client's request.

Headers not prefixed are headers from the next hop server.

⁠Contributing

• Development tooling is performed via the Makefile.
• Dependency management is done via Go Modules (from Go 1.11)
• Non-collabs: Fork, make changes on your fork's master branch, and then issue a pull request back for changes
• Collabs: Make changes on a branch other than master, issue a merge request
• For quickening the process/if this repo seems dead, ping the maintainers⁠

⁠Running locally

make

⁠(Manually) Getting dependencies in

make deps

⁠Running tests

make test

⁠Binary generation (compilation)

# compiles for all operating systems and architectures
make compile

# for windows
make compile.windows

# for macos
make compile.macos

# for linux
make compile.linux

⁠Bundling Docker image for production

make package

⁠Publish Docker image

make release

⁠Continuous Integration Configuration

⁠Available pipelines

Currently, there exists integrations for:

• GitLab CI (for GitLab hosting)
• TraviS CI (for GitHub hosting)

⁠Environment setup

⁠Generating SSH Deploy Keys

Run the following to generate a set of keys to use for your deploy keys:

make ssh.keys

You can find the keys in the ./bin directory as id_rsa (the private key) and id_rsa.pub (the public key). There should also be a Base 64 encoded version of the private key named id_rsa.b64 which you can copy the contents and paste into the relevant x_SSH_DEPLOY_KEY in the Pipeline Environment Variables table below⁠.

⁠Inserting SSH Deploy Keys - GitHub

Go to your repository and click on Settings > Deploy keys and hit the Add deploy key button on the top right of the page. Paste the contents of id_rsa.pub there as the key. Note: do not base64 encode this one.

⁠Inserting SSH Deploy Keys - GitLab

Go to your repository's side menu in Settings > Repository > Deploy Keys and add the contents of id_rsa.pub there as the key. Note: do not base64 encode this one.

⁠Pipeline Environment Variables

Before running the CI pipeline, you need to input the following build pipeline variables:

⁠TODOS

• Healthchecks to verify next hop server is alive
• Healthchecks to verify self-health
• Distributed tracing
• Logs collation

⁠License

This project is licensed under the MIT license⁠.

⁠Cheers