ip-wrangler 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 50080e463e7d3a360d4376c0fecbc3b5c1793a9c
-  data.tar.gz: 382884d4b28641f19d00be8eed3180af9d8e28c1
+  metadata.gz: 810e91e9fe68e1da3839f2aac5b49cb76c239963
+  data.tar.gz: 21042e195f821f83e08dcef4194a28ade84c7a24
 SHA512:
-  metadata.gz: 8cb5a20e02220e89a5720bc6df8514d78151effda458eb33715d6079d927c6dca24e5c36ac9e3d8e7c54390f071b3ff38620535aaa3249a77ec79e1615ca0c9e
-  data.tar.gz: 8ba4ad2bd27f2a26e41556f410895da3d52053647ab9a0f8b005acf3c1e61a9a998edb7191489765cdf34ebda50d32bfd44fa5afe144da2f90e05dbe359407a4
+  metadata.gz: 17cc276c7bf20e6bb9aa6a3ff9820df4f3022b0ee5fea0b0375ad6a92b2afc2e8ea76cedaa4cd66c56a7816395a12aa91d0c2bd6335a0c22af4c13baca1460b2
+  data.tar.gz: e69b73cefb033ddef3554b6629a83522fae80228b069bbe756f00f781a2abd4c924fb802c3b2a58e3b18621fedf740a80eb0d5caba01c113cd3d3052823a2b70

data/.ruby-version

@@ -0,0 +1 @@
+2.2.1

data/DOCS.md

@@ -0,0 +1,113 @@
+# Flow - API
+
+## get `/nat/port`
+
+* `get_nat_ports` on NAT
+* `select_nat_port` on DB
+* replace `public_ip` with `ext_ip`
+
+## get `/nat/port/<private_ip>`
+
+* `get_nat_ports` on NAT by `private_ip`
+* `select_nat_port` on DB by `private_ip`
+* replace `public_ip` with `ext_ip`
+
+## get `/nat/ip`
+
+* `get_nat_ips` on NAT
+* `select_nat_ip` on DB
+
+## get `/nat/ip/<private_ip>`
+
+* `get_nat_ips` on NAT by `private_ip`
+* `select_nat_ip` on DB by `private_ip`
+
+## post `/nat/port/<private_ip>/<private_port>/<protocol>`
+
+* `lock_port` on NAT by `private_ip, private_port, protocol`
+* `select_nat_port` on DB by `private_ip, private_port, protocol`
+* check if empty
+ * `find_port` on NAT by `private_ip, private_port, protocol`
+ * `get_first_empty_nat_port` from DB for protocol `protocol`
+ * check if `not_used_port` and if `not_exists_nat_port`
+  * `insert_nat_port` to DB
+  * `append_nat_port` to IpTables
+* else return exists
+
+## post `/nat/port/<private_ip>/<private_port>`
+
+The same as for **post** `/nat/port/<private_ip>/<private_port>/<protocol>` for
+both `tcp` and `udp` protocols.
+
+## post `/nat/ip/<private_ip>`
+
+* `lock_ip` on NAT by `private_ip`
+* `select_nat_ip` on DB by `private_ip`
+* check if empty
+ * `find_ip` on NAT by `private_ip`
+ * `get_first_empty_nat_ip` on DB
+ * check if `not_used_ip` and if `not_exists_nat_ip`
+  * `insert_nat_ip` to DB
+  * `append_nat_ip` to IpTables
+* else return exists
+
+## delete `/nat/port/<private_ip>/<private_port>/<protocol>`
+
+* `release_port` on NAT by `private_ip, private_port, protocol`
+* for each `select_nat_port` on DB:
+ * `delete_nat_port` on IpTables
+* `delete_nat_port` on DB by `private_ip, private_port, protocol`
+
+## delete `/nat/port/<private_ip>/<private_port>`
+
+The same as for **delete** `/nat/port/<private_ip>/<private_port>/<protocol>` for
+both `tcp` and `udp` protocols.
+
+## delete `/nat/port/<private_ip>`
+
+The same as for **delete** `/nat/port/<private_ip>/<private_port>/<protocol>` for
+both for all mappings.
+
+## delete `/nat/ip/<private_ip>/<private_port>`
+
+* `release_ip` on NAT by `private_ip, public_ip`
+* for each `select_nat_ip` on DB:
+ * `delete_nat_ip` on IpTables
+
+## delete `/nat/ip/<private_ip>`
+
+The same as for **delete** `/nat/ip/<private_ip>/<private_port>` for all mappings.
+
+# Flow - Old API
+
+## get `/`
+
+Return `IptWr REST Endpoint!`
+
+## get `/dnat`
+
+* `get_nat_ports` on NAT
+* `select_nat_port` on DB
+* replace `public_ip` with `ext_ip`
+
+## get `/dnat/<ip>`
+
+* `get_nat_ports` on NAT by `ip`
+* `select_nat_port` on DB by `ip`
+* replace `public_ip` with `ext_ip`
+
+## post `/dnat/<ip>` with JSON body
+
+* for each port in JSON body: `lock_port`; see **post** `/nat/port/`
+
+## delete `/dnat/<ip>/<port>/<proto>`
+
+The same as **delete** `/nat/port/<private_ip>/<private_port>/<protocol>`.
+
+## delete `/dnat/<ip>/<port>`
+
+The same as **delete** `/nat/port/<private_ip>/<private_port>`.
+
+## delete `/dnat/<ip>`
+
+The same as **delete** `/nat/port/<private_ip>`.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ip-wrangler (0.1.0)
+    ip-wrangler (0.1.2)
       json (~> 1.8)
       sequel (~> 4.19)
       sinatra (~> 1.4)
