dradis-pdf_export 4.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2b4fe7c789940f102135b59c9bac0ec1750250ccd1e8ae4f43ef511a88da2c24
+  data.tar.gz: 4d21172050f7db481935f411c159e6cddaef2e3bda5c5827a76ee10080bba7c8
+SHA512:
+  metadata.gz: 68854d55c5b6c746dd7a1bc5f1e35ef5ba9dfbf2d775e7dfd5e28cec29e7e9985d277130b9164c4b7f5a4e1539f4f396754a7dad87f019fe80ddadfeb5aa8f12
+  data.tar.gz: f8a4e5a79538ed2bb548c1218784e70e95404f1aa9c5c1f6750f59e4e8196d4947de6785a7053dd7003399174f15509b690c6500f1434dc8bceaaa1ec38f1dce

data/.gitignore

@@ -0,0 +1,3 @@
+.bundle/
+vendor/bundle/
+Gemfile.lock

data/CHANGELOG.md

@@ -0,0 +1,56 @@
+v4.1.0 (November 2021)
+  - No changes
+
+v4.0.0 (July 2021)
+  - No changes
+
+v3.22.0 (April 2021)
+  - No changes
+
+v3.21.0 (February 2021)
+  - No changes
+
+v3.20.0 (December 2020)
+  - No changes
+
+v3.19.0 (September 2020)
+  - No changes
+
+v3.18.0 (July 2020)
+  - No changes
+
+v3.17.0 (May 2020)
+  - No changes
+
+v3.16.0 (February 2020)
+  - No changes
+
+v3.15.0 (November 2019)
+  - No changes
+
+v3.14.0 (August 2019)
+  - No changes
+
+v3.13.0 (June 2019)
+  - No changes
+
+v3.12.0 (March 2019)
+  - No changes
+
+v3.11.0 (November 2018)
+  - No changes
+
+v3.10.0 (August 2018)
+  - No changes
+
+v3.9.0 (January 2018)
+  - No changes
+
+v3.8.0 (September 2017)
+  - No changes
+
+v3.7.0 (July 2017)
+  - No changes
+
+v3.6.0 (March 2017)
+  - No changes

data/CHANGELOG.template

