nautobot 2.4.9__py3-none-any.whl → 2.4.10__py3-none-any.whl

nautobot/extras/models/jobs.py

@@ -753,6 +753,8 @@ class JobResult(BaseModel, CustomFieldModel):
                     duration.total_seconds()
                 )
 
+    set_status.alters_data = True
+
     @classmethod
     def execute_job(cls, *args, **kwargs):
         """
@@ -768,6 +770,8 @@ class JobResult(BaseModel, CustomFieldModel):
         """
         return cls.enqueue_job(*args, **kwargs, synchronous=True)
 
+    execute_job.__func__.alters_data = True
+
     @classmethod
     def enqueue_job(
         cls,
@@ -938,6 +942,8 @@ class JobResult(BaseModel, CustomFieldModel):
 
         return job_result
 
+    enqueue_job.__func__.alters_data = True
+
     def log(
         self,
         message,
@@ -989,6 +995,8 @@ class JobResult(BaseModel, CustomFieldModel):
         else:
             log.save(using=JOB_LOGS)
 
+    log.alters_data = True
+
 
 #
 # Job Button
@@ -1076,6 +1084,8 @@ class ScheduledJobs(models.Model):
         if not instance.no_changes:
             cls.update_changed()
 
+    changed.__func__.alters_data = True
+
     @classmethod
     def update_changed(cls, raw=False, **kwargs):
         """This function acts as a signal handler to track changes to the scheduled job that is triggered after a change"""
@@ -1083,6 +1093,8 @@ class ScheduledJobs(models.Model):
             return
         cls.objects.update_or_create(ident=1, defaults={"last_update": timezone.now()})
 
+    update_changed.__func__.alters_data = True
+
     @classmethod
     def last_change(cls):
         """This function acts as a getter for the last update on scheduled jobs"""
@@ -1397,6 +1409,8 @@ class ScheduledJob(BaseModel):
         scheduled_job.validated_save()
         return scheduled_job
 
+    create_schedule.__func__.alters_data = True
+
     def to_cron(self):
         tz = self.time_zone
         t = self.start_time.astimezone(tz)  # pylint: disable=no-member

nautobot/extras/models/metadata.py

@@ -251,6 +251,8 @@ class ObjectMetadata(ChangeLoggedModel, BaseModel):
         self.clean()
         return super().validated_save(*args, **kwargs)
 
+    validated_save.alters_data = True
+
     def clean(self):
         """
         Validate a value according to the field's type validation rules.

nautobot/extras/models/models.py

@@ -457,6 +457,8 @@ class ExportTemplate(
         if self.file_extension.startswith("."):
             self.file_extension = self.file_extension[1:]
 
+    clean.alters_data = True
+
 
 #
 # External integrations
@@ -919,6 +921,8 @@ class UserSavedViewAssociation(BaseModel):
         super().clean()
         self.view_name = self.saved_view.view
 
+    clean.alters_data = True
+
 
 #
 # Webhooks

nautobot/extras/models/secrets.py

@@ -4,6 +4,7 @@ from django.core.exceptions import ValidationError
 from django.core.serializers.json import DjangoJSONEncoder
 from django.db import models
 from jinja2.exceptions import TemplateSyntaxError, UndefinedError
+from jinja2.sandbox import unsafe
 
 from nautobot.core.constants import CHARFIELD_MAX_LENGTH
 from nautobot.core.models import BaseModel
@@ -58,6 +59,7 @@ class Secret(PrimaryModel):
         except (TemplateSyntaxError, UndefinedError) as exc:
             raise SecretParametersError(self, registry["secrets_providers"].get(self.provider), str(exc)) from exc
 
+    @unsafe
     def get_value(self, obj=None):
         """Retrieve the secret value that this Secret is a representation of.
 
@@ -77,6 +79,8 @@ class Secret(PrimaryModel):
         except Exception as exc:
             raise SecretError(self, provider, str(exc)) from exc
 
+    get_value.do_not_call_in_templates = True
+
     def clean(self):
         provider = registry["secrets_providers"].get(self.provider)
         if not provider:
@@ -108,6 +112,7 @@ class SecretsGroup(OrganizationalModel):
     def __str__(self):
         return self.name
 
+    @unsafe
     def get_secret_value(self, access_type, secret_type, obj=None, **kwargs):
         """Helper method to retrieve a specific secret from this group.
 
@@ -118,6 +123,8 @@ class SecretsGroup(OrganizationalModel):
         ).secret
         return secret.get_value(obj=obj, **kwargs)
 
+    get_secret_value.do_not_call_in_templates = True
+
 
 @extras_features(
     "graphql",

nautobot/extras/secrets/__init__.py

@@ -1,5 +1,7 @@
 from abc import ABC, abstractmethod
 
+from jinja2.sandbox import unsafe
+
 from nautobot.extras.registry import registry
 
 from .exceptions import SecretError, SecretParametersError, SecretProviderError, SecretValueNotFoundError
@@ -31,6 +33,7 @@ class SecretsProvider(ABC):
 
     @classmethod
     @abstractmethod
+    @unsafe
     def get_value_for_secret(cls, secret, obj=None, **kwargs):
         """Retrieve the stored value described by the given Secret record.
 
@@ -41,6 +44,17 @@ class SecretsProvider(ABC):
             obj (object): Django model instance or similar providing additional context for retrieving the secret.
         """
 
+    get_value_for_secret.__func__.do_not_call_in_templates = True
+
+    def __init_subclass__(cls, **kwargs):
+        # Automatically apply protection against Django and Jinja2 template execution to child classes.
+        if not getattr(cls.get_value_for_secret, "do_not_call_in_templates", False):  # Django
+            cls.get_value_for_secret.__func__.do_not_call_in_templates = True
+        if not getattr(cls.get_value_for_secret, "unsafe_callable", False):  # Jinja @unsafe decorator
+            cls.get_value_for_secret.__func__.unsafe_callable = True
+
+        super().__init_subclass__(**kwargs)
+
 
 def register_secrets_provider(provider):
     """

nautobot/extras/tests/test_context_managers.py

@@ -2,6 +2,7 @@ from unittest import mock
 
 from django.contrib.auth import get_user_model
 from django.contrib.contenttypes.models import ContentType
+from django.core.exceptions import ValidationError
 from django.test import TestCase
 
 from nautobot.core.celery import app
@@ -220,6 +221,25 @@ class WebRequestContextTestCase(TestCase):
         self.assertEqual(call_args[6], oc_list[0].request_id)
         self.assertEqual(call_args[7], oc_list[0].get_snapshots())
 
+    def test_web_request_context_raises_exception_correctly(self):
+        """
+        Test implemented to ensure the fix for https://github.com/nautobot/nautobot/issues/7358 is working as intended.
+        The operation should raise and allow an exception to be passed through instead of raising an
+        AttributeError: 'NoneType' object has no attribute 'get'"
+        """
+        valid_location_type = LocationType.objects.get(name="Campus")
+        location_status = Status.objects.get_for_model(Location).first()
+        invalid_location_type = LocationType(name="rackgroup")
+        with self.assertRaises(ValidationError):
+            with web_request_context(self.user, context_detail="test_web_request_context_raises_exception_correctly"):
+                # These operations should generate some ObjectChange records to test the code path that was causing the reported issue.
+                location = Location(name="Test Location 1", location_type=valid_location_type, status=location_status)
+                location.save()
+                location.description = "changed"
+                location.save()
+                # Location type name is not allowed to be "rackgroup" (reserved name), so this should raise an exception.
+                invalid_location_type.validated_save()
+
 
 class WebRequestContextTransactionTestCase(TransactionTestCase):
     def test_change_log_thread_safe(self):

nautobot/extras/tests/test_models.py

@@ -125,6 +125,13 @@ class ComputedFieldTest(ModelTestCases.BaseModelTestCase):
             fallback_value="An error occurred while rendering this template.",
             weight=50,
         )
+        self.evil_computed_field = ComputedField.objects.create(
+            content_type=ContentType.objects.get_for_model(Secret),
+            key="evil_computed_field",
+            label="Evil Computed Field",
+            template="{{ obj.get_value() }}",
+            weight=666,
+        )
         self.blank_fallback_value = ComputedField.objects.create(
             content_type=ContentType.objects.get_for_model(Location),
             key="blank_fallback_value",
@@ -133,6 +140,18 @@ class ComputedFieldTest(ModelTestCases.BaseModelTestCase):
             weight=50,
         )
         self.location1 = Location.objects.filter(location_type=LocationType.objects.get(name="Campus")).first()
+        self.secret = Secret.objects.create(
+            name="Environment Variable Secret",
+            provider="environment-variable",
+            parameters={"variable": "NAUTOBOT_ROOT"},
+        )
+        self.secrets_group = SecretsGroup.objects.create(name="Group of Secrets")
+        SecretsGroupAssociation.objects.create(
+            secrets_group=self.secrets_group,
+            secret=self.secret,
+            access_type=SecretsGroupAccessTypeChoices.TYPE_GENERIC,
+            secret_type=SecretsGroupSecretTypeChoices.TYPE_SECRET,
+        )
 
     def test_render_method(self):
         rendered_value = self.good_computed_field.render(context={"obj": self.location1})
@@ -146,6 +165,13 @@ class ComputedFieldTest(ModelTestCases.BaseModelTestCase):
         rendered_value = self.bad_computed_field.render(context={"obj": self.location1})
         self.assertEqual(rendered_value, self.bad_computed_field.fallback_value)
 
+    def test_render_method_evil_template(self):
+        rendered_value = self.evil_computed_field.render(context={"obj": self.secret})
+        self.assertEqual(rendered_value, "")
+        self.evil_computed_field.template = "{{ obj.secrets_groups.first().get_secret_value('Generic', 'secret') }}"
+        rendered_value = self.evil_computed_field.render(context={"obj": self.secret})
+        self.assertEqual(rendered_value, "")
+
     def test_check_if_key_is_graphql_safe(self):
         """
         Check the GraphQL validation method on CustomField Key Attribute.

nautobot/ipam/models.py

@@ -200,6 +200,8 @@ class VRF(PrimaryModel):
         instance.validated_save()
         return instance
 
+    add_device.alters_data = True
+
     def remove_device(self, device):
         """
         Remove a `device` from this VRF.
@@ -213,6 +215,8 @@ class VRF(PrimaryModel):
         instance = self.devices.through.objects.get(vrf=self, device=device)
         return instance.delete()
 
+    remove_device.alters_data = True
+
     def add_virtual_machine(self, virtual_machine, rd="", name=""):
         """
         Add a `virtual_machine` to this VRF, optionally overloading `rd` and `name`.
@@ -231,6 +235,8 @@ class VRF(PrimaryModel):
         instance.validated_save()
         return instance
 
+    add_virtual_machine.alters_data = True
+
     def remove_virtual_machine(self, virtual_machine):
         """
         Remove a `virtual_machine` from this VRF.
@@ -244,6 +250,8 @@ class VRF(PrimaryModel):
         instance = self.virtual_machines.through.objects.get(vrf=self, virtual_machine=virtual_machine)
         return instance.delete()
 
+    remove_virtual_machine.alters_data = True
+
     def add_virtual_device_context(self, virtual_device_context, rd="", name=""):
         """
         Add a `virtual_device_context` to this VRF, optionally overloading `rd` and `name`.
@@ -264,6 +272,8 @@ class VRF(PrimaryModel):
         instance.validated_save()
         return instance
 
+    add_virtual_device_context.alters_data = True
+
     def remove_virtual_device_context(self, virtual_device_context):
         """
         Remove a `virtual_device_context` from this VRF.
@@ -279,6 +289,8 @@ class VRF(PrimaryModel):
         )
         return instance.delete()
 
