-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathconfiguring_console_output.html
292 lines (269 loc) · 21.4 KB
/
configuring_console_output.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
<!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>Configuring Console Output, Logging — 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="Configuring Process Priority" href="configuring_process.html" />
<link rel="prev" title="Configuring Attributes of ntfs_find and ntfs_exclude Elements" href="configuring_ntfs_opt.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="configuring_process.html" title="Configuring Process Priority"
accesskey="N">next</a>
<li class="right" >
<a href="configuring_ntfs_opt.html" title="Configuring Attributes of ntfs_find and ntfs_exclude Elements"
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="embedded_tool_suite.html" >Embedded Tool Suite</a> »</li>
<li class="nav-item nav-item-2"><a href="info_tools.html" accesskey="U">Common Options & Properties</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"><a class="reference internal" href="configuration.html">Configuration</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="embedded_tool_suite.html">Embedded Tool Suite</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="info_tools.html">Common Options & Properties</a></li>
<li class="toctree-l2"><a class="reference internal" href="FatInfo.html">FatInfo</a></li>
<li class="toctree-l2"><a class="reference internal" href="FastFind.html">FastFind</a></li>
<li class="toctree-l2"><a class="reference internal" href="GetThis.html">GetThis</a></li>
<li class="toctree-l2"><a class="reference internal" href="GetSamples.html">GetSamples</a></li>
<li class="toctree-l2"><a class="reference internal" href="GetSectors.html">GetSectors</a></li>
<li class="toctree-l2"><a class="reference internal" href="NTFSInfo.html">NTFSInfo</a></li>
<li class="toctree-l2"><a class="reference internal" href="NTFSUtil.html">NTFSUtil</a></li>
<li class="toctree-l2"><a class="reference internal" href="ObjInfo.html">ObjInfo</a></li>
<li class="toctree-l2"><a class="reference internal" href="RegInfo.html">RegInfo</a></li>
<li class="toctree-l2"><a class="reference internal" href="USNInfo.html">USNInfo</a></li>
</ul>
</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="configuring-console-output-logging">
<h1>Configuring Console Output, Logging<a class="headerlink" href="#configuring-console-output-logging" title="Permalink to this heading">¶</a></h1>
<p>Multiple log output are available and they can be use simultaneously. Existing output are console, file and limited syslog.</p>
<p><strong>Syslog use is currently limited to WolfLauncher high level logs</strong>.</p>
<section id="usage">
<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this heading">¶</a></h2>
<p>In XML configuration file, the console output and the file output are configured within the <code class="docutils literal notranslate"><span class="pre">log</span></code> element.</p>
</section>
<section id="log-element">
<h2><code class="docutils literal notranslate"><span class="pre">log</span></code> Element<a class="headerlink" href="#log-element" title="Permalink to this heading">¶</a></h2>
<p><em>optional=yes, default=N/A</em>, <a class="reference external" href="#wolf-element">parent element: wolf</a></p>
<p>The log element can be used to create an optional log file of DFIR ORC execution. This file will be uploaded if an <upload/> element is specified in a <a class="reference internal" href="orc_local_config.html"><span class="doc">DFIR ORC local configuration file</span></a>.</p>
<p>The log message are passing through “sinks” like ‘console’ or ‘file’. To configure log output a sink must be specified.</p>
<section id="console-sink-element-log-console-option">
<h3><code class="docutils literal notranslate"><span class="pre">Console</span></code> sink element, <code class="docutils literal notranslate"><span class="pre">/log:console,...</span></code> Option<a class="headerlink" href="#console-sink-element-log-console-option" title="Permalink to this heading">¶</a></h3>
<p><em>optional=yes, default=N/A</em>, <cite>parent element: log</cite></p>
<section id="level-attribute-log-console-level-level-option">
<h4><code class="docutils literal notranslate"><span class="pre">level</span></code> Attribute, <code class="docutils literal notranslate"><span class="pre">/log:console,level=<Level>,...</span></code> Option<a class="headerlink" href="#level-attribute-log-console-level-level-option" title="Permalink to this heading">¶</a></h4>
<p><em>optional=yes, default=critical</em>, <cite>parent element: console</cite></p>
<p>Log level is one of ‘trace’, ‘debug’, ‘info’ ‘error’, ‘warning’, ‘critical’.</p>
</section>
<section id="backtrace-attribute-log-console-backtrace-level-option">
<h4><code class="docutils literal notranslate"><span class="pre">backtrace</span></code> Attribute, <code class="docutils literal notranslate"><span class="pre">/log:console,backtrace=<Level>,...</span></code> Option<a class="headerlink" href="#backtrace-attribute-log-console-backtrace-level-option" title="Permalink to this heading">¶</a></h4>
<p><em>optional=yes, default=off</em>, <cite>parent element: console</cite></p>
<p>Specify a log level which will trigger a log backtrace which will contain logs up to level ‘debug’.</p>
<p>Value is one of ‘trace’, ‘debug’, ‘info’ ‘error’, ‘warning’, ‘critical’, off.</p>
</section>
</section>
<section id="file-sink-element-log-file-option">
<h3><code class="docutils literal notranslate"><span class="pre">File</span></code> sink element, <code class="docutils literal notranslate"><span class="pre">/log:file,...</span></code> Option<a class="headerlink" href="#file-sink-element-log-file-option" title="Permalink to this heading">¶</a></h3>
<p><em>optional=yes, default=N/A</em>, <cite>parent element: log</cite></p>
<p>The logging can be written to the file at the end of the tool execution.
This implies that tool progress cannot be followed from log file using “tail</p>
<section id="level-attribute-log-file-level-level-option">
<h4><code class="docutils literal notranslate"><span class="pre">level</span></code> Attribute, <code class="docutils literal notranslate"><span class="pre">/log:file,level=<Level>,...</span></code> Option<a class="headerlink" href="#level-attribute-log-file-level-level-option" title="Permalink to this heading">¶</a></h4>
<p><em>optional=yes, default=info</em>, <cite>parent element: file</cite></p>
<p>Log level is one of ‘trace’, ‘debug’, ‘info’ ‘error’, ‘warning’, ‘critical’.</p>
</section>
<section id="backtrace-attribute-log-file-backtrace-level-option">
<h4><code class="docutils literal notranslate"><span class="pre">backtrace</span></code> Attribute, <code class="docutils literal notranslate"><span class="pre">/log:file,backtrace=<Level>,...</span></code> Option<a class="headerlink" href="#backtrace-attribute-log-file-backtrace-level-option" title="Permalink to this heading">¶</a></h4>
<p><em>optional=yes, default=error</em>, <cite>parent element: file</cite></p>
<p>Specify a log level which will trigger a log backtrace which will contain logs up to level ‘debug’.</p>
<p>Value is one of ‘trace’, ‘debug’, ‘info’ ‘error’, ‘warning’, ‘critical’, off.</p>
</section>
<section id="output-element-log-file-output-path-option">
<h4><code class="docutils literal notranslate"><span class="pre">output</span></code> Element, <code class="docutils literal notranslate"><span class="pre">/log:file,output=Path>,...</span></code> Option<a class="headerlink" href="#output-element-log-file-output-path-option" title="Permalink to this heading">¶</a></h4>
<p><em>optional=yes, default=N/A</em>, <cite>parent element: file</cite></p>
<p>Path to the log file. Patterns are supported as with archive element (cf <a class="reference external" href="#the-archive-element">archive element</a>).</p>
</section>
</section>
<section id="syslog-sink-element-log-syslog-option">
<h3><code class="docutils literal notranslate"><span class="pre">Syslog</span></code> sink element, <code class="docutils literal notranslate"><span class="pre">/log:syslog,...</span></code> Option<a class="headerlink" href="#syslog-sink-element-log-syslog-option" title="Permalink to this heading">¶</a></h3>
<p><em>optional=yes, default=N/A</em>, <cite>parent element: log</cite></p>
<p>Redirect high level logs to a syslog server.</p>
<p><strong>Currently ‘syslog’ use is restricted to WolfLauncher</strong>.</p>
<section id="level-attribute-log-syslog-level-level-option">
<h4><code class="docutils literal notranslate"><span class="pre">level</span></code> Attribute, <code class="docutils literal notranslate"><span class="pre">/log:syslog,level=<Level>,...</span></code> Option<a class="headerlink" href="#level-attribute-log-syslog-level-level-option" title="Permalink to this heading">¶</a></h4>
<p><em>optional=yes, default=info</em>, <cite>parent element: syslog</cite></p>
<p>Log level is one of ‘trace’, ‘debug’, ‘info’ ‘error’, ‘warning’, ‘critical’.</p>
</section>
<section id="backtrace-attribute-log-syslog-backtrace-level-option">
<h4><code class="docutils literal notranslate"><span class="pre">backtrace</span></code> Attribute, <code class="docutils literal notranslate"><span class="pre">/log:syslog,backtrace=<Level>,...</span></code> Option<a class="headerlink" href="#backtrace-attribute-log-syslog-backtrace-level-option" title="Permalink to this heading">¶</a></h4>
<p><em>optional=yes, default=off</em>, <cite>parent element: syslog</cite></p>
<p>Specify a log level which will trigger a log backtrace which will contain logs up to level ‘debug’.</p>
<p>Value is one of ‘trace’, ‘debug’, ‘info’ ‘error’, ‘warning’, ‘critical’, off.</p>
</section>
<section id="host-attribute-log-syslog-host-ip4-or-ip6-option">
<h4><code class="docutils literal notranslate"><span class="pre">host</span></code> Attribute, <code class="docutils literal notranslate"><span class="pre">/log:syslog,host=<ip4_or_ip6>,...</span></code> Option<a class="headerlink" href="#host-attribute-log-syslog-host-ip4-or-ip6-option" title="Permalink to this heading">¶</a></h4>
<p><em>optional=no, default=N/A</em>, <cite>parent element: syslog</cite></p>
<p>Address of the syslog server</p>
</section>
<section id="port-attribute-log-syslog-port-port-option">
<h4><code class="docutils literal notranslate"><span class="pre">port</span></code> Attribute, <code class="docutils literal notranslate"><span class="pre">/log:syslog,port=<port>,...</span></code> Option<a class="headerlink" href="#port-attribute-log-syslog-port-port-option" title="Permalink to this heading">¶</a></h4>
<p><em>optional=yes, default=514</em>, <cite>parent element: syslog</cite></p>
<p>Port of the syslog server.</p>
</section>
</section>
<section id="example">
<h3>Example<a class="headerlink" href="#example" title="Permalink to this heading">¶</a></h3>
<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt"><log></span>
<span class="w"> </span><span class="nt"><console</span><span class="w"> </span><span class="na">level=</span><span class="s">"critical"</span><span class="w"> </span><span class="na">backtrace=</span><span class="s">"off"</span><span class="nt">></console></span>
<span class="w"> </span><span class="nt"><file</span><span class="w"> </span><span class="na">level=</span><span class="s">"error"</span><span class="w"> </span><span class="na">backtrace=</span><span class="s">"error"</span><span class="nt">></span>
<span class="w"> </span><span class="nt"><output</span><span class="w"> </span><span class="na">disposition=</span><span class="s">"truncate"</span><span class="nt">></span>ORC_{SystemType}_{FullComputerName}_{TimeStamp}.dev.log<span class="nt"></output></span>
<span class="w"> </span><span class="nt"></file></span>
<span class="w"> </span><span class="nt"><syslog></span>
<span class="w"> </span><span class="nt"><host></span>127.0.0.1<span class="nt"></host></span>
<span class="w"> </span><span class="nt"><port></span>514<span class="nt"></port></span>
<span class="w"> </span><span class="nt"></syslog></span>
<span class="nt"></log></span>
</pre></div>
</div>
<div class="highlight-bat notranslate"><div class="highlight"><pre><span></span>dfir-orc.exe \
/log:console,level=critical,backtrace=off \
/log:file,level=debug,backtrace=error,output=<span class="s2">"dfir-orc.log"</span> \
/log:syslog,host=127.0.0.1,port=514 ...
</pre></div>
</div>
<p><a class="reference external" href="#anchor-root">Back to Root</a></p>
</section>
<section id="noconsole-attribute-noconsole-option">
<h3><code class="docutils literal notranslate"><span class="pre">noconsole</span></code> Attribute, <code class="docutils literal notranslate"><span class="pre">/noconsole</span></code> Option<a class="headerlink" href="#noconsole-attribute-noconsole-option" title="Permalink to this heading">¶</a></h3>
<p>This option disabled console output.</p>
<blockquote>
<div><div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt"><logging</span><span class="w"> </span><span class="na">noconsole=</span><span class="s">""</span><span class="nt">/></span>
</pre></div>
</div>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">/</span><span class="n">noconsole</span>
</pre></div>
</div>
</div></blockquote>
</section>
<section id="verbose-attribute-verbose-option">
<h3><code class="docutils literal notranslate"><span class="pre">verbose</span></code> Attribute, <code class="docutils literal notranslate"><span class="pre">/verbose</span></code> Option<a class="headerlink" href="#verbose-attribute-verbose-option" title="Permalink to this heading">¶</a></h3>
<p>Enables verbose output. <strong>XML is deprecated</strong>.</p>
<blockquote>
<div><div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt"><logging</span><span class="w"> </span><span class="na">verbose=</span><span class="s">""</span><span class="nt">/></span>
</pre></div>
</div>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">/</span><span class="n">verbose</span>
</pre></div>
</div>
</div></blockquote>
</section>
<section id="debug-attribute-debug-option">
<h3><code class="docutils literal notranslate"><span class="pre">debug</span></code> Attribute, <code class="docutils literal notranslate"><span class="pre">/debug</span></code> Option<a class="headerlink" href="#debug-attribute-debug-option" title="Permalink to this heading">¶</a></h3>
<p>Enables debug logging for Console and File log output. <strong>XML is deprecated</strong>.</p>
<blockquote>
<div><div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt"><logging</span><span class="w"> </span><span class="na">debug=</span><span class="s">""</span><span class="nt">/></span>
</pre></div>
</div>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">/</span><span class="n">debug</span>
</pre></div>
</div>
</div></blockquote>
<p>Example of debug logging:</p>
<div class="highlight-bat notranslate"><div class="highlight"><pre><span></span>2021-02-08T17:43:41.200Z [I] WolfLauncher v10.1.0-rc3-115-ge4123652(orc.git 66613f2cdbc7fd9241eb9acabfab7a6ac19a242b
</pre></div>
</div>
</section>
</section>
<section id="typical-usage-example">
<h2>Typical Usage Example<a class="headerlink" href="#typical-usage-example" title="Permalink to this heading">¶</a></h2>
<div class="highlight-bat notranslate"><div class="highlight"><pre><span></span>.\DFIR-Orc.exe NTFSInfo /noconsole /debug /log:file,level=error,output=c:\temp\ntfsinfo.log
</pre></div>
</div>
<p>This example does not output anything to the console (quiet mode), log information directly into an attached debugger and create “c:\temp\ntfsinfo.log” containing the console output.</p>
<p>The equivalent XML syntax is:</p>
<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt"><logging</span><span class="w"> </span><span class="na">file=</span><span class="s">"c:\temp\ntfsinfo.log"</span><span class="w"> </span><span class="na">noconsole=</span><span class="s">""</span><span class="w"> </span><span class="na">debug=</span><span class="s">""</span><span class="w"> </span><span class="nt">/></span>
</pre></div>
</div>
</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="configuring_process.html" title="Configuring Process Priority"
>next</a>
<li class="right" >
<a href="configuring_ntfs_opt.html" title="Configuring Attributes of ntfs_find and ntfs_exclude Elements"
>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="embedded_tool_suite.html" >Embedded Tool Suite</a> »</li>
<li class="nav-item nav-item-2"><a href="info_tools.html" >Common Options & Properties</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>