hidr 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode
+  - rbx-2.1.1
+script: bundle exec rspec spec

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Andrew Tongen
+
+MIT License
+
+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,60 @@
+# Hidr
+
+Hide your strings!
+
+[![Build Status](https://travis-ci.org/atongen/hidr.png)](https://travis-ci.org/atongen/hidr)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hidr'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hidr
+
+## Usage
+
+Hidr allows you to obscure strings in other strings by facilitating a two-way conversion
+between a string and a binary version of that string.
+
+The resulting binary characters can be any two charaters. By default it uses a space and a tab.
+
+```ruby
+h = hidr::Hidr.new(b0: 'a', b1: 'z')
+result = h.hide('Wow!')
+```
+
+After running this code, result will contain "zzzazazazzzzazzazzzazzzazaaaazaa".
+
+It comes with a few commonly used mappings already setup: ascii, unicode, orly.
+Call the class method of the same name to get these hidrs.
+
+You can use Hidr from bash with the `hidr` executable. For example:
+
+```
+% echo Some important stuff | bin/hidr -h
+110010101111011010110110101001100000010010010110101101100000111011110110010011100010111010000110011101100010111000000100110011100010111010101110011001100110011001010000
+```
+
+or even
+
+```
+% echo Some important stuff | bin/hidr -h | bin/hidr -s
+Some important stuff
+```
+
+Type `hidr --help` after gem installation for usage.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/bin/hidr

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) if File.directory?(lib) &&
+  !$LOAD_PATH.include?(lib)
+require 'hidr/hidr_command'
+Hidr::HidrCommand.new(ARGV).run!

data/hidr.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hidr/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hidr"
+  spec.version       = Hidr::VERSION
+  spec.authors       = ["Andrew Tongen"]
+  spec.email         = ["atongen@gmail.com"]
+  spec.description   = %q{Hide your strings!}
+  spec.summary       = %q{Convert strings to and from a binary representation}
+  spec.homepage      = "https://github.com/atongen/hidr"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/hidr.rb

@@ -0,0 +1,23 @@
+require "hidr/version"
+require "hidr/hidr"
+
+# Hidr can be used to obscure strings in other utf-8 strings.
+# This is not encryption, it's obfuscation.
+module Hidr
+  CHARS = {
+    binary:  ["0", "1"],
+    ascii:   ["\s","\t"],
+    unicode: ["\u200B","\uFEFF"],
+    orly:    ["\u0CA0", "\u005F"],
+    niceday: ["\s", "\u263A"]
+  }
+
+  class << self
+    def build(type)
+      if CHARS.has_key?(type)
+        ::Hidr::Hidr.new(b0: CHARS[type].first, b1: CHARS[type].last)
+      end
+    end
+    CHARS.keys.each { |key| class_eval("def #{key}; build(:#{key}); end") }
+  end
+end

data/lib/hidr/hidr.rb

@@ -0,0 +1,13 @@
+require 'hidr/impl'
+
+module Hidr
+  class Hidr
+    include Impl
+
+    def initialize(*o)
+      @o = o.last.is_a?(Hash) ? o.pop : {}
+      @o[:b0] ||= ::Hidr::CHARS[:ascii].first
+      @o[:b1] ||= ::Hidr::CHARS[:ascii].last
+    end
+  end
+end

data/lib/hidr/hidr_command.rb

@@ -0,0 +1,136 @@
+require 'hidr'
+require 'optparse'
+
+module Hidr
+  class HidrCommand
+
+    attr_reader :options
+
+    def initialize(argv)
+      @argv = argv.dup
+
+      @options = {
+        mode:    nil,
+        infile:  '-',
+        outfile: '-',
+        force:   false,
+        b0:      '0',
+        b1:      '1',
+        debug:   false
+      }
+
+      parse!
+    end
+
+    def run!
+      validate_mode
+      hidr = build_hidr
+      data = read_data
+      get_writer do |writer|
+        if @options[:mode] == 'hide'
+          writer.print hidr.hide(data)
+        else
+          writer.print hidr.show(data)
+        end
+      end
+    end
+
+    private
+
+    def parser
+      @parser ||= OptionParser.new do |opts|
+        opts.banner = "Usage: hidr [options]"
+
+        opts.separator ""
+        opts.separator "Mode:"
+        opts.on("-h", "--hide", "hide mode") { @options[:mode] = 'hide' }
+        opts.on("-s", "--show", "show mode") { @options[:mode] = 'show' }
+
+        opts.separator ""
+        opts.separator "Bits:"
+        opts.on("-0", "--zero CHAR", "zero char (default: '#{@options[:b0]}')") { |char| @options[:b0] = char }
+        opts.on("-1", "--one CHAR", "one char (default: '#{@options[:b1]}')") { |char| @options[:b1] = char }
+        opts.on("-b", "--builtin BUILTIN", "built-in binary set (overrides zero and one, options: #{::Hidr::CHARS.keys.join(', ')})") { |builtin| @options[:builtin] = builtin.to_s.strip.to_sym }
+
+        opts.separator ""
+        opts.separator "Files:"
+        opts.on("-i", "--infile FILE", "infile (default: '#{@options[:infile]}')") { |file| @options[:infile] = file }
+        opts.on("-o", "--outfile FILE", "outfile (default: '#{@options[:outfile]}')") { |file| @options[:outfile] = file }
+        opts.on("-f", "--force", "force overwrite outfile (default: #{@options[:force]})") { @options[:force] = true }
+
+        opts.separator ""
+        opts.separator "Common options:"
+
+        opts.on_tail("-D", "--debug", "Set debugging on") { @options[:debug] = true }
+        opts.on_tail("-H", "--help", "Show this message") { puts opts; exit }
+        opts.on_tail('-v', '--version', "Show version") { puts Hidr::VERSION; exit }
+      end
+    end
+
+    def parse!
+      parser.parse!(@argv)
+    end
+
+    # run methods
+
+    def validate_mode
+      unless %w{ hide show }.include?(@options[:mode])
+        STDERR.puts "Mode (show or hide) is required."
+        exit 1
+      end
+    end
+
+    def build_hidr
+      if @options[:builtin]
+        if ::Hidr::CHARS.keys.include?(@options[:builtin])
+          ::Hidr.send(@options[:builtin])
+        else
+          STDERR.puts "Invalid builtin: #{@options[:builtin]}"
+          exit 1
+        end
+      else
+        ::Hidr::Hidr.new(b0: @options[:b0], b1: @options[:b1])
+      end
+    end
+
+    def read_data
+      if @options[:infile] == '-'
+        # requires ARGV clear
+        STDIN.read
+      elsif File.file?(@options[:infile])
+        File.read(@options[:infile])
+      else
+        STDERR.puts "Invalid infile: #{@options[:infile]}"
+        exit 1
+      end
+    end
+
+    def get_writer
+      begin
+        if @options[:outfile] == '-'
+          writer = STDOUT
+        elsif File.file?(@options[:outfile])
+          if @options[:force]
+            writer = File.open(@options[:outfile], 'wb')
+          else
+            STDERR.puts "Not overwriting file without force"
+            exit 1
+          end
+        else
+          writer = File.open(@options[:outfile], 'wb')
+        end
+
+        yield(writer)
+      rescue => e
+        STDERR.puts "Error writing data: #{e}"
+        exit 1
+      ensure
+        # clean-up
+        if writer && @options[:outfile] != '-'
+          writer.close
+        end
+      end
+    end
+
+  end
+end

data/lib/hidr/impl.rb

@@ -0,0 +1,12 @@
+# encoding: UTF-8
+#
+# Hidr::Impl provides methods that convert a string
+# to and from a binary representation.
+module Hidr
+  module Impl
+    def h(m);m.unpack('b*').first.split("").map{|v|v=='0'?@o[:b0]:@o[:b1]}.join;end
+    def s(n);[n.chars.to_a.map{|y|y==@o[:b0]?'0':'1'}.join].pack('b*');end
+    def e(o);s(h(o));end
+    { hide: :h, show: :s, echo: :e }.each { |k,v| alias_method k, v }
+  end
+end

data/lib/hidr/version.rb

@@ -0,0 +1,3 @@
+module Hidr
+  VERSION = "0.0.1"
+end

data/spec/hidr_command_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+require 'hidr/hidr_command'
+
+describe Hidr::HidrCommand do
+
+  subject(:cmd) { Hidr::HidrCommand.new(args.split(" ")) }
+  let(:args) { nil }
+
+  context 'parse' do
+    context 'hide' do
+      let(:args) { "-h -0 a -1 b -i /tmp/in.txt -o /tmp/out.txt -f -D" }
+
+      it 'should parse hide options' do
+        cmd.options[:mode].should eql('hide')
+        cmd.options[:b0].should eql('a')
+        cmd.options[:b1].should eql('b')
+        cmd.options[:infile].should eql('/tmp/in.txt')
+        cmd.options[:outfile].should eql('/tmp/out.txt')
+        cmd.options[:force].should be_true
+        cmd.options[:debug].should be_true
+      end
+    end
+
+    context 'show' do
+      let(:args) { "-s -0 a -1 b -i /tmp/in.txt -o /tmp/out.txt -f -D" }
+
+      it 'should parse show options' do
+        cmd.options[:mode].should eql('show')
+        cmd.options[:b0].should eql('a')
+        cmd.options[:b1].should eql('b')
+        cmd.options[:infile].should eql('/tmp/in.txt')
+        cmd.options[:outfile].should eql('/tmp/out.txt')
+        cmd.options[:force].should be_true
+        cmd.options[:debug].should be_true
+      end
+    end
+
+    context 'builtin' do
+      let(:args) { "-s -b orly -i /tmp/in.txt -o /tmp/out.txt -f -D" }
+
+      it 'should recognize built-in hidrs' do
+        hidr = cmd.send(:build_hidr)
+        opts = hidr.instance_variable_get(:@o)
+        opts[:b0].should eql("\u0CA0")
+        opts[:b1].should eql("\u005F")
+      end
+    end
+  end
+end

data/spec/hidr_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Hidr do
+  let(:hidr)  { nil }
+  let(:ascii) { SecureRandom.base64(10240) }
+  let(:bytes) { SecureRandom.random_bytes(10240) }
+
+  context "ascii out" do
+    let(:hidr) { Hidr.ascii }
+
+    it 'should echo ascii' do
+      hidr.echo(ascii).should eql(ascii)
+    end
+
+    it 'should echo bytes' do
+      hidr.echo(bytes).should eql(bytes)
+    end
+  end
+
+  context "unicode out" do
+    let(:hidr) { Hidr.unicode }
+
+    it 'should echo ascii' do
+      hidr.echo(ascii).should eql(ascii)
+    end
+
+    it 'should echo bytes' do
+      hidr.echo(bytes).should eql(bytes)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'hidr'
+require 'securerandom'
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: hidr
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Andrew Tongen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Hide your strings!
+email:
+- atongen@gmail.com
+executables:
+- hidr
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/hidr
+- hidr.gemspec
+- lib/hidr.rb
+- lib/hidr/hidr.rb
+- lib/hidr/hidr_command.rb
+- lib/hidr/impl.rb
+- lib/hidr/version.rb
+- spec/hidr_command_spec.rb
+- spec/hidr_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/atongen/hidr
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Convert strings to and from a binary representation
+test_files:
+- spec/hidr_command_spec.rb
+- spec/hidr_spec.rb
+- spec/spec_helper.rb
+has_rdoc: