threadfix-cli 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a1e54acd08e9bb3fae80fc89232d76d1e2c2d57b3e94d4d640b687c61cace57f
+  data.tar.gz: 2269a7fb0d0b9ac1ab02072ce8d507a57383d385a0330655aa73400b9969771a
+SHA512:
+  metadata.gz: 7b123e7c57c914c821cf434430c46310bd41cf46e5bce6bcab53c0ee882ae0b1742bcc9ba918aeb68a76f9d14058359b2ad7a0c061a79f6d8b2ae87fb02b0a68
+  data.tar.gz: af0c3b4df849907049b148f73c7d7ebacb6856f0e52ed87de12dcb52a911051413e81a5b737a70e38dae108789bda9ee6df02d541a6dd93b3d721674baa55376

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGE_LOG.md

@@ -0,0 +1,3 @@
+# v0.1.0
+
+- Initial release to upload scans

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in threadfix-cli.gemspec
+gemspec
+
+gem 'pry'

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    threadfix (0.1.0)
+      rest-client
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    domain_name (0.5.20180417)
+      unf (>= 0.0.5, < 1.0.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    method_source (0.9.2)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.0331)
+    netrc (0.11.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rest-client (2.0.2)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    thor (0.20.3)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  threadfix!
+
+BUNDLED WITH
+   2.0.1

data/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2019 David Elliott
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,26 @@
+# Threadfix
+Command line tool to upload a static analysis report to ThreadFix
+
+## Installation
+
+Install it  with:
+
+```ruby
+ $ gem install threadfix
+```
+
+## Usage
+
+```ruby
+ $ threadfix scan upload --app-id <APP-ID> --host <Server> --key <Auth Key> --file ./repo/results.json
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/DDAZZA/threadfix-cli.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "threadfix/cli"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/threadfix

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require "threadfix/cli"
+
+Threadfix::CLI.start

data/lib/threadfix/cli.rb

@@ -0,0 +1,14 @@
+require 'thor'
+require "threadfix/cli/version"
+require "threadfix/cli/scan"
+require "threadfix/client"
+
+module Threadfix
+  class CLI < Thor
+
+    class Error < StandardError; end
+
+    desc "scan <command>", "manage scans"
+    subcommand "scan", Cli::Scan
+  end
+end

data/lib/threadfix/cli/scan.rb

@@ -0,0 +1,29 @@
+require "threadfix/client"
+module Threadfix
+  module Cli
+    class Scan < Thor
+      desc "upload", "Uploads a scan to ThreadFix"
+      option :host
+      option 'app-id', required: true, type: :numeric
+      option :file, required: true, aliases: '-f', desc: "Report to upload"
+      option :key, desc: "Authorisation key"
+      def upload
+        Client.configure do |config|
+          config.host = options[:host] if options[:host]
+          config.key = options[:key] if options[:key]
+        end
+
+        begin
+          response =  Client::Scans.upload(file_path: options[:file], app_id: options['app-id'] )
+          puts response['message']
+        rescue Errno::ENOENT => e
+          puts "Error: File or directory '#{options[:file]}' doesn't exist."
+          exit 1
+        rescue SocketError => e
+          puts "Error: Unable open connection to '#{Client.config.host}'"
+          exit 1
+        end
+      end
+    end
+  end
+end

data/lib/threadfix/cli/version.rb

@@ -0,0 +1,5 @@
+module Threadfix
+  module Cli
+    VERSION = "0.1.0"
+  end
+end

data/lib/threadfix/client.rb

@@ -0,0 +1,23 @@
+require "threadfix/client/scans"
+
+module Threadfix
+  module Client
+    class << self
+      attr_accessor :config
+    end
+
+    def self.configure
+      self.config ||= Configuration.new
+      yield(config)
+    end
+
+    class Configuration
+      attr_accessor :host, :key
+
+      def initialize
+        @host = ENV['HOST']
+        @key = ENV['THREADFIX_TOKEN']
+      end
+    end
+  end
+end

data/lib/threadfix/client/scans.rb

@@ -0,0 +1,17 @@
+require "threadfix/client/scans/upload"
+
+module Threadfix
+  module Client
+    module Scans
+      class <<self
+
+        # @param file_path
+        # @return Hash
+        def upload(options={})
+          action = Upload.new(options)
+          action.perform!
+        end
+      end
+    end
+  end
+end

data/lib/threadfix/client/scans/upload.rb

@@ -0,0 +1,48 @@
+require 'rest-client'
+require 'json'
+
+module Threadfix
+  module Client
+    module Scans
+      class Upload
+        API_VERSION='2.5'
+        attr_accessor :file_path, :app_id
+
+        def initialize(options={})
+          @file_path = options[:file_path]
+          @app_id = options[:app_id]
+        end
+
+        def perform!
+          begin
+            r = RestClient.post(
+              "#{host}/rest/#{API_VERSION}/applications/#{app_id}/upload",
+              { file: file },
+              { :accept => "application/json", :Authorization => "APIKEY #{apiKey}" }
+            )
+            JSON.parse(r.body)
+          rescue RestClient::NotFound => e
+            puts "Endpoint not found (using API version: #{API_VERSION})"
+            raise e
+          rescue RestClient::ExceptionWithResponse => e
+            raise e
+          end
+        end
+
+        private
+
+        def file
+          File.new(file_path, 'rb')
+        end
+
+        def host
+          Client.config.host
+        end
+
+        def apiKey
+          Client.config.key
+        end
+      end
+    end
+  end
+end

data/threadfix-cli.gemspec

@@ -0,0 +1,44 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "threadfix/cli/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "threadfix-cli"
+  spec.version       = Threadfix::Cli::VERSION
+  spec.authors       = ["Dave Elliott"]
+  spec.email         = ["ddazza@gmail.com"]
+
+  spec.summary       = %q{CLI to upload scan report to ThreadFix}
+  spec.description   = %q{Command line tool to upload a static analysis report to ThreadFix}
+  spec.homepage      = "https://github.com/DDAZZA/threadfix-cli"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/DDAZZA/threadfix-cli"
+    spec.metadata["changelog_uri"] = "https://github.com/DDAZZA/threadfix-cli/blob/master/CHANGE_LOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "bin"
+  spec.executables   = "threadfix"
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "thor", '0.20.3'
+  spec.add_runtime_dependency "rest-client", '2.0.2'
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: threadfix-cli
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dave Elliott
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.20.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.20.3
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Command line tool to upload a static analysis report to ThreadFix
+email:
+- ddazza@gmail.com
+executables:
+- threadfix
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CHANGE_LOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/threadfix
+- lib/threadfix/cli.rb
+- lib/threadfix/cli/scan.rb
+- lib/threadfix/cli/version.rb
+- lib/threadfix/client.rb
+- lib/threadfix/client/scans.rb
+- lib/threadfix/client/scans/upload.rb
+- threadfix-cli.gemspec
+homepage: https://github.com/DDAZZA/threadfix-cli
+licenses: []
+metadata:
+  homepage_uri: https://github.com/DDAZZA/threadfix-cli
+  source_code_uri: https://github.com/DDAZZA/threadfix-cli
+  changelog_uri: https://github.com/DDAZZA/threadfix-cli/blob/master/CHANGE_LOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: CLI to upload scan report to ThreadFix
+test_files: []