Project

daino

0.0
No release in over 3 years
Low commit activity in last 3 years
dainoninoseki/dainoHomepageDocumentationSource CodeBug TrackerWiki
A dead simple Cortex API wrapper for Ruby.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
2,845
Stars
1
Forks
1
Watchers
3
 Releases
Current version
0.1.0
Total releases
1
First release
2019-06-09
Latest release
2019-06-09
 Pull Requests
Open Pull Requests
1
Closed Pull Requests
0
Merged Pull Requests
4
Pull Request Acceptance Rate
80%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2019-09-01
Reverse Dependencies
0

 Dependencies

Development

bundler
~> 2.0
coveralls
~> 0.8
rake
~> 12.3
rspec
~> 3.8
vcr
~> 5.0
webmock
~> 3.6
 Project Readme

daino

Gem Version Build Status CodeFactor Coverage Status

daino(大脳) is a dead simple Cortex API wrapper for Ruby.

Installation

gem install daino

Usage

require "daino"

# when given nothing, it tries to load your API key from ENV["CORTEX_API_KEY"] & API endpoint from ENV["CORTEX_API_ENDPOINT"]
api = Daino::API.new
# or you can set them manually
api = Daino::API.new(api_endpoint: "http://your_api_endpoint", api_key: "yoru_api_key")

# search jobs
jobs = api.job.search(data: "1.1.1.1", data_type: "ip")

jobs.each do |job|
  id = job.dig("id")
  next unless id

  # get a report of a job
  report = api.job.report(id)
  puts JSON.pretty_generate(report)
end

Implemented methods

Analyzer

HTTP Method URI Action API method
GET /api/analyzer List analyzers #api.analyzer.list
POST /api/analyzer/_search Search analyzers #api.analyzer.search(attributes)
GET /api/analyzer/:analyzerId Get an analyzer #api.analyzer.get_by_id(id)
GET /api/analyzer/:analyzerId Get an analyzer #api.analyzer.get_by_id(id) or #api.analyzer.get_by_name(name)
GET /api/analyzer/type/:dataType Get analyzers by type #api.analyzer.get_by_type(type)
POST /api/analyzer/:analyzerId/run Run an analyzer #api.analyzer.run_by_id(id, data:, data_type:, tlp: 0, message: nil, parameters: nil, force: nil) or #api.analyzer.run_by_name(name, data:, data_type:, tlp: 0, message: nil, parameters: nil, force: nil)

Job

HTTP Method URI Action API method
POST /api/job/_search Search jobs #api.job.search(range: "all")
GET /api/job/:jobId Get a job by id #api.job.get_by_id(id)
GET /api/job/:jobId/report Get a report of a job #api.job.report(id)
GET /api/job/:jobID/artifacts Get artifacts of a job #api.job.artifacts(id)
DELETE /api/job/:jobId Delete a job #api.job.delete_by_id(id)

Organization

HTTP Method URI Action API method
GET /api/organization List organizations #api.organization.list
POST /api/organization/_search Search organizations #api.organization.search(attributes)
GET /api/organization/:organizationId Get an organization #api.organization.get_by_id(id)
GET /api/organization/:organizationId/user Get users of an organization #api.organization.users(id)
POST /api/organization Create an organization #api.organization.create(name:, description:, status: "Active")
DELETE /api/organization/:organizationId Delete an organization #api.organization.delete_by_id(id)

User

HTTP Method URI Action API method
GET /api/user List users #api.user.list
POST /api/user/_search Search users #api.user.search(attributes)
GET /api/user/:userName Get a user #api.user.get_by_name(name)
POST /api/user Create a user #api.user.create(name:, roles:, organization:, login:, status: "Ok")

License

The gem is available as open source under the terms of the MIT License.