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.

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

Ransomware config UI description #1286

Merged
merged 2 commits into from
Jul 5, 2021

Conversation

mssalvatore
Copy link
Collaborator

What does this PR do?

Adds a description and link to documentation to the ransomware configuration UI.

Issue #1239

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?

Testing Checklist

  • Added relevant unit tests?
  • Have you successfully tested your changes locally?

    See screenshot

  • If applicable, add screenshots or log transcripts of the feature working

Screenshots

image

@codecov
Copy link

codecov bot commented Jun 30, 2021

Codecov Report

Merging #1286 (e1263ec) into develop (f698c88) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff            @@
##           develop    #1286   +/-   ##
========================================
  Coverage    30.68%   30.68%           
========================================
  Files          449      449           
  Lines        13470    13470           
========================================
  Hits          4133     4133           
  Misses        9337     9337           
Impacted Files Coverage Δ
...key_island/cc/services/config_schema/ransomware.py 100.00% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f698c88...e1263ec. Read the comment docs.

Comment on lines +4 to +6
"description": "This page allows you to configure the Infection Monkey to execute a ransomware "
"simulation. The Infection Monkey is capable of simulating a ransomware attack on your network "
"using a set of configurable behaviors. A number of precautions have been taken to ensure that "
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if this is not excessive info since the user is in the ransomware tab under the ransomware title, so it should be obvious that he's configuring ransomware simulation here. The fact that it's safe to run in production environment can be said about almost every field in configuration and monkey in general. The only thing I see as a must is a link to the documentation hub.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've done some thinking about it. I haven't really been able to come up with a better short description of what these configuration options are. I think it's worth the note about it being "safe", so people don't panic when they see "ransomware."

As we continue to work on this capability, we can revisit this.

Copy link
Contributor

@VakarisZ VakarisZ left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved, but it's worth the extra 5mins of thought to make sure that the config is both readable and intuitive without being a burden to go through.

@mssalvatore mssalvatore merged commit 94bf91c into develop Jul 5, 2021
@mssalvatore mssalvatore deleted the ransomware-config-ui-description branch July 29, 2021 14:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants