rubycas-server 0.1.0 → 0.2.0

data/CHANGELOG.txt

@@ -1,3 +1,14 @@
+=== 0.2.0 :: 
+
+* ruby-casserver now behaves more like a real command-line app, accepting
+  various command line arguments including -h (help), -v (version), -c (use
+  an alternate config.yml), and -d (daemonize, when using webrick or mongrel mode)
+* special characters in CAS XML responses are now properly encoded into XML
+  entities
+* CAS XML responses are no longer auto-indented... Markaby's indentation
+  seemed to be causing problems with the PHP CAS client
+* Misc minor bug fixes/cleanup
+
 === 0.1.0 :: 2007-03-01
 
 * First public release.

data/Manifest.txt

@@ -3,6 +3,7 @@ LICENSE.txt
 Manifest.txt
 README.txt
 Rakefile
+bin/rubycas-server
 config.example.yml
 lib/casserver.rb
 lib/casserver/authenticators/active_directory_ldap.rb
@@ -14,6 +15,7 @@ lib/casserver/cas.rb
 lib/casserver/conf.rb
 lib/casserver/controllers.rb
 lib/casserver/models.rb
+lib/casserver/postambles.rb
 lib/casserver/utils.rb
 lib/casserver/version.rb
 lib/casserver/views.rb

data/README.txt

@@ -1,5 +1,7 @@
 === RubyCAS-Server ===========================================================
 
+Copyright 2007 Urbacon Ltd.
+
 For info and installation instructions please see:
 
   http://code.google.com/p/rubycas-server/

data/bin/rubycas-server

@@ -1,7 +1,38 @@
 #!/usr/bin/env ruby
 
-require 'rubygems'
-require_gem 'rubycas-server'
+require 'optparse'
+
+local_casserver = File.expand_path(File.dirname(File.expand_path(__FILE__))+'/../lib/casserver.rb')
+if File.exists? local_casserver
+  $: << File.dirname(local_casserver)
+else
+  require 'rubygems'
+  require_gem 'rubycas-server'
+end
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: rubycas-server [options]"
+
+  opts.on("-c", "--config FILE", "Use config file (default is /etc/rubycas-server/config.yml)") do |c|
+  	puts "Using config file #{c}"
+    $CONFIG_FILE = c
+  end
+  
+  opts.on("-d", "--daemonize", "Run as a daemon (only when using webrick or mongrel)") do |c|
+    $DAEMONIZE = true
+  end
+  
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+  
+  opts.on_tail("-v", "--version", "Show version number") do
+  	require 'casserver/version'
+    puts "rubycas-server-#{CASServer::VERSION::STRING}"
+    exit
+  end
+end.parse!
 
 $RUN = true
 

data/config.example.yml

@@ -28,8 +28,8 @@ port: 443
 ssl_cert: /path/to/your/ssl.pem
 # ssl_key: /path/to/your/private_key.pem  <-- if private key is separate from cert
 
-### mongrel example (you will need to run this behind an https reverse proxy,
-### since mongrel doesn't support SSL on its own)
+### mongrel example (since mongrel doesn't support SSL on its own, you will have to run
+###  this behind an https reverse proxy)
 
 #server: mongrel
 #port: 110011

data/lib/casserver.rb

@@ -4,7 +4,8 @@
 Dir.chdir(File.dirname(File.expand_path(__FILE__))) if __FILE__ == $0
 
 # add current directory to load path
-$: << File.dirname(File.expand_path(__FILE__))
+$CASSERVER_HOME = File.dirname(File.expand_path(__FILE__))
+$: << $CASSERVER_HOME
 
 require 'rubygems'
 require_gem 'camping', '~> 1.5'
@@ -14,7 +15,7 @@ require 'active_support'
 require 'yaml'
 
 # enable xhtml source code indentation for debugging views
-Markaby::Builder.set(:indent, 2)
+#Markaby::Builder.set(:indent, 2)
 
 # seed the random number generator (ruby does this by default, but it doesn't hurt to do it here just to be sure)
 srand
@@ -23,6 +24,20 @@ srand
 Camping.goes :CASServer
 
 module CASServer
+  def init_logger
+    $LOG = CASServer::Utils::Logger.new(CASServer::Conf.log[:file])
+    $LOG.level = "CASServer::Utils::Logger::#{CASServer::Conf.log[:level]}".constantize
+  end
+  module_function :init_logger
+
+  def init_db_logger
+    if CASServer::Conf.db_log
+      CASServer::Models::Base.logger = Logger.new(CASServer::Conf.db_log[:file] || 'casserver_db.log')
+      CASServer::Models::Base.logger.level = "CASServer::Utils::Logger::#{CASServer::Conf.db_log[:level] || 'DEBUG'}".constantize
+    end
+  end
+  module_function :init_db_logger
+
 end
 
 require 'casserver/utils'
