rails_pwnerer 0.1 → 0.2

data/CHANGELOG

@@ -1 +1,3 @@
+v0.2. Supports 'install' to install application from svn. No configuration outside of config/main.rb.
+
 v0.1. Initial release. Supports 'den00b' to setup the environment.

data/Manifest

@@ -1,10 +1,16 @@
 bin/rpwn
 CHANGELOG
+lib/pwnage/app/cluster_config.rb
+lib/pwnage/app/database.rb
+lib/pwnage/app/main.rb
+lib/pwnage/app/nginx_config.rb
+lib/pwnage/app/svn.rb
 lib/pwnage/base/dirs.rb
 lib/pwnage/base/gems.rb
 lib/pwnage/base/packages.rb
 lib/pwnage/base/startup.rb
 lib/pwnage/base.rb
+lib/pwnage/config/main.rb
 lib/pwnage/executor.rb
 lib/pwnage/scaffolds/dirs.rb
 lib/pwnage/scaffolds/gems.rb

data/README

@@ -1,9 +1,26 @@
-This is the ruby driver for the Trusted Execution Module prototype produced at MIT. The best feature of the
-ruby driver is the very powerful DSL (domain-specific language) that TEM procedures are compiled from.
+I want this gem to be Pure Pwnage with Rails.
 
-This work is not ready for publication. If you come across this document and/or software, please do not use or
-distribute it until this notice is removed.
+I built +rails_pwnerer+ because I hate the messy process of putting a rails
+application into production. I don't enjoy following 10-page guides, so I'd
+much rather having ruby do that for me.
 
