net-openvpn 0.1

data/README.md

@@ -0,0 +1,48 @@
+# Net-Openvpn
+
+Net-Openvpn is a gem for configuring a local OpenVPN installation.
+
+## Usage
+
+### Server configuration
+
+Modifying the config for a server (config file will be called `auckland-office.conf`):
+
+```ruby
+server = Net::Openvpn.server("auckland-office")
+server.set :port, 1194
+server.save
+```
+
+### Host Configuration (read: client-config-directive)
+
+This is how you set the IP address of a VPN host with the hostname `optimus`:
+
+```ruby
+host = Net::Openvpn.host("optimus")
+host.ip = 10.8.0.24
+host.network = 10.8.0.0
+host.save
+```
+
+This would create a file at `/etc/openvpn/ccd/optimus` containing the following:
+
+```
+ifconfig-push 10.8.0.24 10.8.0.0
+```
+
+So that any host connecting to the VPN with a hostname of `optimus` get assigned `10.8.0.24`.
+
+## Rails Permissions
+
+If you are running rails and you want to give the rails user access, you could do it like this:
+
+```sh
+groupadd openvpn
+chown root.openvpn /etc/openvpn -R
+chmod ug+rwx /etc/openvpn -R
+chmod o-rwx /etc/openvpn -R
+cd /etc/openvpn
+chmod g-rwx easy-rsa *.key *.crt *.pem
+usermod -aG openvpn rails-app-user
+```

data/lib/net/openvpn.rb

@@ -0,0 +1,30 @@
+require 'net/openvpn/server'
+require 'net/openvpn/host'
+require 'net/openvpn/client_config'
+require 'net/openvpn/parser/server_config'
+
+module Net
+  module Openvpn
+    class << self
+
+      def basepath(path="")
+        path = "/#{path}" unless path.empty?
+        "/etc/openvpn#{path}"
+      end
+
+      def ccdpath(path="")
+        path = "/#{path}" unless path.empty?
+        basepath "ccd#{path}"
+      end
+
+      def host(hostname)
+        Net::Openvpn::Host.new(hostname)
+      end
+
+      def server(name)
+        Net::Openvpn::Server.new(name)
+      end
+
+    end
+  end
+end

data/lib/net/openvpn/client_config.rb

@@ -0,0 +1,48 @@
+module Net
+  module Openvpn
+    class ClientConfig
+
+      def initialize(hostname)
+        @hostname = hostname
+        load if exists?
+      end
+
+      def load
+        ccd = File.read(path)
+        matches = ccd.match /ifconfig-push ([0-9\.]+) ([0-9\.]+)/
+        @ip = matches[1]
+        @network = matches[2]
+      end
+
+      def path
+        Net::Openvpn.ccdpath @hostname
+      end
+
+      def exists?
+        File.exists? path
+      end
+
+      def ip=(ip)
+        @ip = ip
+      end
+
+      def network=(network)
+        @network = network
+      end
+
+      def validate!
+        raise ArgumentError, "No IP set!" if @ip.nil? or @ip.empty?
+        raise ArgumentError, "No network set!" if @network.nil? or @network.empty?
+      end
+
+      def save
+        validate!
+        
+        File.open(path, "w") do |f|
+          f.puts "ifconfig-push #{@ip} #{@network}"
+        end
+      end
+
+    end
+  end
+end

data/lib/net/openvpn/host.rb

@@ -0,0 +1,32 @@
+module Net
+  module Openvpn
+    class Host
+
+      def initialize(hostname)
+        @hostname = hostname
+        @config = Net::Openvpn::ClientConfig.new(@hostname)
+      end
+
+      def generate_key
+
+      end
+
+      def generate_ovpn
+
+      end
+
+      def ip=(ip)
+        @config.ip = ip
+      end
+
+      def network=(network)
+        @config.network = network
+      end
+
+      def save
+        @config.save
+      end
+
+    end
+  end
+end

data/lib/net/openvpn/parser/server_config.rb

@@ -0,0 +1,33 @@
+module Net
+  module Openvpn
+    module Parser
+      module ServerConfig
+        class << self
+
+          def parse(path)
+            config = {}
+
+            File.read(path).each_line do |line|
+              next if line =~ /^$/
+              parts = line.split(" ")
+              key = parts.first
+              value = parts[1..parts.size].join(" ")
+              config[key.to_sym] = value
+            end
+
+            config
+          end
+
+          def save(path, config)
+            File.open(path, "w") do |f|
+              config.each do |key, value|
+                f.puts "#{key} #{value}"
+              end
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/net/openvpn/server.rb

@@ -0,0 +1,36 @@
+module Net
+  module Openvpn
+    class Server
+
+      def initialize(name)
+        @name = name
+        load if exists?
+      end
+
+      def load
+        @config = Net::Openvpn::Parser::ServerConfig.parse(path)
+      end
+
+      def get(key)
+        @config[key]
+      end
+
+      def set(key, value)
+        @config[key] = value
+      end
+
+      def path
+        Net::Openvpn.basepath "#{@name}.conf"
+      end
+
+      def exists?
+        File.exists? path
+      end
+
+      def save
+        Net::Openvpn::Parser::ServerConfig.save(path, @config)
+      end
+
+    end
+  end
+end

data/net-openvpn.gemspec

@@ -0,0 +1,18 @@
+#coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "net-openvpn"
+  spec.version       = "0.1"
+  spec.authors       = ["Robert McLeod"]
+  spec.email         = ["robert@penguinpower.co.nz"]
+  spec.description   = %q{Net-Openvpn is an openvpn library for configuring a local OpenVPN service}
+  spec.summary       = %q{Local OpenVPN configurator}
+  spec.homepage      = "https://github.com/penguinpowernz/net-openvpn"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.require_paths = ["lib", "lib/net", "lib/net/openvpn"]
+end
+

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: net-openvpn
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Robert McLeod
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-07 00:00:00.000000000 Z
+dependencies: []
+description: Net-Openvpn is an openvpn library for configuring a local OpenVPN service
+email:
+- robert@penguinpower.co.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/net/openvpn.rb
+- lib/net/openvpn/client_config.rb
+- lib/net/openvpn/host.rb
+- lib/net/openvpn/parser/server_config.rb
+- lib/net/openvpn/server.rb
+- net-openvpn.gemspec
+homepage: https://github.com/penguinpowernz/net-openvpn
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- lib/net
+- lib/net/openvpn
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Local OpenVPN configurator
+test_files: []