%PDF-
%PDF-
Mini Shell
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 grp
import logging
import os
import pwd
import re
from collections import defaultdict
from pathlib import Path
from typing import Any, Dict, Iterable, List, Literal, Set, Tuple
from peewee import Case, fn
from defence360agent.subsys.panels import hosting_panel
from defence360agent.utils import get_results_iterable_expression
from defence360agent.utils.threads import to_thread
from imav.malwarelib.config import (
MalwareHitStatus,
MalwareScanResourceType,
QueuedScanState,
)
from imav.malwarelib.model import MalwareHit, MalwareScan
from imav.malwarelib.scan.crontab import is_crontab
from imav.malwarelib.utils.cloudways import CloudwaysUser
logger = logging.getLogger(__name__)
def stub_entry():
return {
"user": None,
"home": None,
"infected": 0,
"infected_db": 0,
"_infected_total": 0,
"scan_id": None,
"scan_date": None,
"scan_status": None,
"cleanup_status": None,
}
def system_users():
"""
Get all system users and initialize a dict for them.
If a user has leftover config files after being deleted then
the panel API might treat him as existent. This is resolved by checking
that a system user is a panel user.
"""
for entry in pwd.getpwall():
u = stub_entry()
u["user"] = entry.pw_name
u["home"] = entry.pw_dir
yield u
async def panel_users():
users = await hosting_panel.HostingPanel().get_users()
return [u for u in system_users() if u["user"] in users]
def get(user_list, **kwargs) -> dict:
for u in user_list:
if all([u[k] == v for k, v in kwargs.items()]):
return u
return stub_entry()
def update_infected_count_and_last_scan(user_list):
homes = [u["home"] for u in user_list]
def expr(_homes):
q = (
MalwareScan.select(
MalwareScan.scanid, MalwareScan.completed, MalwareScan.path
)
.group_by(MalwareScan.path)
.having(MalwareScan.completed == fn.Max(MalwareScan.completed))
.where(MalwareScan.path.in_(_homes))
)
return q
# FIXME: refactor this (lots of duplication)
grouped_hits = (
MalwareHit.select(MalwareHit.user, fn.COUNT().alias("infected"))
.where(
MalwareHit.is_infected()
& (MalwareHit.resource_type == MalwareScanResourceType.FILE.value)
)
.group_by(MalwareHit.user)
)
grouped_db_hits = (
MalwareHit.select(MalwareHit.user, fn.COUNT().alias("infected_db"))
.where(
MalwareHit.is_infected()
& (MalwareHit.resource_type == MalwareScanResourceType.DB.value)
)
.group_by(MalwareHit.user)
)
grouped_hits_dict = {entry.user: entry.infected for entry in grouped_hits}
grouped_db_hits_dict = {
entry.user: entry.infected_db for entry in grouped_db_hits
}
actual_scans = get_results_iterable_expression(expr, homes)
for entry in actual_scans:
u = get(user_list, home=entry.path)
u["infected"] = grouped_hits_dict.get(u["user"], 0)
u["scan_status"] = QueuedScanState.stopped.value
u["scan_id"] = entry.scanid
for user, infected_db in grouped_db_hits_dict.items():
u = get(user_list, user=user)
u["infected_db"] = infected_db
for u in user_list:
u["_infected_total"] = u["infected"] + u["infected_db"]
def update_running_scan_status(user_list, get_scans):
paths = [u["home"] for u in user_list]
for scan, status in get_scans(paths):
u = get(user_list, home=scan.path)
u["scan_id"] = scan.scanid
u["scan_status"] = status
u["scan_type"] = scan.scan_type
def update_cleanup_status(user_list):
"""
Updates cleanup status for the list of panel users
If at least on cleanup is running for user then status is 'running'
Else if there are any finished cleanups then status is 'stopped'
If no started and finished cleanups then status is not set
:param user_list:
"""
users = [u["user"] for u in user_list]
def expression(users) -> Tuple[str, Literal["running", "stopped", None]]:
"""
Returns a list of (user, cleanup_status) tuples where `cleanup_status`
can take one of the values: "running", "stopped", or None
"""
case_running = Case(
None,
(
(
MalwareHit.status.in_(
(
MalwareHitStatus.CLEANUP_PENDING,
MalwareHitStatus.CLEANUP_STARTED,
)
),
1,
),
),
0,
)
case_stopped = Case(
None,
(
(
MalwareHit.status.in_(
(
MalwareHitStatus.CLEANUP_DONE,
MalwareHitStatus.CLEANUP_REMOVED,
)
),
1,
),
),
0,
)
query = (
MalwareHit.select(
MalwareHit.user,
Case(
None,
(
(fn.Sum(case_running) > 0, "running"),
(fn.Sum(case_stopped) > 0, "stopped"),
),
).alias("cleanup_status"),
)
.where(MalwareHit.user.in_(users))
.group_by(MalwareHit.user)
)
return query.tuples()
for user, status in get_results_iterable_expression(expression, users):
u = get(user_list, user=user)
u["cleanup_status"] = status
def update_last_scan_date(user_list):
def expression(homes):
return (
MalwareScan.select(MalwareScan.path, MalwareScan.completed)
.where(MalwareScan.path.in_(homes))
.group_by(MalwareScan.path)
.having(MalwareScan.completed == fn.Max(MalwareScan.completed))
)
home_to_users = defaultdict(list)
for user in user_list:
home_to_users[user["home"]].append(user)
for scan in get_results_iterable_expression(
expression, list(home_to_users)
):
for user in home_to_users[scan.path]:
user["scan_date"] = scan.completed
async def get_matched_users(match) -> Tuple[int, List[Dict[str, Any]]]:
user_list = await panel_users()
if isinstance(match, str):
pattern = re.compile(f".*{match}.*")
elif isinstance(match, Iterable):
pattern = re.compile(f"^({'|'.join(match)})$")
else:
pattern = re.compile(".*")
matched_users = [u for u in user_list if pattern.match(u["user"])]
return len(user_list), matched_users
async def fetch_user_list(get_scans, *, match=None):
max_count, user_list = await get_matched_users(match)
update_infected_count_and_last_scan(user_list)
update_running_scan_status(user_list, get_scans)
update_cleanup_status(user_list)
update_last_scan_date(user_list)
return max_count, user_list
def sort(user_list, field="_infected_total", desc=True):
def getter(element):
field_type = (
int
if field
in ["infected", "infected_db", "_infected_total", "scan_date"]
else str
)
min_val = chr(0) if field_type == str else 0
value = element.get(field)
if value is None:
value = min_val
return value
user_list.sort(key=getter, reverse=desc)
if field == "_infected_total":
for user in user_list:
user.pop("_infected_total")
return user_list
async def get_file_owner(
path: str, users_from_panel: Set[str], pw_all: List[pwd.struct_passwd]
):
"""Get username, groupname for file *path*
pw_all - should contains result of pwd.getpwall()
user_from_panel - users in current panel (see code comment)
Returns tuple (user, group, uid, gid)"""
stat = os.stat(path)
owner = user = uid = stat.st_uid
group = gid = stat.st_gid
p = Path(path)
if uid == 0 and is_crontab(p):
for pw in pw_all:
if pw.pw_name == p.name:
if pw.pw_name in users_from_panel:
owner, user, uid = pw.pw_name, pw.pw_name, pw.pw_uid
group = gid = pw.pw_gid
break
else:
# Plesk-panel clients can have two system users with same uids,
# but only one of them will be used in panel.
for pw in pw_all:
if pw.pw_uid == uid and pw.pw_name in users_from_panel:
owner = user = pw.pw_name
break
try:
group = (await to_thread(grp.getgrgid, gid)).gr_name
except KeyError:
pass
user = CloudwaysUser.override_name_by_path(
p, user, users_from_panel, pw_all
)
return owner, user, group, uid, gid
async def fill_results_owner(results):
users_from_panel = set(await hosting_panel.HostingPanel().get_users())
missing = []
pw_all = await to_thread(pwd.getpwall)
for path, data in results.items():
try:
owner, user, group, uid, gid = await get_file_owner(
path,
users_from_panel,
pw_all,
)
except FileNotFoundError:
missing.append(path)
else:
data["owner"] = owner
data["user"] = user
data["group"] = group
data["uid"] = uid
data["gid"] = gid
for m in missing:
del results[m]
def is_uid(username: str) -> bool:
try:
uid = int(username)
return True
except ValueError:
return False
async def get_username_by_uid(uid) -> str:
uid = int(uid)
pw_all = await to_thread(pwd.getpwall)
return next(
(pw.pw_name for pw in pw_all if pw.pw_uid == uid),
None,
)
Zerion Mini Shell 1.0