[bug] Fix for token issuance via UI (#13307)

- Fixes bug where non-staff users could not generate (or revoke) their own tokens via the API
- Closes https://github.com/inventree/InvenTree/issues/13299
This commit is contained in:
Oliver authored and GitHub committed 2026-11-17 22:03:48 +11:00
1 parent ec23dcfdb8
commit 8f8502d0d9
5 files changed
+174 -19

No files matched your search

+21 -13
View File
@@ -136,20 +136,10 @@ class InvenTreeMetadata(SimpleMetadata):
role_required and check_user_role(user, role_required, permission)
)
# check if simple IsAuthenticated permission class is used
# Views guarded only by an "any authenticated user" permission class
# do not require model permissions (e.g. users managing their own API tokens)
if not result:
result = (
view.permission_classes
and len(view.permission_classes) == 1
and any(
perm
in [
permissions.IsAuthenticated,
InvenTree.permissions.IsAuthenticatedOrReadScope,
]
for perm in view.permission_classes
)
)
result = self.allows_any_authenticated_user(view)
if method in actions and not result:
del actions[method]
@@ -173,6 +163,24 @@ class InvenTreeMetadata(SimpleMetadata):
return metadata
@staticmethod
def allows_any_authenticated_user(view) -> bool:
"""Return True if the view is guarded by a single permission class which grants access to any authenticated user.
Such views do not require model / role permissions,
so the available actions should not be filtered by them.
"""
permission_classes = getattr(view, 'permission_classes', None) or []
if len(permission_classes) != 1:
return False
perm = permission_classes[0]
return perm is permissions.IsAuthenticated or bool(
getattr(perm, 'allows_any_authenticated_user', False)
)
def get_filter_metadata(self, request, view) -> dict:
"""Return information on the choice filters available for an API endpoint.
@@ -367,6 +367,10 @@ class IsSuperuserOrReadOnlyOrScope(OASTokenMixin, permissions.IsAdminUser):
class IsAuthenticatedOrReadScope(OASTokenMixin, permissions.IsAuthenticated):
"""Allows access only to authenticated users or read / write scope tokens."""
# Any authenticated user may access the endpoint, regardless of model permissions
# (see InvenTreeMetadata.determine_metadata)
allows_any_authenticated_user = True
def get_required_alternate_scopes(self, request, view):
"""Return the required scopes for the current request."""
return map_scope(
@@ -383,6 +387,10 @@ class IsAuthenticatedNotOAuth2(OASTokenMixin, permissions.IsAuthenticated):
a scoped OAuth2 token must not be able to obtain an unscoped credential.
"""
# Any authenticated user may access the endpoint, regardless of model permissions
# (see InvenTreeMetadata.determine_metadata)
allows_any_authenticated_user = True
def get_required_alternate_scopes(self, request, view):
"""No scope grants access to this endpoint."""
return {}
+71
View File
@@ -1021,6 +1021,77 @@ class UserTokenTests(InvenTreeAPITestCase):
self.assertIsNotNone(response_data.get('database'))
class UnprivilegedUserTokenTests(InvenTreeAPITestCase):
"""Token tests for a non-staff user without any assigned roles.
Regression tests for https://github.com/inventree/InvenTree/issues/13299
"""
fixtures = ['users']
is_staff = False
roles = []
def test_user_is_unprivileged(self):
"""Sanity check: the test user has no elevated access."""
self.assertFalse(self.user.is_staff)
self.assertFalse(self.user.is_superuser)
self.assertFalse(self.user.has_perm('users.view_apitoken'))
self.assertFalse(self.user.has_perm('users.add_apitoken'))
def test_token_options(self):
"""The OPTIONS metadata must advertise token creation to any authenticated user.
The frontend builds the "Generate Token" form from these actions,
so missing actions prevent users from minting their own tokens.
"""
# Token generation endpoint (used by the frontend)
actions = self.options(reverse('api-token'), expected_code=200).data['actions']
self.assertIn('GET', actions)
self.assertIn('name', actions['GET'])
# Token list / create endpoint
actions = self.options(reverse('api-token-list'), expected_code=200).data[
'actions'
]
self.assertIn('GET', actions)
self.assertIn('POST', actions)
self.assertIn('name', actions['POST'])
def test_token_create_and_revoke(self):
"""An unprivileged user can create, list and revoke their own tokens."""
# Generate via the 'me' endpoint
data = self.get(
reverse('api-token'), data={'name': 'via-get'}, expected_code=200
).data
self.assertTrue(data['token'].startswith('inv-'))
# Create via the token list endpoint
data = self.post(
reverse('api-token-list'), data={'name': 'via-post'}, expected_code=201
).data
self.assertTrue(data['token'].startswith('inv-'))
tokens = self.get(reverse('api-token-list'), expected_code=200).data
self.assertEqual({t['name'] for t in tokens}, {'via-get', 'via-post'})
for token in ApiToken.objects.filter(user=self.user):
self.delete(
reverse('api-token-detail', kwargs={'pk': token.pk}), expected_code=204
)
token.refresh_from_db()
self.assertTrue(token.revoked)
def test_no_model_permission_bypass(self):
"""The authenticated-user fallback must not expose actions on role-protected endpoints."""
self.assignRole('part.view')
actions = self.options(reverse('api-part-list'), expected_code=200).data[
'actions'
]
self.assertIn('GET', actions)
self.assertNotIn('POST', actions)
class GroupDetailTests(InvenTreeAPITestCase):
"""Tests for the GroupDetail API endpoint."""
@@ -21,6 +21,7 @@ import {
Textarea
} from '@mantine/core';
import { useDisclosure } from '@mantine/hooks';
import { notifications } from '@mantine/notifications';
import { IconAlertTriangle, IconCircleX } from '@tabler/icons-react';
import { useCallback, useMemo, useState } from 'react';
import { api } from '../../App';
@@ -212,6 +213,10 @@ export function ApiTokenTable({
table.refreshTable();
setRevokeTokenId(null);
setRevocationReason('');
notifications.show({
title: t`Token revoked`,
message: t`The token has been successfully revoked`
});
})
.catch((error) => {
showApiErrorMessage({
@@ -270,7 +275,7 @@ export function ApiTokenTable({
setRevokeTokenId(null);
setRevocationReason('');
}}
title={t`Revoke Token`}
title={<StylishText size='lg'>{t`Revoke Token`}</StylishText>}
centered
>
<Textarea
+68 -5
View File
@@ -1,9 +1,15 @@
import type { Page } from '@playwright/test';
import { createApi } from './api.js';
import { expect, test } from './baseFixtures.js';
import { adminuser, allaccessuser, stevenuser } from './defaults.js';
import {
adminuser,
allaccessuser,
readeruser,
stevenuser
} from './defaults.js';
import {
clearTableSearch,
clickOnRowMenu,
getRowFromCell,
loadTab,
navigate,
@@ -725,19 +731,76 @@ test('Settings - Auth - Tokens', async ({ browser }) => {
url: 'settings/user/'
});
const tokenName = `testtoken-${Date.now()}`;
await page.getByRole('tab', { name: 'Security' }).click();
await page.getByRole('button', { name: 'Access Tokens' }).click();
await page
.getByRole('button', { name: 'action-button-generate-token' })
.click();
await page
.getByRole('textbox', { name: 'text-field-name' })
.fill('testtoken');
await page.getByRole('textbox', { name: 'text-field-name' }).fill(tokenName);
await page.getByRole('button', { name: 'Submit', exact: true }).click();
await page.getByText('Tokens are only shown once').waitFor();
await page
.getByTestId('generated-api-token')
.locator('.mantine-CloseButton-root')
.click();
await page.getByRole('cell', { name: 'testtoken' }).waitFor();
await page.getByRole('cell', { name: tokenName }).waitFor();
});
// Regression test for https://github.com/inventree/InvenTree/issues/13299
// A non-staff user (without API token model permissions) must be able to mint their own tokens
test('Settings - Auth - Tokens - Non-staff user', async ({ browser }) => {
const page = await doCachedLogin(browser, {
user: readeruser,
url: 'settings/user/'
});
const tokenName = `reader-token-${Date.now()}`;
await page.getByRole('tab', { name: 'Security' }).click();
await page.getByRole('button', { name: 'Access Tokens' }).click();
await page
.getByRole('button', { name: 'action-button-generate-token' })
.click();
await page.getByRole('textbox', { name: 'text-field-name' }).fill(tokenName);
await page.getByRole('button', { name: 'Submit', exact: true }).click();
await page.getByText('Tokens are only shown once').waitFor();
// The generated token is displayed to the user
await expect(
page.getByTestId('generated-api-token').getByText(/^inv-/)
).toBeVisible();
await page
.getByTestId('generated-api-token')
.locator('.mantine-CloseButton-root')
.click();
await page.getByText('Token generated').waitFor();
const tokenCell = page.getByRole('cell', { name: tokenName });
await tokenCell.waitFor();
// The user can also revoke the newly minted token
const revocationReason = `revoked-${tokenName}`;
await clickOnRowMenu(tokenCell);
await page.getByRole('menuitem', { name: 'Revoke' }).click();
const revokeDialog = page.getByRole('dialog', { name: 'Revoke Token' });
await revokeDialog
.getByRole('textbox', { name: 'Revocation Reason' })
.fill(revocationReason);
await revokeDialog.getByRole('button', { name: 'Revoke' }).click();
await revokeDialog.waitFor({ state: 'hidden' });
await page.getByText('The token has been successfully revoked').waitFor();
// The table refreshes to show the token as revoked
const tokenRow = await getRowFromCell(tokenCell);
await tokenRow.getByRole('cell', { name: revocationReason }).waitFor();
// A revoked token cannot be revoked again (no row actions are available)
await expect(tokenRow.getByLabel(/row-action-menu-/i)).toHaveCount(0);
});