hackernote 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ff684139dfe33900c5be1dc93d3a8e4b11df8361
+  data.tar.gz: 360f8c7218cf83c8e506d827f4d1b6762bca228d
+SHA512:
+  metadata.gz: cb496296e8f68ab5b89f272b1587538ed4d7056c13750d955a47d28eaec9aac6ffa5bb6ae05193e2d22a5cd5c3415d4971789fd13802967ece93fd12e7b99e50
+  data.tar.gz: 50dd1f61221d47b90fca8e044e93574bfc8338ab1b31db8debf19d3d382619b908cfcb4736c3ca1ab8cb659889790f0366cce8a02cf0750631f011f3c9881b51

data/.gitignore

@@ -0,0 +1 @@
+.idea

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in hackernote.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 KING SABRI
+
+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 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,71 @@
+# Hacker's Note
+
+It's a Ruby script creates a gitbook compatible structure for penetration test and red team projects 
+The main target of this script is to make building [gitbook](https://www.gitbook.com/editor) project for a new PT/RT engagement easily.
+
+## Installation
+
+    $ gem install hackernote
+
+## Usage
+
+```
+$> hackernote -h
+
+                                 ______            ____                                                 ______              ____
+     |         |      .'.      .~      ~.|    ..''|          |`````````,         ..'''' |..          |.~      ~.`````|`````|
+     |_________|    .''```.   |          |..''    |______    |'''|'''''       .''       |  ``..      |          |    |     |______
+     |         |  .'       `. |          |``..    |          |    `.       ..'          |      ``..  |          |    |     |
+     |         |.'           `.`.______.'|    ``..|__________|      `....''             |          ``|`.______.'     |     |___________
+                                                                                                                                 v1.0.0
+      
+Hacker's Note - Helps security professionals to organize their notes in a gitbook structure for PT/RT engagements.
+
+Help menu:
+   -p, --project PROJECT_NAME       Project Name
+   -l, --list TARGET_LIST           The target name or a text file contains list of targets
+   -g, --git GIT_REPO_URL           Configure git server URL
+   -h, --help                       Show this help message
+
+Usage:
+  hackernote --project <project_name> --list <targets[.list]> --git <git server repository URL>
+
+Example:
+  hackernote --project PT_CustomerName_WebApp_01-01-2030 --list target_list.txt
+  hackernote -p PT_CustomerName_WebApp_01-01-2030 -l example.com
+  hackernote -p PT_CustomerName_WebApp_01-01-2030 -l example.com -g https://github.com/[USERNAME]/PT_CustomerName_WebApp_01-01-2030.git
+```
+
+
+## Document Structure
+The script create a tree of folders and files for each target 
+
+- Project Name
+  - Target1/
+    - target1.md
+    - scanning_and_enumeration.md
+    - critical 
+    - high.md
+    - medium.md
+    - low
+    - informational.md
+    - notes
+  - TargetX/ 
+    - target1.md
+    - scanning_and_enumeration.md
+    - critical 
+    - high.md
+    - medium.md
+    - low
+    - informational.md
+    - notes
+  - README.md
+  - book.json
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hackernote.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/hackernote

@@ -0,0 +1,69 @@
+#!/usr/bin/env ruby
+#
+# Hacker's Note - A command-line tool creates gitbook compatible structure for pentest and read team projects.
+#
+# @Author: KING SABRI - @KINGSABRI
+#
+lib = File.dirname(__FILE__) + '/../lib'
+if File.directory?(lib)
+  unless $:.include?(lib)
+    $:.unshift(lib)
+  end
+end
+require 'hackernote'
+include HackerNote::Utils
+
+options = {}
+option_parser = OptionParser.new
+option_parser.banner = "#{"Hacker's Note".bold} - Helps security professionals to organize their notes in a gitbook structure for PT/RT engagements."
+option_parser.set_summary_indent '   '
+option_parser.separator "\nHelp menu:".underline
+option_parser.on('-p', '--project PROJECT_NAME', "Project Name") {|v| options[:project] = v}
+option_parser.on('-l', '--list TARGET_LIST' , 'The target name or a text file contains list of targets') {|v| options[:list] = v}
+option_parser.on('-g', '--git GIT_REPO_URL' , 'Configure git server URL') {|v| options[:git_url] = v}
+option_parser.on('-h', '--help', 'Show this help message') {puts HackerNote::Utils.banner, option_parser; exit!}
+option_parser.on_tail "\nUsage:\n".underline + "  hackernote --project <project_name> --list <targets[.list]> --git <git server repository URL>"
+option_parser.on_tail "\nExample:".underline
+option_parser.on_tail"  hackernote --project PT_CustomerName_WebApp_01-01-2030 --list target_list.txt"
+option_parser.on_tail"  hackernote -p PT_CustomerName_WebApp_01-01-2030 -l example.com"
+option_parser.on_tail"  hackernote -p PT_CustomerName_WebApp_01-01-2030 -l example.com -g https://github.com/[USERNAME]/PT_CustomerName_WebApp_01-01-2030.git\n\n"
+
+begin
+  option_parser.parse!
+  gitbook = HackerNote::GitbookBuilder.new
+  git      = HackerNote::Git.new
+  case
+    when options[:project] && options[:list] && options[:git_url]
+      gitbook.build(options[:project], options[:list])
+      print "\r\n".cls_upline
+      git.setup(options[:project], options[:git_url])
+      puts "\n[+] ".green.bold + "Happy Hacking!".bold
+    when options[:project] && options[:list]
+      gitbook.build(options[:project], options[:list])
+      print "\r\n".cls_upline
+      git.git = nil
+      git.setup(options[:project], '[YOUR GIT REPOSITORY URL]')
+      puts "\n[+] ".green.bold + "Happy Hacking!"
+    when options[:project].nil? && options[:list].nil?
+      puts HackerNote::Utils.banner
+      puts option_parser
+    when options[:project].nil?
+      puts '[!] '.red + "Missing mandatory switch '-p/--project'"
+      puts option_parser
+    when options[:list].nil?
+      puts '[!] '.red + "Missing mandatory switch '-l/--list'"
+      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/hackernote.gemspec

@@ -0,0 +1,23 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "hackernote"
+
+Gem::Specification.new do |spec|
+  spec.name          = "hackernote"
+  spec.version       = HackerNote::VERSION
+  spec.authors       = ["KING SABRI"]
+  spec.email         = ["king.sabri@gmail.com"]
+
+  spec.summary       = %q{Hacker's Note - A command-line tool creates gitbook compatible structure for pentest and read team projects.}
+  spec.description   = %Q{Hacker's Note - A command-line tool creates gitbook compatible structure for pentest and read team projects.\nHelps security professionals to organize their notes in a gitbook structure for PT/RT engagements.}
+  spec.homepage      = "https://github.com/TechArchSA/HackersNote"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject {|f| f.match(%r{^(test|spec|features)/})}
+  spec.bindir        = "bin"
+  spec.executables   = ['hackernote']
+  spec.require_paths = ["lib"]
+
+  spec.post_install_message = HackerNote::Utils.logo
+end

data/lib/hackernote.rb

@@ -0,0 +1,21 @@
+# Standard libraries
+require 'optparse'
+require 'fileutils'
+require 'pathname'
+require 'find'
+require 'mkmf'
+require 'readline'
+
+# HackerNote
+require "hackernote/version"
+require "hackernote/extensions"
+require "hackernote/utils"
+require "hackernote/gitbook_builder"
+require "hackernote/git"
+
+
+module HackerNote
+  String.class_eval do
+    include Extensions::String
+  end
+end

data/lib/hackernote/extensions.rb

@@ -0,0 +1,27 @@
+module HackerNote
+  module Extensions
+    module String
+      # Colors
+      def red; colorize(self, "\e[1m\e[31m"); end
+      def green; colorize(self, "\e[1m\e[32m"); end
+      def dark_green; colorize(self, "\e[32m"); end
+      def yellow; colorize(self, "\e[1m\e[33m"); end
+      def blue; colorize(self, "\e[1m\e[34m"); end
+      def dark_blue; colorize(self, "\e[34m"); end
+      def purple; colorize(self, "\e[35m"); end
+      def dark_purple; colorize(self, "\e[1;35m"); end
+      def cyan; colorize(self, "\e[1;36m"); end
+      def dark_cyan; colorize(self, "\e[36m"); end
+      def pure; colorize(self, "\e[0m\e[28m"); end
+      def underline; colorize(self, "\e[4m"); end
+      def bold; colorize(self, "\e[1m"); end
+      def reset; colorize(self, "\e[0m\e[28m"); end
+      def colorize(text, color_code) "#{color_code}#{text}\e[0m" end
+
+      # Cursor
+      def mv_down(n=1) cursor(self, "\033[#{n}B") end
+      def cls_upline; cursor(self, "\e[K") end
+      def cursor(text, position)"\r#{position}#{text}" end
+    end
+  end
+end

data/lib/hackernote/git.rb

@@ -0,0 +1,41 @@
+module HackerNote
+  class Git
+
+    attr_accessor :git
+    def initialize
+      @git = find_executable0 'git'
+    end
+
+    # Setup git repo
+    def setup(project, git_url='')
+      puts '[+] '.bold + 'Git Setup:'.bold.underline
+
+      git_cmds =
+          [
+              "git init",
+              "git add -A",
+              "git commit -m 'Initial #{project} commit'",
+              "git remote add origin #{git_url}",
+              "git push origin master",
+              "git checkout -b YourName",
+              "git push origin YourName"
+          ]
+      if @git
+        puts '[>] '.bold + "Found 'git' installed!"
+        puts '[-] '.bold + "Initiating local git repository."
+        git_cmds.first(4).each do |cmd|
+          puts "[>] ".bold + "executing: " + "#{cmd}".dark_green
+          `#{cmd}`
+        end
+        puts "[!] ".yellow + "Please do not forget to:".underline
+        git_cmds.last(3).each {|cmd| puts "$ ".bold + "#{cmd}".dark_green}
+      else
+        puts '[x] '.red.bold + "git command can't be found (or you didn't use '--git' switch)."
+        puts '[!] '.yellow + "Please install 'git' command then do the following (or use --git switch if git is installed):"
+        git_cmds.each {|cmd| puts "$> ".bold + "#{cmd}".dark_green}
+      end
+
+    end
+
+  end
+end

data/lib/hackernote/gitbook_builder.rb

@@ -0,0 +1,194 @@
+module HackerNote
+#
+# GitbookBuild class
+#   for all gitbook related work (build gitbook files, targets files, project readme, etc)
+#
+  class GitbookBuilder
+
+    # Builder wrapper
+    def build(project_name, target_list)
+      @project_name = project_name
+      @target_list  = target_list
+
+      puts '[+] '.bold + 'Gitbook Setup:'.bold.underline
+      set_env
+      build_gitbook_files
+      build_targets_files
+      build_project_readme
+      general_fixes
+    end
+
+    # set environment requirements
+    def set_env
+      set_project_dir
+      set_targets_list
+      Dir.chdir @project_path
+    end
+
+    # set the project main directory @see #set_env
+    def set_project_dir
+      @project_path = Pathname.new(@project_name).basename
+
+      if Dir.exist?(@project_path)
+        rename = "#{@project_path}_#{Time.now.to_i}"
+        puts '[-] '.bold + "Renaming Existing directory '#{@project_path}' to '#{rename}'"
+        FileUtils.mv(@project_path, rename)
+      end
+
+      puts '[-] '.bold + "Creating #{@project_name} directory"
+      Dir.mkdir @project_name
+    end
+
+    # check targets list, @see #set_env
+    # if file read each line as a target,
+    # if file not exists, consider the given name as a target
+    #
+    # @return Array of target names
+    def set_targets_list
+      if File.file? @target_list
+        @list_of_targets = File.open(@target_list).each_line(chomp: true).map(&:strip).reject(&:nil?).reject(&:empty?)
+      else
+        puts "[!] ".yellow + "No targets list file, assuming '#{@target_list}' as a target name."
+        @list_of_targets = [@target_list]
+      end
+    end
+
+    # build gitbook's main files such as book.json, SUMMARY.md and README.md
+    def build_gitbook_files
+      puts '[-] '.bold + "Creating gitbook's main files.'"
+      prj_files = %w[book.json SUMMARY.md README.md]
+      prj_files.each do |file|
+        File.write(file, "# #{file.split('.').first.capitalize}\n\n")
+      end
+    end
+
+    # build_targets_files builds project related files
+    #
+    # @example:
+    #   targetX/
+    #     scanning_and_enumeration.md
+    #     critical.md
+    #     high.md
+    #     medium.md
+    #     low.md
+    #     informational.md
+    #     notes.md
+    def build_targets_files
+      puts '[-] '.bold + "Creating targets' files and directories."
+      target_main_files = %W[scanning_and_enumeration.md critical.md high.md medium.md low.md informational.md notes.md]
+
+      @list_of_targets.each do |target|
+        target = fix_project_naming(target)
+        target_files = target_main_files.dup
+        target_files.unshift "#{target}.md"
+        Dir.mkdir(target)
+        create_summary_record(target)
+        target_files.each do |t_file|
+          file_path = File.join(target, t_file)
+          heading1 = t_file.split('.md').first.capitalize   # Each file's title
+          File.write(file_path, "# #{heading1}\n\n")
+          open(file_path, 'a') do |file|
+            file.puts "# #{heading1}\n\n"
+            file.puts build_target_notes if heading1.include? 'Notes'
+          end
+          create_summary_record(file_path.to_s) unless heading1 =~ /#{target}/i
+        end
+
+      end
+    end
+
+    # build_target_notes builds the content of notes file
+    def build_target_notes
+    <<~NOTES
+    ## To Be Checked
+    
+    
+    ## To Be Deleted
+
+    * Users
+      * user1
+      * user2
+    * Files/Directories/URL
+      * filepath1
+      * filepath1
+
+      NOTES
+    end
+
+    # Create summary records @see #build_targets_files
+    def create_summary_record(file_path)
+      record = File.open('SUMMARY.md', 'a+')
+      path = File.split file_path
+      title = path.last.split('.md').first.capitalize
+      path.delete_if {|p| p == '.'}
+      align = "#{'  ' * path.index(path.last)}* "
+      file_path = "#{file_path}/#{file_path}.md" if File.directory? file_path
+      the_record = "#{align}[#{title}](#{file_path})"
+      record.puts the_record
+      record.close
+      print "\r#{the_record}".cls_upline
+      sleep 0.1
+    end
+
+    # README.md generator
+    def build_project_readme
+      readme = <<~README
+      # #{@project_name}
+      ## Customer Requests and Concerns
+      1. No DoS Attacks
+      2. Automated scan should be gentle at production time 
+      3. ABCDEFG
+
+      | Timeline | Date |
+      | :--- | :--- |
+      | Project Testing Start | 1/1/2030 |
+      | Project Testing End | 1/1/2030 |
+
+      ## Applications progress
+
+      | Host/IP | # of issues | Progress % | Issues | Notes | misc. |
+      | :--- | :--- | :--- | :--- | :--- | :--- |
+      #{@list_of_targets.map {|host| "|#{host}  |  |  |  |  |  |" }.join("\n")}
+
+      ### Point Of Contact
+      | Name | email | Mobile number | Job title/Role |
+      | :--- | :--- | :--- | :--- |
+      | Firstname Lastname | email2@email.com | 0550000000 |  |
+
+      ### Source IP Addresses log
+      This list has to be regularly update!
+
+      | Engineer 1 | Engineer 2 |
+      | :--- | :--- |
+      | x.x.x.x | y.y.y.y |
+      | x.x.x.x | y.y.y.y |
+      | x.x.x.x | y.y.y.y |
+
+      ## Scope
+
+      **Approach:**
+
+      **IP ranges**
+
+      **Domains**
+
+      **Credentials**
+
+      ## Clean up
+      | Host | URL/Files | Description |
+      | :--- | :--- | :--- |
+      |  |  |
+      README
+      File.write('README.md', readme)
+    end
+
+    # general fixes
+    def general_fixes
+      # fix for book.json
+      File.write('book.json', '{ }')
+      # Create 'files' directory, general place for project related files and scripts
+      Dir.mkdir 'files'
+    end
+  end
+
+end

data/lib/hackernote/utils.rb

@@ -0,0 +1,56 @@
+module HackerNote
+  module Utils
+
+    # fix target/project name if the target is a URL (eg. http://example.com/app1/route2/)
+    # @return [String]
+    def fix_project_naming(project)
+      project.gsub(/http[:|s]+\/\//, '').gsub('/', '-').gsub(/-*$/, '')
+    end
+
+    def self.logo
+      slogan = 'The Cyber Daemons - '.reset + 'TechArch'.bold
+      %Q{
+              ______
+        '!!""""""""""""*!!'
+     .u$"!'            .!!"$"
+     *$!        'z`        ($!
+     +$-       .$$&`       !$!
+     +$-      `$$$$3       !$!
+     +$'   !!  '!$!   !!   !$!
+     +$'  ($$.  !$!  '$$!  !$!
+     +$'  $$$$  !$!  $$$$  !$!
+     +$'  .$"   !$!   3$   !$!
+     ($!  `$%`  !3!  .$%   ($!
+      ($(` '"$!    `*$"` ."$!
+       `($(` '"$!.($". ."$!
+         `($(` !$$%. ."$!
+           `!$%$! !$%$!
+              `     `
+                     #{slogan}
+      }.red.bold
+    end
+
+    # banner
+    def self.banner
+      version = "v#{HackerNote::VERSION}".underline.reset
+      %Q{
+                                 ______            ____                                                 ______              ____
+     |         |      .'.      .~      ~.|    ..''|          |`````````,         ..'''' |..          |.~      ~.`````|`````|
+     |_________|    .''```.   |          |..''    |______    |'''|'''''       .''       |  ``..      |          |    |     |______
+     |         |  .'       `. |          |``..    |          |    `.       ..'          |      ``..  |          |    |     |
+     |         |.'           `.`.______.'|    ``..|__________|      `....''             |          ``|`.______.'     |     |___________
+                                                                                                                                 #{version}
+      }.bold
+    end
+
+    # ask method for interactive session with user
+    def ask(question, expected_answer)
+      answer = ''
+      until answer.match?(expected_answer)
+        answer = Readline.readline(question, true)
+      end
+
+      answer
+    end
+  end
+end

data/lib/hackernote/version.rb

@@ -0,0 +1,3 @@
+module HackerNote
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: hackernote
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- KING SABRI
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-17 00:00:00.000000000 Z
+dependencies: []
+description: |-
+  Hacker's Note - A command-line tool creates gitbook compatible structure for pentest and read team projects.
+  Helps security professionals to organize their notes in a gitbook structure for PT/RT engagements.
+email:
+- king.sabri@gmail.com
+executables:
+- hackernote
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/hackernote
+- hackernote.gemspec
+- lib/hackernote.rb
+- lib/hackernote/extensions.rb
+- lib/hackernote/git.rb
+- lib/hackernote/gitbook_builder.rb
+- lib/hackernote/utils.rb
+- lib/hackernote/version.rb
+homepage: https://github.com/TechArchSA/HackersNote
+licenses:
+- MIT
+metadata: {}
+post_install_message: "\e[1m\e[1m\e[31m\n              ______\n        '!!\"\"\"\"\"\"\"\"\"\"\"\"*!!'\n
+  \    .u$\"!'            .!!\"$\"\n     *$!        'z`        ($!\n     +$-       .$$&`
+  \      !$!\n     +$-      `$$$$3       !$!\n     +$'   !!  '!$!   !!   !$!\n     +$'
+  \ ($$.  !$!  '$$!  !$!\n     +$'  $$$$  !$!  $$$$  !$!\n     +$'  .$\"   !$!   3$
+  \  !$!\n     ($!  `$%`  !3!  .$%   ($!\n      ($(` '\"$!    `*$\"` .\"$!\n       `($(`
+  '\"$!.($\". .\"$!\n         `($(` !$$%. .\"$!\n           `!$%$! !$%$!\n              `
+  \    `\n                     \e[0m\e[28mThe Cyber Daemons - \e[0m\e[1mTechArch\e[0m\n
+  \     \e[0m\e[0m"
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Hacker's Note - A command-line tool creates gitbook compatible structure
+  for pentest and read team projects.
+test_files: []