Method: Fuzz.init_optparser

Defined in:

lib/fuzz/fuzz.rb

.init_optparser ⇒ Object

parse commandline arguments

# File 'lib/fuzz/fuzz.rb', line 155

def self.init_optparser
  script_name = File.basename($0)
  if not script_name =~ /fuzz/
    script_name = "ruby "+$0
  end

  options.optparser = opts = OptionParser.new
  opts.banner = "Usage: #{script_name} [options] [glob [glob]]\n\n"
  opts.separator "\n--- [General options] ---\n\n"
  opts.on('-t', '--filetype', '=EXT', String,
          'Defines an alternative filetype to search and scan. Can be specified multiple times.',
          "Default: #{Fuzz::FileObject.extensions.join('|')}") { |v|
            (options.user_config[:exts] ||= []) << v
          }
  opts.on('-f', '--file', '=NAME', String,
          'Defines an alternative filename to search and scan. Can be specified multiple times.',
          "Default: #{Fuzz::FileObject.filenames.join('|')}") { |v|
            (options.user_config[:filenames] ||= []) << v
          }
  opts.on('-a', '--add-files',
          'Add custom filenames and/or filetype extensions to default list instead of replacing defaults.',
          'Default: false') { |v|
            options.user_config[:add_files] = true
          }
  opts.on('-S', '--no-symlinks',
          'Do not follow symlinks.',
          'Default: follow symlinks') { |v|
            options.user_config[:follow_symlink] = false
          }
  opts.on('-P', '--fzzr-path', '=PATH',
          'Adds search path for Fuzzers.',
          "Default: loaded from ~/#{FUZZRC} and/or ./#{FUZZRC}") { |v|
            (options.user_config[:fzzr_paths] ||= []) << v.to_s
          }
  opts.on('-B', '--blacklist', '=FZZRID',
          'Adds Fuzzer ID to list of fuzzers to exclude from Fuzz check.',
          'Default: none') { |v|
            (options.user_config[:fzzr_excludes] ||= []) << v.to_sym
          }
  opts.on('-X', '--exclude', '=MASK',
          'Adds path mask (regular expression) to list to exclude from Fuzz check.',
          'Default: none') { |v|
            (options.user_config[:excludes] ||= []) << v
          }
  opts.on('-c', '--config', '=FUZZRC',
          'Load config from FUZZRC file.',
          "Default:  ~/#{FUZZRC} and/or ./#{FUZZRC}") { |v|
    options.add_config(v)
  }
  opts.on('--write-config', '=[FUZZRC]',
          'Write config to file and exit.',
          "Default: ./#{FUZZRC}") { |v|
    options.user_config.save(String === v ? v : FUZZRC)
    exit
  }
  opts.on('--show-config',
          'Display config settings and exit.') { |v|
    options.load_config
    puts YAML.dump(options.config.__send__ :table)
    exit
  }

  opts.separator ''
  opts.on('-o', '--output', '=FILE', String,
          'Specifies filename to write Fuzz messages to.',
          'Default: stderr') { |v|
            options.output = v
          }
  opts.on('-p', '--apply-fix',
          'Apply fixes (if any) for Fuzz errors.',
          'Default: false') { |v|
            options.apply_fix = true
          }
  opts.on('-n', '--no-recurse',
          'Prevents directory recursion in file selection.',
          'Default: recurse') { |v|
            options.recurse = false
          }
  opts.on('-v', '--verbose',
          'Run with increased verbosity level. Repeat to increase more.',
          'Default: 1') { |v| options.verbose += 1 }

  opts.separator ''
  opts.on('-L', '--list',
          'List available Fuzzers and exit.') {
    options.load_config
    load_fuzzers
    puts "TAOX11 fuzz checker #{FUZZ_VERSION_MAJOR}.#{FUZZ_VERSION_MINOR}.#{FUZZ_VERSION_RELEASE}"
    puts FUZZ_COPYRIGHT
    puts('%-30s %s' % %w{Fuzzer Description})
    puts(('-' * 30)+' '+('-' * 48))
    fuzzers.values.each { |fzzr| puts('%-30s %s' % [fzzr.fuzz_id, fzzr.description]) }
    puts
    exit
  }

  opts.separator ""
  opts.on('-V', '--version',
          'Show version information and exit.') {
    puts "TAOX11 fuzz checker #{FUZZ_VERSION_MAJOR}.#{FUZZ_VERSION_MINOR}.#{FUZZ_VERSION_RELEASE}"
    puts FUZZ_COPYRIGHT
    exit
  }
  opts.on('-h', '--help',
          'Show this help message.') {
    options.load_config
    load_fuzzers
    puts opts;
    puts;
    exit
  }

  opts.separator "\n--- [Fuzzer options] ---\n\n"
end