pipe2me-client 0.2.0

data/lib/pipe2me/ext/shell_format.rb

@@ -0,0 +1,69 @@
+require "shellwords"
+require_relative "./file_ext"
+
+module Pipe2me::ShellFormat
+  extend self
+
+  def write(path, data)
+    File.atomic_write path, dump(data)
+  end
+
+  def read(path)
+    parse File.read(path)
+  end
+
+  def dump(obj, prefix=nil)
+    format_entries([], obj, prefix).join
+  end
+
+  alias :shell :dump
+
+  PREFIX = "PIPE2ME"
+
+  def parse(data)
+    arrays = {}
+
+    prefix_re = Regexp.compile(/^#{PREFIX.downcase}_/)
+
+    data.lines.inject({}) do |hsh, line|
+      key, value = line.split(/\s*=\s*/, 2)
+      value.gsub!(/\s*$/, "")
+      value = Integer(value) rescue value
+
+      if key =~ /^(.*)_(\d+)$/
+        ary = arrays[$1] ||= []
+        ary[$2.to_i] = value
+        key, value = $1, ary
+      end
+
+      hsh.update key.downcase.gsub(prefix_re, "").to_sym => value
+    end
+  end
+
+  private
+
+  def format_entries(ary, obj, prefix)
+    case obj
+    when Array
+      prefix = "#{prefix}_" if prefix
+      obj.each_with_index do |entry, idx|
+        format_entries ary, entry, "#{prefix}#{idx}"
+      end
+      ary
+    when Hash
+      prefix = "#{prefix}_" if prefix
+      obj.each do |key, value|
+        format_entries ary, value, "#{prefix}#{key.upcase}"
+      end
+      ary
+    when defined?(ActiveRecord::Relation) ? ActiveRecord::Relation : nil
+      format_entries(ary, obj.to_a, prefix)
+    else
+      if obj.respond_to?(:attributes)
+        format_entries(ary, obj.attributes, prefix)
+      else
+        ary << "#{PREFIX}_#{prefix}=#{Shellwords.escape(obj)}\n"
+      end
+    end
+  end
+end

data/lib/pipe2me/ext/sys.rb

@@ -0,0 +1,38 @@
+require "shellwords"
+
+module Pipe2me::Sys
+  extend self
+  
+  class ExitError < RuntimeError; end
+  
+  def sys(*args)
+    cmd, stdout = _sys(*args)
+    return stdout if $?.exitstatus == 0
+  end
+  
+  def sys!(*args)
+    cmd, stdout = _sys(*args)
+    return stdout if $?.exitstatus == 0
+    raise ExitError, "#{cmd} failed with exit code #{$?.exitstatus}"
+  end
+
+  def sh(*args)
+    sys "sh", "-c", *args
+  end
+  
+  def sh!(*args)
+    sys! "sh", "-c", *args
+  end
+  
+  private
+  
+  def _sys(*args)
+    cmd = args.
+      map { |arg| Shellwords.escape arg.to_s }.
+      join(" ")
+    
+    UI.debug cmd
+    stdout = IO.popen(cmd, &:read)
+    [ cmd, stdout ]
+  end
+end

data/lib/pipe2me/tunnel.rb

@@ -0,0 +1,78 @@
+require "pipe2me/ext/http"
+require "pipe2me/ext/sys"
+require "pipe2me/ext/shell_format"
+
+module Pipe2me::Tunnel
+  # file names
+  SSL_KEY     = "pipe2me.openssl.priv"
+  SSL_CERT    = "pipe2me.openssl.cert"
+
+  SSH_PUBKEY  = "pipe2me.id_rsa.pub"
+  SSH_PRIVKEY = "pipe2me.id_rsa"
+end
+
+require_relative "tunnel/openssl"
+require_relative "tunnel/ssh"
+require_relative "tunnel/commands"
+
+module Pipe2me::Tunnel
+  ShellFormat = Pipe2me::ShellFormat
+  include Pipe2me::Sys
+
+  include OpenSSL
+  include SSH
+  include Commands
+
+  extend self
+
+  def setup(options)
+    if File.exists?("pipe2me.info.inc")
+      raise "Found existing pipe2me configuration in #{Dir.getwd}"
+    end
+
+    # [todo] escape auth option
+    response = HTTP.post! "#{Pipe2me::Config.server}/tunnels/#{options[:auth]}",
+      "protocols" => options[:protocols]
+
+    server_info = ShellFormat.parse(response)
+
+    raise(ArgumentError, "Missing :fqdn information") unless server_info[:fqdn]
+
+    ShellFormat.write "pipe2me.info.inc", server_info
+    ShellFormat.write "pipe2me.local.inc",
+                        :server => Pipe2me::Config.server,
+                        :ports => options[:ports]
+
+    server_info
+  end
+
+  private
+
+  # The base URL for this tunnels' configuration
+  def url
+    "#{config.server}/tunnels/#{config.token}"
+  end
+
+  def config
+    @config ||= begin
+      hsh = { :ports => [] }
+      hsh.update ShellFormat.read("pipe2me.info.inc")
+      hsh.update ShellFormat.read("pipe2me.local.inc")
+      OpenStruct.new hsh
+    end
+  end
+
+  public
+
+  def update
+    unless File.exists?(SSH_PRIVKEY)
+      ssh_keygen
+    end
+    unless File.exists?(SSL_KEY)
+      ssl_keygen
+    end
+    unless File.exists?(SSL_CERT)
+      ssl_certsign
+    end
+  end
+end

data/lib/pipe2me/tunnel/commands.rb

@@ -0,0 +1,68 @@
+module Pipe2me::Tunnel::Commands
+  extend self
+
+  T = Pipe2me::Tunnel
+
+  private
+  
+  # returns an array of [ protocol, remote_port, local_port ] entries
+  def tunnels
+    @tunnels ||= begin
+      urls, ports = config.urls, config.ports
+    
+      urls.zip(ports).map do |url, local_port|
+        uri = URI.parse(url)
+        [ uri.scheme, uri.port, local_port || uri.port ]
+      end
+    end
+  end
+
+  public
+  
+  # return an arry [ [name, command ], [name, command ], .. ]
+  def tunnel_commands
+    tunnel_uri = URI.parse config.tunnel
+    
+    tunnels.map do |protocol, remote_port, local_port|
+      next unless cmd = port_tunnel_command(tunnel_uri, protocol, remote_port, local_port)
+      [ "#{protocol}_#{remote_port}", cmd ]
+    end.compact
+  end
+  
+  def echo_commands
+    tunnels.map do |protocol, remote_port, local_port|
+      next unless cmd = echo_server_command(protocol, local_port)
+      [ "echo_#{remote_port}", cmd ]
+    end.compact
+  end
+
+  private
+  
+  def port_tunnel_command(tunnel_uri, protocol, remote_port, local_port)
+    autossh = `which autossh`.chomp
+    
+    cmd = <<-SHELL
+      env AUTOSSH_GATETIME=0                                # comments work here..
+      #{autossh}
+      -M 0
+      #{tunnel_uri.user}@#{tunnel_uri.host}
+      -p #{tunnel_uri.port}
+      -R 0.0.0.0:#{remote_port}:localhost:#{local_port}
+      -i #{T::SSH_PRIVKEY}
+      -o StrictHostKeyChecking=no
+      -o UserKnownHostsFile=pipe2me.known_hosts
+      -N
+    SHELL
+    
+    # remove comments and newlines from commands
+    cmd.gsub(/( *#.*|\s+)/, " ").gsub(/(^ )|( $)/, "")
+  end  
+
+  def echo_server_command(protocol, port)
+    binary = File.dirname(__FILE__) + "/echo/#{protocol}"
+    return unless File.executable?(binary)
+
+    UI.info "Starting #{protocol} echo server on port #{port}"
+    "env PORT=#{port} #{binary}"
+  end
+end

data/lib/pipe2me/tunnel/echo/http

@@ -0,0 +1,56 @@
+#!/usr/bin/env ruby
+#
+# Derived from https://github.com/radiospiel/inspector
+
+# -- A rack application -------------------------------------------------------
+
+require "rack"
+
+def format_hash(hash)
+  hash.to_a.
+    sort_by(&:first).map do |key, value| 
+      "%25s: %s\n" % [ key.to_s.gsub(/^HTTP_/, ""), value.inspect ] 
+    end.
+    join
+end
+
+def insp(env)
+  request = Rack::Request.new(env)
+  headers, process_env = env.partition do |k,v| k =~ /^HTTP_/ end
+  [
+    "# Request\n\n",
+    format_hash(request_method: request.request_method, fullpath: request.fullpath),
+    "\n# Headers\n\n",
+    format_hash(headers),
+    "\n# process environment\n\n",
+    format_hash(ENV)
+  ].join("\n")
+end
+
+Application = proc do |env|
+  req = Rack::Request.new(env)
+  body = req.path != "/" ? "#{req.request_method} #{req.fullpath}\n" : insp(env)
+  
+  [
+    200, 
+    { 'Content-Type' => 'text/plain' }, 
+    [ body ]
+  ]
+end
+
+# -- configure rack server ----------------------------------------------------
+
+require "webrick/https"
+
+RACK_SERVER_OPTIONS = {
+  :app => Application,
+  :BindAddress => "localhost",
+  :Port => ENV["PORT"] || 8080,
+  :server => "webrick",
+  :Logger => WEBrick::BasicLog.new($stderr, WEBrick::BasicLog::WARN)
+}
+
+if $0 == __FILE__
+  puts "Starting http server at port #{RACK_SERVER_OPTIONS[:Port]}"
+  Rack::Server.start(RACK_SERVER_OPTIONS)
+end

data/lib/pipe2me/tunnel/echo/https

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+#
+
+load "#{File.dirname(__FILE__)}/http"
+
+cert = OpenSSL::X509::Certificate.new File.read("pipe2me.openssl.cert")
+pkey = OpenSSL::PKey::RSA.new File.read("pipe2me.openssl.priv")
+
+RACK_SERVER_OPTIONS.update SSLEnable: true,
+  SSLVerifyClient:        OpenSSL::SSL::VERIFY_NONE,
+  SSLPrivateKey:          pkey, 
+  SSLCertificate:         cert,
+  SSLCertName:            [["CN", WEBrick::Utils::getservername]]
+
+if $0 == __FILE__
+  puts "Starting https server at port #{RACK_SERVER_OPTIONS[:Port]}"
+  Rack::Server.start(RACK_SERVER_OPTIONS)
+end

data/lib/pipe2me/tunnel/openssl.conf

@@ -0,0 +1,351 @@
+#
+# OpenSSL example configuration file.
+# This is mostly being used for generation of certificate requests.
+#
+
+# This definition stops the following lines choking if HOME isn't
+# defined.
+HOME			  = .
+RANDFILE		= pipe2me.openssl.rnd
+
+# Extra OBJECT IDENTIFIER info:
+oid_file		= pipe2me.openssl.oid
+oid_section		= new_oids
+
+# To use this configuration file with the "-extfile" option of the
+# "openssl x509" utility, name here the section containing the
+# X.509v3 extensions to use:
+# extensions		= 
+# (Alternatively, use a configuration file that has only
+# X.509v3 extensions in its main [= default] section.)
+
+[ new_oids ]
+
+# We can add new OIDs in here for use by 'ca', 'req' and 'ts'.
+# Add a simple OID like this:
+# testoid1=1.2.3.4
+# Or use config file substitution like this:
+# testoid2=${testoid1}.5.6
+
+# Policies used by the TSA examples.
+tsa_policy1 = 1.2.3.4.1
+tsa_policy2 = 1.2.3.4.5.6
+tsa_policy3 = 1.2.3.4.5.7
+
+####################################################################
+[ ca ]
+default_ca	= CA_default		# The default ca section
+
+####################################################################
+[ CA_default ]
+
+dir			= pipe2me.openssl.ca
+certs		= $dir/certs		# Where the issued certs are kept
+crl_dir		= $dir/crl		# Where the issued crl are kept
+database	= $dir/index.txt	# database index file.
+#unique_subject	= no			# Set to 'no' to allow creation of
+					# several ctificates with same subject.
+unique_subject = no
+new_certs_dir	= $dir/newcerts		# default place for new certs.
+
+certificate	= $dir/root/certificate.pem			# The CA certificate
+serial			= $dir/serial 									# The current serial number
+#crlnumber	= $dir/crlnumber	# the current crl number
+					# must be commented out to leave a V1 CRL
+crl					= $dir/crl.pem 		# The current CRL
+private_key	= $dir/root/private_key.pem # The private key
+RANDFILE		= $dir/private/.rand	# private random number file
+
+x509_extensions	= usr_cert		# The extentions to add to the cert
+
+# Comment out the following two lines for the "traditional"
+# (and highly broken) format.
+name_opt 	= ca_default		# Subject Name options
+cert_opt 	= ca_default		# Certificate field options
+
+# Extension copying option: use with caution.
+# copy_extensions = copy
+
+# Extensions to add to a CRL. Note: Netscape communicator chokes on V2 CRLs
+# so this is commented out by default to leave a V1 CRL.
+# crlnumber must also be commented out to leave a V1 CRL.
+# crl_extensions	= crl_ext
+
+default_days	= 365			# how long to certify for
+default_crl_days= 30			# how long before next CRL
+default_md	= sha1		# use public key default MD
+preserve	= no			# keep passed DN ordering
+
+# A few difference way of specifying how similar the request should look
+# For type CA, the listed attributes must be the same, and the optional
+# and supplied fields are just that :-)
+policy		= policy_match
+
+# For the CA policy
+[ policy_match ]
+countryName		= match
+stateOrProvinceName	= match
+organizationName	= match
+organizationalUnitName	= optional
+commonName		= supplied
+emailAddress		= optional
+
+# For the 'anything' policy
+# At this point in time, you must list all acceptable 'object'
+# types.
+[ policy_anything ]
+countryName		= optional
+stateOrProvinceName	= optional
+localityName		= optional
+organizationName	= optional
+organizationalUnitName	= optional
+commonName		= supplied
+emailAddress		= optional
+
+####################################################################
+[ req ]
+default_bits		= 1024
+default_keyfile 	= privkey.pem
+distinguished_name	= req_distinguished_name
+attributes		= req_attributes
+x509_extensions	= v3_ca	# The extentions to add to the self signed cert
+
+# Passwords for private keys if not present they will be prompted for
+# input_password = secret
+# output_password = secret
+
+# This sets a mask for permitted string types. There are several options. 
+# default: PrintableString, T61String, BMPString.
+# pkix	 : PrintableString, BMPString (PKIX recommendation before 2004)
+# utf8only: only UTF8Strings (PKIX recommendation after 2004).
+# nombstr : PrintableString, T61String (no BMPStrings or UTF8Strings).
+# MASK:XXXX a literal mask value.
+# WARNING: ancient versions of Netscape crash on BMPStrings or UTF8Strings.
+string_mask = utf8only
+
+# req_extensions = v3_req # The extensions to add to a certificate request
+
+[ req_distinguished_name ]
+countryName			= Country Name (2 letter code)
+countryName_default		= AU
+countryName_min			= 2
+countryName_max			= 2
+
+stateOrProvinceName		= State or Province Name (full name)
+stateOrProvinceName_default	= Some-State
+
+localityName			= Locality Name (eg, city)
+
+0.organizationName		= Organization Name (eg, company)
+0.organizationName_default	= Internet Widgits Pty Ltd
+
+# we can do this but it is not needed normally :-)
+#1.organizationName		= Second Organization Name (eg, company)
+#1.organizationName_default	= World Wide Web Pty Ltd
+
+organizationalUnitName		= Organizational Unit Name (eg, section)
+#organizationalUnitName_default	=
+
+commonName			= Common Name (eg, YOUR name)
+commonName_max			= 64
+
+emailAddress			= Email Address
+emailAddress_max		= 64
+
+# SET-ex3			= SET extension number 3
+
+[ req_attributes ]
+challengePassword		= A challenge password
+challengePassword_min		= 4
+challengePassword_max		= 20
+
+unstructuredName		= An optional company name
+
+[ usr_cert ]
+
+# These extensions are added when 'ca' signs a request.
+
+# This goes against PKIX guidelines but some CAs do it and some software
+# requires this to avoid interpreting an end user certificate as a CA.
+
+basicConstraints=CA:FALSE
+
+# Here are some examples of the usage of nsCertType. If it is omitted
+# the certificate can be used for anything *except* object signing.
+
+# This is OK for an SSL server.
+# nsCertType			= server
+
+# For an object signing certificate this would be used.
+# nsCertType = objsign
+
+# For normal client use this is typical
+# nsCertType = client, email
+
+# and for everything including object signing:
+# nsCertType = client, email, objsign
+
+# This is typical in keyUsage for a client certificate.
+# keyUsage = nonRepudiation, digitalSignature, keyEncipherment
+
+# This will be displayed in Netscape's comment listbox.
+nsComment			= "OpenSSL Generated Certificate"
+
+# PKIX recommendations harmless if included in all certificates.
+subjectKeyIdentifier=hash
+authorityKeyIdentifier=keyid,issuer
+
+# This stuff is for subjectAltName and issuerAltname.
+# Import the email address.
+# subjectAltName=email:copy
+# An alternative to produce certificates that aren't
+# deprecated according to PKIX.
+# subjectAltName=email:move
+
+# Copy subject details
+# issuerAltName=issuer:copy
+
+#nsCaRevocationUrl		= http://www.domain.dom/ca-crl.pem
+#nsBaseUrl
+#nsRevocationUrl
+#nsRenewalUrl
+#nsCaPolicyUrl
+#nsSslServerName
+
+# This is required for TSA certificates.
+# extendedKeyUsage = critical,timeStamping
+
+[ v3_req ]
+
+# Extensions to add to a certificate request
+
+basicConstraints = CA:FALSE
+keyUsage = nonRepudiation, digitalSignature, keyEncipherment
+
+[ v3_ca ]
+
+
+# Extensions for a typical CA
+
+
+# PKIX recommendation.
+
+subjectKeyIdentifier=hash
+
+authorityKeyIdentifier=keyid:always,issuer
+
+# This is what PKIX recommends but some broken software chokes on critical
+# extensions.
+#basicConstraints = critical,CA:true
+# So we do this instead.
+basicConstraints = CA:true
+
+# Key usage: this is typical for a CA certificate. However since it will
+# prevent it being used as an test self-signed certificate it is best
+# left out by default.
+# keyUsage = cRLSign, keyCertSign
+
+# Some might want this also
+# nsCertType = sslCA, emailCA
+
+# Include email address in subject alt name: another PKIX recommendation
+# subjectAltName=email:copy
+# Copy issuer details
+# issuerAltName=issuer:copy
+
+# DER hex encoding of an extension: beware experts only!
+# obj=DER:02:03
+# Where 'obj' is a standard or added object
+# You can even override a supported extension:
+# basicConstraints= critical, DER:30:03:01:01:FF
+
+[ crl_ext ]
+
+# CRL extensions.
+# Only issuerAltName and authorityKeyIdentifier make any sense in a CRL.
+
+# issuerAltName=issuer:copy
+authorityKeyIdentifier=keyid:always
+
+[ proxy_cert_ext ]
+# These extensions should be added when creating a proxy certificate
+
+# This goes against PKIX guidelines but some CAs do it and some software
+# requires this to avoid interpreting an end user certificate as a CA.
+
+basicConstraints=CA:FALSE
+
+# Here are some examples of the usage of nsCertType. If it is omitted
+# the certificate can be used for anything *except* object signing.
+
+# This is OK for an SSL server.
+# nsCertType			= server
+
+# For an object signing certificate this would be used.
+# nsCertType = objsign
+
+# For normal client use this is typical
+# nsCertType = client, email
+
+# and for everything including object signing:
+# nsCertType = client, email, objsign
+
+# This is typical in keyUsage for a client certificate.
+# keyUsage = nonRepudiation, digitalSignature, keyEncipherment
+
+# This will be displayed in Netscape's comment listbox.
+nsComment			= "OpenSSL Generated Certificate"
+
+# PKIX recommendations harmless if included in all certificates.
+subjectKeyIdentifier=hash
+authorityKeyIdentifier=keyid,issuer
+
+# This stuff is for subjectAltName and issuerAltname.
+# Import the email address.
+# subjectAltName=email:copy
+# An alternative to produce certificates that aren't
+# deprecated according to PKIX.
+# subjectAltName=email:move
+
+# Copy subject details
+# issuerAltName=issuer:copy
+
+#nsCaRevocationUrl		= http://www.domain.dom/ca-crl.pem
+#nsBaseUrl
+#nsRevocationUrl
+#nsRenewalUrl
+#nsCaPolicyUrl
+#nsSslServerName
+
+# This really needs to be in place for it to be a proxy certificate.
+proxyCertInfo=critical,language:id-ppl-anyLanguage,pathlen:3,policy:foo
+
+####################################################################
+[ tsa ]
+
+default_tsa = tsa_config1	# the default TSA section
+
+[ tsa_config1 ]
+
+# These are used by the TSA reply generation only.
+dir		= ./demoCA		# TSA root directory
+serial		= $dir/tsaserial	# The current serial number (mandatory)
+crypto_device	= builtin		# OpenSSL engine to use for signing
+signer_cert	= $dir/tsacert.pem 	# The TSA signing certificate
+					# (optional)
+certs		= $dir/cacert.pem	# Certificate chain to include in reply
+					# (optional)
+signer_key	= $dir/private/tsakey.pem # The TSA private key (optional)
+
+default_policy	= tsa_policy1		# Policy if request did not specify it
+					# (optional)
+other_policies	= tsa_policy2, tsa_policy3	# acceptable policies (optional)
+digests		= md5, sha1		# Acceptable message digests (mandatory)
+accuracy	= secs:1, millisecs:500, microsecs:100	# (optional)
+clock_precision_digits  = 0	# number of digits after dot. (optional)
+ordering		= yes	# Is ordering defined for timestamps?
+				# (optional, default: no)
+tsa_name		= yes	# Must the TSA name be included in the reply?
+				# (optional, default: no)
+ess_cert_id_chain	= no	# Must the ESS cert id chain be included?
+				# (optional, default: no)