Sunil Mohan Adapa 74214c18ae
*: Use Django gettext functions instead of ugettext
- ugettext functions will be removed in Django 4.0. Each use emits a warning
when running with Django 3.2. Since we have warnings enabled in developer mode,
we see quite a few messages because of this.

- ugettext is already a simple alias of gettext. So, no regressions are
expected.

Tests:

- Accessing an affected app in UI with Django 3.2 and Django 2.2 works fine.

- Using Django 3.2 there are no warnings related to removal of ugettext
functions.

- Ran regular unit tests.

Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
2021-09-20 16:50:16 -04:00

134 lines
4.6 KiB
Python

# SPDX-License-Identifier: AGPL-3.0-or-later
"""
Forms for wireguard module.
"""
import base64
import binascii
from django import forms
from django.core.exceptions import ValidationError
from django.core.validators import validate_ipv4_address
from django.utils.translation import gettext_lazy as _
KEY_LENGTH = 32
def validate_key(key):
"""Validate a WireGuard public/private/pre-shared key."""
valid = False
if isinstance(key, str):
key = key.encode()
try:
decoded_key = base64.b64decode(key)
if len(decoded_key) == KEY_LENGTH and base64.b64encode(
decoded_key) == key:
valid = True
except binascii.Error:
pass
if not valid:
raise ValidationError(_('Invalid key.'))
def validate_endpoint(endpoint):
"""Validate an endpoint of the form: demo.wireguard.com:12912.
Implemented similar to nm-utils.c::_parse_endpoint().
"""
valid = False
try:
destination, port = endpoint.rsplit(':', maxsplit=1)
port = int(port)
if 1 <= port < ((1 << 16) - 1) and destination:
valid = True
if destination[0] == '[' and (destination[-1] != ']'
or len(destination) < 3):
valid = False
except ValueError:
pass
if not valid:
raise ValidationError('Invalid endpoint.')
class AddClientForm(forms.Form):
"""Form to add client."""
public_key = forms.CharField(
label=_('Public Key'), strip=True,
help_text=_('Public key of the peer. Example: '
'MConEJFIg6+DFHg2J1nn9SNLOSE9KR0ysdPgmPjibEs= .'),
validators=[validate_key])
class AddServerForm(forms.Form):
"""Form to add server."""
peer_endpoint = forms.CharField(
label=_('Endpoint of the server'), strip=True,
help_text=_('Domain name and port in the form "ip:port". Example: '
'demo.wireguard.com:12912 .'),
validators=[validate_endpoint])
peer_public_key = forms.CharField(
label=_('Public key of the server'), strip=True, help_text=_(
'Provided by the server operator, a long string of characters. '
'Example: MConEJFIg6+DFHg2J1nn9SNLOSE9KR0ysdPgmPjibEs= .'),
validators=[validate_key])
ip_address = forms.CharField(
label=_('Client IP address provided by server'), strip=True,
help_text=_('IP address assigned to this machine on the VPN after '
'connecting to the endpoint. This value is usually '
'provided by the server operator. Example: 192.168.0.10.'),
validators=[validate_ipv4_address])
private_key = forms.CharField(
label=_('Private key of this machine'), strip=True, help_text=_(
'Optional. New public/private keys are generated if left blank. '
'Public key can then be provided to the server. This is the '
'recommended way. However, some server operators insist on '
'providing this. Example: '
'MConEJFIg6+DFHg2J1nn9SNLOSE9KR0ysdPgmPjibEs= .'), required=False,
validators=[validate_key])
preshared_key = forms.CharField(
label=_('Pre-shared key'), strip=True, required=False, help_text=_(
'Optional. A shared secret key provided by the server to add an '
'additional layer of security. Fill in only if provided. Example: '
'MConEJFIg6+DFHg2J1nn9SNLOSE9KR0ysdPgmPjibEs=.'),
validators=[validate_key])
default_route = forms.BooleanField(
label=_('Use this connection to send all outgoing traffic'),
required=False, help_text=_(
'Typically checked for a VPN service though which all traffic '
'is sent.'))
def get_settings(self):
"""Return NM settings dict from cleaned data."""
settings = {
'common': {
'type': 'wireguard',
'zone': 'external',
},
'ipv4': {
'method': 'manual',
'address': self.cleaned_data['ip_address'],
'netmask': '',
'gateway': '',
'dns': '',
'second_dns': '',
},
'wireguard': {
'peer_endpoint': self.cleaned_data['peer_endpoint'],
'peer_public_key': self.cleaned_data['peer_public_key'],
'private_key': self.cleaned_data['private_key'],
'preshared_key': self.cleaned_data['preshared_key'],
'default_route': self.cleaned_data['default_route'],
}
}
return settings