Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

NAS-130428 / 24.10 / Add auditing for API key CRUD operations #14131

Merged
merged 2 commits into from
Aug 5, 2024
Merged

NAS-130428 / 24.10 / Add auditing for API key CRUD operations #14131

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f4ae90b
Add auditing for API key CRUD operations
anodos325 Aug 5, 2024
a30afa0
Fix
anodos325 Aug 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions src/middlewared/middlewared/plugins/api_key.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ async def item_extend(self, item):
item.pop("key")
return item

@api_method(ApiKeyCreateArgs, ApiKeyCreateResult)
@api_method(ApiKeyCreateArgs, ApiKeyCreateResult, audit='Create API key', audit_extended=lambda data: data['name'])
async def do_create(self, data: dict) -> dict:
"""
Creates API Key.
Expand All @@ -76,8 +76,8 @@ async def do_create(self, data: dict) -> dict:

return self._serve(data, key)

@api_method(ApiKeyUpdateArgs, ApiKeyUpdateResult)
async def do_update(self, id_: int, data: dict) -> dict:
@api_method(ApiKeyUpdateArgs, ApiKeyUpdateResult, audit='Update API key', audit_callback=True)
async def do_update(self, audit_callback: callable, id_: int, data: dict) -> dict:
"""
Update API Key `id`.

Expand All @@ -86,6 +86,7 @@ async def do_update(self, id_: int, data: dict) -> dict:
reset = data.pop("reset", False)

old = await self.get_instance(id_)
audit_callback(old['name'])
new = old.copy()

new.update(data)
Expand All @@ -108,11 +109,14 @@ async def do_update(self, id_: int, data: dict) -> dict:

return self._serve(await self.get_instance(id_), key)

@api_method(ApiKeyDeleteArgs, ApiKeyDeleteResult)
async def do_delete(self, id_: int) -> Literal[True]:
@api_method(ApiKeyDeleteArgs, ApiKeyDeleteResult, audit='Delete API key', audit_callback=True)
async def do_delete(self, audit_callback: callable, id_: int) -> Literal[True]:
"""
Delete API Key `id`.
"""
name = (await self.get_instance(id_))['name']
audit_callback(name)

response = await self.middleware.call(
"datastore.delete",
self._config.datastore,
Expand Down
34 changes: 34 additions & 0 deletions tests/api2/test_audit_api_key.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
from middlewared.test.integration.utils import call
from middlewared.test.integration.utils.audit import expect_audit_method_calls

API_KEY_NAME = 'AUDIT_API_KEY'


def test_api_key_audit():
payload = {'name': API_KEY_NAME, 'allowlist': [{'resource': '*', 'method': '*'}]}
payload2 = {'allowlist': []}
audit_id = None

try:
with expect_audit_method_calls([{
'method': 'api_key.create',
'params': [payload],
'description': f'Create API key {API_KEY_NAME}',
}]):
api_key_id = call('api_key.create', payload)['id']

with expect_audit_method_calls([{
'method': 'api_key.update',
'params': [api_key_id, payload2],
'description': f'Update API key {API_KEY_NAME}',
}]):
call('api_key.update', api_key_id, payload2)

finally:
if audit_id:
with expect_audit_method_calls([{
'method': 'api_key.delete',
'params': [api_key_id],
'description': f'Delete API key {API_KEY_NAME}',
}]):
call('api_key.delete', api_key_id)
Loading