@@ -0,0 +1,12 @@
+[v#.#.#] ([month] [YYYY])
+  - [future tense verb] [feature]
+  - Upgraded gems:
+    - [gem]
+  - Bugs fixes:
+    - [future tense verb] [bug fix]
+    - Bug tracker items:
+      - [item]
+  - Security Fixes:
+    - High: (Authenticated|Unauthenticated) (admin|author|contributor) [vulnerability description]
+    - Medium: (Authenticated|Unauthenticated) (admin|author|contributor) [vulnerability description]
+    - Low: (Authenticated|Unauthenticated) (admin|author|contributor) [vulnerability description]

data/CONTRIBUTING.md

@@ -0,0 +1,3 @@
+This is a plugin for the Dradis Framework, please see:
+
+https://github.com/dradis/dradisframework/blob/master/CONTRIBUTING.md

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dradis-html_export.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,3 @@
+This is a plugin for the Dradis Framework, please see:
+
+https://github.com/dradis/dradisframework/blob/master/LICENSE

data/README.md

@@ -0,0 +1,30 @@
+# PDF export plugin for the Dradis Framework
+
+[![Build Status](https://secure.travis-ci.org/dradis/dradis-pdf_export.png?branch=master)](http://travis-ci.org/dradis/dradis-pdf_export)
+
+
+This plugin generates a PDF report from the notes in your [Dradis Framework](https://github.com/dradis/dradisframework) repository.
+
+It uses the amazing [Prawn](https://github.com/prawnpdf/prawn) library to do the PDF heavy lifting.
+
+The add-on requires [Dradis CE](https://dradisframework.org/) > 3.0, or [Dradis Pro](https://dradisframework.com/pro/).
+
+
+## More information
+
+See the Dradis Framework's [README.md](https://github.com/dradis/dradisframework/blob/master/README.md)
+
+
+## Contributing
+
+See the Dradis Framework's [CONTRIBUTING.md](https://github.com/dradis/dradisframework/blob/master/CONTRIBUTING.md)
+
+
+## License
+
+Dradis Framework is released under [GNU General Public License version 2.0](http://www.gnu.org/licenses/old-licenses/gpl-2.0.html)
+
+
+## Feature requests and bugs
+
+Please use the [Dradis Framework issue tracker](https://github.com/dradis/dradis-ce/issues) for add-on improvements and bug reports.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/app/controllers/dradis/plugins/pdf_export/base_controller.rb

@@ -0,0 +1,20 @@
+module Dradis
+  module Plugins
+    module PdfExport
+
+      class BaseController < Dradis::Plugins::Export::BaseController
+        # This method cycles throw the notes in the reporting category and creates
+        # a simple PDF report with them.
+        def index
+          exporter = Dradis::Plugins::PdfExport::Exporter.new(export_options)
+          pdf      = exporter.export
+
+          send_data pdf.render, filename: "dradis_report-#{Time.now.to_i}.pdf",
+                                type: 'application/pdf',
+                                disposition: 'inline'
+        end
+      end
+
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+Dradis::Plugins::PdfExport::Engine.routes.draw do
+  root to: 'base#index'
+end

data/dradis-pdf_export.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/dradis/plugins/pdf_export/version', __FILE__)
+version = Dradis::Plugins::PdfExport::version
+
+Gem::Specification.new do |spec|
+  spec.platform = Gem::Platform::RUBY
+  spec.name = "dradis-pdf_export"
+  spec.version = version
+  spec.required_ruby_version = '>= 1.9.3'
+  spec.license = 'GPL-2'
+
+  spec.authors = ['Daniel Martin']
+  spec.email = ["<etd@nomejortu.com>"]
+  spec.description = %q{Export to PDF plugin for the Dradis Framework}
+  spec.summary = %q{Dradis PDF export plugin}
+  spec.homepage = 'http://dradisframework.org'
+
+  spec.files = `git ls-files`.split($\)
+  spec.executables = spec.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'dradis-plugins', '~> 4.0'
+  spec.add_dependency 'prawn', '~> 0.15.0'
+
+  spec.add_development_dependency 'capybara', '~> 1.1.3'
+  spec.add_development_dependency 'database_cleaner'
+  spec.add_development_dependency 'factory_girl_rails'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec-rails', '~> 2.11.0'
+  spec.add_development_dependency 'sqlite3'
+end

data/lib/dradis/plugins/pdf_export/engine.rb

@@ -0,0 +1,31 @@
+module Dradis
+  module Plugins
+    module PdfExport
+
+      class Engine < ::Rails::Engine
+        # Standard Rails Engine stuff
+        isolate_namespace Dradis::Plugins::PdfExport
+
+        # use rspec for tests
+        config.generators do |g|
+          g.test_framework :rspec
+        end
+
+        # Connect to the Framework
+        include Dradis::Plugins::Base
+
+        # plugin_name 'HTML export'
+        provides :export
+        description 'Generate PDF reports'
+
+
+        initializer 'dradis-pdf_export.mount_engine' do
+          Rails.application.routes.append do
+            mount Dradis::Plugins::PdfExport::Engine => '/export/pdf'
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/dradis/plugins/pdf_export/exporter.rb

@@ -0,0 +1,170 @@
+module Dradis
+  module Plugins
+    module PdfExport
+
+      class Processor < Prawn::Document
+        def initialize(args={})
+          super(top_margin: 70)
+
+          content_service = args[:content_service]
+
+          @author = 'Security Tester'
+          @email  = 'tester@securitytesting.com'
+          @issues = content_service.all_issues
+          @notes  = content_service.all_notes
+          @title  = "Dradis Framework - v#{Dradis::CE::VERSION::STRING}"
+
+          sort_issues
+        end
+
+        def generate
+          cover_page
+          project_notes
+          summary_of_findings
+          detailed_findings
+          tool_list
+
+          # outline
+        end
+
+        private
+        def sort_issues
+          sorted = { info: [], low: [], medium: [], high: []}
+          @issues.each do |issue|
+             cvss = issue.fields['CVSSv2'].to_f;
+             case cvss
+               when 0..0.9
+                 sorted[:info] << issue
+               when 1.0..3.9
+                 sorted[:low] << issue
+               when 4.0..6.9
+                 sorted[:medium] << issue
+               else
+                 sorted[:high] << issue
+             end
+           end
+           @sorted = sorted[:high] + sorted[:medium] + sorted[:low] + sorted[:info]
+        end
+
+        def cover_page
+          move_down 50
+          image "#{Engine.config.paths['app/assets'].expanded.first}/logo_pdf.jpg", position: :center
+          move_down 20
+
+          text '<b><font size="24">Security Assessment Report</font></b>', inline_format: true, align: :center
+          move_down 20
+          text "BlackHat Arsenal 2018", align: :center
+
+
+          bounding_box([300, 150], width: 200, height: 150) do
+            # transparent(0.5) { stroke_bounds }  # This will stroke on one page
+            text "<b>Author</b>: #{@author}", inline_format: :true
+            text "<b>Email</b>: #{@email}", inline_format: :true
+            text "<b>Date</b>: #{Time.now.strftime('%Y-%m-%d')}", inline_format: :true
+            # transparent(0.5) { stroke_bounds }  # And this will stroke on the next
+          end
+          start_new_page
+        end
+
+        def project_notes
+          draw_header
+
+          text 'Project notes'
+          move_down 20
+
+          @notes.each do |note|
+            fields = note.fields
+            text "<b>#{fields['Title']}</b>", inline_format: true
+            text fields['Description']
+          end
+
+          start_new_page
+        end
+
+        def summary_of_findings
+          draw_header
+
+          text 'SUMMARY OF FINDINGS'
+          move_down 20
+
+          @sorted.each do |note|
+            fields = note.fields
+            text "• #{fields['Title']} (#{fields['CVSSv2']})"
+          end
+
+          start_new_page
+        end
+
+        def detailed_findings
+          draw_header
+
+          text 'DETAILED FINDINGS'
+          move_down 20
+
+          @sorted.each do |note|
+            fields = note.fields
+            text "<b>#{fields['Title']}</b> (#{fields['CVSSv2']})", inline_format: true
+            text fields['Description']
+
+            move_down 20
+            text "<b>Mitigation:</b>", inline_format: true
+            text fields['Mitigation']
+            start_new_page
+          end
+        end
+
+        def tool_list
+          draw_header
+
+          text 'TOOLS USED'
+          move_down 20
+
+          data = [
+            ['Name', 'Description']
+          ]
+
+          data << ['Dradis Framework', "Collaboration and reporting framework\nhttp://dradisframework.org" ]
+
+          table data, header: true, position: :center
+        end
+
+        def outline
+          outline.define do
+            section('Report Content', destination: 2) do
+              page title: 'Summary of Findings', destination: 2
+              page title: 'Tool List', destination: 3
+            end
+          end
+        end
+
+        def draw_header
+          fill_color 'efefef'
+          fill_rectangle [bounds.left-50, bounds.top + 100], bounds.width + 100, 87
+          fill_color '00000'
+
+          box = bounding_box [bounds.left-50, bounds.top+50], :width  => (bounds.width + 100) do
+
+            font "Helvetica"
+            text "Security Assessment Report", align: :center
+            move_down 20
+
+            stroke_color 'dadada'
+            stroke_horizontal_rule
+            stroke_color '000000'
+
+          end
+          move_down 40
+        end
+
+      end
+
+      class Exporter < Dradis::Plugins::Export::Base
+        def export()
+          pdf = Processor.new(content_service: content_service)
+          pdf.generate
+          pdf
+        end
+      end
+    end
+  end
+end

data/lib/dradis/plugins/pdf_export/gem_version.rb

@@ -0,0 +1,19 @@
+module Dradis
+  module Plugins
+    module PdfExport
+      # Returns the version of the currently loaded Frontend as a <tt>Gem::Version</tt>
+      def self.gem_version
+        Gem::Version.new VERSION::STRING
+      end
+
+      module VERSION
+        MAJOR = 4
+        MINOR = 1
+        TINY = 0
+        PRE = nil
+
+        STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
+      end
+    end
+  end
+end

data/lib/dradis/plugins/pdf_export/version.rb

@@ -0,0 +1,13 @@
+require_relative 'gem_version'
+
+module Dradis
+  module Plugins
+    module PdfExport
+      # Returns the version of the currently loaded HtmlExport as a
+      # <tt>Gem::Version</tt>.
+      def self.version
+        gem_version
+      end
+    end
+  end
+end

data/lib/dradis/plugins/pdf_export.rb

@@ -0,0 +1,10 @@
+require 'dradis/plugins/pdf_export/engine'
+require 'dradis/plugins/pdf_export/exporter'
+require 'dradis/plugins/pdf_export/version'
+
+module Dradis
+  module Plugins
+    module PdfExport
+    end
+  end
+end

data/lib/dradis-pdf_export.rb

@@ -0,0 +1,8 @@
+# Hook to the framework base clases
+require 'dradis-plugins'
+
+# Load supporting classes
+require 'prawn'
+
+# Load this add-on's engine
+require "dradis/plugins/pdf_export"

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: dradis-pdf_export
+version: !ruby/object:Gem::Version
+  version: 4.1.0
+platform: ruby
+authors:
+- Daniel Martin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dradis-plugins
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: prawn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  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: factory_girl_rails
+  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: 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-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: Export to PDF plugin for the Dradis Framework
+email:
+- "<etd@nomejortu.com>"
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- CHANGELOG.template
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- app/assets/images/logo_pdf.jpg
+- app/controllers/dradis/plugins/pdf_export/base_controller.rb
+- config/routes.rb
+- dradis-pdf_export.gemspec
+- lib/dradis-pdf_export.rb
+- lib/dradis/plugins/pdf_export.rb
+- lib/dradis/plugins/pdf_export/engine.rb
+- lib/dradis/plugins/pdf_export/exporter.rb
+- lib/dradis/plugins/pdf_export/gem_version.rb
+- lib/dradis/plugins/pdf_export/version.rb
+homepage: http://dradisframework.org
+licenses:
+- GPL-2
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Dradis PDF export plugin
+test_files: []