rgrove-larch 1.0.0.6 → 1.0.0.7

data/HISTORY

@@ -2,8 +2,10 @@ Larch History
 ================================================================================
 
 Version 1.0.1 (?)
+  * Ruby 1.9.1 support.
   * Much more robust handling of unexpected server disconnects and dropped
     connections.
+  * Option to verify server SSL certificates.
   * Fix excessive post-scan processing times for very large mailboxes.
   * Fetch message headers in blocks of up to 1024 at a time rather than all at
     once, to prevent potential problems with certain servers when a mailbox

data/bin/larch

@@ -22,18 +22,21 @@ EOS
     opt :from, "URI of the source IMAP server.", :short => '-f', :type => :string, :required => true
     opt :to,   "URI of the destination IMAP server.", :short => '-t', :type => :string, :required => true
 
-    text "\nOptions:"
-
-    # opt :dry_run,          "Don't actually do anything.", :short => '-n'
-    opt :fast_scan,        "Use a faster (but less accurate) method to scan mailboxes. This may result in messages being re-copied.", :short => :none
+    text "\nCopy Options:"
     opt :from_folder,      "Source folder to copy from", :short => :none, :default => 'INBOX'
     opt :from_pass,        "Source server password (Default: prompt)", :short => :none, :type => :string
     opt :from_user,        "Source server username (Default: prompt)", :short => :none, :type => :string
-    opt :max_retries,      "Maximum number of times to retry after a recoverable error", :short => :none, :default => 3
-    opt :no_create_folder, "Don't create destination folders that don't already exist", :short => :none
     opt :to_folder,        "Destination folder to copy to", :short => :none, :default => 'INBOX'
     opt :to_pass,          "Destination server password (Default: prompt)", :short => :none, :type => :string
     opt :to_user,          "Destination server username (Default: prompt)", :short => :none, :type => :string
+
+    text "\nGeneral Options:"
+    # opt :dry_run,          "Don't actually do anything.", :short => '-n'
+    opt :fast_scan,        "Use a faster (but less accurate) method to scan mailboxes. This may result in messages being re-copied.", :short => :none
+    opt :max_retries,      "Maximum number of times to retry after a recoverable error", :short => :none, :default => 3
+    opt :no_create_folder, "Don't create destination folders that don't already exist", :short => :none
+    opt :ssl_certs,        "Path to a trusted certificate bundle to use to verify server SSL certificates", :short => :none
+    opt :ssl_verify,       "Verify server SSL certificates", :short => :none
     opt :verbosity,        "Output verbosity: debug, info, warn, error, or fatal", :short => '-V', :default => 'info'
   end
 
@@ -78,17 +81,21 @@ EOS
 
   source = IMAP.new(options[:from], options[:from_user], options[:from_pass],
       :fast_scan   => options[:fast_scan],
-      :max_retries => options[:max_retries])
+      :max_retries => options[:max_retries],
+      :ssl_certs   => options[:ssl_certs] || nil,
+      :ssl_verify  => options[:ssl_verify])
 
   dest = IMAP.new(options[:to], options[:to_user], options[:to_pass],
       :create_mailbox => !options[:no_create_folder],
       :fast_scan      => options[:fast_scan],
-      :max_retries    => options[:max_retries])
+      :max_retries    => options[:max_retries],
+      :ssl_certs      => options[:ssl_certs] || nil,
+      :ssl_verify     => options[:ssl_verify])
 
   unless RUBY_PLATFORM =~ /mswin|mingw|bccwin|wince|java/
     begin
       for sig in [:SIGINT, :SIGQUIT, :SIGTERM]
-        trap(sig) { @log.fatal "Interrupted (#{sig})"; exit }
+        trap(sig) { @log.fatal "Interrupted (#{sig})"; Kernel.exit }
       end
     rescue => e
     end

data/lib/larch/imap.rb

@@ -47,6 +47,17 @@ class IMAP
   #   After a recoverable error occurs, retry the operation up to this many
   #   times. Default is 3.
   #
+  # [:ssl_certs]
+  #   Path to a trusted certificate bundle to use to verify server SSL
+  #   certificates. You can download a bundle of certificate authority root
+  #   certs at http://curl.haxx.se/ca/cacert.pem (it's up to you to verify that
+  #   this bundle hasn't been tampered with, however; don't trust it blindly).
+  #
+  # [:ssl_verify]
+  #   If +true+, server SSL certificates will be verified against the trusted
+  #   certificate bundle specified in +ssl_certs+. By default, server SSL
+  #   certificates are not verified.
+  #
   def initialize(uri, username, password, options = {})
     raise ArgumentError, "not an IMAP URI: #{uri}" unless uri.is_a?(URI) || uri =~ REGEX_URI
     raise ArgumentError, "must provide a username and password" unless username && password
@@ -55,7 +66,7 @@ class IMAP
     @uri       = uri.is_a?(URI) ? uri : URI(uri)
     @username  = username
     @password  = password
-    @options   = {:max_retries => 3}.merge(options)
+    @options   = {:max_retries => 3, :ssl_verify => false}.merge(options)
 
     @ids       = {}
     @imap      = nil
@@ -383,6 +394,11 @@ class IMAP
            OpenSSL::SSL::SSLError => e
 
       raise unless (retries += 1) <= @options[:max_retries]
+
+      # Special check to ensure that we don't retry on OpenSSL certificate
+      # verification errors.
+      raise if e.is_a?(OpenSSL::SSL::SSLError) && e.message =~ /certificate verify failed/
+
       info "#{e.class.name}: #{e.message} (will retry)"
 
       reset
@@ -449,7 +465,9 @@ class IMAP
 
     Thread.new do
       begin
-        @imap = Net::IMAP.new(host, port, ssl?)
+        @imap = Net::IMAP.new(host, port, ssl?,
+            ssl? && @options[:ssl_verify] ? @options[:ssl_certs] : nil,
+            @options[:ssl_verify])
 
         info "connected on port #{port}" << (ssl? ? ' using SSL' : '')
 
@@ -483,7 +501,6 @@ class IMAP
 
       rescue => e
         exception = e
-        error e.message
       end
     end.join
 

data/lib/larch/version.rb

@@ -1,6 +1,6 @@
 module Larch
   APP_NAME      = 'Larch'
-  APP_VERSION   = '1.0.0.6'
+  APP_VERSION   = '1.0.0.7'
   APP_AUTHOR    = 'Ryan Grove'
   APP_EMAIL     = 'ryan@wonko.com'
   APP_URL       = 'http://github.com/rgrove/larch/'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rgrove-larch
 version: !ruby/object:Gem::Version 
-  version: 1.0.0.6
+  version: 1.0.0.7
 platform: ruby
 authors: 
 - Ryan Grove