wg-admin 0.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,56 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'wire_guard/admin/client'
4
+
5
+ module WireGuard
6
+ module Admin
7
+ #
8
+ # A publicly reachable peer/node that serves as a fallback to relay traffic
9
+ # for other VPN peers behind NATs.
10
+ #
11
+ # @see https://github.com/pirate/wireguard-docs#bounce-server]
12
+ #
13
+ class Server < Client
14
+ attr_reader :allowed_ips
15
+ attr_accessor :port, :device
16
+
17
+ # rubocop:disable Metrics/ParameterLists
18
+ def initialize(
19
+ name:,
20
+ ip:,
21
+ private_key: nil,
22
+ public_key: nil,
23
+ port: 51_820,
24
+ allowed_ips:,
25
+ device: 'eth0'
26
+ )
27
+ super(name: name, ip: ip, private_key: private_key, public_key: public_key)
28
+
29
+ raise ArgumentError, 'port must be present' if port.nil?
30
+ raise ArgumentError, 'port number is invalid' unless (1..65_535).cover?(port.to_i)
31
+
32
+ @port = port.to_i
33
+
34
+ raise ArgumentError, 'allowed_ips must be present' if allowed_ips.nil?
35
+
36
+ self.allowed_ips = allowed_ips
37
+
38
+ raise ArgumentError, 'device must be present' if device.nil?
39
+ raise ArgumentError, 'device must not be empty' if device.empty?
40
+
41
+ @device = device
42
+ end
43
+ # rubocop:enable Metrics/ParameterLists
44
+
45
+ def allowed_ips=(aips)
46
+ raise ArgumentError, 'ip must be an IP address with prefix' unless aips.is_a?(IPAddr)
47
+
48
+ @allowed_ips = aips
49
+ end
50
+
51
+ def to_s
52
+ "#{self.class.name.split('::').last} #{name}: #{ip}:#{port} [Allowed IPs: #{allowed_ips}/#{allowed_ips.prefix} via #{device}]"
53
+ end
54
+ end
55
+ end
56
+ end
@@ -0,0 +1,46 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'erb'
4
+
5
+ module WireGuard
6
+ module Admin
7
+ module Templates
8
+ #
9
+ # Configuration template for a WireGuard::Admin::Client
10
+ #
11
+ class Client < ERB
12
+ def self.template
13
+ <<~CLIENT_TEMPLATE
14
+ # WireGuard configuration for <%= client.name %>
15
+ # generated by wg-admin
16
+
17
+ [Interface]
18
+ PrivateKey = <%= client.private_key %>
19
+ Address = <%= client.ip %>/24
20
+
21
+ <% servers.each do |server| %>
22
+ [Peer]
23
+ PublicKey = <%= server.public_key %>
24
+ EndPoint = <%= server.name %>:<%= server.port %>
25
+ AllowedIPs = <%= server.allowed_ips %>/<%= server.allowed_ips.prefix %>
26
+ PersistentKeepalive = 25
27
+ <% end %>
28
+ CLIENT_TEMPLATE
29
+ end
30
+
31
+ attr_reader :client, :servers
32
+
33
+ def initialize(client, servers)
34
+ @client = client
35
+ @servers = servers
36
+ @template = self.class.template
37
+ super(@template)
38
+ end
39
+
40
+ def render
41
+ result(binding)
42
+ end
43
+ end
44
+ end
45
+ end
46
+ end
@@ -0,0 +1,48 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'erb'
4
+
5
+ module WireGuard
6
+ module Admin
7
+ module Templates
8
+ #
9
+ # Configuration template for a WireGuard::Admin::Server
10
+ #
11
+ class Server < ERB
12
+ def self.template
13
+ <<~SERVER_TEMPLATE
14
+ # WireGuard configuration for <%= server.name %>
15
+ # generated by wg-admin
16
+
17
+ [Interface]
18
+ Address = <%= server.ip %>/24
19
+ ListenPort = <%= server.port %>
20
+ PrivateKey = <%= server.private_key %>
21
+ # 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
22
+ # 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
23
+
24
+ <% clients.each do |client| %>
25
+ [Peer]
26
+ # Name = <%= client.name %>
27
+ PublicKey = <%= client.public_key %>
28
+ AllowedIPs = <%= client.ip %>/32
29
+ <% end %>
30
+ SERVER_TEMPLATE
31
+ end
32
+
33
+ attr_reader :server, :clients
34
+
35
+ def initialize(server, clients)
36
+ @server = server
37
+ @clients = clients
38
+ @template = self.class.template
39
+ super(@template)
40
+ end
41
+
42
+ def render
43
+ result(binding)
44
+ end
45
+ end
46
+ end
47
+ end
48
+ end
@@ -0,0 +1,7 @@
1
+ # frozen_string_literal: true
2
+
3
+ module WireGuard
4
+ module Admin
5
+ VERSION = '0.0.2'
6
+ end
7
+ end
data/wg-admin.gemspec ADDED
@@ -0,0 +1,40 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative 'lib/wire_guard/admin/version'
4
+
5
+ # rubocop:disable Metrics/BlockLength
6
+ Gem::Specification.new do |spec|
7
+ spec.name = 'wg-admin'
8
+ spec.version = WireGuard::Admin::VERSION
9
+ spec.authors = ['Steffen Uhlig']
10
+ spec.email = ['steffen@familie-uhlig.net']
11
+ spec.homepage = 'https://github.com/uhlig-it/wg-admin'
12
+
13
+ spec.summary = 'WireGuard administration tool'
14
+ spec.description = %(wg-admin is an administration tool for WireGuard configuration.)
15
+ spec.license = 'MIT'
16
+
17
+ spec.files = Dir.chdir(File.expand_path(__dir__)) do
18
+ `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
19
+ end
20
+
21
+ spec.bindir = 'exe'
22
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
23
+ spec.require_paths = ['lib']
24
+
25
+ spec.add_runtime_dependency 'thor', '~> 1.0.1'
26
+
27
+ spec.add_development_dependency 'aruba', '~> 0.14.14'
28
+ spec.add_development_dependency 'bundler', '~> 2.1'
29
+ spec.add_development_dependency 'guard', '~> 2.16.1'
30
+ spec.add_development_dependency 'guard-bundler', '~> 3.0.0'
31
+ spec.add_development_dependency 'guard-rspec', '~> 4.7.3'
32
+ spec.add_development_dependency 'inifile', '~> 3.0.0'
33
+ spec.add_development_dependency 'pry', '~> 0.12.2'
34
+ spec.add_development_dependency 'pry-byebug', '~> 3.7.0'
35
+ spec.add_development_dependency 'rake', '~> 13.0.1'
36
+ spec.add_development_dependency 'rspec', '~> 3.9.0'
37
+ spec.add_development_dependency 'rubocop', '~> 0.79.0'
38
+ spec.add_development_dependency 'rubocop-rspec', '~> 1.37.1'
39
+ end
40
+ # rubocop:enable Metrics/BlockLength
metadata ADDED
@@ -0,0 +1,253 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: wg-admin
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.2
5
+ platform: ruby
6
+ authors:
7
+ - Steffen Uhlig
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2020-04-30 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: thor
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: 1.0.1
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: 1.0.1
27
+ - !ruby/object:Gem::Dependency
28
+ name: aruba
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: 0.14.14
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: 0.14.14
41
+ - !ruby/object:Gem::Dependency
42
+ name: bundler
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '2.1'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '2.1'
55
+ - !ruby/object:Gem::Dependency
56
+ name: guard
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: 2.16.1
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: 2.16.1
69
+ - !ruby/object:Gem::Dependency
70
+ name: guard-bundler
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: 3.0.0
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: 3.0.0
83
+ - !ruby/object:Gem::Dependency
84
+ name: guard-rspec
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - "~>"
88
+ - !ruby/object:Gem::Version
89
+ version: 4.7.3
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - "~>"
95
+ - !ruby/object:Gem::Version
96
+ version: 4.7.3
97
+ - !ruby/object:Gem::Dependency
98
+ name: inifile
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - "~>"
102
+ - !ruby/object:Gem::Version
103
+ version: 3.0.0
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - "~>"
109
+ - !ruby/object:Gem::Version
110
+ version: 3.0.0
111
+ - !ruby/object:Gem::Dependency
112
+ name: pry
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - "~>"
116
+ - !ruby/object:Gem::Version
117
+ version: 0.12.2
118
+ type: :development
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - "~>"
123
+ - !ruby/object:Gem::Version
124
+ version: 0.12.2
125
+ - !ruby/object:Gem::Dependency
126
+ name: pry-byebug
127
+ requirement: !ruby/object:Gem::Requirement
128
+ requirements:
129
+ - - "~>"
130
+ - !ruby/object:Gem::Version
131
+ version: 3.7.0
132
+ type: :development
133
+ prerelease: false
134
+ version_requirements: !ruby/object:Gem::Requirement
135
+ requirements:
136
+ - - "~>"
137
+ - !ruby/object:Gem::Version
138
+ version: 3.7.0
139
+ - !ruby/object:Gem::Dependency
140
+ name: rake
141
+ requirement: !ruby/object:Gem::Requirement
142
+ requirements:
143
+ - - "~>"
144
+ - !ruby/object:Gem::Version
145
+ version: 13.0.1
146
+ type: :development
147
+ prerelease: false
148
+ version_requirements: !ruby/object:Gem::Requirement
149
+ requirements:
150
+ - - "~>"
151
+ - !ruby/object:Gem::Version
152
+ version: 13.0.1
153
+ - !ruby/object:Gem::Dependency
154
+ name: rspec
155
+ requirement: !ruby/object:Gem::Requirement
156
+ requirements:
157
+ - - "~>"
158
+ - !ruby/object:Gem::Version
159
+ version: 3.9.0
160
+ type: :development
161
+ prerelease: false
162
+ version_requirements: !ruby/object:Gem::Requirement
163
+ requirements:
164
+ - - "~>"
165
+ - !ruby/object:Gem::Version
166
+ version: 3.9.0
167
+ - !ruby/object:Gem::Dependency
168
+ name: rubocop
169
+ requirement: !ruby/object:Gem::Requirement
170
+ requirements:
171
+ - - "~>"
172
+ - !ruby/object:Gem::Version
173
+ version: 0.79.0
174
+ type: :development
175
+ prerelease: false
176
+ version_requirements: !ruby/object:Gem::Requirement
177
+ requirements:
178
+ - - "~>"
179
+ - !ruby/object:Gem::Version
180
+ version: 0.79.0
181
+ - !ruby/object:Gem::Dependency
182
+ name: rubocop-rspec
183
+ requirement: !ruby/object:Gem::Requirement
184
+ requirements:
185
+ - - "~>"
186
+ - !ruby/object:Gem::Version
187
+ version: 1.37.1
188
+ type: :development
189
+ prerelease: false
190
+ version_requirements: !ruby/object:Gem::Requirement
191
+ requirements:
192
+ - - "~>"
193
+ - !ruby/object:Gem::Version
194
+ version: 1.37.1
195
+ description: wg-admin is an administration tool for WireGuard configuration.
196
+ email:
197
+ - steffen@familie-uhlig.net
198
+ executables:
199
+ - wg-admin
200
+ extensions: []
201
+ extra_rdoc_files: []
202
+ files:
203
+ - ".dependabot/config.yml"
204
+ - ".gitignore"
205
+ - ".rspec"
206
+ - ".rubocop.yml"
207
+ - ".ruby-version"
208
+ - ".travis.yml"
209
+ - Gemfile
210
+ - Gemfile.lock
211
+ - Guardfile
212
+ - LICENSE
213
+ - README.markdown
214
+ - Rakefile
215
+ - TODO.markdown
216
+ - exe/wg-admin
217
+ - lib/wire_guard/admin/cli.rb
218
+ - lib/wire_guard/admin/cli/clients.rb
219
+ - lib/wire_guard/admin/cli/helpers.rb
220
+ - lib/wire_guard/admin/cli/networks.rb
221
+ - lib/wire_guard/admin/cli/peers.rb
222
+ - lib/wire_guard/admin/cli/servers.rb
223
+ - lib/wire_guard/admin/client.rb
224
+ - lib/wire_guard/admin/repository.rb
225
+ - lib/wire_guard/admin/server.rb
226
+ - lib/wire_guard/admin/templates/client.rb
227
+ - lib/wire_guard/admin/templates/server.rb
228
+ - lib/wire_guard/admin/version.rb
229
+ - wg-admin.gemspec
230
+ homepage: https://github.com/uhlig-it/wg-admin
231
+ licenses:
232
+ - MIT
233
+ metadata: {}
234
+ post_install_message:
235
+ rdoc_options: []
236
+ require_paths:
237
+ - lib
238
+ required_ruby_version: !ruby/object:Gem::Requirement
239
+ requirements:
240
+ - - ">="
241
+ - !ruby/object:Gem::Version
242
+ version: '0'
243
+ required_rubygems_version: !ruby/object:Gem::Requirement
244
+ requirements:
245
+ - - ">="
246
+ - !ruby/object:Gem::Version
247
+ version: '0'
248
+ requirements: []
249
+ rubygems_version: 3.1.2
250
+ signing_key:
251
+ specification_version: 4
252
+ summary: WireGuard administration tool
253
+ test_files: []