From 4f48587ad2b14141004a63f1bef0f17117686d80 Mon Sep 17 00:00:00 2001 From: Jay Moore Date: Wed, 12 Apr 2023 16:05:00 +0000 Subject: [PATCH] first commit --- LICENSE | 28 ++++++++++++++++++++++++++++ README.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ getv4.php | 16 ++++++++++++++++ getv4.sh | 15 +++++++++++++++ 4 files changed, 108 insertions(+) create mode 100644 LICENSE create mode 100644 README.md create mode 100644 getv4.php create mode 100644 getv4.sh diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..95d2fee --- /dev/null +++ b/LICENSE @@ -0,0 +1,28 @@ +BSD 3-Clause License + +Copyright (c) 2023, Jay Moore + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +3. Neither the name of the copyright holder nor the names of its + contributors may be used to endorse or promote products derived from + this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..94fafc0 --- /dev/null +++ b/README.md @@ -0,0 +1,49 @@ +# GetV4: Self-Hosted Check IP Service + +This will allow you to obtain your WAN IPv4 address from pfSense in a manner similar to most Check IP webpages. It's +output is simply just the IP address with no additional text. It will only return your machine's IPv4 and is not a +public check IP service. + +This is the same as the version included in HEDyn. + +It is not strictly for pfSense and will work on any machine with a public v4 and php. + +## Installation + +- Modify `getv4.sh` with the interface name of your WAN device. +- Modify `getv4.php` with the path to `getv4.sh` +- Load getv4.php in your browser. + +In pfSense installations, this directory is `/usr/local/www` + +## License + +BSD 3-Clause License + +Copyright (c) 2023, Jay Moore + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +3. Neither the name of the copyright holder nor the names of its + contributors may be used to endorse or promote products derived from + this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + diff --git a/getv4.php b/getv4.php new file mode 100644 index 0000000..48de508 --- /dev/null +++ b/getv4.php @@ -0,0 +1,16 @@ +/* +GetV4: Self-Hosted Check IP Service +12-APR-2023 - dewdude@pickmy.org +https://git.pickmy.org/dewdude/HEDyn +*/ + +// Place this file along with getv4.sh in /usr/local/www on pFSense +// or elsewhere if running on different system. Change script path. +// Change comments for "old" style display if needed. + + + diff --git a/getv4.sh b/getv4.sh new file mode 100644 index 0000000..8145c0d --- /dev/null +++ b/getv4.sh @@ -0,0 +1,15 @@ +#!/bin/sh + +# GetV4 IP Check Service for pfSense - shell script +# APR-12-2023 - Jay Moore (dewdude@pickmy.org) +# https://git.pickmy.org/dewdude/HEDyn + +# Modify `dev` to match your interface name. Place in +# /usr/local/www along with getv4.php. + +# Make sure script is +x + +dev=em0 + +ifconfig $dev | grep inet | awk -F '[ \t]+|/' '{print $3}' | grep -v ^fe80 +#ip -4 addr show dev $dev | awk '/inet/ {print $2}' # for machines using `ip`