ruby-openvpn 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bc5a1d684ad198abca47192a0adc879d94975764343f7393286fb848ee024243
+  data.tar.gz: 64ceea86ab532364592779498701c84f40118dd49fae8cf6696576ad89a3b8ed
+SHA512:
+  metadata.gz: cf38839d156be89b67fd94f438173cc57b8a6d6a604b57aa8966f5d39545899d8a8b1fb259ffe57ddba3502a66e1f51c835817e8c477cfe574233e9b8d7b6e9c
+  data.tar.gz: 49335ef54fa9abf7adc1321f663dfb0756be85db493d3d4d716e621b365e200731370fd07975081f3e4487b0a42a92116309d4a03f6e5c1664a4278c3ee48c16

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 jjjm03299-wq
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,10 @@
+# Ruby OpenVPN Management Client
+
+`ruby-openvpn` is an event-driven Ruby library built to interact with the OpenVPN Management Interface using pure Ruby standard libraries (`net/telnet`).
+
+## Installation
+
+Install the gem directly via your terminal:
+
+```bash
+$ gem install ruby-openvpn

data/lib/openvpn.rb

@@ -0,0 +1,128 @@
+# lib/openvpn.rb
+require 'net/telnet'
+require 'socket'
+
+module OpenVPN
+  class Client
+    attr_reader :connection, :emitter
+
+    def initialize
+      @connection = nil
+      @emitter = Hash.new { |h, k| h[k] = [] }
+    end
+
+    def on(event, &block)
+      @emitter[event] << block if block_given?
+    end
+
+    def emit(event, *args)
+      @emitter[event].each { |block| block.call(*args) }
+    end
+
+    def destroy
+      if @connection
+        @connection.close rescue nil
+        @connection = nil
+      end
+    end
+
+    def connect(params = {})
+      host = params[:host] || '127.0.0.1'
+      port = params[:port] || 1337
+      timeout = params[:timeout] || 2
+
+      Thread.new do
+        begin
+          @connection = Net::Telnet.new(
+            'Host' => host,
+            'Port' => port,
+            'Timeout' => timeout,
+            'Prompt' => //
+          )
+
+          open_vpn_log
+          open_vpn_management('pid')
+          open_vpn_management('bytecount 1')
+          open_vpn_management('hold release')
+          emit(:connected)
+        rescue StandardError => e
+          emit(:error, e.message)
+        end
+      end
+
+      self
+    end
+
+    def connect_and_kill(params = {})
+      connect(params)
+      sleep(1)
+      disconnect_open_vpn
+      self
+    end
+
+    def authorize(auth)
+      open_vpn_management(%(username "Auth" "#{auth[:user]}"))
+      open_vpn_management(%(password "Auth" "#{auth[:pass]}"))
+    end
+
+    def disconnect
+      disconnect_open_vpn
+    end
+
+    def cmd(command)
+      open_vpn_management(command)
+    end
+
+    private
+
+    def disconnect_open_vpn
+      open_vpn_management('signal SIGTERM')
+    end
+
+    def open_vpn_management(command)
+      sleep(1)
+      if @connection
+        @connection.cmd('String' => command) do |c|
+          parse_response(c)
+        end
+      end
+    end
+
+    def open_vpn_log
+      @connection.cmd('String' => 'log on all')
+      @connection.cmd('String' => 'state on')
+
+      Thread.new do
+        loop do
+          break unless @connection
+          @connection.waitfor('Match' => /\n/) do |output|
+            parse_response(output) if output
+          end
+        end
+      end
+    end
+
+    def parse_response(response)
+      response.each_line do |res|
+        res = res.strip
+        next if res.empty?
+
+        if res.start_with?('STATE:')
+          emit(:state_change, res.sub('STATE:', '').strip.split(','))
+        elsif res.start_with?('HOLD:')
+          emit(:hold_waiting)
+        elsif res.start_with?('FATAL:', 'ERROR:')
+          emit(:error, res.sub(/^(FATAL|ERROR):\s*/, ''))
+        elsif res.start_with?('BYTECOUNT:')
+          emit(:bytecount, res.sub('BYTECOUNT:', '').strip.split(','))
+        elsif res.start_with?('SUCCESS:')
+          if res.include?('pid')
+            emit(:pid, res.split.last)
+          end
+        else
+          emit(:console_output, res) unless res.empty?
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: ruby-openvpn
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- jjjm03299-wq
+bindir: bin
+cert_chain: []
+date: 2026-08-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-telnet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+description: An event-driven Ruby library for managing and interacting with OpenVPN
+  instances.
+email:
+- your.email@example.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/openvpn.rb
+homepage: https://github.com/jjjm03299-wq/ruby-openvpn
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jjjm03299-wq/ruby-openvpn
+  source_code_uri: https://github.com/jjjm03299-wq/ruby-openvpn
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: A pure Ruby OpenVPN management client.
+test_files: []