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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Copyright (c) 2019 Joost van Baal-Ilić <joostvb-uruk@mdcc.cx> -->
<head>
<meta name="keywords" content="manual">
<style type="text/css">
/* START aephea.base.css */
body
{ text-align: justify;
margin-left: 0%;
margin-right: 0%;
}
a:link { text-decoration: none; }
a:active { text-decoration: none; }
a:visited { text-decoration: none; }
a:link { color: #1111aa; }
a:active { color: #1111aa; }
a:visited { color: #111166; }
a.local:link { color: #11aa11; }
a.local:active { color: #11aa11; }
a.local:visited { color: #116611; }
a.intern:link { color: #1111aa; }
a.intern:active { color: #1111aa; }
a.intern:visited { color: #111166; }
a.extern:link { color: #aa1111; }
a.extern:active { color: #aa1111; }
a.extern:visited { color: #661111; }
a.quiet:link { color: black; }
a.quiet:active { color: black; }
a.quiet:visited { color: black; }
div.verbatim
{ font-family: monospace;
margin-top: 1em;
margin-bottom: 1em;
font-size: 10pt;
margin-left: 2em;
white-space: pre;
}
div.indent
{ margin-left: 8%;
margin-right: 0%;
}
.right { text-align: right; }
.left { text-align: left; }
.nowrap { white-space: nowrap; }
.item_leader
{ position: relative;
margin-left: 8%;
}
.item_compact { position: absolute; vertical-align: baseline; }
.item_cascade { position: relative; }
.item_leftalign { text-align: left; }
.item_rightalign
{ width: 2em;
text-align: right;
}
.item_compact .item_rightalign
{ position: absolute;
width: 52em;
right: -2em;
text-align: right;
}
.item_text
{ position: relative;
margin-left: 3em;
}
.smallcaps { font-size: smaller; text-transform: uppercase }
/* END aephea.base.css */
body { font-family: "Garamond", "Gill Sans", "Verdana", sans-serif; }
body
{ text-align: justify;
margin-left: 8%;
margin-right: 8%;
}
</style>
<title>urukctl</title>
</head>
<body>
<p style="text-align:right">
21 јан 2019
<a class="local" href="urukctl.ps"><b>urukctl</b></a>
20190121
</p>
<div class=" itemize " style="margin-top:1em; font-size:100%">
<div class=" item_compact"><div class=" item_rightalign nowrap " style="right:-3em">1.</div></div>
<div class=" item_text " style="margin-left:4em">
<a class="intern" href="#name">NAME</a>
</div>
<div class=" item_compact"><div class=" item_rightalign nowrap " style="right:-3em">2.</div></div>
<div class=" item_text " style="margin-left:4em">
<a class="intern" href="#synopsis">SYNOPSIS</a>
</div>
<div class=" item_compact"><div class=" item_rightalign nowrap " style="right:-3em">3.</div></div>
<div class=" item_text " style="margin-left:4em">
<a class="intern" href="#description">DESCRIPTION</a>
</div>
<div class=" item_compact"><div class=" item_rightalign nowrap " style="right:-3em">4.</div></div>
<div class=" item_text " style="margin-left:4em">
<a class="intern" href="#see also">SEE ALSO</a>
</div>
<div class=" item_compact"><div class=" item_rightalign nowrap " style="right:-3em">5.</div></div>
<div class=" item_text " style="margin-left:4em">
<a class="intern" href="#copyright">COPYRIGHT</a>
</div>
<div class=" item_compact"><div class=" item_rightalign nowrap " style="right:-3em">6.</div></div>
<div class=" item_text " style="margin-left:4em">
<a class="intern" href="#author">AUTHOR</a>
</div>
</div>
<a name="name"></a>
<h2>NAME</h2>
<p style="margin-bottom:0" class="asd_par">
urukctl — uruk control script</p>
<a name="synopsis"></a>
<h2>SYNOPSIS</h2>
<b>urukctl</b> <i>command</i> <b>[</b><i>argument</i><b>]</b>
<a name="description"></a>
<h2>DESCRIPTION</h2>
<p style="margin-bottom:0" class="asd_par">
<b>urukctl</b> is the user interface for the uruk system. It is used to create or
change saved iptables rulesets, to change the current loaded rulesets and to
report on uruk's status.
</p> <p style="margin-bottom:0" class="asd_par">
See <a class="local sibling" href="uruk.html">uruk(8)</a> for information on how to get started with the Uruk
system, and for a tutorial. This manpage gives just the details on <b>urukctl</b>.
</p> <p style="margin-bottom:0" class="asd_par">
The <b>urukctl</b> script calls <b>uruk</b> to process /etc/uruk/rc. (The uruk init script
calls <b>urukctl</b>.)
</p> <p style="margin-bottom:0" class="asd_par">
These 4 ruleset pairs (for both IPv4 and IPv6) exist in a system using uruk:
<div class=" itemize " style="margin-top:1em; font-size:100%">
<div class=" item_cascade"><div class=" item_leftalign " ><span class="itembullet">•</span></div></div>
<div class=" item_text " style="margin-left:2em">
the ruleset as expressed in the uruk configuration /etc/uruk/rc,
</div>
<div class=" item_cascade"><div class=" item_leftalign " ><span class="itembullet">•</span></div></div>
<div class=" item_text " style="margin-left:2em">
the 2 saved rulesets in <tt>/var/lib/{iptables,ip6tables}/{active,inactive}</tt>
</div>
<div class=" item_cascade"><div class=" item_leftalign " ><span class="itembullet">•</span></div></div>
<div class=" item_text " style="margin-left:2em">
the ruleset as currently loaded in the running kernel
</div>
<div class=" item_cascade"><div class=" item_leftalign " ><span class="itembullet">•</span></div></div>
<div class=" item_text " style="margin-left:2em">
optional: more rulesets saved in <tt>/var/lib/{iptables,ip6tables}</tt>
</div>
</div>
</p>
<p style="margin-bottom:0"><b>arguments</b><br>
<b>urukctl</b> should be called as either <tt>urukctl</tt> <i>argument</i> or
<tt>urukctl</tt> <i>argument</i> <i>option</i>. Possible values are:
<div class=" itemize " style="margin-top:1em; font-size:100%">
<div class=" item_cascade"><div class=" item_leftalign nowrap " ><b>start</b></div></div>
<div class=" item_text " style="margin-left:2em">
<p style="margin-top:0em; margin-bottom:0em">
If not yet done, save current iptables status in "inactive" ruleset.
(Re)build and load the "active" ruleset.
</p>
</div>
<div style="margin-top:0em"> </div><div class=" item_cascade"><div class=" item_leftalign nowrap " ><b>save</b> <i>ruleset</i></div></div>
<div class=" item_text " style="margin-left:2em">
<p style="margin-top:0em; margin-bottom:0em">
Save the current iptables status in given ruleset.
</p>
</div>
<div style="margin-top:0em"> </div><div class=" item_cascade"><div class=" item_leftalign nowrap " ><b>create</b> <<tt>active</tt>|<tt>inactive</tt>></div></div>
<div class=" item_text " style="margin-left:2em">
<p style="margin-top:0em; margin-bottom:0em">
Create an "active" or "inactive" ruleset with sane defaults: "active"
will be based upon the uruk rc file. "inactive" will allow all traffic.
</p>
</div>
<div style="margin-top:0em"> </div><div class=" item_cascade"><div class=" item_leftalign nowrap " ><b>load</b> <i>ruleset</i></div></div>
<div class=" item_text " style="margin-left:2em">
<p style="margin-top:0em; margin-bottom:0em">
Load a saved ruleset
</p>
</div>
<div style="margin-top:0em"> </div><div class=" item_cascade"><div class=" item_leftalign nowrap " ><b>reload</b></div></div>
<div class=" item_text " style="margin-left:2em">
<p style="margin-top:0em; margin-bottom:0em">
(Re)build and load the "active" ruleset, without temporarily clearing the
current iptables status.
</p>
</div>
<div style="margin-top:0em"> </div><div class=" item_cascade"><div class=" item_leftalign nowrap " ><b>force-reload</b></div></div>
<div class=" item_text " style="margin-left:2em">
<p style="margin-top:0em; margin-bottom:0em">
(Re)build and load the "active" ruleset, in case uruk is running.
</p>
</div>
<div style="margin-top:0em"> </div><div class=" item_cascade"><div class=" item_leftalign nowrap " ><b>stop</b></div></div>
<div class=" item_text " style="margin-left:2em">
<p style="margin-top:0em; margin-bottom:0em">
Load the "inactive" ruleset.
</p>
</div>
<div style="margin-top:0em"> </div><div class=" item_cascade"><div class=" item_leftalign nowrap " ><b>restart</b></div></div>
<div class=" item_text " style="margin-left:2em">
<p style="margin-top:0em; margin-bottom:0em">
Perform stop-actions followed by start-actions.
</p>
</div>
<div style="margin-top:0em"> </div><div class=" item_cascade"><div class=" item_leftalign nowrap " ><b>status</b></div></div>
<div class=" item_text " style="margin-left:2em">
<p style="margin-top:0em; margin-bottom:0em">
Print the current status of the service: show which ruleset is loaded, and
wether uruk is "running".
</p>
</div>
<div style="margin-top:0em"> </div><div class=" item_cascade"><div class=" item_leftalign nowrap " ><b>clear</b></div></div>
<div class=" item_text " style="margin-left:2em">
<p style="margin-top:0em; margin-bottom:0em">
Remove all rules and user-defined chains, set default policy to ACCEPT.
</p>
</div>
<div style="margin-top:0em"> </div><div class=" item_cascade"><div class=" item_leftalign nowrap " ><b>halt</b></div></div>
<div class=" item_text " style="margin-left:2em">
<p style="margin-top:0em; margin-bottom:0em">
Remove all rules and user-defined chains, set default policy to DROP.
</p>
</div>
<div style="margin-top:0em"> </div><div class=" item_cascade"><div class=" item_leftalign nowrap " ><b>flush</b></div></div>
<div class=" item_text " style="margin-left:2em">
<p style="margin-top:0em; margin-bottom:0em">
Flush all rules from the current iptables status.
</p>
</div>
</div>
</p>
<p style="margin-bottom:0"><b>configuration</b><br>
<b>urukctl</b> uses the file /etc/default/uruk (on Debian, Ubuntu and related
systems) or /etc/sysconfig/uruk (on Red Hat, Fedora and related systems) for
configuration. Variables used in this file are:
<div class=" itemize " style="margin-top:1em; font-size:100%">
<div class=" item_cascade"><div class=" item_leftalign nowrap " >enable_uruk_check</div></div>
<div class=" item_text " style="margin-left:2em">
<p style="margin-top:0em; margin-bottom:0em">wether to check for existence and sanity of uruk rc file; set to false if
you don't like this, e.g. when using the uruk initscript for managing saved
rulesets only (i.e. not for calling uruk or uruk-save).</p>
</div>
<div style="margin-top:0em"> </div><div class=" item_cascade"><div class=" item_leftalign nowrap " >enable_ipv6</div></div>
<div class=" item_text " style="margin-left:2em">
<p style="margin-top:0em; margin-bottom:0em">set to false to disable IPv6 support. Set to <tt>$(enable-ipv6)</tt> to
dynamically decide wether to filter IPv6 traffic.</p>
</div>
<div style="margin-top:0em"> </div><div class=" item_cascade"><div class=" item_leftalign nowrap " >enable_uruk_save</div></div>
<div class=" item_text " style="margin-left:2em">
<p style="margin-top:0em; margin-bottom:0em">enable calling the unstable uruk-save script.</p>
</div>
<div style="margin-top:0em"> </div><div class=" item_cascade"><div class=" item_leftalign nowrap " >enable_autosave</div></div>
<div class=" item_text " style="margin-left:2em">
<p style="margin-top:0em; margin-bottom:0em">set to "false" to disable autosaving the active ruleset when going from
start to stop.</p>
</div>
<div style="margin-top:0em"> </div><div class=" item_cascade"><div class=" item_leftalign nowrap " >enable_save_counters</div></div>
<div class=" item_text " style="margin-left:2em">
<p style="margin-top:0em; margin-bottom:0em">set to "false" to disable saving table counters with rulesets.</p>
</div>
</div>
</p>
<a name="see also"></a>
<h2>SEE ALSO</h2>
<a class="local sibling" href="uruk.html">uruk(8)</a>, <a class="local sibling" href="uruk-rc.html">uruk-rc(5)</a>,
<a class="local sibling" href="uruk-save.html">uruk-save(8)</a>. The Uruk homepage is at
<a class="extern" href="http://mdcc.cx/uruk/">http://mdcc.cx/uruk/</a> .
<p style="margin-bottom:0" class="asd_par">
<b>iptables(8)</b>, <b>iptables-save(8)</b>,
<b>iptables-restore(8)</b>,
<b>ip6tables(8)</b>, <b>ip6tables-save(8)</b>,
<b>ip6tables-restore(8)</b>, <a class="extern" href="http://www.netfilter.org/">http://www.netfilter.org/</a>
</p> <p style="margin-bottom:0" class="asd_par">
<b>interfaces(5)</b>, <a class="extern" href="http://packages.debian.org/ifupdown">http://packages.debian.org/ifupdown</a>.
</p>
<a name="copyright"></a>
<h2>COPYRIGHT</h2>
Copyright (C) 2013 Joost van Baal-Ilić <joostvb-uruk@mdcc.cx>
<p style="margin-bottom:0" class="asd_par">
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
</p> <p style="margin-bottom:0" class="asd_par">
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
</p> <p style="margin-bottom:0" class="asd_par">
You should have received a copy of the GNU General Public License along
with this program. If not, see <a class="extern" href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>.
</p>
<a name="author"></a>
<h2>AUTHOR</h2>
Joost van Baal-Ilić <joostvb-uruk@mdcc.cx>
</body>
</html>
|
