らくらく BASIC 認証 on Rails

趣旨

Rails アプリでプロトタイプを作ったときに、BASIC 認証を掛けて限定公開したいと思うときがあるかもしれない。ところが Rails ではそれが案外難しい。Apache をかませないと BASIC 認証ができないからだ。そこで WEBrick を使って BASIC 認証を行うようにしてみた。

情報ソース

基本的には、私が過去に書いた

SSL 上で WEBrick を動かす
WEBrick で Basic 認証を行う

という2つのエントリの応用編である。

使い方

下のソースコード

OPTIONS = {
  :realm           => 'My Application',
  :user            => 'guest',
  :password        => 'passwd',  
  ...

とある部分を適宜変更して、webrick_basic_auth.rb という名前のファイルで保存し $RAILS_ROOT/script 以下に置く。(realm というのは、認証ダイアログでユーザ名やパスワードのテキストフィールドのうえに表示される文字列である。) そして次のコマンドを実行する。

% cd $RAILS_ROOT
% ruby script/webrick_basic_auth.rb 

これで BASIC 認証の掛かった Rails アプリが起動する。-p でポート番号を指定したりとか、普通の script/server と同じコマンドオプションが指定できる。

ソースコード

#!/usr/bin/env ruby
require File.dirname(__FILE__) + '/../config/boot'

require 'active_support'
require 'fileutils'

puts "=> Booting WEBrick on BASIC authentication..."

%w(cache pids sessions sockets).each { |dir_to_make| FileUtils.mkdir_p(File.join(RAILS_ROOT, 'tmp', dir_to_make)) }

require 'webrick'
require 'webrick/https'
require 'optparse'

OPTIONS = {
  :realm           => 'My Application',
  :user            => 'guest',
  :password        => 'passwd',  
 
  :port            => 3000,
  :ip              => "0.0.0.0",
  :environment     => (ENV['RAILS_ENV'] || "development").dup,
  :server_root     => File.expand_path(RAILS_ROOT + "/public/"),
  :server_type     => WEBrick::SimpleServer,
  :charset         => "UTF-8",
  :mime_types      => WEBrick::HTTPUtils::DefaultMimeTypes
}

ARGV.options do |opts|
  script_name = File.basename($0)
  opts.banner = "Usage: ruby #{script_name} [options]"

  opts.separator ""

  opts.on("-p", "--port=port", Integer,
          "Runs Rails on the specified port.",
          "Default: 3000") { |v| OPTIONS[:port] = v }
  opts.on("-b", "--binding=ip", String,
          "Binds Rails to the specified ip.",
          "Default: 0.0.0.0") { |v| OPTIONS[:ip] = v }
  opts.on("-e", "--environment=name", String,
          "Specifies the environment to run this server under (test/development/production).",
          "Default: development") { |v| OPTIONS[:environment] = v }
  opts.on("-m", "--mime-types=filename", String,
                  "Specifies an Apache style mime.types configuration file to be used for mime types",
                  "Default: none") { |mime_types_file| OPTIONS[:mime_types] = WEBrick::HTTPUtils::load_mime_types(mime_types_file) }

  opts.on("-d", "--daemon",
          "Make Rails run as a Daemon (only works if fork is available -- meaning on *nix)."
          ) { OPTIONS[:server_type] = WEBrick::Daemon }

  opts.on("-c", "--charset=charset", String,
          "Set default charset for output.",
          "Default: UTF-8") { |v| OPTIONS[:charset] = v }

  opts.separator ""

  opts.on("-h", "--help",
          "Show this help message.") { puts opts; exit }

  opts.parse!
end

ENV["RAILS_ENV"] = OPTIONS[:environment]
RAILS_ENV.replace(OPTIONS[:environment]) if defined?(RAILS_ENV)

require RAILS_ROOT + "/config/environment"
require 'webrick_server'

OPTIONS['working_directory'] = File.expand_path(RAILS_ROOT)

puts "=> Rails application started on http://#{OPTIONS[:ip]}:#{OPTIONS[:port]}"
puts "=> Ctrl-C to shutdown server; call with --help for options" if OPTIONS[:server_type] == WEBrick::SimpleServer

class DispatchServlet
  def self.dispatch(options = {})
  
      Socket.do_not_reverse_lookup = true # patch for OS X

      params = { :Port        => options[:port].to_i,
               :ServerType  => options[:server_type],
               :BindAddress => options[:ip],
                :RequestCallback => lambda do |req, res|
                     HTTPAuth.basic_auth(req, res, options[:realm]) do |user, password|
                       user == options[:user] && password == options[:password]
                  end
                end      
               }
               
      params[:MimeTypes] = options[:mime_types] if options[:mime_types]

      server = WEBrick::HTTPServer.new(params)
      server.mount('/', DispatchServlet, options)

      trap("INT") { server.shutdown }
      
      server.start
  end
end

DispatchServlet.dispatch(OPTIONS)

追記

デーモンとして webrick を立ち上げないと、シェルを抜けたあと動きがおかしくなってしまう。
デーモンとして webrick を立ち上げるには、

% ruby script/webrick_basic_auth.rb -d

とする。