vhskit 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e430d0d0e31a503a95c60b807545dc1a3a94fc5e
+  data.tar.gz: 7a6a6ecc2b83794d50d64564fcb3bf29a3bc85df
+SHA512:
+  metadata.gz: c9289b1c0329abe97406c8d8f63afcbf47cedb9494933b7d9c69a96979542ac7937bad712873ee0b52c08f627fafa51b85c5ed4bda1aad9034ee6d7bcf8f158c
+  data.tar.gz: 4021bc6ad57ccb61caec90c20b39706a7a2280b76927e9cccbdbfb991b5a5936ad51379be92967f44051d5344475cd9bfd0b7da81db48ae297c3a0a201e96124

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+*.gem

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - rbx-19mode

data/Gemfile

@@ -0,0 +1,6 @@
+# encoding: utf-8
+
+source 'https://rubygems.org'
+gemspec
+
+# vim: set sw=2 et:

data/README.md

@@ -0,0 +1,16 @@
+# VHSKit
+
+VHSKit is a server that speaks like a real Postgres server.
+
+See [example](example) for a sample.
+
+`cert` (and its `key`) is a self-signed SSL certificate for 127.0.0.1, for your
+convenience.
+
+## license
+
+MIT.
+
+## copyright
+
+© Amelia Cuss, 2013.

data/Rakefile

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+task :default => :spec
+
+RSpec::Core::RakeTask.new
+
+# vim: set sw=2 et:

data/cert

@@ -0,0 +1,20 @@
+-----BEGIN CERTIFICATE-----
+MIIDOzCCAiOgAwIBAgIJALKaTzk+J1xAMA0GCSqGSIb3DQEBBQUAMDQxCzAJBgNV
+BAYTAkFVMREwDwYDVQQIDAhWaWN0b3JpYTESMBAGA1UEAwwJMTI3LjAuMC4xMB4X
+DTEzMTAwMTAyNDU0NVoXDTEzMTAzMTAyNDU0NVowNDELMAkGA1UEBhMCQVUxETAP
+BgNVBAgMCFZpY3RvcmlhMRIwEAYDVQQDDAkxMjcuMC4wLjEwggEiMA0GCSqGSIb3
+DQEBAQUAA4IBDwAwggEKAoIBAQDDBfIIsdVepCbi/sB+EP747kBS4YLLJBhPvV3W
+zpBn45nSjikfEJmxGKE8oqVZSHfxMESWfdAJCwRQ+UhwiXIyiveZ8Dg0PsMDMLws
+QljK0Qlmc8ZzBFKfqIT6wBVGks0u8RjE8KI0SA9QcKLSHBpmBktoaRQETnwYU222
+oo3Z8cmYaIWmL/Zw0Hj3mGG3+nqFZEktk1xFo/COJ3gVGPJl7Gs9ESy60HWqEV1F
+eTuGAak+5R3pmnyLrkV7UWKatWbWxGcIQ88G/BRsrR605OTH9HGZMj3ZtwDl60DF
+/LDwRa9rA5X36L4Y/hUXXn/DAC5Qa2CAz2yQri8loLOXp0ExAgMBAAGjUDBOMB0G
+A1UdDgQWBBQV2qgcTkj9NTGKpTBbK63D4IE62zAfBgNVHSMEGDAWgBQV2qgcTkj9
+NTGKpTBbK63D4IE62zAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBBQUAA4IBAQCy
+9WcFT6WUspF1t4SHNG2i6Xhbv9i8KeAhgwYakANmx10iJse4Ssn5+i9/Hx34cYlt
+dLmhxF8pGBeQtuh5kBQtLVQHkdJYmfjKSf4Ny2daF2kRpDSbh8jhwmu1FxPOO/T2
+86PyyBRRlEnfdTRrmz4UvHGVc8AWenJUcVHWqwiFwrOV6qE7sNwwXbXA9w16RnOg
+M5jH+knVxqJT9ZNo2dmvM9b4jsmvtPDTElkWJ2D6ttPeHI0A8WtVU4Bf5mVlgq3O
+n/n08+/Q1Z3hYUhibTfW1sKq9U3OKKo9zx6Whia3C3H+dbGkgO0J/jyiSc5Ns9/1
+54qrouInAjWJe5Ki8tbb
+-----END CERTIFICATE-----

