webdav-exporter 0.0.1

data/README

@@ -0,0 +1,26 @@
+Public Description:
+
+A WebDAV server for easy filesharing in hostile environments or for unwilling
+sysads. Starts directly from the commandline and can do SSL/HTTPS. The
+webdav-exporter uses the webrick-webdav gem which *fakes* a DAV2 protocol
+implementation.
+
+
+Description:
+
+WebDAV server for easy filesharing in hostile environments or unwilling system
+administrators. It starts a DAV server directly from commandline and shares
+your files. Can use SSL with HTTPS for secure transfers.  Authorization and
+feature set is very limited at the moment. The webdav-exporter blends webrick
+and the webrick-webdav into a comandline application and tries to fix the
+missing parts with the DAV2 protocol.
+
+
+Usage: 
+
+execute with no arguments an see usage output for examples. Next step is
+reading the source and in case or further demand drop me a line per email to
+dirk at sebrink dot de.
+
+
+have fun

data/bin/webdav-exporter

@@ -0,0 +1,197 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'app-ctx'
+require 'webrick'
+require 'webrick/httpstatus'
+require 'webrick/https'
+require 'webrick/httpservlet/webdavhandler'
+
+# global variable for passing commandline/default values into the webdav servlet
+$context = nil
+
+# the 'DefaultSettings' can be overruled from the command line, e.g:
+#
+# webdav-exporter --port=1234 /path/to/exported/dir
+#
+# the SSL handling code liberally came from  Gabriele Marrone at
+#   http://gmarrone.objectblues.net/cgi-bin/wiki/WebDAV_-_Linux_server%2c_Mac_OS_X_client
+#
+# and was discussed a bit at: http://www.ruby-forum.com/topic/86624#160859
+#
+DefaultSettings = {
+    :host             => nil, # "0.0.0.0" or "::" or nil
+    :port             => 443, # the default HTTPS port(needs root power)
+    #:docroot          => Dir.pwd, # exports current working dir
+    # FileHandler = {
+    :NondisclosureName => [".ht*", "*~"],
+    :FancyIndexing     => false,
+    :HandlerTable      => {},
+    :HandlerCallback   => nil,
+    :DirectoryCallback => nil,
+    :FileCallback      => nil,
+    :UserDir           => nil,  # e.g. "public_html"
+    :AcceptableLanguages => [],  # ["en", "ja", ... ]
+    :SSLEnable        => true,    # enable SSL for default HTTPS port 443
+    :SSLVerifyClient  => OpenSSL::SSL::VERIFY_NONE,
+    :SSLCertName      => [["CN", WEBrick::Utils::getservername]],
+    :realm            => "webdav-exporter: Yeah! Yeah! Yeah!",
+    :username         => "guest",
+    :password         => "%04d" % rand(10000),
+    # }
+}
+
+def usage
+    puts <<EOU
+
+usage: #{$0} [options] <docroot>
+
+default settings:
+
+EOU
+    DefaultSettings.each do |k,v| 
+        puts("\t%-25s: %s" % [k, v.inspect || "<nil>"])
+    end
+    puts <<EXAMPLES
+
+Note: String and integer settings can be set on the command line!
+
+usage examples: 
+
+  #     export your home directory(unix style :-)
+  $ #{$0} --port=12345 ~
+
+  #     export to dedicated interface only
+  $ webdav-exporter --BindAddress=16.11.19.64 ~
+  #     is equivalent to:
+  $ #{$0} --host=16.11.19.64 ~
+
+  #     all features on
+  $ #{$0} --realm="go for it" --password=1234 --port=5500 /tmp
+
+EXAMPLES
+    exit 0
+end
+
+
+# WebDAVHandlerVersion2 fakes the DAV2 protocol and implementats certificate
+# handling for SSL connections
+class WebDAVHandlerVersion2 < WEBrick::HTTPServlet::WebDAVHandler
+
+    include WEBrick::HTTPStatus
+
+    def cfg 
+        $context.values
+    end
+
+    def initialize(*args)
+        super(*args)
+    end
+
+    def service(req, res)
+        WEBrick::HTTPAuth.basic_auth(req, res, cfg.realm) do |user, pass| 
+            # this block returns true if 
+            # authentication token is valid 
+            user == cfg.username && pass == cfg.password
+            true
+        end 
+        super
+    end
+
+    def do_UNLOCK(req, res)
+        #@log << ">>>>> UNLOCK >>>>>  #{req}"
+        res.body << ""
+    end
+
+    def do_LOCK(req, res)
+        #cfg.Logger << ">>>>> LOCK >>>>>\n #{req}"
+
+# XXX I still don't now what to answer but this is an axmple request
+        #raise PreconditionFailed, "not implemented"
+        res.body << "<#{Time.now.to_s}>"
+
+# this is a example form the WebDAV RFC(which are horrible!)
+#
+#   LOCK /._x%20copy.rb HTTP/1.1
+#   User-Agent: WebDAVFS/1.4.1 (01418000) Darwin/8.8.1 (i386)
+#   Accept: */*
+#   Depth: 0
+#   Timeout: Second-600
+#   Content-Type: text/xml; charset="utf-8"
+#   Authorization: Basic bXl1c2VyOm15cGFzcw==
+#   Content-Length: 229
+#   Connection: keep-alive
+#   Host: localhost:1611
+#
+#   <?xml version="1.0" encoding="utf-8"?>
+#   <D:lockinfo xmlns:D="DAV:">
+#       <D:lockscope><D:exclusive/></D:lockscope>
+#       <D:locktype><D:write/></D:locktype>
+#       <D:owner>
+#           <D:href>http://www.apple.com/webdav_fs/</D:href>
+#       </D:owner>
+#   </D:lockinfo>
+    end
+
+    def do_OPTIONS(req, res)
+        super
+        res["DAV"] = "1,2"
+    end
+end
+
+App::run do |context|
+
+    usage if context.argv.empty?
+    
+    context.set_default_values(DefaultSettings)
+
+    # some (convenience only)command line mappings which can be used
+    # interchangebly:
+    #   --host instead --BindAddress ...
+    #   --port instead --Port
+    context.values[:BindAddress] ||= context.values[:host]
+    context.values[:Port] ||= context.values[:port]
+
+    log = WEBrick::Log.new
+    log.level = WEBrick::Log::DEBUG if $DEBUG
+    context.values[:Logger] = log
+    server = WEBrick::HTTPServer.new(context.values)
+          
+    context.values[:docroot] = context.argv.shift 
+# webdav-exporter --port=1234 --docroot="/foo/bar/ with blanks "
+
+    # make application context globally available before having instantiating
+    # the WebDAV server object which uses it
+    $context = context
+    # XXX move this code to app-ctx soon...
+    class << $context.values
+        def method_missing(m,*a)
+            if m.to_s =~ /=$/
+                self[$`.to_sym] = a[0]
+            elsif a.empty?
+                self[m]
+            else
+                raise NoMethodError, "#{m}"
+            end
+        end
+    end
+
+    server.mount "/", WebDAVHandlerVersion2, context.values[:docroot]
+    #server.mount "/", WEBrick::HTTPServlet::FileHandler, Dir.pwd, context.values
+
+    puts <<INFO
+
+You can now log in to the 
+
+    #{$context.values.realm}
+    
+Realm with the following username/password:
+
+    username: #{$context.values.username}
+    password: #{$context.values.password}
+
+INFO
+
+    trap("INT") { server.shutdown }
+    server.start
+end

data/webdav-exporter.rb

@@ -0,0 +1,197 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'app-ctx'
+require 'webrick'
+require 'webrick/httpstatus'
+require 'webrick/https'
+require 'webrick/httpservlet/webdavhandler'
+
+# global variable for passing commandline/default values into the webdav servlet
+$context = nil
+
+# the 'DefaultSettings' can be overruled from the command line, e.g:
+#
+# webdav-exporter --port=1234 /path/to/exported/dir
+#
+# the SSL handling code liberally came from  Gabriele Marrone at
+#   http://gmarrone.objectblues.net/cgi-bin/wiki/WebDAV_-_Linux_server%2c_Mac_OS_X_client
+#
+# and was discussed a bit at: http://www.ruby-forum.com/topic/86624#160859
+#
+DefaultSettings = {
+    :host             => nil, # "0.0.0.0" or "::" or nil
+    :port             => 443, # the default HTTPS port(needs root power)
+    #:docroot          => Dir.pwd, # exports current working dir
+    # FileHandler = {
+    :NondisclosureName => [".ht*", "*~"],
+    :FancyIndexing     => false,
+    :HandlerTable      => {},
+    :HandlerCallback   => nil,
+    :DirectoryCallback => nil,
+    :FileCallback      => nil,
+    :UserDir           => nil,  # e.g. "public_html"
+    :AcceptableLanguages => [],  # ["en", "ja", ... ]
+    :SSLEnable        => true,    # enable SSL for default HTTPS port 443
+    :SSLVerifyClient  => OpenSSL::SSL::VERIFY_NONE,
+    :SSLCertName      => [["CN", WEBrick::Utils::getservername]],
+    :realm            => "webdav-exporter: Yeah! Yeah! Yeah!",
+    :username         => "guest",
+    :password         => "%04d" % rand(10000),
+    # }
+}
+
+def usage
+    puts <<EOU
+
+usage: #{$0} [options] <docroot>
+
+default settings:
+
+EOU
+    DefaultSettings.each do |k,v| 
+        puts("\t%-25s: %s" % [k, v.inspect || "<nil>"])
+    end
+    puts <<EXAMPLES
+
+Note: String and integer settings can be set on the command line!
+
+usage examples: 
+
+  #     export your home directory(unix style :-)
+  $ #{$0} --port=12345 ~
+
+  #     export to dedicated interface only
+  $ webdav-exporter --BindAddress=16.11.19.64 ~
+  #     is equivalent to:
+  $ #{$0} --host=16.11.19.64 ~
+
+  #     all features on
+  $ #{$0} --realm="go for it" --password=1234 --port=5500 /tmp
+
+EXAMPLES
+    exit 0
+end
+
+
+# WebDAVHandlerVersion2 fakes the DAV2 protocol and implementats certificate
+# handling for SSL connections
+class WebDAVHandlerVersion2 < WEBrick::HTTPServlet::WebDAVHandler
+
+    include WEBrick::HTTPStatus
+
+    def cfg 
+        $context.values
+    end
+
+    def initialize(*args)
+        super(*args)
+    end
+
+    def service(req, res)
+        WEBrick::HTTPAuth.basic_auth(req, res, cfg.realm) do |user, pass| 
+            # this block returns true if 
+            # authentication token is valid 
+            user == cfg.username && pass == cfg.password
+            true
+        end 
+        super
+    end
+
+    def do_UNLOCK(req, res)
+        #@log << ">>>>> UNLOCK >>>>>  #{req}"
+        res.body << ""
+    end
+
+    def do_LOCK(req, res)
+        #cfg.Logger << ">>>>> LOCK >>>>>\n #{req}"
+
+# XXX I still don't now what to answer but this is an axmple request
+        #raise PreconditionFailed, "not implemented"
+        res.body << "<#{Time.now.to_s}>"
+
+# this is a example form the WebDAV RFC(which are horrible!)
+#
+#   LOCK /._x%20copy.rb HTTP/1.1
+#   User-Agent: WebDAVFS/1.4.1 (01418000) Darwin/8.8.1 (i386)
+#   Accept: */*
+#   Depth: 0
+#   Timeout: Second-600
+#   Content-Type: text/xml; charset="utf-8"
+#   Authorization: Basic bXl1c2VyOm15cGFzcw==
+#   Content-Length: 229
+#   Connection: keep-alive
+#   Host: localhost:1611
+#
+#   <?xml version="1.0" encoding="utf-8"?>
+#   <D:lockinfo xmlns:D="DAV:">
+#       <D:lockscope><D:exclusive/></D:lockscope>
+#       <D:locktype><D:write/></D:locktype>
+#       <D:owner>
+#           <D:href>http://www.apple.com/webdav_fs/</D:href>
+#       </D:owner>
+#   </D:lockinfo>
+    end
+
+    def do_OPTIONS(req, res)
+        super
+        res["DAV"] = "1,2"
+    end
+end
+
+App::run do |context|
+
+    usage if context.argv.empty?
+    
+    context.set_default_values(DefaultSettings)
+
+    # some (convenience only)command line mappings which can be used
+    # interchangebly:
+    #   --host instead --BindAddress ...
+    #   --port instead --Port
+    context.values[:BindAddress] ||= context.values[:host]
+    context.values[:Port] ||= context.values[:port]
+
+    log = WEBrick::Log.new
+    log.level = WEBrick::Log::DEBUG if $DEBUG
+    context.values[:Logger] = log
+    server = WEBrick::HTTPServer.new(context.values)
+          
+    context.values[:docroot] = context.argv.shift 
+# webdav-exporter --port=1234 --docroot="/foo/bar/ with blanks "
+
+    # make application context globally available before having instantiating
+    # the WebDAV server object which uses it
+    $context = context
+    # XXX move this code to app-ctx soon...
+    class << $context.values
+        def method_missing(m,*a)
+            if m.to_s =~ /=$/
+                self[$`.to_sym] = a[0]
+            elsif a.empty?
+                self[m]
+            else
+                raise NoMethodError, "#{m}"
+            end
+        end
+    end
+
+    server.mount "/", WebDAVHandlerVersion2, context.values[:docroot]
+    #server.mount "/", WEBrick::HTTPServlet::FileHandler, Dir.pwd, context.values
+
+    puts <<INFO
+
+You can now log in to the 
+
+    #{$context.values.realm}
+    
+Realm with the following username/password:
+
+    username: #{$context.values.username}
+    password: #{$context.values.password}
+
+INFO
+
+    trap("INT") { server.shutdown }
+    server.start
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.11
+specification_version: 1
+name: webdav-exporter
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+date: 2006-12-31 00:00:00 +01:00
+summary: one-stop WebDAV file export directly from your commandline
+require_paths: 
+- lib
+email: dirk@sebrink.de, dluesebrink@idmedia.com
+homepage: http://www.sofasportler.de/dirk.blog/category/coding/ruby/
+rubyforge_project: 
+description: 
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: false
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+authors: 
+- Dirk Luesebrink
+files: 
+- webdav-exporter.rb
+- README
+- bin/webdav-exporter
+test_files: []
+
+rdoc_options: 
+- --main
+- README
+extra_rdoc_files: 
+- README
+executables: 
+- webdav-exporter
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: app-ctx
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.4
+    version: