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

Issue #25 Added ability to get the report filename #26

Merged
merged 12 commits into from
Sep 27, 2023

Conversation

BretMcDanel
Copy link
Contributor

When automating it may be advantageous to know with high certainty what the report filename is for further processing (eg XML -> anything).

This changes the local variable report_file_name to a class property report_file_name.

eg:
burp = Burpa( ... )
burp.scan( ... )
do_more_processing_on_report_file(burp.report_file_name)

@BretMcDanel BretMcDanel mentioned this pull request Aug 23, 2023
@tristanlatr
Copy link
Owner

Hello @BretMcDanel,

Thanks for your PR, but I think the implementation is not taking care of all edge cases. A scan can be run on several URLs, generating several report files. I think the way to handle this usage of the scan() method is to return a Report object that will contain status, metrics, issues and report filename for every scans.

Are you willing to implement such a change?

@BretMcDanel
Copy link
Contributor Author

Yeah, I can look at that.

Off the cuff, an array of objects that contain at least:

  • Url
  • report path

Do you want anything else returned? It feels superfluous to include the report contents given they are saved to a file. Minimal parsing of the response could be done, for example counting issues (which would give a positive response that no issues were found, as opposed to no report being generated). Any other ideas?

Copy link
Owner

@tristanlatr tristanlatr left a comment

Choose a reason for hiding this comment

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

Thanks, this is good but just a couple of changes would be nice

burpa/_burpa.py Outdated Show resolved Hide resolved
burpa/_burpa.py Outdated Show resolved Hide resolved
burpa/_burpa.py Outdated Show resolved Hide resolved
burpa/_burpa.py Outdated Show resolved Hide resolved
burpa/_burpa.py Outdated Show resolved Hide resolved
BretMcDanel and others added 6 commits September 25, 2023 08:56
Co-authored-by: tristanlatr <19967168+tristanlatr@users.noreply.github.com>
Co-authored-by: tristanlatr <19967168+tristanlatr@users.noreply.github.com>
Co-authored-by: tristanlatr <19967168+tristanlatr@users.noreply.github.com>
Co-authored-by: tristanlatr <19967168+tristanlatr@users.noreply.github.com>
@BretMcDanel
Copy link
Contributor Author

I believe this will resolve everything. Thanks.

@tristanlatr
Copy link
Owner

I will apply some changes to this PR and merge it when I have a moment. Probably next week.

@tristanlatr tristanlatr merged commit 45e58ee into tristanlatr:main Sep 27, 2023
1 check failed
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.

None yet

2 participants