Skip to content

Add support for Telegram and Discord alerts #117

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mokaton wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Add support for Telegram and Discord alerts #117

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
eaa5b66
Add support for telegram and discord alerts
mokaton Jan 27, 2022
c3d5f60
Update Usage and Examples descriptions
mokaton Jan 27, 2022
67327d1
Update code comments
mokaton Jan 27, 2022
182791a
Fix the issue if use messengers notification and not email
mokaton Jan 27, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,12 @@ Usage: ./ssl-cert-check [ -e email address ] [ -E sender email address ] [ -x da
-b : Will not print header
-c cert file : Print the expiration date for the PEM or PKCS12 formatted certificate in cert file
-d cert directory : Print the expiration date for the PEM or PKCS12 formatted certificates in cert directory
-D webhook path : Set Discord webhook path (looks like {webhook.id}/{webhook.token})
-e E-mail address : E-mail address to send expiration notices
-E E-mail address : Sender E-mail address
-f cert file : File with a list of FQDNs and ports
-g bot token : Set Telegram bot token
-G chat id : Set Telegram chat id
-h : Print this screen
-i : Print the issuer of the certificate
-k password : PKCS12 file password
Expand Down Expand Up @@ -61,6 +64,18 @@ Send an e-mail to admin@prefetch.net if a domain listed in ssldomains will expir
$ ssl-cert-check -a -f ssldomains -q -x 60 -e admin@prefetch.net
</pre>

Send an alarm to Telegram messenger if a domain listed in ssldomains will expire in the next 60-days:

<pre>
$ ssl-cert-check -a -f ssldomains -q -x 60 -g "123456789:AAA_nvmldslAS23FlmsadFA7Llmsa3lmsd" -G 26437058
</pre>

Send an alarm to Discord messenger if a domain listed in ssldomains will expire in the next 60-days:

<pre>
$ ssl-cert-check -a -f ssldomains -q -x 60 -D "123456789/AAA_nvmldslAS23FlmsadFA7Llmsa3lmsd"
</pre>

# Additional Documentation

Documentation And Examples: http://prefetch.net/articles/checkcertificate.html
168 changes: 120 additions & 48 deletions ssl-cert-check
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -305,6 +305,21 @@ NAGIOS="FALSE"
# Don't summarize Nagios output by default (cmdline: -N)
NAGIOSSUMMARY="FALSE"

# Don't send alert to Discord by default
DISCORD="FALSE"

# A part of Discord url to webhook (cmdline: -D "123456789/AAA_nvmldslAS23FlmsadFA7Llmsa3lmsd")
DISCORD_WEBHOOK=""

# Don't send alert to Telegram by default
TELEGRAM=0

# Telegram bot token (cmdline: -g "123456789:AAA_nvmldslAS23FlmsadFA7Llmsa3lmsd")
TELEGRAM_BOT_TOKEN=""

# Telegram chat or user id (cmdline: -G 26437058)
TELEGRAM_CHAT_ID=""

# NULL out the PKCSDBPASSWD variable for later use (cmdline: -k)
PKCSDBPASSWD=""

Expand All @@ -321,29 +336,6 @@ SED=$(command -v sed)
MKTEMP=$(command -v mktemp)
FIND=$(command -v find)

# Try to find a mail client
if [ -f /usr/bin/mailx ]; then
MAIL="/usr/bin/mailx"
MAILMODE="mailx"
elif [ -f /bin/mail ]; then
MAIL="/bin/mail"
MAILMODE="mail"
elif [ -f /usr/bin/mail ]; then
MAIL="/usr/bin/mail"
MAILMODE="mail"
elif [ -f /sbin/mail ]; then
MAIL="/sbin/mail"
MAILMODE="mail"
elif [ -f /usr/sbin/mail ]; then
MAIL="/usr/sbin/mail"
MAILMODE="mail"
elif [ -f /usr/sbin/sendmail ]; then
MAIL="/usr/sbin/sendmail"
MAILMODE="sendmail"
else
MAIL="cantfindit"
MAILMODE="cantfindit"
fi

# Return code used by nagios. Initialize to 0.
RETCODE=0
Expand Down Expand Up @@ -409,6 +401,41 @@ send_mail() {
esac
}


#####################################################
### Send to Discord messenger
### $1 -> Message text
#####################################################
send_to_discord () {

MSG=${1}
MSG=$(sed 's/\"/\\\\\\"/g' <<< "${MSG}")

URL="https://discord.com/api/webhooks/${DISCORD_WEBHOOK}"

PAYLOAD='{"content": "'${MSG}'"}'

curl -X POST -H "Content-Type: application/json" -s -d "${PAYLOAD}" $URL
}


#####################################################
### Send to Telegram messenger
### $1 -> Message text
#####################################################
send_to_telegram () {

MSG=${1}
MSG=$(sed 's/\"/\\\\\\"/g' <<< "${MSG}")

URL="https://api.telegram.org/bot${TELEGRAM_BOT_TOKEN}/sendMessage"

PAYLOAD='{"chat_id":"'${TELEGRAM_CHAT_ID}'","text": "'${MSG}'"}'

curl -X POST -H "Content-Type: application/json" -s -d "${PAYLOAD}" $URL >> /dev/null
}


#############################################################################
# Purpose: Convert a date from MONTH-DAY-YEAR to Julian format
# Acknowledgements: Code was adapted from examples in the book
Expand Down Expand Up @@ -444,8 +471,7 @@ date2julian() {
# Arguments:
# $1 -> Month name (e.g., Sep)
#############################################################################
getmonth()
{
getmonth() {
case ${1} in
Jan) echo 1 ;;
Feb) echo 2 ;;
Expand All @@ -469,8 +495,7 @@ getmonth()
# $1 -> Date #1
# $2 -> Date #2
#############################################################################
date_diff()
{
date_diff() {
if [ "${1}" != "" ] && [ "${2}" != "" ]; then
echo $((${2} - ${1}))
else
Expand All @@ -490,8 +515,7 @@ date_diff()
# $7 -> Common Name
# $8 -> Serial Number
#####################################################################
prints()
{
prints() {
if [ "${NAGIOSSUMMARY}" = "TRUE" ]; then
return
fi
Expand Down Expand Up @@ -524,8 +548,7 @@ prints()
# Arguments:
# None
####################################################
print_heading()
{
print_heading() {
if [ "${NOHEADER}" != "TRUE" ]; then
if [ "${QUIET}" != "TRUE" ] && [ "${ISSUER}" = "TRUE" ] && [ "${NAGIOS}" != "TRUE" ] && [ "${VALIDATION}" != "TRUE" ]; then
${PRINTF} "\n%-35s %-17s %-8s %-11s %-4s\n" "Host" "Issuer" "Status" "Expires" "Days"
Expand All @@ -551,8 +574,7 @@ print_heading()
# Arguments:
# None
####################################################
print_summary()
{
print_summary() {
if [ "${NAGIOSSUMMARY}" != "TRUE" ]; then
return
fi
Expand All @@ -574,8 +596,7 @@ print_summary()
# Arguments:
# $1 -> New returncorde
#############################################################
set_returncode()
{
set_returncode() {
if [ "${RETCODE}" -lt "${1}" ]; then
RETCODE="${1}"
fi
Expand All @@ -590,8 +611,7 @@ set_returncode()
# $4 -> Date when certificate will expire
# $5 -> Days left until the certificate will expire
########################################################################
set_summary()
{
set_summary() {
if [ "${1}" -eq 0 ]; then
SUMMARY_VALID=$((SUMMARY_VALID+1))
elif [ "${1}" -eq 1 ]; then
Expand All @@ -613,18 +633,20 @@ set_summary()
# Arguments:
# None
##########################################
usage()
{
usage() {
echo "Usage: $0 [ -e email address ] [-E sender email address] [ -x days ] [-q] [-a] [-b] [-h] [-i] [-n] [-N] [-v]"
echo " { [ -s common_name ] && [ -p port] } || { [ -f cert_file ] } || { [ -c cert file ] } || { [ -d cert dir ] }"
echo ""
echo " -a : Send a warning message through E-mail"
echo " -b : Will not print header"
echo " -c cert file : Print the expiration date for the PEM or PKCS12 formatted certificate in cert file"
echo " -d cert directory : Print the expiration date for the PEM or PKCS12 formatted certificates in cert directory"
echo " -D webhook path : Set Discord webhook path (looks like {webhook.id}/{webhook.token})"
echo " -e E-mail address : E-mail address to send expiration notices"
echo " -E E-mail sender : E-mail address of the sender"
echo " -f cert file : File with a list of FQDNs and ports"
echo " -g bot token : Set Telegram bot token"
echo " -G chat id : Set Telegram chat id"
echo " -h : Print this screen"
echo " -i : Print the issuer of the certificate"
echo " -k password : PKCS12 file password"
Expand Down Expand Up @@ -776,17 +798,31 @@ check_file_status() {

if [ "${CERTDIFF}" -lt 0 ]; then
if [ "${ALARM}" = "TRUE" ]; then
send_mail "${SENDER}" "${ADMIN}" "Certificate for ${HOST} \"(CN: ${COMMONNAME})\" has expired!" \
"The SSL certificate for ${HOST} \"(CN: ${COMMONNAME})\" has expired!"
SUBJECT="Certificate for ${HOST} \"(CN: ${COMMONNAME})\" has expired!"
if [ "${DISCORD}" = "TRUE" ]; then
send_to_discord "${SUBJECT}"
elif [[ "${TELEGRAM}" -ge 2 ]]; then
send_to_telegram "${SUBJECT}"
else
send_mail "${SENDER}" "${ADMIN}" \
"The SSL certificate for ${HOST} \"(CN: ${COMMONNAME})\" has expired!"
fi
fi

prints "${HOST}" "${PORT}" "Expired" "${CERTDATE}" "${CERTDIFF}" "${CERTISSUER}" "${COMMONNAME}" "${SERIAL}"
RETCODE_LOCAL=2

elif [ "${CERTDIFF}" -lt "${WARNDAYS}" ]; then
if [ "${ALARM}" = "TRUE" ]; then
send_mail "${SENDER}" "${ADMIN}" "Certificate for ${HOST} \"(CN: ${COMMONNAME})\" will expire in ${CERTDIFF} days or less" \
"The SSL certificate for ${HOST} \"(CN: ${COMMONNAME})\" will expire on ${CERTDATE}"
SUBJECT="Certificate for ${HOST} \"(CN: ${COMMONNAME})\" will expire in ${CERTDIFF} days or less"
if [ "${DISCORD}" = "TRUE" ]; then
send_to_discord "${SUBJECT}"
elif [[ "${TELEGRAM}" -ge 2 ]]; then
send_to_telegram "${SUBJECT}"
else
send_mail "${SENDER}" "${ADMIN}" "${SUBJECT}" \
"The SSL certificate for ${HOST} \"(CN: ${COMMONNAME})\" will expire on ${CERTDATE}"
fi
fi
prints "${HOST}" "${PORT}" "Expiring" "${CERTDATE}" "${CERTDIFF}" "${CERTISSUER}" "${COMMONNAME}" "${SERIAL}"
RETCODE_LOCAL=1
Expand All @@ -804,16 +840,22 @@ check_file_status() {
#################################
### Start of main program
#################################
while getopts abc:d:e:E:f:hik:nNp:qs:St:Vx: option
while getopts abc:d:D:e:E:f:g:G:hik:nNp:qs:St:Vx: option
do
case "${option}" in
a) ALARM="TRUE";;
b) NOHEADER="TRUE";;
c) CERTFILE=${OPTARG};;
d) CERTDIRECTORY=${OPTARG};;
D) DISCORD="TRUE"
DISCORD_WEBHOOK=${OPTARG};;
e) ADMIN=${OPTARG};;
E) SENDER=${OPTARG};;
f) SERVERFILE=$OPTARG;;
g) TELEGRAM+=1
TELEGRAM_BOT_TOKEN=${OPTARG};;
G) TELEGRAM+=1
TELEGRAM_CHAT_ID=${OPTARG};;
h) usage
exit 1;;
i) ISSUER="TRUE";;
Expand All @@ -835,6 +877,34 @@ do
esac
done

# Try to find a client
if [ "$SENDER" = "messenger" ]; then
MAIL="messenger"
MAILMODE="messenger"
elif [ -f /usr/bin/mailx ]; then
MAIL="/usr/bin/mailx"
MAILMODE="mailx"
elif [ -f /bin/mail ]; then
MAIL="/bin/mail"
MAILMODE="mail"
elif [ -f /usr/bin/mail ]; then
MAIL="/usr/bin/mail"
MAILMODE="mail"
elif [ -f /sbin/mail ]; then
MAIL="/sbin/mail"
MAILMODE="mail"
elif [ -f /usr/sbin/mail ]; then
MAIL="/usr/sbin/mail"
MAILMODE="mail"
elif [ -f /usr/sbin/sendmail ]; then
MAIL="/usr/sbin/sendmail"
MAILMODE="sendmail"
else
MAIL="cantfindit"
MAILMODE="cantfindit"
fi


### Check to make sure a openssl utility is available
if [ ! -f "${OPENSSL}" ]; then
echo "ERROR: The openssl binary does not exist in ${OPENSSL}."
Expand Down Expand Up @@ -871,10 +941,12 @@ if [ ! -f "${SED}" ] || [ ! -f "${AWK}" ]; then
fi

### Check to make sure a mail client is available it automated notifications are requested
if [ "${ALARM}" = "TRUE" ] && [ ! -f "${MAIL}" ]; then
echo "ERROR: You enabled automated alerts, but the mail binary could not be found."
echo "FIX: Please modify the ${MAIL} variable in the program header."
exit 1
if [ "${ALARM}" = "TRUE" ]; then
if [ ! -f "${MAIL}" ] && [ "${DISCORD}" = "FALSE" ] && [ "${TELEGRAM}" -le 0 ]; then
echo "ERROR: You enabled automated alerts, but the mail binary could not be found."
echo "FIX: Please modify the ${MAIL} variable in the program header."
exit 1
fi
fi

# Send along the servername when TLS is used
Expand Down