data/example

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+$: << "./lib"
+
+require 'vhskit'
+
+VHSKit.run(port: 15432) do
+=begin
+  on_auth do |user, database|
+    puts "auth got user #{user}, database #{database}"
+    # return the password for this user, or nil if none
+    "hello"
+  end
+=end
+
+  on_query do |user, database, query|
+    puts "user #{user}, database #{database}, query #{query}"
+
+    if query =~ /^insert /i
+      {insert: 4}
+    elsif query =~ /^delete /i
+      {delete: 4}
+    elsif query =~ /^update /i
+      {update: 4}
+    elsif query =~ /^select /i
+      {select:
+       {columns: ["id", "int4",
+                  "name", "text"],
+        rows: ["1", "Joanne",
+               "2", "Yorick"]}}
+    else
+      nil
+    end
+  end
+end
+
+# vim: set sw=2 et:

data/key

@@ -0,0 +1,27 @@
+-----BEGIN RSA PRIVATE KEY-----
+MIIEpAIBAAKCAQEAwwXyCLHVXqQm4v7AfhD++O5AUuGCyyQYT71d1s6QZ+OZ0o4p
+HxCZsRihPKKlWUh38TBEln3QCQsEUPlIcIlyMor3mfA4ND7DAzC8LEJYytEJZnPG
+cwRSn6iE+sAVRpLNLvEYxPCiNEgPUHCi0hwaZgZLaGkUBE58GFNttqKN2fHJmGiF
+pi/2cNB495hht/p6hWRJLZNcRaPwjid4FRjyZexrPREsutB1qhFdRXk7hgGpPuUd
+6Zp8i65Fe1FimrVm1sRnCEPPBvwUbK0etOTkx/RxmTI92bcA5etAxfyw8EWvawOV
+9+i+GP4VF15/wwAuUGtggM9skK4vJaCzl6dBMQIDAQABAoIBAH3knqNiOPzJNpke
+HqDC0/VZx4g5Lzd3a4I+Gg+KdMm7sRas0nrNOomJ/runutlx4It/vybuvJa51+V1
+pn+PGnrqHn/vBDklsrmigjaH9c2nN0w9vIOO7M9H99/uk01lgrKkzHqFZBAf3FLv
+AwxjO99UfOU/v74v9Ae4A4D8WlmvjFKCGzQJh+NywECnonU6YJzH+CNo2j//6lv5
+LCvMSNooCffDoEdkwakFGyglha8xf0SaiaUsB7YFx4Yp0e5RQeSRC7ubtqK3QjRJ
+WeESWyQPJMbpHps0NfFei5dgmGlqIqFncbQwHrHtQNsagM1eFWF+GoTp9xxrU4I5
+PGKxi+ECgYEA8ISAsrGMsa5eex9CDBIclefLt7NrFlFaE2JEkwa0zE/DqfbUQJ28
+6NRcO5gLrIRA7uAnbstNVeTSNqiMkWbQhSAw9dhH4FiAEw0e/ZSsyZRFWFa6/W7T
+ck6WI45Cn/QBavq5xkejMBFwGBIHtarzirw0sC4OP0FikeN+LU6fXyUCgYEAz5O9
+VajcXiHU7gG6USozTMkD+HvPMLWlYR+eDlTPzpJ3+dRhySG6v8luYWN0X4yk0TsQ
+hdbTv1iiJrB8qabMWVuMgXYJHDtnfIRWNzv0yr5HH2tcMZ1NWS+sXazNqUfdzxj1
+KTxYRY+GOd57fwxgnMF90F0vENSo++asWp7fch0CgYEA1sEo/OUlv/z2pa7aVVbS
+qVMIBiWwp4PKDua+Xh0t0AQkrB0VlgCCDc6X8Copukd4hxIkg3wJuHkQ7fb/VFDe
+PQ/qR4lvXDUJXnlnw3o98dtvM5p1ahbLvBPJYUQD3ziLD4+B0zZh0mivkv5+Xcqf
+nK/Bx9HHrNlf/u2G20OJb/UCgYAL5+5xLllNcOVUrXaxVxlQKyt2IivVIGYW9whK
+zCSLNa15/+uH7M5YV8ZkAZ9YJ6oAckHVW2gTzpKmY3MTDAUmjvC1MD7/hoy+AJ0t
+V9wHkPhlXfQQyHP6TJi3WsUFE6EuUsElF1f8zWmmghNVSzFzbEm6HM4pSflTUXzL
+SdeJJQKBgQDcVB1n29fOX3icpADox3u9IMFNh0vPASa6MVbGhPq5NkDT7xHFRGVn
+ECsS8H1MlLa4WG3UHsiUptk8K2hS71BqFlVUa2hbwY+NfthIFp2VDq33hAdLak2f
+3DdPDrVgJNPAPtyBIOw4YN6/96w6u/GEDjAy27MgOOK8T2bXj0W4JQ==
+-----END RSA PRIVATE KEY-----