+    remove_virtual_device_context.alters_data = True
+
     def add_prefix(self, prefix):
         """
         Add a `prefix` to this VRF. Each object must be in the same Namespace.
@@ -293,6 +305,8 @@ class VRF(PrimaryModel):
         instance.validated_save()
         return instance
 
+    add_prefix.alters_data = True
+
     def remove_prefix(self, prefix):
         """
         Remove a `prefix` from this VRF.
@@ -306,6 +320,8 @@ class VRF(PrimaryModel):
         instance = self.prefixes.through.objects.get(vrf=self, prefix=prefix)
         return instance.delete()
 
+    remove_prefix.alters_data = True
+
 
 @extras_features("graphql")
 class VRFDeviceAssignment(BaseModel):
@@ -374,6 +390,8 @@ class VRFDeviceAssignment(BaseModel):
                 "A VRFDeviceAssignment entry must be associated with a device, a virtual machine, or a virtual device context."
             )
 
+    clean.alters_data = True
+
 
 @extras_features("graphql")
 class VRFPrefixAssignment(BaseModel):
@@ -640,6 +658,8 @@ class Prefix(PrimaryModel):
             self.prefix_length = prefix.prefixlen
             self.ip_version = prefix.version
 
+    _deconstruct_prefix.alters_data = True
+
     def delete(self, *args, **kwargs):
         """
         A Prefix with children will be impossible to delete and raise a `ProtectedError`.
@@ -705,6 +725,8 @@ class Prefix(PrimaryModel):
             return parent
         return None
 
+    get_parent.alters_data = True
+
     def clean(self):
         if self.prefix is not None:  # missing network/prefix_length will be caught by super().clean()
             # Clear host bits from prefix
@@ -716,6 +738,8 @@ class Prefix(PrimaryModel):
 
         super().clean()
 
+    clean.alters_data = True
+
     def save(self, *args, **kwargs):
         self.clean()
 
@@ -821,6 +845,8 @@ class Prefix(PrimaryModel):
 
         return query.update(parent=self)
 
+    reparent_subnets.alters_data = True
+
     def reparent_ips(self):
         """Determine the list of child IPAddresses and set the parent to self."""
         query = IPAddress.objects.select_for_update().filter(
@@ -832,6 +858,8 @@ class Prefix(PrimaryModel):
 
         return query.update(parent=self)
 
+    reparent_ips.alters_data = True
+
     def supernets(self, direct=False, include_self=False, for_update=False):
         """
         Return supernets of this Prefix.
@@ -1228,6 +1256,8 @@ class IPAddress(PrimaryModel):
             self.mask_length = address.prefixlen
             self.ip_version = address.version
 
+    _deconstruct_address.alters_data = True
+
     natural_key_field_names = ["parent__namespace", "host"]
 
     def _get_closest_parent(self):
@@ -1289,6 +1319,8 @@ class IPAddress(PrimaryModel):
 
         super().clean()
 
+    clean.alters_data = True
+
     def save(self, *args, **kwargs):
         self.clean()  # MUST do data fixup as above
 

nautobot/project-static/docs/development/apps/api/platform-features/secrets-providers.html

@@ -10092,46 +10092,47 @@
 </div>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="c1"># secrets.py</span>
 <a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="kn">from</span> <span class="nn">django</span> <span class="kn">import</span> <span class="n">forms</span>
-<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="kn">from</span> <span class="nn">nautobot.apps.secrets</span> <span class="kn">import</span> <span class="n">SecretsProvider</span>
-<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="kn">from</span> <span class="nn">nautobot.utilities.forms</span> <span class="kn">import</span> <span class="n">BootstrapMixin</span>
-<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a>
+<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>
+<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="kn">from</span> <span class="nn">nautobot.apps.secrets</span> <span class="kn">import</span> <span class="n">SecretsProvider</span>
+<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a><span class="kn">from</span> <span class="nn">nautobot.utilities.forms</span> <span class="kn">import</span> <span class="n">BootstrapMixin</span>
 <a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a>
