-
-
Notifications
You must be signed in to change notification settings - Fork 108
/
rules.go
511 lines (427 loc) · 12.9 KB
/
rules.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
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
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
/*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at https://mozilla.org/MPL/2.0/.
*/
package firewall
import (
"context"
"fmt"
"sort"
"strings"
"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation"
"github.com/bpg/terraform-provider-proxmox/proxmox/firewall"
"github.com/bpg/terraform-provider-proxmox/proxmox/types"
"github.com/bpg/terraform-provider-proxmox/proxmoxtf/resource/validators"
"github.com/bpg/terraform-provider-proxmox/proxmoxtf/structure"
)
const (
dvSecurityGroup = ""
dvRuleComment = ""
dvRuleDPort = ""
dvRuleDest = ""
dvRuleEnabled = true
dvRuleIface = ""
dvRuleLog = ""
dvRuleMacro = ""
dvRuleProto = ""
dvRuleSPort = ""
dvRuleSource = ""
// MkRule defines the name of the rule resource in the schema.
MkRule = "rule"
mkSecurityGroup = "security_group"
mkRuleAction = "action"
mkRuleComment = "comment"
mkRuleDPort = "dport"
mkRuleDest = "dest"
mkRuleEnabled = "enabled"
mkRuleIFace = "iface"
mkRuleLog = "log"
mkRuleMacro = "macro"
mkRulePos = "pos"
mkRuleProto = "proto"
mkRuleSource = "source"
mkRuleSPort = "sport"
mkRuleType = "type"
)
// Rules returns a resource that manages firewall rules.
func Rules() *schema.Resource {
rule := map[string]*schema.Schema{
mkRulePos: {
Type: schema.TypeInt,
Description: "Rules position",
Computed: true,
},
mkSecurityGroup: {
Type: schema.TypeString,
Description: "Security group name",
Optional: true,
ForceNew: true,
Default: dvSecurityGroup,
},
mkRuleAction: {
Type: schema.TypeString,
Description: "Rules action ('ACCEPT', 'DROP', 'REJECT')",
Optional: true,
ValidateDiagFunc: validators.FirewallPolicy(),
},
mkRuleType: {
Type: schema.TypeString,
Description: "Rules type ('in', 'out')",
Optional: true,
ValidateDiagFunc: validation.ToDiagFunc(validation.StringInSlice([]string{"in", "out"}, true)),
},
mkRuleComment: {
Type: schema.TypeString,
Description: "Rules comment",
Optional: true,
Default: dvRuleComment,
},
mkRuleDest: {
Type: schema.TypeString,
Description: "Restrict packet destination address. This can refer to a single IP address, an" +
" IP set ('+ipsetname') or an IP alias definition. You can also specify an address range " +
"like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are " +
"separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.",
Optional: true,
Default: dvRuleDest,
},
mkRuleDPort: {
Type: schema.TypeString,
Description: "Restrict TCP/UDP destination port. You can use service names or simple numbers " +
"(0-65535), as defined in '/etc/services'. Port ranges can be specified with '\\d+:\\d+'," +
" for example '80:85', and you can use comma separated list to match several ports or ranges.",
Optional: true,
Default: dvRuleDPort,
},
mkRuleEnabled: {
Type: schema.TypeBool,
Description: "Enable rule",
Optional: true,
Default: dvRuleEnabled,
},
mkRuleIFace: {
Type: schema.TypeString,
Description: "Network interface name. You have to use network configuration key names for VMs" +
" and containers ('net\\d+'). Host related rules can use arbitrary strings.",
Optional: true,
Default: dvRuleIface,
},
mkRuleLog: {
Type: schema.TypeString,
Description: "Log level for this rule ('emerg', 'alert', 'crit', 'err', 'warning', 'notice'," +
" 'info', 'debug', 'nolog')",
Optional: true,
Default: dvRuleLog,
},
mkRuleMacro: {
Type: schema.TypeString,
Description: "Use predefined standard macro",
Optional: true,
Default: dvRuleMacro,
},
mkRuleProto: {
Type: schema.TypeString,
Description: "Restrict packet protocol. You can use protocol names or simple numbers " +
"(0-255), as defined in '/etc/protocols'.",
Optional: true,
Default: dvRuleProto,
},
mkRuleSource: {
Type: schema.TypeString,
Description: "Restrict packet source address. This can refer to a single IP address, an" +
" IP set ('+ipsetname') or an IP alias definition. You can also specify an address range " +
"like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are " +
"separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.",
Optional: true,
Default: dvRuleSource,
},
mkRuleSPort: {
Type: schema.TypeString,
Description: "Restrict TCP/UDP source port. You can use service names or simple numbers " +
"(0-65535), as defined in '/etc/services'. Port ranges can be specified with '\\d+:\\d+'," +
" for example '80:85', and you can use comma separated list to match several ports or ranges.",
Optional: true,
Default: dvRuleSPort,
},
}
s := map[string]*schema.Schema{
MkRule: {
Type: schema.TypeList,
Description: "List of rules",
Required: true,
ForceNew: true,
Elem: &schema.Resource{Schema: rule},
},
}
structure.MergeSchema(s, selectorSchema())
return &schema.Resource{
Schema: s,
CreateContext: invokeRuleAPI(RulesCreate),
ReadContext: invokeRuleAPI(RulesRead),
UpdateContext: invokeRuleAPI(RulesUpdate),
DeleteContext: invokeRuleAPI(RulesDelete),
}
}
// RulesCreate creates new firewall rules.
func RulesCreate(ctx context.Context, api firewall.Rule, d *schema.ResourceData) diag.Diagnostics {
var diags diag.Diagnostics
rules := d.Get(MkRule).([]interface{})
for i := len(rules) - 1; i >= 0; i-- {
var ruleBody firewall.RuleCreateRequestBody
rule := rules[i].(map[string]interface{})
sg := rule[mkSecurityGroup].(string)
if sg != "" {
// this is a special case of security group insertion
ruleBody = firewall.RuleCreateRequestBody{
Action: sg,
Type: "group",
BaseRule: *mapToSecurityGroupBaseRule(rule),
}
} else {
a := rule[mkRuleAction].(string)
t := rule[mkRuleType].(string)
if a == "" || t == "" {
diags = append(diags, diag.Errorf("Either '%s' OR both '%s' and '%s' must be defined for the rule #%d",
mkSecurityGroup, mkRuleAction, mkRuleType, i)...)
continue
}
ruleBody = firewall.RuleCreateRequestBody{
Action: a,
Type: t,
BaseRule: *mapToBaseRule(rule),
}
}
err := api.CreateRule(ctx, &ruleBody)
diags = append(diags, diag.FromErr(err)...)
}
if diags.HasError() {
return diags
}
// reset rules, we re-read them (with proper positions) from the API
err := d.Set(MkRule, nil)
if err != nil {
return diag.FromErr(err)
}
d.SetId(api.GetRulesID())
return RulesRead(ctx, api, d)
}
// RulesRead reads rules from the API and updates the state.
func RulesRead(ctx context.Context, api firewall.Rule, d *schema.ResourceData) diag.Diagnostics {
var diags diag.Diagnostics
readRule := func(pos int, ruleMap map[string]interface{}) error {
rule, err := api.GetRule(ctx, pos)
if err != nil {
if strings.Contains(err.Error(), "no rule at position") {
// this is not an error, the rule does not exist
return nil
}
return fmt.Errorf("error reading rule %d : %w", pos, err)
}
// pos in the map should be int!
ruleMap[mkRulePos] = pos
if rule.Type == "group" {
// this is a special case of security group insertion
ruleMap[mkSecurityGroup] = rule.Action
securityGroupBaseRuleToMap(&rule.BaseRule, ruleMap)
} else {
ruleMap[mkRuleAction] = rule.Action
ruleMap[mkRuleType] = rule.Type
baseRuleToMap(&rule.BaseRule, ruleMap)
}
return nil
}
rules := d.Get(MkRule).([]interface{})
if len(rules) > 0 {
// We have rules in the state, so we need to read them from the API
for _, v := range rules {
ruleMap := v.(map[string]interface{})
pos := ruleMap[mkRulePos].(int)
err := readRule(pos, ruleMap)
diags = append(diags, diag.FromErr(err)...)
}
} else {
ruleIDs, err := api.ListRules(ctx)
if err != nil {
return diag.FromErr(err)
}
for _, id := range ruleIDs {
ruleMap := map[string]interface{}{}
err = readRule(id.Pos, ruleMap)
if err != nil {
diags = append(diags, diag.FromErr(err)...)
} else if len(ruleMap) > 0 {
rules = append(rules, ruleMap)
}
}
}
if diags.HasError() {
return diags
}
err := d.Set(MkRule, rules)
diags = append(diags, diag.FromErr(err)...)
return diags
}
// RulesUpdate updates rules.
func RulesUpdate(ctx context.Context, api firewall.Rule, d *schema.ResourceData) diag.Diagnostics {
var diags diag.Diagnostics
rules := d.Get(MkRule).([]interface{})
for i := len(rules) - 1; i >= 0; i-- {
rule := rules[i].(map[string]interface{})
ruleBody := firewall.RuleUpdateRequestBody{
BaseRule: *mapToBaseRule(rule),
}
pos := rule[mkRulePos].(int)
if pos >= 0 {
ruleBody.Pos = &pos
}
action := rule[mkRuleAction].(string)
if action != "" {
ruleBody.Action = &action
}
rType := rule[mkRuleType].(string)
if rType != "" {
ruleBody.Type = &rType
}
err := api.UpdateRule(ctx, pos, &ruleBody)
if err != nil {
diags = append(diags, diag.FromErr(err)...)
}
}
if diags.HasError() {
return diags
}
return RulesRead(ctx, api, d)
}
// RulesDelete deletes all rules.
func RulesDelete(ctx context.Context, api firewall.Rule, d *schema.ResourceData) diag.Diagnostics {
var diags diag.Diagnostics
rules := d.Get(MkRule).([]interface{})
sort.Slice(rules, func(i, j int) bool {
ruleI := rules[i].(map[string]interface{})
ruleJ := rules[j].(map[string]interface{})
return ruleI[mkRulePos].(int) > ruleJ[mkRulePos].(int)
})
for _, v := range rules {
rule := v.(map[string]interface{})
pos := rule[mkRulePos].(int)
_, err := api.GetRule(ctx, pos)
if err != nil {
// if the rule is not found / can't be retrieved, we can safely ignore it
continue
}
err = api.DeleteRule(ctx, pos)
diags = append(diags, diag.FromErr(err)...)
}
return diags
}
func mapToBaseRule(rule map[string]interface{}) *firewall.BaseRule {
baseRule := &firewall.BaseRule{}
comment := rule[mkRuleComment].(string)
if comment != "" {
baseRule.Comment = &comment
}
dest := rule[mkRuleDest].(string)
if dest != "" {
baseRule.Dest = &dest
}
dport := rule[mkRuleDPort].(string)
if dport != "" {
baseRule.DPort = &dport
}
enableBool := types.CustomBool(rule[mkRuleEnabled].(bool))
baseRule.Enable = &enableBool
iface := rule[mkRuleIFace].(string)
if iface != "" {
baseRule.IFace = &iface
}
log := rule[mkRuleLog].(string)
if log != "" {
baseRule.Log = &log
}
macro := rule[mkRuleMacro].(string)
if macro != "" {
baseRule.Macro = ¯o
}
proto := rule[mkRuleProto].(string)
if proto != "" {
baseRule.Proto = &proto
}
source := rule[mkRuleSource].(string)
if source != "" {
baseRule.Source = &source
}
sport := rule[mkRuleSPort].(string)
if sport != "" {
baseRule.SPort = &sport
}
return baseRule
}
func mapToSecurityGroupBaseRule(rule map[string]interface{}) *firewall.BaseRule {
baseRule := &firewall.BaseRule{}
comment := rule[mkRuleComment].(string)
if comment != "" {
baseRule.Comment = &comment
}
enableBool := types.CustomBool(rule[mkRuleEnabled].(bool))
baseRule.Enable = &enableBool
iface := rule[mkRuleIFace].(string)
if iface != "" {
baseRule.IFace = &iface
}
return baseRule
}
func baseRuleToMap(baseRule *firewall.BaseRule, rule map[string]interface{}) {
if baseRule.Comment != nil {
rule[mkRuleComment] = *baseRule.Comment
}
if baseRule.Dest != nil {
rule[mkRuleDest] = *baseRule.Dest
}
if baseRule.DPort != nil {
rule[mkRuleDPort] = *baseRule.DPort
}
if baseRule.Enable != nil {
rule[mkRuleEnabled] = *baseRule.Enable
}
if baseRule.IFace != nil {
rule[mkRuleIFace] = *baseRule.IFace
}
if baseRule.Log != nil {
rule[mkRuleLog] = *baseRule.Log
}
if baseRule.Macro != nil {
rule[mkRuleMacro] = *baseRule.Macro
}
if baseRule.Proto != nil {
rule[mkRuleProto] = *baseRule.Proto
}
if baseRule.Source != nil {
rule[mkRuleSource] = *baseRule.Source
}
if baseRule.SPort != nil {
rule[mkRuleSPort] = *baseRule.SPort
}
}
func securityGroupBaseRuleToMap(baseRule *firewall.BaseRule, rule map[string]interface{}) {
if baseRule.Comment != nil {
rule[mkRuleComment] = *baseRule.Comment
}
if baseRule.Enable != nil {
rule[mkRuleEnabled] = *baseRule.Enable
}
if baseRule.IFace != nil {
rule[mkRuleIFace] = *baseRule.IFace
}
}
func invokeRuleAPI(
f func(context.Context, firewall.Rule, *schema.ResourceData) diag.Diagnostics,
) func(context.Context, *schema.ResourceData, interface{}) diag.Diagnostics {
return func(ctx context.Context, d *schema.ResourceData, m interface{}) diag.Diagnostics {
return selectFirewallAPI(func(ctx context.Context, api firewall.API, data *schema.ResourceData) diag.Diagnostics {
return f(ctx, api, data)
})(ctx, d, m)
}
}