@@ -11,24 +11,24 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    daemons (1.1.9)
-    eventmachine (1.0.6)
+    daemons (1.2.2)
+    eventmachine (1.0.7)
     json (1.8.2)
     rack (1.6.0)
     rack-protection (1.5.3)
       rack
     rake (10.4.2)
-    sequel (4.19.0)
-    sinatra (1.4.5)
+    sequel (4.21.0)
+    sinatra (1.4.6)
       rack (~> 1.4)
       rack-protection (~> 1.4)
-      tilt (~> 1.3, >= 1.3.4)
+      tilt (>= 1.3, < 3)
     sqlite3 (1.3.10)
     thin (1.6.3)
       daemons (~> 1.0, >= 1.0.9)
       eventmachine (~> 1.0)
       rack (~> 1.0)
-    tilt (1.4.1)
+    tilt (2.0.1)
 
 PLATFORMS
   ruby

data/README.md

@@ -45,6 +45,8 @@ Install `ruby` and `bundler` (as root, **optional**):
     popd
     popd
 
+> **Note!** You can use *rbenv* or *rvm* if you don't want to install ruby globally.
+
 Install this software:
 
     gem install ip-wrangler
@@ -88,7 +90,9 @@ To clean rules created by `ipwrangler` in `iptables`:
 
     ip-wrangler-clean <iptables_chain_name|maybe:IPT_WR>
 
-You can use *init.d* scripts to start and stop *migratio* automatic. Check [`initd.md`](support/initd.md)
+You can use *init.d* scripts to start and stop *migratio* automatic.
+Plase check [`initd.md`](support/initd.md). Be aware that service will
+run as `root`. You can change it by modifing [script](support/initd/ip-wrangler).
 
 ### Log'n'roll
 
@@ -173,6 +177,10 @@ Deleting:
 * `DELETE /dnat/<private_ip>/<private_port>` - delete NAT port for specified IP
 * `DELETE /dnat/<private_ip>` - delete any NAT port for specified IP
 
+## Flow
+
+More information in [docs](DOCS.md).
+
 ## Contributing
 
 1. Fork it!

data/lib/ip_wrangler/version.rb

@@ -1,3 +1,3 @@
 module IpWrangler
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/support/initd.md

@@ -20,3 +20,5 @@ Set values to:
 * database file: `/etc/ip-wrangler/ip-wrangler.db`
 
 Update your `initd` configuration to enable start and stop service. `ip-wrangler` will started by `root`.
+
+Remeber about *logrotate* settings. Please check section [Log'n'roll](https://github.com/dice-cyfronet/ip-wrangler#lognroll).

data/support/systemd/ip-wrangler.service

@@ -0,0 +1,18 @@
+[Unit]
+Description=IP-Wrangler Service
+
+[Service]
+Type=forking
+User=ip-wrangler
+Group=ip-wrangler
+PermissionsStartOnly=true
+Environment="GEM_PATH=/usr/share/gems"
+ExecStartPre=/usr/bin/mkdir -p /var/run/ip-wrangler
+ExecStartPre=/usr/bin/chown -R ip-wrangler:ip-wrangler /var/run/ip-wrangler
+ExecStart=/usr/bin/ip-wrangler-start -c /etc/ip-wrangler.yml -P /var/run/ip-wrangler/ip-wrangler.pid
+ExecStop=/usr/bin/ip-wrangler-stop -P /var/run/ip-wrangler/ip-wrangler.pid
+PIDFile=/var/run/ip-wrangler/ip-wrangler.pid
+
+[Install]
+WantedBy=multi-user.target
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ip-wrangler
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Paweł Suder
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-12 00:00:00.000000000 Z
+date: 2015-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -132,7 +132,9 @@ files:
 - ".gitignore"
 - ".hound.yml"
 - ".rubocop.yml"
+- ".ruby-version"
 - CHANGELOG
+- DOCS.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -161,6 +163,7 @@ files:
 - lib/ip_wrangler/version.rb
 - support/initd.md
 - support/initd/ip-wrangler
+- support/systemd/ip-wrangler.service
 homepage: https://github.com/dice-cyfronet/ip-wrangler
 licenses:
 - MIT
@@ -181,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Service is responsible for managing DNAT rules in iptables nat table