ruby-taxii2 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc528f87e1d77992648872b73b304cadd0770fcd61104a013b968da7c6db8712
-  data.tar.gz: d84191bbf3ef2aa98e43e6ab76c73e63f277387141bd406f5ee670b6a1c1b879
+  metadata.gz: 59094f4d94c54c1468ac70bb38ed293f0d7faa99b4626d409742060c48b0bd74
+  data.tar.gz: c7d004ebbb8774848c1874db3ebc93f4f27eccc5662193d9ed5c0e2cb3872c40
 SHA512:
-  metadata.gz: ca13340ef9443169c8aafba8ee2181398eb1c26c8544c463508236d717ea1697eec8627fc23b6f34391356bd6816f71eee28c50aea2ea06b8a259b4d3f36a6ac
-  data.tar.gz: eaee116e0eb3ddae02329cd3c6287b81ad00bf80bb7ac3afb961fd5dcda7f2d53ceb0927230b041f38e43fce2c227cdd2ede6b9189376d69879dd8648276f4fb
+  metadata.gz: 325da7bd11690bf0837a17809526cd051c3482dbae094af1740b2561b0a5492809ea51ff093f568d63eba48a196eb363b5d56491b50bdde7de2a025f2a852d0b
+  data.tar.gz: 7ab0a2f04941f2884c9c5a3100b4991f414b37e84f3a6d6aaf1733d3ccaeafe2f9399a54cbfc1e80e42f9eea670db8695ec740d854310ad02b90cd7408cd11b6

data/.github/workflows/rspec.yml

@@ -7,12 +7,18 @@ on:
 jobs:
   build:
     name: RSpec
-    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+        ruby: ['2.7', '3.0', '3.1', head]
+    runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v3
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3.1.2
+        ruby-version: ${{ matrix.ruby }}
+        bundler: latest
     - run: bundle
     - run: bundle exec rspec
+    - run: bundle exec gem build

data/.gitignore

@@ -10,3 +10,4 @@
 /spec/fixtures/spec_ca/
 /tmp/
 /vendor/bundle/
+*.gem

data/README.md

