-
Notifications
You must be signed in to change notification settings - Fork 0
/
ipset.py
277 lines (229 loc) · 8.15 KB
/
ipset.py
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
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
from subprocess import run, PIPE, TimeoutExpired
from xmltodict import parse as parsexml
from log import logger
# timeout
# errorcode
class IpsetError(RuntimeError):
"""ipset returned an error"""
def _run_cmd(command, args=[]):
"""
Helper function to help calling and decoding ipset output
:param command: command to run
:param args: list of additional arguments
:return: tuple (bool, dict, str), representing command success, parsed output, and raw error output
"""
logger.debug("Running ipset %s -output xml %s", " ".join(command), " ".join(args))
result = run(["ipset", command, "-output", "xml"] + args, stdout=PIPE, stderr=PIPE, timeout=2)
success = result.returncode == 0
out = result.stdout.decode("UTF-8")
err = result.stderr.decode("UTF-8")
if out:
return (success, parsexml(out), err or None)
else:
return (success, None, err or None)
class Ipset:
def __init__(self, name):
"""
Instantiate this class, but actually does nothing.
:param name: name of the set.
"""
self.name = name
logger.info("Initialized ipset with name %s", name)
def create(self, typ, timeout=None, counters=True, skbinfo=True, comment=False, exist=True, **kwargs):
"""
Create the set with given configuration options. Additional options can be given by kwargs.
"""
args = [self.name, typ]
if timeout:
args += ["timeout", timeout]
if counters:
args += ["counters"]
if comment:
args += ["comment"]
if skbinfo:
args += ["skbinfo"]
if exist:
args += ["-exist"]
for k,v in [(k, kwargs[k]) for k in kwargs]:
if type(v) == bool or v == None:
if v:
args += [k]
else:
args += [k, v]
success, _, err = _run_cmd("create", args)
if not success:
raise IpsetError(err)
logger.debug("ipset successfully initialized")
def destroy(self):
"""
Destroy the set.
"""
success, _, err = _run_cmd("destroy", [self.name])
if not success:
raise IpsetError(err)
logger.info("ipset successfully destroyed")
def add(self, entry, exist=True, nomatch=False):
"""
Add entry to the set.
:param entry: either a raw value such as an ip, or an Entry allowing to give additional properties such as comment or skb values.
:param exist: don't fail if entry already exists.
:param nomatch: see ipset(8).
"""
if type(entry) is Entry:
args = [self.name] + entry.to_cmd()
else:
args = [self.name, entry]
if nomatch:
args += ["nomatch"]
if exist:
args += ["-exist"]
success, _, err = _run_cmd("add", args)
if not success:
raise IpsetError(err)
logger.debug("added entry %s", " ".join(entry.to_cmd()))
def delete(self, entry, exist=True):
"""
Delete entry from the set.
:param entry: either a raw value such as an ip, or an Entry.
:param exist: don't fail if entry does not exist.
"""
if type(entry) is Entry:
args = [self.name, entry.elem]
else:
args = [self.name, entry]
if exist:
args += ["-exist"]
success, _, err = _run_cmd("del", args)
if not success:
raise IpsetError(err)
def test(self, entry):
"""
Test if entry exist in set.
:param entry: either a raw value such as an ip, or an Entry.
:retur: bool was the entry found.
"""
if type(entry) is Entry:
args = [entry.elem]
else:
args = [entry]
success, _, err = _run_cmd("test", args)
if success:
return True
if "is NOT in set" in err:
return False
raise IpsetError(err)
def list(self):
"""
List entries in set.
:return: Set instance containing datas about the ipset and it's content.
"""
success, res, err = _run_cmd("list", [self.name])
if not success:
raise IpsetError(err)
return Set.from_dict(res["ipsets"]["ipset"])
def flush(self):
"""
Flush all entries from the set.
"""
success, _, err = _run_cmd("flush", [self.name])
if not success:
raise IpsetError(err)
def rename(self, name):
"""
Rename the set.
:param name: the new name.
"""
success, _, err = _run_cmd("rename", [self.name, name])
if not success:
raise IpsetError(err)
self.name = name
def swap(self, other):
"""
Swap two sets.
They must be compatible for the operation to success.
:param other: Ipset, the other set to swap with.
"""
success, _, err = _run_cmd("swap", [self.name, other.name])
if not success:
raise IpsetError(err)
self.name,other.name = other.name,self.name
def real(self):
"""
Is this a real ipset or a mock?
:return: True
"""
return True
class Set:
"""
A dataclass representing the state of an ipset at a given time.
"""
def __init__(self, name, typ, header, entries):
self.name = name # string
self.type = typ # string
self.header = header # dict
self.entries = entries # list of entries
def from_dict(data):
"""
Deserialize itself from ipset output
"""
if data["members"] is None:
entries = []
elif type(data["members"]["member"]) is list:
entries = [Entry(**e) for e in data["members"]["member"]]
else:
entries = [Entry(**data["members"]["member"])]
return Set(data["@name"], data["type"], dict(data["header"]), entries)
class Entry:
"""
A dataclass representing a single (to be or existing) entry in an ipset.
"""
def __init__(self, elem, timeout=None, packets=None, bytes=None, comment=None, skbmark=None, skbprio=None, skbqueue=None):
self.elem = elem
self.comment = comment.replace('"', '')
self.timeout = int(timeout) if timeout is not None else None
self.packets = int(packets) if packets is not None else None
self.bytes = int(bytes) if bytes is not None else None
self.skbqueue = int(skbqueue) if skbqueue is not None else None
if skbmark is None:
self.skbmark = None
elif type(skbmark) is int:
self.skbmark = (skbmark, 2**32-1)
elif type(skbmark) is tuple:
self.skbmark = skbmark
else:
if "/" in skbmark:
mark,mask = skbmark.split("/")
self.skbmark = (int(mark, 16), int(mask,16))
else:
self.skbmark = (int(skbmark, 16), 2**32-1)
if skbprio is None:
self.skbprio = None
elif type(skbprio) is tuple:
self.skbprio = skbprio
else:
maj,min = skbprio.split(":")
self.skbprio = (int(maj), int(min))
def to_cmd(self):
"""
Serialize itself to the parameters that would add it to an ipset.
:return: list of strings, the arguments that would add it to a set.
"""
res = [self.elem]
if self.comment is not None:
res += ["comment", self.comment]
if self.timeout is not None:
res += ["timeout", str(self.timeout)]
if self.packets is not None:
res += ["packets", str(self.packets)]
if self.bytes is not None:
res += ["bytes", str(self.bytes)]
if self.skbqueue is not None:
res += ["skbqueue", str(self.skbqueue)]
if self.skbmark is not None:
res += ["skbmark", '0x{:x}/0x{:x}'.format(*self.skbmark)]
if self.skbprio is not None:
res += ["skbprio", '{}:{}'.format(*self.skbprio)]
logger.debug("Generated command '%s' from ipset entry", res)
return res