zimbra_intercepting_proxy 0.0.4.2 → 0.0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c43322897f826dfb60b13d7f600624311debaa4e
-  data.tar.gz: 52c6130238ffb9f4d7ab0be5a8381f8ac6238ed5
+  metadata.gz: 83d9620bd1aa1ec6ac96f2aa64db725be374daae
+  data.tar.gz: 7071c9856422b7ab43172b76c156a4c69ba38f9e
 SHA512:
-  metadata.gz: 92ddfc17968639cc7a521e909df6519da27792647441c987571425f22013541348cb6284a103349fb344191d73176b2b0a2687f7a843a08aa06ae711aee58bc9
-  data.tar.gz: 85976c28eed04ae7b12e105638c7d2d5e44bde9e162467cf5058d4e34800c4925c42bd755134b97565df4fa3fce2ed91a961da309b65cdd8457afaa28443fd21
+  metadata.gz: b2fce49c23f5a8a3886e390093e56ff6d3dc7e9ad169c75d2d6204975b2d3af39c83d489d8cc7db60826bb5ae6a991f546bc23cf340fa03d5b44e40d69b3c36b
+  data.tar.gz: 63722a2fecf679f020c42afd7c63ee02988993627a38c8c223921c10f7c874c6a96e2cdc46ef36d0fd3440fd5149ef9612b707abf19ad3f8c55782d5336688c2

data/README.md

@@ -1,47 +1,148 @@
-# ZimbraInterceptingProxy
+# Zimbra Intercepting Proxy
 
-This software is used to Intercept and Transform the traffic to and from the Zimbra Mailboxes when using a Zimbra Proxy.
-If you don't know what Zimbra Proxy is, You can read about it here: [https://wiki.zimbra.com/wiki/Zimbra_Proxy_Guide](https://wiki.zimbra.com/wiki/Zimbra_Proxy_Guide)
+This software is used to intercept and apply modifications to the traffic between a Zimbra Proxy and Zimbra Mailboxes.
+If you don't know what a Zimbra Proxy is, You can read about it here: [https://wiki.zimbra.com/wiki/Zimbra_Proxy_Guide](https://wiki.zimbra.com/wiki/Zimbra_Proxy_Guide)
 
-## What is good for?
+This work for all kind of client access:
+
+* POP3
+* IMAP
+* Webmail
+* ActiveSync
+* Zimbra Outlook Connector
+
+## What this try to solve?
 
 ### Zimbra Migrations
