https://github.com/mitre/cyber-trackr-live
OpenAPI specification and Ruby client for cyber.trackr.live API
https://github.com/mitre/cyber-trackr-live
api disa disa-cci disa-stig mitre mitre-saf openapi openapi3
Last synced: 3 months ago
JSON representation
OpenAPI specification and Ruby client for cyber.trackr.live API
- Host: GitHub
- URL: https://github.com/mitre/cyber-trackr-live
- Owner: mitre
- License: other
- Created: 2025-07-14T23:29:01.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-07-16T21:16:35.000Z (3 months ago)
- Last Synced: 2025-07-17T11:33:46.558Z (3 months ago)
- Topics: api, disa, disa-cci, disa-stig, mitre, mitre-saf, openapi, openapi3
- Language: Ruby
- Homepage: https://mitre.github.io/cyber-trackr-live/
- Size: 311 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README-GEM.md
- Changelog: CHANGELOG-GEM.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# cyber_trackr_live
Ruby client for the cyber.trackr.live API - Access DISA STIGs, SRGs, RMF controls, CCIs, and SCAP data.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'cyber_trackr_live'
```
And then execute:
$ bundle install
Or install it yourself as:
$ gem install cyber_trackr_live
## Usage
### Basic Usage
```ruby
require 'cyber_trackr_helper'
# Initialize the helper client
client = CyberTrackrHelper::Client.new
# List all STIGs
stigs = client.list_stigs
stigs.each do |name, versions|
puts "#{name}: #{versions.first.version}R#{versions.first.release}"
end
# Fetch a complete STIG with all requirements
stig = client.fetch_complete_stig('Juniper_SRX_Services_Gateway_ALG', '3', '3')
puts "#{stig[:title]} has #{stig[:requirements].count} requirements"
# Search for documents
results = client.search_documents('firewall')
```
### Direct API Client Usage
```ruby
require 'cyber_trackr_client'
# Configure the client
CyberTrackrClient.configure do |config|
config.host = 'cyber.trackr.live'
config.base_path = '/api'
end
# Use the API directly
api = CyberTrackrClient::DocumentsApi.new
documents = api.list_all_documents
```
## API Documentation
Full API documentation is available at: https://mitre.github.io/cyber-trackr-live/
## Features
- Full access to cyber.trackr.live API
- Helper methods for common workflows
- Automatic retry and error handling
- Progress callbacks for long operations
- Type-safe Ruby objects
## License
The gem is available as open source under the terms of the [Apache-2.0 License](https://opensource.org/licenses/Apache-2.0).