openVPNServer 0.0.2

data/README

@@ -0,0 +1,68 @@
+openVPNServer Management - README File 
+---------------------------------------
+
+NOTE: Please check your openVPN server version because there are some commands that aren't implemented in the older versions.
+
+Versions:
+				0.0.1 Creation of project. Basic set of commands implemented.
+
+
+Commands List and Examples of usage
+-----------------------------------
+
+new 
+		Create a new openvpn telnet session. Need host and port of server and optionally password for login.
+
+		o = Net::OpenVPN::Manage.new("Host" => "myHost", "Port" => 1234, "Timeout" => 10, "Password" => "myPassword")
+
+close 
+		Destroy an openvpn telnet session.
+
+		o.close
+		
+status 
+		Get information about clients connected list and routing table. Return two arrays of arrays with lists inside.
+		For each client in client_list array there is: Common Name, Addredding Infos, Bytes in/out, Uptime. 
+		Insteed for each route entry there is: IP/Eth Address (depend on tun/tap mode), Addressing, Uptime.
+
+		client_list, routing_list = o.status
+		p client_list
+ 			[["Foo", "1.2.3.4:5678", "4.3.2.1", "67264", "87264", "Fri Jul  7 14:20:51 2006", "1152300051"], 
+  		["Foo2", "2.3.4.5:6789", "5.4.3.2", "12347101", "19043721", "Tue Jul  3 12:10:05 2006", "1150000050"] 
+  		... ]
+		p routing_list
+ 			[["4.3.2.1", "John Doe" ,"1.2.3.4:5678", "Fri Jul  7 14:41:35 2006", "1152301295"],
+  		["5.4.3.2", "Jane Doe" ,"2.3.4.5:6789", "Tue Jul  3 12:10:05 2006", "1150000050"]
+  ... ]
+
+load_stats 
+		Get information about number of clients connected and traffic statistic (byte in & byte out). Return an array of three element, the first is the number of client, second the number of byte in input and third the number of byte in output.
+
+		stats_info = o.load_stats
+		
+kill 
+		Kill the client instance(s) by common name of host:port combination.
+
+		o.kill("CommonName" => "myCN") OR o.kill("Host" => "myHost", "Port" => 1234)
+		
+signal 
+		Send signal s to daemon, where s can be SIGHUP, SIGTERM, SIGUSR1, SIGUSR2.
+
+		o.signal("SIGHUP")
+		
+version 
+		Returns a string showing the processes and management interface's version.
+
+pid 
+		Show process ID of the current OpenVPN process.
+
+mute 
+		Set log mute level to n, or show level if n is absent.
+
+		o.mute(n)
+		
+verb 
+		Set log verbosity level to n, or show if n is absent.
+
+		o.verb(n)
+	

data/lib/openVPNServer.rb

