gpip

gpip

HTTP service that returns callers IP address

gpip is a service to be used for returning callers IP address. A single endpoint to handle requests.

It supports supports application/json and text/plain for handling different response types. To determine the calling IP the headers Forwarded, then X-Forwarded-For and finally X-Real-IP are checked before falling back to incoming remote address.

Contents

• Endpoints
• Configuration
• Build
• Deployment
• Additional credits

Endpoints

// Get IP as JSON
// With Accept: application/json, Accept: */* or no Accept header provided
// it will respond with application/json.
Accept: application/json
GET /

// Response
{"ip":"<ip-address>"}

// Get IP as text/plain
Accept: text/plain
GET /

// Response
<ip-address>

Configuration

gpip listens by default on address 0.0.0.0:5050. To configure host and port, flags or environment variables can be used.

Environment variables

GPIP_LISTEN_HOST=0.0.0.0
GPIP_LISTEN_PORT=5050

Flags

gpip -host 0.0.0.0 -port 5050

Build

Provided build script, build.sh will run tests, compile application and finally build a docker image.

Usage

Syntax:
# Build binary. Will default to Linux.
./build.sh --version <version>

# Build binary for MacOS.
./build.sh --version <version> --platform darwin

# Build for binary for linux and build docker image.
./build.sh --version <version> --docker

Deployment

gpip can be hosted in a matter of ways. It has been tested on:

• Kubernetes (AKS)
• Azure WebApp for Containers

Any platform that can pass on source ip, either through the use of headers Forwarded, X-Forwarded-For, X-Real-IP, or some other form of manupilating the remote address of the request will do.

Additional credits

Inspiration to intercepting and logging request was inspired/taken from a reply by user nemith at this reddit post, and a reply by huangapple at this Stack Overflow post. So credit to those posts and posters.