-
Notifications
You must be signed in to change notification settings - Fork 51
/
iptablesprovider.go
401 lines (328 loc) · 9.96 KB
/
iptablesprovider.go
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
package provider
import (
"bytes"
"fmt"
"os/exec"
"regexp"
"strings"
"sync"
"github.com/coreos/go-iptables/iptables"
version "github.com/hashicorp/go-version"
"go.uber.org/zap"
)
// IptablesProvider is an abstraction of all the methods an implementation of userspace
// iptables need to provide.
type IptablesProvider interface {
BaseIPTables
// Commit will commit changes if it is a batch provider.
Commit() error
// RetrieveTable allows a caller to retrieve the final table.
RetrieveTable() map[string]map[string][]string
}
// BaseIPTables is the base interface of iptables functions.
type BaseIPTables interface {
// Append apends a rule to chain of table
Append(table, chain string, rulespec ...string) error
// Insert inserts a rule to a chain of table at the required pos
Insert(table, chain string, pos int, rulespec ...string) error
// Delete deletes a rule of a chain in the given table
Delete(table, chain string, rulespec ...string) error
// ListChains lists all the chains associated with a table
ListChains(table string) ([]string, error)
// ClearChain clears a chain in a table
ClearChain(table, chain string) error
// DeleteChain deletes a chain in the table. There should be no references to this chain
DeleteChain(table, chain string) error
// NewChain creates a new chain
NewChain(table, chain string) error
}
// BatchProvider uses iptables-restore to program ACLs
type BatchProvider struct {
ipt BaseIPTables
// TABLE CHAIN RULES
rules map[string]map[string][]string
batchTables map[string]bool
// Allowing for custom commit functions for testing
commitFunc func(buf *bytes.Buffer) error
sync.Mutex
restoreCmd string
}
const (
restoreCmdV4 = "iptables-restore"
restoreCmdV6 = "ip6tables-restore"
)
// NewGoIPTablesProviderV4 returns an IptablesProvider interface based on the go-iptables
// external package.
func NewGoIPTablesProviderV4(batchTables []string) (*BatchProvider, error) {
ipt, err := iptables.New()
if err != nil {
return nil, err
}
batchTablesMap := map[string]bool{}
// We will only support the batch method if there is iptables-restore and iptables
// version 1.6.2 or better. Otherwise, we fall back to classic iptables instructions.
// This will allow us to support older kernel versions.
if restoreHasWait(restoreCmdV4) {
for _, t := range batchTables {
batchTablesMap[t] = true
}
}
b := &BatchProvider{
ipt: ipt,
rules: map[string]map[string][]string{},
batchTables: batchTablesMap,
restoreCmd: restoreCmdV4,
}
b.commitFunc = b.restore
return b, nil
}
// NewGoIPTablesProviderV6 returns an IptablesProvider interface based on the go-iptables
// external package.
func NewGoIPTablesProviderV6(batchTables []string) (*BatchProvider, error) {
ipt, err := iptables.NewWithProtocol(iptables.ProtocolIPv6)
if err != nil {
return nil, err
}
batchTablesMap := map[string]bool{}
// We will only support the batch method if there is iptables-restore and iptables
// version 1.6.2 or better. Otherwise, we fall back to classic iptables instructions.
// This will allow us to support older kernel versions.
if restoreHasWait(restoreCmdV6) {
for _, t := range batchTables {
batchTablesMap[t] = true
}
}
b := &BatchProvider{
ipt: ipt,
rules: map[string]map[string][]string{},
batchTables: batchTablesMap,
restoreCmd: restoreCmdV6,
}
b.commitFunc = b.restore
return b, nil
}
// NewCustomBatchProvider is a custom batch provider wher the downstream
// iptables utility is provided by the caller. Very useful for testing
// the ACL functions with a mock.
func NewCustomBatchProvider(ipt BaseIPTables, commit func(buf *bytes.Buffer) error, batchTables []string) *BatchProvider {
batchTablesMap := map[string]bool{}
for _, t := range batchTables {
batchTablesMap[t] = true
}
return &BatchProvider{
ipt: ipt,
rules: map[string]map[string][]string{},
batchTables: batchTablesMap,
commitFunc: commit,
}
}
// Append will append the provided rule to the local cache or call
// directly the iptables command depending on the table.
func (b *BatchProvider) Append(table, chain string, rulespec ...string) error {
b.Lock()
defer b.Unlock()
if _, ok := b.batchTables[table]; !ok {
return b.ipt.Append(table, chain, rulespec...)
}
if _, ok := b.rules[table]; !ok {
b.rules[table] = map[string][]string{}
}
if _, ok := b.rules[table][chain]; !ok {
b.rules[table][chain] = []string{}
}
rule := strings.Join(rulespec, " ")
b.rules[table][chain] = append(b.rules[table][chain], rule)
return nil
}
// Insert will insert the rule in the corresponding position in the local
// cache or call the corresponding iptables command, depending on the table.
func (b *BatchProvider) Insert(table, chain string, pos int, rulespec ...string) error {
b.Lock()
defer b.Unlock()
if _, ok := b.batchTables[table]; !ok {
return b.ipt.Insert(table, chain, pos, rulespec...)
}
if _, ok := b.rules[table]; !ok {
b.rules[table] = map[string][]string{}
}
if _, ok := b.rules[table][chain]; !ok {
b.rules[table][chain] = []string{}
}
rule := strings.Join(rulespec, " ")
if pos == 1 {
b.rules[table][chain] = append([]string{rule}, b.rules[table][chain]...)
} else if pos > len(b.rules[table][chain]) {
b.rules[table][chain] = append(b.rules[table][chain], rule)
} else {
b.rules[table][chain] = append(b.rules[table][chain], "newvalue")
copy(b.rules[table][chain][pos-1:], b.rules[table][chain][pos-2:])
b.rules[table][chain][pos-1] = rule
}
return nil
}
// Delete will delete the rule from the local cache or the system.
func (b *BatchProvider) Delete(table, chain string, rulespec ...string) error {
b.Lock()
defer b.Unlock()
if _, ok := b.batchTables[table]; !ok {
return b.ipt.Delete(table, chain, rulespec...)
}
if _, ok := b.rules[table]; !ok {
return nil
}
if _, ok := b.rules[table][chain]; !ok {
return nil
}
rule := strings.Join(rulespec, " ")
for index, r := range b.rules[table][chain] {
if rule == r {
switch index {
case 0:
if len(b.rules[table][chain]) == 1 {
b.rules[table][chain] = []string{}
} else {
b.rules[table][chain] = b.rules[table][chain][1:]
}
case len(b.rules[table][chain]) - 1:
b.rules[table][chain] = b.rules[table][chain][:index]
default:
b.rules[table][chain] = append(b.rules[table][chain][:index], b.rules[table][chain][index+1:]...)
}
break
}
}
return nil
}
// ListChains will provide a list of the current chains.
func (b *BatchProvider) ListChains(table string) ([]string, error) {
b.Lock()
defer b.Unlock()
return b.ipt.ListChains(table)
}
// ClearChain will clear the chains.
func (b *BatchProvider) ClearChain(table, chain string) error {
b.Lock()
defer b.Unlock()
if _, ok := b.batchTables[table]; !ok {
return b.ipt.ClearChain(table, chain)
}
if _, ok := b.rules[table]; !ok {
return nil
}
if _, ok := b.rules[table][chain]; !ok {
return nil
}
b.rules[table][chain] = []string{}
return nil
}
// DeleteChain will delete the chains.
func (b *BatchProvider) DeleteChain(table, chain string) error {
b.Lock()
defer b.Unlock()
if _, ok := b.batchTables[table]; !ok {
return b.ipt.DeleteChain(table, chain)
}
if _, ok := b.rules[table]; !ok {
return nil
}
delete(b.rules[table], chain)
return nil
}
// NewChain creates a new chain.
func (b *BatchProvider) NewChain(table, chain string) error {
b.Lock()
defer b.Unlock()
if _, ok := b.batchTables[table]; !ok {
return b.ipt.NewChain(table, chain)
}
if _, ok := b.rules[table]; !ok {
b.rules[table] = map[string][]string{}
}
b.rules[table][chain] = []string{}
return nil
}
// Commit commits the rules to the system
func (b *BatchProvider) Commit() error {
b.Lock()
defer b.Unlock()
// We don't commit if we don't have any tables. This is old
// kernel compatibility mode.
if len(b.batchTables) == 0 {
return nil
}
buf, err := b.createDataBuffer()
if err != nil {
return fmt.Errorf("Failed to crete buffer %s", err)
}
return b.commitFunc(buf)
}
// RetrieveTable allows a caller to retrieve the final table. Mostly
// needed for debuging and unit tests.
func (b *BatchProvider) RetrieveTable() map[string]map[string][]string {
b.Lock()
defer b.Unlock()
return b.rules
}
func (b *BatchProvider) createDataBuffer() (*bytes.Buffer, error) {
buf := bytes.NewBuffer([]byte{})
for table := range b.rules {
if _, err := fmt.Fprintf(buf, "*%s\n", table); err != nil {
return nil, err
}
for chain := range b.rules[table] {
if _, err := fmt.Fprintf(buf, ":%s - [0:0]\n", chain); err != nil {
return nil, err
}
}
for chain := range b.rules[table] {
for _, rule := range b.rules[table][chain] {
if _, err := fmt.Fprintf(buf, "-A %s %s\n", chain, rule); err != nil {
return nil, err
}
}
}
if _, err := fmt.Fprintf(buf, "COMMIT\n"); err != nil {
return nil, err
}
}
return buf, nil
}
// restore will save the current DB to iptables.
func (b *BatchProvider) restore(buf *bytes.Buffer) error {
cmd := exec.Command(b.restoreCmd, "--wait")
cmd.Stdin = buf
out, err := cmd.CombinedOutput()
if err != nil {
again, _ := b.createDataBuffer()
zap.L().Error("Failed to execute command", zap.Error(err),
zap.ByteString("Output", out),
zap.String("Output", again.String()),
)
return fmt.Errorf("Failed to execute iptables-restore: %s", err)
}
return nil
}
func restoreHasWait(restoreCmd string) bool {
cmd := exec.Command(restoreCmd, "--version")
cmd.Stdin = bytes.NewReader([]byte{})
bytes, err := cmd.CombinedOutput()
if err != nil {
// Cannot retrieve version - assume no wait.
return false
}
versionMatcher := regexp.MustCompile(`v([0-9]+(\.[0-9]+)+)`)
match := versionMatcher.FindStringSubmatch(string(bytes))
if match == nil || len(match) < 2 {
// Cannot match version - assume no wait.
return false
}
restoreVersion, err := version.NewVersion(match[1])
if err != nil {
return false
}
minimumVersion, err := version.NewVersion("1.6.2")
if err != nil {
return false
}
return !restoreVersion.LessThan(minimumVersion)
}