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.

Sign up for GitHub

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

Jump to bottom

Improve Documentation for ZAP Automation Framework ScanType #1902

Open
Weltraumschaf opened this issue Aug 7, 2023 · 3 comments · May be fixed by #2387
Open

Improve Documentation for ZAP Automation Framework ScanType #1902

Weltraumschaf opened this issue Aug 7, 2023 · 3 comments · May be fixed by #2387
Assignees
@Ilyesbdlala
Labels
breaking Changes requiring a major release documentation Improvements or additions to documentation enhancement New feature or request

Comments

@Weltraumschaf
Copy link
Member

Weltraumschaf commented Aug 7, 2023 •
edited

We want the same level of documentation like we have for ZAP advanced:

  • Examples
  • Migration from ZAP Advanced
@Weltraumschaf Weltraumschaf mentioned this issue Aug 7, 2023
Closed
@J12934
Copy link
Member

J12934 commented Sep 1, 2023

Related blog (non published) post: https://github.com/secureCodeBox/documentation/blob/main/blog/2022-08-03-automate-zap-with-authentication.md

@Weltraumschaf
Copy link
Member Author

Related PR from @malexmave secureCodeBox/documentation#348

@Weltraumschaf Weltraumschaf transferred this issue from secureCodeBox/documentation Sep 6, 2023
@J12934 J12934 changed the title ZAP Automation Framework Imporve Documentation for ZAP Automation Framework ScanType Feb 9, 2024
@Weltraumschaf
Copy link
Member Author

  • Rename scan type: "zap-automation-scan" -> scanType: "zap-automation-framwork"
  • Add deprecation hint to page "ZAP" and "ZAP Advanced"
  • Add new Page "Zap Atutomation Framweork"
    • Adapt the documentation from deprectaed sites to ZAP Autmation Framework.

