Mini Shell
"""
This program is free software: you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License,
or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
Copyright © 2019 Cloud Linux Software Inc.
This software is also available under ImunifyAV commercial license,
see <https://www.imunify360.com/legal/eula>
"""
import asyncio
import json
import logging
import os
import pwd
import shutil
import time
import zipfile
from collections import defaultdict
from distutils.version import LooseVersion
from pathlib import Path
import yaml
from defence360agent.api import inactivity
from defence360agent.contracts.config import (
MalwareScanScheduleInterval as Interval,
SystemConfig,
ANTIVIRUS_MODE,
)
from defence360agent.files import Index
from defence360agent.sentry import log_message
from defence360agent.utils import check_run
from imav import files
from imav.contracts.config import Wordpress
from imav.model.wordpress import WPSite
from imav.wordpress import cli, telemetry, PLUGIN_VERSION_FILE
from imav.malwarelib.plugins.schedule_watcher import get_user_schedule_config
from imav.wordpress.utils import (
build_command_for_user,
calculate_next_scan_timestamp,
clear_get_cagefs_enabled_users_cache,
get_last_scan,
get_malware_history,
prepare_scan_data,
write_plugin_data_file_atomically,
)
from imav.wordpress.site_repository import (
delete_site,
get_outdated_sites,
get_sites_for_user,
get_sites_to_install,
get_sites_to_mark_as_manually_deleted,
get_installed_sites,
insert_installed_sites,
mark_site_as_manually_deleted,
update_site_version,
)
from imav.wordpress.proxy_auth import setup_site_authentication
logger = logging.getLogger(__name__)
COMPONENTS_DB_PATH = Path(
"/var/lib/cloudlinux-app-version-detector/components_versions.sqlite3"
)
# WordPress rules file names
WP_RULES_ZIP_FILENAME = "wp-rules.zip"
WP_RULES_VERSION_FILENAME = "VERSION"
def clear_caches():
"""Clear all WordPress-related caches."""
clear_get_cagefs_enabled_users_cache()
cli.clear_get_content_dir_cache()
def site_search(items: dict, user_info: pwd.struct_passwd, matcher) -> dict:
# Get all WordPress sites for the user (the main site is always last)
user_sites = get_sites_for_user(user_info)
result = {path: [] for path in user_sites}
for item in items:
# Find all matching sites for this item
matching_sites = [path for path in user_sites if matcher(item, path)]
if matching_sites:
# Find the most specific (longest) matching path
most_specific_site = max(matching_sites, key=len)
result[most_specific_site].append(item)
return result
async def _get_scan_data_for_user(
sink, user_info: pwd.struct_passwd, admin_config: SystemConfig
):
# Get the last scan data
last_scan = await get_last_scan(sink, user_info.pw_name)
# Extract the last scan date
last_scan_time = last_scan.get("scan_date", None)
# Get user-specific schedule configuration
interval, hour, day_of_month, day_of_week = get_user_schedule_config(
user_info.pw_name, admin_config
)
next_scan_time = None
if interval != Interval.NONE:
next_scan_time = calculate_next_scan_timestamp(
interval, hour, day_of_month, day_of_week
)
# Get the malware history for the user
malware_history = get_malware_history(user_info.pw_name)
# Split malware history by site. This part relies on the main site being the last one in the list.
# Without this all malware could be attributed to the main site.
malware_by_site = site_search(
malware_history,
user_info,
lambda item, path: item["resource_type"] == "file"
and item["file"].startswith(path),
)
return last_scan_time, next_scan_time, malware_by_site
async def _send_telemetry_task(coro, semaphore: asyncio.Semaphore):
async with semaphore:
try:
await coro
except Exception as e:
logger.error(f"Telemetry task failed: {e}")
async def process_telemetry_tasks(coroutines: list, concurrency=10):
"""
Process a list of telemetry coroutines with a concurrency limit.s
"""
if not coroutines:
return
semaphore = asyncio.Semaphore(concurrency)
tasks = [
asyncio.create_task(_send_telemetry_task(coro, semaphore))
for coro in coroutines
]
try:
await asyncio.gather(*tasks)
except Exception as e:
logger.error(f"Some telemetry tasks failed: {e}")
async def install_everywhere(sink):
"""Install the imunify-security plugin for all sites where it is not installed."""
logger.info("Installing imunify-security wp plugin")
# Keep track of the installed sites
installed = set()
authenticated = set()
rules_installed = set()
failed_rules_updates = set()
failed = set()
telemetry_coros = []
with inactivity.track.task("wp-plugin-installation"):
try:
clear_caches()
to_install = get_sites_to_install()
if not to_install:
return
# Create SystemConfig once for all users
admin_config = SystemConfig()
# Create wp rules once for all users
try:
wp_rules_index = files.Index(
files.WP_RULES, integrity_check=False
)
await wp_rules_index.update()
wp_rules_data = get_updated_wp_rules_data(wp_rules_index)
except Exception as e:
logger.warning(
"Failed to load wp-rules index: %s, skipping rules"
" installation",
e,
)
wp_rules_data = None
if not wp_rules_data:
logger.warning(
"valid WordPress rules not found, skipping rules"
" installation"
)
if wp_rules_data:
# Get version and create ruleset dict with version and rules
wp_rules_version = get_wp_ruleset_version(wp_rules_index)
ruleset_dict = {
"version": wp_rules_version,
"rules": wp_rules_data,
}
wp_rules_php = _format_php_with_embedded_json(ruleset_dict)
else:
wp_rules_php = None
# Group sites by user id
sites_by_user = defaultdict(list)
for site in to_install:
sites_by_user[site.uid].append(site)
# Now iterate over the grouped sites
for uid, sites in sites_by_user.items():
try:
user_info = pwd.getpwuid(uid)
username = user_info.pw_name
except Exception as error:
log_message(
"Skipping installation of WordPress plugin on"
" {count} site(s) because they belong to user"
" {user} and it is not possible to retrieve"
" username for this user. Reason: {reason}",
format_args={
"count": len(sites),
"user": uid,
"reason": error,
},
level="warning",
component="wordpress",
fingerprint="wp-plugin-install-skip-user",
)
continue
(
last_scan_time,
next_scan_time,
malware_by_site,
) = await _get_scan_data_for_user(
sink, user_info, admin_config
)
for site in sites:
if await remove_site_if_missing(sink, site):
continue
try:
# Check if site is correctly installed and accessible using WP CLI
is_wordpress_installed = (
await cli.is_wordpress_installed(site)
)
if not is_wordpress_installed:
log_message(
"WordPress site is not accessible using WP"
" CLI. site={site}",
format_args={"site": site},
level="warning",
component="wordpress",
fingerprint="wp-plugin-cli-not-accessible",
)
continue
# Prepare scan data
scan_data = prepare_scan_data(
last_scan_time,
next_scan_time,
username,
site,
malware_by_site,
)
# Create the scan data file
await update_scan_data_file(site, scan_data)
await update_site_auth(
site, user_info, authenticated, failed
)
# Install the plugin
await cli.plugin_install(site)
# Install rules
if wp_rules_php:
await update_wp_rules_for_site(
site,
user_info,
wp_rules_php,
rules_installed,
failed_rules_updates,
)
# Get the version of the plugin
version = await cli.get_plugin_version(site)
if not version:
installed.add(site)
else:
installed.add(
WPSite.build_with_version(site, version)
)
# Prepare telemetry
telemetry_coros.append(
telemetry.send_event(
sink=sink,
event="installed_by_imunify",
site=site,
version=version,
)
)
except Exception as error:
logger.error(
"Failed to install plugin to site=%s error=%r",
site,
error,
)
logger.info(
"Installed imunify-security wp plugin on %d sites",
len(installed),
)
if failed:
logger.warning(
"Failed to authenticate %d sites",
len(failed),
)
if failed_rules_updates:
logger.warning(
"Failed to install wp-rules on %d sites",
len(failed_rules_updates),
)
except asyncio.CancelledError:
logger.info(
"Installation imunify-security wp plugin was cancelled. Plugin"
" was installed for %d sites",
len(installed),
)
except Exception as error:
logger.error(
"Error occurred during plugin installation. error=%r", error
)
raise
finally:
# Insert the installed sites into the database
insert_installed_sites(installed)
# Send telemetry
await process_telemetry_tasks(telemetry_coros)
return installed
def get_latest_plugin_version() -> str:
"""Get the latest version of the imunify-security plugin from the version file."""
try:
if not PLUGIN_VERSION_FILE.exists():
logger.error(
"Plugin version file does not exist: %s", PLUGIN_VERSION_FILE
)
return None
return PLUGIN_VERSION_FILE.read_text().strip()
except Exception as e:
logger.error("Failed to read plugin version file: %s", e)
return None
async def update_everywhere(sink):
"""Update the imunify-security plugin on all sites where it is installed."""
latest_version = get_latest_plugin_version()
if not latest_version:
logger.error("Could not determine latest plugin version")
return
logger.info(
"Updating imunify-security wp plugin to the latest version %s",
latest_version,
)
updated = set()
telemetry_coros = []
with inactivity.track.task("wp-plugin-update"):
try:
# Get sites with outdated versions
outdated_sites = get_outdated_sites(latest_version)
logger.info(f"Found {len(outdated_sites)} outdated sites")
if not outdated_sites:
return
# Create SystemConfig once for all users
admin_config = SystemConfig()
# Group sites by user id
sites_by_user = defaultdict(list)
for site in outdated_sites:
sites_by_user[site.uid].append(site)
# Process each user's sites
for uid, sites in sites_by_user.items():
try:
user_info = pwd.getpwuid(uid)
username = user_info.pw_name
except Exception as error:
logger.error(
"Failed to get username for uid=%d. error=%s",
uid,
error,
)
continue
# Get scan data once for all sites of this user
(
last_scan_time,
next_scan_time,
malware_by_site,
) = await _get_scan_data_for_user(
sink, user_info, admin_config
)
for site in sites:
if await remove_site_if_missing(sink, site):
continue
try:
# Check if site still exists
if not await cli.is_wordpress_installed(site):
logger.info(
"WordPress site no longer exists: %s", site
)
continue
# Prepare scan data
scan_data = prepare_scan_data(
last_scan_time,
next_scan_time,
username,
site,
malware_by_site,
)
# Update the scan data file
await update_scan_data_file(site, scan_data)
# Now update the plugin
await cli.plugin_update(site)
updated.add(site)
# Get the version after update
version = await cli.get_plugin_version(site)
if version:
# Store original version for comparison
original_version = site.version
# Update the database with the new version
update_site_version(site, version)
# Create a new WPSite with updated version
site = site.build_with_version(version)
# Determine if this is a downgrade
is_downgrade = LooseVersion(
version
) < LooseVersion(original_version)
# Prepare telemetry
telemetry_coros.append(
telemetry.send_event(
sink=sink,
event=(
"downgraded_by_imunify"
if is_downgrade
else "updated_by_imunify"
),
site=site,
version=version,
)
)
except Exception as error:
logger.error(
"Failed to update plugin on site=%s error=%s",
site,
error,
)
logger.info(
"Updated imunify-security wp plugin on %d sites",
len(updated),
)
except asyncio.CancelledError:
logger.info(
"Update of imunify-security wp plugin was cancelled. Plugin"
" was updated on %d sites",
len(updated),
)
except Exception as error:
logger.error(
"Error occurred during plugin update. error=%s", error
)
raise
finally:
# Send telemetry
await process_telemetry_tasks(telemetry_coros)
async def delete_plugin_files(site: WPSite):
data_dir = await cli.get_data_dir(site)
if data_dir.exists():
await asyncio.to_thread(shutil.rmtree, data_dir)
async def remove_from_single_site(site: WPSite, sink, telemetry_coros) -> int:
"""
Remove the imunify-security plugin from a single site, including all cleanup and telemetry.
Returns the number of affected sites (should be 1 if deletion was successful).
This function is intended to be protected with asyncio.shield to ensure it completes even if the parent task is cancelled.
"""
try:
# Check if site is still installed and accessible using WP CLI
is_installed = await cli.is_plugin_installed(site)
if not is_installed:
# Plugin is no longer installed. It was removed manually by the user.
await process_manually_deleted_plugin(
site, time.time(), sink, telemetry_coros
)
return 0
# Get the version of the plugin (for telemetry data)
version = await cli.get_plugin_version(site)
# Uninstall the plugin from WordPress site.
await cli.plugin_uninstall(site)
# Delete the data files from the site.
await delete_plugin_files(site)
# Delete the site from database.
affected = delete_site(site)
# Send telemetry for successful uninstall
telemetry_coros.append(
telemetry.send_event(
sink=sink,
event="uninstalled_by_imunify",
site=site,
version=version,
)
)
return affected
except Exception as error:
# Log any error that occurs during the removal process
logger.error("Failed to remove plugin from %s %s", site, error)
return 0
async def remove_all_installed(sink):
"""Remove the imunify-security plugin from all sites where it is installed."""
logger.info("Deleting imunify-security wp plugin")
telemetry_coros = []
affected = 0
with inactivity.track.task("wp-plugin-removal"):
try:
clear_caches()
to_remove = get_installed_sites()
for site in to_remove:
try:
affected += await asyncio.shield(
remove_from_single_site(site, sink, telemetry_coros)
)
except asyncio.CancelledError:
logger.info(
"Deleting imunify-security wp plugin was cancelled."
" Plugin was deleted from %d sites (out of %d)",
affected,
len(to_remove),
)
except Exception as error:
logger.error("Error occurred during plugin deleting. %s", error)
raise
finally:
logger.info(
"Removed imunify-security wp plugin from %s sites",
affected,
)
# send telemetry
await process_telemetry_tasks(telemetry_coros)
async def process_manually_deleted_plugin(site, now, sink, telemetry_coros):
"""
Process the manually deleted plugin for a single site.
Args:
site: The site to process.
now: The current time.
sink: The telemetry/event sink.
telemetry_coros: The list of telemetry coroutines to add the event to.
The process includes:
- marking the site as manually deleted in the database
- removing plugin data files
- sending telemetry for manual removal
"""
try:
# Mark the site as manually deleted in the database
mark_site_as_manually_deleted(site, now)
# Remove plugin data files
await delete_plugin_files(site)
# Send telemetry for manual removal
telemetry_coros.append(
telemetry.send_event(
sink=sink,
event="removed_by_user",
site=site,
version=site.version,
)
)
except Exception as error:
logger.error(
"Failed to process manually deleted plugin for site=%s error=%s",
site,
error,
)
async def tidy_up_manually_deleted(
sink, freshly_installed_sites: set[WPSite] = None
):
"""
Tidy up sites that have been manually deleted by the user.
Args:
sink: The telemetry/event sink.
freshly_installed_sites: Optional set of sites that were just installed and should be excluded
from being marked as manually deleted to avoid race conditions.
"""
telemetry_coros = []
try:
to_mark_as_manually_removed = get_sites_to_mark_as_manually_deleted(
freshly_installed_sites
)
if to_mark_as_manually_removed:
now = time.time()
for site in to_mark_as_manually_removed:
await process_manually_deleted_plugin(
site, now, sink, telemetry_coros
)
except Exception as error:
logger.error("Error occurred during site tidy up. %s", error)
finally:
if telemetry_coros:
await process_telemetry_tasks(telemetry_coros)
async def update_data_on_sites(sink, sites: list[WPSite]):
if not sites:
return
# Create SystemConfig once for all users
admin_config = SystemConfig()
# Group sites by user id
sites_by_user = defaultdict(list)
for site in sites:
sites_by_user[site.uid].append(site)
# Now iterate over the grouped sites
for uid, sites in sites_by_user.items():
try:
user_info = pwd.getpwuid(uid)
username = user_info.pw_name
except Exception as error:
logger.error(
"Failed to get username for uid=%d. error=%s",
uid,
error,
)
continue
(
last_scan_time,
next_scan_time,
malware_by_site,
) = await _get_scan_data_for_user(sink, user_info, admin_config)
for site in sites:
if await remove_site_if_missing(sink, site):
continue
try:
# Prepare scan data
scan_data = prepare_scan_data(
last_scan_time,
next_scan_time,
username,
site,
malware_by_site,
)
# Update the scan data file
await update_scan_data_file(site, scan_data)
except Exception as error:
logger.error(
"Failed to update scan data on site=%s error=%s",
site,
error,
)
async def update_scan_data_file(site: WPSite, scan_data: dict):
# Get the gid for the given user
user_info = pwd.getpwuid(site.uid)
gid = user_info.pw_gid
# Ensure data directory exists with correct permissions
data_dir = await _ensure_site_data_directory(site, user_info)
scan_data_path = data_dir / "scan_data.php"
# Format and write the PHP file
php_content = _format_php_with_embedded_json(scan_data)
write_plugin_data_file_atomically(
scan_data_path, php_content, uid=site.uid, gid=gid
)
def _format_php_with_embedded_json(data: dict) -> str:
"""
Format a dictionary as a PHP file that returns JSON-decoded data.
This creates a WordPress-safe PHP file that:
1. Checks if it's being included from WordPress (WPINC defined)
2. Returns the data as a decoded JSON string
Args:
data: Dictionary to embed in the PHP file
Returns:
Formatted PHP file content as a string
"""
return (
"<?php\n"
"if ( ! defined( 'WPINC' ) ) {\n"
"\texit;\n"
"}\n"
"return json_decode( '"
+ json.dumps(data).replace("'", "\\'")
+ "', true );"
)
def _find_file_in_index(index: Index, filename: str) -> Path | None:
"""
Find a file path from the index by filename.
Args:
index: files.Index object
filename: Name of the file to find (e.g., WP_RULES_ZIP_FILENAME, WP_RULES_VERSION_FILENAME)
Returns:
Path to the file or None if not found
"""
for item in index.items():
if item["name"] == filename:
file_path = Path(index.localfilepath(item["url"]))
if file_path.exists():
return file_path
logger.error("%s not found in %s", filename, index.files_path(index.type))
return None
def _extract_wp_rules_yaml(zip_path: Path) -> dict | None:
"""
Extract and parse wp-rules.yaml from the zip file.
Args:
zip_path: Path to wp-rules.zip file
Returns:
Parsed YAML data as dict or None if extraction/parsing fails
"""
try:
with zipfile.ZipFile(zip_path, "r") as zip_file:
with zip_file.open("wp-rules.yaml") as yaml_file:
rules_data = yaml.safe_load(yaml_file)
except (zipfile.BadZipFile, KeyError, yaml.YAMLError) as e:
logger.error("Failed to extract or parse wp-rules.yaml: %s", e)
return None
if not isinstance(rules_data, dict):
logger.error("Invalid wp-rules.yaml format: %s", rules_data)
return None
return rules_data
async def _ensure_site_data_directory(
site: WPSite, user_info: pwd.struct_passwd
) -> Path:
"""
Ensure the site's data directory exists with correct permissions.
Args:
site: WordPress site
user_info: User information from pwd
Returns:
Path to data directory
Raises:
Exception: If the data directory is a symlink or cannot be created
"""
data_dir = await cli.get_data_dir(site)
if os.path.islink(data_dir):
raise Exception(
"Data directory %s is a symlink, skipping.", str(data_dir)
)
if not data_dir.exists():
command = build_command_for_user(
user_info.pw_name,
["mkdir", "-p", str(data_dir)],
)
await check_run(command)
if not data_dir.exists():
raise Exception(
"Failed to create directory %s for user %s",
str(data_dir),
user_info.pw_name,
)
# we can safely change the permissions of the directory because we just created it
data_dir.chmod(0o750)
return data_dir
def get_updated_wp_rules_data(index: Index) -> dict | None:
"""
Retrieve the latest WordPress rules and return them as a dictionary.
Args:
index (Index): The files.Index object used to locate the wp-rules.zip file.
Returns:
dict: The parsed wp-rules data as a dictionary.
If the wp-rules archive or data cannot be found or parsed, returns None.
"""
# Find wp-rules.zip file
zip_path = _find_file_in_index(index, WP_RULES_ZIP_FILENAME)
if not zip_path:
return None
# Extract and parse wp-rules.yaml
rules_data = _extract_wp_rules_yaml(zip_path)
if not rules_data:
return None
logger.info("Successfully parsed wp-rules.yaml")
if ANTIVIRUS_MODE:
# all rules will be in monitoring mode only for AV and AV+
for cve, params in rules_data.items():
params["mode"] = "pass"
return rules_data
def get_wp_ruleset_version(index: Index) -> str:
"""
Retrieve the WordPress ruleset version string from the VERSION file.
Args:
index (Index): The files.Index object used to locate the VERSION file.
Returns:
str: The version string from the VERSION file.
If the VERSION file cannot be found or read, returns "NA".
"""
# Find VERSION file
version_path = _find_file_in_index(index, WP_RULES_VERSION_FILENAME)
if not version_path:
return "NA"
try:
version_string = version_path.read_text().strip()
logger.info("Successfully read wp-rules version: %s", version_string)
return version_string
except Exception as e:
logger.error("Failed to read VERSION file: %s", e)
return "NA"
async def update_wp_rules_for_site(
site: WPSite,
user_info: pwd.struct_passwd,
wp_rules_php: str,
updated: set,
failed: set,
) -> None:
"""
Deploy wp-rules to a single WordPress site and track the result.
Args:
site: WordPress site to deploy to
user_info: User information from pwd
wp_rules_php: Formatted PHP rules content
updated: Set to add site to if successful
failed: Set to add site to if failed
"""
gid = user_info.pw_gid
try:
data_dir = await _ensure_site_data_directory(site, user_info)
rules_path = data_dir / "rules.php"
write_plugin_data_file_atomically(
rules_path, wp_rules_php, uid=site.uid, gid=gid
)
updated.add(site)
logger.info("Updated wp-rules for site %s", site.docroot)
except Exception as error:
failed.add(site)
logger.error(
"Failed to update wp-rules for site %s: %s",
site.docroot,
error,
)
async def update_wp_rules_on_sites(index: Index, is_updated: bool) -> None:
"""
Hook that runs when wp-rules files are updated.
Extracts wp-rules.yaml from wp-rules.zip and deploys to all active WordPress sites.
Args:
index: files.Index object for wp-rules
is_updated: Whether files were actually updated
"""
if not Wordpress.SECURITY_PLUGIN_ENABLED:
logger.info(
"wordpress security plugin not enabled, skipping wp-rules"
" deployment"
)
return
if not is_updated:
logger.info("wp-rules not updated, skipping deployment")
return
logger.info("Starting wp-rules deployment to WordPress sites")
wp_rules_data = get_updated_wp_rules_data(index)
if not wp_rules_data:
logger.error("No valid wp-rules found, skipping deployment")
return
# Get version and create ruleset dict with version and rules
wp_rules_version = get_wp_ruleset_version(index)
ruleset_dict = {
"version": wp_rules_version,
"rules": wp_rules_data,
}
wp_rules_php = _format_php_with_embedded_json(ruleset_dict)
updated = set()
failed = set()
with inactivity.track.task("wp-rules-deployment"):
try:
clear_caches()
# Get all active WordPress sites
installed_sites = get_installed_sites()
if not installed_sites:
logger.info("No active WordPress sites found")
return
sites_by_user = defaultdict(list)
for site in installed_sites:
sites_by_user[site.uid].append(site)
# Process users concurrently
tasks = []
for uid, sites in sites_by_user.items():
try:
user_info = pwd.getpwuid(uid)
# Create tasks for all sites of this user
for site in sites:
task = update_wp_rules_for_site(
site, user_info, wp_rules_php, updated, failed
)
tasks.append(task)
except Exception as error:
log_message(
"Skipping wp-rules update for {count} site(s)"
" belonging to user {user} because username retrieval"
" failed. Reason: {reason}",
format_args={
"count": len(sites),
"user": uid,
"reason": error,
},
level="warning",
component="wordpress",
fingerprint="wp-rules-update-skip-user",
)
for site in sites:
failed.add(site)
continue
# Run all site updates concurrently with a reasonable limit
max_concurrent = 10
for i in range(0, len(tasks), max_concurrent):
batch = tasks[i : i + max_concurrent]
await asyncio.gather(*batch, return_exceptions=True)
logger.info(
"wp-rules deployment complete. Updated: %d, Failed: %d",
len(updated),
len(failed),
)
except asyncio.CancelledError:
logger.info(
"wp-rules deployment was cancelled. Updated %d sites",
len(updated),
)
except Exception as error:
logger.error(
"Error occurred during wp-rules deployment. error=%s", error
)
raise
async def update_auth_everywhere():
"""Update auth.php files for all existing WordPress sites."""
logger.info("Updating auth.php files for existing WordPress sites")
updated = set()
failed = set()
with inactivity.track.task("wp-auth-update"):
try:
clear_caches()
# Get all installed sites from db
installed_sites = get_installed_sites()
if not installed_sites:
logger.info("No installed WordPress sites found")
return
sites_by_user = defaultdict(list)
for site in installed_sites:
sites_by_user[site.uid].append(site)
# Process users concurrently
tasks = []
for uid, sites in sites_by_user.items():
try:
user_info = pwd.getpwuid(uid)
# Create tasks for all sites of this user
for site in sites:
task = update_site_auth(
site, user_info, updated, failed
)
tasks.append(task)
except Exception as error:
log_message(
"Skipping auth update for WordPress sites on"
" {count} site(s) because they belong to user"
" {user} and it is not possible to retrieve"
" username for this user. Reason: {reason}",
format_args={
"count": len(sites),
"user": uid,
"reason": error,
},
level="warning",
component="wordpress",
fingerprint="wp-plugin-auth-update-skip-user",
)
continue
# Run all site updates concurrently with a reasonable limit
# Adjust max_concurrent based on your system's I/O capacity
max_concurrent = 10
for i in range(0, len(tasks), max_concurrent):
batch = tasks[i : i + max_concurrent]
await asyncio.gather(*batch, return_exceptions=True)
logger.info(
"Updated auth.php files for %d WordPress sites, %d failed",
len(updated),
len(failed),
)
except asyncio.CancelledError:
logger.info(
"Auth update for WordPress sites was cancelled. Auth was"
" updated for %d sites",
len(updated),
)
except Exception as error:
logger.error("Error occurred during auth update. error=%s", error)
raise
async def update_site_auth(site, user_info, updated, failed):
"""Process authentication setup for a single site."""
try:
await setup_site_authentication(site, user_info)
updated.add(site)
except Exception as error:
failed.add(site)
logger.error(
"Failed to update auth for site=%s error=%s",
site,
error,
)
async def remove_site_if_missing(sink, site: WPSite) -> bool:
"""
Checks if the site directory exists. If not, removes the site from the local database and sends a 'site_removed' telemetry event only if deletion is successful.
Returns True if the site was removed (directory missing), False otherwise.
Parameters:
sink: The telemetry/event sink.
site: The WPSite object to check and potentially remove.
Side effect: If the site is missing and successfully deleted from database, a telemetry event will be sent.
"""
if os.path.isdir(site.docroot):
return False
# Attempt to delete the site from the database first
rows_deleted = delete_site(site)
# Only send telemetry if the deletion was successful (at least one row was deleted)
if rows_deleted > 0:
await telemetry.send_event(
sink=sink, event="site_removed", site=site, version=site.version
)
else:
logger.warning(
"Failed to delete missing site %s from database, no rows affected",
site,
)
log_message(
"Failed to delete missing site {site} from database",
format_args={"site": site},
level="warning",
component="wordpress",
fingerprint="wp-plugin-site-delete-failed",
)
return True
async def fix_site_data_file_permissions(
site: WPSite, file_permissions: int
) -> bool:
"""
Fix data file permissions for a single WordPress site.
Args:
site: The WordPress site to fix permissions for
file_permissions: The file permissions to set (e.g., 0o440 or 0o400)
Returns:
bool: True if permissions were fixed successfully, False otherwise
"""
try:
# Get the data directory
data_dir = await cli.get_data_dir(site)
if not data_dir.exists():
return False
# Fix directory permissions (0o750) only if not already correct
current_dir_mode = data_dir.stat().st_mode & 0o777
if current_dir_mode != 0o750:
data_dir.chmod(0o750)
for file_name in ["scan_data.php", "auth.php"]:
file_path = data_dir / file_name
if file_path.exists():
# Set permissions based on hosting panel only if not already correct
current_file_mode = file_path.stat().st_mode & 0o777
if current_file_mode != file_permissions:
file_path.chmod(file_permissions)
return True
except Exception as error:
logger.error(
"Failed to fix permissions for site=%s error=%s",
site,
error,
)
return False
async def fix_data_file_permissions_everywhere(sink):
"""
Fix data file permissions for all WordPress sites with imunify-security plugin installed.
Args:
sink: The telemetry/event sink
"""
fixed = set()
failed = set()
with inactivity.track.task("wp-plugin-fix-permissions"):
try:
clear_caches()
# Get all installed sites
installed_sites = get_installed_sites()
if not installed_sites:
return
# Determine file permissions based on hosting panel
from defence360agent.subsys.panels.hosting_panel import (
HostingPanel,
)
from defence360agent.subsys.panels.plesk import Plesk
file_permissions = (
0o440 if HostingPanel().NAME == Plesk.NAME else 0o400
)
# Process sites
for site in installed_sites:
if await remove_site_if_missing(sink, site):
continue
success = await fix_site_data_file_permissions(
site, file_permissions
)
if success:
fixed.add(site)
else:
failed.add(site)
logger.info(
"Fixed data file permissions for %d WordPress sites, %d"
" failed",
len(fixed),
len(failed),
)
except asyncio.CancelledError:
logger.info(
"Fixing data file permissions was cancelled. Permissions were"
" fixed for %d sites",
len(fixed),
)
except Exception as error:
logger.error(
"Error occurred during permission fixing. error=%s", error
)