# Snippets

Snippets are meant as method of definig very high-level options, that may be very opinionated and thus not suited for everybody.

Snippets can be enabled individually. They can be definied by third parties, so to circumvent name collisions all snippets defined by this repository are prefixed with `nnf-`. Please do not use this prefix for any snippets defined by other repositories, though it might be advised you pick your own prefix.

Snippets are considered less stable than the rest of this repository. As they usually are quite opionated, when they get inproved, you might not actually cosider those changes an improvement. Please consider that when using snippets, you can always just copy and modify them for your needs. When updating this repository give it a quick look to see what has changed with the snippets you use.

## nnf-common
This snippets enables the firewall and many other snippets. Currently the following ones get enables.
### networking.nftables.firewall.snippets.nnf-common.enable

<div class="nixopt">

<div class="fieldname">Name</div>

```
networking.nftables.firewall.snippets.nnf-common.enable
```

<div class="fieldname">Description</div>

Whether to enable the nnf-common firewall snippet.

<div class="fieldname">Type</div>

```
boolean
```


<div class="fieldname">Default</div>

```
false
```


<div class="fieldname">Example</div>

```
true
```



<div class="fieldname">Declared in</div>


<a href="https://github.com/thelegy/nixos-nftables-firewall/blob/main/modules/snippets/nnf-common.nix" target="_blank">modules/snippets/nnf-common.nix</a>



</div>


## nnf-default-stopRuleset
### networking.nftables.firewall.snippets.nnf-default-stopRuleset.allowedTCPPorts

<div class="nixopt">

<div class="fieldname">Name</div>

```
networking.nftables.firewall.snippets.nnf-default-stopRuleset.allowedTCPPorts
```

<div class="fieldname">Description</div>

List of allowd TCP ports while the firewall is disabled.


<div class="fieldname">Type</div>

```
list of 16 bit unsigned integer; between 0 and 65535 (both inclusive)
```


<div class="fieldname">Default</div>

```
config.services.openssh.ports
```





<div class="fieldname">Declared in</div>


<a href="https://github.com/thelegy/nixos-nftables-firewall/blob/main/modules/snippets/nnf-default-stopRuleset.nix" target="_blank">modules/snippets/nnf-default-stopRuleset.nix</a>



</div>


### networking.nftables.firewall.snippets.nnf-default-stopRuleset.enable

<div class="nixopt">

<div class="fieldname">Name</div>

```
networking.nftables.firewall.snippets.nnf-default-stopRuleset.enable
```

<div class="fieldname">Description</div>

Whether to enable the nnf-default-stopRuleset snippet.

<div class="fieldname">Type</div>

```
boolean
```


<div class="fieldname">Default</div>

```
false
```


<div class="fieldname">Example</div>

```
true
```



<div class="fieldname">Declared in</div>


<a href="https://github.com/thelegy/nixos-nftables-firewall/blob/main/modules/snippets/nnf-default-stopRuleset.nix" target="_blank">modules/snippets/nnf-default-stopRuleset.nix</a>



</div>


## nnf-conntrack
### networking.nftables.firewall.snippets.nnf-conntrack.enable

<div class="nixopt">

<div class="fieldname">Name</div>

```
networking.nftables.firewall.snippets.nnf-conntrack.enable
```

<div class="fieldname">Description</div>

Whether to enable the nnf-conntrack firewall snippet.

<div class="fieldname">Type</div>

```
boolean
```


<div class="fieldname">Default</div>

```
false
```


<div class="fieldname">Example</div>

```
true
```



<div class="fieldname">Declared in</div>


<a href="https://github.com/thelegy/nixos-nftables-firewall/blob/main/modules/snippets/nnf-conntrack.nix" target="_blank">modules/snippets/nnf-conntrack.nix</a>



</div>


## nnf-dhcpv6
### networking.nftables.firewall.snippets.nnf-dhcpv6.enable

<div class="nixopt">

<div class="fieldname">Name</div>

```
networking.nftables.firewall.snippets.nnf-dhcpv6.enable
```

<div class="fieldname">Description</div>

Whether to enable the nnf-dhcpv6 firewall snippet.

<div class="fieldname">Type</div>

```
boolean
```


<div class="fieldname">Default</div>

```
false
```


<div class="fieldname">Example</div>

```
true
```



<div class="fieldname">Declared in</div>


<a href="https://github.com/thelegy/nixos-nftables-firewall/blob/main/modules/snippets/nnf-dhcpv6.nix" target="_blank">modules/snippets/nnf-dhcpv6.nix</a>



</div>


## nnf-drop
### networking.nftables.firewall.snippets.nnf-drop.enable

<div class="nixopt">

<div class="fieldname">Name</div>

```
networking.nftables.firewall.snippets.nnf-drop.enable
```

<div class="fieldname">Description</div>

Whether to enable the nnf-drop firewall snippet.

