commit 1d60fda3a1bb591fb09ef1b08bee562637ba1c9e Author: CaffeineFueled Date: Sat Jan 10 23:58:55 2026 +0100 init - no version yet diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..2b146bc --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ +Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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. + diff --git a/README.md b/README.md new file mode 100644 index 0000000..ab85418 --- /dev/null +++ b/README.md @@ -0,0 +1,80 @@ +# Chorus Monitoring + +Status: Beta + +Chorus is supposed to be a serverless mesh monitoring 'solution'. + +It is a simple script that checks endpoints via ICMP, HTTP and TCP. Rollout it manually or with any automation tool and use cronjob, systemd timers to run it in your preferred freqyency. + +Goals: +- keeping it simple to understand and to modify +- avoiding a single-point-of-failure + +Use cases: +- let hosts monitor eachother +- let many hosts monitor some endpoints + +Suited for: +- small envs +- homelabs +- temporary envs +- backup monitoring for critical endpoints + +--- + +## Features + +**Available**: +- Check via ICMP,HTTP and TCP +- temp files with down endpoints to avoid notification spam +- modular functions +- simple with board tools only + +**Ideas**: +- host based exclusions +- optional server for logs and status page? +- DNS checks +- file integrity check? +- systemd checks? +- Windows and other platforms? + +**Not planned**: + +--- + +## Installation + +1. modify the script + a. notification methods + b. what endpoint should be monitored. + c. maybe modify threshold of retries after fail +2. rollout script too all endpoints manually or via automation +3. run script perioidicly (cronjob, systemd timers, etc) + +Will rework this section later. + +--- + +## Security + +For security concerns or reports, please contact via `hello a t uphillsecurity d o t com` [gpg](https://uphillsecurity.com/gpg). + +--- + +## License + +**Apache License** + +Version 2.0, January 2004 + +http://www.apache.org/licenses/ + +- ✅ Commercial use +- ✅ Modification +- ✅ Distribution +- ✅ Patent use +- ✅ Private use +- ✅ Limitations +- ❌Trademark use +- ❌Liability +- ❌Warranty diff --git a/chorus-script.sh b/chorus-script.sh new file mode 100755 index 0000000..89b359f --- /dev/null +++ b/chorus-script.sh @@ -0,0 +1,113 @@ +#!/usr/bin/env bash + +# State management +get_state_file() { + echo "/tmp/chorus-monitoring-down-hosts.txt" +} + +is_host_down() { + local type=$1 host=$2 + local state_file=$(get_state_file) + + # If state file doesn't exist, host is not down + [ ! -f "$state_file" ] && return 1 + + # Check if TYPE:HOST exists in state file + grep -qxF "${type}:${host}" "$state_file" +} + +mark_host_down() { + local type=$1 host=$2 + local state_file=$(get_state_file) + + # Create file if it doesn't exist + touch "$state_file" + + # Only add if not already present (idempotent) + if ! grep -qxF "${type}:${host}" "$state_file"; then + echo "${type}:${host}" >> "$state_file" + fi +} + +mark_host_up() { + local type=$1 host=$2 + local state_file=$(get_state_file) + + # If state file doesn't exist, nothing to remove + [ ! -f "$state_file" ] && return 0 + + # Remove the TYPE:HOST line from state file + sed -i "\|^${type}:${host}$|d" "$state_file" +} + +notify() { + local status=$1 type=$2 host=$3 + local emoji message + + if [[ "$status" == "DOWN" ]]; then + emoji="🔴" + message="$emoji [$type] $HOSTNAME says $host is DOWN. $(date -u)" + else + emoji="🟢" + message="$emoji [$type] $HOSTNAME says $host is UP. $(date -u)" + fi + + curl -s -d "$message" \ + https://ntfy.uphillsecurity.com/thisisarandomtpic + # ADD MAIL AND OTHER METHODS HERE +} + +check_with_retries() { + local type=$1 host=$2; shift 2 + + for _ in {1..5}; do + if "$@"; then + echo "$host: reply" + + # Check if host was previously down (state transition: DOWN → UP) + if is_host_down "$type" "$host"; then + mark_host_up "$type" "$host" + notify "UP" "$type" "$host" + fi + + return 0 + fi + sleep 1 + done + + echo "$host: no reply after 5 attempts" + + # Check if host is newly down (state transition: UP → DOWN) + if ! is_host_down "$type" "$host"; then + mark_host_down "$type" "$host" + notify "DOWN" "$type" "$host" + fi + + return 1 +} + +main() { + + # WHAT TO MONITOR + hosts_icmp=("127.0.0.1" "8.8.8.8") + hosts_http=("git.uphillsecurity.com" "uphillsecurity.com" "mettwork.com") + hosts_tcp=("google.com:443" "uphillsecurity.com:22") # PORT REQUIRED + + # CHECKS + for h in "${hosts_icmp[@]}"; do + check_with_retries ICMP "$h" \ + bash -c 'ping -c 1 -W 1 "$1" >/dev/null 2>&1' _ "$h" + done + + for h in "${hosts_http[@]}"; do + check_with_retries HTTP "$h" \ + curl -s -o /dev/null --connect-timeout 1 --max-time 2 -f "https://$h" + done + + for h in "${hosts_tcp[@]}"; do + check_with_retries TCP "$h" \ + bash -c 'nc -z -w 1 "$1" "$2" >/dev/null 2>&1' _ ${h%:*} ${h##*:} + done +} + +main diff --git a/gpg b/gpg new file mode 100644 index 0000000..b67e285 --- /dev/null +++ b/gpg @@ -0,0 +1,51 @@ +-----BEGIN PGP PUBLIC KEY BLOCK----- + +mQINBGjIaswBEAC1yZE46QaONCaNb+jgJNDSY/5sCEEuAx0PP4zJELRLGzpy2gRs +Js4ZW32ycUfrvzxtBRMn4fKtEpoUpWc3zzly8Zs6ZqjxOkAo1x+dEXqLA8BuGr5z +vBSgNTPyGBVihjCoY5FR02SRMUs+/FnuNBdHWst5LgRmULJqWZB4/v8sAUuCZuk/ +ByMqMUsFXuuqBuBZJtDdg8PVMEplF1UIxPEISimnrguF92vvZuNgNmAp4HcciJvn +uUSCg1Uc/Lzwa4B1h9Zx8mDjZGyOPRuiVHzU23Gkh1cHqFQsfD2F7PjWLZgREMAB +QU7FyaPaiP+Qlg/pR2yF7oN/81HzABP8oteHsBadY9UlVbubKR9nSEEf8h6jv6gW +Sye0MffIgberibRG1QtiCAFOaSJg0+urHC4AtUO0aMF+VtPBRSJWMPK6skWzlJSV +qgziECeptXBdEhCPCQzauNezcOHrrH2hJGCWrU6Rw/uaAV4h/bb1hGWK+WHZRnCJ +G5shwqsnaIRsBz2sKl9eFljT1D6QL5u2ifry58FvQk8NAvdxra29SGakx1lU6jsh +Jt/P6bpn7xXBlOGydaGbcY0HyrFnM+TLULxiT1J7BFJe4nTg1NiftrlSMcyfqaf3 +blszHT5Pb6zecxMQrABfeIHoXiOxNgGlO33iFV9H73+6W4CwzVbQhFH8/wARAQAB +tB5jZjcgPGhlbGxvQHVwaGlsbHNlY3VyaXR5LmNvbT6JAlEEEwEKADsWIQQ8vp+a +lCehCyS9lezKKV1kMHTGjAUCaMhqzAIbAwULCQgHAgIiAgYVCgkICwIEFgIDAQIe +BwIXgAAKCRDKKV1kMHTGjIBnD/9ROb4+A+cV/JmVXrYNcsljvOF4Y4au6dRJ6s8H +oMIMC5/IZDIzQcnxfmuyICc7M5YNfQQodPh4d3PcPjM4zytO2TcO/hZiiG44BEh6 +5lV1rAv5lY7dzKmLivluCRmglu2RcSEfhlK8+cSoblNSkI0bbmst1MHDIFyWzOKQ +P41LSNaEnSI59/Aw7UD1jSsP+UlHluMW2lBJuLyRNtQD+hC05y4IPFQOZZyuP3vK +PuVAJXw7AACq6oBmDVTY5g+u12P5xO8hisSJGg0IEa+8WPe8Rcl9EfpT6yWQxsnU +bzirgcyIN34APTCmOA8LkNbt06EIE3U1Uzdmy1i8pR/u6/+kra7P25fEtNRcQJzo +3KdSeHNc8hG5J0CunQO6eZ5OqX/gUb4GBgS62a70jL+HXYUpzClXbSasi5kvA7Wo +SJdWoLPixGecNBQslzu4JtW6+7OwqbkDI5cZ1OoqYVC6HlZPAG8ZDUnxIzc09gDG +xPw//vh4CwXU857U2oFe58RFrtVzd8MaSuUfDxMjV1FMb2wmXn13er5CkoChuQR/ ++a5HWm2XtC5JIDwWngdHkIiw6UthyY2pBxNp+aXCu47jVAaEi+FB4zEHXxTUza22 +FplrEtlQ7tqFCJHWN5S/YxMMjizT4KaBNdh7oQ+lllBVnwtdLtblequ6krOpiCgV +RDO6qbkCDQRoyGrMARAAoWzHzAesDyMP3wg5pKRRSlgNL3XR5wybpCoJN19zs2IP +vYbcvRkepMJb5V/XCHNPxb7rsIUP2zc+7ndsWM2IqHMKfrHEqe7vrWkTzHANYGnb +A/MdgU6mkJDqX0POZNREtLmwYlQX07JFOgWVPQ3uYoiJrX5PJCD+DDgKwyPchhOi +kieSxZYbGsuVfnCmRm0Lz4Kh0CC7pszbSzOJgtzhbhronK8YXW3ePxCgiqbUrNi2 +wdWsjirmDRi5ax4JyXhWb8xrvq8i+uB3W3nguNPITtw+X97Ikr3ZqY44Y0RA8WeC +dWRPOJ1agNOfF/KVuC0XiYuuBMtq4zQQ12sBAbfmZqF4g0IZeuSATqmqBlMF/m33 +apxhitHA6vB7X4kzLb4If8O7fokQEDlHJmsGRqTUIG310LqJgT5tcJuO+gbMt/io +jM60jmrUTKyWMhTFl1sJNLREPTkZR8gXpD7JJpAk/XpClk8X16Yy26nwIfbrb18M +LBW8gXgekyrQU69W9yxz2aSBvd59bKH93M+pHNi8ZH1c7TM2NUrP77x3NKh2PplN +9Kipaidre2UGurri60QZ6tIVESK2A3IMU+Y7RAJFh9JoSBILgc2roZ+ej9lFZtws +ybtl7tePc5/hNFy6mnO7xkPCYVOvGHlSQChDayAVeNyYw7wxiu3wGBELnacjJVkA +EQEAAYkCNgQYAQoAIBYhBDy+n5qUJ6ELJL2V7MopXWQwdMaMBQJoyGrMAhsMAAoJ +EMopXWQwdMaMXCwQAIQxk3UuarQjHMk6mvRzkxiZOh8jFj5emLrizdnsyXoWtbWs +bsaKkupQvDRW1ONc5QW/VvYJpX2W1L+Hbc+iNMmu9FlIJULiQraDW04N4/VAG5Dq +JvU2SgbMyLGvso1QbvzWNe0Eu7NuCp5p9IlCbI9Udjn6YwvqTqpBRb61EsxEEb4G +tB29F20GHCR9sh1ck1OnzSWPuJ5Q0fATdmKEegnhLwSMbBJ4m9E8ZGfoV8hBqOKD +xA/0DVkac7jorZNXPRVO4lq+HuhbWf6/QIaqXokD3R2NcSCBEHUnKxJonBSySeu1 +KhWRb0523VVv184KDqL9+iMp2yRffDaXf+ktpeBdOmoeqqNcEbPTvPF5XJLzcT9h +wDW+3R6+Lm52RQfJufeONL2IvjDJ9Ke5v8yriFbLCBXNYhMJU9TpRrkyfSYgXrV6 +xLy3p61fDfG/8WxBcytZ6gRiHtiA89BBhFzGaW2nYEn/+vSvVAR7cBLQy9oO0k0U +y5j4/tAW3xd7gcLRblEheisDD30srGQO2S4Fsb3xadQjfG6hUHyhujeSPgMPLW94 +v/PBQM/xaiL2Jt8OHtB1i6aa7Kz7i5HDTYBYe9Zfhf7CLnJFJH8SokSeYWRhDxNT +TrDRiTWRjHoMR9HE9kB25/dVXUyaZqiB2ty8tUb8w2QQ95wPzd9wQQ8L2JmG +=kz1r +-----END PGP PUBLIC KEY BLOCK-----