Client Spider Support

[JohnnyIrvin]

#!/usr/bin/env python

from zapv2 import ZAPv2
import time


target = 'http://127.0.0.1' # Change to match the target URL you want to scan
apikey = 'changeme' # Change to match the API key set in ZAP, or use None if the API key is disabled


zap = ZAPv2(apikey=apikey)

print(f'Spidering target {target}')
scanid = zap.clientSpider.scan(url=target)

while (int(zap.clientSpider.status(scanid)) < 100):
    print(f"Spider progress %: {zap.clientSpider.status(scanid)}")
    time.sleep(2)
    
print('Spider completed')

Adds the client spider to the python api.

[psiinon]

Checkmarx One – Scan Summary & Details – a4ececca-f38c-4a73-ab4a-13411bcf5c9c

Great job, no security vulnerabilities found in this Pull Request

[JohnnyIrvin]

@psiinon fixed commit signatures. no way for me to rerun job.

[kingthorin]

You need to do all of them.
Or squash it and do just one.
https://github.com/zaproxy/zap-api-python/pull/143/checks?check_run_id=43121122608

[JohnnyIrvin]

@kingthorin thank you for clarification.

should be fixed now.

any other changes required?

[JohnnyIrvin]

@kingthorin or @psiinon -- Any update? Looking to move this forward.

[thc202]

If you want to move this forward generate the implementation instead of hand write it.

[thc202]

This is unnecessary.

[JohnnyIrvin]

Why?

[thc202]

The existing examples already cover how the "scans" should be used.

[JohnnyIrvin]

Okay.

[thc202]

The changelog should be updated.

[JohnnyIrvin]

@thc202

Where is the documentation to generate it automatically?

Where should I place example usage?

[JohnnyIrvin]

The changelog should be updated.

What should it say?

[thc202]

Read https://github.com/zaproxy/zap-api-python/blob/main/CONTRIBUTING.md and https://github.com/zaproxy/zap-api-python/blob/main/CHANGELOG.md

[JohnnyIrvin]

@thc202

Unable to get the build system to build the plugin to generate the api.

Spent less time writing this simple addition then it takes to get automation tools to run.

Maybe.. Will come back later.

[JohnnyIrvin]

The changelog should be updated.

Added change log per request.

[thc202]

Superseded by #156 which has the APIs automatically generated.