adding a test to fetch user information

Author: jason-at-contrast

get-user-info/get-user-info.py

@@ -0,0 +1,157 @@
+import requests
+import base64
+import getpass  # For secure password input (hides input from display)
+import json
+import csv
+import os
+
+class Application:
+    def __init__(self, app_id, name):
+        self.app_id = app_id
+        self.name = name
+
+def read_creds_file(filename="../.creds"):
+    """Read credentials from a .creds file"""
+    creds = {}
+    try:
+        with open(filename, "r") as f:
+            for line in f:
+                line = line.strip()  # Remove whitespace from beginning and end of line
+                # Skip empty lines and comment lines that start with #
+                if line and not line.startswith("#"):
+                    key, value = line.split("=", 1)  # Split on first = only (in case value contains =)
+                    creds[key] = value
+    except FileNotFoundError:
+        print(f"Warning: {filename} file not found. Please input values.")
+    return creds
+
+# Read credentials from .creds file
+creds = read_creds_file()
+
+# Set the default values for re-using within your organization from .creds file
+contrast_url = creds.get("CONTRAST_URL", "")  # .get() returns empty string if key doesn't exist
+org_id = creds.get("ORG_ID", "")
+username = creds.get("USERNAME", "")
+api_key = creds.get("API_KEY", "")
+service_key = creds.get("SERVICE_KEY", "")
+app_id = creds.get("APP_ID", "")
+
+# Pre-encode credentials for Basic Authentication (done early to avoid repeating)
+auth_str = f"{username}:{service_key}"
+auth_b64 = base64.b64encode(auth_str.encode()).decode()
+
+# Set up HTTP headers for API requests
+headers = {
+    "Accept": "application/json"  # Tell API we want JSON responses
+}
+# Set up query parameters to expand server data in responses
+params = {
+    "expand": ["apps"]
+}
+
+def getUsers(headers, params, org_id):
+    """Fetch all users from the Contrast API"""
+    url = f"{contrast_url}/api/ng/{org_id}/users"
+    response = requests.get(url, headers=headers, params=params)
+    return response
+
+def getServer(headers, params, org_id, server_id):
+    """Fetch individual server details including applications"""
+    url = f"{contrast_url}/api/ng/{org_id}/servers/{server_id}"
+    response = requests.get(url, headers=headers, params=params)
+    return response
+
+def read_json_file(filename):
+    """Helper function to read JSON files"""
+    with open(filename, "r") as f:
+        return f.read()
+
+def main():
+    # Allow modification of global variables within this function
+    global contrast_url, org_id, username, api_key, service_key
+
+    # Prompt user for Contrast URL, use default from .creds if blank
+    msg = f"Enter your Contrast URL (blank will use default '{contrast_url}'): "
+    contrast_url_input = input(msg)
+    if contrast_url_input.strip():  # .strip() removes whitespace, then check if anything remains
+        contrast_url = contrast_url_input
+    else:
+        # Keep prompting if no default exists and user provides blank input
+        while not contrast_url_input.strip() and not contrast_url.strip():
+            print("Contrast URL cannot be blank.")
+            contrast_url_input = input(msg)
+            contrast_url = contrast_url_input
+
+    # Prompt user for Organization ID, use default from .creds if blank
+    msg = f"Enter your Organization ID (blank will use default '{org_id}'): "
+    org_id_input = input(msg)
+    if org_id_input.strip():
+        org_id = org_id_input
+    else:
+        # Keep prompting if no default exists and user provides blank input
+        while not org_id_input.strip() and not org_id.strip():
+            print("Organization ID cannot be blank.")
+            org_id_input = input(msg)
+            org_id = org_id_input
+
+    # Prompt user for username, use default from .creds if blank
+    msg = f"Enter your username (blank will use default '{username}'): "
+    username_input = input(msg)
+    if username_input.strip():
+        username = username_input
+    else:
+        # Keep prompting if no default exists and user provides blank input
+        while not username_input.strip() and not username.strip():
+            print("Username cannot be blank.")
+            username_input = input(msg)
+            username = username_input
+
+    # Prompt user for API key (hidden input), use default from .creds if blank
+    msg = f"Enter your API key (blank will use default '****************************'): "
+    api_key_input = getpass.getpass(msg)  # getpass hides the input from display for security
+    if api_key_input.strip():
+        api_key = api_key_input
+    else:
+        # Keep prompting if no default exists and user provides blank input
+        while not api_key_input.strip() and not api_key.strip():
+            print("API key cannot be blank.")
+            api_key_input = getpass.getpass(msg)
+            api_key = api_key_input
+
+    # Prompt user for service key (hidden input), use default from .creds if blank
+    msg = f"Enter your service key (blank will use default '************'): "
+    service_key_input = getpass.getpass(msg)  # getpass hides the input from display for security
+    if service_key_input.strip():
+        service_key = service_key_input
+    else:
+        # Keep prompting if no default exists and user provides blank input
+        while not service_key_input.strip() and not service_key.strip():
+            print("Service key cannot be blank.")
+            service_key_input = getpass.getpass(msg)
+            service_key = service_key_input
+
+    # List of specific servers to process (modify this list as needed for your environment)
+    servers_list = [90926, 90086, 90001]
+
+    # Create Basic Authentication header with encoded credentials
+    auth_str = f"{username}:{service_key}"  # Format: username:servicekey
+    auth_b64 = base64.b64encode(auth_str.encode()).decode()  # Encode to base64 for Basic auth
+    headers["Authorization"] = f"Basic {auth_b64}"  # Add Authorization header
+    headers["API-Key"] = api_key  # Add API key header required by Contrast
+
+    # Fetch all servers from the API
+    response = getUsers(headers, params, org_id)
+    if response.status_code == 200:  # HTTP 200 means success
+        data = response.json()  # Parse JSON response into Python dict
+        # Save the full server response to JSON file for debugging/reference
+        with open("output.json", "w") as f:
+            json.dump(data, f, indent=2)  # indent=2 makes it human-readable
+        os.system('clear')  # Clear the terminal screen (use 'cls' on Windows)
+              
+    else:
+        # Display error if API call failed (non-200 status code)
+        print(f"Error: {response.status_code} - {response.text}")
+
+# Only run main() if this script is executed directly (not imported)
+if __name__ == "__main__":
+    main()