-
Notifications
You must be signed in to change notification settings - Fork 0
/
xmlcheck.html
477 lines (454 loc) · 19.4 KB
/
xmlcheck.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
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>xmlcheck — WatchGuard Toolbox Project</title>
<link rel="stylesheet" href="_static/cloud.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="./" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/cloud.base.js"></script>
<script type="text/javascript" src="_static/cloud.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="watchguard-letsencrypt-deploy" href="watchguard-letsencrypt-deploy.html" />
<link rel="prev" title="WatchGuard Toolbox Project" href="index.html" />
<meta name="viewport" content="width=device-width, initial-scale=1">
</head><body>
<div class="relbar-top">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="watchguard-letsencrypt-deploy.html" title="watchguard-letsencrypt-deploy"
accesskey="N">next</a> </li>
<li class="right" >
<a href="index.html" title="WatchGuard Toolbox Project"
accesskey="P">previous</a> </li>
<li><a href="index.html">WatchGuard Toolbox Project</a> »</li>
</ul>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="xmlcheck">
<h1>xmlcheck<a class="headerlink" href="#xmlcheck" title="Permalink to this headline">¶</a></h1>
<p>WatchGuard policy XML check utility.</p>
<p>xmlcheck is used to find duplicate aliases and services</p>
<p>xmlcheck is part of <a class="reference external" href="https://watchguard-toolbox-project.github.io">WatchGuard Toolbox Project</a></p>
<div class="section" id="installation">
<h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h2>
<div class="section" id="prerequisites">
<h3>Prerequisites<a class="headerlink" href="#prerequisites" title="Permalink to this headline">¶</a></h3>
<p>this php projects needs composer for building the class autoloader and and ensuring the SimpleXML extension is installed.</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>~/xmlcheck$ composer install
Loading composer repositories with package information
Updating dependencies <span class="o">(</span>including require-dev<span class="o">)</span>
Nothing to install or update
Writing lock file
Generating autoload files
~/xmlcheck$
</pre></div>
</div>
</div>
</div>
<div class="section" id="usage">
<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$ ./xmlcheck.php <options> <args>
</pre></div>
</div>
</div>
<div class="section" id="command-summary">
<h2>Command summary<a class="headerlink" href="#command-summary" title="Permalink to this headline">¶</a></h2>
<table class="docutils option-list" frame="void" rules="none">
<col class="option" />
<col class="description" />
<tbody valign="top">
<tr><td class="option-group">
<kbd><span class="option">-h</span>, <span class="option">--help</span></kbd></td>
<td>displays short cli help</td></tr>
<tr><td class="option-group" colspan="2">
<kbd><span class="option">-l</span>, <span class="option">--listaliases</span></kbd></td>
</tr>
<tr><td> </td><td>lists all aliases</td></tr>
<tr><td class="option-group" colspan="2">
<kbd><span class="option">-p</span>, <span class="option">--listpolicies</span></kbd></td>
</tr>
<tr><td> </td><td>lists all policies</td></tr>
<tr><td class="option-group" colspan="2">
<kbd><span class="option">-s</span>, <span class="option">--listservices</span></kbd></td>
</tr>
<tr><td> </td><td>lists all services</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-t</span>, <span class="option">--listtags</span></kbd></td>
<td>lists all tags</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-a</span>, <span class="option">--alias</span></kbd></td>
<td>print alias aliasname</td></tr>
<tr><td class="option-group">
<kbd><span class="option">--simplexmlout</span></kbd></td>
<td>print SimpleXML structure
as read from xmlfile</td></tr>
</tbody>
</table>
</div>
<div class="section" id="listing-aliases">
<h2>Listing aliases<a class="headerlink" href="#listing-aliases" title="Permalink to this headline">¶</a></h2>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$ ./xmlcheck.php -i <inputxml> -l
$ ./xmlcheck.php -i <inputxml> --listaliases
</pre></div>
</div>
<div class="section" id="description">
<h3>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h3>
<p>List all aliases from the xml file.</p>
</div>
<div class="section" id="options">
<h3>Options<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h3>
<blockquote>
<div><table class="docutils option-list" frame="void" rules="none">
<col class="option" />
<col class="description" />
<tbody valign="top">
<tr><td class="option-group">
<kbd><span class="option">-v</span>, <span class="option">--verbose</span></kbd></td>
<td>verbose output</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-u</span>, <span class="option">--unused</span></kbd></td>
<td>show only unused objects</td></tr>
</tbody>
</table>
</div></blockquote>
</div>
<div class="section" id="arguments">
<h3>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline">¶</a></h3>
<blockquote>
<div><table class="docutils option-list" frame="void" rules="none">
<col class="option" />
<col class="description" />
<tbody valign="top">
<tr><td class="option-group" colspan="2">
<kbd><span class="option">-i</span>, <span class="option">--infile <var>filename</var></span></kbd></td>
</tr>
<tr><td> </td><td>inputfile filename (mandatory)</td></tr>
</tbody>
</table>
</div></blockquote>
</div>
</div>
<div class="section" id="display-single-alias">
<h2>Display single alias<a class="headerlink" href="#display-single-alias" title="Permalink to this headline">¶</a></h2>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$ ./xmlcheck.php -i <inputxml> -a <aliasname>
</pre></div>
</div>
<div class="section" id="id1">
<h3>Description<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3>
<p>Displays one single alias.</p>
</div>
<div class="section" id="id2">
<h3>Options<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h3>
<blockquote>
<div><table class="docutils option-list" frame="void" rules="none">
<col class="option" />
<col class="description" />
<tbody valign="top">
<tr><td class="option-group">
<kbd><span class="option">-v</span>, <span class="option">--verbose</span></kbd></td>
<td>verbose output</td></tr>
</tbody>
</table>
</div></blockquote>
</div>
<div class="section" id="id3">
<h3>Arguments<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3>
<blockquote>
<div><table class="docutils option-list" frame="void" rules="none">
<col class="option" />
<col class="description" />
<tbody valign="top">
<tr><td class="option-group" colspan="2">
<kbd><span class="option">-i</span>, <span class="option">--infile <var>filename</var></span></kbd></td>
</tr>
<tr><td> </td><td>inputfile filename (mandatory)</td></tr>
</tbody>
</table>
</div></blockquote>
</div>
</div>
<div class="section" id="listing-services">
<h2>Listing services<a class="headerlink" href="#listing-services" title="Permalink to this headline">¶</a></h2>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$ ./xmlcheck.php -i <inputxml> -s
$ ./xmlcheck.php -i <inputxml> --listservices
</pre></div>
</div>
<div class="section" id="id4">
<h3>Description<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h3>
<p>List all services from the xml file.</p>
</div>
<div class="section" id="id5">
<h3>Options<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h3>
<blockquote>
<div><table class="docutils option-list" frame="void" rules="none">
<col class="option" />
<col class="description" />
<tbody valign="top">
<tr><td class="option-group">
<kbd><span class="option">-v</span>, <span class="option">--verbose</span></kbd></td>
<td>verbose output</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-u</span>, <span class="option">--unused</span></kbd></td>
<td>show only unused objects</td></tr>
</tbody>
</table>
</div></blockquote>
</div>
<div class="section" id="id6">
<h3>Arguments<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h3>
<blockquote>
<div><table class="docutils option-list" frame="void" rules="none">
<col class="option" />
<col class="description" />
<tbody valign="top">
<tr><td class="option-group" colspan="2">
<kbd><span class="option">-i</span>, <span class="option">--infile <var>filename</var></span></kbd></td>
</tr>
<tr><td> </td><td>inputfile filename (mandatory)</td></tr>
</tbody>
</table>
</div></blockquote>
</div>
</div>
<div class="section" id="listing-tags">
<h2>Listing tags<a class="headerlink" href="#listing-tags" title="Permalink to this headline">¶</a></h2>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$ ./xmlcheck.php -i <inputxml> -t
$ ./xmlcheck.php -i <inputxml> --listtags
</pre></div>
</div>
<div class="section" id="id7">
<h3>Description<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h3>
<p>List all tags from the xml file.</p>
</div>
<div class="section" id="id8">
<h3>Options<a class="headerlink" href="#id8" title="Permalink to this headline">¶</a></h3>
<blockquote>
<div><table class="docutils option-list" frame="void" rules="none">
<col class="option" />
<col class="description" />
<tbody valign="top">
<tr><td class="option-group">
<kbd><span class="option">-v</span>, <span class="option">--verbose</span></kbd></td>
<td>verbose output</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-u</span>, <span class="option">--unused</span></kbd></td>
<td>show only unused objects</td></tr>
</tbody>
</table>
</div></blockquote>
</div>
<div class="section" id="id9">
<h3>Arguments<a class="headerlink" href="#id9" title="Permalink to this headline">¶</a></h3>
<blockquote>
<div><table class="docutils option-list" frame="void" rules="none">
<col class="option" />
<col class="description" />
<tbody valign="top">
<tr><td class="option-group" colspan="2">
<kbd><span class="option">-i</span>, <span class="option">--infile <var>filename</var></span></kbd></td>
</tr>
<tr><td> </td><td>inputfile filename (mandatory)</td></tr>
</tbody>
</table>
</div></blockquote>
</div>
</div>
<div class="section" id="listing-policies">
<h2>Listing policies<a class="headerlink" href="#listing-policies" title="Permalink to this headline">¶</a></h2>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$ ./xmlcheck.php -i <inputxml> -p
$ ./xmlcheck.php -i <inputxml> --listpolicies
</pre></div>
</div>
<div class="section" id="id10">
<h3>Description<a class="headerlink" href="#id10" title="Permalink to this headline">¶</a></h3>
<p>List all policies from the xml file.</p>
</div>
<div class="section" id="id11">
<h3>Options<a class="headerlink" href="#id11" title="Permalink to this headline">¶</a></h3>
<blockquote>
<div><table class="docutils option-list" frame="void" rules="none">
<col class="option" />
<col class="description" />
<tbody valign="top">
<tr><td class="option-group">
<kbd><span class="option">-v</span>, <span class="option">--verbose</span></kbd></td>
<td>verbose output</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-E</span>, <span class="option">--enabled</span></kbd></td>
<td>only show enabled policies (= skip disabled policies)</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-D</span>, <span class="option">--disabled</span></kbd></td>
<td>only show disabled policies (= skip enabled policies)</td></tr>
</tbody>
</table>
</div></blockquote>
</div>
<div class="section" id="id12">
<h3>Arguments<a class="headerlink" href="#id12" title="Permalink to this headline">¶</a></h3>
<blockquote>
<div><table class="docutils option-list" frame="void" rules="none">
<col class="option" />
<col class="description" />
<tbody valign="top">
<tr><td class="option-group" colspan="2">
<kbd><span class="option">-i</span>, <span class="option">--infile <var>filename</var></span></kbd></td>
</tr>
<tr><td> </td><td>inputfile filename (mandatory)</td></tr>
</tbody>
</table>
</div></blockquote>
</div>
</div>
<div class="section" id="api-documentation-download">
<h2>API documentation & download<a class="headerlink" href="#api-documentation-download" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><a class="reference external" href="https://watchguard-toolbox-project.github.io/xmlcheck/api/">phpdoc api documentation</a></li>
<li><a class="reference external" href="https://github.com/watchguard-toolbox-project/xmlcheck/">github repository</a></li>
</ul>
</div>
<div class="section" id="changelog">
<h2>Changelog<a class="headerlink" href="#changelog" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li>2020-07-27 - v0.4 - added -E and -D for enabled/disabled policies</li>
<li>2019-09-11 - v0.3 - fixed “–listtags –unused” - now correct if more than one tag per policy</li>
<li>2019-09-06 v0.2 - added –listtags</li>
<li>2019-08-24 v0.1 - initial release</li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper"><div class="sphinx-toc sphinxlocaltoc">
<h3><a href="index.html">Page contents</a></h3>
<ul>
<li><a class="reference internal" href="#">xmlcheck</a><ul>
<li><a class="reference internal" href="#installation">Installation</a><ul>
<li><a class="reference internal" href="#prerequisites">Prerequisites</a></li>
</ul>
</li>
<li><a class="reference internal" href="#usage">Usage</a></li>
<li><a class="reference internal" href="#command-summary">Command summary</a></li>
<li><a class="reference internal" href="#listing-aliases">Listing aliases</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#options">Options</a></li>
<li><a class="reference internal" href="#arguments">Arguments</a></li>
</ul>
</li>
<li><a class="reference internal" href="#display-single-alias">Display single alias</a><ul>
<li><a class="reference internal" href="#id1">Description</a></li>
<li><a class="reference internal" href="#id2">Options</a></li>
<li><a class="reference internal" href="#id3">Arguments</a></li>
</ul>
</li>
<li><a class="reference internal" href="#listing-services">Listing services</a><ul>
<li><a class="reference internal" href="#id4">Description</a></li>
<li><a class="reference internal" href="#id5">Options</a></li>
<li><a class="reference internal" href="#id6">Arguments</a></li>
</ul>
</li>
<li><a class="reference internal" href="#listing-tags">Listing tags</a><ul>
<li><a class="reference internal" href="#id7">Description</a></li>
<li><a class="reference internal" href="#id8">Options</a></li>
<li><a class="reference internal" href="#id9">Arguments</a></li>
</ul>
</li>
<li><a class="reference internal" href="#listing-policies">Listing policies</a><ul>
<li><a class="reference internal" href="#id10">Description</a></li>
<li><a class="reference internal" href="#id11">Options</a></li>
<li><a class="reference internal" href="#id12">Arguments</a></li>
</ul>
</li>
<li><a class="reference internal" href="#api-documentation-download">API documentation & download</a></li>
<li><a class="reference internal" href="#changelog">Changelog</a></li>
</ul>
</li>
</ul>
</div>
<div class="sphinxprev">
<h4>Previous page</h4>
<p class="topless"><a href="index.html"
title="Previous page">← WatchGuard Toolbox Project</a></p>
</div>
<div class="sphinxnext">
<h4>Next page</h4>
<p class="topless"><a href="watchguard-letsencrypt-deploy.html"
title="Next page">→ watchguard-letsencrypt-deploy</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/xmlcheck.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="sidebar-toggle-group no-js">
<button class="sidebar-toggle" id="sidebar-hide" title="Hide the sidebar menu">
«
<span class="show-for-small">hide menu</span>
</button>
<button class="sidebar-toggle" id="sidebar-show" title="Show the sidebar menu">
<span class="show-for-small">menu</span>
<span class="hide-for-small">sidebar</span>
»
</button>
</div>
<div class="clearer"></div>
</div>
<div class="relbar-bottom">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="watchguard-letsencrypt-deploy.html" title="watchguard-letsencrypt-deploy"
>next</a> </li>
<li class="right" >
<a href="index.html" title="WatchGuard Toolbox Project"
>previous</a> </li>
<li><a href="index.html">WatchGuard Toolbox Project</a> »</li>
</ul>
</div>
</div>
<div class="footer" role="contentinfo">
© Copyright 2019-2024, WatchGuard Toolbox Project.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
</div>
<!-- cloud_sptheme 1.4 -->
</body>
</html>