sheepsafe 0.1.0 → 0.2.0

data/README.md

@@ -5,7 +5,14 @@ http://github.com/nicksieger/sheepsafe
 
 ## Description
 
-Sheepsafe is a small utility to keep you safe from [FireSheep][]! 
+Sheepsafe is a small utility to keep you safe from [FireSheep][]!
+It's a tool for mobile geeks.
+
+We all know the cookie-stealing issue has been out there for a while,
+but now with [FireSheep][], it just got way too easy. If you're like
+me, I don't want to get exposed at the next gathering of techies at a
+conference or even at a local coffee shop with this thing out there.
+So I built Sheepsafe for myself.
 
 Sheepsafe was built to automate the task of switching your network
 configuration to use a SOCKS proxy whenever you join an untrusted
@@ -34,29 +41,21 @@ but this setup Works For Me.
 
 ## Install
 
-- First install the gem: `sudo gem install sheepsafe`. It's
-  recommended to install using the system Ruby to minimize
+- First install the gem:
+      sudo gem install sheepsafe
+  It's recommended to install using the system Ruby to minimize
   difficulties informing launchd about an [RVM][] or some other
   package manager.
 - After installing the gem, run `sheepsafe install` and follow the
   prompts for configuring Sheepsafe.
 
-### Setting up the "Untrusted" location
-
-One manual step that you need to do during installation is to create
-an "Untrusted" location for Sheepsafe to configure and use when you're
-on an untrusted network. Sheepsafe will prompt you to do these steps
-during installation.
-
-![Edit locations...](http://github.com/nicksieger/sheepsafe/raw/master/doc/edit-locations.jpg)
-
-![Add Untrusted and Apply...](http://github.com/nicksieger/sheepsafe/raw/master/doc/add-untrusted-apply.jpg)
-
 ## Growl
 
 If you wish to receive Growl notifications when Sheepsafe is switching
 your location, be sure to install the `growlnotify` utility from the
-"Extras" folder in the Growl .dmg.
+"Extras" folder in the Growl .dmg. Then install the `growl` gem:
+
+      sudo gem install growl
 
 ## Post-install
 
@@ -68,6 +67,12 @@ settings for making connections, where applicable.
 - Run `sheepsafe uninstall` to unregister the Launchd task and remove
   Sheepsafe vestiges from your system.
 
+## Give back
+
+I'll gladly accept [pull requests][pr] and [bug reports][issues].
+
 [FireSheep]: http://codebutler.com/firesheep
 [RVM]: http://rvm.beginrescueend.com/
 [polo]: http://www.symonds.id.au/marcopolo/
+[pr]: http://github.com/nicksieger/sheepsafe/pulls
+[issues]: http://github.com/nicksieger/sheepsafe/issues

data/bin/sheepsafe

@@ -8,9 +8,13 @@ rescue LoadError
   require 'sheepsafe'
 end
 
-if ARGV.length == 1 && ARGV.first =~ /^(un)?install$/
+if ARGV.length == 1
   installer = Sheepsafe::Installer.new
-  ARGV.first == 'install' ? installer.run : installer.uninstall
+  if installer.respond_to?(ARGV.first)
+    installer.send(ARGV.first)
+  else
+    abort "unknown command #{ARGV.first}. Try 'install', 'update', or 'uninstall'."
+  end
 else
   # Allow network changes to sink in for a couple more seconds
   sleep 2

data/lib/sheepsafe/config.rb

@@ -8,9 +8,9 @@ module Sheepsafe
     ARRAY_ATTRS = %w(trusted_names)
 
     def self.load_config
-      File.open(FILE) {|f| YAML.load(f) }
-    rescue
-      raise "Unable to read ~/sheepsafe.yml; please run sheepsafe-install"
+      YAML.load_file(FILE)
+    rescue Errno::ENOENT
+      raise "Unable to read ~/.sheepsafe.yml; please run sheepsafe-install"
     end
 
     attr_reader :config
@@ -30,7 +30,7 @@ module Sheepsafe
     end
 
     def write
-      File.open(FILE, "w") {|f| f << YAML.dump(@config) }
+      File.open(FILE, "w") {|f| f << YAML.dump(config) }
     end
   end
 end

data/lib/sheepsafe/controller.rb

@@ -1,18 +1,21 @@
 require 'daemons'
 require 'logger'
-require 'growl'
+begin
+  require 'growl'
+rescue LoadError
+end
 
 module Sheepsafe
   class Controller
     LOG_FILE = Sheepsafe::Config::FILE.sub(/\.yml/, '.log')
 
-    def initialize(config = nil, status = nil, logger = nil)
-      @config = config || Sheepsafe::Config.new
-      @status = status || Sheepsafe::Status.new(@config)
-      @logger = logger || begin
-                            STDOUT.reopen(File.open(LOG_FILE, (File::WRONLY | File::APPEND)))
-                            Logger.new(STDOUT)
-                          end
+    def initialize(config = nil, network = nil, logger = nil)
+      @config  = config  || Sheepsafe::Config.new
+      @network = network || Sheepsafe::Network.new(@config)
+      @logger  = logger  || begin
+                              STDOUT.reopen(File.open(LOG_FILE, (File::WRONLY | File::APPEND)))
+                              Logger.new(STDOUT)
+                            end
     end
 
     def run
@@ -28,7 +31,7 @@ module Sheepsafe
             bring_socks_proxy 'up'
             system "scselect #{@config.untrusted_location}"
           end
-          @config.last_network = @status.current_network
+          @config.last_network = @network
           @config.write
         end
       else
@@ -38,19 +41,19 @@ module Sheepsafe
     end
 
     def network_up?
-      @status.network_up?
+      @network.up?
     end
 
     def network_changed?
-      @status.current_network != @config.last_network
+      @network.ssid != @config.last_network.ssid || @network.bssid != @config.last_network.bssid
     end
 
     def switch_to_trusted?
-      @status.current_network.trusted?
+      @network.trusted?
     end
 
     def switch_to_untrusted?
-      !@status.current_network.trusted?
+      !@network.trusted?
     end
 
     def bring_socks_proxy(direction)
@@ -65,21 +68,17 @@ module Sheepsafe
     end
 
     def notify_ok(msg)
-      check_growl_installed
-      Growl.notify_ok(msg)
+      when_growl_available { Growl.notify_ok(msg) }
       log(msg)
     end
 
     def notify_warning(msg)
-      check_growl_installed
-      Growl.notify_warning(msg)
+      when_growl_available { Growl.notify_warning(msg) }
       log(msg)
     end
 
-    def check_growl_installed
-      unless Growl.installed?
-        log("WARNING: Growl not installed (probably couldn't find growlnotify in PATH: #{ENV['PATH']})")
-      end
+    def when_growl_available(&block)
+      block.call if defined?(Growl)
     end
 
     def log(msg)

data/lib/sheepsafe/installer.rb

@@ -2,21 +2,20 @@ module Sheepsafe
   class Installer
     PLIST_FILE = File.expand_path("~/Library/LaunchAgents/sheepsafe.plist")
 
-    attr_reader :config, :status, :controller
+    attr_reader :config, :network, :controller
 
-    def initialize
+    def initialize(config = nil, network = nil, controller = nil)
       require 'highline/import'
-      @config = File.readable?(Sheepsafe::Config::FILE) ? Sheepsafe::Config.new : Sheepsafe::Config.new({})
-      @status = Sheepsafe::Status.new(@config)
-      @controller = Sheepsafe::Controller.new @config, @status, Logger.new(Sheepsafe::Controller::LOG_FILE)
-      update_config_with_status
+      @config  = config  || (File.readable?(Sheepsafe::Config::FILE) ? Sheepsafe::Config.new : Sheepsafe::Config.new({}))
+      @network = network || Sheepsafe::Network.new(@config)
+      @controller = controller || Sheepsafe::Controller.new(@config, @network, Logger.new(Sheepsafe::Controller::LOG_FILE))
+      update_config_with_network
     end
 
-    def run
+    def install
       intro_message
       config_prompts
-      manual_network_location_prompt
-      setup_untrusted_location
+      setup_network_location
       write_config
       write_launchd_plist
       register_launchd_task
@@ -53,20 +52,19 @@ MSG
         q.default = config.trusted_location
       end
 
-      config.trusted_names = ask "Next, one or more network names (blank line to stop, RET for #{@names.inspect}) >\n" do |q|
-        q.gather = ""
-      end
-      config.trusted_names = @names if config.trusted_names.empty?
+      config.trusted_names = ask "Next, one or more trusted network names/SSIDs (comma-separated) >\n" do |q|
+        q.default = @names.join(',')
+      end.split(",").map(&:strip)
     end
 
-    def manual_network_location_prompt
-      say "Next, I need you to create and switch to the \"Untrusted\" location in Network preferences."
-      system "open /System/Library/PreferencePanes/Network.prefPane"
-      ask "Press ENTER when done."
-    end
+    def setup_network_location
+      if `networksetup -listlocations` !~ /Untrusted/m &&
+          agree("Next, I'll create and switch to the \"Untrusted\" location in Network Preferences. OK\? (yes/no)\n")
+        system "networksetup -createlocation Untrusted populate"
+      end
 
-    def setup_untrusted_location
       if agree "Next, I'll set up the SOCKS proxy in the \"Untrusted\" location for you. OK\? (yes/no)\n"
+        system "networksetup -switchtolocation Untrusted"
         system "networksetup -setsocksfirewallproxy AirPort localhost #{config.socks_port}"
       end
     end
@@ -134,12 +132,18 @@ PLIST
       say "Uninstall finished."
     end
 
+    def update
+      system "launchctl unload #{PLIST_FILE}"
+      write_launchd_plist
+      register_launchd_task
+    end
+
     private
-    def update_config_with_status
+    def update_config_with_network
       unless config.trusted_location
-        config.trusted_location = status.current_location
+        config.trusted_location = network.current_location
       end
-      @names = [status.current_network.current_ssid, status.current_network.current_bssid]
+      @names = [network.ssid, network.bssid]
     end
 
     def sheepsafe_bin_path

data/lib/sheepsafe/network.rb

@@ -1,24 +1,26 @@
 module Sheepsafe
   class Network
+    attr_reader :current_location
+
     def initialize(config = nil)
+      @current_location = `networksetup -getcurrentlocation`.chomp
       @data = YAML.load(`/System/Library/PrivateFrameworks/Apple80211.framework/Versions/A/Resources/airport -I`.gsub(/^\s*([^:]+)/, '"\1"'))
       @config = config || Sheepsafe::Config.new({})
     end
 
     def trusted?
-      @config.trusted_names.include?(current_ssid) ||
-        @config.trusted_names.include?(current_bssid)
+      @config.trusted_names.include?(ssid) || @config.trusted_names.include?(bssid)
     end
 
     def up?
       @data['AirPort'] != false
     end
 
-    def current_ssid
+    def ssid
       @data['SSID']
     end
 
-    def current_bssid
+    def bssid
       @data['BSSID']
     end
   end

data/lib/sheepsafe.rb

@@ -1,9 +1,8 @@
 module Sheepsafe
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end
 
 require 'sheepsafe/config'
 require 'sheepsafe/controller'
 require 'sheepsafe/installer'
 require 'sheepsafe/network'
-require 'sheepsafe/status'

data/sheepsafe.gemspec

@@ -2,8 +2,8 @@
 
 Gem::Specification.new do |s|
   s.name              = 'sheepsafe'
-  s.version           = '0.1.0'
-  s.date              = '2010-10-26'
+  s.version           = '0.2.0'
+  s.date              = '2010-10-27'
 
   s.rubyforge_project = %q{caldersphere}
 
@@ -28,6 +28,9 @@ Welcome to Sheepsafe!
 If this is your first time using Sheepsafe, you probably want to set it up.
 
 To do that, run \`sheepsafe install\' now.
+
+If you\'re updating to a new version of Sheepsafe and want to keep your
+current configuration, run \`sheepsafe update\'.
 ===========================================================================
   ]
 
@@ -38,14 +41,11 @@ To do that, run \`sheepsafe install\' now.
     README.md
     Rakefile
     bin/sheepsafe
-    doc/add-untrusted-apply.jpg
-    doc/edit-locations.jpg
     lib/sheepsafe.rb
     lib/sheepsafe/config.rb
     lib/sheepsafe/controller.rb
     lib/sheepsafe/installer.rb
     lib/sheepsafe/network.rb
-    lib/sheepsafe/status.rb
     sheepsafe.gemspec
     spec/sheepsafe_spec.rb
   ]
@@ -53,7 +53,6 @@ To do that, run \`sheepsafe install\' now.
 
   s.test_files = s.files.select { |path| path =~ /^spec\/.*spec.*\.rb/ }
 
-  s.add_dependency(%q<growl>, ["~> 1.0"])
   s.add_dependency(%q<highline>, ["~> 1.6"])
   s.add_dependency(%q<daemons>, ["~> 1.1"])
   s.add_development_dependency(%q<rspec>, ["~> 2.0"])

data/spec/sheepsafe_spec.rb

@@ -3,48 +3,46 @@ require 'sheepsafe'
 
 describe Sheepsafe::Controller do
   let(:config) do
-    mock("config", :trusted_location => "trusted_location", :untrusted_location => "untrusted_location",
+    double("config", :trusted_location => "trusted_location", :untrusted_location => "untrusted_location",
          :last_network= => nil, :write => nil)
   end
 
-  let (:status) do
-    mock("status", :current_network => "current_network", :network_up? => true)
+  let (:network) do
+    double("network", :up? => true, :ssid => "current", :bssid => "current_bssid")
   end
 
   let(:controller) do
     # Stub out logging
-    Sheepsafe::Controller.new(config, status, mock("logger", :info => nil)).tap do |c|
-      c.stub!(:notify_ok)
-      c.stub!(:notify_warning)
+    Sheepsafe::Controller.new(config, network, double("logger", :info => nil)).tap do |c|
+      c.stub(:notify_ok)
+      c.stub(:notify_warning)
     end
   end
 
   context "#network_changed?" do
     it "is when the current_network is different than the last_network" do
-      config.should_receive(:last_network).and_return "last_network"
-      status.should_receive(:current_network).and_return "current_network"
+      config.should_receive(:last_network).and_return double("network", :ssid => "last", :bssid => nil)
       controller.network_changed?.should be_true
     end
   end
 
   context "#switch_to_trusted?" do
     it "is when the current network is trusted" do
-      status.stub_chain(:current_network, :trusted?).and_return true
+      network.stub :trusted? => true
       controller.switch_to_trusted?.should be_true
     end
   end
 
   context "#switch_to_untrusted?" do
     it "is when the current network is trusted" do
-      status.stub_chain(:current_network, :trusted?).and_return false
+      network.stub :trusted? => false
       controller.switch_to_untrusted?.should be_true
     end
   end
 
   context "network didn't change" do
     before :each do
-      config.should_receive(:last_network).and_return "last_network"
-      status.should_receive(:current_network).and_return "last_network"
+      config.stub :last_network => network
     end
 
     it "does nothing" do
@@ -55,7 +53,7 @@ describe Sheepsafe::Controller do
 
   context "network is down" do
     it "does nothing" do
-      status.should_receive(:network_up?).and_return false
+      network.should_receive(:up?).and_return false
       config.should_not_receive(:write)
       controller.run
     end
@@ -63,14 +61,12 @@ describe Sheepsafe::Controller do
 
   context "network changed" do
     before :each do
-      controller.stub!(:network_changed?).and_return true
-      controller.stub!(:switch_to_trusted?).and_return false
-      controller.stub!(:switch_to_untrusted?).and_return false
+      controller.stub(:network_changed? => true, :switch_to_trusted? => false,
+                      :switch_to_untrusted? => false)
     end
 
     it "writes the last network to the configuration" do
-      status.should_receive(:current_network).and_return "current_network"
-      config.should_receive(:last_network=).with("current_network").ordered
+      config.should_receive(:last_network=).ordered
       config.should_receive(:write).ordered
       controller.run
     end
@@ -95,25 +91,18 @@ describe Sheepsafe::Controller do
   end
 end
 
-describe Sheepsafe::Status do
-  let(:status) { Sheepsafe::Status.new }
-
-  its(:current_location) { should_not be_nil }
-  its(:current_network) { should_not be_nil }
-end
-
 describe Sheepsafe::Network do
   let(:current_network) { Sheepsafe::Network.new }
 
   context "with trusted SSID" do
-    let(:config) { Sheepsafe::Config.new({"trusted_names" => [current_network.current_ssid]}) }
+    let(:config) { Sheepsafe::Config.new({"trusted_names" => [current_network.ssid]}) }
     subject { Sheepsafe::Network.new(config) }
 
     it { should be_trusted }
   end
 
   context "with trusted BSSID" do
-    let(:config) { Sheepsafe::Config.new({"trusted_names" => [current_network.current_bssid]}) }
+    let(:config) { Sheepsafe::Config.new({"trusted_names" => [current_network.bssid]}) }
     subject { Sheepsafe::Network.new(config) }
 
     it { should be_trusted }
@@ -125,3 +114,43 @@ describe Sheepsafe::Network do
     it { should_not be_trusted }
   end
 end
+
+describe Sheepsafe::Installer do
+  let(:config) { double("config").as_null_object }
+  let(:network) { double("network", :up? => true, :ssid => "current", :bssid => "current_bssid") }
+  let(:controller) { double "controller" }
+  let (:installer) do
+    @messages = []
+    @commands = []
+    Sheepsafe::Installer.new(config, network, controller).tap do |ins|
+      ins.stub(:say).and_return do |msg|
+        @messages << msg
+      end
+      ins.stub(:ask).and_return do |msg,*rest|
+        @messages << msg
+        ""
+      end
+      ins.stub(:agree).and_return do |msg|
+        @messages << msg
+        true
+      end
+      ins.stub(:system).and_return do |cmd|
+        @commands << cmd
+        nil
+      end
+    end
+  end
+
+  before :each do
+    $?.stub :success? => true
+  end
+
+  it "asks questions, runs commands, writes the config to disk and runs the controller" do
+    config.should_receive(:write)
+    controller.should_receive(:run)
+    installer.should_receive(:write_launchd_plist) # don't want to actually touch plist file
+    installer.install
+    @messages.should_not be_empty
+    @commands.should_not be_empty
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sheepsafe
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Nick Sieger
@@ -15,28 +15,13 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-26 00:00:00 -05:00
+date: 2010-10-27 00:00:00 -05:00
 default_executable: sheepsafe
 dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: growl
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 1
-        - 0
-        version: "1.0"
-  type: :runtime
-  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: highline
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -47,11 +32,11 @@ dependencies:
         - 6
         version: "1.6"
   type: :runtime
-  version_requirements: *id002
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: daemons
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -62,11 +47,11 @@ dependencies:
         - 1
         version: "1.1"
   type: :runtime
-  version_requirements: *id003
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -77,7 +62,7 @@ dependencies:
         - 0
         version: "2.0"
   type: :development
-  version_requirements: *id004
+  version_requirements: *id003
 description: Automatically toggle network locations and start a SOCKS proxy on untrusted networks. Mac OS X only.
 email: nick@nicksieger.com
 executables: 
@@ -93,14 +78,11 @@ files:
 - README.md
 - Rakefile
 - bin/sheepsafe
-- doc/add-untrusted-apply.jpg
-- doc/edit-locations.jpg
 - lib/sheepsafe.rb
 - lib/sheepsafe/config.rb
 - lib/sheepsafe/controller.rb
 - lib/sheepsafe/installer.rb
 - lib/sheepsafe/network.rb
-- lib/sheepsafe/status.rb
 - sheepsafe.gemspec
 - spec/sheepsafe_spec.rb
 has_rdoc: true
@@ -112,7 +94,9 @@ post_install_message: "\n\
   Welcome to Sheepsafe!\n\n\
   =8P <=== (That's a sheep emoji.)\n\n\
   If this is your first time using Sheepsafe, you probably want to set it up.\n\n\
-  To do that, run `sheepsafe install' now.\n\
+  To do that, run `sheepsafe install' now.\n\n\
+  If you're updating to a new version of Sheepsafe and want to keep your\n\
+  current configuration, run `sheepsafe update'.\n\
   ===========================================================================\n  "
 rdoc_options: 
 - --charset=UTF-8

data/lib/sheepsafe/status.rb

@@ -1,14 +0,0 @@
-module Sheepsafe
-  class Status
-    attr_reader :current_location, :current_network
-
-    def initialize(config = nil)
-      @current_location = `networksetup -getcurrentlocation`.chomp
-      @current_network = Network.new config
-    end
-
-    def network_up?
-      @current_network.up?
-    end
-  end
-end