Code
Hub
Workspaces
Following
Trending
Connect
MCP
copy
Index your code
hub
/
github.com/ForensicArtifacts/artifacts-kb
/ functions
Functions
76 in github.com/ForensicArtifacts/artifacts-kb
⨍
Functions
76
◇
Types & classes
15
↓ 17 callers
Method
OpenFileObject
Opens the Windows Message Resource file using a file-like object. Args: file_object (file): file-like object. Raises:
artifactsrc/resource_file.py:223
↓ 13 callers
Method
Close
Closes the Windows Message Resource file. Raises: IOError: if not open. OSError: if not open.
artifactsrc/resource_file.py:132
↓ 13 callers
Method
_GetTestFilePath
Retrieves the path of a test file in the test data directory. Args: path_segments (list[str]): path segments inside the test data d
tests/test_lib.py:24
↓ 13 callers
Method
_SkipIfPathNotExists
Skips the test if the path does not exist. Args: path (str): path of a test file. Raises: SkipTest: if the path
tests/test_lib.py:37
↓ 6 callers
Method
_GetVersionInformation
Determines the file and product version.
artifactsrc/resource_file.py:48
↓ 4 callers
Method
read
Reads the resource data. Returns: bytes: resource data.
tests/resource_file.py:85
↓ 3 callers
Method
_GetVersionInformationResource
Retrieves the version information resource. Returns: pywrc.version_information_resource: version information resource or None
artifactsrc/resource_file.py:81
↓ 3 callers
Method
get_resource_by_identifier
Retrieves a specific resource by identifier. Args: identifier (int): identifier. Returns: object: resource or No
tests/resource_file.py:108
↓ 2 callers
Method
CheckDependencies
Checks the availability of the dependencies. Args: verbose_output (Optional[bool]): True if output should be verbose. Retu
utils/dependencies.py:315
↓ 2 callers
Method
GetMUILanguage
Retrieves the MUI language. Returns: str: MUI language or None if not available.
artifactsrc/resource_file.py:160
↓ 2 callers
Method
GetMessageTableResource
Retrieves the message table resource. Returns: pywrc.resource: resource containing the message table resource or None
artifactsrc/resource_file.py:149
↓ 2 callers
Method
HasMessageTableResource
Determines if the resource file as a message table resource. Returns: bool: True if the resource file as a message table resource.
artifactsrc/resource_file.py:206
↓ 2 callers
Method
Read
Reads dependency definitions. Args: file_object (file): file-like object to read from. Yields: DependencyDefinit
utils/dependencies.py:90
↓ 2 callers
Method
WriteArtifactDefinition
Writes an artifact definition to the index.rst file. Args: artifact_name (str): artifact name.
tools/generate_docs.py:50
↓ 2 callers
Method
_CheckPythonModule
Checks the availability of a Python module. Args: dependency (DependencyDefinition): dependency definition. Returns:
utils/dependencies.py:149
↓ 2 callers
Method
_GetDataTypeMap
Retrieves a data type map defined by the definition file. The data type maps are cached for reuse. Args: name (str): name
artifactsrc/volume_scanner.py:169
↓ 2 callers
Method
_OpenMessageResourceFile
Opens the message resource file specified by the Windows path. Args: windows_path (str): Windows path containing the message resour
artifactsrc/volume_scanner.py:188
↓ 2 callers
Method
_PrintCheckDependencyStatus
Prints the check dependency status. Args: dependency (DependencyDefinition): dependency definition. result (bool): True i
utils/dependencies.py:292
↓ 2 callers
Method
__init__
Initializes a stream.
tests/resource_file.py:101
↓ 1 callers
Method
CheckArtifactDefinition
Checks if an artifact definition on a storage media image. Args: artifact_definition (artifacts.ArtifactDefinition): artifact defin
artifactsrc/volume_scanner.py:303
↓ 1 callers
Method
CheckTestDependencies
Checks the availability of the dependencies when running tests. Args: verbose_output (Optional[bool]): True if output should be ver
utils/dependencies.py:346
↓ 1 callers
Method
GetMUIResource
Retrieves the MUI resource. Returns: pywrc.mui_resource: MUI resource or None if not available.
artifactsrc/resource_file.py:172
↓ 1 callers
Function
Main
Entry point of console script to generate documentation. Returns: int: exit code that is provided to sys.exit().
tools/generate_docs.py:138
↓ 1 callers
Function
Main
Entry point of console script to check artifact definitions. Returns: int: exit code that is provided to sys.exit().
tools/check_artifacts.py:22
↓ 1 callers
Method
ScanForOperatingSystemVolumes
Scans for volumes containing an operating system. Args: source_path (str): source path. options (Optional[dfvfs.VolumeSca
artifactsrc/volume_scanner.py:365
↓ 1 callers
Method
_CheckPythonModuleVersion
Checks the version of a Python module. Args: module_object (module): Python module. module_name (str): name of the Python
utils/dependencies.py:177
↓ 1 callers
Method
_DetermineDataFormat
Determines the data format. Args: names (list[str]): names of data formats to check. file_object (file): file-like object
artifactsrc/volume_scanner.py:136
↓ 1 callers
Method
_FixLinks
Corrects links to .md files not part of the documentation. Args: node (docutils.nodes.Node): docutils node. Returns:
docs/conf.py:121
↓ 1 callers
Method
_GetConfigValue
Retrieves a value from the config parser. Args: config_parser (ConfigParser): configuration parser. section_name (str): n
utils/dependencies.py:74
↓ 1 callers
Method
_ImportPythonModule
Imports a Python module. Args: module_name (str): name of the module. Returns: module: Python module or None if
utils/dependencies.py:271
↓ 1 callers
Method
_OpenMessageResourceFileByPathSpec
Opens the message resource file specified by the path specification. Args: path_spec (dfvfs.PathSpec): path specification.
artifactsrc/volume_scanner.py:204
↓ 1 callers
Method
_ReadChecksDefinitions
Reads the checks definitions from checks.yaml. Returns: list[dict[str, object]]: checks definitions.
artifactsrc/volume_scanner.py:237
↓ 1 callers
Method
_ReadDataTypeFabricDefinitionFile
Reads a dtFabric definition file. Args: filename (str): name of the dtFabric definition file. Returns: dtfabric.
artifactsrc/volume_scanner.py:253
↓ 1 callers
Method
_ReadStructureFromFileObject
Reads a structure from a file-like object. This method currently only supports fixed-size structures. Args: file_object (f
artifactsrc/volume_scanner.py:273
↓ 1 callers
Method
_Traverse
Traverses the document tree rooted at node. Args: node (docutils.nodes.Node): docutils node.
docs/conf.py:142
↓ 1 callers
Method
__init__
Initializes an index.rst output writer.
tools/generate_docs.py:19
↓ 1 callers
Method
__init__
Initializes a dependency helper. Args: dependencies_file (Optional[str]): path to the dependencies configuration file
utils/dependencies.py:121
↓ 1 callers
Method
__init__
Initializes check results.
artifactsrc/volume_scanner.py:33
↓ 1 callers
Method
get_resource_by_name
Retrieves a specific resource by name. Args: name (str): name. Returns: object: resource or None.
tests/resource_file.py:119
Method
GetWindowsVersion
Determines the Windows version from kernel executable file. Returns: str: Windows version or None otherwise.
artifactsrc/volume_scanner.py:341
Function
RunSphinxAPIDoc
Runs sphinx-apidoc to auto-generate documentation. Args: app (sphinx.application.Sphinx): Sphinx application. Required by the the
docs/conf.py:101
Method
WriteArtifactDefinition
Writes an artifact definition to a Markdown file. Args: artifact_definition (list[artifacs.ArtifactDefinition]): artifact
tools/generate_docs.py:80
Method
__enter__
Make this work with the 'with' statement.
tools/generate_docs.py:25
Method
__enter__
Make this work with the 'with' statement.
tools/generate_docs.py:70
Method
__enter__
Make this work with the 'with' statement.
tests/test_lib.py:59
Method
__exit__
Make this work with the 'with' statement.
tools/generate_docs.py:45
Method
__exit__
Make this work with the 'with' statement.
tools/generate_docs.py:75
Method
__exit__
Make this work with the 'with' statement.
tests/test_lib.py:64
Method
__init__
Initializes a Markdown output writer.
tools/generate_docs.py:64
Method
__init__
Initializes a dependency configuration. Args: name (str): name of the dependency.
utils/dependencies.py:32
Method
__init__
Initializes an artifact definitions volume scanner. Args: artifacts_registry (artifacts.ArtifactDefinitionsRegistry): artifact
artifactsrc/volume_scanner.py:110
Method
__init__
Initializes the Windows Message Resource file. Args: windows_path (str): normalized version of the Windows path. ascii_co
artifactsrc/resource_file.py:19
Method
__init__
Initializes a temporary directory.
tests/test_lib.py:54
Method
__init__
Initializes a resource.
tests/resource_file.py:18
Method
__init__
Initializes a resource item. Args: identifier (int]): identifier.
tests/resource_file.py:53
Method
apply
Applies this transform on document tree.
docs/conf.py:154
Method
file_version
str: the file version.
artifactsrc/resource_file.py:119
Method
get_item_by_index
Retrieves a specific resource item. Args: index (int): index. Returns: TestWrcResourceItem: resource item.
tests/resource_file.py:33
Method
get_number_of_items
Retrieves the number of resource items. Returns: int: number of resource items.
tests/resource_file.py:25
Method
get_number_of_sub_items
Retrieves the number of resource sub items. Returns: int: number of resource sub items.
tests/resource_file.py:66
Method
get_sub_item_by_index
Retrieves a specific resource sub item. Args: index (int): index. Returns: TestWrcResourceItem: resource item.
tests/resource_file.py:74
Method
product_version
str: the product version.
artifactsrc/resource_file.py:126
Function
setup
Called at Sphinx initialization. Args: app (sphinx.application.Sphinx): Sphinx application.
docs/conf.py:160
Method
testFileVersionProperty
Tests the file_version property.
tests/resource_file.py:1013
Method
testGetMUILanguage
Tests the GetMUILanguage function.
tests/resource_file.py:1119
Method
testGetMessageTableResourceNoWrc
Tests the GetMessageTableResource function.
tests/resource_file.py:1081
Method
testGetMessageTableResourceWrc
Tests the GetMessageTableResource function.
tests/resource_file.py:1100
Method
testGetVersionInformationNoWrc
Tests the _GetVersionInformation function.
tests/resource_file.py:907
Method
testGetVersionInformationResourceNoWrc
Tests the _GetVersionInformationResource function.
tests/resource_file.py:973
Method
testGetVersionInformationResourceWrc
Tests the _GetVersionInformationResource function.
tests/resource_file.py:993
Method
testGetVersionInformationWrc
Tests the _GetVersionInformation function.
tests/resource_file.py:926
Method
testHasMessageTableResourceNoWrc
Tests the HasMessageTableResource function.
tests/resource_file.py:1144
Method
testHasMessageTableResourceWrc
Tests the HasMessageTableResource function.
tests/resource_file.py:1163
Method
testOpenFileObjectAndCloseNoWrc
Tests the OpenFileObject and Close functions.
tests/resource_file.py:1047
Method
testOpenFileObjectAndCloseWrc
Tests the OpenFileObject and Close functions.
tests/resource_file.py:1064
Method
testProductVersionProperty
Tests the product_version property.
tests/resource_file.py:1029