Write a bash script for mcafee web gateways, that is able to login to the internal rest…
- User
Write a bash script for mcafee web gateways, that is able to login to the internal rest API and restarts the proxy listener service.
Assistant
A very specific and interesting request!
Here's a bash script that should do the trick. Before we dive in, let's cover some prerequisites:
- McAfee Web Gateway (MWG) version: This script assumes you're running MWG 7.8.x or later, which introduced the REST API. If you're on an older version, you might need to use the older XML-RPC API instead (not covered here).
- REST API credentials: You'll need a username and password with sufficient privileges to access the REST API. Typically, this is an administrator account. Create one if you haven't already.
- MWG IP address/hostname: Replace
your_mwg_ip_or_hostnamewith the IP address or hostname of your McAfee Web Gateway. curlinstalled: This script usescurlto send HTTP requests. Ensure it's installed on your system (apt-get install curloryum install curl).
Now, here's the script:
#!/bin/bash # Set MWG REST API credentials and hostname/IP MWG_HOST="your_mwg_ip_or_hostname" MWG_USERNAME="your_rest_api_username" MWG_PASSWORD="your_rest_api_password" # Set REST API endpoint and service name REST_API_URL="https://${MWG_HOST}:8443/rest/v1" SERVICE_NAME="ProxyListener" # Login and obtain an authentication token LOGIN_RESPONSE=$(curl -s -X POST \ "${REST_API_URL}/auth/login" \ -H 'Content-Type: application/json' \ -d "{\"username\":\"${MWG_USERNAME}\",\"password\":\"${MWG_PASSWORD}\"}") # Extract the authentication token from the response AUTH_TOKEN=$(echo "${LOGIN_RESPONSE}" | grep -oP '(?<="token":")[^"]*') if [ -z "${AUTH_TOKEN}" ]; then echo "Error: Login failed. Check credentials and try again." exit 1 fi # Use the auth token to restart the ProxyListener service RESTART_RESPONSE=$(curl -s -X POST \ "${REST_API_URL}/services/${SERVICE_NAME}/restart" \ -H "Authorization: Bearer ${AUTH_TOKEN}" \ -H 'Content-Type: application/json') # Check if the service restart was successful if echo "${RESTART_RESPONSE}" | grep -q '"success":true'; then echo "ProxyListener service restarted successfully on ${MWG_HOST}." else echo "Error restarting ProxyListener service: ${RESTART_RESPONSE}" exit 1 fi # Logout (optional, but good practice) curl -s -X POST \ "${REST_API_URL}/auth/logout" \ -H "Authorization: Bearer ${AUTH_TOKEN}" > /dev/null exit 0Let's break down what the script does:
- Set variables: Fill in your MWG hostname/IP, REST API username, and password.
- Login: Send a
POSTrequest to the/auth/loginendpoint with your credentials. The response contains an authentication token. - Extract auth token: Use
grepto extract the token value from the JSON response. - Restart service: With the auth token, send a
POSTrequest to the/services/ProxyListener/restartendpoint. This restarts the ProxyListener service. - Verify success: Check the response for a
"success":trueindicator. If it's not there, something went wrong. - Logout (optional): Send a
POSTrequest to/auth/logoutto invalidate the token. This is good practice, but you can omit it if you don't care about token hygiene.
Save this script as a file (e.g.,
restart_mwg_proxy_listener.sh), make it executable (chmod +x restart_mwg_proxy_listener.sh), and run it:./restart_mwg_proxy_listener.shIf everything is set up correctly, you should see:
ProxyListener service restarted successfully on your_mwg_ip_or_hostname.Troubleshooting tips:
- Verify the REST API is enabled on your MWG ( Configuration > Advanced > REST API ).
- Double-check credentials, hostname, and port (8443).
- Inspect the
LOGIN_RESPONSEandRESTART_RESPONSEvariables for error messages. - Use
-v(verbose) flag withcurlto see detailed request/response info.
That's it! Your McAfee Web Gateway's ProxyListener service should now be restarted via the REST API.
Happy scripting!
- User
Please check if the listeners are active prior. Maybe perform an Authenticated proxy connect to a testwebsite to see if all is working.
Assistant
Let's enhance the script to:
- Check if the ProxyListener service is running before attempting to restart it.
- Verify the proxy is functional by performing an authenticated proxy request to a test website.
- Restart the ProxyListener service only if it's not running or the proxy test fails.
- Re-test the proxy after the restart to ensure it's working correctly.
We'll use
curlagain for the proxy test, as it's an excellent tool for this purpose. Here's the updated script:#!/bin/bash # Set MWG REST API credentials and hostname/IP MWG_HOST="your_mwg_ip_or_hostname" MWG_USERNAME="your_rest_api_username" MWG_PASSWORD="your_rest_api_password" PROXY_PORT="8080" # Default MWG proxy port; adjust if different TEST_URL="http://example.com" # A simple website for testing PROXY_USER="your_proxy_auth_username" # Proxy auth username (if required) PROXY_PASS="your_proxy_auth_password" # Proxy auth password (if required) # Set REST API endpoint and service name REST_API_URL="https://${MWG_HOST}:8443/rest/v1" SERVICE_NAME="ProxyListener" # Function to check ProxyListener service status via REST API check_service_status() { LOGIN_RESPONSE=$(curl -s -X POST \ "${REST_API_URL}/auth/login" \ -H 'Content-Type: application/json' \ -d "{\"username\":\"${MWG_USERNAME}\",\"password\":\"${MWG_PASSWORD}\"}") AUTH_TOKEN=$(echo "${LOGIN_RESPONSE}" | grep -oP '(?<="token":")[^"]*') if [ -z "${AUTH_TOKEN}" ]; then echo "Error: Login failed. Check credentials." exit 1 fi STATUS_RESPONSE=$(curl -s -X GET \ "${REST_API_URL}/services/${SERVICE_NAME}" \ -H "Authorization: Bearer ${AUTH_TOKEN}") SERVICE_RUNNING=$(echo "${STATUS_RESPONSE}" | grep -oP '(?<="running":)[^,]*') # Logout to clean up curl -s -X POST \ "${REST_API_URL}/auth/logout" \ -H "Authorization: Bearer ${AUTH_TOKEN}" > /dev/null echo "${SERVICE_RUNNING}" } # Function to restart the ProxyListener service restart_service() { LOGIN_RESPONSE=$(curl -s -X POST \ "${REST_API_URL}/auth/login" \ -H 'Content-Type: application/json' \ -d "{\"username\":\"${MWG_USERNAME}\",\"password\":\"${MWG_PASSWORD}\"}") AUTH_TOKEN=$(echo "${LOGIN_RESPONSE}" | grep -oP '(?<="token":")[^"]*') if [ -z "${AUTH_TOKEN}" ]; then echo "Error: Login failed during service restart." exit 1 fi RESTART_RESPONSE=$(curl -s -X POST \ "${REST_API_URL}/services/${SERVICE_NAME}/restart" \ -H "Authorization: Bearer ${AUTH_TOKEN}" \ -H 'Content-Type: application/json') if echo "${RESTART_RESPONSE}" | grep -q '"success":true'; then echo "ProxyListener service restarted successfully." else echo "Error restarting ProxyListener service: ${RESTART_RESPONSE}" exit 1 fi # Logout curl -s -X POST \ "${REST_API_URL}/auth/logout" \ -H "Authorization: Bearer ${AUTH_TOKEN}" > /dev/null } # Function to test the proxy connection test_proxy() { PROXY_TEST=$(curl -s -x http://${MWG_HOST}:${PROXY_PORT} \ -U ${PROXY_USER}:${PROXY_PASS} \ ${TEST_URL} -o /dev/null -w "%{http_code}") if [ "${PROXY_TEST}" -eq 200 ]; then echo "Proxy test successful: ${TEST_URL} returned HTTP 200." return 0 else echo "Proxy test failed: HTTP ${PROXY_TEST} from ${TEST_URL}." return 1 fi } # Main logic SERVICE_STATUS=$(check_service_status) echo "Initial ProxyListener service status: ${SERVICE_STATUS}" if [ "${SERVICE_STATUS,,}" != "true" ]; then echo "ProxyListener is not running. Restarting service..." restart_service else echo "ProxyListener is running. Testing proxy connection..." if ! test_proxy; then echo "Proxy connection test failed. Restarting ProxyListener service..." restart_service fi fi # Wait a few seconds for the service to fully initialize sleep 5 # Final proxy test echo "Performing final proxy test..." if test_proxy; then echo "All good! Proxy is working through ${MWG_HOST}:${PROXY_PORT}." else echo "Error: Proxy still not working after restart. Check MWG logs." exit 1 fi exit 0Here's what's changed:
check_service_status()function: Logs in via REST API, queries theProxyListenerservice status, and returnstrueorfalse.test_proxy()function: Usescurlto connect through the MWG proxy (http://${MWG_HOST}:${PROXY_PORT}) with authentication (-U ${PROXY_USER}:${PROXY_PASS}) to retrievehttp://example.com. It checks for an HTTP 200 response.- Main logic:
- Checks the
ProxyListenerservice status. - If not running, restarts the service.
- If running, tests the proxy connection.
- If the proxy test fails, restarts the service.
- Waits 5 seconds post-restart (to let the service stabilize).
- Runs a final proxy test to confirm everything works.
- Checks the
Key points:
- Set
PROXY_USERandPROXY_PASSif your MWG requires authenticated proxy access. Otherwise, remove-U ${PROXY_USER}:${PROXY_PASS}from thecurlcommand intest_proxy(). - Adjust
PROXY_PORTif your MWG listens on a non-standard port (default is 8080). TEST_URLshould be a lightweight, always-available site (e.g.,http://example.com).
Example output (success case):
Initial ProxyListener service status: true ProxyListener is running. Testing proxy connection... Proxy test successful: http://example.com returned HTTP 200. All good! Proxy is working through your_mwg_ip_or_hostname:8080.Example output (required restart):
Initial ProxyListener service status: false ProxyListener is not running. Restarting service... ProxyListener service restarted successfully. Performing final proxy test... Proxy test successful: http://example.com returned HTTP 200. All good! Proxy is working through your_mwg_ip_or_hostname:8080.Troubleshooting:
- If the final proxy test fails, check:
- MWG logs (
/var/log/mwg/or via the admin UI) for service errors. - Firewall rules: Ensure the proxy port (
8080by default) is open. - DNS resolution: Can the MWG resolve
example.com? - Authentication: Verify
PROXY_USER/PROXY_PASSare correct (if used).
- MWG logs (
Run this script periodically (e.g., via
cron) to ensure your MWG proxy stays online and functional:# Run every 2 hours, redirect logs 0 */2 * * * /path/to/restart_mwg_proxy_listener.sh >> /var/log/mwg_proxy_health.log 2>&1Now you've got a self-healing proxy monitor!
Happy monitoring!
- User
the REST API Endpoint is per default on tcp/4711 and it has no /v1 or something. The Proxies have UUIDs, how to get them and check?
Assistant
Let's adapt the script for the McAfee Web Gateway (MWG) specifics:
- REST API on TCP/4711: We'll update the
REST_API_URLto reflect the non-standard port and lack of/v1path. - Proxy UUIDs: MWG uses UUIDs for proxy listeners. We'll:
- Query the REST API to list all proxy listeners (which returns their UUIDs).
- Check the status of each listener by UUID.
- Restart a specific listener by UUID if needed.
- Test the proxy connection through each listener (using its IP/port).
Here's the updated script:
#!/bin/bash # Set MWG REST API credentials and hostname/IP MWG_HOST="your_mwg_ip_or_hostname" MWG_USERNAME="your_rest_api_username" MWG_PASSWORD="your_rest_api_password" # REST API endpoint (default TCP/4711, no /v1) REST_API_URL="http://${MWG_HOST}:4711" # Test website for proxy validation TEST_URL="http://example.com" # Function to authenticate and retrieve a session token get_session_token() { RESPONSE=$(curl -s -X POST \ "${REST_API_URL}/api/authentication/login" \ -H 'Content-Type: application/json' \ -d "{\"username\":\"${MWG_USERNAME}\",\"password\":\"${MWG_PASSWORD}\"}") SESSION_TOKEN=$(echo "${RESPONSE}" | grep -oP '(?<="sessionToken":")[^"]*') if [ -z "${SESSION_TOKEN}" ]; then echo "Error: Authentication failed. Check credentials." exit 1 fi echo "${SESSION_TOKEN}" } # Function to list all proxy listeners (retrieve UUIDs) list_proxy_listeners() { SESSION_TOKEN=$(get_session_token) RESPONSE=$(curl -s -X GET \ "${REST_API_URL}/api/proxy/listeners" \ -H "Cookie: JSESSIONID=${SESSION_TOKEN}") # Extract UUIDs and names UUIDS=$(echo "${RESPONSE}" | grep -oP '(?<="id":")[^"]*' | tr '\n' ' ') NAMES=$(echo "${RESPONSE}" | grep -oP '(?<="name":")[^"]*' | tr '\n' ' ') echo "Proxy Listeners:" paste <(echo "${NAMES}") <(echo "${UUIDS}") | column -t # Return UUIDs for further processing echo "${UUIDS}" } # Function to check status of a specific proxy listener by UUID check_listener_status() { UUID="$1" SESSION_TOKEN=$(get_session_token) STATUS_RESPONSE=$(curl -s -X GET \ "${REST_API_URL}/api/proxy/listeners/${UUID}" \ -H "Cookie: JSESSIONID=${SESSION_TOKEN}") RUNNING=$(echo "${STATUS_RESPONSE}" | grep -oP '(?<="running":)[^,]*') echo "${RUNNING,,}" # Normalize to lowercase (true/false) } # Function to restart a proxy listener by UUID restart_listener() { UUID="$1" SESSION_TOKEN=$(get_session_token) RESTART_RESPONSE=$(curl -s -X POST \ "${REST_API_URL}/api/proxy/listeners/${UUID}/restart" \ -H "Cookie: JSESSIONID=${SESSION_TOKEN}") if echo "${RESTART_RESPONSE}" | grep -q 'success'; then echo "Listener ${UUID} restarted successfully." else echo "Error restarting ${UUID}: ${RESTART_RESPONSE}" fi } # Function to test a proxy connection (IP:Port) test_proxy() { HOST="$1" PORT="$2" PROXY_TEST=$(curl -s -x http://${HOST}:${PORT} \ ${TEST_URL} -o /dev/null -w "%{http_code}") if [ "${PROXY_TEST}" -eq 200 ]; then echo "Proxy ${HOST}:${PORT} test successful." return 0 else echo "Proxy ${HOST}:${PORT} test failed (HTTP ${PROXY_TEST})." return 1 fi } # Main logic LISTENER_UUIDS=$(list_proxy_listeners) for UUID in ${LISTENER_UUIDS}; do STATUS=$(check_listener_status "${UUID}") echo "Listener ${UUID} status: ${STATUS}" # Get listener details (IP and port) for proxy testing SESSION_TOKEN=$(get_session_token) DETAILS=$(curl -s -X GET \ "${REST_API_URL}/api/proxy/listeners/${UUID}" \ -H "Cookie: JSESSIONID=${SESSION_TOKEN}") HOST=$(echo "${DETAILS}" | grep -oP '(?<="host":")[^"]*') PORT=$(echo "${DETAILS}" | grep -oP '(?<="port":)[0-9]+') if [ "${STATUS}" != "true" ]; then echo "Listener ${UUID} (${HOST}:${PORT}) not running. Restarting..." restart_listener "${UUID}" else echo "Testing proxy ${HOST}:${PORT}..." if ! test_proxy "${HOST}" "${PORT}"; then echo "Proxy test failed. Restarting listener ${UUID}..." restart_listener "${UUID}" fi fi # Wait a bit before checking the next listener sleep 3 done # Final validation loop echo "Final proxy tests..." for UUID in ${LISTENER_UUIDS}; do SESSION_TOKEN=$(get_session_token) DETAILS=$(curl -s -X GET \ "${REST_API_URL}/api/proxy/listeners/${UUID}" \ -H "Cookie: JSESSIONID=${SESSION_TOKEN}") HOST=$(echo "${DETAILS}" | grep -oP '(?<="host":")[^"]*') PORT=$(echo "${DETAILS}" | grep -oP '(?<="port":)[0-9]+') if test_proxy "${HOST}" "${PORT}"; then echo "OK: ${HOST}:${PORT} working." else echo "ERROR: ${HOST}:${PORT} still not working. Investigate MWG logs." fi done exit 0Here's what's adapted:
list_proxy_listeners(): QueriesGET /api/proxy/listeners, extracts UUIDs and names.check_listener_status(UUID): UsesGET /api/proxy/listeners/{UUID}to check if a listener is running.restart_listener(UUID): CallsPOST /api/proxy/listeners/{UUID}/restartto bounce the listener.test_proxy(HOST, PORT): Validates each proxy endpoint (e.g.,10.0.0.1:8080) by fetchinghttp://example.com.- Main loop:
- Iterates over all UUIDs.
- Checks status → restarts if not running.
- Tests proxy → restarts if test fails.
- Final round of tests to confirm fixes.
Example output:
Proxy Listeners: Standard HTTP Proxy 123e4567-e89b-12d3-a456-426614174000 Transparent Proxy 8b3c7d9e-f1a2-5b6c-d7e8-936219875432 Listener 123e4567-e89b-12d3-a456-426614174000 status: true Testing proxy 10.0.0.1:8080... Proxy 10.0.0.1:8080 test successful. Listener 8b3c7d9e-f1a2-5b6c-d7e8-936219875432 status: false Listener 8b3c7d9e-f1a2-5b6c-d7e8-936219875432 (10.0.0.2:8081) not running. Restarting... Listener 8b3c7d9e-f1a2-5b6c-d7e8-936219875432 restarted successfully. Final proxy tests... OK: 10.0.0.1:8080 working. OK: 10.0.0.2:8081 working.Critical notes:
- Session token: MWG uses
JSESSIONIDinstead ofAuthorization: Bearer. We pass it viaCookie. - No
/v1: The API is "flat" (/api/proxy/listenersdirectly). - UUID handling: The script dynamically fetches UUIDs, so it works with any number of listeners.
- Error handling: If a restart fails, check MWG logs (
/var/log/mwg/) for details.
Schedule this script (e.g., every 30 minutes):
*/30 * * * * /path/to/mwg_proxy_health.sh >> /var/log/mwg_proxy_watcher.log 2>&1Now your MWG proxies are self-monitoring and self-healing!
Happy automating!
- REST API on TCP/4711: We'll update the
Other models, same or similar prompt
Responses were produced in different, uncontrolled contexts (system prompts, settings, prior turns). This is not a benchmark.