@@ -32,9 +47,7 @@ require 'casserver/conf'
 require 'casserver/views'
 require 'casserver/controllers'
 
-# init the logger
-$LOG = CASServer::Utils::Logger.new(CASServer::Conf.log[:file])
-$LOG.level = "CASServer::Utils::Logger::#{CASServer::Conf.log[:level]}".constantize
+CASServer.init_logger
 
 # do initialization stuff
 def CASServer.create
@@ -55,98 +68,20 @@ end
 # this gets run if we launch directly (i.e. `ruby casserver.rb` rather than `camping casserver`)
 if __FILE__ == $0 || $RUN
   CASServer::Models::Base.establish_connection(CASServer::Conf.database)
-  if CASServer::Conf.db_log
-    CASServer::Models::Base.logger = Logger.new(CASServer::Conf.db_log[:file] || 'casserver_db.log')
-    CASServer::Models::Base.logger.level = "CASServer::Utils::Logger::#{CASServer::Conf.db_log[:level] || 'DEBUG'}".constantize
-  end
-
-  case CASServer::Conf.server
-  when "webrick", :webrick
-    require 'webrick/httpserver'
-    require 'webrick/https'
-    require 'camping/webrick'
-    
-    # TODO: verify the certificate's validity
-    # example of how to do this is here: http://pablotron.org/download/ruri-20050331.rb
-    
-    cert_path = CASServer::Conf.ssl_cert
-    key_path = CASServer::Conf.ssl_key || CASServer::Conf.ssl_cert
-      # look for the key in the ssl_cert if no ssl_key is specified
-    
-    raise "'#{cert_path}' is not a valid ssl certificate. Your 'ssl_cert' configuration" +
-      " setting must be a path to a valid ssl certificate file." unless
-        File.exists? cert_path
-    
-    raise "'#{key_path}' is not a valid ssl private key. Your 'ssl_key' configuration" +
-      " setting must be a path to a valid ssl private key file." unless
-        File.exists? key_path
-    
-    cert = OpenSSL::X509::Certificate.new(File.read(cert_path))
-    key = OpenSSL::PKey::RSA.new(File.read(key_path))
-    
-    begin
-      s = WEBrick::HTTPServer.new(
-        :BindAddress => "0.0.0.0",
-        :Port => CASServer::Conf.port,
-        :SSLEnable => true,
-        :SSLVerifyClient => ::OpenSSL::SSL::VERIFY_NONE,
-        :SSLCertificate => cert,
-        :SSLPrivateKey => key
-      )
-    rescue Errno::EACCES
-      puts "\nThe server could not launch. Are you running on a privileged port? (e.g. port 443) If so, you must run the server as root."
-      exit 2
-    end
-    
-    CASServer.create
-    s.mount "#{CASServer::Conf.uri_path}", WEBrick::CampingHandler, CASServer
-    
-    puts "\n** CASServer is running at http://localhost:#{CASServer::Conf.port}#{CASServer::Conf.uri_path} and logging to '#{CASServer::Conf.log[:file]}'\n\n"
-  
-    # This lets Ctrl+C shut down your server
-    trap(:INT) do
-      s.shutdown
-    end
+  CASServer.init_db_logger unless CASServer::Conf.server.to_s == 'mongrel'
   
-    s.start
-    
-  when "mongrel", :mongrel
-    require 'rubygems'
-    require 'mongrel/camping'
-    
-    # camping has fixes for mongrel currently only availabe in SVN
-    # ... you can install camping from svn (1.5.180) by running: 
-    #     gem install camping --source code.whytheluckystiff.net
-    require_gem 'camping', '~> 1.5.180'
-    
-    CASServer.create
+  require 'casserver/postambles'
+  include CASServer::Postambles
   
-    begin
-      server = Mongrel::Camping::start("0.0.0.0",CASServer::Conf.port,"#{CASServer::Conf.uri_path}",CASServer)
-    rescue Errno::EACCES
-      puts "\nThe server could not launch. Are you running on a privileged port? (e.g. port 443) If so, you must run the server as root."
-      exit 2
-    end
-    
-    puts "\n** CASServer is running at http://localhost:#{CASServer::Conf.port}#{CASServer::Conf.uri_path} and logging to '#{CASServer::Conf.log[:file]}'"
-    server.run.join
-  
-  when "fastcgi", :fastcgi
-    require 'camping/fastcgi'
-    Dir.chdir('/srv/www/camping/casserver/')
-    
-    CASServer.create
-    Camping::FastCGI.start(CASServer)
-    
-  when "cgi", :cgi
-    CASServer.create
-    puts CASServer.run
-    
-  else
+  begin
+    raise NoMethodError if CASServer::Conf.server.nil?
+    send(CASServer::Conf.server)
+  rescue NoMethodError
     if CASServer::Conf.server
       raise "The server setting '#{CASServer::Conf.server}' in your config.yml file is invalid."
     else
       raise "You must have a 'server' setting in your config.yml file. Please see the RubyCAS-Server documentation."
     end
   end
