Skip to content

Firewall: Rules: Add af-to (address family translation) to filter rules #10638

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Monviech wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Firewall: Rules: Add af-to (address family translation) to filter rules #10638

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions src/opnsense/mvc/app/controllers/OPNsense/Firewall/forms/dialogFilterRule.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -659,6 +659,31 @@
<visible>false</visible>
</grid_view>
</field>
<field>
<type>header</type>
<label>Address family translation</label>
<advanced>true</advanced>
</field>
<field>
<id>rule.af-to-source</id>
<label>Translation source</label>
<type>text</type>
<help>Source address used after translating the packet to the opposite address family. Address family translation is only valid for inbound pass rules using an explicit IPv4 or IPv6 version.</help>
<advanced>true</advanced>
<grid_view>
<visible>false</visible>
</grid_view>
</field>
<field>
<id>rule.af-to-destination</id>
<label>Translation destination</label>
<type>text</type>
<help>Optional destination address or network used after translating the packet to the opposite address family.</help>
<advanced>true</advanced>
<grid_view>
<visible>false</visible>
</grid_view>
</field>
<!-- Not exposed in dialog, do not exist in model, only for grid -->
<field>
<id>rule.statistics</id>
Expand Down
9 changes: 9 additions & 0 deletions src/opnsense/mvc/app/library/OPNsense/Firewall/FilterRule.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ class FilterRule extends Rule
'dn' => 'parsePlain',
'divert-to' => 'parsePlain,divert-to ',
'label' => 'parsePlain,label ",",63',
'af-to' => 'parsePlain, af-to ', // af-to always appears after the label in pfctl
'descr' => 'parseComment'
);

Expand Down Expand Up @@ -305,6 +306,14 @@ private function parseFilterRules()
$rule['dn'] = sprintf('%s %s', $shaper1['type'], $shaper1['id']);
}
}
// restructure address family translation
if (!empty($rule['af-to-source'])) {
$address_family = $rule['ipprotocol'] === 'inet' ? 'inet6' : 'inet';
$rule['af-to'] = sprintf('%s from %s', $address_family, $rule['af-to-source']);
if (!empty($rule['af-to-destination'])) {
$rule['af-to'] .= sprintf(' to %s', $rule['af-to-destination']);
}
}

yield $rule;
}
Expand Down
46 changes: 46 additions & 0 deletions src/opnsense/mvc/app/models/OPNsense/Firewall/Filter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -285,6 +285,52 @@ public function performValidation($validateFullModel = false)
$rule->replyto->__reference
));
}
// af-to validation
if (!$rule->{'af-to-destination'}->isEmpty() && $rule->{'af-to-source'}->isEmpty()) {
$messages->appendMessage(
new Message(
gettext("Translation destination requires a translation source."),
$rule->{'af-to-source'}->__reference
)
);
} elseif (!$rule->{'af-to-source'}->isEmpty()) {
if ($rule->action != 'pass') {
$messages->appendMessage(new Message(
gettext("Address family translation is only valid for pass rules."),
$rule->{'af-to-source'}->__reference
));
}
if ($rule->direction != 'in') {
$messages->appendMessage(new Message(
gettext("Address family translation is only valid for inbound rules."),
$rule->{'af-to-source'}->__reference
));
}
if (!in_array((string)$rule->ipprotocol, ['inet', 'inet6'], true)) {
$messages->appendMessage(new Message(
gettext("An address family must be selected when using address family translation."),
$rule->ipprotocol->__reference
));
}
if ($rule->statetype == 'none') {
$messages->appendMessage(new Message(
gettext("Address family translation requires state tracking."),
$rule->{'af-to-source'}->__reference
));
}
if (!$rule->gateway->isEmpty()) {
$messages->appendMessage(new Message(
gettext("Address family translation cannot be combined with route-to."),
$rule->gateway->__reference
));
}
if (!$rule->replyto->isEmpty()) {
$messages->appendMessage(new Message(
gettext("Address family translation cannot be combined with reply-to."),
$rule->replyto->__reference
));
}
}
}
}
}
Expand Down
7 changes: 7 additions & 0 deletions src/opnsense/mvc/app/models/OPNsense/Firewall/Filter.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,13 @@
<ConfigdPopulateAct>filter list diverts</ConfigdPopulateAct>
<ValidationMessage>Specify a valid divert-to target.</ValidationMessage>
</divert-to>
<af-to-source type="NetworkField">
<NetMaskAllowed>N</NetMaskAllowed>
</af-to-source>
<af-to-destination type="NetworkField">
<NetMaskRequired>Y</NetMaskRequired>
<Strict>Y</Strict>
</af-to-destination>
<gateway type="JsonKeyValueStoreField">
<ConfigdPopulateAct>interface gateways list -g</ConfigdPopulateAct>
<ValidationMessage>Specify a valid gateway from the list matching the networks ip protocol.</ValidationMessage>
Expand Down