nautobot 3.0.0a2__py3-none-any.whl → 3.0.0a3__py3-none-any.whl

nautobot/vpn/forms.py

@@ -0,0 +1,486 @@
+"""Forms for the vpn models."""
+
+import logging
+
+from django import forms
+
+from nautobot.apps.forms import (
+    add_blank_choice,
+    APISelect,
+    BulkEditNullBooleanSelect,
+    DynamicModelChoiceField,
+    DynamicModelMultipleChoiceField,
+    JSONArrayFormField,
+    NautobotBulkEditForm,
+    NautobotFilterForm,
+    NautobotModelForm,
+    StaticSelect2,
+    TagFilterField,
+    TagsBulkEditFormMixin,
+)
+from nautobot.dcim.choices import InterfaceTypeChoices
+from nautobot.dcim.models import Device, Interface
+from nautobot.extras.models import DynamicGroup, SecretsGroup
+from nautobot.ipam.models import IPAddress, Prefix
+from nautobot.tenancy.forms import TenancyFilterForm, TenancyForm
+
+from . import choices, models
+
+logger = logging.getLogger(__name__)
+
+
+class VPNProfileForm(NautobotModelForm, TenancyForm):  # pylint: disable=too-many-ancestors
+    """Form for creating and updating VPNProfile."""
+
+    secrets_group = DynamicModelChoiceField(
+        queryset=SecretsGroup.objects.all(),
+        required=False,
+        label="Secrets Group",
+        help_text="Secrets Group for the VPN Profile.",
+    )
+
+    class Meta:
+        """Meta attributes."""
+
+        model = models.VPNProfile
+        fields = [
+            "name",
+            "description",
+            "keepalive_interval",
+            "keepalive_retries",
+            "keepalive_enabled",
+            "secrets_group",
+            "role",
+            "extra_options",
+            "nat_traversal",
+            "tenant_group",
+            "tenant",
+            "tags",
+        ]
+
+
+class VPNProfileBulkEditForm(TagsBulkEditFormMixin, NautobotBulkEditForm):  # pylint: disable=too-many-ancestors
+    """VPNProfile bulk edit form."""
+
+    pk = forms.ModelMultipleChoiceField(queryset=models.VPNProfile.objects.all(), widget=forms.MultipleHiddenInput)
+    description = forms.CharField(required=False, label="Description")
+    keepalive_interval = forms.IntegerField(
+        min_value=0,
+        required=False,
+    )
+    keepalive_retries = forms.IntegerField(
+        min_value=0,
+        required=False,
+    )
+    keepalive_enabled = forms.NullBooleanField(
+        required=False, widget=BulkEditNullBooleanSelect, label="Keepalive Enabled"
+    )
+    nat_traversal = forms.NullBooleanField(required=False, widget=BulkEditNullBooleanSelect, label="Nat Traversal")
+
+    class Meta:
+        """Meta attributes."""
+
+        model = models.VPNProfile
+        nullable_fields = [
+            "description",
+            "keepalive_interval",
+            "keepalive_retries",
+        ]
+
+
+VPNProfilePh1FormSet = forms.inlineformset_factory(
+    parent_model=models.VPNProfile,
+    model=models.VPNProfilePhase1PolicyAssignment,
+    fields=("vpn_phase1_policy", "weight"),
+    extra=1,
+    widgets={
+        "vpn_phase1_policy": APISelect(api_url="/api/vpn/vpn-phase-1-policies/"),
+        "weight": forms.NumberInput(attrs={"class": "form-control"}),
+    },
+)
+
+
+VPNProfilePh2FormSet = forms.inlineformset_factory(
+    parent_model=models.VPNProfile,
+    model=models.VPNProfilePhase2PolicyAssignment,
+    fields=("vpn_phase2_policy", "weight"),
+    extra=1,
+    widgets={
+        "vpn_phase2_policy": APISelect(api_url="/api/vpn/vpn-phase-2-policies/"),
+        "weight": forms.NumberInput(attrs={"class": "form-control"}),
+    },
+)
+
+
+class VPNProfileFilterForm(NautobotFilterForm, TenancyFilterForm):  # pylint: disable=too-many-ancestors
+    """Filter form for VPNProfile."""
+
+    model = models.VPNProfile
+    q = forms.CharField(required=False, label="Search")
+    tags = TagFilterField(model)
+
+
+class VPNPhase1PolicyForm(NautobotModelForm, TenancyForm):  # pylint: disable=too-many-ancestors
+    """Form for creating and updating VPNPhase1Policy."""
+
+    ike_version = forms.ChoiceField(
+        required=False,
+        choices=add_blank_choice(choices.IkeVersionChoices),
+        widget=StaticSelect2,
+        label="IKE Version",
+    )
+    authentication_method = forms.ChoiceField(
+        required=False,
+        choices=add_blank_choice(choices.AuthenticationMethodChoices),
+        widget=StaticSelect2,
+        label="Authentication Method",
+    )
+
+    class Meta:
+        """Meta attributes."""
+
+        model = models.VPNPhase1Policy
+        fields = "__all__"
+
+
+class VPNPhase1PolicyBulkEditForm(TagsBulkEditFormMixin, NautobotBulkEditForm):  # pylint: disable=too-many-ancestors
+    """VPNPhase1Policy bulk edit form."""
+
+    pk = forms.ModelMultipleChoiceField(queryset=models.VPNPhase1Policy.objects.all(), widget=forms.MultipleHiddenInput)
+    description = forms.CharField(required=False, label="Description")
+    ike_version = forms.ChoiceField(
+        required=False,
+        choices=add_blank_choice(choices.IkeVersionChoices),
+        widget=StaticSelect2,
+        label="Ike Version",
+    )
+    aggressive_mode = forms.NullBooleanField(required=False, widget=BulkEditNullBooleanSelect, label="Aggressive Mode")
+    encryption_algorithm = JSONArrayFormField(
+        choices=choices.EncryptionAlgorithmChoices,
+        base_field=forms.CharField(),
+        required=False,
+        label="Encryption Algorithm",
+    )
+    integrity_algorithm = JSONArrayFormField(
+        choices=choices.IntegrityAlgorithmChoices,
+        base_field=forms.CharField(),
+        required=False,
+        label="Integrity Algorithm",
+    )
+    dh_group = JSONArrayFormField(
+        choices=choices.DhGroupChoices,
+        base_field=forms.CharField(),
+        required=False,
+        label="Dh Group",
+    )
+    lifetime_seconds = forms.IntegerField(
+        min_value=0,
+        required=False,
+    )
+    lifetime_kb = forms.IntegerField(
+        min_value=0,
+        required=False,
+    )
+    authentication_method = forms.ChoiceField(
+        required=False,
+        choices=add_blank_choice(choices.AuthenticationMethodChoices),
+        widget=StaticSelect2,
+        label="Authentication Method",
+    )
+
+    class Meta:
+        """Meta attributes."""
+
+        model = models.VPNPhase1Policy
+        nullable_fields = [
+            "description",
+            "ike_version",
+            "encryption_algorithm",
+            "integrity_algorithm",
+            "dh_group",
+            "lifetime_seconds",
+            "lifetime_kb",
+            "authentication_method",
+        ]
+
+
+class VPNPhase1PolicyFilterForm(NautobotFilterForm, TenancyFilterForm):  # pylint: disable=too-many-ancestors
+    """Filter form for VPNPhase1Policy."""
+
+    model = models.VPNPhase1Policy
+    q = forms.CharField(required=False, label="Search")
+    tags = TagFilterField(model)
+
+
+class VPNPhase2PolicyForm(NautobotModelForm, TenancyForm):  # pylint: disable=too-many-ancestors
+    """Form for creating and updating VPNPhase2Policy."""
+
+    class Meta:
+        """Meta attributes."""
+
+        model = models.VPNPhase2Policy
+        fields = "__all__"
+
+
+class VPNPhase2PolicyBulkEditForm(TagsBulkEditFormMixin, NautobotBulkEditForm):  # pylint: disable=too-many-ancestors
+    """VPNPhase2Policy bulk edit form."""
+
+    pk = forms.ModelMultipleChoiceField(queryset=models.VPNPhase2Policy.objects.all(), widget=forms.MultipleHiddenInput)
+    description = forms.CharField(required=False, label="Description")
+    encryption_algorithm = JSONArrayFormField(
+        choices=choices.EncryptionAlgorithmChoices,
+        base_field=forms.CharField(),
+        required=False,
+        label="Encryption Algorithm",
+    )
+    integrity_algorithm = JSONArrayFormField(
+        choices=choices.IntegrityAlgorithmChoices,
+        base_field=forms.CharField(),
+        required=False,
+        label="Integrity Algorithm",
+    )
+    pfs_group = JSONArrayFormField(
+        choices=choices.DhGroupChoices,
+        base_field=forms.CharField(),
+        required=False,
+        label="Pfs Group",
+    )
+    lifetime = forms.IntegerField(
+        min_value=0,
+        required=False,
+    )
+
+    class Meta:
+        """Meta attributes."""
+
+        model = models.VPNPhase2Policy
+        nullable_fields = [
+            "description",
+            "encryption_algorithm",
+            "integrity_algorithm",
+            "pfs_group",
+            "lifetime",
+        ]
+
+
+class VPNPhase2PolicyFilterForm(NautobotFilterForm, TenancyFilterForm):  # pylint: disable=too-many-ancestors
+    """Filter form for VPNPhase2Policy."""
+
+    model = models.VPNPhase2Policy
+    q = forms.CharField(required=False, label="Search")
+    tags = TagFilterField(model)
+
+
+class VPNForm(NautobotModelForm, TenancyForm):  # pylint: disable=too-many-ancestors
+    """Form for creating and updating VPN."""
+
+    vpn_profile = DynamicModelChoiceField(
+        queryset=models.VPNProfile.objects.all(),
+        required=False,
+        label="VPN Profile",
+    )
+
+    class Meta:
+        """Meta attributes."""
+
+        model = models.VPN
+        fields = "__all__"
+
+
+class VPNBulkEditForm(TagsBulkEditFormMixin, NautobotBulkEditForm):  # pylint: disable=too-many-ancestors
+    """VPN bulk edit form."""
+
+    pk = forms.ModelMultipleChoiceField(queryset=models.VPN.objects.all(), widget=forms.MultipleHiddenInput)
+    description = forms.CharField(required=False, label="Description")
+    vpn_profile = DynamicModelChoiceField(
+        queryset=models.VPNProfile.objects.all(),
+        required=False,
+        label="VPN Profile",
+    )
+
+    class Meta:
+        """Meta attributes."""
+
+        model = models.VPN
+        nullable_fields = [
+            "description",
+            "vpn_profile",
+        ]
+
+
+class VPNFilterForm(NautobotFilterForm, TenancyFilterForm):  # pylint: disable=too-many-ancestors
+    """Filter form for VPN."""
+
+    model = models.VPN
+    q = forms.CharField(required=False, label="Search")
+    tags = TagFilterField(model)
+
+
+class VPNTunnelForm(NautobotModelForm, TenancyForm):  # pylint: disable=too-many-ancestors
+    """Form for creating and updating VPNTunnel."""
+
+    vpn_profile = DynamicModelChoiceField(
+        queryset=models.VPNProfile.objects.all(),
+        required=False,
+        label="VPN Profile",
+    )
+    vpn = DynamicModelChoiceField(
+        queryset=models.VPN.objects.all(),
+        required=False,
+        label="VPN",
+    )
+    encapsulation = forms.ChoiceField(
+        required=True,
+        choices=add_blank_choice(choices.EncapsulationChoices),
+        widget=StaticSelect2,
+        label="Encapsulation",
+    )
+    endpoint_a = DynamicModelChoiceField(
+        queryset=models.VPNTunnelEndpoint.objects.all(),
+        required=False,
+        label="Endpoint A",
+    )
+    endpoint_z = DynamicModelChoiceField(
+        queryset=models.VPNTunnelEndpoint.objects.all(),
+        required=False,
+        label="Endpoint Z",
+    )
+
+    class Meta:
+        """Meta attributes."""
+
+        model = models.VPNTunnel
+        fields = "__all__"
+
+
+class VPNTunnelBulkEditForm(TagsBulkEditFormMixin, NautobotBulkEditForm):  # pylint: disable=too-many-ancestors
+    """VPNTunnel bulk edit form."""
+
+    pk = forms.ModelMultipleChoiceField(queryset=models.VPNTunnel.objects.all(), widget=forms.MultipleHiddenInput)
+    description = forms.CharField(required=False, label="Description")
+    vpn_profile = DynamicModelChoiceField(
+        queryset=models.VPNProfile.objects.all(),
+        required=False,
+        label="VPN Profile",
+    )
+    vpn = DynamicModelChoiceField(
+        queryset=models.VPN.objects.all(),
+        required=False,
+        label="VPN",
+    )
+    encapsulation = forms.ChoiceField(
+        required=False,
+        choices=add_blank_choice(choices.EncapsulationChoices),
+        widget=StaticSelect2,
+        label="Encapsulation",
+    )
+
+    class Meta:
+        """Meta attributes."""
+
+        model = models.VPNTunnel
+        nullable_fields = [
+            "vpn_profile",
+            "vpn",
+            "description",
+            "encapsulation",
+        ]
+
+
+class VPNTunnelFilterForm(NautobotFilterForm, TenancyFilterForm):  # pylint: disable=too-many-ancestors
+    """Filter form for VPNTunnel."""
+
+    model = models.VPNTunnel
+    q = forms.CharField(required=False, label="Search")
+    tags = TagFilterField(model)
+
+
+class VPNTunnelEndpointForm(NautobotModelForm, TenancyForm):  # pylint: disable=too-many-ancestors
+    """Form for creating and updating VPNTunnelEndpoint."""
+
+    device = DynamicModelChoiceField(
+        queryset=Device.objects.all(),
+        required=False,
+        label="Device",
+    )
+    source_interface = DynamicModelChoiceField(
+        queryset=Interface.objects.all(),
+        required=False,
+        label="Source Interface",
+        query_params={
+            "device": "$device",
+        },
+    )
+    source_ipaddress = DynamicModelChoiceField(
+        queryset=IPAddress.objects.all(),
+        required=False,
+        label="Source IP Address",
+        query_params={
+            "interfaces": "$source_interface",
+        },
+    )
+    tunnel_interface = DynamicModelChoiceField(
+        queryset=Interface.objects.all(),
+        required=False,
+        label="Tunnel Interface",
+        query_params={
+            "device": "$device",
+            "type": InterfaceTypeChoices.TYPE_TUNNEL,
+        },
+        help_text="Interface must be of type Tunnel",
+    )
+    vpn_profile = DynamicModelChoiceField(
+        queryset=models.VPNProfile.objects.all(),
+        required=False,
+        label="VPN Profile",
+        help_text="VPN Profile for the tunnel endpoint.",
+    )
+    protected_prefixes = DynamicModelMultipleChoiceField(
+        queryset=Prefix.objects.all(),
+        required=False,
+        label="Protected Prefixes",
+        help_text="Protected Prefixes behind the tunnel endpoint.",
+    )
+    protected_prefixes_dg = DynamicModelMultipleChoiceField(
+        queryset=DynamicGroup.objects.all(),
+        required=False,
+        label="Protected Prefixes Dynamic Group",
+        to_field_name="name",
+        help_text="Protected Prefixes behind the tunnel endpoint.",
+    )
+
+    class Meta:
+        """Meta attributes."""
+
+        model = models.VPNTunnelEndpoint
+        fields = "__all__"
+
+
+class VPNTunnelEndpointBulkEditForm(TagsBulkEditFormMixin, NautobotBulkEditForm):  # pylint: disable=too-many-ancestors
+    """VPNTunnelEndpoint bulk edit form."""
+
+    pk = forms.ModelMultipleChoiceField(
+        queryset=models.VPNTunnelEndpoint.objects.all(), widget=forms.MultipleHiddenInput
+    )
+    vpn_profile = DynamicModelChoiceField(
+        queryset=models.VPNProfile.objects.all(),
+        required=False,
+        label="VPN Profile",
+        help_text="VPN Profile for the tunnel endpoint.",
+    )
+
+    class Meta:
+        """Meta attributes."""
+
+        model = models.VPNTunnelEndpoint
+        nullable_fields = [
+            "vpn_profile",
+        ]
+
+
+class VPNTunnelEndpointFilterForm(NautobotFilterForm, TenancyFilterForm):  # pylint: disable=too-many-ancestors
+    """Filter form for VPNTunnelEndpoint."""
+
+    model = models.VPNTunnelEndpoint
+    q = forms.CharField(required=False, label="Search")
+    tags = TagFilterField(model)

nautobot/vpn/homepage.py

@@ -0,0 +1,19 @@
+from nautobot.core.apps import HomePageItem, HomePagePanel
+from nautobot.vpn.models import VPN
+
+layout = (
+    HomePagePanel(
+        name="VPN",
+        weight=550,
+        items=(
+            HomePageItem(
+                name="VPNs",
+                link="vpn:vpn_list",
+                model=VPN,
+                description="VPNs",
+                permissions=["vpn.view_vpn"],
+                weight=100,
+            ),
+        ),
+    ),
+)