Introduction

Caido is a lightweight web security auditing toolkit designed to assist developers and security professionals in identifying vulnerabilities within web applications. The caido-ruby library serves as a Ruby implementation of Caido's API, providing a seamless and efficient way for Ruby developers to integrate Caido's powerful security auditing capabilities into their applications.

Installation

gem install caido

Usage

require 'caido'

# Init instance
instance = Caido::Instance.new "http://localhost:8080", "AUTH_TOKEN"

# Use helper
instance.version # 0.38.0
instance.projects # [...]
instance.replay_sessions # [{"name"=>"1", "activeEntry"=> {"request"=> ... ]
instance.request(12) # {"id"=>"12", "host"=>"www.hahwul.com", "method"=>"GET", ... }

# Use GraphQL Query
instance.query('{runtime{platform}}')

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.