WEBDIENSTE/volatility3
1
0
Fork 0
mirror of https://github.com/volatilityfoundation/volatility3.git synced 2026-09-28 04:24:53 +02:00
Code Issues Packages Projects Releases Wiki Activity

Development: Add stub files

Browse Source 
With the plugin module __path__ variable updated at runtime, and plugin
imports based on this updated path within their own module definitions,
static type checkers and language servers cannot resolve these imports
to provide support for autocompletion, type-checking, etc.

This commit:
- Adds the required stub files to make development easier when working
  on plugins
- Removes the stubs directory from the .gitignore file
- Adds a [tool.pyright] section to tell pyright where to look for stubs

Development: Additional stub updates
This commit is contained in:
David McDonald
2025-02-28 13:15:30 -06:00
parent 795b853ad5
commit c7c83ca539
8 changed files with 333 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.gitignore
-1
View File
@@ -13,7 +13,6 @@ workspace.xml
# Manually generated files
.mypy_cache
stubs
volatility3/symbols/linux*
volatility3/symbols/windows*
volatility3/symbols/mac*
pyproject.toml
+3
View File
@@ -76,6 +76,9 @@ include = ["volatility3*"]
mypy_path = "./stubs"
show_traceback = true
[tool.pyright]
stubPath = "./stubs"
[tool.ruff]
line-length = 88
target-version = "py38"
stubs/volatility3/__init__.pyi
+14
View File
@@ -0,0 +1,14 @@
from importlib import abc
from typing import Any, Callable
class classproperty(property):
def __init__(self, func: Callable[[_S], _T]) -> None: ...
def __get__(self, obj: Any, type: _S | None = None) -> _T: ...
class WarningFindSpec(abc.MetaPathFinder):
@staticmethod
def find_spec(
fullname: str, path: list[str] | None, target: None = None, **kwargs
) -> None: ...
warning_find_spec: list[abc.MetaPathFinder]
stubs/volatility3/plugins/__init__.pyi
+27
View File
@@ -0,0 +1,27 @@
from volatility3.framework.plugins import (
banners,
configwriter,
isfinfo,
layerwriter,
linux,
mac,
regexscan,
timeliner,
vmscan,
windows,
yarascan,
)
__all__ = [
"banners",
"configwriter",
"isfinfo",
"layerwriter",
"linux",
"mac",
"regexscan",
"timeliner",
"vmscan",
"windows",
"yarascan",
]
stubs/volatility3/plugins/linux/__init__.pyi
+85
View File
@@ -0,0 +1,85 @@
from volatility3.framework.plugins.linux import (
bash,
boottime,
capabilities,
check_afinfo,
check_creds,
check_idt,
check_modules,
check_syscall,
ebpf,
elfs,
envars,
hidden_modules,
iomem,
ip,
kallsyms,
keyboard_notifiers,
kmsg,
kthreads,
library_list,
lsmod,
lsof,
malfind,
modxview,
mountinfo,
netfilter,
pagecache,
pidhashtable,
proc,
psaux,
pscallstack,
pslist,
psscan,
pstree,
ptrace,
sockstat,
tracing,
tty_check,
vmaregexscan,
vmayarascan,
vmcoreinfo,
)
__all__ = [
"bash",
"boottime",
"capabilities",
"check_afinfo",
"check_creds",
"check_idt",
"check_modules",
"check_syscall",
"ebpf",
"elfs",
"envars",
"hidden_modules",
"iomem",
"ip",
"kallsyms",
"keyboard_notifiers",
"kmsg",
"kthreads",
"library_list",
"lsmod",
"lsof",
"malfind",
"modxview",
"mountinfo",
"netfilter",
"pagecache",
"pidhashtable",
"proc",
"psaux",
"pscallstack",
"pslist",
"psscan",
"pstree",
"ptrace",
"sockstat",
"tracing",
"tty_check",
"vmaregexscan",
"vmayarascan",
"vmcoreinfo",
]
stubs/volatility3/plugins/mac/__init__.pyi
+51
View File
@@ -0,0 +1,51 @@
from volatility3.framework.plugins.mac import (
bash,
check_syscall,
check_sysctl,
check_trap_table,
dmesg,
ifconfig,
kauth_listeners,
kauth_scopes,
kevents,
list_files,
lsmod,
lsof,
malfind,
mount,
netstat,
proc_maps,
psaux,
pslist,
pstree,
socket_filters,
timers,
trustedbsd,
vfsevents,
)
__all__ = [
"bash",
"check_syscall",
"check_sysctl",
"check_trap_table",
"dmesg",
"ifconfig",
"kauth_listeners",
"kauth_scopes",
"kevents",
"list_files",
"lsmod",
"lsof",
"malfind",
"mount",
"netstat",
"proc_maps",
"psaux",
"pslist",
"pstree",
"socket_filters",
"timers",
"trustedbsd",
"vfsevents",
]
stubs/volatility3/plugins/windows/__init__.pyi
+153
View File
@@ -0,0 +1,153 @@
from volatility3.framework.plugins.windows import (
amcache,
bigpools,
cachedump,
callbacks,
cmdline,
cmdscan,
consoles,
crashinfo,
debugregisters,
devicetree,
direct_system_calls,
dlllist,
driverirp,
drivermodule,
driverscan,
dumpfiles,
envars,
filescan,
getservicesids,
getsids,
handles,
hashdump,
hollowprocesses,
iat,
indirect_system_calls,
info,
joblinks,
kpcrs,
ldrmodules,
lsadump,
malfind,
mbrscan,
memmap,
mftscan,
modscan,
modules,
mutantscan,
netscan,
netstat,
orphan_kernel_threads,
pe_symbols,
pedump,
poolscanner,
privileges,
processghosting,
pslist,
psscan,
pstree,
psxview,
registry,
scheduled_tasks,
sessions,
shimcachemem,
skeleton_key_check,
ssdt,
strings,
suspended_threads,
suspicious_threads,
svcdiff,
svclist,
svcscan,
symlinkscan,
thrdscan,
threads,
timers,
truecrypt,
unhooked_system_calls,
unloadedmodules,
vadinfo,
vadregexscan,
vadwalk,
vadyarascan,
verinfo,
virtmap,
)
__all__ = [
"amcache",
"bigpools",
"cachedump",
"callbacks",
"cmdline",
"cmdscan",
"consoles",
"crashinfo",
"debugregisters",
"devicetree",
"direct_system_calls",
"dlllist",
"driverirp",
"drivermodule",
"driverscan",
"dumpfiles",
"envars",
"filescan",
"getservicesids",
"getsids",
"handles",
"hashdump",
"hollowprocesses",
"iat",
"indirect_system_calls",
"info",
"joblinks",
"kpcrs",
"ldrmodules",
"lsadump",
"malfind",
"mbrscan",
"memmap",
"mftscan",
"modscan",
"modules",
"mutantscan",
"netscan",
"netstat",
"orphan_kernel_threads",
"pe_symbols",
"pedump",
"poolscanner",
"privileges",
"processghosting",
"pslist",
"psscan",
"pstree",
"psxview",
"registry",
"scheduled_tasks",
"sessions",
"shimcachemem",
"skeleton_key_check",
"ssdt",
"strings",
"suspended_threads",
"suspicious_threads",
"svcdiff",
"svclist",
"svcscan",
"symlinkscan",
"thrdscan",
"threads",
"timers",
"truecrypt",
"unhooked_system_calls",
"unloadedmodules",
"vadinfo",
"vadregexscan",
"vadwalk",
"vadyarascan",
"verinfo",
"virtmap",
]
volatility3/py.typed
View File