-Running coverage tests:
-gem install rcov
-rcov -Ilib test/*.rb
+Right now, +rails_pwnerer+ assumes a fresh Ubuntu 7.10 installation. You're
+welcome to test/update for other systems, and I'll be happy to merge patches,
+or add you to the RubyForge project. 
+
+
+Quick start with +rails_pwnerer+:
+
+1) Install rubygems:
+sudo apt-get install rubygems
+
+2) Install +rails_pwnerer+:
+sudo gem install rails_pwnerer
+
+3) Get your server production-ready:
+sudo rpwn den00b
+
+4) Install your application:
+sudo rpwn install svn+ssh://your.repo/path/to/your_application
+
+That's it. Reboot, and you're ready.

data/lib/pwnage/app/cluster_config.rb

@@ -0,0 +1,45 @@
+# builds the mongrel cluster configuration
+
+require 'fileutils'
+
+class RailsPwnage::App::ClusterConfig
+  include RailsPwnage::Base
+  
+  def fix_permissions(app_name)
+    pwnerer_user = RailsPwnage::Config.pwnerer_user
+    pwnerer_uid = uid_for_username(pwnerer_user)
+    pwnerer_group = group_for_username(pwnerer_user)
+    
+    with_dir(RailsPwnage::Config.path_to(app_name)) do
+      %w(log tmp public).each do |writable_dir|
+        FileUtils.chown_R(pwnerer_uid, pwnerer_group, writable_dir)
+      end
+    end
+  end
+
+  def configure_mongrels(app_name)
+    app_path = RailsPwnage::Config.path_to app_name
+    pwnerer_user = RailsPwnage::Config.pwnerer_user
+    pwnerer_group = group_for_username(pwnerer_user)
+    
+    instances = RailsPwnage::Config.app_instances(app_name)
+    first_port = RailsPwnage::Config.app_port0(app_name)
+    
+    with_dir(app_path) do
+      # create the mongrel_cluster configuration
+      system "mongrel_rails cluster::configure -e production -N #{instances} -p #{first_port} -a 127.0.0.1 -c #{app_path} --user #{pwnerer_user} --group #{pwnerer_group}"
+      
+      # copy the configuration to the launch directory
+      FileUtils.cp('config/mongrel_cluster.yml', "#{RailsPwnage::Config.path_to :mongrel_configs}#{File::SEPARATOR}#{app_name}.yml")
+    end    
+  end
+
+  def setup(app_name)
+    configure_mongrels app_name
+    fix_permissions app_name
+  end
+  
+  def self.setup(app_name)
+    self.new.setup(app_name)
+  end  
+end

data/lib/pwnage/app/database.rb

@@ -0,0 +1,50 @@
+# sets up the application database
+
+class RailsPwnage::App::Database
+  include RailsPwnage::Base
+
+  # creates the mysql database for the application
+  def create_databse(app_name)
+    db_name = RailsPwnage::Config.app_dbname(app_name)
+    db_user = RailsPwnage::Config.app_db_user(app_name)
+    db_pass = RailsPwnage::Config.app_db_password(app_name)
+    
+    with_dir(RailsPwnage::Config.path_to(app_name)) do
+      # put together the creation script
+      sql_commands = <<ENDSQL
+        CREATE DATABASE #{db_name};
+        GRANT ALL ON #{db_name}.* TO '#{db_user}'@'localhost' IDENTIFIED BY '#{db_pass}' WITH GRANT OPTION;
+ENDSQL
+      
+      # run it
+      File.open('tmp/create_db.sql', 'w') { |f| f.write sql_commands }
+      system "mysql -uroot < tmp/create_db.sql"
+      
+      # cleanup
+      File.delete('tmp/create_db.sql')
+    end    
+  end
+  
+  # configures rails to use the database in the production environment
+  def configure_rails(app_name)
+    # TODO: write rails configuration file
+  end
+  
+  # migrates the database so it's ready
+  def migrate_database(app_name)
+    with_dir(RailsPwnage::Config.path_to(app_name)) do
+      # now migrate the database
+      system "rake db:migrate RAILS_ENV=production"
+    end
+  end
+
+  def setup(app_name)
+    create_databse app_name
+    configure_rails app_name
+    migrate_database app_name
+  end
+  
+  def self.setup(app_name)
+    self.new.setup(app_name)
+  end
+end

data/lib/pwnage/app/main.rb

@@ -0,0 +1,9 @@
+module RailsPwnage::App
+  # installs an application given its SVN path
+  def self.install(svn_path)
+    app_name = Svn.setup(svn_path)
+    Database.setup(app_name)
+    ClusterConfig.setup(app_name)
+    NginxConfig.setup(app_name)
+  end
+end

data/lib/pwnage/app/nginx_config.rb

@@ -0,0 +1,63 @@
+# builds the nginx configuration
+
+class RailsPwnage::App::NginxConfig
+  include RailsPwnage::Base
+  
+  # writes the nginx configuration for this server
+  def config_nginx(app_name)
+    first_port = RailsPwnage::Config.app_port0(app_name)
+    hostname_filter = RailsPwnage::Config.app_servername(app_name)
+    
+    File.open(RailsPwnage::Config.path_to(:nginx_configs) + File::SEPARATOR + app_name, 'w') do |f|
+      # link to the mongrels
+      f << "  upstream #{app_name} {\n"
+      RailsPwnage::Config.app_instances(app_name).times do |instance|
+        f << "    server 127.0.0.1:#{first_port + instance};\n"
+      end
+      f << "  }\n\n"
+      
+      # server configuration -- big and ugly
+      f << <<NGINX_CONFIG
+  server {
+    listen 80;
+    #{(hostname_filter.nil? ? '' : "server_name " + hostname_filter + ";")}
+    root #{RailsPwnage::Config.path_to(app_name)};
+    client_max_body_size #{RailsPwnage::Config.app_max_request_mb(app_name)}M;
+    location / {
+      proxy_set_header X-Real-IP $remote_addr;
+      proxy_set_header Host $host;
+      proxy_redirect false;
+      proxy_connect_timeout 2;
+      proxy_read_timeout 86400;
+
+      if (-f $request_filename/index.html) {
+        rewrite (.*) $1/index.html break;
+      }
+      if (-f $request_filename.html) {
+        rewrite (.*) $1.html break;
+      }
+      if (!-f $request_filename) {
+        proxy_pass http://#{app_name};
+        break;
+      }
+    }
+  }      
+NGINX_CONFIG
+    end    
+  end
+  
+  # removes the default configuration stub (so nginx doesn't stumble upon it)
+  def remove_nginx_stub
+    stub_file = RailsPwnage::Config.path_to(:nginx_configs) + File::SEPARATOR + 'default'
+    File.delete(stub_file) if File.exists?(stub_file)
+  end
+  
+  def setup(app_name)
+    config_nginx(app_name)
+    remove_nginx_stub
+  end 
+
+  def self.setup(app_name)
+    self.new.setup(app_name)
+  end
+end

data/lib/pwnage/app/svn.rb

@@ -0,0 +1,33 @@
+# checks out the application
+
+require 'fileutils'
+
+class RailsPwnage::App::Svn
+  include RailsPwnage::Base
+  
+  def checkout(svn_path)
+    app_name = File.basename(svn_path)
+
+    prod_apps = RailsPwnage::Config.path_to :prod_apps
+    with_dir(prod_apps) do
+      # checkout application
+      system "svn co #{svn_path} #{app_name}"
+    end
+    
+    return app_name
+  end
+        
+  def setup(svn_path)
+    app_name = checkout(svn_path)
+
+    # TODO: fetch configuration, feed to system 
+
+    return app_name    
+  end
+  
+  def self.setup(svn_path)
+    self.new.setup(svn_path)
+  end
+  
+  # TODO: uninstallation
+end

data/lib/pwnage/base/dirs.rb

@@ -4,7 +4,7 @@ require 'etc'
 
 module RailsPwnage::Base
   # runs the associated block within a certain directory
-  def self.with_dir(dir)
+  def with_dir(dir)
     old_dir = Dir.pwd()
     Dir.chdir(dir)
     
@@ -16,8 +16,22 @@ module RailsPwnage::Base
   end
   
   # gets the UID associated with the username
-  def self.uid_for_username(name)
-    passwd_entry = getpwnam(name)
+  def uid_for_username(name)
+    passwd_entry = Etc.getpwnam(name)
     return (passwd_entry.nil?) ? nil : passwd_entry.uid
-  end  
-end
+  end
+  
+  # gets the GID associated with the username
+  def gid_for_username(name)
+    passwd_entry = Etc.getpwnam(name)
+    return (passwd_entry.nil?) ? nil : passwd_entry.gid    
+  end
+  
+  # gets the main group of the given user
+  def group_for_username(name)
+    gid = gid_for_username(name)
+    return nil if gid.nil?
+    group_entry = Etc.getgrgid(gid)
+    return (group_entry.nil?) ? nil : group_entry.name 
+  end
+end

data/lib/pwnage/base/startup.rb

@@ -16,4 +16,16 @@ module RailsPwnage::Base
     # add to boot sequence
     system "update-rc.d #{script_name} defaults"
   end
+  
+  def control_boot_script(script_name, action = :restart)
+    path_to_script = "/etc/init.d/#{script_name}"
+    case action
+    when :stop
+      system "#{path_to_script} stop"
+    when :start
+      system "#{path_to_script} start"
+    when :restart
+      system "#{path_to_script} restart"
+    end
+  end
 end

data/lib/pwnage/config/main.rb

@@ -0,0 +1,68 @@
+module RailsPwnage::Config
+  # the path to something important (e.g. :prod_apps --> path to all production applications)
+  def self.path_to(what = :prod)
+    case what
+    when :prod
+      # the directory containing all the production data
+      '/prod'
+    when :prod_apps
+      # the directory containing the production apps
+      '/prod/apps'
+    when :prod_config
+      # the directory containing the config files
+      '/prod/config'
+    when :mongrel_configs
+      # the directory containing the mongrel_cluster config files
+      '/etc/mongrel_cluster'
+    when :nginx_configs
+      # the directory containing the nginx config files
+      '/etc/nginx/sites-enabled'
+    when String
+      # an application
+      self.path_to(:prod_apps) + File::SEPARATOR + what
+    end
+  end
+
+  # the user which will receive the keys to the production system 
+  def self.pwnerer_user
+    'victor'
+  end
+  
+  # the number of instances for the given application
+  def self.app_instances(app_name)
+    4
+  end
+  
+  # the first internal port for the given application
+  def self.app_port0(app_name)
+    8000
+  end
+  
+  # the name of the database for the given application
+  def self.app_dbname(app_name)
+    # NOTE: convention, this doesn't have to change
+    app_name + '_prod' 
+  end
+ 
+  # the datbase user for the given application
+  def self.app_db_user(app_name)
+    # NOTE: convention, this doesn't have to change
+    app_name
+  end
+  
+  # the password of the database user for the given application
+  def self.app_db_password(app_name)
+    'superpass'
+  end
+  
+  # a DNS name for server-based filtering (multiple apps on the same box)
+  def self.app_servername(app_name)
+    # "#{app_name}.zergling.net"
+    nil
+  end
+  
+  # the maximum request size (megabytes) to be accepted by an application
+  def self.app_max_request_mb(app_name)
+    48
+  end
+end

data/lib/pwnage/executor.rb

@@ -18,6 +18,10 @@ class RailsPwnage::Executor
         Gems.go
         Dirs.go
         HookMongrels.go
+        
+      when 'install'
+        svn_path = args[1]
+        RailsPwnage::App.install svn_path
     end
   end
   

data/lib/pwnage/scaffolds/dirs.rb

@@ -1,16 +1,18 @@
 # sets up the required directory structure
 
+require 'fileutils'
+
 class RailsPwnage::Scaffolds::Dirs
   include RailsPwnage::Base
 
   # runner
   def run
+    pwnerer_uid = uid_for_username(RailsPwnage::Config.pwnerer_user)
     with_dir('/') do
-      Dir.mkdir('prod')
-      Dir.mkdir('prod/apps')
-      File.chown(uid_for_username('victor'), nil, 'prod/apps')
-      Dir.mkdir('prod/config')
-      File.chown(uid_for_username('victor'), nil, 'prod/config')
+      [:prod_apps, :prod_config].map { |k| RailsPwnage::Config.path_to k }.each do |path|
+        FileUtils.mkpath path
+        File.chown(pwnerer_uid, nil, path)        
+      end
     end
   end
 

data/lib/pwnage/scaffolds/hook_mongrels.rb

@@ -21,7 +21,7 @@ class RailsPwnage::Scaffolds::HookMongrels
   
   # build the configuration
   def make_config
-    Dir.mkdir('/etc/mongrel_cluster')
+    Dir.mkdir(RailsPwnage::Config.path_to(:mongrel_configs))
   end
 
   # runner

data/lib/rails_pwnage.rb

@@ -10,9 +10,17 @@ require 'pwnage/base/gems.rb'
 require 'pwnage/base/packages.rb'
 require 'pwnage/base/startup.rb'
 
+require 'pwnage/config/main.rb'
+
 require 'pwnage/executor.rb'
 
 require 'pwnage/scaffolds/dirs.rb'
 require 'pwnage/scaffolds/gems.rb'
 require 'pwnage/scaffolds/hook_mongrels.rb'
 require 'pwnage/scaffolds/packages.rb'
+
+require 'pwnage/app/main.rb'
+require 'pwnage/app/svn.rb'
+require 'pwnage/app/database.rb'
+require 'pwnage/app/cluster_config.rb'
+require 'pwnage/app/nginx_config.rb'

data/rails_pwnerer.gemspec

@@ -1,10 +1,10 @@
 
-# Gem::Specification for Rails_pwnerer-0.1
+# Gem::Specification for Rails_pwnerer-0.2
 # Originally generated by Echoe
 
 Gem::Specification.new do |s|
   s.name = %q{rails_pwnerer}
-  s.version = "0.1"
+  s.version = "0.2"
 
   s.specification_version = 2 if s.respond_to? :specification_version=
 
@@ -15,8 +15,8 @@ Gem::Specification.new do |s|
   s.description = %q{Rails deployment tool/hack.}
   s.email = %q{victor@costan.us}
   s.executables = ["rpwn"]
-  s.extra_rdoc_files = ["bin/rpwn", "CHANGELOG", "lib/pwnage/base/dirs.rb", "lib/pwnage/base/gems.rb", "lib/pwnage/base/packages.rb", "lib/pwnage/base/startup.rb", "lib/pwnage/base.rb", "lib/pwnage/executor.rb", "lib/pwnage/scaffolds/dirs.rb", "lib/pwnage/scaffolds/gems.rb", "lib/pwnage/scaffolds/hook_mongrels.rb", "lib/pwnage/scaffolds/packages.rb", "lib/rails_pwnage.rb", "LICENSE", "README"]
-  s.files = ["bin/rpwn", "CHANGELOG", "lib/pwnage/base/dirs.rb", "lib/pwnage/base/gems.rb", "lib/pwnage/base/packages.rb", "lib/pwnage/base/startup.rb", "lib/pwnage/base.rb", "lib/pwnage/executor.rb", "lib/pwnage/scaffolds/dirs.rb", "lib/pwnage/scaffolds/gems.rb", "lib/pwnage/scaffolds/hook_mongrels.rb", "lib/pwnage/scaffolds/packages.rb", "lib/rails_pwnage.rb", "LICENSE", "Manifest", "README", "RUBYFORGE", "rails_pwnerer.gemspec"]
+  s.extra_rdoc_files = ["bin/rpwn", "CHANGELOG", "lib/pwnage/app/cluster_config.rb", "lib/pwnage/app/database.rb", "lib/pwnage/app/main.rb", "lib/pwnage/app/nginx_config.rb", "lib/pwnage/app/svn.rb", "lib/pwnage/base/dirs.rb", "lib/pwnage/base/gems.rb", "lib/pwnage/base/packages.rb", "lib/pwnage/base/startup.rb", "lib/pwnage/base.rb", "lib/pwnage/config/main.rb", "lib/pwnage/executor.rb", "lib/pwnage/scaffolds/dirs.rb", "lib/pwnage/scaffolds/gems.rb", "lib/pwnage/scaffolds/hook_mongrels.rb", "lib/pwnage/scaffolds/packages.rb", "lib/rails_pwnage.rb", "LICENSE", "README"]
+  s.files = ["bin/rpwn", "CHANGELOG", "lib/pwnage/app/cluster_config.rb", "lib/pwnage/app/database.rb", "lib/pwnage/app/main.rb", "lib/pwnage/app/nginx_config.rb", "lib/pwnage/app/svn.rb", "lib/pwnage/base/dirs.rb", "lib/pwnage/base/gems.rb", "lib/pwnage/base/packages.rb", "lib/pwnage/base/startup.rb", "lib/pwnage/base.rb", "lib/pwnage/config/main.rb", "lib/pwnage/executor.rb", "lib/pwnage/scaffolds/dirs.rb", "lib/pwnage/scaffolds/gems.rb", "lib/pwnage/scaffolds/hook_mongrels.rb", "lib/pwnage/scaffolds/packages.rb", "lib/rails_pwnage.rb", "LICENSE", "Manifest", "README", "RUBYFORGE", "rails_pwnerer.gemspec"]
   s.has_rdoc = true
   s.homepage = %q{http://www.costan.us/rails_pwnage}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Rails_pwnerer", "--main", "README"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rails_pwnerer
 version: !ruby/object:Gem::Version 
-  version: "0.1"
+  version: "0.2"
 platform: ruby
 authors: 
 - Victor Costan
@@ -22,11 +22,17 @@ extensions: []
 extra_rdoc_files: 
 - bin/rpwn
 - CHANGELOG
+- lib/pwnage/app/cluster_config.rb
+- lib/pwnage/app/database.rb
+- lib/pwnage/app/main.rb
+- lib/pwnage/app/nginx_config.rb
+- lib/pwnage/app/svn.rb
 - lib/pwnage/base/dirs.rb
 - lib/pwnage/base/gems.rb
 - lib/pwnage/base/packages.rb
 - lib/pwnage/base/startup.rb
 - lib/pwnage/base.rb
+- lib/pwnage/config/main.rb
 - lib/pwnage/executor.rb
 - lib/pwnage/scaffolds/dirs.rb
 - lib/pwnage/scaffolds/gems.rb
@@ -38,11 +44,17 @@ extra_rdoc_files:
 files: 
 - bin/rpwn
 - CHANGELOG
+- lib/pwnage/app/cluster_config.rb
+- lib/pwnage/app/database.rb
+- lib/pwnage/app/main.rb
+- lib/pwnage/app/nginx_config.rb
+- lib/pwnage/app/svn.rb
 - lib/pwnage/base/dirs.rb
 - lib/pwnage/base/gems.rb
 - lib/pwnage/base/packages.rb
 - lib/pwnage/base/startup.rb
 - lib/pwnage/base.rb
+- lib/pwnage/config/main.rb
 - lib/pwnage/executor.rb
 - lib/pwnage/scaffolds/dirs.rb
 - lib/pwnage/scaffolds/gems.rb