-Suppose you 
+Suppose you need to move a lot of users and data from one Zimbra Platform to another, like we do at [ZBox](http://www.zboxapp.com), and given the size of the migration, you can't move all the mailboxes at once, so you have to do it in groups.
+
+This procedure have the following inconvenients:
+
+* You have to update the configuration of the clients for all the migrated users,
+* Your users will need to learn a new Webmail URL,
+* It's not transparent for the end user,
+* It's a lot of work for you
+
+### Network and OpenSource Deployments
+Not a hot topic for Zimbra Inc., sorry guys, but lets be honest about it, some companies can't afford Zimbra Network for all the employees, so they use two setup platform.
+
+The main problem with this is that you have to configure your clients with to kind of information.
+
+### How Zimbra Intercepting Proxy Works
+Zimbra Intercepting Proxy reads a map file, a `YAML` file, in which you indicate the pair `username:zimbraID` of the users located on the _other_  Mailbox.
+
+Based on this information, `ZIP` tell the Zimbra Proxy to which Mailbox it should communicate with.
+
+## Instalation and configuration
+
+### Requirements
+This has been tested with:
+
+* Zimbra >= 7
+* Ruby >= 2.0
+* Zimbra Proxy
+
+**You need to have direct access to the `7072` port of both Mailboxes**.
+
+### Installation
+It's recommended to install it on the same Zimbra Proxy server. All you need to do is run:
+
+```bash
+$ gem install zimbra_intercepting_proxy
+```
+
+### Zimbra Proxy Modification
+
+**Important Note**
+You are going to modify Zimbra template files, used to build the configuration files of Nginx. **Take some backups!!**
+
+* All the files are located in `/opt/zimbra/conf/nginx/templates`.
+* `<`, config being replaced
+* `>`, new config
+
+You have to make this modifications
+
+```diff
+ # nginx.conf.mail.template
+19c19,20
+<     ${mail.:auth_http}
+---
+>
+>     auth_http  localhost:9072/service/extension/nginx-lookup;
+```
+
+```diff
+ # nginx.conf.web.template
+17c17
+<         #${web.upstream.:servers}
+---
+>         server localhost:9080;
+23c23
+<     #${web.:routehandlers}
+---
+>     zmroutehandlers localhost:9072/service/extension/nginx-lookup;
+```
+
+Next restart. You should restart memcached and nginx, but just to be sure:
+
+```bash
+$ zmcontrol restart
+```
+
+### Starting Zimbra Intercepting Proxy
+
+You have to start 2 instances of `ZIP`:
+
+* One on port `9080` for Web and SOAP Auth Requests, and
+* One on port `9072` for `Route-Handler`, this is how the Proxy knows to which Mailbox redirect the traffic.
 
-## TODO:
+So the first one:
 
-1. Logger
-2. Iniciar con parametros
-3. Iniciar el segundo plano
-4. Paquetizar
+```bash
+$ zimbra_intercepting_proxy -d example.com -f /root/users.yml -o oldmailbox.example.com --newmailbox=190.196.215.125 -b 9080 --newmailboxlocalip=192.168.0.
+```
 
-## Configuracion de Zimbra Proxy
+And the second one:
 
-1. Editar Templates
+```bash
+$ zimbra_intercepting_proxy -d example.com -f /root/users.yml -o oldmailbox.example.com --newmailbox=190.196.215.125 -b 9072 --newmailboxlocalip=192.168.0.
+```
 
-2. Cambiar zimbraMtaAuthHost: localhost
+#### Options
 
-## Installation
+* `-d`, the domain, in case the user only enters the username,
+* `-o`, the _default_ or old Mailbox,
+* `--newmailbox`, the _other_ or new Mailbox,
+* `-f`, the `YAML` map file, with the list of users on the `--newmailbox`,
+* `-b`, the bind port
+* `--newmailboxlocalip`, the LAN IP address of the `--newmailbox`
 
-Add this line to your application's Gemfile:
 
-    gem 'zimbra_proxy_spy'
+#### The Map File
 
-And then execute:
+It's a simple YAML file with a `email:zimbraId` pair, like
 
-    $ bundle
+```yaml
+max@example.com: "7b562c60-be97-0132-9a66-482a1423458f"
+moliery@example.com: "7b562ce0-be97-0132-9a66-482a1423458f"
+watson@example.com: "251b1902-2250-4477-bdd1-8a101f7e7e4e"
+sherlock@example.com: "7b562dd0-be97-0132-9a66-482a1423458f"
+```
 
-Or install it yourself as:
+You can get the `zimbraId` with:
 
-    $ gem install zimbra_proxy_spy
+```
+$ zmprov ga watson@example.com zimbraId
+```
 
-## Usage
+## Thanks
 
-TODO: Write usage instructions here
+* To the Zimbra folks for a great product, and
+* [@igrigorik](http://twitter.com/igrigorik) for [em-proxy](https://github.com/igrigorik/em-proxy)
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/zimbra_proxy_spy/fork )
+1. Fork it ( https://github.com/pbruna/zimbra_intercepting_proxy/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/zimbra_intercepting_proxy/server.rb

@@ -30,8 +30,14 @@ module ZimbraInterceptingProxy
             @backend[:port] = request.port
           end
           
-          conn.server @backend[:host], :host => @backend[:host], :port => @backend[:port]
-          conn.relay_to_servers connection.buffer
+          begin
+            conn.server @backend[:host], :host => @backend[:host], :port => @backend[:port]
+            conn.relay_to_servers connection.buffer
+          rescue EventMachine::ConnectionError => e
+            conn.server @backend[:host], :host => ZimbraInterceptingProxy::Config.old_backend, :port => @backend[:port]
+            conn.relay_to_servers connection.buffer
+          end
+
           
           connection.buffer.clear
           

data/lib/zimbra_intercepting_proxy/version.rb

@@ -1,3 +1,3 @@
 module ZimbraInterceptingProxy
-  VERSION = "0.0.4.2"
+  VERSION = "0.0.4.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zimbra_intercepting_proxy
 version: !ruby/object:Gem::Version
-  version: 0.0.4.2
+  version: 0.0.4.3
 platform: ruby
 authors:
 - Patricio Bruna
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-14 00:00:00.000000000 Z
+date: 2015-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-proxy