-end 
+
+end 

data/lib/casserver/conf.rb

@@ -1,9 +1,13 @@
 # load configuration
-begin  
-  conf_file = etc_conf = "/etc/rubycas-server/config.yml"
-  unless File.exists? conf_file 
-    # can use local config.yml file in case we're running non-gem installation
-    conf_file = File.dirname(File.expand_path(__FILE__))+"/../../config.yml"
+begin
+  if $CONFIG_FILE
+    conf_file = $CONFIG_FILE
+  else
+    conf_file = etc_conf = "/etc/rubycas-server/config.yml"
+    unless File.exists? conf_file 
+      # can use local config.yml file in case we're running non-gem installation
+      conf_file = File.dirname(File.expand_path(__FILE__))+"/../../config.yml"
+    end
   end
 
   unless File.exists? conf_file  

data/lib/casserver/postambles.rb

@@ -0,0 +1,113 @@
+module CASServer
+  module Postambles
+    
+    def webrick
+      require 'webrick/httpserver'
+      require 'webrick/https'
+      require 'camping/webrick'
+      
+      # TODO: verify the certificate's validity
+      # example of how to do this is here: http://pablotron.org/download/ruri-20050331.rb
+      
+      cert_path = CASServer::Conf.ssl_cert
+      key_path = CASServer::Conf.ssl_key || CASServer::Conf.ssl_cert
+        # look for the key in the ssl_cert if no ssl_key is specified
+      
+      raise "'#{cert_path}' is not a valid ssl certificate. Your 'ssl_cert' configuration" +
+        " setting must be a path to a valid ssl certificate file." unless
+          File.exists? cert_path
+      
+      raise "'#{key_path}' is not a valid ssl private key. Your 'ssl_key' configuration" +
+        " setting must be a path to a valid ssl private key file." unless
+          File.exists? key_path
+      
+      cert = OpenSSL::X509::Certificate.new(File.read(cert_path))
+      key = OpenSSL::PKey::RSA.new(File.read(key_path))
+      
+      begin
+        s = WEBrick::HTTPServer.new(
+          :BindAddress => "0.0.0.0",
+          :Port => CASServer::Conf.port,
+          :SSLEnable => true,
+          :SSLVerifyClient => ::OpenSSL::SSL::VERIFY_NONE,
+          :SSLCertificate => cert,
+          :SSLPrivateKey => key
+        )
+      rescue Errno::EACCES
+        puts "\nThe server could not launch. Are you running on a privileged port? (e.g. port 443) If so, you must run the server as root."
+        exit 2
+      end
+      
+      CASServer.create
+      s.mount "#{CASServer::Conf.uri_path}", WEBrick::CampingHandler, CASServer
+      
+      puts "\n** CASServer is running at http://localhost:#{CASServer::Conf.port}#{CASServer::Conf.uri_path} and logging to '#{CASServer::Conf.log[:file]}'\n\n"
+    
+      # This lets Ctrl+C shut down your server
+      trap(:INT) do
+        s.shutdown
+      end
+    
+      if $DAEMONIZE
+        WEBrick::Daemon.start {s.start}
+      else
+        s.start
+      end
+    end
+    
+    
+    
+    def mongrel
+      require 'rubygems'
+      require 'mongrel/camping'
+      
+      # camping has fixes for mongrel currently only availabe in SVN
+      # ... you can install camping from svn (1.5.180) by running: 
+      #     gem install camping --source code.whytheluckystiff.net
+      require_gem 'camping', '~> 1.5.180'
+      
+      CASServer.create    
+      
+      puts "\n** CASServer is starting. Look in '#{CASServer::Conf.log[:file]}' for further notices."
+      
+      settings = {:host => "0.0.0.0", :log_file => CASServer::Conf.log[:file], :cwd => $CASSERVER_HOME}
+      
+      # need to close all IOs if we daemonize
+      $LOG.close
+      
+      config = Mongrel::Configurator.new settings  do
+        daemonize :log_file => CASServer::Conf.log[:file], :cwd => $CASSERVER_HOME if $DAEMONIZE
+        
+        listener :port => CASServer::Conf.port do
+          uri CASServer::Conf.uri_path, :handler => Mongrel::Camping::CampingHandler.new(CASServer)
+          setup_signals
+        end
+      end
+      
+      config.run
+      
+      CASServer.init_logger
+      CASServer.init_db_logger
+      
+      puts "\n** CASServer is running at http://localhost:#{CASServer::Conf.port}#{CASServer::Conf.uri_path} and logging to '#{CASServer::Conf.log[:file]}'"
+      config.join
+      puts "\n** CASServer is stopped (#{Time.now})"
+    end
+    
+    
+    def fastcgi
+      require 'camping/fastcgi'
+      Dir.chdir('/srv/www/camping/casserver/')
+      
+      CASServer.create
+      Camping::FastCGI.start(CASServer)
+    end
+    
+    
+    def cgi
+      CASServer.create
+      puts CASServer.run
+    end
+  
+  end
+end