data/lib/vhskit.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+module VHSKit
+  require 'vhskit/server'
+
+  def self.run(opts, &block)
+    port = opts.delete(:port) || 5432
+
+    if opts.length > 0
+      raise ArgumentError.new("Unknown options: #{opts.keys.join ", "}")
+    end
+
+    conf = VHSKit::Configurator.new
+    if block
+      conf.instance_exec(&block)
+    end
+
+    VHSKit::Server.new(port, conf).run
+  end
+end
+
+# vim: set sw=2 et:

data/lib/vhskit/handler.rb

@@ -0,0 +1,255 @@
+# encoding: utf-8
+
+# References:
+# http://www.postgresql.org/docs/9.1/static/protocol-flow.html
+# http://www.postgresql.org/docs/9.1/static/protocol-message-formats.html
+# http://www.postgresql.org/docs/9.1/static/catalog-pg-type.html
+# http://www.postgresql.org/docs/9.1/static/catalog-pg-attribute.html
+# http://ruby-doc.org/core-2.0.0/Array.html#method-i-pack
+# http://www.postgresql.org/docs/9.1/static/protocol-error-fields.html
+# http://www.postgresql.org/docs/9.1/static/errcodes-appendix.html
+
+require 'openssl'
+require 'vhskit/oid'
+
+class VHSKit::Handler
+  def initialize(sock, conf)
+    @sock = sock
+    @conf = conf.fns
+  end
+
+  def run
+    start
+    @sock.close rescue false
+  rescue Exception => e
+    STDERR.puts "error in VHSKit::Handler: #{e}"
+    STDERR.puts e.backtrace
+    @sock.close rescue false
+  end
+
+  private
+
+    def start
+      startup = read_msg()
+      ver = startup.unpack('L>')[0]
+
+      if ver == 80877103 && startup.length == 4
+        @sock.write 'S'  # accept the request
+
+        ctx = OpenSSL::SSL::SSLContext.new(:SSLv23_server)
+        ctx.cert = OpenSSL::X509::Certificate.new(File.read('cert'))
+        ctx.key = OpenSSL::PKey::RSA.new(File.read('key'))
+        ctx.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        @sock = OpenSSL::SSL::SSLSocket.new(@sock.to_io, ctx)
+        @sock.accept
+
+        startup = read_msg()
+        ver = startup.unpack('L>')[0]
+      end
+
+      if ver != 196608
+        STDERR.puts "unknown version #{ver}; bye"
+        return
+      end
+
+      handle_opts(startup[4..-1])
+    end
+
+    def handle_opts(opts)
+      hash = {}
+      while opts.length > 1
+        key, val, opts = opts.unpack('Z*Z*a*')
+        hash[key] = val
+      end
+
+      if opts != "\0"
+        STDERR.puts "options terminated poorly; bye"
+        return
+      end
+
+      if !hash["user"]
+        STDERR.puts "no user specified; bye"
+        return
+      end
+
+      @user = hash["user"]
+      @database = hash["database"] || @user
+
+      if @conf[:on_auth]
+        pwd = @conf[:on_auth].call(@user, @database)
+
+        salt = Random::DEFAULT.bytes(4)
+        STDERR.puts salt.bytes.length
+        write_msg 'R', [5, salt].pack('L>a*')  # AuthenticationMD5
+        tag = read_tag
+
+        if tag != 'p'
+          STDERR.puts "expected 'p', got #{tag}; bye"
+          return
+        end
+
+        enc = read_msg().unpack('Z*')[0]
+
+        if !pwd
+          comp = nil
+        else
+          comp = 'md5' + Digest::MD5.hexdigest(
+            Digest::MD5.hexdigest(pwd + @user) + salt)
+        end
+
+        if enc != comp
+          write_msg 'E', notice_error_body(
+            'S' => 'FATAL',
+            'C' => '28P01',
+            'M' => "password authentication failed for user \"#@user\"")
+          return
+        end
+      end
+
+      write_msg 'R', [0].pack('L>')  # AuthenticationOk
+
+      mainloop
+    end
+
+    def mainloop
+      @abort = false
+      while !@abort
+        main
+      end
+    end
+
+    def main
+      # ReadyForQuery
+      write_msg 'Z', (!@transaction ? 'I' : 'T')  # 'E' for failed txn block
+
+      kind = @sock.read(1)
+
+      case kind
+      when 'Q'
+        query
+      when 'X'
+        puts "client terminated"
+        @abort = true
+      else
+        STDERR.puts "unknown kind #{kind}"
+        @abort = true
+      end
+    end
+
+    def query
+      query = read_msg()
+      on_query = @conf[:on_query]
+      if !on_query
+        write_msg 'E', notice_error_body(
+          'S' => 'ERROR',
+          'C' => 'XX000',
+          'M' => 'Internal error: no query handler available')
+        return
+      end
+
+      each_query(query.strip, on_query)
+    end
+
+    def each_query(query, on_query)
+      result = on_query.call(@user, @database, query)
+      if !result || result.keys.length != 1
+        STDERR.puts "result.keys not unary for #{query.inspect}: #{result.inspect}"
+        write_msg 'E', notice_error_body(
+          'S' => 'ERROR',
+          'C' => 'XX000',
+          'M' => "Internal error: query handler didn't return sensible data")
+        return
+      end
+
+      key, value = result.to_a[0]
+
+      case key
+      when :insert
+        # CommandComplete
+        write_msg 'C', ["INSERT 0 #{value}"].pack('Z*')
+      when :delete
+        # CommandComplete
+        write_msg 'C', ["DELETE #{value}"].pack('Z*')
+      when :update
+        # CommandComplete
+        write_msg 'C', ["UPDATE #{value}"].pack('Z*')
+      when :select
+        rows = value[:columns].each_slice(2).map {|name, type|
+          [name, 0, 0, VHSKit::OID.by_name(type),
+           4,  # XXX this is wrong
+           -1, 0]}
+        # RowDescription
+        write_msg 'T', row_descriptions(rows)
+
+        count = 0
+        value[:rows].each_slice(rows.length).each do |row|
+          # DataRow
+          write_msg 'D', data_row(row)
+          count += 1
+        end
+
+        # CommandComplete
+        write_msg 'C', ["SELECT #{count}"].pack('Z*')
+      # when :move
+      # when :fetch
+      # when :copy
+      else
+        raise StandardError.new("unknown key #{key.inspect}")
+      end
+    end
+
+    def read_tag()
+      r = @sock.read(1)
+      if !r || r.length < 1
+        raise EOFError
+      end
+      r
+    end
+
+    def read_msg()
+      len = @sock.read(4).unpack('L>')[0]
+      r = @sock.read(len - 4)
+      if !r || r.length < len - 4
+        raise EOFError
+      end
+      r
+    end
+
+    def write_msg(tag, data)
+      @sock.write tag
+      @sock.write [data.length + 4].pack('L>')
+      @sock.write data
+      @sock.flush
+    end
+
+    def notice_error_body(pairs)
+      pairs.map do |k,v|
+        if k.length != 1
+          raise ArgumentError.new("notice_error_body got key #{k.inspect}")
+        end
+
+        [k, v].pack('aZ*')
+      end.join.force_encoding('US-ASCII') + "\00"
+    end
+
+    # rows should be an Array of Arrays of:
+    # - field name (String)
+    # - table OID or zero (Integer)
+    # - column OID or zero (Integer)
+    # - data type OID (Integer)
+    # - data type size (Integer)
+    # - type modifier (Integer)
+    # - format code (Integer: 0 text, 1 binary)
+    def row_descriptions(rows)
+      [rows.length,
+       rows.map {|e| e.pack('Z*L>S>L>S>L>S>')}.join].pack('S>a*')
+    end
+
+    # columns should be an Array of Strings
+    def data_row(columns)
+      [columns.length,
+       columns.map {|e| [e.length + 1, e].pack('L>Z*')}.join].pack('S>a*')
+    end
+end
+
+# vim: set sw=2 et:

