1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
|
# Copyright 2020 VyOS maintainers and contributors <maintainers@vyos.io>
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library. If not, see <http://www.gnu.org/licenses/>.
import os
import jinja2
from vyos.ifconfig.control import Control
template_v4 = """
# generated by ifconfig.py
option rfc3442-classless-static-routes code 121 = array of unsigned integer 8;
timeout 60;
retry 300;
interface "{{ intf }}" {
send host-name "{{ hostname }}";
{% if client_id -%}
send dhcp-client-identifier "{{ client_id }}";
{% endif -%}
{% if vendor_class_id -%}
send vendor-class-identifier "{{ vendor_class_id }}";
{% endif -%}
request subnet-mask, broadcast-address, routers, domain-name-servers,
rfc3442-classless-static-routes, domain-name, interface-mtu;
require subnet-mask;
}
"""
template_v6 = """
# generated by ifconfig.py
interface "{{ intf }}" {
request routers, domain-name-servers, domain-name;
}
"""
class DHCP (Control):
client_base = r'/var/lib/dhcp/dhclient_'
def __init__ (self, ifname, **kargs):
super().__init__(**kargs)
# per interface DHCP config files
self._dhcp = {
4: {
'ifname': ifname,
'conf': self.client_base + ifname + '.conf',
'pid': self.client_base + ifname + '.pid',
'lease': self.client_base + ifname + '.leases',
'options': {
'intf': ifname,
'hostname': '',
'client_id': '',
'vendor_class_id': ''
},
},
6: {
'ifname': ifname,
'conf': self.client_base + ifname + '.v6conf',
'pid': self.client_base + ifname + '.v6pid',
'lease': self.client_base + ifname + '.v6leases',
'accept_ra': f'/proc/sys/net/ipv6/conf/{ifname}/accept_ra',
'options': {
'intf': ifname,
'dhcpv6_prm_only': False,
'dhcpv6_temporary': False
},
},
}
def get_dhcp_options(self):
"""
Return dictionary with supported DHCP options.
Dictionary should be altered and send back via set_dhcp_options()
so those options are applied when DHCP is run.
"""
return self._dhcp[4]['options']
def set_dhcp_options(self, options):
"""
Store new DHCP options used by next run of DHCP client.
"""
self._dhcp[4]['options'] = options
def get_dhcpv6_options(self):
"""
Return dictionary with supported DHCPv6 options.
Dictionary should be altered and send back via set_dhcp_options()
so those options are applied when DHCP is run.
"""
return self._dhcp[6]['options']
def set_dhcpv6_options(self, options):
"""
Store new DHCP options used by next run of DHCP client.
"""
self._dhcp[6]['options'] = options
# replace dhcpv4/v6 with systemd.networkd?
def _set_dhcp(self):
"""
Configure interface as DHCP client. The dhclient binary is automatically
started in background!
Example:
>>> from vyos.ifconfig import Interface
>>> j = Interface('eth0')
>>> j.set_dhcp()
"""
dhcp = self.get_dhcp_options()
if not dhcp['hostname']:
# read configured system hostname.
# maybe change to vyos hostd client ???
with open('/etc/hostname', 'r') as f:
dhcp['hostname'] = f.read().rstrip('\n')
# render DHCP configuration
tmpl = jinja2.Template(template_v4)
dhcp_text = tmpl.render(dhcp)
with open(self._dhcp[4]['conf'], 'w') as f:
f.write(dhcp_text)
cmd = 'start-stop-daemon'
cmd += ' --start'
cmd += ' --oknodo'
cmd += ' --quiet'
cmd += ' --pidfile {pid}'
cmd += ' --exec /sbin/dhclient'
cmd += ' --'
# now pass arguments to dhclient binary
cmd += ' -4 -nw -cf {conf} -pf {pid} -lf {lease} {ifname}'
return self._cmd(cmd.format(**self._dhcp[4]))
def _del_dhcp(self):
"""
De-configure interface as DHCP clinet. All auto generated files like
pid, config and lease will be removed.
Example:
>>> from vyos.ifconfig import Interface
>>> j = Interface('eth0')
>>> j.del_dhcp()
"""
if not os.path.isfile(self._dhcp[4]['pid']):
self._debug_msg('No DHCP client PID found')
return None
# with open(self._dhcp[4]['pid'], 'r') as f:
# pid = int(f.read())
# stop dhclient, we need to call dhclient and tell it should release the
# aquired IP address. tcpdump tells me:
# 172.16.35.103.68 > 172.16.35.254.67: [bad udp cksum 0xa0cb -> 0xb943!] BOOTP/DHCP, Request from 00:50:56:9d:11:df, length 300, xid 0x620e6946, Flags [none] (0x0000)
# Client-IP 172.16.35.103
# Client-Ethernet-Address 00:50:56:9d:11:df
# Vendor-rfc1048 Extensions
# Magic Cookie 0x63825363
# DHCP-Message Option 53, length 1: Release
# Server-ID Option 54, length 4: 172.16.35.254
# Hostname Option 12, length 10: "vyos"
#
cmd = '/sbin/dhclient -cf {conf} -pf {pid} -lf {lease} -r {ifname}'
self._cmd(cmd.format(**self._dhcp[4]))
# cleanup old config files
for name in ('conf', 'pid', 'lease'):
if os.path.isfile(self._dhcp[4][name]):
os.remove(self._dhcp[4][name])
def _set_dhcpv6(self):
"""
Configure interface as DHCPv6 client. The dhclient binary is automatically
started in background!
Example:
>>> from vyos.ifconfig import Interface
>>> j = Interface('eth0')
>>> j.set_dhcpv6()
"""
dhcpv6 = self.get_dhcpv6_options()
# better save then sorry .. should be checked in interface script
# but if you missed it we are safe!
if dhcpv6['dhcpv6_prm_only'] and dhcpv6['dhcpv6_temporary']:
raise Exception(
'DHCPv6 temporary and parameters-only options are mutually exclusive!')
# render DHCP configuration
tmpl = jinja2.Template(template_v6)
dhcpv6_text = tmpl.render(dhcpv6)
with open(self._dhcp[6]['conf'], 'w') as f:
f.write(dhcpv6_text)
# no longer accept router announcements on this interface
self._write_sysfs(self._dhcp[6]['accept_ra'], 0)
# assemble command-line to start DHCPv6 client (dhclient)
cmd = 'start-stop-daemon'
cmd += ' --start'
cmd += ' --oknodo'
cmd += ' --quiet'
cmd += ' --pidfile {pid}'
cmd += ' --exec /sbin/dhclient'
cmd += ' --'
# now pass arguments to dhclient binary
cmd += ' -6 -nw -cf {conf} -pf {pid} -lf {lease}'
# add optional arguments
if dhcpv6['dhcpv6_prm_only']:
cmd += ' -S'
if dhcpv6['dhcpv6_temporary']:
cmd += ' -T'
cmd += ' {ifname}'
return self._cmd(cmd.format(**self._dhcp[6]))
def _del_dhcpv6(self):
"""
De-configure interface as DHCPv6 clinet. All auto generated files like
pid, config and lease will be removed.
Example:
>>> from vyos.ifconfig import Interface
>>> j = Interface('eth0')
>>> j.del_dhcpv6()
"""
if not os.path.isfile(self._dhcp[6]['pid']):
self._debug_msg('No DHCPv6 client PID found')
return None
# with open(self._dhcp[6]['pid'], 'r') as f:
# pid = int(f.read())
# stop dhclient
cmd = 'start-stop-daemon'
cmd += ' --start'
cmd += ' --oknodo'
cmd += ' --quiet'
cmd += ' --pidfile {pid}'
self._cmd(cmd.format(**self._dhcp[6]))
# accept router announcements on this interface
self._write_sysfs(self._dhcp[6]['accept_ra'], 1)
# cleanup old config files
for name in ('conf', 'pid', 'lease'):
if os.path.isfile(self._dhcp[6][name]):
os.remove(self._dhcp[6][name])
|
