bnvd_client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b028965b9d29e0565fbce0895a43c80e043d0a8ba5c4e4d0333d1982190e7482
+  data.tar.gz: cbed124aef817b2b440a10c1f3a63e782dac06a3387522c39d9758dc1e288d2a
+SHA512:
+  metadata.gz: f7434ce1a4621a9630676751a7d6e0250f1e29f2128403d2459ebfc8c42dd96a709dd0090912d539db51bea20d733f1d992d95c1f243b619a6d704f101f4cede
+  data.tar.gz: 723baf902b93182b943d6e6f56eb90d5f63093c5f07a7669ea8d9049f5398da09cd3566a536e80535b577618dfbee7eec18267c53f1d7739d22bee194cb70c37

data/README.md

@@ -0,0 +1,125 @@
+# BNVD API Client - Ruby
+
+Cliente oficial em Ruby para a API do Banco Nacional de Vulnerabilidades Cibernéticas (BNVD).
+
+## Instalação
+
+Adicione ao seu Gemfile:
+
+```ruby
+gem 'bnvd_client'
+```
+
+Ou instale diretamente:
+
+```bash
+gem install bnvd_client
+```
+
+## Uso
+
+```ruby
+require 'bnvd_client'
+
+# Configurar cliente (URL padrão: https://bnvd.org/api/v1)
+client = BNVD::Client.new(BNVD::Config.new)
+
+# Ou com configuração customizada
+# config = BNVD::Config.new(
+#   base_url: 'https://bnvd.org/api/v1',
+#   timeout: 30
+# )
+# client = BNVD::Client.new(config)
+
+# Listar vulnerabilidades
+result = client.list_vulnerabilities(
+  BNVD::SearchParams.new(
+    page: 1,
+    per_page: 20,
+    include_pt: true
+  )
+)
+
+if result.success?
+  puts "Total: #{result.pagination['total']}"
+  result.data.each do |vuln|
+    puts vuln['cve']['id']
+  end
+end
+
+# Buscar vulnerabilidade específica
+vuln = client.get_vulnerability('CVE-2024-12345')
+
+# Buscar por ano
+vulns_2024 = client.search_by_year(2024)
+
+# Buscar por severidade
+critical = client.search_by_severity(BNVD::Severity::CRITICAL)
+
+# Buscar vulnerabilidades recentes
+recent = client.get_recent_vulnerabilities(
+  BNVD::RecentSearchParams.new(days: 7)
+)
+
+# Obter estatísticas
+stats = client.get_stats
+puts "Total de vulnerabilidades: #{stats.data['total_vulnerabilities']}"
+```
+
+## Métodos Disponíveis
+
+### Informações da API
+- `get_api_info()` - Retorna informações sobre a API
+
+### Vulnerabilidades
+- `list_vulnerabilities(params)` - Lista todas as vulnerabilidades
+- `get_vulnerability(cve_id, include_pt)` - Busca vulnerabilidade específica
+- `get_recent_vulnerabilities(params)` - Vulnerabilidades recentes
+- `get_top5_recent(include_pt)` - Top 5 mais recentes
+- `search_by_year(year, params)` - Busca por ano
+- `search_by_severity(severity, params)` - Busca por severidade
+- `search_by_vendor(vendor, params)` - Busca por fabricante
+
+### Estatísticas
+- `get_stats()` - Estatísticas gerais
+- `get_year_stats()` - Estatísticas por ano
+
+### Notícias
+- `list_noticias(params)` - Lista todas as notícias
+- `get_recent_noticias(limit)` - Notícias recentes
+- `get_noticia_by_slug(slug)` - Busca notícia por slug
+
+### MITRE ATT&CK
+- `get_mitre_info()` - Informações sobre o sistema MITRE
+- `list_mitre_matrices()` - Lista matrizes disponíveis
+- `get_mitre_matrix(name, include_pt)` - Retorna matriz específica
+- `list_mitre_techniques(params)` - Lista técnicas
+- `get_mitre_technique(id, include_pt)` - Detalhes de técnica
+- `list_mitre_subtechniques(params)` - Lista subtécnicas
+- `list_mitre_groups(params)` - Lista grupos de ameaças
+- `get_mitre_group(id, include_pt)` - Detalhes de grupo
+- `list_mitre_mitigations(params)` - Lista mitigações
+- `get_mitre_mitigation(id, include_pt)` - Detalhes de mitigação
+
+## Níveis de Severidade
+
+```ruby
+BNVD::Severity::LOW       # Baixa
+BNVD::Severity::MEDIUM    # Média
+BNVD::Severity::HIGH      # Alta
+BNVD::Severity::CRITICAL  # Crítica
+```
+
+## Tratamento de Erros
+
+```ruby
+begin
+  result = client.get_vulnerability('CVE-INVALID')
+rescue => e
+  puts "Erro: #{e.message}"
+end
+```
+
+## Licença
+
+MIT