data/lib/vhskit/oid.rb

@@ -0,0 +1,85 @@
+# encoding: utf-8
+
+# Source for OIDs:
+# http://jdbc.postgresql.org/development/privateapi/constant-values.html#org.postgresql.core.Oid.INT4
+
+module VHSKit::OID
+  BIT = 1560
+  BIT_ARRAY = 1561
+  BOOL = 16
+  BOOL_ARRAY = 1000
+  BPCHAR = 1042
+  BPCHAR_ARRAY = 1014
+  BYTEA = 17
+  BYTEA_ARRAY = 1001
+  CHAR = 18
+  CHAR_ARRAY = 1002
+  DATE = 1082
+  DATE_ARRAY = 1182
+  FLOAT4 = 700
+  FLOAT4_ARRAY = 1021
+  FLOAT8 = 701
+  FLOAT8_ARRAY = 1022
+  INT2 = 21
+  INT2_ARRAY = 1005
+  INT4 = 23
+  INT4_ARRAY = 1007
+  INT8 = 20
+  INT8_ARRAY = 1016
+  INTERVAL = 1186
+  INTERVAL_ARRAY = 1187
+  MONEY = 790
+  MONEY_ARRAY = 791
+  NAME = 19
+  NAME_ARRAY = 1003
+  NUMERIC = 1700
+  NUMERIC_ARRAY = 1231
+  OID = 26
+  OID_ARRAY = 1028
+  TEXT = 25
+  TEXT_ARRAY = 1009
+  TIME = 1083
+  TIME_ARRAY = 1183
+  TIMESTAMP = 1114
+  TIMESTAMP_ARRAY = 1115
+  TIMESTAMPTZ = 1184
+  TIMESTAMPTZ_ARRAY = 1185
+  TIMETZ = 1266
+  TIMETZ_ARRAY = 1270
+  UNSPECIFIED = 0
+  UUID = 2950
+  UUID_ARRAY = 2951
+  VARBIT = 1562
+  VARBIT_ARRAY = 1563
+  VARCHAR = 1043
+  VARCHAR_ARRAY = 1015
+  VOID = 2278
+  XML = 142
+  XML_ARRAY = 143
+
+  def self.by_name(name)
+    name = name.upcase
+
+    array = false
+    if name =~ /^(.+)\[\]$/
+      name = $1
+      array = true
+    end
+
+    if name =~ /^(.+) WITHOUT TIME ZONE$/
+      name = $1
+    end
+
+    if name =~ /^(.+) WITH TIME ZONE$/
+      name = "#{$1}TZ"
+    end
+
+    if array
+      name << "_ARRAY"
+    end
+
+    const_get name
+  end
+end
+
+# vim: set sw=2 et:

data/lib/vhskit/server.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+
+require 'socket'
+require 'vhskit/handler'
+
+class VHSKit::Server
+  def initialize(port, conf)
+    @serv = TCPServer.new port
+    @conf = conf
+  end
+
+  def run
+    while true
+      sock = @serv.accept
+      Thread.start do
+        VHSKit::Handler.new(sock, @conf).run
+      end
+    end
+  end
+end
+
+class VHSKit::Configurator
+  def initialize
+    @fns = {}
+  end
+
+  attr_reader :fns
+
+  FNS = [:on_auth, :on_query]
+
+  FNS.each do |fn|
+    define_method(fn) do |&block|
+      @fns[fn] = block
+    end
+  end
+end
+
+# vim: set sw=2 et:

data/lib/vhskit/version.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+module VHSKit
+  VERSION = "0.0.1"
+end
+
+# vim: set sw=2 et:

data/vhskit.gemspec

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+require File.expand_path('../lib/vhskit/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors = ["Amelia Cuss"]
+  gem.email = ["amelia@kivikakk.ee"]
+  gem.description = %q{Just like a Postgres server, only fake}
+  gem.summary = %q{A Postgres server protocol implementation you can configure with a DSL.}
+  gem.homepage = "https://github.com/kivikakk/vhskit"
+
+  gem.add_development_dependency('rake')
+  gem.add_development_dependency('rspec')
+
+  gem.files = `git ls-files`.split($\)
+  gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name = "vhskit"
+  gem.require_paths = ["lib"]
+  gem.version = VHSKit::VERSION
+end
+
+# vim: set sw=2 et:

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: vhskit
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Amelia Cuss
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Just like a Postgres server, only fake
+email:
+- amelia@kivikakk.ee
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- cert
+- example
+- key
+- lib/vhskit.rb
+- lib/vhskit/handler.rb
+- lib/vhskit/oid.rb
+- lib/vhskit/server.rb
+- lib/vhskit/version.rb
+- vhskit.gemspec
+homepage: https://github.com/kivikakk/vhskit
+licenses: []
+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.0.3
+signing_key: 
+specification_version: 4
+summary: A Postgres server protocol implementation you can configure with a DSL.
+test_files: []