ruby-hidden-service 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d3aa95dec3863a6310b2b6460d7a6a44d0296c5c
+  data.tar.gz: 9fbc3b5e0ed61b76bf6a77aa094e05184d67e102
+SHA512:
+  metadata.gz: 6e7101cd38223e1cca8c31cd48cd4efc180a12b3191dbc73f8c2bd5943a372aedc68ad7cee3ea152150c2e5bf7fbd4a5348f4010dd4a696d1f1d78860ce1ae5d
+  data.tar.gz: a59fb9b9f6ca002037db1b26cbc42a0907debf1341ae03b9984ae413005d9cc69a225e3e3fa16015e0177d959c754f34139da27ae79acfdc071ab9b43fe2ed97

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (C) 2015 Warren Guy <warren@guy.net.au>
+
+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,58 @@
+# Tor::HiddenService
+
+Bring up a Tor hidden service from within your Ruby app.
+
+You might find this useful to run a hidden service in your Heroku/Dokku or
+other containerised infrastructure.
+
+## Usage
+
+Add the gem to your Gemfile:
+
+```ruby
+gem 'ruby-hidden-service'
+```
+
+and start the hidden service during startup of your web backend, probably
+in `config.ru`, for example:
+
+```ruby
+require 'ruby-hidden-service'
+
+hidden_service = Tor::HiddenService.new(
+  private_key: ENV['HIDDEN_SERVICE_PRIVATE_KEY'],
+  server_port: ENV['PORT'] || 5000
+)
+
+hidden_service.start
+```
+### Options
+
+All configuration options and their defaults:
+```ruby
+tor_executable:      (Tor.available? ? Tor.program_path : nil),
+temp_dir:            "#{ENV['PWD']}/tmp" || nil,
+private_key:         nil,
+server_host:         'localhost',
+server_port:         ENV['PORT'],
+hidden_service_port: 80,
+tor_control_port:    rand(10000..65000)
+```
+
+### Tor executable
+
+This relies on Tor being in your path, or otherwise having the path to the
+Tor binary specified in the options hash. If you're running on Heroku or
+Dokku, you can use the [heroku-buildpack-apt](https://github.com/ddollar/heroku-buildpack-apt) and [heroku-buildpack-multi](https://github.com/ddollar/heroku-buildpack-multi)
+buildpacks to install the `tor` package. This will place the Tor binary in
+the path where this library can discover it.
+
+## License
+
+MIT license. See [LICENSE](https://github.com/warrenguy/ruby-hidden-service/blob/master/LICENSE).
+
+## Author
+
+Warren Guy <warren@guy.net.au>
+
+https://warrenguy.me

data/lib/tor/hidden-service.rb

@@ -0,0 +1,102 @@
+require 'tor'
+require 'openssl'
+require 'fileutils'
+
+module Tor
+  class HiddenService
+
+    attr_reader :options
+
+    def initialize(options={})
+      @options = parse_options(options)
+      @base_dir = "#{@options[:temp_dir]}/tor_#{@options[:tor_control_port]}"
+    end
+
+    def start
+      generate_tor_config
+
+      @pid = fork do
+        spawn @options[:tor_executable], '-f',  "#{@base_dir}/torrc"
+      end
+      Process.wait(@pid)
+
+      begin
+        @tor_pid = File.read(open("#{@base_dir}/pid")).strip.to_i
+      rescue Errno::ENOENT
+        log_message "Waiting for Tor PID to appear..."
+        sleep 1
+        retry
+      end
+
+      log_message "Started Tor with PID #{@tor_pid} on control port #{@options[:tor_control_port]}"
+
+      at_exit do
+        log_message "Killing Tor PID #{@tor_pid}..."
+        Process.kill :SIGTERM, @tor_pid
+        Process.wait
+      end
+    end
+
+    private
+
+    def parse_options(options)
+      parsed_options = {
+        tor_executable:      (Tor.available? ? Tor.program_path : nil),
+        temp_dir:            "#{ENV['PWD']}/tmp" || nil,
+        private_key:         nil,
+        server_host:         'localhost',
+        server_port:         ENV['PORT'],
+        hidden_service_port: 80,
+        tor_control_port:    rand(10000..65000)
+      }.merge(options)
+
+      raise ArgumentError, "No tor executable found" unless parsed_options[:tor_executable]
+      raise ArgumentError, "temp_dir #{parsed_options[:temp_dir]} does not exist or is not writable" unless (
+        File.writable? parsed_options[:temp_dir] or
+        FileUtils.mkdir_p parsed_options[:temp_dir])
+      raise ArgumentError, "Private key is not a valid 1024 bit RSA private key" unless (
+        OpenSSL::PKey::RSA.new(parsed_options[:private_key]).private? and
+        OpenSSL::PKey::RSA.new(parsed_options[:private_key]).n.num_bits == 1024)
+      raise ArgumentError, "Must provide option: #{parsed_options.key(nil).to_s}" if parsed_options.values.include? nil
+
+      return parsed_options
+    end
+
+    def generate_tor_config
+      tor_config = {
+        DataDirectory:     "#{@base_dir}/data",
+        ControlPort:       "#{@options[:tor_control_port]}",
+        HiddenServiceDir:  "#{@base_dir}/hidden_service",
+        HiddenServicePort: "#{@options[:hidden_service_port]} #{@options[:server_host]}:#{@options[:server_port]}",
+        PidFile:           "#{@base_dir}/pid",
+        RunAsDaemon:       1,
+        SocksPort:         0
+      }
+
+      begin
+        FileUtils.mkdir_p tor_config[:DataDirectory]
+        FileUtils.mkdir_p tor_config[:HiddenServiceDir]
+        File.write("#{tor_config[:HiddenServiceDir]}/private_key", @options[:private_key])
+        FileUtils.chmod 0700, tor_config[:HiddenServiceDir]
+        FileUtils.chmod 0600, "#{tor_config[:HiddenServiceDir]}/private_key"
+
+        File.write(
+          "#{@base_dir}/torrc",
+          tor_config.map{|k,v| "#{k} #{v}"}.join("\n"))
+      rescue => e
+        raise "Error creating configuration: #{e}"
+      end
+
+      return true
+    end
+
+    def log_message(message)
+      $stdout.puts "Tor::HiddenService: [#{@options[:tor_control_port]}]: #{message}"
+    end
+
+    def log_error(message)
+      $stderr.puts "Tor::HiddenService: [#{@options[:tor_control_port]}]: ERROR: #{message}"
+    end
+
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: ruby-hidden-service
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Warren Guy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Automatically set up and tear down a Tor hidden service
+email: warren@guy.net.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/tor/hidden-service.rb
+homepage: https://github.com/warrenguy/ruby-hidden-service
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Automatically set up and tear down a Tor hidden service
+test_files: []