3078 revoke agent tokens #3201

cakekoa · 2023-04-05T21:04:59Z

What does this PR do?

Fixes part of #3078 by removing users for agents that have shut down or timed out.

PR Checklist

Have you added an explanation of what your changes do and why you'd like to include them?
Is the TravisCI build passing?
Was the CHANGELOG.md updated to reflect the changes?
Was the documentation framework updated to reflect the changes?
Have you checked that you haven't introduced any duplicate code?

Testing Checklist

Added relevant unit tests?
Do all unit tests pass?
Do all end-to-end tests pass?
Any other testing performed?

Manually tested agent user removed after agent shutdown and when agent times out
Ran the logout BB test to test that the agent user is removed after agent logs out
If applicable, add screenshots or log transcripts of the feature working

codecov · 2023-04-05T21:12:04Z

Codecov Report

Patch coverage has no change and project coverage change: +0.04 🎉

Comparison is base (768a656) 73.02% compared to head (e63d78f) 73.07%.

❗ Current head e63d78f differs from pull request most recent head 1017721. Consider uploading reports for the commit 1017721 to get more accurate results

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #3201      +/-   ##
===========================================
+ Coverage    73.02%   73.07%   +0.04%     
===========================================
  Files          469      470       +1     
  Lines        13566    13599      +33     
===========================================
+ Hits          9907     9937      +30     
- Misses        3659     3662       +3

see 5 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

monkey/monkey_island/cc/services/authentication_service/authentication_facade.py

monkey/monkey_island/cc/services/authentication_service/setup.py

...s/unit_tests/monkey_island/cc/services/authentication_service/test_authentication_service.py

monkey/tests/unit_tests/monkey_island/cc/island_event_handlers/test_agent_heartbeat_monitor.py

monkey/monkey_island/cc/services/authentication_service/setup.py

monkey/monkey_island/cc/services/authentication_service/authentication_facade.py

mssalvatore · 2023-04-06T14:46:27Z

Fix commit with TEMP prefix

mssalvatore · 2023-04-07T12:14:20Z

monkey/monkey_island/cc/services/authentication_service/register_event_handlers.py

+    island_event_queue.subscribe(IslandEventTopic.AGENT_TIMED_OUT, agent_remover.remove_on_timeout)
+
+
+class AgentRemover:


AgentUserRemover. This name makes it seem like we're removing agents from the AgentRepository.

mssalvatore

Approved with one minor comment.

mssalvatore · 2023-04-07T16:42:04Z

envs/monkey_zoo/blackbox/test_blackbox.py

+    }
+
+    agent_requests.post(GET_AGENTS_ENDPOINT, data=agent_registration_dict)
+    assert agent_requests.post(LOGOUT_ENDPOINT, data=None).status_code == HTTPStatus.OK


We should attempt to access another endpoint and prove the agent is truly logged out.

mssalvatore reviewed Apr 5, 2023

View reviewed changes

monkey/monkey_island/cc/services/authentication_service/authentication_facade.py Outdated Show resolved Hide resolved

mssalvatore reviewed Apr 5, 2023

View reviewed changes

monkey/monkey_island/cc/services/authentication_service/setup.py Outdated Show resolved Hide resolved

mssalvatore reviewed Apr 5, 2023

View reviewed changes

...s/unit_tests/monkey_island/cc/services/authentication_service/test_authentication_service.py Outdated Show resolved Hide resolved

mssalvatore reviewed Apr 5, 2023

View reviewed changes

monkey/tests/unit_tests/monkey_island/cc/island_event_handlers/test_agent_heartbeat_monitor.py Outdated Show resolved Hide resolved

ilija-lazoroski force-pushed the 3078-revoke-agent-tokens branch from 2f2fdce to 0687547 Compare April 6, 2023 08:41

shreyamalviya reviewed Apr 6, 2023

View reviewed changes

monkey/monkey_island/cc/services/authentication_service/setup.py Outdated Show resolved Hide resolved

mssalvatore reviewed Apr 6, 2023

View reviewed changes

monkey/monkey_island/cc/services/authentication_service/setup.py Outdated Show resolved Hide resolved

