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

Adding "How to Test" for the WSTG Checklist [Work in Progress] #1109

Open
CristiVlad25 opened this issue Nov 14, 2023 · 17 comments
Open

Adding "How to Test" for the WSTG Checklist [Work in Progress] #1109

CristiVlad25 opened this issue Nov 14, 2023 · 17 comments
Labels
enhancement A new or improved feature for the WSTG or repo

Comments

@CristiVlad25
Copy link

The WSTG checklist is of utmost importance to penetration testers because it provides the blueprint for what to test. Its current format provides the following:

ID, Test Name, Objectives, Status, Notes.

ID, Test Name, and Objectives have been compiled from WSTG.

WSTG is a companion and reference manual that I go to often for the pentest I do for my clients. For each test, it also has a section called "How to Test" which provides a few actionables for the specific vulnerability.

I propose to include this section (as a new column) in the checklist. The new format will be:

ID, Test Name, Objectives, How to Test, Status, Notes.

I know it might be tricky because for some tests, the "How to Test" is very extensive, while for some it is very succinct. However, I take on the challenge of making a uniform "How to Test" in the checklist across all tests.

Each "How to Test" entry will be 3-5 short bullet points, as in the image below:

image

What do you all think about this?

@CristiVlad25 CristiVlad25 added the enhancement A new or improved feature for the WSTG or repo label Nov 14, 2023
@kingthorin
Copy link
Collaborator

How do you intend such bullets to be generated/extracted/added?

@CristiVlad25
Copy link
Author

CristiVlad25 commented Nov 15, 2023

How do you intend such bullets to be generated/extracted/added?

Two ways:

  • using AI to extract them. AI extracts => I review manually and approve.
  • copy-paste where possible (where the "How to Test" is short enough).

@ThunderSon
Copy link
Collaborator

That How to section is usually a light checklist inside the file itself, we kept it generic cz it's really hard in some files to not repeat content. It'll be an interesting challenge that's for sure.

Another thing to keep in mind, as changes/releases are created, we need to be able to scale accordingly. If we do it for one version, and not for another, it'll become a debt.

🤔
P.S. I'm not against it, just discussing the big points to consider.

@kingthorin
Copy link
Collaborator

kingthorin commented Nov 15, 2023

If it has to be maintained manually it won't work/scale. Checklist are generated through automation.

@CristiVlad25
Copy link
Author

Well, it would be a challenge indeed, but why not try?

@kingthorin
Copy link
Collaborator

I'm not saying don't try, I'm saying plan for it.

If we simply push an updated checklist at this point it'll get clobbered the next time an update PR is merged.

@CristiVlad25
Copy link
Author

It's discouraging. I'll probably do this for myself then.

@kingthorin
Copy link
Collaborator

You could add a Test Summary section or something that could be extracted like the Objectives are? I dunno, open to ideas.

@ThunderSon
Copy link
Collaborator

Hey @CristiVlad25. I understand it's slightly frustrating.

You mentioned how the checklist is of high importance, we're not opposing you, we need to challenge you if we want this for the long term.
As you say as well, you want to try this out. Please go ahead.

If it's a good result, I'm sure we can figure out a way to add it as an experimental piece :)

What me and @kingthorin are talking about is the scale of it with newer versions. Let's worry about that later.

Is there anything we can help you with? We'll be happy to review PRs/progress/brainstorm things.

@CristiVlad25
Copy link
Author

Let me just have a first version of it and we'll see where we can go from there.

@CristiVlad25
Copy link
Author

@kingthorin and @ThunderSon, here it is: https://docs.google.com/spreadsheets/d/1BWs_SzkO7al59gSwZHFh3ISvK9zO4kEN/edit

Let me know your thoughts.

@ThunderSon
Copy link
Collaborator

I like the initial results. I still need to review more of it to ensure what's written is good with the test itself :)
Thank you for doing it!

@CristiVlad25
Copy link
Author

Thanks @ThunderSon!

@kingthorin
Copy link
Collaborator

Sorry I haven’t gotten to this yet, it hasn’t been forgotten.

@rejahrehim
Copy link
Member

@ThunderSon @kingthorin

What about keeping this 'How to test' data as files inside the checklist folder ? We could update the script to accommodate that during build ?

@kingthorin
Copy link
Collaborator

It's definitely an option, but I'd worry about it getting out of sync with the actual content.

I'm willing to be convinced that it can/will work.

@CristiVlad25
Copy link
Author

CristiVlad25 commented Dec 4, 2023 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement A new or improved feature for the WSTG or repo
Projects
None yet
Development

No branches or pull requests

4 participants