@Weltraumschaf Weltraumschaf added breaking Changes requiring a major release documentation Improvements or additions to documentation enhancement New feature or request labels Feb 9, 2024
@J12934 J12934 changed the title Imporve Documentation for ZAP Automation Framework ScanType Improve Documentation for ZAP Automation Framework ScanType Feb 9, 2024
@Ilyesbdlala Ilyesbdlala self-assigned this Feb 13, 2024
Ilyesbdlala added a commit that referenced this issue Mar 19, 2024
@Ilyesbdlala
#1902 basic copy of zap scanner folder renamed to zap-automation-fram…
f789735 
…ework

Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
Ilyesbdlala added a commit that referenced this issue Mar 19, 2024
@Ilyesbdlala
#1902 Add deprecation notice to zap and zap-advanced
f03ee63 
Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
Ilyesbdlala added a commit that referenced this issue Mar 19, 2024
@Ilyesbdlala
#1902 Added generated docs
15a0cde 
Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
Ilyesbdlala added a commit that referenced this issue Mar 19, 2024
@Ilyesbdlala
#1902 Add zap-automation-framework to ci and release-build
3b6b842 
Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
Ilyesbdlala added a commit that referenced this issue Mar 19, 2024
@Ilyesbdlala
#1902 Include zap-automation-framework in telemetry and persistence-…
f51fafe 
…defectdojo

Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
Ilyesbdlala added a commit that referenced this issue Mar 19, 2024
@Ilyesbdlala
#1902 remove irrelevant examples to zap-automation-framework
ca1d473 
Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
Ilyesbdlala added a commit that referenced this issue Mar 19, 2024
@Ilyesbdlala
#1902 re-generated updated zap and zap-advanced docs
78c9fdd 
Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
Ilyesbdlala added a commit that referenced this issue Mar 19, 2024
@Ilyesbdlala
#1902 Rename helm chart and parser name of ZAP-Automation-Framework
02bf1d1 
Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
Ilyesbdlala added a commit that referenced this issue Mar 19, 2024
@Ilyesbdlala
#1902 Include a configmap template that includes all possible zap-aut…
ab26ec3 
…omation-framework config options

Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
Ilyesbdlala added a commit that referenced this issue Mar 19, 2024
@Ilyesbdlala
#1902 Leave only zap-automation-framework scantype
8468d38 
Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
Ilyesbdlala added a commit that referenced this issue Mar 19, 2024
@Ilyesbdlala
#1902 Include a zap-baseline config to use in zap-automation-framework
4c3fccb 
Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
Ilyesbdlala added a commit that referenced this issue Apr 9, 2024
@Ilyesbdlala
#1902 basic copy of zap scanner folder renamed to zap-automation-fram…
fbd49fa 
…ework

Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
Ilyesbdlala added a commit that referenced this issue Apr 9, 2024
@Ilyesbdlala
#1902 Add deprecation notice to zap and zap-advanced
ce422a8 
Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
Ilyesbdlala added a commit that referenced this issue Apr 9, 2024
@Ilyesbdlala
#1902 Added generated docs
348c0ce 
Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
Ilyesbdlala added a commit that referenced this issue Apr 9, 2024
@Ilyesbdlala
#1902 Add zap-automation-framework to ci and release-build
afa1d4b 
Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
Ilyesbdlala added a commit that referenced this issue Apr 9, 2024
@Ilyesbdlala
#1902 Include zap-automation-framework in telemetry and persistence-…
8c10c79 
…defectdojo

Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
Ilyesbdlala added a commit that referenced this issue Apr 9, 2024
@Ilyesbdlala
#1902 remove irrelevant examples to zap-automation-framework
0ff05c8 
Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
Ilyesbdlala added a commit that referenced this issue Apr 9, 2024
@Ilyesbdlala
#1902 re-generated updated zap and zap-advanced docs
a032622 
Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
Ilyesbdlala added a commit that referenced this issue Apr 9, 2024
@Ilyesbdlala
#1902 Rename helm chart and parser name of ZAP-Automation-Framework
b42ed21 
Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
Ilyesbdlala added a commit that referenced this issue Apr 9, 2024
@Ilyesbdlala
#1902 Renamed integration tests for zap-automation-framework
06d5935 
Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
Ilyesbdlala added a commit that referenced this issue Apr 9, 2024
@Ilyesbdlala
#1902 Added zap-automation-framework scan examples
036c4c3 
Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
Ilyesbdlala added a commit that referenced this issue Apr 9, 2024
@Ilyesbdlala
#1902 Add documentation on how to migrate from zap and zap-advanced t…
6dde524 
…o zap automation framework

Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
Ilyesbdlala added a commit that referenced this issue Apr 9, 2024
@Ilyesbdlala
#1902 Regenerated docs
141701d 
Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
@Ilyesbdlala Ilyesbdlala linked a pull request Apr 9, 2024 that will close this issue
Open
4 tasks
Ilyesbdlala added a commit that referenced this issue Apr 9, 2024
@Ilyesbdlala
#1902 Updated zap-automation-framework helm-unittest snapshot
34c05c7 
Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
Ilyesbdlala added a commit that referenced this issue Apr 9, 2024
@Ilyesbdlala
#1902 Replaced all occurences of OWASP ZAP to ZAP
997c442 
This is due to ZAP no longer being part of OWASP

Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
Ilyesbdlala added a commit that referenced this issue Apr 9, 2024
@Ilyesbdlala
#1902 Removed configmap names prefix in zap-automation-framework
109e423 
It is no longer needed
Co-authored-by:  Jannik Hollenbach <jannik.hollenbach@iteratec.com>

Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
Ilyesbdlala added a commit that referenced this issue Apr 9, 2024
@Ilyesbdlala @J12934
#1902 Improve deprecation notice wording
350a03a 
Co-authored-by: Jannik Hollenbach <jannik.hollenbach@iteratec.com>
Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
Ilyesbdlala added a commit that referenced this issue May 8, 2024
@Ilyesbdlala
#1902 basic copy of zap scanner folder renamed to zap-automation-fram…
6eda4c4 
…ework

Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
Ilyesbdlala added a commit that referenced this issue May 8, 2024
@Ilyesbdlala
#1902 Add deprecation notice to zap and zap-advanced
9344741 
Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
Ilyesbdlala added a commit that referenced this issue May 8, 2024
@Ilyesbdlala
#1902 Add zap-automation-framework to ci and release-build
0ac76c9 
Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
Ilyesbdlala added a commit that referenced this issue May 8, 2024
@Ilyesbdlala
#1902 Include zap-automation-framework in telemetry and persistence-…
413550e 
…defectdojo

Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
Ilyesbdlala added a commit that referenced this issue May 8, 2024
@Ilyesbdlala
#1902 remove irrelevant examples to zap-automation-framework
3f7abbc 
Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
Ilyesbdlala added a commit that referenced this issue May 8, 2024
@Ilyesbdlala
#1902 re-generated updated zap and zap-advanced docs
fa892d8 
Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
Ilyesbdlala added a commit that referenced this issue May 8, 2024
@Ilyesbdlala
#1902 Rename helm chart and parser name of ZAP-Automation-Framework
b5022ef 
Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
Ilyesbdlala added a commit that referenced this issue May 8, 2024
@Ilyesbdlala
#1902 Include a configmap template that includes all possible zap-aut…
db7ad4a 
…omation-framework config options

Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
Ilyesbdlala added a commit that referenced this issue May 8, 2024
@Ilyesbdlala
#1902 Leave only zap-automation-framework scantype
ebd78e8 
Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
Ilyesbdlala added a commit that referenced this issue May 8, 2024
@Ilyesbdlala
#1902 Include a zap-baseline config to use in zap-automation-framework
2bce5c9 
Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
Ilyesbdlala added a commit that referenced this issue May 8, 2024
@Ilyesbdlala
#1902 Update package name for parser-zap to parser-zap-automation-fra…
99aab1e 
…mework

Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
Ilyesbdlala added a commit that referenced this issue May 8, 2024
@Ilyesbdlala
#1902 Update parser image in Makefile to use own parser
3092ed9 
Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
Ilyesbdlala added a commit that referenced this issue May 8, 2024
@Ilyesbdlala
#1902 Renamed integration tests for zap-automation-framework
44c82a3 
Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
Ilyesbdlala added a commit that referenced this issue May 8, 2024
@Ilyesbdlala
#1902 Added zap-automation-framework scan examples
d2d2e33 
Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
Ilyesbdlala added a commit that referenced this issue May 8, 2024
@Ilyesbdlala
#1902 Add documentation on how to migrate from zap and zap-advanced t…
9eb8f45 
…o zap automation framework

Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
Ilyesbdlala added a commit that referenced this issue May 8, 2024
@Ilyesbdlala
#1902 Regenerated docs
4740643 
Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
Ilyesbdlala added a commit that referenced this issue May 8, 2024
@Ilyesbdlala
#1902 Updated zap-automation-framework helm-unittest snapshot
c13dd4d 
Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
Ilyesbdlala added a commit that referenced this issue May 8, 2024
@Ilyesbdlala
#1902 Replaced all occurences of OWASP ZAP to ZAP
938fa52 
 This is due to ZAP no longer being part of OWASP

Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
Ilyesbdlala added a commit that referenced this issue May 8, 2024
@Ilyesbdlala
#1902 Removed configmap names prefix in zap-automation-framework
da8fcb0 
It is no longer needed
Co-authored-by:  Jannik Hollenbach <jannik.hollenbach@iteratec.com>

Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
Ilyesbdlala added a commit that referenced this issue May 8, 2024
@Ilyesbdlala @J12934
#1902 Improve deprecation notice wording
d4e7f35 
Co-authored-by: Jannik Hollenbach <jannik.hollenbach@iteratec.com>
Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
Ilyesbdlala added a commit that referenced this issue May 8, 2024
@Ilyesbdlala
#1902 regenerated helm docs after merge conflict resolve
8cc34ca 
Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Ilyesbdlala Ilyesbdlala

Labels
breaking Changes requiring a major release documentation Improvements or additions to documentation enhancement New feature or request
Projects
secureCodeBox v4
Status: In Progress
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Migrate to ZAP Automation Framework secureCodeBox/secureCodeBox
3 participants
@Weltraumschaf @J12934 @Ilyesbdlala