data/lib/casserver/version.rb

@@ -1,7 +1,7 @@
 module CASServer
   module VERSION #:nodoc:
     MAJOR = 0
-    MINOR = 1
+    MINOR = 2
     TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')

data/lib/casserver/views.rb

@@ -27,8 +27,6 @@ module CASServer::Views
 
   # 2.1.3
   def login
-    @logo = 
-  
     table(:id => "login-box") do
       tr do
         td(:colspan => 2) do
@@ -104,15 +102,15 @@ module CASServer::Views
     if @success
       tag!("cas:serviceResponse", 'xmlns:cas' => "http://www.yale.edu/tp/cas") do
         tag!("cas:authenticationSuccess") do
-          tag!("cas:user") {@username}
+          tag!("cas:user") {@username.to_s.to_xs}
           if @pgtiou
-            tag!("cas:proxyGrantingTicket") {@pgtiou}
+            tag!("cas:proxyGrantingTicket") {@pgtiou.to_s.to_xs}
           end
         end
       end
     else
       tag!("cas:serviceResponse", 'xmlns:cas' => "http://www.yale.edu/tp/cas") do
-        tag!("cas:authenticationFailure", :code => @error.code) {@error}
+        tag!("cas:authenticationFailure", :code => @error.code) {@error.to_s.to_xs}
       end
     end
   end
@@ -123,14 +121,14 @@ module CASServer::Views
     if @success
       tag!("cas:serviceResponse", 'xmlns:cas' => "http://www.yale.edu/tp/cas") do
         tag!("cas:authenticationSuccess") do
-          tag!("cas:user") {@username}
+          tag!("cas:user") {@username.to_s.to_xs}
           if @pgtiou
-            tag!("cas:proxyGrantingTicket") {@pgtiou}
+            tag!("cas:proxyGrantingTicket") {@pgtiou.to_s.to_xs}
           end
           if @proxies && !@proxies.empty?
             tag!("cas:proxies") do
               @proxies.each do |proxy_url|
-                tag!("cas:proxy") {proxy_url}
+                tag!("cas:proxy") {proxy_url.to_s.to_xs}
               end
             end
           end
@@ -138,7 +136,7 @@ module CASServer::Views
       end
     else
       tag!("cas:serviceResponse", 'xmlns:cas' => "http://www.yale.edu/tp/cas") do
-        tag!("cas:authenticationFailure", :code => @error.code) {@error}
+        tag!("cas:authenticationFailure", :code => @error.code) {@error.to_s.to_xs}
       end
     end
   end
@@ -149,12 +147,12 @@ module CASServer::Views
     if @success
       tag!("cas:serviceResponse", 'xmlns:cas' => "http://www.yale.edu/tp/cas") do
         tag!("cas:proxySuccess") do
-          tag!("cas:proxyTicket") {@pt}
+          tag!("cas:proxyTicket") {@pt.to_s.to_xs}
         end
       end
     else
       tag!("cas:serviceResponse", 'xmlns:cas' => "http://www.yale.edu/tp/cas") do
-        tag!("cas:proxyFailure", :code => @error.code) {@error}
+        tag!("cas:proxyFailure", :code => @error.code) {@error.to_s.to_xs}
       end
     end
   end
@@ -182,4 +180,4 @@ module CASServer::Views
     CASServer::Conf.infoline || ""
   end
   module_function :infoline
-end
+end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: rubycas-server
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
-date: 2007-03-08 00:00:00 -05:00
+  version: 0.2.0
+date: 2007-03-20 00:00:00 -04:00
 summary: Provides single sign on for web applications using the CAS protocol.
 require_paths: 
 - lib
@@ -34,6 +34,7 @@ files:
 - Manifest.txt
 - README.txt
 - Rakefile
+- bin/rubycas-server
 - config.example.yml
 - lib/casserver.rb
 - lib/casserver/authenticators/active_directory_ldap.rb
@@ -45,6 +46,7 @@ files:
 - lib/casserver/conf.rb
 - lib/casserver/controllers.rb
 - lib/casserver/models.rb
+- lib/casserver/postambles.rb
 - lib/casserver/utils.rb
 - lib/casserver/version.rb
 - lib/casserver/views.rb