/
resource_aviatrix_firewall.go
396 lines (344 loc) · 11.7 KB
/
resource_aviatrix_firewall.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
package aviatrix
import (
"fmt"
"log"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation"
"github.com/AviatrixSystems/terraform-provider-aviatrix/v2/goaviatrix"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
)
func resourceAviatrixFirewall() *schema.Resource {
return &schema.Resource{
Create: resourceAviatrixFirewallCreate,
Read: resourceAviatrixFirewallRead,
Update: resourceAviatrixFirewallUpdate,
Delete: resourceAviatrixFirewallDelete,
Importer: &schema.ResourceImporter{
State: schema.ImportStatePassthrough,
},
SchemaVersion: 1,
StateUpgraders: []schema.StateUpgrader{
{
Type: resourceAviatrixFirewallResourceV0().CoreConfigSchema().ImpliedType(),
Upgrade: resourceAviatrixFirewallStateUpgradeV0,
Version: 0,
},
},
Schema: map[string]*schema.Schema{
"gw_name": {
Type: schema.TypeString,
Required: true,
Description: "The name of gateway.",
},
"base_policy": {
Type: schema.TypeString,
Optional: true,
Default: "deny-all",
ValidateFunc: validation.StringInSlice([]string{"deny-all", "allow-all"}, false),
Description: "New base policy.",
},
"base_log_enabled": {
Type: schema.TypeBool,
Optional: true,
Default: false,
Description: "Indicates whether enable logging or not. Valid values: true, false. Default value: false.",
},
"manage_firewall_policies": {
Type: schema.TypeBool,
Optional: true,
Default: true,
Description: "Enable to manage firewall policies via in-line rules. If false, policies must be managed " +
"using `aviatrix_firewall_policy` resources.",
},
"policy": {
Type: schema.TypeList,
Optional: true,
Description: "New access policy for the gateway.",
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"src_ip": {
Type: schema.TypeString,
Required: true,
Description: "Source address, a valid IPv4 address or tag name.",
},
"dst_ip": {
Type: schema.TypeString,
Required: true,
Description: "Destination address, a valid IPv4 address or tag name.",
},
"protocol": {
Type: schema.TypeString,
Optional: true,
Default: "all",
ValidateFunc: validation.StringInSlice([]string{"all", "tcp", "udp", "icmp", "sctp", "rdp", "dccp"}, false),
Description: "Valid values: 'all', 'tcp', 'udp', 'icmp', 'sctp', 'rdp', 'dccp'.",
},
"port": {
Type: schema.TypeString,
Required: true,
Description: "A single port or a range of port numbers.",
},
"action": {
Type: schema.TypeString,
Required: true,
ValidateFunc: validation.StringInSlice([]string{"allow", "deny", "force-drop"}, false),
Description: "Valid values: 'allow', 'deny' or 'force-drop'(in stateful firewall rule to allow immediate packet dropping on established sessions).",
},
"log_enabled": {
Type: schema.TypeBool,
Optional: true,
Default: false,
Description: "Valid values: true, false. Default value: false.",
},
"description": {
Type: schema.TypeString,
Optional: true,
Default: "",
Description: "Description of this firewall policy.",
},
},
},
},
},
}
}
func resourceAviatrixFirewallCreate(d *schema.ResourceData, meta interface{}) error {
client := meta.(*goaviatrix.Client)
firewall := &goaviatrix.Firewall{
GwName: d.Get("gw_name").(string),
BasePolicy: d.Get("base_policy").(string),
}
_, hasSetPolicies := d.GetOk("policy")
enabledInlinePolicies := d.Get("manage_firewall_policies").(bool)
if hasSetPolicies && !enabledInlinePolicies {
return fmt.Errorf("manage_firewall_policies must be set to true to set in-line policies")
}
// If policies are present and manage_firewall_policies is set to true, update policies
if hasSetPolicies && enabledInlinePolicies {
policyList, err := getAndValidatePolicy(d)
if err != nil {
return err
}
firewall.PolicyList = policyList
}
log.Printf("[INFO] Creating Aviatrix firewall: %#v", firewall)
d.SetId(firewall.GwName)
flag := false
defer resourceAviatrixFirewallReadIfRequired(d, meta, &flag)
//If base_policy or base_log enable is present, set base policy
if firewall.BasePolicy == "allow-all" {
firewall.BaseLogEnabled = "off"
err := client.SetBasePolicy(firewall)
if err != nil {
return fmt.Errorf("failed to set base firewall policy for GW %s: %s", firewall.GwName, err)
}
}
baseLogEnabled := d.Get("base_log_enabled").(bool)
if baseLogEnabled {
firewall.BaseLogEnabled = "on"
err := client.SetBasePolicy(firewall)
if err != nil {
return fmt.Errorf("failed to enable base logging for GW %s: %s", firewall.GwName, err)
}
}
if hasSetPolicies && enabledInlinePolicies {
err := client.UpdatePolicy(firewall)
if err != nil {
return fmt.Errorf("failed to set Aviatrix firewall policies for GW %s: %s", firewall.GwName, err)
}
}
return resourceAviatrixFirewallReadIfRequired(d, meta, &flag)
}
func resourceAviatrixFirewallReadIfRequired(d *schema.ResourceData, meta interface{}, flag *bool) error {
if !(*flag) {
*flag = true
return resourceAviatrixFirewallRead(d, meta)
}
return nil
}
func resourceAviatrixFirewallRead(d *schema.ResourceData, meta interface{}) error {
client := meta.(*goaviatrix.Client)
gwName := d.Get("gw_name").(string)
if gwName == "" {
id := d.Id()
log.Printf("[DEBUG] Looks like an import, no gateway name received. Import Id is %s", id)
d.Set("gw_name", id)
d.Set("manage_firewall_policies", true)
d.SetId(id)
}
firewall := &goaviatrix.Firewall{
GwName: d.Get("gw_name").(string),
}
fw, err := client.GetPolicy(firewall)
if err != nil {
if err == goaviatrix.ErrNotFound {
d.SetId("")
return nil
}
return fmt.Errorf("error fetching policy for gateway %s: %s", firewall.GwName, err)
}
log.Printf("[TRACE] Reading policy for gateway %s: %#v", firewall.GwName, fw)
var policiesFromFile []map[string]interface{}
if fw != nil {
if fw.BasePolicy == "allow-all" {
d.Set("base_policy", "allow-all")
} else {
d.Set("base_policy", "deny-all")
}
if fw.BaseLogEnabled == "on" {
d.Set("base_log_enabled", true)
} else {
d.Set("base_log_enabled", false)
}
for _, policy := range fw.PolicyList {
policiesFromFile = append(policiesFromFile, goaviatrix.PolicyToMap(policy))
}
}
// Only write policies to state if the user has enabled in-line policies.
if d.Get("manage_firewall_policies").(bool) {
if err := d.Set("policy", policiesFromFile); err != nil {
log.Printf("[WARN] Error setting policy for (%s): %s", d.Id(), err)
}
}
return nil
}
func resourceAviatrixFirewallUpdate(d *schema.ResourceData, meta interface{}) error {
client := meta.(*goaviatrix.Client)
firewall := &goaviatrix.Firewall{
GwName: d.Get("gw_name").(string),
}
d.Partial(true)
log.Printf("[INFO] Creating Aviatrix firewall: %#v", firewall)
_, hasSetPolicies := d.GetOk("policy")
enabledInlinePolicies := d.Get("manage_firewall_policies").(bool)
if hasSetPolicies && !enabledInlinePolicies {
return fmt.Errorf("manage_firewall_policies must be set to true to set in-line policies")
}
if ok := d.HasChange("base_policy"); ok {
firewall.BasePolicy = d.Get("base_policy").(string)
if firewall.BasePolicy == "allow" {
firewall.BasePolicy = "allow-all"
} else if firewall.BasePolicy == "deny" {
firewall.BasePolicy = "deny-all"
}
if d.HasChange("base_log_enabled") {
old, _ := d.GetChange("base_log_enabled")
if old.(bool) {
firewall.BaseLogEnabled = "on"
} else {
firewall.BaseLogEnabled = "off"
}
} else {
if d.Get("base_log_enabled").(bool) {
firewall.BaseLogEnabled = "on"
} else {
firewall.BaseLogEnabled = "off"
}
}
err := client.SetBasePolicy(firewall)
if err != nil {
return fmt.Errorf("failed to update base firewall policies for GW %s: %s", firewall.GwName, err)
}
}
if ok := d.HasChange("base_log_enabled"); ok {
firewall.BasePolicy = d.Get("base_policy").(string)
if d.Get("base_log_enabled").(bool) {
firewall.BaseLogEnabled = "on"
} else {
firewall.BaseLogEnabled = "off"
}
err := client.SetBasePolicy(firewall)
if err != nil {
return fmt.Errorf("failed to update base logging for GW %s: %s", firewall.GwName, err)
}
}
if ok := d.HasChange("policy"); ok && enabledInlinePolicies {
policyList, err := getAndValidatePolicy(d)
if err != nil {
return err
}
firewall.PolicyList = policyList
err = client.UpdatePolicy(firewall)
if err != nil {
return fmt.Errorf("failed to update Aviatrix Firewall policy: %s", err)
}
}
d.Partial(false)
return resourceAviatrixFirewallRead(d, meta)
}
func resourceAviatrixFirewallDelete(d *schema.ResourceData, meta interface{}) error {
client := meta.(*goaviatrix.Client)
firewall := &goaviatrix.Firewall{
GwName: d.Get("gw_name").(string),
}
firewall.PolicyList = make([]*goaviatrix.Policy, 0)
err := client.UpdatePolicy(firewall)
if err != nil {
return fmt.Errorf("failed to delete Aviatrix Firewall policy list: %s", err)
}
if d.Get("base_policy").(string) != "deny-all" {
firewall.BasePolicy = "deny-all"
baseLogEnabled := d.Get("base_log_enabled").(bool)
if baseLogEnabled {
firewall.BaseLogEnabled = "on"
} else {
firewall.BaseLogEnabled = "off"
}
err = client.SetBasePolicy(firewall)
if err != nil {
return fmt.Errorf("failed to set base firewall policies to default: %s", err)
}
}
if d.Get("base_log_enabled").(bool) {
firewall.BasePolicy = "deny-all"
firewall.BaseLogEnabled = "off"
err = client.SetBasePolicy(firewall)
if err != nil {
return fmt.Errorf("failed to set base logging to default: %s", err)
}
}
return nil
}
func getAndValidatePolicy(d *schema.ResourceData) ([]*goaviatrix.Policy, error) {
var mapPolicyKey = make(map[string]bool)
var previousActionIsForceDrop = true
var policyList []*goaviatrix.Policy
policies := d.Get("policy").([]interface{})
for index, policy := range policies {
pl := policy.(map[string]interface{})
firewallPolicy := &goaviatrix.Policy{
SrcIP: pl["src_ip"].(string),
DstIP: pl["dst_ip"].(string),
Protocol: pl["protocol"].(string),
Port: pl["port"].(string),
Action: pl["action"].(string),
Description: pl["description"].(string),
}
if !previousActionIsForceDrop && firewallPolicy.Action == "force-drop" {
return nil, fmt.Errorf("validation on policy rules failed: rule no. %v in policy list is a 'force-drop' rule. It should be ahead of other type rules in Policy list", index+1)
}
if previousActionIsForceDrop && firewallPolicy.Action != "force-drop" {
previousActionIsForceDrop = false
}
key := firewallPolicy.SrcIP + "~" + firewallPolicy.DstIP + "~" + firewallPolicy.Protocol + "~" + firewallPolicy.Port
if mapPolicyKey[key] {
return nil, fmt.Errorf("validation on policy rules failed: rule no. %v in policy list is a duplicate rule", index+1)
}
mapPolicyKey[key] = true
if firewallPolicy.Protocol == "all" && firewallPolicy.Port != "0:65535" {
return nil, fmt.Errorf("validation on policy rules failed: rule no. %v's port should be '0:65535' for protocol 'all'", index+1)
} else if firewallPolicy.Protocol == "all" {
firewallPolicy.Port = ""
}
if firewallPolicy.Protocol == "icmp" && (firewallPolicy.Port != "") {
return nil, fmt.Errorf("validation on policy rules failed: rule no. %v's port should be empty for protocol 'icmp'", index+1)
}
logEnabled := pl["log_enabled"].(bool)
if logEnabled {
firewallPolicy.LogEnabled = "on"
} else {
firewallPolicy.LogEnabled = "off"
}
policyList = append(policyList, firewallPolicy)
}
return policyList, nil
}