Add campaign summary export

JCantu248 commented 3 years ago

🗣 Description

This change adds the capability to export click summaries for the campaigns in an assessment. The output of these new features are a click summary in both a text file format and a JSON file. This data consists of the number of emails sent, the number of unique users who responded, the rate of user clicks, and the total number of clicks returned.

UPDATE 8/30: Per request with @BenBreaksThings, changes were made to improve the campaign summaries. They are now no longer being called campaign click summaries, but simply campaign summaries. The fields reported have expanded to include email subject, from address, and the campaign start and end dates. Some significant refactor happened as a result and the changes will have to be reviewed.

💭 Motivation and context

The PCA team runs a script against Cobalt-Strike, called cs_phish_parse that creates this report from a series of csv input files. This script is run manually by operators, and it was requested that it gets ported to Gophish and included as part of the export process. The PCA team requested both the JSON and plain text file output of the report.

🧪 Testing

The Gophish-export command was run against multiple assessments, with campaigns that contain clicks and those that do not. The values output in the final click summary report reflected the correct number of emails sent, clicked on, and the correct number of unique users.

A test case was also written to test the function that counts the number of unique users that clicked on a campaign email.

📷 Screenshots (if appropriate)

✅ Checklist

[x] This PR has an informative and human-readable title.
[x] Changes are limited to a single goal - eschew scope creep!
[x] All future TODOs are captured in issues, which are referenced in code comments.
[x] All relevant type-of-change labels have been added.
[x] I have read the CONTRIBUTING document.
[x] These code changes follow cisagov code standards.
[x] All relevant repo and/or project documentation has been updated to reflect the changes in this PR.
[x] I have added tests to cover my changes.
[x] All new and existing tests pass.

jsf9k commented 3 years ago

LGTM.

This is outside of the scope of this PR in my opinion but something we should consider for future cleanup/improvements is to circle back and create an issue to clean up all outputs in this project. For example, where we are using logging along with print to dump to stdout and try to make it consistent. Same for any file output paths we can standardize.

Great point @nickviola! I suggest using logging everywhere. Please make an issue for this so the idea is captured and not forgotten.

nickviola commented 3 years ago

LGTM. This is outside of the scope of this PR in my opinion but something we should consider for future cleanup/improvements is to circle back and create an issue to clean up all outputs in this project. For example, where we are using logging along with print to dump to stdout and try to make it consistent. Same for any file output paths we can standardize.

Great point @nickviola! I suggest using logging everywhere. Please make an issue for this so the idea is captured and not forgotten.

👍 I agree and also prefer using logging exclusively. I will get an issue created to keep it on our radar. Thanks for the feedback @jsf9k!

dav3r commented 3 years ago

LGTM. This is outside of the scope of this PR in my opinion but something we should consider for future cleanup/improvements is to circle back and create an issue to clean up all outputs in this project. For example, where we are using logging along with print to dump to stdout and try to make it consistent. Same for any file output paths we can standardize.

Great point @nickviola! I suggest using logging everywhere. Please make an issue for this so the idea is captured and not forgotten.

👍 I agree and also prefer using logging exclusively. I will get an issue created to keep it on our radar. Thanks for the feedback @jsf9k!

To close the loop here, I just wanted to mention that @nickviola created #41 for this. 👍

dav3r commented 3 years ago

@JCantu248 - Can you please clean up this incomplete sentence in the "Testing" section above? I'm dying to know about this test case! 😃

A test case was also written to test the c

JCantu248 commented 3 years ago

@JCantu248 - Can you please clean up this incomplete sentence in the "Testing" section above? I'm dying to know about this test case! 😃

A test case was also written to test the c

Fixed!