-<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a><span class="k">class</span> <span class="nc">ConstantValueSecretsProvider</span><span class="p">(</span><span class="n">SecretsProvider</span><span class="p">):</span>
-<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a><span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
-<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a><span class="sd">    Example SecretsProvider - this one just returns a user-specified constant value.</span>
-<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a>
-<a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a><span class="sd">    Obviously this is insecure and not something you&#39;d want to actually use!</span>
-<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a><span class="sd">    &quot;&quot;&quot;</span>
-<a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a>
-<a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a>    <span class="n">slug</span> <span class="o">=</span> <span class="s2">&quot;constant-value&quot;</span>
-<a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a>    <span class="n">name</span> <span class="o">=</span> <span class="s2">&quot;Constant Value&quot;</span>
-<a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a>
-<a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a>    <span class="k">class</span> <span class="nc">ParametersForm</span><span class="p">(</span><span class="n">BootstrapMixin</span><span class="p">,</span> <span class="n">forms</span><span class="o">.</span><span class="n">Form</span><span class="p">):</span>
-<a id="__codelineno-0-18" name="__codelineno-0-18" href="#__codelineno-0-18"></a><span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
-<a id="__codelineno-0-19" name="__codelineno-0-19" href="#__codelineno-0-19"></a><span class="sd">        User-friendly form for specifying the required parameters of this provider.</span>
-<a id="__codelineno-0-20" name="__codelineno-0-20" href="#__codelineno-0-20"></a><span class="sd">        &quot;&quot;&quot;</span>
-<a id="__codelineno-0-21" name="__codelineno-0-21" href="#__codelineno-0-21"></a>        <span class="n">constant</span> <span class="o">=</span> <span class="n">forms</span><span class="o">.</span><span class="n">CharField</span><span class="p">(</span>
-<a id="__codelineno-0-22" name="__codelineno-0-22" href="#__codelineno-0-22"></a>            <span class="n">required</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
-<a id="__codelineno-0-23" name="__codelineno-0-23" href="#__codelineno-0-23"></a>            <span class="n">help_text</span><span class="o">=</span><span class="s2">&quot;Constant secret value. &lt;strong&gt;DO NOT USE FOR REAL DATA&lt;/strong&gt;&quot;</span>
-<a id="__codelineno-0-24" name="__codelineno-0-24" href="#__codelineno-0-24"></a>        <span class="p">)</span>
-<a id="__codelineno-0-25" name="__codelineno-0-25" href="#__codelineno-0-25"></a>
-<a id="__codelineno-0-26" name="__codelineno-0-26" href="#__codelineno-0-26"></a>    <span class="nd">@classmethod</span>
-<a id="__codelineno-0-27" name="__codelineno-0-27" href="#__codelineno-0-27"></a>    <span class="k">def</span> <span class="nf">get_value_for_secret</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">secret</span><span class="p">,</span> <span class="n">obj</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
-<a id="__codelineno-0-28" name="__codelineno-0-28" href="#__codelineno-0-28"></a><span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
-<a id="__codelineno-0-29" name="__codelineno-0-29" href="#__codelineno-0-29"></a><span class="sd">        Return the value defined in the Secret.parameters &quot;constant&quot; key.</span>
-<a id="__codelineno-0-30" name="__codelineno-0-30" href="#__codelineno-0-30"></a>
-<a id="__codelineno-0-31" name="__codelineno-0-31" href="#__codelineno-0-31"></a><span class="sd">        A more realistic SecretsProvider would make calls to external APIs, etc.,</span>
-<a id="__codelineno-0-32" name="__codelineno-0-32" href="#__codelineno-0-32"></a><span class="sd">        to retrieve a secret from another system as desired.</span>
-<a id="__codelineno-0-33" name="__codelineno-0-33" href="#__codelineno-0-33"></a>
-<a id="__codelineno-0-34" name="__codelineno-0-34" href="#__codelineno-0-34"></a><span class="sd">        Args:</span>
-<a id="__codelineno-0-35" name="__codelineno-0-35" href="#__codelineno-0-35"></a><span class="sd">            secret (nautobot.extras.models.Secret): The secret whose value should be retrieved.</span>
-<a id="__codelineno-0-36" name="__codelineno-0-36" href="#__codelineno-0-36"></a><span class="sd">            obj (object): The object (Django model or similar) providing context for the secret&#39;s</span>
-<a id="__codelineno-0-37" name="__codelineno-0-37" href="#__codelineno-0-37"></a><span class="sd">                parameters.</span>
-<a id="__codelineno-0-38" name="__codelineno-0-38" href="#__codelineno-0-38"></a><span class="sd">        &quot;&quot;&quot;</span>
-<a id="__codelineno-0-39" name="__codelineno-0-39" href="#__codelineno-0-39"></a>        <span class="k">return</span> <span class="n">secret</span><span class="o">.</span><span class="n">rendered_parameters</span><span class="p">(</span><span class="n">obj</span><span class="o">=</span><span class="n">obj</span><span class="p">)</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;constant&quot;</span><span class="p">)</span>
-<a id="__codelineno-0-40" name="__codelineno-0-40" href="#__codelineno-0-40"></a>
+<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a>
+<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a><span class="k">class</span> <span class="nc">ConstantValueSecretsProvider</span><span class="p">(</span><span class="n">SecretsProvider</span><span class="p">):</span>
+<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a><span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a><span class="sd">    Example SecretsProvider - this one just returns a user-specified constant value.</span>
+<a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a>
+<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a><span class="sd">    Obviously this is insecure and not something you&#39;d want to actually use!</span>
+<a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a><span class="sd">    &quot;&quot;&quot;</span>
+<a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a>
+<a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a>    <span class="n">slug</span> <span class="o">=</span> <span class="s2">&quot;constant-value&quot;</span>
+<a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a>    <span class="n">name</span> <span class="o">=</span> <span class="s2">&quot;Constant Value&quot;</span>
+<a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a>
+<a id="__codelineno-0-18" name="__codelineno-0-18" href="#__codelineno-0-18"></a>    <span class="k">class</span> <span class="nc">ParametersForm</span><span class="p">(</span><span class="n">BootstrapMixin</span><span class="p">,</span> <span class="n">forms</span><span class="o">.</span><span class="n">Form</span><span class="p">):</span>
+<a id="__codelineno-0-19" name="__codelineno-0-19" href="#__codelineno-0-19"></a><span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
+<a id="__codelineno-0-20" name="__codelineno-0-20" href="#__codelineno-0-20"></a><span class="sd">        User-friendly form for specifying the required parameters of this provider.</span>
+<a id="__codelineno-0-21" name="__codelineno-0-21" href="#__codelineno-0-21"></a><span class="sd">        &quot;&quot;&quot;</span>
+<a id="__codelineno-0-22" name="__codelineno-0-22" href="#__codelineno-0-22"></a>        <span class="n">constant</span> <span class="o">=</span> <span class="n">forms</span><span class="o">.</span><span class="n">CharField</span><span class="p">(</span>
+<a id="__codelineno-0-23" name="__codelineno-0-23" href="#__codelineno-0-23"></a>            <span class="n">required</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
+<a id="__codelineno-0-24" name="__codelineno-0-24" href="#__codelineno-0-24"></a>            <span class="n">help_text</span><span class="o">=</span><span class="s2">&quot;Constant secret value. &lt;strong&gt;DO NOT USE FOR REAL DATA&lt;/strong&gt;&quot;</span>
+<a id="__codelineno-0-25" name="__codelineno-0-25" href="#__codelineno-0-25"></a>        <span class="p">)</span>
+<a id="__codelineno-0-26" name="__codelineno-0-26" href="#__codelineno-0-26"></a>
+<a id="__codelineno-0-27" name="__codelineno-0-27" href="#__codelineno-0-27"></a>    <span class="nd">@classmethod</span>
+<a id="__codelineno-0-28" name="__codelineno-0-28" href="#__codelineno-0-28"></a>    <span class="k">def</span> <span class="nf">get_value_for_secret</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">secret</span><span class="p">,</span> <span class="n">obj</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
+<a id="__codelineno-0-29" name="__codelineno-0-29" href="#__codelineno-0-29"></a><span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
+<a id="__codelineno-0-30" name="__codelineno-0-30" href="#__codelineno-0-30"></a><span class="sd">        Return the value defined in the Secret.parameters &quot;constant&quot; key.</span>
+<a id="__codelineno-0-31" name="__codelineno-0-31" href="#__codelineno-0-31"></a>
+<a id="__codelineno-0-32" name="__codelineno-0-32" href="#__codelineno-0-32"></a><span class="sd">        A more realistic SecretsProvider would make calls to external APIs, etc.,</span>
+<a id="__codelineno-0-33" name="__codelineno-0-33" href="#__codelineno-0-33"></a><span class="sd">        to retrieve a secret from another system as desired.</span>
+<a id="__codelineno-0-34" name="__codelineno-0-34" href="#__codelineno-0-34"></a>
+<a id="__codelineno-0-35" name="__codelineno-0-35" href="#__codelineno-0-35"></a><span class="sd">        Args:</span>
+<a id="__codelineno-0-36" name="__codelineno-0-36" href="#__codelineno-0-36"></a><span class="sd">            secret (nautobot.extras.models.Secret): The secret whose value should be retrieved.</span>
+<a id="__codelineno-0-37" name="__codelineno-0-37" href="#__codelineno-0-37"></a><span class="sd">            obj (object): The object (Django model or similar) providing context for the secret&#39;s</span>
+<a id="__codelineno-0-38" name="__codelineno-0-38" href="#__codelineno-0-38"></a><span class="sd">                parameters.</span>
+<a id="__codelineno-0-39" name="__codelineno-0-39" href="#__codelineno-0-39"></a><span class="sd">        &quot;&quot;&quot;</span>
+<a id="__codelineno-0-40" name="__codelineno-0-40" href="#__codelineno-0-40"></a>        <span class="k">return</span> <span class="n">secret</span><span class="o">.</span><span class="n">rendered_parameters</span><span class="p">(</span><span class="n">obj</span><span class="o">=</span><span class="n">obj</span><span class="p">)</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;constant&quot;</span><span class="p">)</span>
 <a id="__codelineno-0-41" name="__codelineno-0-41" href="#__codelineno-0-41"></a>
-<a id="__codelineno-0-42" name="__codelineno-0-42" href="#__codelineno-0-42"></a><span class="n">secrets_providers</span> <span class="o">=</span> <span class="p">[</span><span class="n">ConstantValueSecretsProvider</span><span class="p">]</span>
+<a id="__codelineno-0-42" name="__codelineno-0-42" href="#__codelineno-0-42"></a>
+<a id="__codelineno-0-43" name="__codelineno-0-43" href="#__codelineno-0-43"></a><span class="n">secrets_providers</span> <span class="o">=</span> <span class="p">[</span><span class="n">ConstantValueSecretsProvider</span><span class="p">]</span>
 </code></pre></div>
 <p>After installing and enabling your app, you should now be able to navigate to <code>Secrets &gt; Secrets</code> and create a new Secret, at which point <code>"constant-value"</code> should now be available as a new secrets provider to use.</p>