/usr/lib/python3/dist-packages/provisioningserver/pserv_services/tftp.py is in python3-maas-provisioningserver 2.0.0~beta3+bzr4941-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 | # Copyright 2012-2016 Canonical Ltd. This software is licensed under the
# GNU Affero General Public License version 3 (see the file LICENSE).
"""Twisted Application Plugin for the MAAS TFTP server."""
__all__ = [
"TFTPBackend",
"TFTPService",
]
from functools import partial
from socket import (
AF_INET,
AF_INET6,
)
from netaddr import IPAddress
from provisioningserver.boot import (
BootMethodRegistry,
get_remote_mac,
)
from provisioningserver.drivers import ArchitectureRegistry
from provisioningserver.events import (
EVENT_TYPES,
send_event_node_mac_address,
)
from provisioningserver.kernel_opts import KernelParameters
from provisioningserver.rpc.boot_images import list_boot_images
from provisioningserver.rpc.exceptions import BootConfigNoResponse
from provisioningserver.rpc.region import (
GetBootConfig,
MarkNodeFailed,
)
from provisioningserver.utils import (
tftp,
typed,
)
from provisioningserver.utils.network import get_all_interface_addresses
from provisioningserver.utils.tftp import TFTPPath
from provisioningserver.utils.twisted import (
deferred,
RPCFetcher,
)
from tftp.backend import FilesystemSynchronousBackend
from tftp.errors import (
BackendError,
FileNotFound,
)
from tftp.protocol import TFTP
from twisted.application import internet
from twisted.application.service import MultiService
from twisted.internet import (
reactor,
udp,
)
from twisted.internet.abstract import isIPv6Address
from twisted.internet.address import (
IPv4Address,
IPv6Address,
)
from twisted.internet.defer import (
inlineCallbacks,
maybeDeferred,
returnValue,
)
from twisted.internet.task import deferLater
from twisted.python import log
from twisted.python.filepath import FilePath
def get_boot_image(params):
"""Get the boot image for the params on this rack controller."""
# Match on purpose; enlist uses the commissioning purpose.
purpose = params["purpose"]
if purpose == "enlist":
purpose = "commissioning"
# Get the matching boot images, minus subarchitecture.
boot_images = list_boot_images()
boot_images = [
image
for image in boot_images
if (image['osystem'] == params['osystem'] and
image['release'] == params['release'] and
image['architecture'] == params['arch'] and
image['purpose'] == purpose)
]
# See if exact subarchitecture match.
for image in boot_images:
if image["subarchitecture"] == params["subarch"]:
return image
# Not exact match check if subarchitecture is in the supported
# subarchitectures list.
for image in boot_images:
subarches = image.get("supported_subarches", "")
subarches = subarches.split(",")
if params["subarch"] in subarches:
return image
# No matching boot image was found.
return None
def log_request(mac_address, file_name, clock=reactor):
"""Log a TFTP request.
This will be logged at a later iteration of the `clock` so as to not delay
the task currently in progress.
"""
# If the file name is a byte string, decode it as ASCII, replacing
# non-ASCII characters, so that we have at least something to log.
if isinstance(file_name, bytes):
file_name = file_name.decode("ascii", "replace")
d = deferLater(
clock, 0, send_event_node_mac_address,
event_type=EVENT_TYPES.NODE_TFTP_REQUEST,
mac_address=mac_address, description=file_name)
d.addErrback(log.err, "Logging TFTP request failed.")
class TFTPBackend(FilesystemSynchronousBackend):
"""A partially dynamic read-only TFTP server.
Static files such as kernels and initrds, as well as any non-MAAS files
that the system may already be set up to serve, are served up normally.
But PXE configurations are generated on the fly.
When a PXE configuration file is requested, the server asynchronously
requests the appropriate parameters from the API (at a configurable
"generator URL") and generates a config file based on those.
The regular expressions `re_config_file` and `re_mac_address` specify
which files the server generates on the fly. Any other requests are
passed on to the filesystem.
Passing requests on to the API must be done very selectively, because
failures cause the boot process to halt. This is why the expression for
matching the MAC address is so narrowly defined: PXELINUX attempts to
fetch files at many similar paths which must not be passed on.
"""
def __init__(self, base_path, client_service):
"""
:param base_path: The root directory for this TFTP server.
:param client_service: The RPC client service for the rack controller.
"""
if not isinstance(base_path, FilePath):
base_path = FilePath(base_path)
super(TFTPBackend, self).__init__(
base_path, can_read=True, can_write=False)
self.client_service = client_service
self.fetcher = RPCFetcher()
@inlineCallbacks
@typed
def get_boot_method(self, file_name: TFTPPath):
"""Finds the correct boot method."""
for _, method in BootMethodRegistry:
params = yield maybeDeferred(method.match_path, self, file_name)
if params is not None:
params["bios_boot_method"] = method.bios_boot_method
returnValue((method, params))
returnValue((None, None))
def get_boot_image(self, params, client):
"""Get the boot image for the params on this rack controller.
Calls `MarkNodeFailed` for the machine if its a known machine.
"""
system_id = params.pop("system_id", None)
if params["purpose"] == "local":
# Local purpose doesn't use a boot image so jsut set the label
# to "local", but this value will no be used.
params["label"] = "local"
return params
else:
boot_image = get_boot_image(params)
if boot_image is None:
# No matching boot image.
description = "Missing boot image %s/%s/%s/%s." % (
params['osystem'], params["arch"],
params["subarch"], params["release"])
# Call MarkNodeFailed if this was a known machine.
if system_id is not None:
d = client(
MarkNodeFailed,
system_id=system_id,
error_description=description)
d.addErrback(
log.err,
"Failed to mark machine failed: %s" % description)
params["label"] = "no-such-image"
else:
params["label"] = boot_image["label"]
return params
@deferred
def get_kernel_params(self, params):
"""Return kernel parameters obtained from the API.
:param params: Parameters so far obtained, typically from the file
path requested.
:return: A `KernelParameters` instance.
"""
client = self.client_service.getClient()
params["system_id"] = client.localIdent
d = self.fetcher(client, GetBootConfig, **params)
d.addCallback(self.get_boot_image, client)
d.addCallback(lambda data: KernelParameters(**data))
return d
@deferred
def get_boot_method_reader(self, boot_method, params):
"""Return an `IReader` for a boot method.
:param boot_method: Boot method that is generating the config
:param params: Parameters so far obtained, typically from the file
path requested.
"""
def generate(kernel_params):
return boot_method.get_reader(
self, kernel_params=kernel_params, **params)
d = self.get_kernel_params(params)
d.addCallback(generate)
return d
@staticmethod
def no_response_errback(failure, file_name):
failure.trap(BootConfigNoResponse)
# Convert to a TFTP file not found.
raise FileNotFound(file_name)
@deferred
@typed
def handle_boot_method(self, file_name: TFTPPath, result):
boot_method, params = result
if boot_method is None:
return super(TFTPBackend, self).get_reader(file_name)
# Map pxe namespace architecture names to MAAS's.
arch = params.get("arch")
if arch is not None:
maasarch = ArchitectureRegistry.get_by_pxealias(arch)
if maasarch is not None:
params["arch"] = maasarch.name.split("/")[0]
# Send the local and remote endpoint addresses.
local_host, local_port = tftp.get_local_address()
params["local_ip"] = local_host
remote_host, remote_port = tftp.get_remote_address()
params["remote_ip"] = remote_host
d = self.get_boot_method_reader(boot_method, params)
return d
@staticmethod
def all_is_lost_errback(failure):
if failure.check(BackendError):
# This failure is something that the TFTP server knows how to deal
# with, so pass it through.
return failure
else:
# Something broke badly; record it.
log.err(failure, "TFTP back-end failed.")
# Don't keep people waiting; tell them something broke right now.
raise BackendError(failure.getErrorMessage())
@deferred
@typed
def get_reader(self, file_name: TFTPPath):
"""See `IBackend.get_reader()`.
If `file_name` matches a boot method then the response is obtained
from that boot method. Otherwise the filesystem is used to service
the response.
"""
# It is possible for a client to request the file with '\' instead
# of '/', example being 'bootx64.efi'. Convert all '\' to '/' to be
# unix compatiable.
file_name = file_name.replace(b'\\', b'/')
mac_address = get_remote_mac()
if mac_address is not None:
log_request(mac_address, file_name)
d = self.get_boot_method(file_name)
d.addCallback(partial(self.handle_boot_method, file_name))
d.addErrback(self.no_response_errback, file_name)
d.addErrback(self.all_is_lost_errback)
return d
class Port(udp.Port):
"""A :py:class:`udp.Port` that groks IPv6."""
# This must be set by call sites.
addressFamily = None
def getHost(self):
"""See :py:meth:`twisted.internet.udp.Port.getHost`."""
host, port = self.socket.getsockname()[:2]
addr_type = IPv6Address if isIPv6Address(host) else IPv4Address
return addr_type('UDP', host, port)
class UDPServer(internet.UDPServer):
"""A :py:class:`~internet.UDPServer` that groks IPv6.
This creates the port directly instead of using the reactor's
``listenUDP`` method so that we can do a switcharoo to our own
IPv6-enabled port implementation.
"""
def _getPort(self):
"""See :py:meth:`twisted.application.internet.UDPServer._getPort`."""
return self._listenUDP(*self.args, **self.kwargs)
def _listenUDP(self, port, protocol, interface='', maxPacketSize=8192):
"""See :py:meth:`twisted.internet.reactor.listenUDP`."""
p = Port(port, protocol, interface, maxPacketSize)
p.addressFamily = AF_INET6 if isIPv6Address(interface) else AF_INET
p.startListening()
return p
class TFTPService(MultiService, object):
"""An umbrella service representing a set of running TFTP servers.
Creates a UDP server individually for each discovered network
interface, so that we can detect the interface via which we have
received a datagram.
It then periodically updates the servers running in case there's a
change to the host machine's network configuration.
:ivar backend: The :class:`TFTPBackend` being used to service TFTP
requests.
:ivar port: The port on which each server is started.
:ivar refresher: A :class:`TimerService` that calls
``updateServers`` periodically.
"""
def __init__(self, resource_root, port, client_service):
"""
:param resource_root: The root directory for this TFTP server.
:param port: The port on which each server should be started.
:param client_service: The RPC client service for the rack controller.
"""
super(TFTPService, self).__init__()
self.backend = TFTPBackend(resource_root, client_service)
self.port = port
# Establish a periodic call to self.updateServers() every 45
# seconds, so that this service eventually converges on truth.
# TimerService ensures that a call is made to it's target
# function immediately as it's started, so there's no need to
# call updateServers() from here.
self.refresher = internet.TimerService(45, self.updateServers)
self.refresher.setName("refresher")
self.refresher.setServiceParent(self)
def getServers(self):
"""Return a set of all configured servers.
:rtype: :class:`set` of :class:`internet.UDPServer`
"""
return {
service for service in self
if service is not self.refresher
}
def updateServers(self):
"""Run a server on every interface.
For each configured network interface this will start a TFTP
server. If called later it will bring up servers on newly
configured interfaces and bring down servers on deconfigured
interfaces.
"""
addrs_established = set(service.name for service in self.getServers())
addrs_desired = set(get_all_interface_addresses())
for address in addrs_desired - addrs_established:
if not IPAddress(address).is_link_local():
tftp_service = UDPServer(
self.port, TFTP(self.backend), interface=address)
tftp_service.setName(address)
tftp_service.setServiceParent(self)
for address in addrs_established - addrs_desired:
tftp_service = self.getServiceNamed(address)
tftp_service.disownServiceParent()
|