Rename pepper field to pepper_id for clarity

This commit is contained in:
Jeremy Stretch 2025-10-02 15:38:17 -04:00
parent 5dc48f3a88
commit 11099b01bb
8 changed files with 22 additions and 22 deletions

View File

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

View File

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

View File

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

View File

@ -32,7 +32,7 @@ class TokenSerializer(ValidatedModelSerializer):
model = Token model = Token
fields = ( fields = (
'id', 'url', 'display_url', 'display', 'version', 'key', 'user', 'description', 'created', 'expires', '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',) read_only_fields = ('key',)
brief_fields = ('id', 'url', 'display', 'version', 'key', 'write_enabled', 'description') brief_fields = ('id', 'url', 'display', 'version', 'key', 'write_enabled', 'description')

View File

@ -133,7 +133,7 @@ class TokenFilterSet(BaseFilterSet):
class Meta: class Meta:
model = Token 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): def search(self, queryset, name, value):
if not value.strip(): if not value.strip():

View File

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

View File

@ -80,8 +80,8 @@ class Token(models.Model):
validators=[MinLengthValidator(TOKEN_KEY_LENGTH)], validators=[MinLengthValidator(TOKEN_KEY_LENGTH)],
help_text=_('v2 token identification key'), help_text=_('v2 token identification key'),
) )
pepper = models.PositiveSmallIntegerField( pepper_id = models.PositiveSmallIntegerField(
verbose_name=_('pepper'), verbose_name=_('pepper ID'),
blank=True, blank=True,
null=True, null=True,
help_text=_('ID of the cryptographic pepper used to hash the token (v2 only)'), 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. 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( self.hmac_digest = hmac.new(
pepper_value.encode('utf-8'), pepper_value.encode('utf-8'),
self.token.encode('utf-8'), self.token.encode('utf-8'),
@ -202,7 +202,7 @@ class Token(models.Model):
return token == self.key return token == self.key
if self.v2: if self.v2:
try: try:
pepper = settings.API_TOKEN_PEPPERS[self.pepper] pepper = settings.API_TOKEN_PEPPERS[self.pepper_id]
except KeyError: except KeyError:
# Invalid pepper ID # Invalid pepper ID
return False return False

View File

@ -22,7 +22,7 @@ class TokenTable(UserTokenTable):
class Meta(NetBoxTable.Meta): class Meta(NetBoxTable.Meta):
model = Token model = Token
fields = ( 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', 'last_used', 'allowed_ips',
) )