https://github.com/trailofbits/censys-ruby

Ruby API client for the Censys internet-wide network-scan search engine
https://github.com/trailofbits/censys-ruby

network-scanning search-engine security-scanner

Last synced: about 1 month ago
JSON representation

Ruby API client for the Censys internet-wide network-scan search engine

• Host: GitHub
• URL: https://github.com/trailofbits/censys-ruby
• Owner: trailofbits
• License: mit
• Created: 2016-02-19T04:18:44.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2024-09-12T16:50:40.000Z (3 months ago)
• Last Synced: 2024-09-13T05:49:48.584Z (3 months ago)
• Topics: network-scanning, search-engine, security-scanner
• Language: Ruby
• Homepage:
• Size: 22.5 KB
• Stars: 9
• Watchers: 46
• Forks: 3
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: ChangeLog.md
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-ip-search-engines - Censys Ruby

README

        
# CenSys

* [Homepage](https://github.com/trailofbits/censys-ruby#readme)

* [Issues](https://github.com/trailofbits/censys-ruby/issues)

* [Documentation](http://rubydoc.info/gems/censys/frames)

## Description

Ruby API client to the [CenSys] internet search engine.

## Features

## Examples

Initialize the API:

    require 'censys'

    api = CenSys::API.new(uid,secret)

Initialize the API using `$CENSYS_ID` and `$CENSYS_SECRET` environment

variables:

    api = CenSys::API.new

Search for IPv4 addresses:

    response = api.ipv4.search(query: 'dropbox.com')

Search for Websites:

    response = api.websites.search(query: 'dropbox.com')

Search for Certificates:

    response = api.certificates.search(query: 'dropbox.com')

Enumerate through search results:

    response.each_page do |page|

      puts ">>> Page ##{page.metadata.page} / #{page.metadata.pages} ..."

      page.each do |result|

        puts result

      end

    end

Generate aggregate reports:

    response = api.websites.report(

      query: '80.http.get.headers.server: Apache',

      field: 'location.country_code',

      buckets: 100

    )

    response.each do |country,count|

      puts "#{country}: #{count}"

    end

## Requirements

* [ruby] >= 2.0

## Install

    $ gem install censys

## Copyright

Copyright (c) 2016 Hal Brodigan

See {file:LICENSE.txt} for details.

[ruby]: http://www.ruby-lang.org/

[CenSys]: https://censys.io/