@@ -0,0 +1,188 @@
+#!/usr/bin/env ruby
+ 
+# Authors::     Alessandro Celestini <a.celestini@gmail.com>, Antonio Davoli <antonio.davoli@gmail.com>, Davide Guerri <d.guerri@caspur.it> 
+# Copyright::   Copyright (c) 2010 
+# License::     Ruby License
+# 
+
+# This class was written to simplify the managing of a openVPN
+# server through apposite command sent by a telnet client.
+
+require 'net/telnet'
+
+class OpenVPNServer
+                  
+    @cmd_prompt = /(SUCCESS:.*\n|ERROR:.*\n|END.*\n)/
+
+    # Create a new openvpn telnet session. Need host and port of server and optionally password for login.
+    def initialize(options)
+      pass = nil
+      
+      # Parsing Options - Set to default values if missing
+      if !options.has_key?("Host")
+        options["Host"] = "localhost"
+      end
+      
+      if !options.has_key?("Port")
+        options["Port"] = 1234
+      end
+      
+      if !options.has_key?("Timeout")
+        options["Timeout"] = 10 
+      end
+      
+      if options.has_key?("Password")
+        pass = options["Password"]
+        options.delete("Password")
+      end
+ 
+      # Add Prompt to options
+      options["Prompt"] = />INFO:OpenVPN.*\n/
+      
+      # Create Socket Telnet Connection
+      @sock = Net::Telnet::new(options)
+
+      # Password Management
+      # ----------------------
+      # This is just a little trick. 
+      # The openvpn telnet server for management requests just password without username. 
+      # The Net::Telnet client wait first for username prompt indeed, so we have to deceive it
+      # that there is a user without pass, and this is made inverting the prompt values and 
+      # sending just pass prompt and pass value :)
+      
+	    if !pass.nil?
+  	    @sock.login("LoginPrompt" => /ENTER PASSWORD:/, "Name" => pass) 
+      end
+    end
+
+    # Destroy an openVPNServer telnet session.
+    def destroy
+      @sock.close
+    end
+    
+    # Get information about clients connected list and routing table. Return two arrays of arrays with lists inside. 
+    # For each client in client_list array there is: Common Name, Addredding Infos, Bytes in/out, Uptime.
+		# Insteed for each route entry there is: IP/Eth Address (depend on tun/tap mode), Addressing, Uptime.
+    def status
+		  client_list_flag = 0, routing_list_flag = 0
+		  client_list = []
+		  routing_list = [] 
+
+      c =  @sock.cmd("String" => "status", "Match" => /(SUCCESS:.*\n|ERROR:.*\n|END.*\n)/) 
+		  c.each do |l| 
+		    
+		    # End Information Markers
+  			if (l == "ROUTING TABLE\n")
+          client_list_flag = 0
+        end
+
+        if (l == "GLOBAL STATS\n")
+          routing_list_flag = 0
+        end
+
+        # Update Clients Connected List
+			  if client_list_flag == 1
+				  client_list << l.split(',')
+				  client_list[-1][-1].chop!
+			  end
+
+        # Update Routing Info List
+			  if routing_list_flag == 1 
+				  routing_list << l.split(',')
+				  routing_list[-1][-1].chop!
+			  end
+	
+		    # Start Information Markers
+			  if (l == "Common Name,Real Address,Bytes Received,Bytes Sent,Connected Since\n")
+	    		client_list_flag = 1
+			  end
+
+			  if (l == "Virtual Address,Common Name,Real Address,Last Ref\n")
+				  routing_list_flag = 1
+			  end
+		  end
+  
+		  return client_list, routing_list
+	  end
+
+    # Get information about number of clients connected and traffic statistic (byte in & byte out). 
+    #Return an array of three element, the first is the number of client, second the number of byte in input and third the number of byte in output.
+    
+	  def load_stats
+		  stats_info = []
+		  c = @sock.cmd("String" => "load-stats", "Match" => /(SUCCESS:.*\n|ERROR:.*\n|END.*\n)/)
+		  stats_info = c.split(',')
+		  # Number of clients
+		  stats_info[0] =  stats_info[0].gsub("SUCCESS: nclients=", "").to_i
+		  # Bytes Input
+		  stats_info[1] = stats_info[1].gsub("bytesin=", "").to_i
+		  # Bytes Output
+		  stats_info[2] = stats_info[2].chop!.gsub("bytesout=", "").to_i
+		  return stats_info
+    end
+
+    # Returns a string showing the processes and management interface's version.
+    def version
+      @sock.cmd("String" => "version", "Match" => /(SUCCESS:.*\n|ERROR:.*\n|END.*\n)/)
+    end
+
+    # Show process ID of the current OpenVPN process.
+    def pid
+      @sock.cmd("String" => "pid", "Match" => /(SUCCESS:.*\n|ERROR:.*\n|END.*\n)/)
+    end
+    
+    # Send signal s to daemon, where s can be SIGHUP, SIGTERM, SIGUSR1, SIGUSR2.
+    def signal(s)
+      msg = "signal"
+      if s == "SIGHUP" || s == "SIGTERM" || s == "SIGUSR1" || s == "SIGUSR2"
+        msg.concat(" #{s}")
+        @sock.cmd("String" => msg , "Match" => /(SUCCESS:.*\n|ERROR:.*\n|END.*\n)/)
+      else
+        puts "openVPNServer Signal Error (Supported: SIGHUP, SIGTERM, SIGUSR1, SIGUSR2)"
+      end
+    end
+
+    # Set log verbosity level to n, or show if n is absent.
+    def verb(n=-1)
+	    verb = "verb"
+	    verb.concat(" #{n}") if n >= 0	 
+	    @sock.cmd("String" => verb , "Match" => /(SUCCESS:.*\n|ERROR:.*\n|END.*\n)/)
+    end
+
+    # Set log mute level to n, or show level if n is absent.
+    def mute(n=-1)
+	    mute = "mute"
+	    mute.concat(" #{n}") if n >= 0	 
+	    @sock.cmd("String" => mute , "Match" => /(SUCCESS:.*\n|ERROR:.*\n|END.*\n)/)
+    end
+
+    # Kill the client instance(s) by common name of host:port combination.
+    def kill(options)
+    
+      msg = "kill"
+      cn = nil
+      host = nil
+      port = nil
+      
+      # Searching Options
+      cn = options["CommonName"] if options.has_key?("CommonName")
+      host = options["Host"] if options.has_key?("Host")
+      port = options["Port"] if options.has_key?("Port")
+      
+      if !cn.nil?
+        msg.concat(" #{cn}")
+        @sock.cmd("String" => msg , "Match" => /(SUCCESS:.*\n|ERROR:.*\n|END.*\n)/) do |c|
+          print c
+        end
+      else
+        if !host.nil? && !port.nil? 
+          msg.concat(" #{host}:#{port}")
+          @sock.cmd("String" => msg , "Match" => /(SUCCESS:.*\n|ERROR:.*\n|END.*\n)/)
+        else  
+          puts "Net::OpenVPN Kill Error (Common Name or Host:Port Combination needed)"
+        end
+      end
+    end
+    
+end
+

data/test.rb

@@ -0,0 +1,17 @@
+
+# OpenVPNServer Test Example
+
+require 'Rubygems'
+require 'openVPNServer'
+
+# openVPNServer creation (Modify your fields)
+s = OpenVPNServer.new("Host" => "localhost", "Port" => 1234, "Timeout" => 10,  "Password" => "hi")
+# status command
+c,r = s.status
+p c
+p r
+# load_stats command
+s_info = s.load_stats
+p s_info
+s.destroy
+

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: openVPNServer
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Alessandro Celestini
+- Antonio Davoli
+- Davide Guerri
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-13 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: openVPNServer provides simple interfacing with openVPN server management console through a telnet client.
+email: 
+- a.celestini@gmail.com
+- antonio.davoli@gmail.com
+- d.guerri@caspur.it
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- lib/openVPNServer.rb
+- test.rb
+has_rdoc: true
+homepage: http://openvpnserver.rubyforge.org
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: openVPNServer
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: openVPNServer Management Ruby Class
+test_files: []
+