<div class="fieldname">Type</div>

```
boolean
```


<div class="fieldname">Default</div>

```
false
```


<div class="fieldname">Example</div>

```
true
```



<div class="fieldname">Declared in</div>


<a href="https://github.com/thelegy/nixos-nftables-firewall/blob/main/modules/snippets/nnf-drop.nix" target="_blank">modules/snippets/nnf-drop.nix</a>



</div>


## nnf-icmp
### networking.nftables.firewall.snippets.nnf-icmp.enable

<div class="nixopt">

<div class="fieldname">Name</div>

```
networking.nftables.firewall.snippets.nnf-icmp.enable
```

<div class="fieldname">Description</div>

Whether to enable the nnf-icmp firewall snippet.

<div class="fieldname">Type</div>

```
boolean
```


<div class="fieldname">Default</div>

```
false
```


<div class="fieldname">Example</div>

```
true
```



<div class="fieldname">Declared in</div>


<a href="https://github.com/thelegy/nixos-nftables-firewall/blob/main/modules/snippets/nnf-icmp.nix" target="_blank">modules/snippets/nnf-icmp.nix</a>



</div>


### networking.nftables.firewall.snippets.nnf-icmp.ipv4Types

<div class="nixopt">

<div class="fieldname">Name</div>

```
networking.nftables.firewall.snippets.nnf-icmp.ipv4Types
```

<div class="fieldname">Description</div>

List of allowed ICMP types.


<div class="fieldname">Type</div>

```
list of string
```


<div class="fieldname">Default</div>

```
[
  "echo-request"
  "router-advertisement"
]
```





<div class="fieldname">Declared in</div>


<a href="https://github.com/thelegy/nixos-nftables-firewall/blob/main/modules/snippets/nnf-icmp.nix" target="_blank">modules/snippets/nnf-icmp.nix</a>



</div>


### networking.nftables.firewall.snippets.nnf-icmp.ipv6Types

<div class="nixopt">

<div class="fieldname">Name</div>

```
networking.nftables.firewall.snippets.nnf-icmp.ipv6Types
```

<div class="fieldname">Description</div>

List of allowed ICMPv6 types.


<div class="fieldname">Type</div>

```
list of string
```


<div class="fieldname">Default</div>

```
[
  "echo-request"
  "nd-router-advert"
  "nd-neighbor-solicit"
  "nd-neighbor-advert"
]
```





<div class="fieldname">Declared in</div>


<a href="https://github.com/thelegy/nixos-nftables-firewall/blob/main/modules/snippets/nnf-icmp.nix" target="_blank">modules/snippets/nnf-icmp.nix</a>



</div>


## nnf-loopback
### networking.nftables.firewall.snippets.nnf-loopback.enable

<div class="nixopt">

<div class="fieldname">Name</div>

```
networking.nftables.firewall.snippets.nnf-loopback.enable
```

<div class="fieldname">Description</div>

Whether to enable the nnf-loopback firewall snippet.

<div class="fieldname">Type</div>

```
boolean
```


<div class="fieldname">Default</div>

```
false
```


<div class="fieldname">Example</div>

```
true
```



<div class="fieldname">Declared in</div>


<a href="https://github.com/thelegy/nixos-nftables-firewall/blob/main/modules/snippets/nnf-loopback.nix" target="_blank">modules/snippets/nnf-loopback.nix</a>



</div>


## nnf-nixos-firewall
### networking.nftables.firewall.snippets.nnf-nixos-firewall.enable

<div class="nixopt">

<div class="fieldname">Name</div>

```
networking.nftables.firewall.snippets.nnf-nixos-firewall.enable
```

<div class="fieldname">Description</div>

Whether to enable the nnf-nixos-firewall firewall snippet.

<div class="fieldname">Type</div>

```
boolean
```


<div class="fieldname">Default</div>

```
false
```


<div class="fieldname">Example</div>

```
true
```



<div class="fieldname">Declared in</div>


<a href="https://github.com/thelegy/nixos-nftables-firewall/blob/main/modules/snippets/nnf-nixos-firewall.nix" target="_blank">modules/snippets/nnf-nixos-firewall.nix</a>



</div>


## nnf-ssh
### networking.nftables.firewall.snippets.nnf-ssh.enable

<div class="nixopt">

<div class="fieldname">Name</div>

```
networking.nftables.firewall.snippets.nnf-ssh.enable
```

<div class="fieldname">Description</div>

Whether to enable the nnf-ssh firewall snippet.

<div class="fieldname">Type</div>

```
boolean
```


<div class="fieldname">Default</div>

```
false
```


<div class="fieldname">Example</div>

```
true
```



<div class="fieldname">Declared in</div>


<a href="https://github.com/thelegy/nixos-nftables-firewall/blob/main/modules/snippets/nnf-ssh.nix" target="_blank">modules/snippets/nnf-ssh.nix</a>



</div>