build-ubuntu-ami 0.1.0

data/LICENSE

@@ -0,0 +1,9 @@
+(The MIT License)
+
+Copyright © 2012 Aaron Suggs
+
+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,28 @@
+# Build Ubuntu AMI
+
+A simple, secure tool for customizing Ubuntu images for Amazon EC2 from your local computer.
+
+## Install
+
+    gem install build-ubuntu-ami
+
+## Basic Usage
+
+    build-ubuntu-ami my_custom_script.sh
+
+## How it works
+
+This program is based heavily on Eric Hammond's blog post [Creating Public AMIs Securely for EC2](http://alestic.com/2011/06/ec2-ami-security), and his shell script [alestic-git-build-ami](https://github.com/alestic/alestic-git/blob/master/bin/alestic-git-build-ami).
+
+It works as follows:
+
+1. Boot an official Ubuntu EC2 instance
+2. Download and mount a copy of the official Ubuntu root volume image
+3. Run the custom user script in a chrooted environment on that image
+4. Attach an empty EBS volume
+5. Copy the customized boot image to the EBS volume
+6. Register an AMI from the customized EBS volume
+
+Booting and logging in to a system offers many opportunities to leak secret credentials (even if you [delete them](http://alestic.com/2009/09/ec2-public-ebs-danger)). Creating an AMI from a pristine image rather than a running root volume obviates the need to remove leaked credentials.
+
+This script does not need a private key & cert for credentials. It uses the AWS Access Key ID and Secret Access Key.

data/bin/build-ubuntu-ami

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+$: << 'lib'
+require 'build_ubuntu_ami'
+require 'optparse'
+require 'open-uri'
+
+options = BuildUbuntuAmi.default_options
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: #{$0} [options] [path or url to user script]"
+  opts.on('-r', '--region=REGION', "AWS region (#{options[:region]})") { |o| options[:region] = o }
+  opts.on('-f', '--flavor=FLAVOR', "AWS instance type (#{options[:flavor]})") { |o| options[:flavor] = o }
+  opts.on('-b', '--brand=BRAND', "brand prefix (#{options[:brand]})") { |o| options[:brand] = o }
+  opts.on('-s', '--size=SIZE', "Size of root volume in GB (#{options[:size]})") { |o| options[:size] = o }
+  opts.on('-c', '--codename=CODENAME', "Ubuntu release codename (#{options[:codename]})") { |o| options[:codename] = o }
+  opts.on('-k', '--key_name=KEY_NAME', "EC2 key name for scratch AMI (#{options[:key_name]})") { |o| options[:key_name] = o }
+  opts.on('-g', '--group=GROUP', "EC2 security group for scratch AMI (#{options[:group]})") { |o| options[:group] = o }
+
+  opts.on('-h', '--help', 'Show this message') { puts opts; exit }
+end.parse!
+
+unless ARGV[0]
+  message = %{
+Must specify a custom user script (file or url)
+See https://github.com/kickstarter/build-ubuntu-ami/tree/master/examples
+  }.strip
+  raise OptionParser::MissingArgument.new(message)
+end
+options[:custom_user_script] = open(ARGV[0]).read
+
+BuildUbuntuAmi.new(options).build!

data/data/user_data.sh.erb

@@ -0,0 +1,60 @@
+#!/bin/bash -ex
+# User data script
+
+# Log output to the console, syslog, and /var/log/user-data.log
+exec > >(tee /var/log/user-data.log|logger -t user-data -s 2>/dev/console) 2>&1
+
+# Download and mount the clean image
+image=/mnt/<%= image_name %>.img
+imagedir=/mnt/<%= image_name %>-cloudimg-<%= arch %>
+wget -qO- <%= image_url %> |
+  tar xzf - -C /mnt
+mkdir -p $imagedir
+mount -o loop $image $imagedir
+
+# Allow network access from chroot environment
+cp /etc/resolv.conf $imagedir/etc/
+
+# Upgrade and install packages on the target file system
+chroot $imagedir mount -t proc none /proc
+#sudo chroot $imagedir mount -t devpts none /dev/pts
+cat <<EOF | tee $imagedir/usr/sbin/policy-rc.d > /dev/null
+#!/bin/sh
+exit 101
+EOF
+chmod 755 $imagedir/usr/sbin/policy-rc.d
+chroot $imagedir apt-get update
+chroot $imagedir apt-get dist-upgrade -y
+
+# RUN CUSTOM USER SCRIPT
+cat <<CUSTOM_SCRIPT_EOF > $imagedir/tmp/custom_user_script
+<%= custom_user_script %>
+CUSTOM_SCRIPT_EOF
+
+chmod +x $imagedir/tmp/custom_user_script
+chroot $imagedir /tmp/custom_user_script
+# END CUSTOM USER SCRIPT
+
+# Clean up chroot environment
+chroot $imagedir umount /proc
+#chroot $imagedir umount /dev/pts
+rm -f $imagedir/usr/sbin/policy-rc.d
+
+# Wait for EBS volume to be attached
+dev=<%= ebs_device %>
+while [ ! -e $dev ]; do sleep 1; done
+
+# Format and mount the EBS volume
+yes | sudo mkfs.ext4 -L cloudimg-rootfs $dev
+ebsimagedir=$imagedir-ebs
+mkdir $ebsimagedir
+mount $dev $ebsimagedir
+
+# Copy file system from temporary rootdir to EBS volume
+tar -cSf - -C $imagedir . | sudo tar xvf - -C $ebsimagedir
+
+umount $imagedir
+umount $ebsimagedir
+
+# Shutdown to signal success
+shutdown -h now

data/lib/build_ubuntu_ami.rb

@@ -0,0 +1,157 @@
+require 'open-uri'
+require 'fog'
+require 'erb'
+
+class BuildUbuntuAmi
+  USER_DATA = File.read(File.join(File.dirname(__FILE__),'..','data','user_data.sh.erb'))
+
+  attr_accessor :region, :flavor, :brand, :size, :codename, :key_name, :group,
+    :custom_user_script, :now, :server, :volume, :snapshot, :arch,
+    :canonical_ami, :kernel
+
+  def self.default_options
+    {
+      :region   => 'us-east-1',
+      :flavor   => 'm1.small',
+      :brand    => 'My',
+      :size     => 20,
+      :codename => 'lucid',
+      :key_name => 'default',
+      :group    => 'default',
+      :arch     => 'amd64',
+      :kernel   => nil
+    }
+  end
+
+  def initialize(opts={})
+    opts = self.class.default_options.merge(opts)
+    puts "Configuration:"
+    (self.class.default_options.keys - [:kernel]).each do |attr|
+      puts "  #{attr}: #{opts[attr]}"
+      self.send("#{attr}=", opts[attr])
+    end
+    self.custom_user_script = opts[:custom_user_script]
+
+    find_canonical_ubuntu_ami
+    puts "  canonical ami: #{canonical_ami}"
+    puts "  kernel: #{kernel}"
+
+    @now = Time.now.strftime('%Y%m%d-%H%M')
+    puts "  description: #{description}"
+  end
+
+  # Return the Ubuntu AMI with the architecture for +flavor+
+  def find_canonical_ubuntu_ami
+    url = "http://uec-images.ubuntu.com/query/#{codename}/server/released.current.txt"
+    data = open(url).read.split("\n").map{|l| l.split}.detect do |ary|
+      ary[4] == 'ebs' &&
+        ary[5] == arch &&
+        ary[6] == region &&
+        ary[9] == 'paravirtual'
+    end
+
+    self.canonical_ami = data[7]
+    self.kernel ||= data[8]
+  end
+
+  def image_arch
+    case arch
+    when 'amd64'
+      'x86_64'
+    else
+      arch
+    end
+
+  end
+
+  def description
+    "#{brand}-#{codename}-#{arch}-#{now}"
+  end
+
+  def ebs_device
+    '/dev/sdi'
+  end
+
+  def root_device
+    '/dev/sda1'
+  end
+
+  def block_device_mapping
+    [{ "DeviceName" => root_device, "SnapshotId" => snapshot.id, "VolumeSize" => size, "DeleteOnTermination" => true }]
+  end
+
+  def image_name
+    "#{codename}-server-cloudimg-#{arch}"
+  end
+
+  def image_url
+    "http://uec-images.ubuntu.com/#{codename}/current/#{image_name}.tar.gz"
+  end
+
+  def launch_server!
+    puts "Launching server..."
+    self.server = Fog::Compute[:aws].servers.create({
+      :flavor_id => flavor,
+      :image_id => canonical_ami,
+      :groups => [group],
+      :key_name => key_name,
+      :user_data => user_data
+    })
+    server.wait_for { ready? }
+    puts "Launched #{server.id}; #{server.dns_name}; waiting for it to be available."
+  end
+
+  def launch_volume!
+    self.volume = server.volumes.create(:size => size, :device => ebs_device)
+    puts "Attaching volume #{volume.id}"
+    volume.wait_for { state == 'in-use' }
+  end
+
+  def snapshot_description
+    "#{description} root volume"
+  end
+
+  def take_snapshot!
+    puts "Waiting for volume to detach..."
+    volume.wait_for { state == 'available' }
+    puts "Taking snapshot #{snapshot_description} from #{volume.id}"
+    self.snapshot = volume.snapshots.create(:description => snapshot_description)
+    puts "Creating snapshot #{snapshot.id}"
+    snapshot.wait_for { ready? }
+  end
+
+  def user_data
+    @user_data ||= USER_DATA
+    ERB.new(@user_data).result(binding)
+  end
+
+  def cleanup!
+    puts "Deleting #{volume.id}"
+    volume.destroy
+    puts "Terminating #{server.id}"
+    server.destroy
+  end
+
+
+  def build!
+    launch_server!
+    launch_volume!
+
+    puts "waiting for user_data to complete and server to shut down..."
+    puts "Follow along by running:"
+    puts "  ssh -l #{server.username} #{server.dns_name} 'tail -f /var/log/user.log'"
+    server.wait_for { state == 'stopped' }
+
+    puts "Detaching volume"
+    volume.server = nil
+
+    take_snapshot!
+
+    # Register AMI
+    res = Fog::Compute[:aws].register_image(description, description, root_device, block_device_mapping, 'KernelId' => kernel, 'Architecture' => image_arch)
+    puts "Registered imageId #{res.body['imageId']}"
+
+    cleanup!
+
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: build-ubuntu-ami
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Aaron Suggs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fog
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+description: Create customized ubuntu AMIs the hard (secure) way.
+email: aaron@ktheory.com
+executables:
+- build-ubuntu-ami
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/build-ubuntu-ami
+- lib/build_ubuntu_ami.rb
+- data/user_data.sh.erb
+- LICENSE
+- README.md
+homepage: http://github.com/kickstarter/build-ubuntu-ami
+licenses: []
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.5
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Securely create a customized Ubuntu Amazon Machine Image.
+test_files: []