cakekoa force-pushed the 3078-revoke-agent-tokens branch from 0687547 to ff31553 Compare April 6, 2023 11:53

cakekoa marked this pull request as ready for review April 6, 2023 12:06

mssalvatore reviewed Apr 6, 2023

View reviewed changes

monkey/monkey_island/cc/services/authentication_service/authentication_facade.py Show resolved Hide resolved

mssalvatore reviewed Apr 6, 2023

View reviewed changes

monkey/monkey_island/cc/services/authentication_service/authentication_facade.py Show resolved Hide resolved

cakekoa force-pushed the 3078-revoke-agent-tokens branch from 8299a91 to e63d78f Compare April 6, 2023 14:08

cakekoa force-pushed the 3078-revoke-agent-tokens branch from f4f53d9 to 5405dab Compare April 6, 2023 16:14

cakekoa requested a review from mssalvatore April 6, 2023 16:14

ilija-lazoroski approved these changes Apr 7, 2023

View reviewed changes

mssalvatore reviewed Apr 7, 2023

View reviewed changes

cakekoa force-pushed the 3078-revoke-agent-tokens branch from 5405dab to dadb05b Compare April 7, 2023 12:56

cakekoa and others added 11 commits April 7, 2023 15:48

Island: Add Island event for agent timeout

ab4e778

Island: Send timeout event on agent timeout

950f300

Island: Add AuthenticationFacade.remove_user

691f4e8

Island: Register handlers to remove expired agents

a445668

Island: Remove unneeded comment in AuthenticationFacade

6f52509

Island: Change agent id type from str to AgentID

2982657

UT: Rename remove_user test in authentication_service tests

88a4120

UT: Use assert_any_call in AgentHeartbeatMonitor tests

0be94b9

UT: Fix revoke tokens tests in authentication_service

651e9e3

Island: Move register_event_handlers to its own module

b9168f8

Island: Prevent race condition in remove_user()

07ca604

cakekoa added 6 commits April 7, 2023 15:48

Island: Consolidate "unregister agent" handlers

b622c3e

Island: Remove agent user on logout

1593c41

Island: Rename AgentRemover -> AgentUserRemover

104ae2c

BB: Test agent logout

f8a1aef

Island: Fix agent user removal on logout

f7d7b45

UT: Fix logout tests

c24dbff

cakekoa force-pushed the 3078-revoke-agent-tokens branch from dadb05b to c24dbff Compare April 7, 2023 16:22

mssalvatore approved these changes Apr 7, 2023

View reviewed changes

cakekoa and others added 3 commits April 7, 2023 17:00

BB: Test agent unable to access endpoint after logout

1017721

BB: Remove extra print statement

1cb2f4e

BB: Disambiguate island from agent logout tests

062efc2

mssalvatore merged commit 3b0cff0 into develop Apr 7, 2023

mssalvatore deleted the 3078-revoke-agent-tokens branch April 7, 2023 17:11

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

3078 revoke agent tokens #3201

3078 revoke agent tokens #3201

cakekoa commented Apr 5, 2023 •

edited

Loading

codecov bot commented Apr 5, 2023 •

edited

Loading

mssalvatore commented Apr 6, 2023

mssalvatore Apr 7, 2023

mssalvatore left a comment

mssalvatore Apr 7, 2023

		island_event_queue.subscribe(IslandEventTopic.AGENT_TIMED_OUT, agent_remover.remove_on_timeout)


		class AgentRemover:

3078 revoke agent tokens #3201

3078 revoke agent tokens #3201

Conversation

cakekoa commented Apr 5, 2023 • edited Loading

What does this PR do?

PR Checklist

Testing Checklist

codecov bot commented Apr 5, 2023 • edited Loading

Codecov Report

mssalvatore commented Apr 6, 2023

mssalvatore Apr 7, 2023

Choose a reason for hiding this comment

mssalvatore left a comment

Choose a reason for hiding this comment

mssalvatore Apr 7, 2023

Choose a reason for hiding this comment

cakekoa commented Apr 5, 2023 •

edited

Loading

codecov bot commented Apr 5, 2023 •

edited

Loading