Skip to content

Commit f9b23d2

Browse files
committed
Update loaders table
1 parent ef506fd commit f9b23d2

1 file changed

Lines changed: 77 additions & 76 deletions

File tree

docs/source/supported-targets.rst

Lines changed: 77 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ The goal is to build a virtual representation of the original system.
1313

1414
For a deeper dive into how loaders work, see :doc:`loaders </advanced/loaders>`.
1515

16-
In most cases, the appropriate loader is selected automatically based on the the file it encounters.
17-
This can be based on the file extension, a directory structure inside the file or a specific configuration inside the file.
18-
However, a loader can be selected manually using ``-L <loader type>`` flag or with URI-style notation ``<loader type>://``.
16+
In most cases, Dissect selects the appropriate loader automatically based on the file you target.
17+
This can be based on the file extension, a specific directory structure inside the file (e.g. inside a zip file) or a specific configuration inside the file.
18+
However, there is an option to select a loader manually using ``-L <loader type>`` flag or with URI-style notation ``<loader type>://``.
1919

2020
.. code-block:: bash
2121
@@ -25,157 +25,158 @@ However, a loader can be selected manually using ``-L <loader type>`` flag or wi
2525
2626
.. list-table:: Supported Loaders
2727
:header-rows: 1
28-
:widths: 15 10 25
28+
:widths: 15 20 10 5
2929

