Skip to main content

A simple WSGI app that returns the value of the `X-Forwarded-For` header

Project description

WSGIEchoIP

$ curl -L ip.jb2170.com
12.34.56.78

A simple WSGI app that returns the value of the X-Forwarded-For header, so one can get their public IP address.

No more need for $ curl -L -D - ipconfig.org and its unnecessary cookies!

This is a useful 'just-werks' app, and demonstrates using WSGI without a framework such as Flask. The only thing to really be aware of in raw WSGI is that strings are bytes decoded as Latin-1, as per PEP-3333, when in reality there's a 99% chance the bytes should've been decoded as UTF-8. Therefore if one is concerned about Unicode headers etc the WSGI environment strings should be corrected with .encode("latin1").decode("utf8"). This is one of the many reasons to use a framework like Flask in a production app.

Installing

I run this as a reverse proxy via Apache. Example systemd unit files and friends are in daemon-files of this repo

  • create a venv, say in ~/.local/var/lib/WSGIEchoIP, and source it
  • $ pip install WSGIEchoIP gunicorn
  • place the systemd unit file and shell script into the correct folders, for example I use ~/.local/var/lib/systemd/{etc/user,usr/bin}
  • place the .htaccess file in the public http folder corresponding to the domain you want to serve the app from
  • adjust the unix socket path in the .htaccess file and .service unit

Make sure you have the headers, proxy, and proxy_http modules enabled for Apache!

You can probably figure out the rest, enabling / starting the systemd service...

Customizing

Setting the environment variable FORWARDED_IP_HEADER_NAME=X-Sneed-Chuck makes the app return the X-Sneed-Chuck header value instead. (perhaps nginx uses something different than X-Forwarded-For.)

See also

  • FlaskEchoIP, a Flask version of this app that I also made, which is why this one is now archived

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wsgiechoip-1.1.1.tar.gz (40.2 kB view details)

Uploaded Source

Built Distribution

WSGIEchoIP-1.1.1-py3-none-any.whl (27.9 kB view details)

Uploaded Python 3

File details

Details for the file wsgiechoip-1.1.1.tar.gz.

File metadata

  • Download URL: wsgiechoip-1.1.1.tar.gz
  • Upload date:
  • Size: 40.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.7

File hashes

Hashes for wsgiechoip-1.1.1.tar.gz
Algorithm Hash digest
SHA256 1ac7d44ded524e0e4d2b088252a3b9aad0802e04b273e5b3b592c35faa86de6a
MD5 4725efbf4a50b167aaff8a690ab2722e
BLAKE2b-256 cc770ac41bcb37ca3d04bb63978033e7a8f358ee163cecd00220bf4a4962628a

See more details on using hashes here.

File details

Details for the file WSGIEchoIP-1.1.1-py3-none-any.whl.

File metadata

  • Download URL: WSGIEchoIP-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 27.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.7

File hashes

Hashes for WSGIEchoIP-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ad5770eafcdf9513a37c1dd080fed01f3ce5596432bb6197fe6399f366b6a0e9
MD5 e3cd384b8f80a7189e6c3438bdd1ed7f
BLAKE2b-256 182cc29e97a8fafbcf19374ff2d4ec7ac3419623ba6ff9cf78672b528a0f1cf3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page