MCPcopy Index your code
hub / github.com/bramp/myip

github.com/bramp/myip @v1.3

Chat with this repo
repository ↗ · DeepWiki ↗ · release v1.3 ↗ · + Follow
92 symbols 240 edges 25 files 54 documented · 59%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

MyIP License Build Status Report card

by Andrew Brampton (bramp.net)

(A better) What's My IP Address web application. Determines both your IPv4 and IPv6 addresses, issues WHOIS and reverse DNS lookups, and shows all your HTTP headers.

Check it in action: ip.bramp.net or read about it on my blog.

ip.bramp.net screenshot

This project was quite literally hacked out in one weekend, and was my first App Engine project.

Install

Prerequisites

  • Google Cloud SDK
  • AppEngine Go SDK

    shell $ gcloud components install app-engine-go

  • Make (which comes on Linux or Mac)

  • npm

Domains

As designed, this Go application will run on the Standard Google App Engine. It requires two to three host names. One that is IPv4 only, and one that is IPv6 only. In my configuration I have ip.bramp.net that has both A and AAAA records, ip4.bramp.net that has only A records, and ip6.bramp.net that only has AAAA records. These all point to the same App Engine instance.

$ dig ip.bramp.net
ip.bramp.net.       300 IN  A   216.239.32.21
ip.bramp.net.       300 IN  AAAA    2001:4860:4802:32::15

$ dig ip4.bramp.net
ip4.bramp.net.      300 IN  A   216.239.32.21

$ dig AAAA ip6.bramp.net
ip6.bramp.net.      300 IN  AAAA    2001:4860:4802:32::15

All three domain names should be configured in main.go (find the prodConfig var).

To deploy:

make deploy # to prod
make stage  # to stage

Development

To run locally we use the addresses, localhost:8080, 127.0.0.1:8080, and http://[::1]:8080. The first can be either, and the latter are IPv4 and IPv6 respectively.

To start up a local instance, just execute:

make serve

When running locally, the server runs in debug mode. Since your local IP address (e.g 127.0.0.1) won't return useful RDAP or WHOIS results, you can override the IP address by passing a host query parameter:

http://localhost:8080/?host=8.8.8.8

This also works with the JSON API:

http://localhost:8080/json?host=8.8.8.8

Note: The host parameter is only available in debug mode and is disabled in production.

To test:

make test

Libraries

To keep libraries up to date run:

make check-updates
make veryclean
make test

TODO

  • [ ] Add rate limiting of requests
  • [ ] Add caching of DNS and WHOIS records (including the iana IP ranges)
  • [ ] Add configuration file, so can be hosted on different domains
  • [ ] Add a favicon.ico
  • [ ] Add Make test (which checks with different build tags, e.g macos,appengine linux,appengine)
  • [ ] Implement a App Engine Flex, and other PaaS environments
  • [ ] Minify all css and js and combine into one file
  • [ ] Do better at determining the root cause errors. e.g If both IPv4/IPv6 fail, then perhaps problem with the site. If IPv6 fails after 30 seconds, perhaps problem with IPv6 connectivity.
  • [ ] Refactor the app. We don't need to seperate appengine and not appengine anymore. The code is almost identical.

Licence (Apache 2)

This is not an official Google product (experimental or otherwise), it is just code that happens to be owned by Google.

Copyright 2017,2020 Google Inc. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Extension points exported contracts — how you extend this code

Server (Interface)
Server is the interface all instances of the myip application should implement. [1 implementers]
lib/myip/server.go

Core symbols most depended-on inside this repo

NewClient
called by 5
lib/rdap/rdap.go
QueryIP
called by 5
lib/rdap/rdap.go
addToWg
called by 5
lib/myip/myip.go
ipNetworkToResponse
called by 4
lib/rdap/rdap.go
formatTextBody
called by 4
lib/rdap/rdap.go
parseLatLong
called by 2
lib/location/location.go
build
called by 2
lib/location/location.go
convertEvents
called by 2
lib/rdap/rdap.go

Shape

Function 63
Method 15
Struct 13
Interface 1

Languages

Go100%

Modules by API surface

lib/rdap/rdap.go16 symbols
lib/myip/server.go11 symbols
lib/myip/output_test.go11 symbols
lib/whois/whois.go8 symbols
lib/location/location.go8 symbols
lib/rdap/rdap_test.go7 symbols
lib/rdap/rdap_integration_test.go5 symbols
appengine/appengine.go4 symbols
lib/myip/myip.go3 symbols
lib/myip/json.go3 symbols
lib/dns/dns.go3 symbols
lib/whois/whois_test.go2 symbols

For agents

$ claude mcp add myip \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact