plum 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8e9aa768df8ce054c286452ca40c8e6f5671fda5
+  data.tar.gz: 3a5dafa95ec6dd94b6b354091a8eee73b88f3214
+SHA512:
+  metadata.gz: 3110fdf853b9ab1a7966adff6b24a3665bf792853a63bc814e295cee3a343761894b2fa1a48157a19c349998415bfee7710f3242400081ea8863b48f30028d4f
+  data.tar.gz: 061d1e6292eb1cd9d2fc6cd6db1daceb4e483970c577cf504f23deb23a407e44535fa27c57a819159198f41c7b248c015940485bab620a565cca84b0a7f14620

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.*.sw*
+.*.local

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+addons:
+  code_climate:
+    repo_token: f5092ab344fac7f2de9d7332e00597642a4d24e3d560f7d7f329172a2e5a2def
+install:
+  - echo openssl_url=https://www.openssl.org/source >> $rvm_path/user/db
+  - echo openssl_version=1.0.2d >> $rvm_path/user/db
+  - rvm pkg install openssl
+  - $rvm_path/usr/bin/openssl version
+  - rvm install 2.2.2-alpn --patch https://gist.githubusercontent.com/rhenium/b1711edcc903e8887a51/raw/2309e469f5a3ba15917d804ac61b19e62b3d8faf/ruby-openssl-alpn-no-tests-and-docs.patch --with-openssl-dir=$rvm_path/usr
+  - rvm use 2.2.2-alpn
+  - bundle install
+script:
+  - bundle exec rake test

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,7 @@
+guard :minitest, env: { "SKIP_COVERAGE" => true } do
+  # with Minitest::Unit
+  watch(%r{^test/(.*)\/?test_(.*)\.rb$})
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     {|m| ["test/#{m[1]}test_#{m[2]}.rb", "test/#{m[1]}#{m[2]}"] }
+  watch(%r{^test/test_helper\.rb$})      { "test" }
+  watch(%r{^test/utils/.*\.rb})          { "test" }
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Kazuki Yamaguchi
+
+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,14 @@
+# Plum [![Build Status](https://travis-ci.org/rhenium/plum.png?branch=master)](https://travis-ci.org/rhenium/plum) [![Code Climate](https://codeclimate.com/github/rhenium/plum/badges/gpa.svg)](https://codeclimate.com/github/rhenium/plum) [![Test Coverage](https://codeclimate.com/github/rhenium/plum/badges/coverage.svg)](https://codeclimate.com/github/rhenium/plum/coverage)
+A minimal implementation of HTTP/2 server.
+
+## Requirements
+* OpenSSL 1.0.2+
+* Ruby 2.2 with [ALPN support](https://gist.github.com/rhenium/b1711edcc903e8887a51) and [ECDH support (r51348)](https://bugs.ruby-lang.org/projects/ruby-trunk/repository/revisions/51348/diff?format=diff) or latest Ruby 2.3.0-dev.
+
+## TODO
+* "http" URIs support (upgrade from HTTP/1.1)
+* Stream Priority (RFC 7540 5.3)
+* Better API
+
+## License
+MIT License

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "yard"
+
+Rake::TestTask.new do |t|
+  t.libs << "test" << "lib"
+  t.pattern = "test/**/test_*.rb"
+end
+
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ["lib/**/*.rb"]
+end

data/examples/local_server.rb

@@ -0,0 +1,206 @@
+DEBUG = ENV["DEBUG"] || false
+HOST = ENV["HOST"]
+PORT = ENV["PORT"]
+DOCUMENT_ROOT = ENV["DOCUMENT_ROOT"] || "/srv/http"
+TLS_CERT = ENV["TLS_CERT"]
+TLS_KEY = ENV["TLS_KEY"]
+
+CONTENT_TYPES = {
+  /\.html$/ => "text/html",
+  /\.png$/ => "image/png",
+  /\.jpg$/ => "image/jpeg",
+  /\.css$/ => "text/css",
+  /\.js$/ => "application/javascript",
+}
+
+$LOAD_PATH << File.expand_path("../../lib", __FILE__)
+require "plum"
+require "openssl"
+require "socket"
+begin
+  require "oga"
+  HAVE_OGA = true
+rescue LoadError
+  puts "Oga is needed for parsing HTML"
+  HAVE_OGA = false
+end
+
+begin
+  require "sslkeylog/autotrace" # for debug
+rescue LoadError
+end
+
+def log(con, stream, s)
+  prefix = "[%02x;%02x] " % [con, stream]
+  if s.is_a?(Enumerable)
+    puts s.map {|a| prefix + a.to_s }.join("\n")
+  else
+    puts prefix + s.to_s
+  end
+end
+
+def content_type(filename)
+  exp, ct = CONTENT_TYPES.lazy.select {|pat, e| pat =~ filename }.first
+  ct || "texp/plain"
+end
+
+def assets(file)
+  if /\.html$/ =~ File.basename(file)
+    doc = Oga.parse_html(File.read(file))
+    assets = []
+    doc.xpath("img").each {|img| assets << img.get("src") }
+    doc.xpath("//html/head/link[@rel='stylesheet']").each {|css| assets << css.get("href") }
+    doc.xpath("script").each {|js| assets << js.get("src") }
+    assets.compact.uniq.map {|path|
+      if path.include?("//")
+        next nil
+      end
+
+      if path.start_with?("/")
+        pa = File.expand_path(DOCUMENT_ROOT + path)
+      else
+        pa = File.expand_path(path, file)
+      end
+      
+      if pa.start_with?(DOCUMENT_ROOT) & File.exist?(pa)
+        pa
+      else
+        nil
+      end
+    }.compact
+  else
+    []
+  end
+end
+
+ctx = OpenSSL::SSL::SSLContext.new
+ctx.ssl_version = :TLSv1_2
+ctx.alpn_select_cb = -> protocols {
+  raise "Client does not support HTTP/2: #{protocols}" unless protocols.include?("h2")
+  "h2"
+}
+ctx.tmp_ecdh_callback = -> (sock, ise, keyl) {
+  OpenSSL::PKey::EC.new("prime256v1")
+}
+
+ctx.cert = OpenSSL::X509::Certificate.new File.read(TLS_CERT)
+ctx.key = OpenSSL::PKey::RSA.new File.read(TLS_KEY)
+tcp_server = TCPServer.new(HOST, PORT)
+ssl_server = OpenSSL::SSL::SSLServer.new(tcp_server, ctx)
+
+loop do
+  begin
+    sock = ssl_server.accept
+    id = sock.io.fileno
+    puts "#{id}: accept!"
+  rescue => e
+    puts e
+    next
+  end
+
+  plum = Plum::HTTPSConnection.new(sock)
+
+  plum.on(:frame) do |frame|
+    log(id, frame.stream_id, "recv: #{frame.inspect}")
+  end if DEBUG
+
+  plum.on(:send_frame) do |frame|
+    log(id, frame.stream_id, "send: #{frame.inspect}")
+  end if DEBUG
+
+  plum.on(:remote_settings) do |settings|
+    log(id, 0, settings.map {|name, value| "#{name}: #{value}" }) if DEBUG
+  end
+
+  plum.on(:connection_error) do |exception|
+    puts exception
+    puts exception.backtrace
+  end if DEBUG
+
+  plum.on(:stream) do |stream|
+    log(id, stream.id, "stream open")
+    stream.on(:stream_error) do |exception|
+      puts exception
+      puts exception.backtrace
+    end if DEBUG
+
+    headers = data = nil
+
+    stream.on(:open) do
+      headers = nil
+      data = ""
+    end
+
+    stream.on(:headers) do |headers_|
+      log(id, stream.id, headers_.map {|name, value| "#{name}: #{value}" }) if DEBUG
+      headers = headers_.to_h
+    end
+
+    stream.on(:data) do |data_|
+      log(id, stream.id, data_) if DEBUG
+      data << data_
+    end
+
+    stream.on(:end_stream) do
+      if headers[":method"] == "GET"
+        file = File.expand_path(DOCUMENT_ROOT + headers[":path"])
+        file << "/index.html" if Dir.exist?(file)
+        if file.start_with?(DOCUMENT_ROOT) && File.exist?(file)
+          io = File.open(file)
+          size = File.stat(file).size
+          i_sts = assets(file).map {|asset|
+            i_st = stream.promise({
+              ":authority": headers[":authority"],
+              ":method": "GET",
+              ":scheme": "https",
+              ":path": asset[DOCUMENT_ROOT.size..-1]
+            })
+            [i_st, asset]
+          }
+          stream.respond({
+            ":status": "200",
+            "server": "plum/#{Plum::VERSION}",
+            "content-type": content_type(file),
+            "content-length": size
+          }, io)
+          i_sts.each do |i_st, asset|
+            aio = File.open(asset)
+            asize = File.stat(asset).size
+            i_st.respond({
+              ":status": "200",
+              "server": "plum/#{Plum::VERSION}",
+              "content-type": content_type(asset),
+              "content-length": asize
+            }, aio)
+          end
+        else
+          body = headers.map {|name, value| "#{name}: #{value}" }.join("\n") + "\n" + data
+          stream.respond({
+            ":status": "404",
+            "server": "plum/#{Plum::VERSION}",
+            "content-type": "text/plain",
+            "content-length": body.bytesize
+          }, body)
+        end
+      else
+        # Not implemented
+        body = headers.map {|name, value| "#{name}: #{value}" }.join("\n") << "\n" << data
+        stream.respond({
+          ":status": "501",
+          "server": "plum/#{Plum::VERSION}",
+          "content-type": "text/plain",
+          "content-length": body.bytesize
+        }, body)
+      end
+    end
+  end
+
+  Thread.new {
+    begin
+      plum.run
+    rescue
+      puts $!
+      puts $!.backtrace
+    end
+  }
+end

data/examples/static_server.rb

@@ -0,0 +1,157 @@
+$LOAD_PATH << File.expand_path("../../lib", __FILE__)
+require "plum"
+require "openssl"
+require "socket"
+require "cgi"
+
+begin
+  require "sslkeylog/autotrace"
+rescue LoadError
+end
+
+def log(con, stream, s)
+  prefix = "[%02x;%02x] " % [con, stream]
+  if s.is_a?(Enumerable)
+    puts s.map {|a| prefix + a.to_s }.join("\n")
+  else
+    puts prefix + s.to_s
+  end
+end
+
+ctx = OpenSSL::SSL::SSLContext.new
+ctx.ssl_version = :TLSv1_2
+ctx.alpn_select_cb = -> protocols {
+  raise "Client does not support HTTP/2: #{protocols}" unless protocols.include?("h2")
+  "h2"
+}
+ctx.tmp_ecdh_callback = -> (sock, ise, keyl) {
+  OpenSSL::PKey::EC.new("prime256v1")
+}
+ctx.cert = OpenSSL::X509::Certificate.new File.read(".crt.local")
+ctx.key = OpenSSL::PKey::RSA.new File.read(".key.local")
+tcp_server = TCPServer.new("0.0.0.0", 40443)
+ssl_server = OpenSSL::SSL::SSLServer.new(tcp_server, ctx)
+
+loop do
+  begin
+    sock = ssl_server.accept
+    id = sock.io.fileno
+    puts "#{id}: accept!"
+  rescue => e
+    STDERR.puts e
+    next
+  end
+
+  plum = Plum::HTTPSConnection.new(sock)
+
+  plum.on(:frame) do |frame|
+    log(id, frame.stream_id, "recv: #{frame.inspect}")
+  end
+
+  plum.on(:send_frame) do |frame|
+    log(id, frame.stream_id, "send: #{frame.inspect}")
+  end
+
+  plum.on(:connection_error) do |exception|
+    puts exception
+    puts exception.backtrace
+  end
+
+  plum.on(:stream) do |stream|
+    stream.on(:stream_error) do |exception|
+      puts exception
+      puts exception.backtrace
+    end
+
+    stream.on(:send_deferred) do |frame|
+      log(id, frame.stream_id, "send (deferred): #{frame.inspect}")
+    end
+
+    headers = data = nil
+
+    stream.on(:open) do
+      headers = nil
+      data = ""
+    end
+
+    stream.on(:headers) do |headers_|
+      log(id, stream.id, headers_.map {|name, value| "#{name}: #{value}" })
+      headers = headers_.to_h
+    end
+
+    stream.on(:data) do |data_|
+      log(id, stream.id, data_)
+      data << data_
+    end
+
+    stream.on(:end_stream) do
+      case [headers[":method"], headers[":path"]]
+      when ["GET", "/"]
+        body = "Hello World! <a href=/abc.html>ABC</a> <a href=/fgsd>Not found</a>"
+        body << <<-EOF
+        <form action=post.page method=post>
+        <input type=text name=key value=default_value>
+        <input type=submit>
+        </form>
+        EOF
+        stream.respond({
+          ":status": "200",
+          "server": "plum",
+          "content-type": "text/html",
+          "content-length": body.size
+        }, body)
+      when ["GET", "/abc.html"]
+        body = "ABC! <a href=/>Back to top page</a><br><img src=/image.nyan>"
+        i_stream = stream.promise({
+          ":authority": "localhost:40443",
+          ":method": "GET",
+          ":scheme": "https",
+          ":path": "/image.nyan"
+        })
+        stream.respond({
+          ":status": "200",
+          "server": "plum",
+          "content-type": "text/html",
+          "content-length": body.size
+        }, body)
+        image = ("iVBORw0KGgoAAAANSUhEUgAAAEAAAABAAgMAAADXB5lNAAAACVBMVEX///93o0jG/4mTMy20AAAA" <<
+                 "bklEQVQ4y2NgoAoIRQJkCoSimIdTgJGBBU1ABE1A1AVdBQuaACu6gCALhhZ0axlZCDgMWYAB6ilU" <<
+                 "35IoADEMxWyyBDD45AhQCFahM0kXWIVu3sAJrILzyBcgytoFeATABBcXWohhCEC14BCgGAAAX1ZQ" <<
+                 "ZtJp0zAAAAAASUVORK5CYII=").unpack("m")[0]
+        i_stream.respond({
+          ":status": "200",
+          "server": "plum",
+          "content-type": "image/png",
+          "content-length": image.size
+        }, image)
+      when ["POST", "/post.page"]
+        body = "Posted value is: #{CGI.unescape(data).gsub("<", "&lt;").gsub(">", "&gt;")}<br> <a href=/>Back to top page</a>"
+        stream.respond({
+          ":status": "200",
+          "server": "plum",
+          "content-type": "text/html",
+          "content-length": body.size
+        }, body)
+      else
+        body = "Page not found! <a href=/>Back to top page</a>"
+        stream.respond({
+          ":status": "404",
+          "server": "plum",
+          "content-type": "text/html",
+          "content-length": body.size
+        }, body)
+      end
+    end
+  end
+
+  Thread.new {
+    begin
+      plum.run
+    rescue
+      puts $!
+      puts $!.backtrace
+    ensure
+      sock.close
+    end
+  }
+end