docs: remove Depfu badge

Updates the requirements on [rubocop-rspec](https://github.com/rubocop/rubocop-rspec) to permit the latest version.
- [Release notes](https://github.com/rubocop/rubocop-rspec/releases)
- [Changelog](https://github.com/rubocop/rubocop-rspec/blob/master/CHANGELOG.md)
- [Commits](https://github.com/rubocop/rubocop-rspec/compare/v2.26.1...v2.29.2)

---
updated-dependencies:
- dependency-name: rubocop-rspec
  dependency-type: direct:development
...

Signed-off-by: dependabot[bot] <support@github.com>

.github/dependabot.yml

@@ -0,0 +1,13 @@
+---
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    commit-message:
+      prefix: "gems"
+    labels: ["dependabot"]
+    open-pull-requests-limit: 10
+    pull-request-branch-name:
+      separator: "-"

.github/renovate.json5

@@ -0,0 +1,42 @@
+{
+  extends: [
+    "config:recommended",
+    ":dependencyDashboard",
+    ":prHourlyLimitNone",
+    ":prConcurrentLimitNone",
+    ":label(dependency-upgrade)",
+  ],
+  schedule: ["before 8am on thursday"],
+  branchPrefix: "renovate-",
+  dependencyDashboardHeader: "View repository job log [here](https://app.renovatebot.com/dashboard#github/cmur2/dyndnsd).",
+  separateMinorPatch: true,
+  commitMessagePrefix: "project: ",
+  commitMessageAction: "update",
+  commitMessageTopic: "{{depName}}",
+  commitMessageExtra: "to {{#if isSingleVersion}}v{{{newVersion}}}{{else}}{{{newValue}}}{{/if}}",
+  packageRules: [
+    // Ruby dependencies are managed by dependabot (previously depfu, until PR creation failed)
+    {
+      matchManagers: ["bundler"],
+      enabled: false,
+    },
+    // Commit message formats
+    {
+      matchDatasources: ["docker"],
+      commitMessagePrefix: "docker: ",
+    },
+    {
+      matchManagers: ["github-actions"],
+      commitMessagePrefix: "ci: ",
+    },
+  ],
+  customManagers: [
+    {
+      customType: "regex",
+      fileMatch: ["\.rb$", "^Rakefile$"],
+      matchStrings: [
+        "renovate: datasource=(?<datasource>.*?) depName=(?<depName>.*?)\\s.*_version = '(?<currentValue>.*)'\\s"
+      ]
+    },
+  ],
+}

.github/workflows/ci.yml

@@ -16,12 +16,12 @@ jobs:
     strategy:
       matrix:
         ruby-version:
-        - '2.5'
-        - '2.6'
-        - '2.7'
         - '3.0'
+        - '3.1'
+        - '3.2'
+        - '3.3'
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Set up Ruby ${{ matrix.ruby-version }}
       uses: ruby/setup-ruby@v1
       with:

.rubocop.yml

@@ -3,9 +3,15 @@ require:
 - rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: '2.5'
+  TargetRubyVersion: 3.0'
   NewCops: enable
 
+Gemspec/DevelopmentDependencies:
+  EnforcedStyle: gemspec
+
+Gemspec/RequireMFA:
+  Enabled: false
+
 Layout/EmptyLineAfterGuardClause:
   Enabled: false
 
@@ -95,6 +101,9 @@ RSpec/ExampleLength:
   Max: 10
 
 RSpec/FilePath:
+  Enabled: false
+
+RSpec/SpecFilePathFormat:
   CustomTransform:
     OpenVPNStatusWeb: openvpn-status-web
 

README.md

@@ -1,6 +1,6 @@
 # openvpn-status-web
 
-![ci](https://github.com/cmur2/openvpn-status-web/workflows/ci/badge.svg) [![Depfu](https://badges.depfu.com/badges/c264e2f70f2a19c43f880ddcb4a12ba8/overview.svg)](https://depfu.com/github/cmur2/openvpn-status-web?project_id=6194)
+![ci](https://github.com/cmur2/openvpn-status-web/workflows/ci/badge.svg)
 
 ## Description
 
@@ -61,7 +61,31 @@ If the information exposed is important to you serve it via the VPN or use a web
 
 There is a [Dockerfile](docs/Dockerfile) that can be used to build a Docker image for running openvpn-status-web.
 
-The [Debian 6 init script](docs/debian-init-openvpn-status-web) assumes that openvpn-status-web is installed into the system ruby (no RVM support) and the config.yaml is at `/opt/openvpn-status-web/config.yaml`. Modify to your needs.
+This can for example be used with `docker-compose` via:
+
+```yaml
+version: "2.4"
+services:
+  openvpn-status-web:
+    image: your-selfbuilt-docker-image
+    user: root  # needed since the default status files are chmod 600
+    volumes:
+    - /path/to/host/config.yml:/etc/openvpn-status-web/config.yml:ro
+    - /run/openvpn-server:/run/openvpn-server
+    ports:
+    - "8080:8080"
+```
+
+The `/path/to/host/config.yml` could be:
+
+```yaml
+host: "0.0.0.0"
+port: "8080"
+vpns:
+  my-cool-vpn:  # the following depends on your setup
+    version: 2
+    status_file: "/run/openvpn-server/status-my-cool-vpn.log"
+```
 
 ## License
 

docs/Dockerfile

@@ -1,8 +1,8 @@
-FROM alpine:3.13
+FROM alpine:3.19
 
 EXPOSE 8080
 
-ENV VERSION=3.1.0
+ENV VERSION=3.4.0
 
 RUN apk --no-cache add openssl ca-certificates && \
     apk --no-cache add ruby ruby-etc ruby-webrick && \

examples/status.v2

@@ -1,8 +1,8 @@
 TITLE,OpenVPN 2.1_rc15 mipsel-unknown-linux-gnu [SSL] [LZO1] [EPOLL] built on Mar 27 2009
 TIME,Sun Jan 1 23:42:00 2012,1238702330
 HEADER,CLIENT_LIST,Common Name,Real Address,Virtual Address,Bytes Received,Bytes Sent,Connected Since,Connected Since (time_t)
-CLIENT_LIST,foo,1.2.3.4:1234,11811160064,4194304,Sun Jan 1 23:42:00 2012,1238702330
-CLIENT_LIST,bar,1.2.3.5:1235,512,2048,Sun Jan 1 23:42:00 2012,1238702330
+CLIENT_LIST,foo,1.2.3.4:1234,192.168.66.2,11811160064,4194304,Sun Jan 1 23:42:00 2012,1238702330
+CLIENT_LIST,bar,1.2.3.5:1235,2001:db8:0:0::1000,512,2048,Sun Jan 1 23:42:00 2012,1238702330
 HEADER,ROUTING_TABLE,Virtual Address,Common Name,Real Address,Last Ref,Last Ref (time_t)
 ROUTING_TABLE,192.168.0.0/24,foo,1.2.3.4:1234,Sun Jan 1 23:42:00 2012,1238702330
 ROUTING_TABLE,192.168.66.2,bar,1.2.3.5:1235,Sun Jan 1 23:42:00 2012,1238702330

examples/status.v3

@@ -1,8 +1,8 @@
 TITLE	OpenVPN 2.1_rc15 mipsel-unknown-linux-gnu [SSL] [LZO1] [EPOLL] built on Mar 27 2009
 TIME	Sun Jan 1 23:42:00 2012	1238702330
 HEADER	CLIENT_LIST	Common Name	Real Address	Virtual Address	Bytes Received	Bytes Sent	Connected Since	Connected Since (time_t)
-CLIENT_LIST	foo	1.2.3.4:1234	11811160064	4194304	Sun Jan 1 23:42:00 2012	1238702330
-CLIENT_LIST	bar	1.2.3.5:1235	512	2048	Sun Jan 1 23:42:00 2012	1238702330
+CLIENT_LIST	foo	1.2.3.4:1234	192.168.66.2	11811160064	4194304	Sun Jan 1 23:42:00 2012	1238702330
+CLIENT_LIST	bar	1.2.3.5:1235	2001:db8:0:0::1000	512	2048	Sun Jan 1 23:42:00 2012	1238702330
 HEADER	ROUTING_TABLE	Virtual Address	Common Name	Real Address	Last Ref	Last Ref (time_t)
 ROUTING_TABLE	192.168.0.0/24	foo	1.2.3.4:1234	Sun Jan 1 23:42:00 2012	1238702330
 ROUTING_TABLE	192.168.66.2	bar	1.2.3.5:1235	Sun Jan 1 23:42:00 2012	1238702330

examples/status2_5.v2

@@ -0,0 +1,8 @@
+TITLE,OpenVPN 2.5.1 x86_64-pc-linux-gnu [SSL (OpenSSL)] [LZO] [LZ4] [EPOLL] [PKCS11] [MH/PKTINFO] [AEAD] built on May 14 2021
+TIME,2012-01-01 23:42:00,1238702330
+HEADER,CLIENT_LIST,Common Name,Real Address,Virtual Address,Virtual IPv6 Address,Bytes Received,Bytes Sent,Connected Since,Connected Since (time_t),Username,Client ID,Peer ID,Data Channel Cipher
+CLIENT_LIST,foo,1.2.3.4:1234,192.168.66.2,,11811160064,4194304,2012-01-01 23:42:00,1238702330,UNDEF,1,0,AES-256-GCM
+HEADER,ROUTING_TABLE,Virtual Address,Common Name,Real Address,Last Ref,Last Ref (time_t)
+ROUTING_TABLE,192.168.66.2,foo,1.2.3.4:1234,2012-01-01 23:42:00,1238702330
+GLOBAL_STATS,Max bcast/mcast queue length,42
+END

lib/openvpn-status-web.rb

@@ -7,9 +7,10 @@ require 'logger'
 require 'ipaddr'
 require 'yaml'
 require 'rack'
+require 'rackup'
 require 'erb'
 require 'metriks'
-require 'better_errors' if ENV['RACK_ENV'] == 'development'
+require 'better_errors' if ENV.fetch('RACK_ENV', nil) == 'development'
 
 require 'openvpn-status-web/status'
 require 'openvpn-status-web/parser/v1'
@@ -128,21 +129,21 @@ module OpenVPNStatusWeb
 
       # configure rack
       app = Daemon.new(config['vpns'])
-      if ENV['RACK_ENV'] == 'development'
+      if ENV.fetch('RACK_ENV', nil) == 'development'
         app = BetterErrors::Middleware.new(app)
         BetterErrors.application_root = File.expand_path(__dir__)
       end
 
       Signal.trap('INT') do
         OpenVPNStatusWeb.logger.info 'Quitting...'
-        Rack::Handler::WEBrick.shutdown
+        Rackup::Handler::WEBrick.shutdown
       end
       Signal.trap('TERM') do
         OpenVPNStatusWeb.logger.info 'Quitting...'
-        Rack::Handler::WEBrick.shutdown
+        Rackup::Handler::WEBrick.shutdown
       end
 
-      Rack::Handler::WEBrick.run app, Host: config['host'], Port: config['port']
+      Rackup::Handler::WEBrick.run app, Host: config['host'], Port: config['port']
     end
   end
 end

lib/openvpn-status-web/main.html.erb

@@ -50,20 +50,36 @@ thead {
   <div>
   <table>
     <thead>
-      <td class="first">Common Name</td>
-      <td class="middle">Real Address</td>
-      <td class="middle">Data Received</td>
-      <td class="middle">Data Sent</td>
-      <td class="last">Connected Since</td>
+<% status.client_list_headers.each_with_index do |header,i| %>
+<% if i == 0 %>
+      <td class="first">
+<% elsif i == status.client_list_headers.size-1 %>
+      <td class="last">
+<% else %>
+      <td class="middle">
+<% end %>
+      <%= header %></td>
+<% end %>
     </thead>
     <tbody>
 <% status.client_list.each do |client| %>
       <tr>
-        <td class="first"><%= client[0] %></td>
-        <td class="middle"><%= client[1] %></td>
-        <td class="middle"><%= client[2].to_i.as_bytes %></td>
-        <td class="middle"><%= client[3].to_i.as_bytes %></td>
-        <td class="last"><%= client[4].strftime('%-d.%-m.%Y %H:%M:%S') %></td>
+<% status.client_list_headers.each_with_index do |header,i| %>
+<% if i == 0 %>
+        <td class="first">
+<% elsif i == status.client_list_headers.size-1 %>
+        <td class="last">
+<% else %>
+        <td class="middle">
+<% end %>
+<% if header =~ /(Received|Sent)/ %>
+        <%= client[i].as_bytes %></td>
+<% elsif client[i].is_a? DateTime %>
+        <%= client[i].strftime('%-d.%-m.%Y %H:%M:%S') %></td>
+<% else %>
+        <%= client[i] %></td>
+<% end %>
+<% end %>
       </tr>
 <% end %>
     </tbody>
@@ -74,18 +90,34 @@ thead {
   <div>
   <table>
     <thead>
-      <td class="first">Virtual Address</td>
-      <td class="middle">Common Name</td>
-      <td class="middle">Real Address</td>
-      <td class="last">Last Ref</td>
+<% status.routing_table_headers.each_with_index do |header,i| %>
+<% if i == 0 %>
+      <td class="first">
+<% elsif i == status.routing_table_headers.size-1 %>
+      <td class="last">
+<% else %>
+      <td class="middle">
+<% end %>
+      <%= header %></td>
+<% end %>
     </thead>
     <tbody>
 <% status.routing_table.each do |route| %>
       <tr>
-        <td class="first"><%= route[0] %></td>
-        <td class="middle"><%= route[1] %></td>
-        <td class="middle"><%= route[2] %></td>
-        <td class="last"><%= route[3].strftime('%-d.%-m.%Y %H:%M:%S') %></td>
+<% status.routing_table_headers.each_with_index do |header,i| %>
+<% if i == 0 %>
+        <td class="first">
+<% elsif i == status.routing_table_headers.size-1 %>
+        <td class="last">
+<% else %>
+        <td class="middle">
+<% end %>
+<% if route[i].is_a? DateTime %>
+        <%= route[i].strftime('%-d.%-m.%Y %H:%M:%S') %></td>
+<% else %>
+        <%= route[i] %></td>
+<% end %>
+<% end %>
       </tr>
 <% end %>
     </tbody>

lib/openvpn-status-web/parser/modern_stateless.rb

@@ -5,29 +5,38 @@ module OpenVPNStatusWeb
     class ModernStateless
       def self.parse_status_log(text, sep)
         status = Status.new
+        status.client_list_headers = []
         status.client_list = []
+        status.routing_table_headers = []
         status.routing_table = []
         status.global_stats = []
 
         text.lines.each do |line|
           parts = line.strip.split(sep)
-          status.client_list << parse_client(parts[1..5]) if parts[0] == 'CLIENT_LIST'
-          status.routing_table << parse_route(parts[1..4]) if parts[0] == 'ROUTING_TABLE'
+          status.client_list_headers = parts[2..] if parts[0] == 'HEADER' && parts[1] == 'CLIENT_LIST'
+          status.client_list << parse_client(parts[1..], status.client_list_headers) if parts[0] == 'CLIENT_LIST'
+          status.routing_table_headers = parts[2..] if parts[0] == 'HEADER' && parts[1] == 'ROUTING_TABLE'
+          status.routing_table << parse_route(parts[1..], status.routing_table_headers) if parts[0] == 'ROUTING_TABLE'
           status.global_stats << parse_global(parts[1..2]) if parts[0] == 'GLOBAL_STATS'
         end
 
         status
       end
 
-      private_class_method def self.parse_client(client)
-        client[2] = client[2].to_i
-        client[3] = client[3].to_i
-        client[4] = DateTime.strptime(client[4], '%a %b %d %k:%M:%S %Y')
+      private_class_method def self.parse_client(client, headers)
+        headers.each_with_index do |header, i|
+          client[i] = parse_date(client[i]) if header.end_with?('Since')
+          client[i] = client[i].to_i if header.start_with?('Bytes')
+        end
+
         client
       end
 
-      private_class_method def self.parse_route(route)
-        route[3] = DateTime.strptime(route[3], '%a %b %d %k:%M:%S %Y')
+      private_class_method def self.parse_route(route, headers)
+        headers.each_with_index do |header, i|
+          route[i] = parse_date(route[i]) if header.end_with?('Last Ref')
+        end
+
         route
       end
 
@@ -35,6 +44,12 @@ module OpenVPNStatusWeb
         global[1] = global[1].to_i
         global
       end
+
+      private_class_method def self.parse_date(date_string)
+        DateTime.strptime(date_string, '%a %b %d %k:%M:%S %Y')
+      rescue ArgumentError
+        DateTime.strptime(date_string, '%Y-%m-%d %k:%M:%S')
+      end
     end
   end
 end

lib/openvpn-status-web/parser/v1.rb

@@ -26,8 +26,10 @@ module OpenVPNStatusWeb
         end
 
         status = Status.new
-        status.client_list = client_list[2..-1].map { |client| parse_client(client) }
-        status.routing_table = routing_table[1..-1].map { |route| parse_route(route) }
+        status.client_list_headers = ['Common Name', 'Real Address', 'Data Received', 'Data Sent', 'Connected Since']
+        status.client_list = client_list[2..].map { |client| parse_client(client) }
+        status.routing_table_headers = ['Virtual Address', 'Common Name', 'Real Address', 'Last Ref']
+        status.routing_table = routing_table[1..].map { |route| parse_route(route) }
         status.global_stats = global_stats.map { |global| parse_global(global) }
         status
       end

lib/openvpn-status-web/status.rb

@@ -2,7 +2,9 @@
 
 module OpenVPNStatusWeb
   class Status
+    attr_accessor :client_list_headers
     attr_accessor :client_list
+    attr_accessor :routing_table_headers
     attr_accessor :routing_table
     attr_accessor :global_stats
   end

lib/openvpn-status-web/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenVPNStatusWeb
-  VERSION = '3.1.0'
+  VERSION = '3.4.0'
 end

openvpn-status-web.gemspec

@@ -24,21 +24,22 @@ Gem::Specification.new do |s|
   s.executables = ['openvpn-status-web']
   s.extra_rdoc_files = Dir['README.md', 'LICENSE']
 
-  s.required_ruby_version = '>= 2.5'
+  s.required_ruby_version = '>= 3.0'
 
   s.add_runtime_dependency 'metriks'
-  s.add_runtime_dependency 'rack', '~> 2.0'
+  s.add_runtime_dependency 'rack', '~> 3.0'
+  s.add_runtime_dependency 'rackup', '~> 2'
   s.add_runtime_dependency 'webrick', '>= 1.6.1'
 
   s.add_development_dependency 'better_errors'
   s.add_development_dependency 'binding_of_caller'
   s.add_development_dependency 'bundler'
-  s.add_development_dependency 'bundler-audit', '~> 0.7.0'
+  s.add_development_dependency 'bundler-audit', '~> 0.9.0'
   s.add_development_dependency 'rack-test'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
-  s.add_development_dependency 'rubocop', '~> 1.8.1'
-  s.add_development_dependency 'rubocop-rake', '~> 0.5.1'
-  s.add_development_dependency 'rubocop-rspec', '~> 2.1.0'
-  s.add_development_dependency 'solargraph', ' ~> 0.40.0'
+  s.add_development_dependency 'rubocop', '~> 1.63.5'
+  s.add_development_dependency 'rubocop-rake', '~> 0.6.0'
+  s.add_development_dependency 'rubocop-rspec', '~> 2.29.2'
+  s.add_development_dependency 'solargraph', '~> 0.50.0'
 end

spec/openvpn-status-web/parser/modern_stateless_spec.rb

@@ -7,7 +7,7 @@ describe OpenVPNStatusWeb::Parser::ModernStateless do
     2 => status_v2,
     3 => status_v3
   }.each do |version, status|
-    context "for status-version #{version}" do
+    context "when status-version #{version}" do
       context 'with client list' do
         it 'parses common names' do
           expect(status.client_list.map { |client| client[0] }).to eq(%w[foo bar])
@@ -17,21 +17,30 @@ describe OpenVPNStatusWeb::Parser::ModernStateless do
           expect(status.client_list.map { |client| client[1] }).to eq(['1.2.3.4:1234', '1.2.3.5:1235'])
         end
 
+        it 'parses virtual addresses' do
+          expect(status.client_list.map { |client| client[2] }).to eq(['192.168.66.2', '2001:db8:0:0::1000'])
+        end
+
         it 'parses received bytes' do
-          expect(status.client_list.map { |client| client[2] }).to eq([11_811_160_064, 512])
+          expect(status.client_list.map { |client| client[3] }).to eq([11_811_160_064, 512])
         end
 
         it 'parses sent bytes' do
-          expect(status.client_list.map { |client| client[3] }).to eq([4_194_304, 2048])
+          expect(status.client_list.map { |client| client[4] }).to eq([4_194_304, 2048])
         end
 
         it 'parses connected since date' do
-          expect(status.client_list.map { |client| client[4] }).to eq(
+          expect(status.client_list.map { |client| client[5] }).to eq(
             [
-              DateTime.new(2012, 1, 1, 23, 42, 0), DateTime.new(2012, 1, 1, 23, 42, 0)
+              DateTime.new(2012, 1, 1, 23, 42, 0),
+              DateTime.new(2012, 1, 1, 23, 42, 0)
             ]
           )
         end
+
+        it 'has the same number of headers' do
+          expect(status.client_list[0].size).to eq(status.client_list_headers.size)
+        end
       end
 
       context 'with routing table' do
@@ -55,6 +64,10 @@ describe OpenVPNStatusWeb::Parser::ModernStateless do
             ]
           )
         end
+
+        it 'has the same number of headers' do
+          expect(status.routing_table[0].size).to eq(status.routing_table_headers.size)
+        end
       end
 
       it 'parses global stats' do
@@ -63,4 +76,8 @@ describe OpenVPNStatusWeb::Parser::ModernStateless do
       end
     end
   end
+
+  it 'parses status-version 2 of OpenVPN 2.5' do
+    expect(status_2_5_v2).not_to be_nil
+  end
 end

spec/openvpn-status-web/parser/v1_spec.rb

@@ -31,6 +31,10 @@ describe OpenVPNStatusWeb::Parser::V1 do
         ]
       )
     end
+
+    it 'has the same number of headers' do
+      expect(status.client_list[0].length).to eq(status.client_list_headers.length)
+    end
   end
 
   context 'with routing table' do
@@ -54,6 +58,10 @@ describe OpenVPNStatusWeb::Parser::V1 do
         ]
       )
     end
+
+    it 'has the same number of headers' do
+      expect(status.routing_table[0].length).to eq(status.routing_table_headers.length)
+    end
   end
 
   it 'parses global stats' do

spec/spec_helper.rb

@@ -7,16 +7,21 @@ require 'rack/test'
 require 'openvpn-status-web'
 
 def status_v1
-  text = File.open('examples/status.v1', 'rb', &:read)
+  text = File.binread('examples/status.v1')
   OpenVPNStatusWeb::Parser::V1.new.parse_status_log text
 end
 
 def status_v2
-  text = File.open('examples/status.v2', 'rb', &:read)
+  text = File.binread('examples/status.v2')
+  OpenVPNStatusWeb::Parser::V2.new.parse_status_log text
+end
+
+def status_2_5_v2
+  text = File.binread('examples/status2_5.v2')
   OpenVPNStatusWeb::Parser::V2.new.parse_status_log text
 end
 
 def status_v3
-  text = File.open('examples/status.v3', 'rb', &:read)
+  text = File.binread('examples/status.v3')
   OpenVPNStatusWeb::Parser::V3.new.parse_status_log text
 end