-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathcli_options.html
403 lines (370 loc) · 31.2 KB
/
cli_options.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<title>DFIR ORC Command-line Options — DFIR ORC documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/solar.css" />
<link rel="stylesheet" type="text/css" href="_static/css/custom.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="WolfLauncher Configuration File" href="wolf_config.html" />
<link rel="prev" title="Referencing Resources in Configurations" href="resources.html" /><link href='http://fonts.googleapis.com/css?family=Source+Code+Pro|Open+Sans:300italic,400italic,700italic,400,300,700' rel='stylesheet' type='text/css'>
<link href="_static/solarized-dark.css" rel="stylesheet">
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" >
<a href="wolf_config.html" title="WolfLauncher Configuration File"
accesskey="N">next</a>
<li class="right" >
<a href="resources.html" title="Referencing Resources in Configurations"
accesskey="P">previous</a>
|</li>
<li class="nav-item nav-item-0"><a href="index.html">DFIR ORC documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="configuration.html" accesskey="U">Configuration</a> »</li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="index.html">
<img class="logo" src="_static/logo.jpg" alt="Logo"/>
</a></p>
<h3><a href="index.html">Table of Contents</a></h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="tuto.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="platforms.html">Requirements</a></li>
<li class="toctree-l1"><a class="reference internal" href="intro_to_data_collection.html">Design and Architecture</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="configuration.html">Configuration</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="resources.html">Referencing Resources in Configurations</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">DFIR ORC Command-line Options</a></li>
<li class="toctree-l2"><a class="reference internal" href="wolf_config.html">WolfLauncher Configuration File</a></li>
<li class="toctree-l2"><a class="reference internal" href="ToolEmbed.html">ToolEmbed</a></li>
<li class="toctree-l2"><a class="reference internal" href="orc_local_config.html">DFIR ORC Local Configuration File</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="embedded_tool_suite.html">Embedded Tool Suite</a></li>
<li class="toctree-l1"><a class="reference internal" href="licenses.html">Licenses</a></li>
</ul>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="dfir-orc-command-line-options">
<h1>DFIR ORC Command-line Options<a class="headerlink" href="#dfir-orc-command-line-options" title="Permalink to this heading">¶</a></h1>
<p>DFIR ORC cannot be solely configured using command-line options. It never was and never will be possible.
DFIR ORC is configured using XML configuration files. Command-line options are too often misused, misspelled or misunderstood
by users and/or administrators. DFIR ORC aims to be error resilient and delivers its output no matter what.
That being said, command-line options can be used to change certain behaviors of a configured binary.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Options are case insensitive.</p>
</div>
<section id="out-outputfolder-option">
<h2><code class="docutils literal notranslate"><span class="pre">/out=<OutputFolder></span></code> Option<a class="headerlink" href="#out-outputfolder-option" title="Permalink to this heading">¶</a></h2>
<p>Modifies the output location of the archives. This must be an existing directory with write access for the user running <code class="docutils literal notranslate"><span class="pre">DFIR-Orc.exe</span></code>.</p>
<div class="highlight-bat notranslate"><div class="highlight"><pre><span></span>/out=<span class="p"><</span>OutputFolder>
/out=\\myServer\MyShare\OutputFolder
</pre></div>
</div>
<p>By default, outputs are written in the current directory a.k.a. <code class="docutils literal notranslate"><span class="pre">.</span></code></p>
<p>This option overrides the output location setting defined by the <a class="reference internal" href="orc_local_config.html#orc-local-config-output-element"><span class="std std-ref">output element</span></a> in a local configuration file.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This option does not affect the upload location.</p>
</div>
</section>
<section id="tempdir-tempfolder-option">
<h2><code class="docutils literal notranslate"><span class="pre">/TempDir=<TempFolder></span></code> Option<a class="headerlink" href="#tempdir-tempfolder-option" title="Permalink to this heading">¶</a></h2>
<p>Changes the temporary folder used for temporary files.</p>
<div class="highlight-bat notranslate"><div class="highlight"><pre><span></span>/tempdir=<span class="p"><</span>OutputFolder>
/tempdir=<span class="nv">%temp%</span>\MyTemp
</pre></div>
</div>
<p>By default, %TEMP%\WorkingTemp\ is used.</p>
<p>This option overrides the directory defined in the <a class="reference internal" href="orc_local_config.html#orc-local-config-temporary-element"><span class="std std-ref">temporary element</span></a> in a local configuration file.</p>
</section>
<section id="keys-option">
<span id="cli-options-keys"></span><h2><code class="docutils literal notranslate"><span class="pre">/Keys</span></code> Option<a class="headerlink" href="#keys-option" title="Permalink to this heading">¶</a></h2>
<p>This option can be used to visualize the archives and commands of a configured binary <code class="docutils literal notranslate"><span class="pre">DFIR-Orc.exe</span></code>.
When <code class="docutils literal notranslate"><span class="pre">/Keys</span></code> is used, no command is executed, no archives are created.</p>
<div class="highlight-bat notranslate"><div class="highlight"><pre><span></span>/Keys
</pre></div>
</div>
<p>An example of the output for this command is shown below.</p>
<div class="highlight-bat notranslate"><div class="highlight"><pre><span></span>.\DFIR-Orc.exe /Keys
DFIR-Orc Version 10.0.2.000
<span class="k">Start</span> time : 10/22/2019 09:07:07.956 (UTC)
Computer : DESKTOP-ORBLVTG
User : DESKTOP-ORBLVTG\user (elevated)
System type : WorkStation
System tags : OSBuild#18362,RTM,Release#1903,Windows10,WorkStation,x64
Operating System : Microsoft Windows 10 Professional (build 18362), 64-bit
Output directory : C:\Temp\output (encoding=UTF8)
Temp directory : C:\Temp\WorkingTemp (encoding=UTF8)
Log file : DFIR-ORC_WorkStation_DESKTOP-ORBLVT_20191022_090707.log
Repeat Behavior : No global override set (config behavior used)
Priority : Low
[X] Archive: Main (file is DFIR-ORC_WorkStation_DESKTOP-ORBLVTG_Main.7z)
[X] Command SystemInfo
[X] Command Processes
[X] Command GetEvents
[X] Command Autoruns
[X] Command NTFSInfo
[ ] Command NTFSInfoHashPE
[X] Command FatInfo
[ ] Command FatInfoHashPE
[X] Command USNInfo
[X] Command GetArtefacts
[X] Archive: Hives (file is DFIR-ORC_WorkStation_DESKTOP-ORBLVTG_Hives.7z)
[X] Command GetSystemHives
[X] Command GetUserHives
[X] Command GetSamHive
[ ] Archive: Yara (file is DFIR-ORC_WorkStation_DESKTOP-ORBLVTG_Yara.7z)
[X] Command GetYara
Finish time : 10/22/2019 09:07:07.956 (UTC)
Elapsed time : 0 msecs
</pre></div>
</div>
<p>An <code class="docutils literal notranslate"><span class="pre">[X]</span></code> before an archive implies that it will be collected. However, an <code class="docutils literal notranslate"><span class="pre">[X]</span></code> before a command only shows the default commands run when collecting the archive. If the archive itself is not selected, the command <strong>will not</strong> be run.
In the previous example, the archives <code class="docutils literal notranslate"><span class="pre">Main.7z</span></code> and <code class="docutils literal notranslate"><span class="pre">Hives.7z</span></code> are computed but not <code class="docutils literal notranslate"><span class="pre">Yara.7z</span></code>.</p>
</section>
<section id="key-keyword-key-keyword-and-key-keyword-options">
<h2><code class="docutils literal notranslate"><span class="pre">/Key=<Keyword></span></code>, <code class="docutils literal notranslate"><span class="pre">/+Key=<Keyword></span></code> and <code class="docutils literal notranslate"><span class="pre">/-Key=<Keyword></span></code> Options<a class="headerlink" href="#key-keyword-key-keyword-and-key-keyword-options" title="Permalink to this heading">¶</a></h2>
<p>Regarding the <code class="docutils literal notranslate"><span class="pre"><Keyword></span></code> value:</p>
<ul class="simple">
<li><p>the list of available keywords can be obtained with the <code class="docutils literal notranslate"><span class="pre">/Keys</span></code> option,</p></li>
<li><p>can be a comma separated list of keywords,</p></li>
<li><p>are case insensitive,</p></li>
<li><p>non-matching keywords are not executed nor generated (and no warning message displayed).</p></li>
</ul>
<p>The <code class="docutils literal notranslate"><span class="pre">/Key=<Keyword></span></code> option allows the selection of specific commands to be executed or archives to be generated.</p>
<div class="highlight-bat notranslate"><div class="highlight"><pre><span></span>/Key=<span class="p"><</span>Keyword>
/Key=Main
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">/+Key=<Keyword></span></code> option enables an optional archive or command (cf. <a class="reference internal" href="wolf_config.html#wolf-config-archive-element"><span class="std std-ref">archive element</span></a>, <a class="reference internal" href="wolf_config.html#wolf-config-command-element"><span class="std std-ref">command element</span></a>).</p>
<div class="highlight-bat notranslate"><div class="highlight"><pre><span></span>/+Key=<span class="p"><</span>Keyword>
/+Key=GetYara
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">/-Key=<Keyword></span></code> option disables an archive generation or command execution.</p>
<div class="highlight-bat notranslate"><div class="highlight"><pre><span></span>/-Key=<span class="p"><</span>Keyword>
/-Key=Hives,NTFSInfo
</pre></div>
</div>
<p>Options <code class="docutils literal notranslate"><span class="pre">/+Key</span></code> and <code class="docutils literal notranslate"><span class="pre">/-Key</span></code> can be combined and repeated on the command line. <code class="docutils literal notranslate"><span class="pre">/+Key</span></code> options take effect first and then the <code class="docutils literal notranslate"><span class="pre">/-Key</span></code> ones.</p>
<p>This option overrides the attributes of the <a class="reference internal" href="wolf_config.html#wolf-config-archive-element"><span class="std std-ref">archive element</span></a> and the <a class="reference internal" href="wolf_config.html#wolf-config-command-element"><span class="std std-ref">command element</span></a>.</p>
<p>It also overrides optional settings using <a class="reference internal" href="orc_local_config.html#orc-local-config-key-element"><span class="std std-ref">key, enable_key and disable_key elements</span></a> in a local configuration file.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>“c++” syntax <code class="docutils literal notranslate"><span class="pre">/Key+=<keyword></span></code> and <code class="docutils literal notranslate"><span class="pre">/Key-=<keyword></span></code> is also supported.</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><code class="docutils literal notranslate"><span class="pre">/Keys</span></code> can be used in conjunction with <code class="docutils literal notranslate"><span class="pre">/Key</span></code>, <code class="docutils literal notranslate"><span class="pre">/+Key</span></code> and <code class="docutils literal notranslate"><span class="pre">/-Key</span></code> to visualize the command and archives actually selected to be collected.</p>
</div>
</section>
<section id="childdebug-and-nochilddebug-options">
<h2><code class="docutils literal notranslate"><span class="pre">/ChildDebug</span></code> and <code class="docutils literal notranslate"><span class="pre">/NoChildDebug</span></code> Options<a class="headerlink" href="#childdebug-and-nochilddebug-options" title="Permalink to this heading">¶</a></h2>
<p>These options respectively enable and disable the debugger of DFIR ORC.</p>
<div class="highlight-bat notranslate"><div class="highlight"><pre><span></span>/ChildDebug
/NoChildDebug
</pre></div>
</div>
<p>The debugger is disabled by default.</p>
<p>This option overrides the <code class="docutils literal notranslate"><span class="pre">ChildDebug</span></code> attribute set in the <a class="reference internal" href="wolf_config.html#wolf-config-wolf-element"><span class="std std-ref">wolf element</span></a>.</p>
</section>
<section id="once-overwrite-and-createnew-options">
<h2><code class="docutils literal notranslate"><span class="pre">/Once</span></code>, <code class="docutils literal notranslate"><span class="pre">/Overwrite</span></code> and <code class="docutils literal notranslate"><span class="pre">/CreateNew</span></code> Options<a class="headerlink" href="#once-overwrite-and-createnew-options" title="Permalink to this heading">¶</a></h2>
<p>These options control the behavior of the launcher when the output archives are already present in the output or upload location (cf. <a class="reference internal" href="wolf_config.html#wolf-config-archive-element"><span class="std std-ref">archive element</span></a>).</p>
<p>These options apply to all archives created by the execution of <code class="docutils literal notranslate"><span class="pre">DFIR-Orc.exe</span></code>.</p>
<div class="highlight-bat notranslate"><div class="highlight"><pre><span></span>/Once
/OverWrite
/CreateNew
</pre></div>
</div>
<p>This option overrides the <code class="docutils literal notranslate"><span class="pre">repeat</span></code> attribute set in the <a class="reference internal" href="wolf_config.html#wolf-config-archive-element"><span class="std std-ref">archive element</span></a> in a WolfLauncher configuration file.</p>
</section>
<section id="compression-compressionlevel-option">
<h2><code class="docutils literal notranslate"><span class="pre">/Compression=<CompressionLevel></span></code> Option<a class="headerlink" href="#compression-compressionlevel-option" title="Permalink to this heading">¶</a></h2>
<p>This option controls the level of compression for generated archives.
Allowed values are: <code class="docutils literal notranslate"><span class="pre">None</span></code>, <code class="docutils literal notranslate"><span class="pre">Fastest</span></code>, <code class="docutils literal notranslate"><span class="pre">Fast</span></code>, <code class="docutils literal notranslate"><span class="pre">Normal</span></code>, <code class="docutils literal notranslate"><span class="pre">Maximum</span></code>, <code class="docutils literal notranslate"><span class="pre">Ultra</span></code>.</p>
<p>The override applies to all archives created by the DFIR ORC execution.</p>
<div class="highlight-bat notranslate"><div class="highlight"><pre><span></span>/Compression=Fast
</pre></div>
</div>
<p>By default, level <code class="docutils literal notranslate"><span class="pre">Normal</span></code> is used.</p>
<p>This option overrides the <code class="docutils literal notranslate"><span class="pre">compression</span></code> attribute set in the <a class="reference internal" href="wolf_config.html#wolf-config-archive-element"><span class="std std-ref">archive element</span></a> in a WolfLauncher configuration file.</p>
</section>
<section id="archive-timeout-timeoutvalue-option">
<h2><code class="docutils literal notranslate"><span class="pre">/archive_timeout=<TimeoutValue></span></code> Option<a class="headerlink" href="#archive-timeout-timeoutvalue-option" title="Permalink to this heading">¶</a></h2>
<p>This option configures the number of minutes during which the archive is allowed to run <strong>after</strong> the last command finishes. In other words, this parameter is the timeout after which the archive is canceled at the end of command execution.</p>
<div class="highlight-bat notranslate"><div class="highlight"><pre><span></span>/archive_timeout=10
</pre></div>
</div>
<p>By default, an archive creation has to complete within 5 minutes after the last command terminates.</p>
<p>This option overrides the <code class="docutils literal notranslate"><span class="pre">archive_timeout</span></code> attribute set in the <a class="reference internal" href="wolf_config.html#wolf-config-archive-element"><span class="std std-ref">archive element</span></a> in a WolfLauncher configuration file.</p>
</section>
<section id="command-timeout-timeoutvalue-option">
<h2><code class="docutils literal notranslate"><span class="pre">/command_timeout=<TimeoutValue></span></code> Option<a class="headerlink" href="#command-timeout-timeoutvalue-option" title="Permalink to this heading">¶</a></h2>
<p>This option configures the time span (in minutes) during which the command engine is allowed to run. In other words, this parameter configures the total amount of time, per archive, the commands can take to execute.</p>
<div class="highlight-bat notranslate"><div class="highlight"><pre><span></span>/command_timeout=180
</pre></div>
</div>
<p>By default, after 3 hours, any pending command is killed, the archive is then properly completed and closed.</p>
<p>This option overrides the attribute <code class="docutils literal notranslate"><span class="pre">command_timeout</span></code> of the <a class="reference internal" href="wolf_config.html#wolf-config-archive-element"><span class="std std-ref">archive element</span></a> in a WolfLauncher configuration file.</p>
</section>
<section id="tee-cleartext-option">
<h2><code class="docutils literal notranslate"><span class="pre">/tee_cleartext</span></code> Option<a class="headerlink" href="#tee-cleartext-option" title="Permalink to this heading">¶</a></h2>
<p>This option is for <strong>testing/debugging purposes only</strong>. It creates a clear text file alongside the encrypted file when DFIR ORC encrypts its output (cf <a class="reference internal" href="wolf_config.html#wolf-config-recipient-element"><span class="std std-ref">wolf recipient element</span></a>).</p>
</section>
<section id="no-journaling-option">
<h2><code class="docutils literal notranslate"><span class="pre">/no_journaling</span></code> Option<a class="headerlink" href="#no-journaling-option" title="Permalink to this heading">¶</a></h2>
<p>This option disables the journal format inside PKCS#7 CMS messages (for encrypted archives), thus directly creating the enveloped archive inside the CMS message (at the expense of a temporary clear text file created on disk).</p>
</section>
<section id="werdontshowui-option">
<h2><code class="docutils literal notranslate"><span class="pre">/WERDontShowUI</span></code> Option<a class="headerlink" href="#werdontshowui-option" title="Permalink to this heading">¶</a></h2>
<p>When <code class="docutils literal notranslate"><span class="pre">DFIR-Orc.exe</span></code> and children crash (no matter whether child debug is enabled), it may happen that a user interface is shown to the user, asking for interaction.</p>
<p>This results in a loss of concurrent execution and <code class="docutils literal notranslate"><span class="pre">DFIR-Orc.exe</span></code> eventually hangs (when all concurrent runs are blocked by this UI). To prevent this, the <code class="docutils literal notranslate"><span class="pre">WERDontShowUI</span></code> option temporarily disables WER UI (Microsoft Windows Error Reporting).
When DFIR ORC ends, this parameter is reset to its previous value.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Using this option may modify twice the registry value of <code class="docutils literal notranslate"><span class="pre">HKEY_CURRENT_USER\Software\Microsoft\Windows\Windows</span> <span class="pre">Error</span> <span class="pre">Reporting,DontShowUI</span></code>.</p>
</div>
<p>By default, it is disabled (i.e. WER prompts are shown).</p>
<p>This option overrides the <code class="docutils literal notranslate"><span class="pre">werdontshowui</span></code> attribute of the <a class="reference internal" href="wolf_config.html#wolf-config-wolf-element"><span class="std std-ref">wolf element</span></a>.</p>
</section>
<section id="priority-level-option">
<h2><code class="docutils literal notranslate"><span class="pre">/Priority=<Level></span></code> Option<a class="headerlink" href="#priority-level-option" title="Permalink to this heading">¶</a></h2>
<p>To avoid impact on the user experience during the tool execution, <code class="docutils literal notranslate"><span class="pre">DFIR-Orc.exe</span></code> can be launched with a modified priority (typically below normal).</p>
<p>Available priority values are:</p>
<table class="docutils align-left">
<thead>
<tr class="row-odd"><th class="head"><p>Priority level</p></th>
<th class="head"><p>Description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">low</span></code></p></td>
<td><p>BELOW_NORMAL_PRIORITY_CLASS</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">normal</span></code></p></td>
<td><p>NORMAL_PRIORITY_CLASS</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">high</span></code></p></td>
<td><p>ABOVE_NORMAL_PRIORITY_CLASS</p></td>
</tr>
</tbody>
</table>
<p>This option overrides the <code class="docutils literal notranslate"><span class="pre">priority</span></code> attribute of the <a class="reference internal" href="orc_local_config.html#orc-local-config-dfir-orc-element"><span class="std std-ref">dfir-orc element</span></a> in a local configuration file.</p>
</section>
<section id="powerstate-requirements-option">
<h2><code class="docutils literal notranslate"><span class="pre">/PowerState=<Requirements></span></code> Option<a class="headerlink" href="#powerstate-requirements-option" title="Permalink to this heading">¶</a></h2>
<p>To avoid letting the computer sleep (a.k.a. going to StandBy or S3 power mode) when the user is away, this option can be used with the following values:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">SystemRequired</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">DisplayRequired</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">UserPresent</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">AwayMode</span></code></p></li>
</ul>
<p>To only prevent sleep, recommended value for this option is: <code class="docutils literal notranslate"><span class="pre">SystemRequired,AwayMode</span></code>.</p>
<p>This option overrides the <code class="docutils literal notranslate"><span class="pre">powerstate</span></code> attribute of the <a class="reference internal" href="orc_local_config.html#orc-local-config-dfir-orc-element"><span class="std std-ref">dfir-orc element</span></a> in a local configuration file.</p>
</section>
<section id="nolimits-command1-command2-option">
<h2><code class="docutils literal notranslate"><span class="pre">/NoLimits[:<Command1>,<Command2>,...]</span></code> Option<a class="headerlink" href="#nolimits-command1-command2-option" title="Permalink to this heading">¶</a></h2>
<p>Overrides the safety limits configuration when collecting with <code class="docutils literal notranslate"><span class="pre">GetThis</span></code> and <code class="docutils literal notranslate"><span class="pre">GetSamples</span></code> subcommands.</p>
<p>The option <code class="docutils literal notranslate"><span class="pre">/nolimits</span></code> with no value means that ALL configurated commands will have no output size limits. BEWARE: this could easily use all available storage space. As such, it is recommanded to target specific overrides by indicating one or more commands (see available list with <code class="docutils literal notranslate"><span class="pre">/Keys</span></code> option).</p>
<p>For example:
1. Execute the configured DFIR-ORC but overrides limits for <code class="docutils literal notranslate"><span class="pre">GetFoo</span></code> and <code class="docutils literal notranslate"><span class="pre">GetBar</span></code> commands:</p>
<div class="highlight-bat notranslate"><div class="highlight"><pre><span></span>dfir-orc.exe /nolimits:GetFoo,GetBar ...
</pre></div>
</div>
<ol class="arabic simple" start="2">
<li><p>Only execute <code class="docutils literal notranslate"><span class="pre">GetFoo</span></code> and overrides limits for this command:</p></li>
</ol>
<div class="highlight-bat notranslate"><div class="highlight"><pre><span></span>dfir-orc.exe /key=GetFoo /nolimits
dfir-orc.exe /key=GetFoo /nolimits:GetFoo
</pre></div>
</div>
</section>
<section id="mothership-specific-command-line-options">
<h2>Mothership Specific Command-line Options<a class="headerlink" href="#mothership-specific-command-line-options" title="Permalink to this heading">¶</a></h2>
<p>The <a class="reference internal" href="architecture.html#architecture-exec"><span class="std std-ref">Mothership mechanism</span></a> allows DFIR ORC to be executed in any compatible context (Scheduled Task, Logon Script, Startup script, x86/x64…). The configuration allows the Mothership to launch the subsequent execution which suits the context. Specific command-line options can be used to customize this behavior.</p>
<section id="nowait-option">
<h3><code class="docutils literal notranslate"><span class="pre">-NoWait</span></code> Option<a class="headerlink" href="#nowait-option" title="Permalink to this heading">¶</a></h3>
<p>With this option, the mothership executes the command engine (i.e. WolfLauncher) with appropriate options (CREATE_SUSPENDED|CREATE_BREAKAWAY_FROM_JOB) and return immediately.
This option is typically used in startup scripts which could limit the time <code class="docutils literal notranslate"><span class="pre">DFIR-Orc.exe</span></code> is allowed to run.</p>
</section>
<section id="wmi-option">
<h3><code class="docutils literal notranslate"><span class="pre">-WMI</span></code> Option<a class="headerlink" href="#wmi-option" title="Permalink to this heading">¶</a></h3>
<p>With this option, the mothership executes the command engine (i.e. WolfLauncher) using WMI (the <code class="docutils literal notranslate"><span class="pre">Win32_Process::Create</span></code> method).</p>
</section>
<section id="preservejob-option">
<h3><code class="docutils literal notranslate"><span class="pre">-PreserveJob</span></code> Option<a class="headerlink" href="#preservejob-option" title="Permalink to this heading">¶</a></h3>
<p>With this option, the mothership <strong>does not</strong> alter the job under which it executes.
By default, the mothership attempts to modify the current job (if needed, typically to allow JOB_OBJECT_LIMIT_BREAKAWAY_OK).</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Using this option may lead to a failure in WolfLauncher command engine if BreakAwayFromJob is not allowed. See <a class="reference internal" href="platforms.html"><span class="doc">Requirements</span></a> for more details.</p>
</div>
</section>
</section>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" >
<a href="wolf_config.html" title="WolfLauncher Configuration File"
>next</a>
<li class="right" >
<a href="resources.html" title="Referencing Resources in Configurations"
>previous</a>
|</li>
<li class="nav-item nav-item-0"><a href="index.html">DFIR ORC documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="configuration.html" >Configuration</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2019, ANSSI. The contents of this documentation is available under the Open License version 2.0 as published by Etalab (French task force for Open Data). The name DFIR ORC and the associated logo belong to ANSSI, no use is permitted without its express approval. Le contenu de cette documentation est disponible sous license Open License version 2.0 telle que publiée par Etalab (organisation francaise pour Open Data). Le nom DFIR ORC et le logo associé appartiennent à l'ANSSI, tout usage doit être expressément autorisé par l'ANSSI..
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 5.3.0.Theme is <a href="http://github.com/vimalkvn/solar-theme">Solar</a>
</div>
<script type="text/javascript">
$(document).ready(function() {
$(".toggle > *").hide();
$(".toggle .header").show();
$(".toggle .header").click(function() {
$(this).parent().children().not(".header").toggle(400);
$(this).parent().children(".header").toggleClass("open");
})
});
</script>
</body>
</html>