wg-admin 0.0.2

data/lib/wire_guard/admin/server.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'wire_guard/admin/client'
+
+module WireGuard
+  module Admin
+    #
+    # A publicly reachable peer/node that serves as a fallback to relay traffic
+    # for other VPN peers behind NATs.
+    #
+    #  @see https://github.com/pirate/wireguard-docs#bounce-server]
+    #
+    class Server < Client
+      attr_reader :allowed_ips
+      attr_accessor :port, :device
+
+      # rubocop:disable Metrics/ParameterLists
+      def initialize(
+        name:,
+        ip:,
+        private_key: nil,
+        public_key: nil,
+        port: 51_820,
+        allowed_ips:,
+        device: 'eth0'
+      )
+        super(name: name, ip: ip, private_key: private_key, public_key: public_key)
+
+        raise ArgumentError, 'port must be present' if port.nil?
+        raise ArgumentError, 'port number is invalid' unless (1..65_535).cover?(port.to_i)
+
+        @port = port.to_i
+
+        raise ArgumentError, 'allowed_ips must be present' if allowed_ips.nil?
+
+        self.allowed_ips = allowed_ips
+
+        raise ArgumentError, 'device must be present' if device.nil?
+        raise ArgumentError, 'device must not be empty' if device.empty?
+
+        @device = device
+      end
+      # rubocop:enable Metrics/ParameterLists
+
+      def allowed_ips=(aips)
+        raise ArgumentError, 'ip must be an IP address with prefix' unless aips.is_a?(IPAddr)
+
+        @allowed_ips = aips
+      end
+
+      def to_s
+        "#{self.class.name.split('::').last} #{name}: #{ip}:#{port} [Allowed IPs: #{allowed_ips}/#{allowed_ips.prefix} via #{device}]"
+      end
+    end
+  end
+end

data/lib/wire_guard/admin/templates/client.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'erb'
+
+module WireGuard
+  module Admin
+    module Templates
+      #
+      # Configuration template for a WireGuard::Admin::Client
+      #
+      class Client < ERB
+        def self.template
+          <<~CLIENT_TEMPLATE
+            # WireGuard configuration for <%= client.name %>
+            # generated by wg-admin
+
+            [Interface]
+            PrivateKey = <%= client.private_key %>
+            Address = <%= client.ip %>/24
+
+            <% servers.each do |server| %>
+            [Peer]
+            PublicKey = <%= server.public_key %>
+            EndPoint = <%= server.name %>:<%= server.port %>
+            AllowedIPs = <%= server.allowed_ips %>/<%= server.allowed_ips.prefix %>
+            PersistentKeepalive = 25
+            <% end %>
+          CLIENT_TEMPLATE
+        end
+
+        attr_reader :client, :servers
+
+        def initialize(client, servers)
+          @client = client
+          @servers = servers
+          @template = self.class.template
+          super(@template)
+        end
+
+        def render
+          result(binding)
+        end
+      end
+    end
+  end
+end

data/lib/wire_guard/admin/templates/server.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'erb'
+
+module WireGuard
+  module Admin
+    module Templates
+      #
+      # Configuration template for a WireGuard::Admin::Server
+      #
+      class Server < ERB
+        def self.template
+          <<~SERVER_TEMPLATE
+            # WireGuard configuration for <%= server.name %>
+            # generated by wg-admin
+
+            [Interface]
+            Address = <%= server.ip %>/24
+            ListenPort = <%= server.port %>
+            PrivateKey = <%= server.private_key %>
+            # PostUp = iptables -A FORWARD -i %i -j ACCEPT; iptables -A FORWARD -o %i -j ACCEPT; iptables -t nat -A POSTROUTING -o <%= server.device %> -j MASQUERADE
+            # PostDown = iptables -D FORWARD -i %i -j ACCEPT; iptables -D FORWARD -o %i -j ACCEPT; iptables -t nat -D POSTROUTING -o <%= server.device %> -j MASQUERADE
+
+            <% clients.each do |client| %>
+            [Peer]
+            # Name = <%= client.name %>
+            PublicKey = <%= client.public_key %>
+            AllowedIPs = <%= client.ip %>/32
+            <% end %>
+          SERVER_TEMPLATE
+        end
+
+        attr_reader :server, :clients
+
+        def initialize(server, clients)
+          @server = server
+          @clients = clients
+          @template = self.class.template
+          super(@template)
+        end
+
+        def render
+          result(binding)
+        end
+      end
+    end
+  end
+end

data/lib/wire_guard/admin/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module WireGuard
+  module Admin
+    VERSION = '0.0.2'
+  end
+end

data/wg-admin.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative 'lib/wire_guard/admin/version'
+
+# rubocop:disable Metrics/BlockLength
+Gem::Specification.new do |spec|
+  spec.name          = 'wg-admin'
+  spec.version       = WireGuard::Admin::VERSION
+  spec.authors       = ['Steffen Uhlig']
+  spec.email         = ['steffen@familie-uhlig.net']
+  spec.homepage      = 'https://github.com/uhlig-it/wg-admin'
+
+  spec.summary       = 'WireGuard administration tool'
+  spec.description   = %(wg-admin is an administration tool for WireGuard configuration.)
+  spec.license       = 'MIT'
+
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'thor', '~> 1.0.1'
+
+  spec.add_development_dependency 'aruba', '~> 0.14.14'
+  spec.add_development_dependency 'bundler', '~> 2.1'
+  spec.add_development_dependency 'guard', '~> 2.16.1'
+  spec.add_development_dependency 'guard-bundler', '~> 3.0.0'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7.3'
+  spec.add_development_dependency 'inifile', '~> 3.0.0'
+  spec.add_development_dependency 'pry', '~> 0.12.2'
+  spec.add_development_dependency 'pry-byebug', '~> 3.7.0'
+  spec.add_development_dependency 'rake', '~> 13.0.1'
+  spec.add_development_dependency 'rspec', '~> 3.9.0'
+  spec.add_development_dependency 'rubocop', '~> 0.79.0'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.37.1'
+end
+# rubocop:enable Metrics/BlockLength

metadata

@@ -0,0 +1,253 @@
+--- !ruby/object:Gem::Specification
+name: wg-admin
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Steffen Uhlig
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.14
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.14
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.16.1
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.3
+- !ruby/object:Gem::Dependency
+  name: inifile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.79.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.79.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.37.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.37.1
+description: wg-admin is an administration tool for WireGuard configuration.
+email:
+- steffen@familie-uhlig.net
+executables:
+- wg-admin
+extensions: []
+extra_rdoc_files: []
+files:
+- ".dependabot/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE
+- README.markdown
+- Rakefile
+- TODO.markdown
+- exe/wg-admin
+- lib/wire_guard/admin/cli.rb
+- lib/wire_guard/admin/cli/clients.rb
+- lib/wire_guard/admin/cli/helpers.rb
+- lib/wire_guard/admin/cli/networks.rb
+- lib/wire_guard/admin/cli/peers.rb
+- lib/wire_guard/admin/cli/servers.rb
+- lib/wire_guard/admin/client.rb
+- lib/wire_guard/admin/repository.rb
+- lib/wire_guard/admin/server.rb
+- lib/wire_guard/admin/templates/client.rb
+- lib/wire_guard/admin/templates/server.rb
+- lib/wire_guard/admin/version.rb
+- wg-admin.gemspec
+homepage: https://github.com/uhlig-it/wg-admin
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: WireGuard administration tool
+test_files: []