data/lib/bnvd_client.rb

@@ -0,0 +1,263 @@
+# frozen_string_literal: true
+
+# BNVD API Client - Ruby
+# Cliente oficial para a API do Banco Nacional de Vulnerabilidades Cibernéticas
+# @version 1.0.0
+
+require 'net/http'
+require 'json'
+require 'uri'
+
+module BNVD
+  # Níveis de severidade CVSS
+  module Severity
+    LOW = 'LOW'
+    MEDIUM = 'MEDIUM'
+    HIGH = 'HIGH'
+    CRITICAL = 'CRITICAL'
+  end
+
+  # Configuração do cliente
+  class Config
+    attr_accessor :base_url, :timeout, :headers
+
+    def initialize(base_url: 'https://bnvd.org/api/v1', timeout: 30, headers: {})
+      @base_url = base_url
+      @timeout = timeout
+      @headers = {
+        'Content-Type' => 'application/json'
+      }.merge(headers)
+    end
+  end
+
+  # Parâmetros de paginação
+  class PaginationParams
+    attr_accessor :page, :per_page
+
+    def initialize(page: nil, per_page: nil)
+      @page = page
+      @per_page = per_page
+    end
+
+    def to_query_params
+      params = {}
+      params['page'] = @page.to_s if @page
+      params['per_page'] = @per_page.to_s if @per_page
+      params
+    end
+  end
+
+  # Parâmetros de busca
+  class SearchParams < PaginationParams
+    attr_accessor :year, :severity, :vendor, :include_pt
+
+    def initialize(page: nil, per_page: nil, year: nil, severity: nil, vendor: nil, include_pt: true)
+      super(page: page, per_page: per_page)
+      @year = year
+      @severity = severity
+      @vendor = vendor
+      @include_pt = include_pt
+    end
+
+    def to_query_params
+      params = super
+      params['year'] = @year.to_s if @year
+      params['severity'] = @severity if @severity
+      params['vendor'] = @vendor if @vendor
+      params['include_pt'] = @include_pt.to_s if @include_pt
+      params
+    end
+  end
+
+  # Parâmetros de busca recente
+  class RecentSearchParams < PaginationParams
+    attr_accessor :days, :include_pt
+
+    def initialize(page: nil, per_page: nil, days: nil, include_pt: true)
+      super(page: page, per_page: per_page)
+      @days = days
+      @include_pt = include_pt
+    end
+
+    def to_query_params
+      params = super
+      params['days'] = @days.to_s if @days
+      params['include_pt'] = @include_pt.to_s if @include_pt
+      params
+    end
+  end
+
+  # Resposta da API
+  class APIResponse
+    attr_reader :status, :data, :message, :pagination
+
+    def initialize(json)
+      @status = json['status']
+      @data = json['data']
+      @message = json['message']
+      @pagination = json['pagination']
+    end
+
+    def success?
+      @status == 'success'
+    end
+
+    def error?
+      @status == 'error'
+    end
+  end
+
+  # Cliente da API BNVD
+  class Client
+    def initialize(config)
+      @config = config
+    end
+
+    # Faz requisição HTTP para a API
+    def request(endpoint, params = {})
+      uri = URI.parse(@config.base_url + endpoint)
+      uri.query = URI.encode_www_form(params) unless params.empty?
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme == 'https'
+      http.read_timeout = @config.timeout
+
+      request = Net::HTTP::Get.new(uri.request_uri)
+      @config.headers.each { |key, value| request[key] = value }
+
+      response = http.request(request)
+
+      case response
+      when Net::HTTPSuccess
+        APIResponse.new(JSON.parse(response.body))
+      else
+        raise "HTTP Error: #{response.code} #{response.message}"
+      end
+    end
+
+    # Retorna informações sobre a API
+    def get_api_info
+      request('/api/v1/')
+    end
+
+    # Lista todas as vulnerabilidades com suporte a paginação e filtros
+    def list_vulnerabilities(params = SearchParams.new)
+      query_params = params.is_a?(SearchParams) ? params.to_query_params : params
+      request('/api/v1/vulnerabilities', query_params)
+    end
+
+    # Busca uma vulnerabilidade específica pelo CVE ID
+    def get_vulnerability(cve_id, include_pt: true)
+      request("/api/v1/vulnerabilities/#{cve_id}", { include_pt: include_pt })
+    end
+
+    # Busca vulnerabilidades recentes
+    def get_recent_vulnerabilities(params = RecentSearchParams.new)
+      query_params = params.is_a?(RecentSearchParams) ? params.to_query_params : params
+      request('/api/v1/search/recent', query_params)
+    end
+
+    # Retorna as 5 vulnerabilidades mais recentes
+    def get_top5_recent(include_pt: true)
+      request('/api/v1/search/recent/5', { include_pt: include_pt })
+    end
+
+    # Busca vulnerabilidades por ano
+    def search_by_year(year, params = PaginationParams.new)
+      query_params = params.is_a?(PaginationParams) ? params.to_query_params : params
+      request("/api/v1/search/year/#{year}", query_params)
+    end
+
+    # Busca vulnerabilidades por severidade
+    def search_by_severity(severity, params = PaginationParams.new)
+      query_params = params.is_a?(PaginationParams) ? params.to_query_params : params
+      request("/api/v1/search/severity/#{severity}", query_params)
+    end
+
+    # Busca vulnerabilidades por vendor/fabricante
+    def search_by_vendor(vendor, params = PaginationParams.new)
+      query_params = params.is_a?(PaginationParams) ? params.to_query_params : params
+      request("/api/v1/search/vendor/#{vendor}", query_params)
+    end
+
+    # Retorna estatísticas gerais
+    def get_stats
+      request('/api/v1/stats')
+    end
+
+    # Retorna estatísticas por ano
+    def get_year_stats
+      request('/api/v1/stats/years')
+    end
+
+    # === Notícias ===
+
+    # Lista todas as notícias
+    def list_noticias(params = PaginationParams.new)
+      query_params = params.is_a?(PaginationParams) ? params.to_query_params : params
+      request('/api/v1/noticias', query_params)
+    end
+
+    # Retorna notícias recentes
+    def get_recent_noticias(limit = 5)
+      request("/api/v1/noticias/recentes/#{limit}")
+    end
+
+    # Busca notícia por slug
+    def get_noticia_by_slug(slug)
+      request("/api/v1/noticias/#{slug}")
+    end
+
+    # === MITRE ATT&CK ===
+
+    # Retorna informações sobre o sistema MITRE ATT&CK
+    def get_mitre_info
+      request('/api/v1/mitre')
+    end
+
+    # Lista todas as matrizes MITRE ATT&CK disponíveis
+    def list_mitre_matrices
+      request('/api/v1/mitre/matrices')
+    end
+
+    # Retorna uma matriz específica
+    def get_mitre_matrix(matrix_name, include_pt = true)
+      request("/api/v1/mitre/matrix/#{matrix_name}", { include_pt: include_pt })
+    end
+
+    # Lista todas as técnicas MITRE ATT&CK
+    def list_mitre_techniques(params = {})
+      request('/api/v1/mitre/techniques', params)
+    end
+
+    # Retorna detalhes de uma técnica específica
+    def get_mitre_technique(technique_id, include_pt = true)
+      request("/api/v1/mitre/technique/#{technique_id}", { include_pt: include_pt })
+    end
+
+    # Lista todas as subtécnicas MITRE ATT&CK
+    def list_mitre_subtechniques(params = {})
+      request('/api/v1/mitre/subtechniques', params)
+    end
+
+    # Lista todos os grupos de ameaças MITRE ATT&CK
+    def list_mitre_groups(params = {})
+      request('/api/v1/mitre/groups', params)
+    end
+
+    # Retorna detalhes de um grupo específico
+    def get_mitre_group(group_id, include_pt = true)
+      request("/api/v1/mitre/group/#{group_id}", { include_pt: include_pt })
+    end
+
+    # Lista todas as mitigações MITRE ATT&CK
+    def list_mitre_mitigations(params = {})
+      request('/api/v1/mitre/mitigations', params)
+    end
+
+    # Retorna detalhes de uma mitigação específica
+    def get_mitre_mitigation(mitigation_id, include_pt = true)
+      request("/api/v1/mitre/mitigation/#{mitigation_id}", { include_pt: include_pt })
+    end
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: bnvd_client
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- BNVD Team
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+description: Cliente Ruby para a API do Banco Nacional de Vulnerabilidades Cibernéticas
+  (BNVD)
+email:
+- contato@bnvd.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/bnvd_client.rb
+homepage: https://bnvd.org
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://bnvd.org
+  source_code_uri: https://github.com/azurejoga/bnvd/tree/main/api_clients/ruby
+  changelog_uri: https://github.com/azurejoga/bnvd/tree/main/api_clients/ruby/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Cliente oficial para a API do BNVD
+test_files: []