zaproxy-ruby

A Ruby Implementation and Library for Easy Utilization of ZAP API.

require 'zaproxy'

instance = ZAPv2.new(endpoint: 'http://localhost:8090')

instance.core.sites
# <Result:0x0000000105eef830
# @message="{\"sites\":[\"https://www.hahwul.com\",\"https://github.com\"]}",
# @object={"sites"=>["https://www.hahwul.com", "https://github.com"]},
# @success=true>

instance.spider.scan('https://www.hahwul.com','','','','')
# <Result:0x0000000105f01738 @message="{\"scan\":\"0\"}", @object={"scan"=>"0"}, @success=true>

Getting started

The zaproxy gem provides Ruby bindings to the ZAP(Zed Attack Proxy) tool, allowing you to automate security testing and scanning of web applications. You can install the gem using either gem or bundler.

Gem

gem install zaproxy

Bundler

If you are managing dependencies with Bundler, you can add the zaproxy gem to your project's Gemfile and then use Bundler to install it.

Create a Gemfile in your project directory. and Open the Gemfile and add the following line to specify the zaproxy gem

# Gemfile
gem 'zaproxy'

In your terminal, navigate to your project directory and run the following command to install the gem and its dependencies using Bundler

bundle install

Documents

• RubyDocs