3030
* - Name
31-
- Loader type
32-
- File extensions
3331
- Description
32+
- Extension
33+
- Type
3434
* - Android Backup
35-
- :class:`ab <dissect.target.loaders.ab.AndroidBackupLoader>`
36-
- ``.ab``
3735
- Android backup files.
36+
- ``.ab``
37+
- :class:`ab <dissect.target.loaders.ab.AndroidBackupLoader>`
3838
* - Carbon Black
39-
- :class:`cb <dissect.target.loaders.cb.CbLoader>`
40-
-
4139
- Carbon Black Live Response endpoints. Can only be used directly with ``cb://`` or ``-L cb``.
40+
-
41+
- :class:`cb <dissect.target.loaders.cb.CbLoader>`
4242
* - Cellebrite
43-
- :class:`cellebrite <dissect.target.loaders.cellebrite.CellebriteLoader>`
44-
- ``.ufdx``, ``.ufd``
4543
- Cellebrite UFED exports files.
44+
- ``.ufdx``, ``.ufd``
45+
- :class:`cellebrite <dissect.target.loaders.cellebrite.CellebriteLoader>`
4646
* - Directory
47-
- :class:`dir <dissect.target.loaders.dir.DirLoader>`
48-
-
4947
- Use a local directory as the root of a virtual filesystem.
48+
-
49+
- :class:`dir <dissect.target.loaders.dir.DirLoader>`
5050
* - Hyper-V
51-
- :class:`hyperv <dissect.target.loaders.hyperv.HyperVLoader>`
52-
- ``.vmcx``, ``.xml``
5351
- Microsoft Hyper-V configuration files.
52+
- ``.vmcx``, ``.xml``
53+
- :class:`hyperv <dissect.target.loaders.hyperv.HyperVLoader>`
5454
* - Itunes Backup
55-
- :class:`itunes <dissect.target.loaders.itunes.ITunesLoader>`
56-
-
5755
- iTunes backup files. Only from a directory that contains a ``Manifest.plist`` file.
56+
-
57+
- :class:`itunes <dissect.target.loaders.itunes.ITunesLoader>`
5858
* - Kape
59-
- :class:`kape <dissect.target.loaders.kape.KapeLoader>`
60-
- ``.vhdx`` or ``directory/``
6159
- KAPE forensic image format files. Only if the file or directory contains Kape specific directories.
60+
- ``.vhdx`` or ``directory/``
61+
- :class:`kape <dissect.target.loaders.kape.KapeLoader>`
6262
* - Libvirt
63-
- :class:`libvirt <dissect.target.loaders.libvirt.LibvirtLoader>`
64-
- ``.xml``
6563
- Libvirt xml configuration files.
64+
- ``.xml``
65+
- :class:`libvirt <dissect.target.loaders.libvirt.LibvirtLoader>`
6666
* - Local
67-
- :class:`local <dissect.target.loaders.local.LocalLoader>`
6867
- Interpret the local system inside Dissect.
68+
-
69+
- :class:`local <dissect.target.loaders.local.LocalLoader>`
6970
* - Log
70-
- :class:`log <dissect.target.loaders.log.LogLoader>`
71-
-
7271
- Target specific log files. Can only be used directly with ``cb://`` or ``-L log``.
73-
* - MQTT
74-
- :class:`mqtt <dissect.target.loaders.mqtt.MqttLoader>`
7572
-
73+
- :class:`log <dissect.target.loaders.log.LogLoader>`
74+
* - MQTT
7675
- MQTT broker. Can only be used directly with ``mqtt://`` or ``-L mqtt``.
76+
-
77+
- :class:`mqtt <dissect.target.loaders.mqtt.MqttLoader>`
7778
* - OVA
78-
- :class:`ova <dissect.target.loaders.ova.OvaLoader>`
79-
- ``.ova``
8079
- Virtual Appliance files.
80+
- ``.ova``
81+
- :class:`ova <dissect.target.loaders.ova.OvaLoader>`
8182
* - Overlay
82-
- :class:`overlay <dissect.target.loaders.overlay.OverlayLoader>`,
83-
-
8483
- Construct a filesystem of the different layers of a ``podman`` container directory.
85-
* - Overlay2
86-
- :class:`overlay2 <dissect.target.loaders.overlay2.Overlay2Loader>`
8784
-
85+
- :class:`overlay <dissect.target.loaders.overlay.OverlayLoader>`,
86+
* - Overlay2
8887
- Construct a filesystem of the different layers of a ``docker`` container directory.
88+
-
89+
- :class:`overlay2 <dissect.target.loaders.overlay2.Overlay2Loader>`
8990
* - Open Virtualization Format
90-
- :class:`ovf <dissect.target.loaders.ovf.OvfLoader>`
91-
- ``.ovf``
9291
- Open Virtualization Format (OVF) files.
92+
- ``.ovf``
93+
- :class:`ovf <dissect.target.loaders.ovf.OvfLoader>`
9394
* - Phobos
94-
- :class:`phobos <dissect.target.loaders.phobos.PhobosLoader>`
95-
- ``.eight``
9695
- Phobos Ransomware files.
96+
- ``.eight``
97+
- :class:`phobos <dissect.target.loaders.phobos.PhobosLoader>`
9798
* - Proxmox
98-
- :class:`proxmox <dissect.target.loaders.proxmox.ProxmoxLoader>`
99-
- ``.conf``
10099
- Proxmox VM configuration files.
100+
- ``.conf``
101+
- :class:`proxmox <dissect.target.loaders.proxmox.ProxmoxLoader>`
101102
* - Parallels VM
103+
- Parallels VM directory (.pvm) and the conviguration file (config.pvs)
104+
- ``.pvm``, ``config.pvs``
102105
- :class:`pvm <dissect.target.loaders.pvm.PvmLoader>`,
103106
:class:`pvs <dissect.target.loaders.pvs.PvsLoader>`
104-
- ``.pvm``, ``config.pvs``
105-
- Parallels VM directory (.pvm) and the conviguration file (config.pvs)
106107
* - Raw
107-
- :class:`raw <dissect.target.loaders.raw.RawLoader>`,
108-
:class:`multiraw <dissect.target.loaders.multiraw.MultiRawLoader>`
109-
-
110108
- Raw binary files such as disk images.
111109
To load multiple raw containers in a single target, use ``MultiRaw``.
112110
To use this loader automatically use ``+`` to chain disks. E.g. ``/dev/vda+/dev/vdb``
111+
-
112+
- :class:`raw <dissect.target.loaders.raw.RawLoader>`,
113+
:class:`multiraw <dissect.target.loaders.multiraw.MultiRawLoader>`
113114
* - Remote
114-
- :class:`remote <dissect.target.loaders.remote.RemoteLoader>`
115-
-
116115
- Connect to a remote target that runs a compatible Dissect agent. Can only be used directly with ``remote://`` or ``-L remote``.
117-
* - SMB
118-
- :class:`smb <dissect.target.loaders.smb.SmbLoader>`
119116
-
117+
- :class:`remote <dissect.target.loaders.remote.RemoteLoader>`
118+
* - SMB
120119
- Use an SMB connection to user remote SMB servers as a target.
121120
This particular loader requires ``impacket`` to be installed.
122121
Can only be used directly with ``smb://`` or ``-L smb``.
123-
* - Tanium
124-
- :class:`tanium <dissect.target.loaders.tanium.TaniumLoader>`
125122
-
123+
- :class:`smb <dissect.target.loaders.smb.SmbLoader>`
124+
* - Tanium
126125
- Tanium forensic image format files.
126+
-
127+
- :class:`tanium <dissect.target.loaders.tanium.TaniumLoader>`
127128
* - Tar
128-
- :class:`tar <dissect.target.loaders.tar.TarLoader>`
129-
- ``.tar``, ``.tar.<comp>``, ``.t<comp>``
130129
- (Compressed) Tar files, docker container images and output files from Acquire or UAC.
130+
- ``.tar``, ``.tar.<comp>``, ``.t<comp>``
131+
- :class:`tar <dissect.target.loaders.tar.TarLoader>`
131132
* - Target
132-
- :class:`target <dissect.target.loaders.target.TargetLoader>`
133-
- ``.target``
134133
- Load target system using a target file.
134+
- ``.target``
135+
- :class:`target <dissect.target.loaders.target.TargetLoader>`
135136
* - Unix-like Artifacts Collector
136-
- :class:`uac <dissect.target.loaders.uac.UacLoader>`
137-
-
138137
- UAC tool output. Detects whether the directory contains ``uac.log`` and a ``[root]`` directory.
138+
-
139+
- :class:`uac <dissect.target.loaders.uac.UacLoader>`
139140
* - UTM
140-
- :class:`utm <dissect.target.loaders.utm.UtmLoader>`
141-
- ``*.utm/`` directory.
142141
- UTM virtual machine files.
142+
- ``*.utm/`` directory.
143+
- :class:`utm <dissect.target.loaders.utm.UtmLoader>`
143144
* - VB
144-
- :class:`vb <dissect.target.loaders.vb.VBLoader>`
145-
- .. TODO:
146145
- .. TODO: looks like it supports rawcopy or something.
146+
-
147+
- :class:`vb <dissect.target.loaders.vb.VBLoader>`
147148
* - Virtual Box
148-
- :class:`vbox <dissect.target.loaders.vbox.VBoxLoader>`
149-
- ``.vbox``
150149
- Oracle VirtualBox files.
150+
- ``.vbox``
151+
- :class:`vbox <dissect.target.loaders.vbox.VBoxLoader>`
151152
* - Veaam Backup
152-
- :class:`vbk <dissect.target.loaders.vbk.VbkLoader>`
153-
- ``.vbk``
154153
- Load Veaam Backup (VBK) files.
154+
- ``.vbk``
155+
- :class:`vbk <dissect.target.loaders.vbk.VbkLoader>`
155156
* - Velociraptor
156-
- :class:`velociraptor <dissect.target.loaders.velociraptor.VelociraptorLoader>`
157-
-
158157
- Rapid7 Velociraptor forensic image files. Either loads in the zip file or a directory containing the contents.
158+
-
159+
- :class:`velociraptor <dissect.target.loaders.velociraptor.VelociraptorLoader>`
159160
* - Virtual Machine Archive
160-
- :class:`vma <dissect.target.loaders.vma.VmaLoader>`
161-
- ``.vma``
162161
- Proxmox Virtual Machine Archive files.
162+
- ``.vma``
163+
- :class:`vma <dissect.target.loaders.vma.VmaLoader>`
163164
* - VMware Fusion
164-
- :class:`vmwarevm <dissect.target.loaders.vmwarevm.VmwarevmLoader>`
165-
- ``.vmwarevm``
166165
- VMware Fusion virtual machines.
166+
- ``.vmwarevm``
167+
- :class:`vmwarevm <dissect.target.loaders.vmwarevm.VmwarevmLoader>`
167168
* - VMware VM configuration
168-
- :class:`vmx <dissect.target.loaders.vmx.VmxLoader>`
169-
- ``.vmx``
170169
- VMware virtual machine configuration files.
170+
- ``.vmx``
171+
- :class:`vmx <dissect.target.loaders.vmx.VmxLoader>`
171172
* - XVA
172-
- :class:`xva <dissect.target.loaders.xva.XvaLoader>`
173-
- ``.xva``
174173
- Citrix Hypervisor format files.
174+
- ``.xva``
175+
- :class:`xva <dissect.target.loaders.xva.XvaLoader>`
175176
* - Zip
176-
- :class:`zip <dissect.target.loaders.zip.ZipLoader>`
177-
- ``.zip``
178177
- Zip files themselves or load the output of tools like Acquire or UAC.
178+
- ``.zip``
179+
- :class:`zip <dissect.target.loaders.zip.ZipLoader>`
179180

180181
Containers
181182
~~~~~~~~~~

0 commit comments

Comments
 (0)