فهرست منبع

Rename pepper field to pepper_id for clarity

Jeremy Stretch 4 ماه پیش
والد
کامیت
11099b01bb

+ 10 - 10
contrib/openapi.json

@@ -166113,7 +166113,7 @@
                     },
                     {
                         "in": "query",
-                        "name": "pepper",
+                        "name": "pepper_id",
                         "schema": {
                             "type": "array",
                             "items": {
@@ -166126,14 +166126,14 @@
                     },
                     {
                         "in": "query",
-                        "name": "pepper__empty",
+                        "name": "pepper_id__empty",
                         "schema": {
                             "type": "boolean"
                         }
                     },
                     {
                         "in": "query",
-                        "name": "pepper__gt",
+                        "name": "pepper_id__gt",
                         "schema": {
                             "type": "array",
                             "items": {
@@ -166146,7 +166146,7 @@
                     },
                     {
                         "in": "query",
-                        "name": "pepper__gte",
+                        "name": "pepper_id__gte",
                         "schema": {
                             "type": "array",
                             "items": {
@@ -166159,7 +166159,7 @@
                     },
                     {
                         "in": "query",
-                        "name": "pepper__lt",
+                        "name": "pepper_id__lt",
                         "schema": {
                             "type": "array",
                             "items": {
@@ -166172,7 +166172,7 @@
                     },
                     {
                         "in": "query",
-                        "name": "pepper__lte",
+                        "name": "pepper_id__lte",
                         "schema": {
                             "type": "array",
                             "items": {
@@ -166185,7 +166185,7 @@
                     },
                     {
                         "in": "query",
-                        "name": "pepper__n",
+                        "name": "pepper_id__n",
                         "schema": {
                             "type": "array",
                             "items": {
@@ -228205,7 +228205,7 @@
                         "type": "boolean",
                         "description": "Permit create/update/delete operations using this key"
                     },
-                    "pepper": {
+                    "pepper_id": {
                         "type": "integer",
                         "maximum": 32767,
                         "minimum": 0,
@@ -244459,7 +244459,7 @@
                         "type": "boolean",
                         "description": "Permit create/update/delete operations using this key"
                     },
-                    "pepper": {
+                    "pepper_id": {
                         "type": "integer",
                         "maximum": 32767,
                         "minimum": 0,
@@ -244654,7 +244654,7 @@
                         "type": "boolean",
                         "description": "Permit create/update/delete operations using this key"
                     },
-                    "pepper": {
+                    "pepper_id": {
                         "type": "integer",
                         "maximum": 32767,
                         "minimum": 0,

+ 2 - 2
netbox/account/tables.py

@@ -53,6 +53,6 @@ class UserTokenTable(NetBoxTable):
     class Meta(NetBoxTable.Meta):
         model = UserToken
         fields = (
-            'pk', 'id', 'version', 'key', 'pepper', 'description', 'write_enabled', 'created', 'expires', 'last_used',
-            'allowed_ips',
+            'pk', 'id', 'version', 'key', 'pepper_id', 'description', 'write_enabled', 'created', 'expires',
+            'last_used', 'allowed_ips',
         )

+ 2 - 2
netbox/templates/users/token.html

@@ -28,8 +28,8 @@
               <td>{{ object }}</td>
             </tr>
             <tr>
-              <th scope="row">{% trans "Pepper" %}</th>
-              <td>{{ object.pepper }}</td>
+              <th scope="row">{% trans "Pepper ID" %}</th>
+              <td>{{ object.pepper_id }}</td>
             </tr>
           {% endif %}
           <tr>

+ 1 - 1
netbox/users/api/serializers_/tokens.py

@@ -32,7 +32,7 @@ class TokenSerializer(ValidatedModelSerializer):
         model = Token
         fields = (
             'id', 'url', 'display_url', 'display', 'version', 'key', 'user', 'description', 'created', 'expires',
-            'last_used', 'write_enabled', 'pepper', 'allowed_ips', 'token',
+            'last_used', 'write_enabled', 'pepper_id', 'allowed_ips', 'token',
         )
         read_only_fields = ('key',)
         brief_fields = ('id', 'url', 'display', 'version', 'key', 'write_enabled', 'description')

+ 1 - 1
netbox/users/filtersets.py

@@ -133,7 +133,7 @@ class TokenFilterSet(BaseFilterSet):
 
     class Meta:
         model = Token
-        fields = ('id', 'version', 'key', 'pepper', 'write_enabled', 'description', 'last_used')
+        fields = ('id', 'version', 'key', 'pepper_id', 'write_enabled', 'description', 'last_used')
 
     def search(self, queryset, name, value):
         if not value.strip():

+ 1 - 1
netbox/users/migrations/0014_users_token_v2.py

@@ -64,7 +64,7 @@ class Migration(migrations.Migration):
         ),
         migrations.AddField(
             model_name='token',
-            name='pepper',
+            name='pepper_id',
             field=models.PositiveSmallIntegerField(blank=True, null=True),
         ),
         migrations.AddField(

+ 4 - 4
netbox/users/models/tokens.py

@@ -80,8 +80,8 @@ class Token(models.Model):
         validators=[MinLengthValidator(TOKEN_KEY_LENGTH)],
         help_text=_('v2 token identification key'),
     )
-    pepper = models.PositiveSmallIntegerField(
-        verbose_name=_('pepper'),
+    pepper_id = models.PositiveSmallIntegerField(
+        verbose_name=_('pepper ID'),
         blank=True,
         null=True,
         help_text=_('ID of the cryptographic pepper used to hash the token (v2 only)'),
@@ -179,7 +179,7 @@ class Token(models.Model):
         """
         Recalculate and save the HMAC digest using the currently defined pepper and token values.
         """
-        self.pepper, pepper_value = get_current_pepper()
+        self.pepper_id, pepper_value = get_current_pepper()
         self.hmac_digest = hmac.new(
             pepper_value.encode('utf-8'),
             self.token.encode('utf-8'),
@@ -202,7 +202,7 @@ class Token(models.Model):
             return token == self.key
         if self.v2:
             try:
-                pepper = settings.API_TOKEN_PEPPERS[self.pepper]
+                pepper = settings.API_TOKEN_PEPPERS[self.pepper_id]
             except KeyError:
                 # Invalid pepper ID
                 return False

+ 1 - 1
netbox/users/tables.py

@@ -22,7 +22,7 @@ class TokenTable(UserTokenTable):
     class Meta(NetBoxTable.Meta):
         model = Token
         fields = (
-            'pk', 'id', 'version', 'key', 'pepper', 'user', 'description', 'write_enabled', 'created', 'expires',
+            'pk', 'id', 'version', 'key', 'pepper_id', 'user', 'description', 'write_enabled', 'created', 'expires',
             'last_used', 'allowed_ips',
         )