openvpn_configurator 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc04ba2c2c6003731f8e2448e266453c692bb27a3f1209f99a52936efdac4cd9
-  data.tar.gz: ff1237be67eed51281813f450fbeb446fdaaa39c17bba733c6468ceef7f41c3a
+  metadata.gz: e5c1f39eb5fb9575fbd0cf3f65c293b2c85ba65773c840f6cf19a0c3a54c9f79
+  data.tar.gz: 88f0572ff291a1b5ec27d8bb66654a6671b4d54b2974ffdfc9d5d8f6265bf0cf
 SHA512:
-  metadata.gz: '08c9aa447ef05a530f7252e3163ec3f865457c96209d01fbebe3d7e94b4edc8ae6259e38956f1e1cdcf4e88b5e55065a9084f0e245998b2c9c488f0e9108740a'
-  data.tar.gz: a274b18a5561fb3ce7b7c2fd2167ce05da247df1f97d4d190edf051a5a67c78350cd42cfef14e58f42719f44833a9cb922f4cd36c4124f16087fc6c810f47f08
+  metadata.gz: 14e4908a7f2b7f5d497e341fb429267cc5d33363514cf89c4ffde4411871864c37b4895006d514fb375a76f0c07352476b4d0f8284c05b92d1971c946bb72724
+  data.tar.gz: fc5de4cd52c552cdf919f0804d832004a0ff9d291efcacc1fa3a1c497e3be92388d84d5dd33dbd2f62c98648e271b7f5f4e3656767f0f32877691f532b6bf633

data/CHANGELOG.md

@@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.1.0] - 2020-10-12
+### Added
+- Support for `--client` option
+- Automatic pruning of overlapping/duplicate routes
+
 ## [1.0.0] - 2020-04-28
 
 ### Added

data/lib/openvpn_configurator/cli.rb

@@ -41,6 +41,7 @@ module OpenVPNConfigurator
 				banner self.synopsis
 				banner "Usage: #{$0} [options] <input-path> <output-path>"
 				banner 'Dynamic route collection options'
+				opt :client, "Run in client mode (directly assign routes instead of pushing them)", type: :boolean, default: false
 				opt :route_v4_aws_region, "Add IPv4 routes for an AWS region (like 'us-west-2')", type: :string, multi: true
 				opt :route_v4_dns, 'Add IPv4 routes for A record(s) returned by the specified DNS query', type: :string, multi: true
 				banner 'Actions'

data/lib/openvpn_configurator/comment.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+module OpenVPNConfigurator
+	# Represents a comment to be inserted into the configuration file
+	class Comment
+		def initialize(message)
+			@message = message
+		end
+
+
+		def to_s
+			"#{@message.gsub("\n", ' ')}"
+		end
+	end
+end
+

data/lib/openvpn_configurator/route_gatherer.rb

@@ -5,6 +5,10 @@ require 'optimist'
 require 'resolv'
 require 'rest_client'
 require 'semantic_logger'
+require 'time'
+
+require_relative 'comment'
+
 
 module OpenVPNConfigurator
 	class RouteGatherer
@@ -18,9 +22,10 @@ module OpenVPNConfigurator
 			old_output = read_file options[:output_path], nonexistent_behavior: :empty_string
 
 			routes = gather_routes options
-			rendered = render_routes routes
+			reduced = reduce_routes routes
+			rendered = render_routes reduced, client: !!options[:client]
 
-			result = format "%s\n\n\n# Added by OpenVPN Configurator v%s\n%s", template, VERSION, rendered
+			result = format "%s\n\n\n# Added by OpenVPN Configurator v%s at %s\n%s", template, VERSION, Time.now.iso8601(6), rendered
 			if result != old_output
 				logger.info "Output content changed, rewriting file #{options[:output_path].inspect}"
 				write_file options[:output_path], result
@@ -86,6 +91,51 @@ module OpenVPNConfigurator
 		end
 
 
+		# rel determines the relationship to another IPv4Net. Returns:
+		# * 1 if this IPv4Net is the supernet of other
+		# * 0 if the two are equal
+		# * -1 if this IPv4Net is a subnet of other
+		# * nil if the networks are unrelated
+
+		# @return [Hash<String, Array<NetAddr::IPv4Net, NetAddr::IPv6Net>]
+		def reduce_routes(routes)
+			seen_v4 = []
+			seen_v6 = []
+			reduction = false
+			result = {}
+			routes.each_pair do |name, entries|
+				result[name] = []
+				entries.each do |entry|
+					seen = case entry
+						when NetAddr::IPv4Net
+							seen_v4
+						when NetAddr::IPv6Net
+							seen_v6
+						else
+							nil
+					end
+					if seen
+						covered = seen.find { |s| [1, 0].include? s.rel(entry) }
+						if covered
+							reduction = true
+							result[name].push Comment.new("Route #{entry} already covered by route #{covered}")
+						else
+							seen.push entry
+							result[name].push entry
+						end
+					else
+						result[name].push entry
+					end
+				end
+			end
+			if reduction
+				reduce_routes result
+			else
+				result
+			end
+		end
+
+
 		# For tests, this method is stubbable
 		# @return [Array<NetAddr::IPv4, NetAddr::IPv6>]
 		def resolve_v4(name)
@@ -106,20 +156,27 @@ module OpenVPNConfigurator
 
 
 		# @param routes [Hash<String, Array<NetAddr::IPv4Net, NetAddr::IPv6Net>>] { "Configuration Source Name" => [NetAddr::IPv4Net, NetAddr::IPv6Net] }
-		def render_routes(routes)
+		def render_routes(routes, client: false)
+			indent = "\t\t\t"
+			directive_indent = client ? indent : ' '
+			prefix = client ? '' : "push#{indent}\""
+			postfix = client ? '' : '"'
+
 			result = []
 			routes.keys.sort.each do |source|
 				result << "##{source}"
 				routes[source].sort_by(&:to_s).each do |route|
 					directive = case route
 						when NetAddr::IPv4Net
-							format 'route %s', route.extended
+							format 'route%s%s', directive_indent, route.extended
 						when NetAddr::IPv6Net
-							format 'route-ipv6 %s', route.to_s
+							format 'route-ipv6%s%s', directive_indent, route.to_s
+						when Comment
+							format '# %s', route.to_s
 						else
 							raise "Only supporting IPv4 and IPv6 networks presently, got #{route.inspect} instead"
 					end
-					result << format("push\t\t\t\"%s\"", directive)
+					result << format("%s%s%s", prefix, directive, postfix)
 				end
 				result << ''
 			end

data/lib/openvpn_configurator/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openvpn_configurator
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Aaron Ten Clay
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-12 00:00:00.000000000 Z
+date: 2020-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gelf
@@ -214,6 +214,7 @@ files:
 - exe/openvpn_configurator
 - lib/openvpn_configurator.rb
 - lib/openvpn_configurator/cli.rb
+- lib/openvpn_configurator/comment.rb
 - lib/openvpn_configurator/route_gatherer.rb
 - lib/openvpn_configurator/version.rb
 - openvpn_configurator.gemspec
@@ -239,8 +240,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.3
 signing_key: 
 specification_version: 4
 summary: Assists in generating OpenVPN configurations.