securitytxt 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27e70469171c726ba4e2356bc164161faf698a4e
-  data.tar.gz: 62d06c069621e9504aa43b972ff8cdda05481a3e
+  metadata.gz: 7ccb7ac4366e494d85af320fd89b39c75b603ec6
+  data.tar.gz: 2ce31783e42d90c7b137cbbd9b85e3d6402c576c
 SHA512:
-  metadata.gz: 431b1a4e3fb888e18d86cd19e4735cde8fd0dace49462642b259cd163aefb57bec23b75cf87de1bbda3054ef494352eac6b88e2baf8a8caeac661ab9d390414e
-  data.tar.gz: b228557995da8537dcd2b0fdf9b178f89d0e809b0e3aed87d21dbaa836eaf9df53944391c0b42a1f9ca989951c7b1f2d347699fba66868ced2661a5851d7e336
+  metadata.gz: 6872ad70a0d1ff677acff4c7fb9aa229b7d0e393a62e3a68a7edc3bca6357d59266d45011bf12f1a891248752d474b2053f85c0655636633cfb18feafe34a7f4
+  data.tar.gz: 0d9fbf51c1f8b106335a8ead278bf42f450966b46a2f344eebc4393ae352d84b32eb648b77b1166ace9b1be2a2e52be1a8ecd563239e32f52ed37db6d305c1a6

data/README.md

@@ -65,5 +65,19 @@ puts SecurityTxt::Generator.new({"contact"=>"https://hackerone.com/ed", "encrypt
 # Acknowledgements: https://hackerone.com/ed/thanks
 ```
 
+## CLI usage
+
+```
+Securitytxt - A CLI tool to parse and generate securitytxt content.
+
+Help menu:
+   -p, --parse FILE | URL           Parse securitytxt file or URL
+   -g, --generate                   Generate a securitytxt string.
+   -c, --contact DETAILS            List of contact details separated by comma(,) without spaces. (used with -g/--generate)
+   -e, --encryption URL             Link to a page which contains your key.(used with -g/--generate)
+   -a, --acknowledgements URL       Link to a page where security researchers are recognized for their reports.(used with -g/--generate)
+   -h, --help                       Show this help message
+```
+
 ## License
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/bin/securitytxt

@@ -0,0 +1,70 @@
+#!/usr/bin/env ruby
+# Securitytxt command-line tool
+#
+require 'optparse'
+require 'open-uri'
+require 'securitytxt/parser'
+require 'securitytxt/generator'
+
+class String
+  def red; colorize(self, "\e[1m\e[31m"); end
+  def dark_green; colorize(self, "\e[32m"); end
+  def underline; colorize(self, "\e[4m"); end
+  def bold; colorize(self, "\e[1m"); end
+  def colorize(text, color_code) "#{color_code}#{text}\e[0m" end
+end
+
+options = {}
+option_parser = OptionParser.new
+option_parser.banner = "#{"Securitytxt".bold} - A CLI tool to parse and generate securitytxt content."
+option_parser.set_summary_indent '   '
+option_parser.separator "\nHelp menu:".underline
+option_parser.on('-p', '--parse FILE | URL', 'Parse securitytxt file or URL') {|v| options[:parse] = v}
+option_parser.on('-g', '--generate', 'Generate a securitytxt string.') {|v| options[:generate] = v}
+option_parser.on('-c', '--contact DETAILS', Array, 'List of contact details separated by comma(,) without spaces. (used with -g/--generate)') {|v| options[:contact] = v}
+option_parser.on('-e', '--encryption URL', 'Link to a page which contains your key.(used with -g/--generate)') {|v| options[:encryption] = v}
+option_parser.on('-a', '--acknowledgements URL', 'Link to a page where security researchers are recognized for their reports.(used with -g/--generate)') {|v| options[:ack] = v}
+option_parser.on('-h', '--help', 'Show this help message') {|v| option_parser}
+option_parser.on_tail "\nExample:".underline
+option_parser.on_tail"  securitytxt --parse https://securitytxt.org/.well-known/security.txt"
+option_parser.on_tail"  securitytxt --generate -c https://hackerone.com/ed -e https://keybase.pub/edoverflow/pgp_key.asc -a https://hackerone.com/ed/thanks"
+
+begin
+  option_parser.parse!
+  case
+    when options[:parse]
+      securitytxt = SecurityTxt::Parser.new.parse(open(options[:parse]).read)
+      securitytxt.each do |key, val|
+        puts "- #{key.ljust(16).bold} : #{[val].join(', ')}"
+      end
+      puts "\n-[".bold + "Hash".dark_green + "]---".bold
+      puts securitytxt
+    when options[:generate] && options[:contact] && options[:encryption] && options[:ack]
+      data = {"contact" => options[:contact], "encryption" => options[:encryption], "acknowledgements" => options[:ack]}
+      generated =  SecurityTxt::Generator.new(data).generate
+      puts generated
+      puts "\n-[".bold + "Hash".dark_green + "]---".bold
+      puts SecurityTxt::Parser.new.parse(generated)
+    when options[:generate] && (options[:contact] || options[:encryption] || options[:akc]).nil?
+      puts '[!] '.red + "Missing mandatory options, -g/--generate requires '-c/--contact', '-e/--encrytion', '-a/--ack' options."
+    when options[:generate] && options[:contact].nil?
+      puts '[!] '.red + "Missing mandatory option '-c/--contact'"
+    when options[:generate] && options[:encryption].nil?
+      puts '[!] '.red + "Missing mandatory option '-e/--encryption'"
+    when options[:generate] && options[:ack].nil?
+      puts '[!] '.red + "Missing mandatory option '-a/--ack'"
+    else
+      puts option_parser
+  end
+rescue OptionParser::MissingArgument => e
+  e.args.each {|arg| puts '[!] '.red + "#{e.reason.capitalize} for '#{arg}' option."}
+  puts option_parser
+rescue OptionParser::InvalidOption => e
+  puts '[!] '.red + "#{e}"
+  puts option_parser
+rescue Exception => e
+  puts e.backtrace
+  puts e.backtrace_locations
+  puts e
+end
+

data/lib/securitytxt/version.rb

@@ -1,3 +1,3 @@
 module SecurityTxt
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: securitytxt
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Benoit Larroque
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-15 00:00:00.000000000 Z
+date: 2018-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -42,13 +42,15 @@ description: 'This gems includes various tools about security.txt for Ruby: A ra
   engine, A Rack MiddleWare, a simple parser and generator '
 email:
 - benoit@sqreen.io
-executables: []
+executables:
+- securitytxt
 extensions: []
 extra_rdoc_files: []
 files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- bin/securitytxt
 - lib/securitytxt.rb
 - lib/securitytxt/generator.rb
 - lib/securitytxt/middleware.rb
@@ -78,5 +80,5 @@ rubyforge_project:
 rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
-summary: Provides a tools about security.txt for Ruby
+summary: Provides tools about security.txt for Ruby
 test_files: []