riseup_vpn 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5749722468abc5f22914e79b50843c565be88d489d8fba1ef5cb9d26f30bdb52
-  data.tar.gz: 76f3542e75019a9dea6d319664a1bb1b5fe0f8c28b2e75939cc02e44418aeadd
+  metadata.gz: b9fb7defcb7a949292d44dc949acfdc4524eb599a21ec1c90f5f1680c8b9d0ff
+  data.tar.gz: dcbb98a3d236a6bf35d3fab3f073549836e98d976a747a4dd134417f6f3ad43e
 SHA512:
-  metadata.gz: f70b3352d7e5be2ba70e765dc346b8948e1819fe5b60195963651fe9ff8627f5171eee642dfd0a28ca83cc0c620b9451f4bf72c6d020da47c8a4eabf02e1254d
-  data.tar.gz: a2adafe678f656818a760dd453b2e599d7ecfc47c086b424fc88a57fa1bcfb47443398d29cc718af2bde226688e47b3afd9f4b8eb2b6bd686a43c478b2a7ed0f
+  metadata.gz: 01bf804c22e6edde11abfd61073f3a9093d33b9463e05f5456aa66f7537e44e19ef37708979499ca8193b05045439acdba5b3a46337ef4edc219053e9603e373
+  data.tar.gz: 219ee6e1de2521e85e94a558e28dda6347b3cb74e288bb293f04a86599975f76e00f4477b1d73493562403971f2e0435ff9fb4bde77404a774a690bd489dbd7f

data/CHANGELOG.md

@@ -1,10 +1,12 @@
 ## [Unreleased]
 
-## [1.0.0] - 2025-04-21
+## [1.1.0] - 2025-04-22
 
 ### New features
 
-- upgrade TLS to 1.3, if supported by client
+- add ability to import VPN client configs into Network Manager (Linux)
+
+## [1.0.0] - 2025-04-21
 
 ### Breaking changes
 
@@ -12,6 +14,10 @@
 - `#write_files` no longer takes an dir path arg
 - All errors subclass `RiseupVPN::Error`
 
+### New features
+
+- upgrade TLS to 1.3, if supported by client
+
 ## [0.1.0] - 2025-04-19
 
 - Initial release

data/README.md

@@ -28,20 +28,20 @@ gem install riseup_vpn
 ```ruby
 require 'riseup_vpn'
 
-manager = RiseupVPN::Manager.new # takes an optional positional arg for the dir path. Default is '~/.config/riseup_vpn'
+@manager = RiseupVPN::Manager.new # takes an optional positional arg for the dir path. Default is '~/.config/riseup_vpn'
 # => instance_of RiseupVPN::Manager
 
-manager.ovpns
+@manager.ovpns
 # => {"vpn01-sea.riseup.net" => "client\ntls-client\ndev tun\nproto udp\nremote 204.13.164.252 1194 ...
 
-manager.ovpns.size
+@manager.ovpns.size
 # => 21
 
 RiseupVPN::Manager::OPTS # returns a list of valid options which maybe passed as an optional hash at initialization.
 # => {proto: ["udp", "tcp"]} defaults are the first values e.g. 'udp' for :proto
 # For example; RiseupVPN::Manager.new('/some/path', proto: 'tcp')
 
-manager.write_files # (over)writes the VPN client config files to the dir path
+@manager.write_files # (over)writes the VPN client config files to the dir path
 ```
 The last command creates (or overwrites) the following files:
 - an .ovpn file for each VPN gateway
@@ -49,9 +49,16 @@ The last command creates (or overwrites) the following files:
 - the client private key file (client.key)
 - the client cert file (client.crt)
 
-Note: The last 2 expire after 30 days and therefore need to be updated regularly
+Note: The last 2 expire after 30 days and therefore need to be updated regularly.
+
 Also note: OpenVPN requires that cert & key files shared across .ovpn client config files are present in the same directory.
 
+On Linux, you can do this to make Riseup's VPNs available in Network Manager. It uses `nmcli` under the hood:
+```Ruby
+@manager.import_ovpn_configs # writes the files and (re)imports the VPN configs into Network Manager
+# the client key and cert files are updated too
+```
+
 ## \_why?
 
 I can use Riseup's white-labeled [desktop app](https://leap.se) to access Riseup's VPNs, so why the need?

data/Rakefile

@@ -5,8 +5,6 @@ require 'minitest/test_task'
 require 'rake/testtask'
 require 'rubocop/rake_task'
 
-# Minitest::TestTask.create
-
 namespace :test do
   Rake::TestTask.new do |t|
     t.name = 'api'

data/lib/riseup_vpn/manager.rb

@@ -26,6 +26,13 @@ module RiseupVPN
       raise ArgumentError, "Dir #{@dir} doesn't exist or isn't writable"
     end
 
+    def import_ovpn_configs
+      raise NoMethodError, 'nmcli does not appear to be installed' unless Utils.nmcli?
+
+      write_files
+      Dir["#{@dir}/*.ovpn"].each { |f| Nmcli.import_openvpn f }
+    end
+
     private
 
     def write_ovpn_files

data/lib/riseup_vpn/nmcli.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative 'generator'
+
+module RiseupVPN
+  # in the absence of an nmcli gem..
+  module Nmcli
+    def self.nmcli(command_string)
+      `nmcli #{command_string}`
+    end
+
+    def self.import_openvpn(file)
+      nmcli "con import type openvpn file #{file}"
+    end
+  end
+end

data/lib/riseup_vpn/utils.rb

@@ -17,5 +17,9 @@ module RiseupVPN
     def self.tls_version
       "1.#{OpenSSL::VERSION.to_i}".to_f
     end
+
+    def self.nmcli?
+      !`which nmcli`.empty?
+    end
   end
 end

data/lib/riseup_vpn/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RiseupVPN
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/lib/riseup_vpn.rb

@@ -7,6 +7,7 @@ require_relative 'riseup_vpn/api'
 require_relative 'riseup_vpn/errors'
 require_relative 'riseup_vpn/generator'
 require_relative 'riseup_vpn/manager'
+require_relative 'riseup_vpn/nmcli'
 require_relative 'riseup_vpn/version'
 
 # namespace

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: riseup_vpn
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - MatzFan
@@ -26,6 +26,7 @@ files:
 - lib/riseup_vpn/errors.rb
 - lib/riseup_vpn/generator.rb
 - lib/riseup_vpn/manager.rb
+- lib/riseup_vpn/nmcli.rb
 - lib/riseup_vpn/template_ovpn.yml
 - lib/riseup_vpn/utils.rb
 - lib/riseup_vpn/version.rb
@@ -53,7 +54,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.0.dev
+rubygems_version: 3.6.7
 specification_version: 4
 summary: RiseupVPN configuration
 test_files: []