Pi-hole/pi-hole
Pi-hole/pi-hole
1
0
Fork 0
mirror of https://github.com/pi-hole/pi-hole.git synced 2024-11-22 06:03:43 +00:00
Code Issues Projects Releases Packages Wiki Activity

Add session details to API command output

Browse source 
Signed-off-by: DL6ER <dl6er@dl6er.de>
This commit is contained in:
DL6ER 2024-08-24 10:37:58 +02:00
parent 8e4fc27168
commit b304562c8e
No known key found for this signature in database
GPG key ID: 00135ACBD90B28DD
1 changed files with 28 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
advanced/Scripts/api.sh
View file

@ -88,6 +88,9 @@ LoginAPI() {
# Exit early if authentication is not needed # Exit early if authentication is not needed
if [ "${needAuth}" = false ]; then if [ "${needAuth}" = false ]; then
if [ "${1}" = "verbose" ]; then
echo "API Authentication: Not needed"
fi
return return
fi fi
@ -95,8 +98,15 @@ LoginAPI() {
if [ -r /etc/pihole/cli_pw ]; then if [ -r /etc/pihole/cli_pw ]; then
password=$(cat /etc/pihole/cli_pw) password=$(cat /etc/pihole/cli_pw)
if [ "${1}" = "verbose" ]; then
echo "API Authentication: Trying to use CLI password"
fi
# Try to authenticate using the CLI password # Try to authenticate using the CLI password
Authentication Authentication "${1}"
elif [ "${1}" = "verbose" ]; then
echo "API Authentication: CLI password not available"
fi fi
@ -109,7 +119,7 @@ LoginAPI() {
secretRead; printf '\n' secretRead; printf '\n'
# Try to authenticate again # Try to authenticate again
Authentication Authentication "${1}"
done done
} }
@ -124,6 +134,14 @@ Authentication() {
# obtain validity and session ID from session response # obtain validity and session ID from session response
validSession=$(echo "${sessionResponse}"| jq .session.valid 2>/dev/null) validSession=$(echo "${sessionResponse}"| jq .session.valid 2>/dev/null)
SID=$(echo "${sessionResponse}"| jq --raw-output .session.sid 2>/dev/null) SID=$(echo "${sessionResponse}"| jq --raw-output .session.sid 2>/dev/null)
if [ "${1}" = "verbose" ]; then
if [ "${validSession}" = true ]; then
echo "API Authentication: ${COL_GREEN}Success${COL_NC}"
else
echo "API Authentication: ${COL_RED}Failed${COL_NC}"
fi
fi
} }
LogoutAPI() { LogoutAPI() {
@ -134,10 +152,12 @@ LogoutAPI() {
deleteResponse=$(curl -skS -o /dev/null -w "%{http_code}" -X DELETE "${API_URL}auth" -H "Accept: application/json" -H "sid: ${SID}") deleteResponse=$(curl -skS -o /dev/null -w "%{http_code}" -X DELETE "${API_URL}auth" -H "Accept: application/json" -H "sid: ${SID}")
case "${deleteResponse}" in case "${deleteResponse}" in
"401") printf "%b" "Logout attempt without a valid session. Unauthorized!\n";; "401") echo "Logout attempt without a valid session. Unauthorized!";;
esac; "204") if [ "${1}" = "verbose" ]; then echo "API Logout: ${COL_GREEN}Success${COL_NC} (session deleted)"; fi;;
esac;
elif [ "${1}" = "verbose" ]; then
echo "API Logout: ${COL_GREEN}Success${COL_NC} (no valid session)"
fi fi
} }
GetFTLData() { GetFTLData() {
@ -234,7 +254,8 @@ apiFunc() {
local data response status status_col local data response status status_col
# Authenticate with the API # Authenticate with the API
LoginAPI LoginAPI verbose
echo ""
echo "Requesting: ${COL_PURPLE}GET ${COL_CYAN}${API_URL}${COL_YELLOW}$1${COL_NC}" echo "Requesting: ${COL_PURPLE}GET ${COL_CYAN}${API_URL}${COL_YELLOW}$1${COL_NC}"
echo "" echo ""
@ -265,5 +286,5 @@ apiFunc() {
fi fi
# Delete the session # Delete the session
LogoutAPI LogoutAPI verbose
} }