@@ -9,7 +9,7 @@ Currently under development - likely to break at a moment's notice.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'ruby-taxii'
+gem 'ruby-taxii2'
 ```
 
 And then execute:
@@ -18,14 +18,49 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install ruby-taxii
+    $ gem install ruby-taxii2
 
 ## Usage
 
+```ruby
+require 'taxii'
+
+# You can use a json file configuration
+# client = Taxii::configure(config: 'my.config.json')
+# or a direct configuration
+client = Taxii::configure(user: 'user', pass: 'pass', url: 'url')
+collections = client.discover_collections
+
+# List collections (name, type and availability)
+puts "Listing collections:"
+collections.each do |collection|
+  puts "#{collection['@collection_name']} #{collection['@collection_type']} #{collection['@available']}"
+end
+
+# Pick up the first available collection
+collection_name = collections.find{ |collection| collection['@available'] == 'true' }['@collection_name']
+
+puts "Retrieving data for collection: #{collection_name}"
+poll_request_message = Taxii::Messages::PollRequest.new(
+  collection_name: collection_name,
+  poll_parameters: Taxii::Messages::Parameters::Poll.new(response_type: 'FULL')
+)
+
+client.get_content_blocks(poll_request_message).each do |message|
+  begin
+    # Try to parse the response as a Content_Block
+    pp Taxii::Messages::ContentBlock.new(message)
+    # You can also convert it to json
+    # pp Taxii::Messages::ContentBlock.new(message).as_json
+  rescue
+    puts 'This is not a ContentBlock'
+  end
+end
+```
 
 ## Development
 
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/ryanbreed/ruby-taxii.
+Bug reports and pull requests are welcome on GitHub at https://github.com/crondaemon/ruby-taxii2.

data/lib/taxii/client.rb

@@ -14,7 +14,7 @@ module Taxii
       end
     end
 
-    def build_request(url: self.url,payload: {}, format: Taxii::Messages::TAXII_11_HEADERS)
+    def build_request(url: self.url, payload: {}, format: Taxii::Messages::TAXII_11_HEADERS)
       RestClient::Request.new(
         method:   :post,
         url:      url,
@@ -33,7 +33,7 @@ module Taxii
 
     def get_service_address(service_name)
       service = discover_services.find do |svc|
-        svc['@service_type']==service_name && svc['@available']=='true'
+        svc['@service_type'] == service_name && svc['@available'] == 'true'
       end
       service.nil? ? nil : service['Address']
     end
@@ -61,11 +61,18 @@ module Taxii
       @poll_service_url ||= get_service_address('POLL')
     end
 
-    def discover_feeds(url=self.collection_management_service_url)
+    def discover_feeds(url = self.collection_management_service_url)
       msg  = Taxii::Messages::FeedInformationRequest.new.to_xml
       http  = build_request(url: url, payload: msg, format: Taxii::Messages::TAXII_10_HEADERS)
       parsed  = xml.parse(http.execute.body)
-      parsed['Feed_Information_Response'].fetch('Feed',[])
+      parsed['Feed_Information_Response'].fetch('Feed', [])
+    end
+
+    def discover_collections(url = self.collection_management_service_url)
+      msg  = Taxii::Messages::CollectionInformationRequest.new.to_xml
+      http  = build_request(url: url, payload: msg, format: Taxii::Messages::TAXII_10_HEADERS)
+      parsed  = xml.parse(http.execute.body)
+      parsed['Collection_Information_Response'].fetch('Collection', [])
     end
 
     def scheme_protocol

data/lib/taxii/messages/collection_information_request.rb

@@ -0,0 +1,18 @@
+module Taxii
+  module Messages
+    class CollectionInformationRequest < Hashie::Dash
+      property :message_id, default: -> { Taxii::Messages.generate_id }
+
+      def to_h
+        Taxii::Messages::NAMESPACE_ATTRIBUTES.merge({
+          '@message_id': message_id
+        })
+      end
+
+      def to_xml
+        Gyoku.xml({'taxii_11:Collection_Information_Request/': to_h}, key_converter: :none)
+      end
+
+    end
+  end
+end

data/lib/taxii/messages/content_block.rb

@@ -0,0 +1,29 @@
+require 'json'
+
+module Taxii
+  module Messages
+    class ContentBlock < Hashie::Dash
+      def initialize(body)
+        parsed = Nori.new(strip_namespaces: true).parse(body)
+        @body = parsed['Content_Block']['Content']
+        @body
+      end
+
+      def to_s
+        @body.to_s
+      end
+
+      def inspect
+        self.to_s
+      end
+
+      def as_json
+        JSON.parse(@body)
+      end
+
+      def pretty_print(pp)
+        puts self.to_s
+      end
+    end
+  end
+end

data/lib/taxii/messages/poll_fulfillment_request.rb

@@ -0,0 +1,25 @@
+module Taxii
+  module Messages
+    class PollFulfillmentRequest < Hashie::Dash
+      include Hashie::Extensions::Coercion
+
+      property :collection_name, default: 'system.Default'
+      property :result_id
+      property :result_part_number
+      property :message_id, default: -> { Taxii::Messages.generate_id }
+
+      def to_h
+        NAMESPACE_ATTRIBUTES.merge({
+          '@message_id':         message_id,
+          '@collection_name':    collection_name,
+          '@result_id':          result_id,
+          '@result_part_number': result_part_number,
+        })
+      end
+
+      def to_xml
+        Gyoku.xml({'taxii_11:Poll_Fulfillment': to_h}, key_converter: :none)
+      end
+    end
+  end
+end

data/lib/taxii/messages/poll_request.rb

@@ -21,7 +21,7 @@ module Taxii
         if exclusive_begin_timestamp.nil?
           {}
         else
-          {'Exclusive_Begin_Timestamp': exclusive_begin_timestamp.strftime(TS_FORMAT)}
+          {'taxii_11:Exclusive_Begin_Timestamp': exclusive_begin_timestamp.strftime(TS_FORMAT)}
         end
       end
 
@@ -29,7 +29,7 @@ module Taxii
         if inclusive_end_timestamp.nil?
           {}
         else
-          {'Inclusive_End_Timestamp': inclusive_end_timestamp.strftime(TS_FORMAT)}
+          {'taxii_11:Inclusive_End_Timestamp': inclusive_end_timestamp.strftime(TS_FORMAT)}
         end
       end
       def requested_info

data/lib/taxii/poll_client.rb

@@ -3,26 +3,62 @@ module Taxii
     include Client
 
     PARSE_OPTIONS = Nokogiri::XML::ParseOptions::DEFAULT_XML | Nokogiri::XML::ParseOptions::NOBLANKS
-    CONTENT_XPATH = '/taxii_11:Poll_Response/taxii_11:Content_Block/taxii_11:Content'
+    POLL_RESPONSE_PATH = '/taxii_11:Poll_Response'
+    CONTENT_XPATH = "#{POLL_RESPONSE_PATH}/taxii_11:Content_Block/taxii_11:Content"
 
-    def get( poll_request_message, url: self.poll_service_url)
+    def get(poll_request_message, url: self.poll_service_url)
       msg = format_request(poll_request_message)
       build_request(url: url, payload: msg).execute
     end
 
-    def get_content_blocks( poll_request_message,
+    def get_content_blocks(poll_request_message,
                             url: self.poll_service_url,
-                            xpath: CONTENT_XPATH )
+                            xpath: CONTENT_XPATH)
       response = self.get(poll_request_message, url: url)
-      content_xml = Nokogiri::XML(response.body,nil,nil,PARSE_OPTIONS)
-      content_xml.xpath(xpath).flat_map { |blk| blk.children.map(&:to_s) }
+      @content_xml = Nokogiri::XML(response.body, nil, nil, PARSE_OPTIONS)
+
+      blocks = response_blocks
+
+      # We have a muulti-part message
+      # http://docs.oasis-open.org/cti/taxii/v1.1.1/cs01/part2-services/taxii-v1.1.1-cs01-part2-services.html#_Toc450734190
+      while attribute_more == 'true'
+        poll_fulfillment_message = Taxii::Messages::PollFulfillmentRequest.new(
+          collection_name: poll_request_message.collection_name,
+          result_id: result_id,
+          result_part_number: result_part_number + 1)
+
+        response = self.get(poll_fulfillment_message, url: url)
+        @content_xml = Nokogiri::XML(response.body, nil, nil, PARSE_OPTIONS)
+
+        blocks += response_blocks
+      end
+
+      blocks
+    end
+
+    private
+
+    def response_blocks
+      @content_xml.xpath(POLL_RESPONSE_PATH).flat_map { |blk| blk.children.map(&:to_s) }
+    end
+
+    def attribute_more
+      @content_xml.at_xpath(POLL_RESPONSE_PATH).attributes['more'].value
+    end
+
+    def result_id
+      @content_xml.at_xpath(POLL_RESPONSE_PATH).attributes['result_id'].value
+    end
+
+    def result_part_number
+      @content_xml.at_xpath(POLL_RESPONSE_PATH).attributes['result_part_number'].value.to_i
     end
 
     def format_request(request_message)
       case request_message
         when String
           request_message
-        when Taxii::Messages::PollRequest
+        when Taxii::Messages::PollRequest, Taxii::Messages::PollFulfillmentRequest
           request_message.to_xml
         else
           fail ArgumentError, 'request message must be String or PollRequest'

data/lib/taxii/version.rb

@@ -1,3 +1,3 @@
 module Taxii
-  VERSION = '0.3.1'
+  VERSION = '0.3.2'
 end

data/lib/taxii.rb

@@ -4,6 +4,7 @@ require 'rest-client'
 require 'uri'
 require 'nori'
 require 'gyoku'
+require 'json'
 
 require 'taxii/version'
 require 'taxii/time_extensions'
@@ -11,13 +12,29 @@ require 'taxii/messages'
 require 'taxii/messages/parameters'
 require 'taxii/messages/discovery_request'
 require 'taxii/messages/poll_request'
+require 'taxii/messages/poll_fulfillment_request'
 require 'taxii/messages/feed_information_request'
+require 'taxii/messages/collection_information_request'
+require 'taxii/messages/content_block'
 require 'taxii/client'
 require 'taxii/poll_client'
 
 module Taxii
-  def self.configure(config: File.join(ENV['HOME'],'.taxii.json'), client: PollClient)
-    configuration = JSON.parse(File.read(config))
+  def self.configure(options = {})
+    client = options.fetch(:client, PollClient)
+    config = options.fetch(:config, File.join(ENV['HOME'],'.taxii.json'))
+    user = options[:user]
+    pass = options[:pass]
+    url = options[:url]
+
+    if user && pass && url
+      configuration = { user: user, pass: pass, url: url }
+    elsif File.exist?(config)
+      configuration = JSON.parse(File.read(config))
+    else
+      raise('You must provide user+pass+url, ora a config file, or have a default $HOME/.taxii.json')
+    end
+
     client.new(configuration)
   end
 

data/ruby-taxii.gemspec

@@ -33,4 +33,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'vcr'
   spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-byebug'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-taxii2
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Dario Lombardo
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-27 00:00:00.000000000 Z
+date: 2023-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -206,6 +206,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: " implement api-alike for python libtaxii https://github.com/TAXIIProject/libtaxii "
 email:
 - lomato@gmail.com
@@ -225,9 +253,12 @@ files:
 - lib/taxii.rb
 - lib/taxii/client.rb
 - lib/taxii/messages.rb
+- lib/taxii/messages/collection_information_request.rb
+- lib/taxii/messages/content_block.rb
 - lib/taxii/messages/discovery_request.rb
 - lib/taxii/messages/feed_information_request.rb
 - lib/taxii/messages/parameters.rb
+- lib/taxii/messages/poll_fulfillment_request.rb
 - lib/taxii/messages/poll_request.rb
 - lib/taxii/parsers/sax_poll_response.rb
 - lib/taxii/poll_client.rb