Skip to content

Firewall: Aliases - allow setting a custom auth http header #8688

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
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Firewall: Aliases - allow setting a custom auth http header #8688

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
13 changes: 13 additions & 0 deletions src/opnsense/mvc/app/models/OPNsense/Firewall/Alias.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,19 @@ public function performValidation($validateFullModel = false)
$messages->appendMessage(new Message(gettext('Illegal characters in token'), $ref . '.authtype'));
}
break;
case 'Header':
if (empty($username) || empty($password)) {
$messages->appendMessage(new Message(gettext('Please provide a header key and value when Header auth is selected'), $ref . '.authtype'));
} elseif (strlen($username) > 255) {
$messages->appendMessage(new Message(gettext('Invalid key length'), $ref . '.authtype'));
} elseif (strlen($password) > 512) {
$messages->appendMessage(new Message(gettext('Invalid value length'), $ref . '.authtype'));
} elseif (!preg_match('/^[A-Za-z0-9-_.]+$/', $username)) {
$messages->appendMessage(new Message(gettext('Illegal characters in key'), $ref . '.authtype'));
} elseif (!preg_match('/^[A-Za-z0-9-_.]+$/', $password)) {
$messages->appendMessage(new Message(gettext('Illegal characters in value'), $ref . '.authtype'));
}
break;
}
}

Expand Down
1 change: 1 addition & 0 deletions src/opnsense/mvc/app/models/OPNsense/Firewall/Alias.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@
<OptionValues>
<Basic>Basic</Basic>
<Bearer>Bearer</Bearer>
<Header>Header</Header>
</OptionValues>
</authtype>
<categories type="ModelRelationField">
Expand Down
4 changes: 4 additions & 0 deletions src/opnsense/mvc/app/views/OPNsense/Firewall/alias.volt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -378,6 +378,10 @@
case 'Bearer':
$("#alias\\.password").show().attr('placeholder', '{{lang._('API token')}}');
break;
case 'Header':
$("#alias\\.username").show().attr('placeholder', '{{lang._('HTTP Header')}}');
$("#alias\\.password").show().attr('placeholder', '{{lang._('API token')}}');
break;
}
});
$("#alias\\.authtype").change();
Expand Down
2 changes: 2 additions & 0 deletions src/opnsense/scripts/filter/lib/alias/uri.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,8 @@ def iter_addresses(self, url):
req_opts['auth'] = requests.auth.HTTPBasicAuth(self._username, self._password)
elif self._authtype == 'Bearer':
req_opts['headers']['Authorization'] = f'Bearer {self._password}'
elif self._authtype == 'Header' and self._username is not None:
req_opts['headers'][self._username] = self._password

# fetch data
try:
Expand Down