/usr/lib/python2.7/dist-packages/curtin/util.py is in python-curtin 18.1-5-g572ae5d6-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 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 | # This file is part of curtin. See LICENSE file for copyright and license info.
import argparse
import collections
from contextlib import contextmanager
import errno
import glob
import json
import os
import platform
import re
import shlex
import shutil
import socket
import subprocess
import stat
import sys
import tempfile
import time
# avoid the dependency to python3-six as used in cloud-init
try:
from urlparse import urlparse
except ImportError:
# python3
# avoid triggering pylint, https://github.com/PyCQA/pylint/issues/769
# pylint:disable=import-error,no-name-in-module
from urllib.parse import urlparse
try:
string_types = (basestring,)
except NameError:
string_types = (str,)
try:
numeric_types = (int, float, long)
except NameError:
# python3 does not have a long type.
numeric_types = (int, float)
from .log import LOG
_INSTALLED_HELPERS_PATH = 'usr/lib/curtin/helpers'
_INSTALLED_MAIN = 'usr/bin/curtin'
_LSB_RELEASE = {}
_USES_SYSTEMD = None
_HAS_UNSHARE_PID = None
_DNS_REDIRECT_IP = None
# matcher used in template rendering functions
BASIC_MATCHER = re.compile(r'\$\{([A-Za-z0-9_.]+)\}|\$([A-Za-z0-9_.]+)')
def _subp(args, data=None, rcs=None, env=None, capture=False,
combine_capture=False, shell=False, logstring=False,
decode="replace", target=None, cwd=None, log_captured=False,
unshare_pid=None):
if rcs is None:
rcs = [0]
devnull_fp = None
tpath = target_path(target)
chroot_args = [] if tpath == "/" else ['chroot', target]
sh_args = ['sh', '-c'] if shell else []
if isinstance(args, string_types):
args = [args]
try:
unshare_args = _get_unshare_pid_args(unshare_pid, tpath)
except RuntimeError as e:
raise RuntimeError("Unable to unshare pid (cmd=%s): %s" % (args, e))
args = unshare_args + chroot_args + sh_args + list(args)
if not logstring:
LOG.debug(
"Running command %s with allowed return codes %s (capture=%s)",
args, rcs, 'combine' if combine_capture else capture)
else:
LOG.debug(("Running hidden command to protect sensitive "
"input/output logstring: %s"), logstring)
try:
stdin = None
stdout = None
stderr = None
if capture:
stdout = subprocess.PIPE
stderr = subprocess.PIPE
if combine_capture:
stdout = subprocess.PIPE
stderr = subprocess.STDOUT
if data is None:
devnull_fp = open(os.devnull)
stdin = devnull_fp
else:
stdin = subprocess.PIPE
sp = subprocess.Popen(args, stdout=stdout,
stderr=stderr, stdin=stdin,
env=env, shell=False, cwd=cwd)
# communicate in python2 returns str, python3 returns bytes
(out, err) = sp.communicate(data)
# Just ensure blank instead of none.
if not out and capture:
out = b''
if not err and capture:
err = b''
if decode:
def ldecode(data, m='utf-8'):
if not isinstance(data, bytes):
return data
return data.decode(m, errors=decode)
out = ldecode(out)
err = ldecode(err)
except OSError as e:
raise ProcessExecutionError(cmd=args, reason=e)
finally:
if devnull_fp:
devnull_fp.close()
if capture and log_captured:
LOG.debug("Command returned stdout=%s, stderr=%s", out, err)
rc = sp.returncode # pylint: disable=E1101
if rc not in rcs:
raise ProcessExecutionError(stdout=out, stderr=err,
exit_code=rc,
cmd=args)
return (out, err)
def _has_unshare_pid():
global _HAS_UNSHARE_PID
if _HAS_UNSHARE_PID is not None:
return _HAS_UNSHARE_PID
if not which('unshare'):
_HAS_UNSHARE_PID = False
return False
out, err = subp(["unshare", "--help"], capture=True, decode=False,
unshare_pid=False)
joined = b'\n'.join([out, err])
_HAS_UNSHARE_PID = b'--fork' in joined and b'--pid' in joined
return _HAS_UNSHARE_PID
def _get_unshare_pid_args(unshare_pid=None, target=None, euid=None):
"""Get args for calling unshare for a pid.
If unshare_pid is False, return empty list.
If unshare_pid is True, check if it is usable. If not, raise exception.
if unshare_pid is None, then unshare if
* euid is 0
* 'unshare' with '--fork' and '--pid' is available.
* target != /
"""
if unshare_pid is not None and not unshare_pid:
# given a false-ish other than None means no.
return []
if euid is None:
euid = os.geteuid()
tpath = target_path(target)
unshare_pid_in = unshare_pid
if unshare_pid is None:
unshare_pid = False
if tpath != "/" and euid == 0:
if _has_unshare_pid():
unshare_pid = True
if not unshare_pid:
return []
# either unshare was passed in as True, or None and turned to True.
if euid != 0:
raise RuntimeError(
"given unshare_pid=%s but euid (%s) != 0." %
(unshare_pid_in, euid))
if not _has_unshare_pid():
raise RuntimeError(
"given unshare_pid=%s but no unshare command." % unshare_pid_in)
return ['unshare', '--fork', '--pid', '--']
def subp(*args, **kwargs):
"""Run a subprocess.
:param args: command to run in a list. [cmd, arg1, arg2...]
:param data: input to the command, made available on its stdin.
:param rcs:
a list of allowed return codes. If subprocess exits with a value not
in this list, a ProcessExecutionError will be raised. By default,
data is returned as a string. See 'decode' parameter.
:param env: a dictionary for the command's environment.
:param capture:
boolean indicating if output should be captured. If True, then stderr
and stdout will be returned. If False, they will not be redirected.
:param combine_capture:
boolean indicating if stderr should be redirected to stdout. When True,
interleaved stderr and stdout will be returned as the first element of
a tuple.
:param log_captured:
boolean indicating if output should be logged on capture. If
True, then stderr and stdout will be logged at DEBUG level. If
False, they will not be logged.
:param shell: boolean indicating if this should be run with a shell.
:param logstring:
the command will be logged to DEBUG. If it contains info that should
not be logged, then logstring will be logged instead.
:param decode:
if False, no decoding will be done and returned stdout and stderr will
be bytes. Other allowed values are 'strict', 'ignore', and 'replace'.
These values are passed through to bytes().decode() as the 'errors'
parameter. There is no support for decoding to other than utf-8.
:param retries:
a list of times to sleep in between retries. After each failure
subp will sleep for N seconds and then try again. A value of [1, 3]
means to run, sleep 1, run, sleep 3, run and then return exit code.
:param target:
run the command as 'chroot target <args>'
:param unshare_pid:
unshare the pid namespace.
default value (None) is to unshare pid namespace if possible
and target != /
:return
if not capturing, return is (None, None)
if capturing, stdout and stderr are returned.
if decode:
python2 unicode or python3 string
if not decode:
python2 string or python3 bytes
"""
retries = []
if "retries" in kwargs:
retries = kwargs.pop("retries")
if not retries:
# allow retries=None
retries = []
if args:
cmd = args[0]
if 'args' in kwargs:
cmd = kwargs['args']
# Retry with waits between the retried command.
for num, wait in enumerate(retries):
try:
return _subp(*args, **kwargs)
except ProcessExecutionError as e:
LOG.debug("try %s: command %s failed, rc: %s", num,
cmd, e.exit_code)
time.sleep(wait)
# Final try without needing to wait or catch the error. If this
# errors here then it will be raised to the caller.
return _subp(*args, **kwargs)
def wait_for_removal(path, retries=[1, 3, 5, 7]):
if not path:
raise ValueError('wait_for_removal: missing path parameter')
# Retry with waits between checking for existence
LOG.debug('waiting for %s to be removed', path)
for num, wait in enumerate(retries):
if not os.path.exists(path):
LOG.debug('%s has been removed', path)
return
LOG.debug('sleeping %s', wait)
time.sleep(wait)
# final check
if not os.path.exists(path):
LOG.debug('%s has been removed', path)
return
raise OSError('Timeout exceeded for removal of %s', path)
def load_command_environment(env=os.environ, strict=False):
mapping = {'scratch': 'WORKING_DIR', 'fstab': 'OUTPUT_FSTAB',
'interfaces': 'OUTPUT_INTERFACES', 'config': 'CONFIG',
'target': 'TARGET_MOUNT_POINT',
'network_state': 'OUTPUT_NETWORK_STATE',
'network_config': 'OUTPUT_NETWORK_CONFIG',
'report_stack_prefix': 'CURTIN_REPORTSTACK'}
if strict:
missing = [k for k in mapping.values() if k not in env]
if len(missing):
raise KeyError("missing environment vars: %s" % missing)
return {k: env.get(v) for k, v in mapping.items()}
def is_kmod_loaded(module):
"""Test if kernel module 'module' is current loaded by checking sysfs"""
if not module:
raise ValueError('is_kmod_loaded: invalid module: "%s"', module)
return os.path.isdir('/sys/module/%s' % module)
def load_kernel_module(module, check_loaded=True):
"""Install kernel module via modprobe. Optionally check if it's already
loaded .
"""
if not module:
raise ValueError('load_kernel_module: invalid module: "%s"', module)
if check_loaded:
if is_kmod_loaded(module):
LOG.debug('Skipping kernel module load, %s already loaded', module)
return
LOG.debug('Loading kernel module %s via modprobe', module)
subp(['modprobe', '--use-blacklist', module])
class BadUsage(Exception):
pass
class ProcessExecutionError(IOError):
MESSAGE_TMPL = ('%(description)s\n'
'Command: %(cmd)s\n'
'Exit code: %(exit_code)s\n'
'Reason: %(reason)s\n'
'Stdout: %(stdout)s\n'
'Stderr: %(stderr)s')
stdout_indent_level = 8
def __init__(self, stdout=None, stderr=None,
exit_code=None, cmd=None,
description=None, reason=None):
if not cmd:
self.cmd = '-'
else:
self.cmd = cmd
if not description:
self.description = 'Unexpected error while running command.'
else:
self.description = description
if not isinstance(exit_code, int):
self.exit_code = '-'
else:
self.exit_code = exit_code
if not stderr:
self.stderr = "''"
else:
self.stderr = self._indent_text(stderr)
if not stdout:
self.stdout = "''"
else:
self.stdout = self._indent_text(stdout)
if reason:
self.reason = reason
else:
self.reason = '-'
message = self.MESSAGE_TMPL % {
'description': self.description,
'cmd': self.cmd,
'exit_code': self.exit_code,
'stdout': self.stdout,
'stderr': self.stderr,
'reason': self.reason,
}
IOError.__init__(self, message)
def _indent_text(self, text):
if type(text) == bytes:
text = text.decode()
return text.replace('\n', '\n' + ' ' * self.stdout_indent_level)
class LogTimer(object):
def __init__(self, logfunc, msg):
self.logfunc = logfunc
self.msg = msg
def __enter__(self):
self.start = time.time()
return self
def __exit__(self, etype, value, trace):
self.logfunc("%s took %0.3f seconds" %
(self.msg, time.time() - self.start))
def is_mounted(target, src=None, opts=None):
# return whether or not src is mounted on target
mounts = ""
with open("/proc/mounts", "r") as fp:
mounts = fp.read()
for line in mounts.splitlines():
if line.split()[1] == os.path.abspath(target):
return True
return False
def list_device_mounts(device):
# return mount entry if device is in /proc/mounts
mounts = ""
with open("/proc/mounts", "r") as fp:
mounts = fp.read()
dev_mounts = []
for line in mounts.splitlines():
if line.split()[0] == device:
dev_mounts.append(line)
return dev_mounts
def fuser_mount(path):
""" Execute fuser to determine open file handles from mountpoint path
Use verbose mode and then combine stdout, stderr from fuser into
a dictionary:
{pid: "fuser-details"}
path may also be a kernel devpath (e.g. /dev/sda)
"""
fuser_output = {}
try:
stdout, stderr = subp(['fuser', '--verbose', '--mount', path],
capture=True)
except ProcessExecutionError as e:
LOG.debug('fuser returned non-zero: %s', e.stderr)
return None
pidlist = stdout.split()
"""
fuser writes a header in verbose mode, we'll ignore that but the
order if the input is <mountpoint> <user> <pid*> <access> <command>
note that <pid> is not present in stderr, it's only in stdout. Also
only the entry with pid=kernel entry will contain the mountpoint
# Combined stdout and stderr look like:
# USER PID ACCESS COMMAND
# /home: root kernel mount /
# root 1 .rce. systemd
#
# This would return
#
{
'kernel': ['/home', 'root', 'mount', '/'],
'1': ['root', '1', '.rce.', 'systemd'],
}
"""
# Note that fuser only writes PIDS to stdout. Each PID value is
# 'kernel' or an integer and indicates a process which has an open
# file handle against the path specified path. All other output
# is sent to stderr. This code below will merge the two as needed.
for (pid, status) in zip(pidlist, stderr.splitlines()[1:]):
fuser_output[pid] = status.split()
return fuser_output
@contextmanager
def chdir(dirname):
curdir = os.getcwd()
try:
os.chdir(dirname)
yield dirname
finally:
os.chdir(curdir)
def do_mount(src, target, opts=None):
# mount src at target with opts and return True
# if already mounted, return False
if opts is None:
opts = []
if isinstance(opts, str):
opts = [opts]
if is_mounted(target, src, opts):
return False
ensure_dir(target)
cmd = ['mount'] + opts + [src, target]
subp(cmd)
return True
def do_umount(mountpoint, recursive=False):
# unmount mountpoint. if recursive, unmount all mounts under it.
# return boolean indicating if mountpoint was previously mounted.
mp = os.path.abspath(mountpoint)
ret = False
for line in reversed(load_file("/proc/mounts", decode=True).splitlines()):
curmp = line.split()[1]
if curmp == mp or (recursive and curmp.startswith(mp + os.path.sep)):
subp(['umount', curmp])
if curmp == mp:
ret = True
return ret
def ensure_dir(path, mode=None):
try:
os.makedirs(path)
except OSError as e:
if e.errno != errno.EEXIST:
raise
if mode is not None:
os.chmod(path, mode)
def write_file(filename, content, mode=0o644, omode="w"):
"""
write 'content' to file at 'filename' using python open mode 'omode'.
if mode is not set, then chmod file to mode. mode is 644 by default
"""
ensure_dir(os.path.dirname(filename))
with open(filename, omode) as fp:
fp.write(content)
if mode:
os.chmod(filename, mode)
def load_file(path, read_len=None, offset=0, decode=True):
with open(path, "rb") as fp:
if offset:
fp.seek(offset)
contents = fp.read(read_len) if read_len else fp.read()
if decode:
return decode_binary(contents)
else:
return contents
def decode_binary(blob, encoding='utf-8', errors='replace'):
# Converts a binary type into a text type using given encoding.
return blob.decode(encoding, errors=errors)
def file_size(path):
"""get the size of a file"""
with open(path, 'rb') as fp:
fp.seek(0, 2)
return fp.tell()
def del_file(path):
try:
os.unlink(path)
LOG.debug("del_file: removed %s", path)
except OSError as e:
LOG.exception("del_file: %s did not exist.", path)
if e.errno != errno.ENOENT:
raise e
def disable_daemons_in_root(target):
contents = "\n".join(
['#!/bin/sh',
'# see invoke-rc.d for exit codes. 101 is "do not run"',
'while true; do',
' case "$1" in',
' -*) shift;;',
' makedev|x11-common) exit 0;;',
' *) exit 101;;',
' esac',
'done',
''])
fpath = target_path(target, "/usr/sbin/policy-rc.d")
if os.path.isfile(fpath):
return False
write_file(fpath, mode=0o755, content=contents)
return True
def undisable_daemons_in_root(target):
try:
os.unlink(target_path(target, "/usr/sbin/policy-rc.d"))
except OSError as e:
if e.errno != errno.ENOENT:
raise
return False
return True
class ChrootableTarget(object):
def __init__(self, target, allow_daemons=False, sys_resolvconf=True):
if target is None:
target = "/"
self.target = target_path(target)
self.mounts = ["/dev", "/proc", "/sys"]
self.umounts = []
self.disabled_daemons = False
self.allow_daemons = allow_daemons
self.sys_resolvconf = sys_resolvconf
self.rconf_d = None
def __enter__(self):
for p in self.mounts:
tpath = target_path(self.target, p)
if do_mount(p, tpath, opts='--bind'):
self.umounts.append(tpath)
if not self.allow_daemons:
self.disabled_daemons = disable_daemons_in_root(self.target)
rconf = target_path(self.target, "/etc/resolv.conf")
target_etc = os.path.dirname(rconf)
if self.target != "/" and os.path.isdir(target_etc):
# never muck with resolv.conf on /
rconf = os.path.join(target_etc, "resolv.conf")
rtd = None
try:
rtd = tempfile.mkdtemp(dir=target_etc)
tmp = os.path.join(rtd, "resolv.conf")
os.rename(rconf, tmp)
self.rconf_d = rtd
shutil.copy("/etc/resolv.conf", rconf)
except Exception:
if rtd:
shutil.rmtree(rtd)
self.rconf_d = None
raise
return self
def __exit__(self, etype, value, trace):
if self.disabled_daemons:
undisable_daemons_in_root(self.target)
# if /dev is to be unmounted, udevadm settle (LP: #1462139)
if target_path(self.target, "/dev") in self.umounts:
subp(['udevadm', 'settle'])
for p in reversed(self.umounts):
do_umount(p)
rconf = target_path(self.target, "/etc/resolv.conf")
if self.sys_resolvconf and self.rconf_d:
os.rename(os.path.join(self.rconf_d, "resolv.conf"), rconf)
shutil.rmtree(self.rconf_d)
def subp(self, *args, **kwargs):
kwargs['target'] = self.target
return subp(*args, **kwargs)
def path(self, path):
return target_path(self.target, path)
def is_exe(fpath):
# Return path of program for execution if found in path
return os.path.isfile(fpath) and os.access(fpath, os.X_OK)
def which(program, search=None, target=None):
target = target_path(target)
if os.path.sep in program:
# if program had a '/' in it, then do not search PATH
# 'which' does consider cwd here. (cd / && which bin/ls) = bin/ls
# so effectively we set cwd to / (or target)
if is_exe(target_path(target, program)):
return program
if search is None:
paths = [p.strip('"') for p in
os.environ.get("PATH", "").split(os.pathsep)]
if target == "/":
search = paths
else:
search = [p for p in paths if p.startswith("/")]
# normalize path input
search = [os.path.abspath(p) for p in search]
for path in search:
ppath = os.path.sep.join((path, program))
if is_exe(target_path(target, ppath)):
return ppath
return None
def _installed_file_path(path, check_file=None):
# check the install root for the file 'path'.
# if 'check_file', then path is a directory that contains file.
# return absolute path or None.
inst_pre = "/"
if os.environ.get('SNAP'):
inst_pre = os.path.abspath(os.environ['SNAP'])
inst_path = os.path.join(inst_pre, path)
if check_file:
check_path = os.path.sep.join((inst_path, check_file))
else:
check_path = inst_path
if os.path.isfile(check_path):
return os.path.abspath(inst_path)
return None
def get_paths(curtin_exe=None, lib=None, helpers=None):
# return a dictionary with paths for 'curtin_exe', 'helpers' and 'lib'
# that represent where 'curtin' executable lives, where the 'curtin' module
# directory is (containing __init__.py) and where the 'helpers' directory.
mydir = os.path.realpath(os.path.dirname(__file__))
tld = os.path.realpath(mydir + os.path.sep + "..")
if curtin_exe is None:
if os.path.isfile(os.path.join(tld, "bin", "curtin")):
curtin_exe = os.path.join(tld, "bin", "curtin")
if (curtin_exe is None and
(os.path.basename(sys.argv[0]).startswith("curtin") and
os.path.isfile(sys.argv[0]))):
curtin_exe = os.path.realpath(sys.argv[0])
if curtin_exe is None:
found = which('curtin')
if found:
curtin_exe = found
if curtin_exe is None:
curtin_exe = _installed_file_path(_INSTALLED_MAIN)
# "common" is a file in helpers
cfile = "common"
if (helpers is None and
os.path.isfile(os.path.join(tld, "helpers", cfile))):
helpers = os.path.join(tld, "helpers")
if helpers is None:
helpers = _installed_file_path(_INSTALLED_HELPERS_PATH, cfile)
return({'curtin_exe': curtin_exe, 'lib': mydir, 'helpers': helpers})
def get_architecture(target=None):
out, _ = subp(['dpkg', '--print-architecture'], capture=True,
target=target)
return out.strip()
def has_pkg_available(pkg, target=None):
out, _ = subp(['apt-cache', 'pkgnames'], capture=True, target=target)
for item in out.splitlines():
if pkg == item.strip():
return True
return False
def get_installed_packages(target=None):
(out, _) = subp(['dpkg-query', '--list'], target=target, capture=True)
pkgs_inst = set()
for line in out.splitlines():
try:
(state, pkg, other) = line.split(None, 2)
except ValueError:
continue
if state.startswith("hi") or state.startswith("ii"):
pkgs_inst.add(re.sub(":.*", "", pkg))
return pkgs_inst
def has_pkg_installed(pkg, target=None):
try:
out, _ = subp(['dpkg-query', '--show', '--showformat',
'${db:Status-Abbrev}', pkg],
capture=True, target=target)
return out.rstrip() == "ii"
except ProcessExecutionError:
return False
def parse_dpkg_version(raw, name=None, semx=None):
"""Parse a dpkg version string into various parts and calcualate a
numerical value of the version for use in comparing package versions
returns a dictionary with the results
"""
if semx is None:
semx = (10000, 100, 1)
upstream = raw.split('-')[0]
toks = upstream.split(".", 2)
if len(toks) == 3:
major, minor, micro = toks
elif len(toks) == 2:
major, minor, micro = (toks[0], toks[1], 0)
elif len(toks) == 1:
major, minor, micro = (toks[0], 0, 0)
version = {
'major': major,
'minor': minor,
'micro': micro,
'raw': raw,
'upstream': upstream,
}
if name:
version['name'] = name
if semx:
try:
version['semantic_version'] = int(
int(major) * semx[0] + int(minor) * semx[1] +
int(micro) * semx[2])
except (ValueError, IndexError):
version['semantic_version'] = None
return version
def get_package_version(pkg, target=None, semx=None):
"""Use dpkg-query to extract package pkg's version string
and parse the version string into a dictionary
"""
try:
out, _ = subp(['dpkg-query', '--show', '--showformat',
'${Version}', pkg], capture=True, target=target)
raw = out.rstrip()
return parse_dpkg_version(raw, name=pkg, semx=semx)
except ProcessExecutionError:
return None
def find_newer(src, files):
mtime = os.stat(src).st_mtime
return [f for f in files if
os.path.exists(f) and os.stat(f).st_mtime > mtime]
def set_unexecutable(fname, strict=False):
"""set fname so it is not executable.
if strict, raise an exception if the file does not exist.
return the current mode, or None if no change is needed.
"""
if not os.path.exists(fname):
if strict:
raise ValueError('%s: file does not exist' % fname)
return None
cur = stat.S_IMODE(os.lstat(fname).st_mode)
target = cur & (~stat.S_IEXEC & ~stat.S_IXGRP & ~stat.S_IXOTH)
if cur == target:
return None
os.chmod(fname, target)
return cur
def apt_update(target=None, env=None, force=False, comment=None,
retries=None):
marker = "tmp/curtin.aptupdate"
if target is None:
target = "/"
if env is None:
env = os.environ.copy()
if retries is None:
# by default run apt-update up to 3 times to allow
# for transient failures
retries = (1, 2, 3)
if comment is None:
comment = "no comment provided"
if comment.endswith("\n"):
comment = comment[:-1]
marker = target_path(target, marker)
# if marker exists, check if there are files that would make it obsolete
listfiles = [target_path(target, "/etc/apt/sources.list")]
listfiles += glob.glob(
target_path(target, "etc/apt/sources.list.d/*.list"))
if os.path.exists(marker) and not force:
if len(find_newer(marker, listfiles)) == 0:
return
restore_perms = []
abs_tmpdir = tempfile.mkdtemp(dir=target_path(target, "/tmp"))
try:
abs_slist = abs_tmpdir + "/sources.list"
abs_slistd = abs_tmpdir + "/sources.list.d"
ch_tmpdir = "/tmp/" + os.path.basename(abs_tmpdir)
ch_slist = ch_tmpdir + "/sources.list"
ch_slistd = ch_tmpdir + "/sources.list.d"
# this file gets executed on apt-get update sometimes. (LP: #1527710)
motd_update = target_path(
target, "/usr/lib/update-notifier/update-motd-updates-available")
pmode = set_unexecutable(motd_update)
if pmode is not None:
restore_perms.append((motd_update, pmode),)
# create tmpdir/sources.list with all lines other than deb-src
# avoid apt complaining by using existing and empty dir for sourceparts
os.mkdir(abs_slistd)
with open(abs_slist, "w") as sfp:
for sfile in listfiles:
with open(sfile, "r") as fp:
contents = fp.read()
for line in contents.splitlines():
line = line.lstrip()
if not line.startswith("deb-src"):
sfp.write(line + "\n")
update_cmd = [
'apt-get', '--quiet',
'--option=Acquire::Languages=none',
'--option=Dir::Etc::sourcelist=%s' % ch_slist,
'--option=Dir::Etc::sourceparts=%s' % ch_slistd,
'update']
# do not using 'run_apt_command' so we can use 'retries' to subp
with ChrootableTarget(target, allow_daemons=True) as inchroot:
inchroot.subp(update_cmd, env=env, retries=retries)
finally:
for fname, perms in restore_perms:
os.chmod(fname, perms)
if abs_tmpdir:
shutil.rmtree(abs_tmpdir)
with open(marker, "w") as fp:
fp.write(comment + "\n")
def run_apt_command(mode, args=None, aptopts=None, env=None, target=None,
execute=True, allow_daemons=False):
opts = ['--quiet', '--assume-yes',
'--option=Dpkg::options::=--force-unsafe-io',
'--option=Dpkg::Options::=--force-confold']
if args is None:
args = []
if aptopts is None:
aptopts = []
if env is None:
env = os.environ.copy()
env['DEBIAN_FRONTEND'] = 'noninteractive'
if which('eatmydata', target=target):
emd = ['eatmydata']
else:
emd = []
cmd = emd + ['apt-get'] + opts + aptopts + [mode] + args
if not execute:
return env, cmd
apt_update(target, env=env, comment=' '.join(cmd))
with ChrootableTarget(target, allow_daemons=allow_daemons) as inchroot:
return inchroot.subp(cmd, env=env)
def system_upgrade(aptopts=None, target=None, env=None, allow_daemons=False):
LOG.debug("Upgrading system in %s", target)
for mode in ('dist-upgrade', 'autoremove'):
ret = run_apt_command(
mode, aptopts=aptopts, target=target,
env=env, allow_daemons=allow_daemons)
return ret
def install_packages(pkglist, aptopts=None, target=None, env=None,
allow_daemons=False):
if isinstance(pkglist, str):
pkglist = [pkglist]
return run_apt_command(
'install', args=pkglist,
aptopts=aptopts, target=target, env=env, allow_daemons=allow_daemons)
def is_uefi_bootable():
return os.path.exists('/sys/firmware/efi') is True
def get_efibootmgr(target):
"""Return mapping of EFI information.
Calls `efibootmgr` inside the `target`.
Example output:
{
'current': '0000',
'timeout': '1 seconds',
'order': ['0000', '0001'],
'entries': {
'0000': {
'name': 'ubuntu',
'path': (
'HD(1,GPT,0,0x8,0x1)/File(\\EFI\\ubuntu\\shimx64.efi)'),
},
'0001': {
'name': 'UEFI:Network Device',
'path': 'BBS(131,,0x0)',
}
}
}
"""
efikey_to_dict_key = {
'BootCurrent': 'current',
'Timeout': 'timeout',
'BootOrder': 'order',
}
with ChrootableTarget(target) as in_chroot:
stdout, _ = in_chroot.subp(['efibootmgr', '-v'], capture=True)
output = {}
for line in stdout.splitlines():
split = line.split(':')
if len(split) == 2:
key = split[0].strip()
output_key = efikey_to_dict_key.get(key, None)
if output_key:
output[output_key] = split[1].strip()
if output_key == 'order':
output[output_key] = output[output_key].split(',')
output['entries'] = {
entry: {
'name': name.strip(),
'path': path.strip(),
}
for entry, name, path in re.findall(
r"^Boot(?P<entry>[0-9a-fA-F]{4})\*?\s(?P<name>.+)\t"
r"(?P<path>.*)$",
stdout, re.MULTILINE)
}
return output
def run_hook_if_exists(target, hook):
"""
Look for "hook" in "target" and run it
"""
target_hook = target_path(target, '/curtin/' + hook)
if os.path.isfile(target_hook):
LOG.debug("running %s" % target_hook)
subp([target_hook])
return True
return False
def sanitize_source(source):
"""
Check the install source for type information
If no type information is present or it is an invalid
type, we default to the standard tgz format
"""
if type(source) is dict:
# already sanitized?
return source
supported = ['tgz', 'dd-tgz', 'dd-tbz', 'dd-txz', 'dd-tar', 'dd-bz2',
'dd-gz', 'dd-xz', 'dd-raw', 'fsimage']
deftype = 'tgz'
for i in supported:
prefix = i + ":"
if source.startswith(prefix):
return {'type': i, 'uri': source[len(prefix):]}
# translate squashfs: to fsimage type.
if source.startswith("squashfs:"):
return {'type': 'fsimage', 'uri': source[len("squashfs:")]}
if source.endswith("squashfs") or source.endswith("squash"):
return {'type': 'fsimage', 'uri': source}
LOG.debug("unknown type for url '%s', assuming type '%s'", source, deftype)
# default to tgz for unknown types
return {'type': deftype, 'uri': source}
def get_dd_images(sources):
"""
return all disk images in sources list
"""
src = []
if type(sources) is not dict:
return src
for i in sources:
if type(sources[i]) is not dict:
continue
if sources[i]['type'].startswith('dd-'):
src.append(sources[i])
return src
def get_meminfo(meminfo="/proc/meminfo", raw=False):
mpliers = {'kB': 2**10, 'mB': 2 ** 20, 'B': 1, 'gB': 2 ** 30}
kmap = {'MemTotal:': 'total', 'MemFree:': 'free',
'MemAvailable:': 'available'}
ret = {}
with open(meminfo, "r") as fp:
for line in fp:
try:
key, value, unit = line.split()
except ValueError:
key, value = line.split()
unit = 'B'
if raw:
ret[key] = int(value) * mpliers[unit]
elif key in kmap:
ret[kmap[key]] = int(value) * mpliers[unit]
return ret
def get_fs_use_info(path):
# return some filesystem usage info as tuple of (size_in_bytes, free_bytes)
statvfs = os.statvfs(path)
return (statvfs.f_frsize * statvfs.f_blocks,
statvfs.f_frsize * statvfs.f_bfree)
def human2bytes(size):
# convert human 'size' to integer
size_in = size
if isinstance(size, int):
return size
elif isinstance(size, float):
if int(size) != size:
raise ValueError("'%s': resulted in non-integer (%s)" %
(size_in, int(size)))
return size
elif not isinstance(size, str):
raise TypeError("cannot convert type %s ('%s')." % (type(size), size))
if size.endswith("B"):
size = size[:-1]
mpliers = {'B': 1, 'K': 2 ** 10, 'M': 2 ** 20, 'G': 2 ** 30, 'T': 2 ** 40}
num = size
mplier = 'B'
for m in mpliers:
if size.endswith(m):
mplier = m
num = size[0:-len(m)]
try:
num = float(num)
except ValueError:
raise ValueError("'%s' is not valid input." % size_in)
if num < 0:
raise ValueError("'%s': cannot be negative" % size_in)
val = num * mpliers[mplier]
if int(val) != val:
raise ValueError("'%s': resulted in non-integer (%s)" % (size_in, val))
return val
def bytes2human(size):
"""convert size in bytes to human readable"""
if not isinstance(size, numeric_types):
raise ValueError('size must be a numeric value, not %s', type(size))
isize = int(size)
if isize != size:
raise ValueError('size "%s" is not a whole number.' % size)
if isize < 0:
raise ValueError('size "%d" < 0.' % isize)
mpliers = {'B': 1, 'K': 2 ** 10, 'M': 2 ** 20, 'G': 2 ** 30, 'T': 2 ** 40}
unit_order = sorted(mpliers, key=lambda x: -1 * mpliers[x])
unit = next((u for u in unit_order if (isize / mpliers[u]) >= 1), 'B')
return str(int(isize / mpliers[unit])) + unit
def import_module(import_str):
"""Import a module."""
__import__(import_str)
return sys.modules[import_str]
def try_import_module(import_str, default=None):
"""Try to import a module."""
try:
return import_module(import_str)
except ImportError:
return default
def is_file_not_found_exc(exc):
return (isinstance(exc, (IOError, OSError)) and
hasattr(exc, 'errno') and
exc.errno in (errno.ENOENT, errno.EIO, errno.ENXIO))
def _lsb_release(target=None):
fmap = {'Codename': 'codename', 'Description': 'description',
'Distributor ID': 'id', 'Release': 'release'}
data = {}
try:
out, _ = subp(['lsb_release', '--all'], capture=True, target=target)
for line in out.splitlines():
fname, _, val = line.partition(":")
if fname in fmap:
data[fmap[fname]] = val.strip()
missing = [k for k in fmap.values() if k not in data]
if len(missing):
LOG.warn("Missing fields in lsb_release --all output: %s",
','.join(missing))
except ProcessExecutionError as err:
LOG.warn("Unable to get lsb_release --all: %s", err)
data = {v: "UNAVAILABLE" for v in fmap.values()}
return data
def lsb_release(target=None):
if target_path(target) != "/":
# do not use or update cache if target is provided
return _lsb_release(target)
global _LSB_RELEASE
if not _LSB_RELEASE:
data = _lsb_release()
_LSB_RELEASE.update(data)
return _LSB_RELEASE
class MergedCmdAppend(argparse.Action):
"""This appends to a list in order of appearence both the option string
and the value"""
def __call__(self, parser, namespace, values, option_string=None):
if getattr(namespace, self.dest, None) is None:
setattr(namespace, self.dest, [])
getattr(namespace, self.dest).append((option_string, values,))
def json_dumps(data):
return json.dumps(data, indent=1, sort_keys=True, separators=(',', ': '))
def get_platform_arch():
platform2arch = {
'i586': 'i386',
'i686': 'i386',
'x86_64': 'amd64',
'ppc64le': 'ppc64el',
'aarch64': 'arm64',
}
return platform2arch.get(platform.machine(), platform.machine())
def basic_template_render(content, params):
"""This does simple replacement of bash variable like templates.
It identifies patterns like ${a} or $a and can also identify patterns like
${a.b} or $a.b which will look for a key 'b' in the dictionary rooted
by key 'a'.
"""
def replacer(match):
""" replacer
replacer used in regex match to replace content
"""
# Only 1 of the 2 groups will actually have a valid entry.
name = match.group(1)
if name is None:
name = match.group(2)
if name is None:
raise RuntimeError("Match encountered but no valid group present")
path = collections.deque(name.split("."))
selected_params = params
while len(path) > 1:
key = path.popleft()
if not isinstance(selected_params, dict):
raise TypeError("Can not traverse into"
" non-dictionary '%s' of type %s while"
" looking for subkey '%s'"
% (selected_params,
selected_params.__class__.__name__,
key))
selected_params = selected_params[key]
key = path.popleft()
if not isinstance(selected_params, dict):
raise TypeError("Can not extract key '%s' from non-dictionary"
" '%s' of type %s"
% (key, selected_params,
selected_params.__class__.__name__))
return str(selected_params[key])
return BASIC_MATCHER.sub(replacer, content)
def render_string(content, params):
""" render_string
render a string following replacement rules as defined in
basic_template_render returning the string
"""
if not params:
params = {}
return basic_template_render(content, params)
def is_resolvable(name):
"""determine if a url is resolvable, return a boolean
This also attempts to be resilent against dns redirection.
Note, that normal nsswitch resolution is used here. So in order
to avoid any utilization of 'search' entries in /etc/resolv.conf
we have to append '.'.
The top level 'invalid' domain is invalid per RFC. And example.com
should also not exist. The random entry will be resolved inside
the search list.
"""
global _DNS_REDIRECT_IP
if _DNS_REDIRECT_IP is None:
badips = set()
badnames = ("does-not-exist.example.com.", "example.invalid.")
badresults = {}
for iname in badnames:
try:
result = socket.getaddrinfo(iname, None, 0, 0,
socket.SOCK_STREAM,
socket.AI_CANONNAME)
badresults[iname] = []
for (_, _, _, cname, sockaddr) in result:
badresults[iname].append("%s: %s" % (cname, sockaddr[0]))
badips.add(sockaddr[0])
except (socket.gaierror, socket.error):
pass
_DNS_REDIRECT_IP = badips
if badresults:
LOG.debug("detected dns redirection: %s", badresults)
try:
result = socket.getaddrinfo(name, None)
# check first result's sockaddr field
addr = result[0][4][0]
if addr in _DNS_REDIRECT_IP:
LOG.debug("dns %s in _DNS_REDIRECT_IP", name)
return False
LOG.debug("dns %s resolved to '%s'", name, result)
return True
except (socket.gaierror, socket.error):
LOG.debug("dns %s failed to resolve", name)
return False
def is_valid_ipv6_address(addr):
try:
socket.inet_pton(socket.AF_INET6, addr)
except socket.error:
return False
return True
def is_resolvable_url(url):
"""determine if this url is resolvable (existing or ip)."""
return is_resolvable(urlparse(url).hostname)
def target_path(target, path=None):
# return 'path' inside target, accepting target as None
if target in (None, ""):
target = "/"
elif not isinstance(target, string_types):
raise ValueError("Unexpected input for target: %s" % target)
else:
target = os.path.abspath(target)
# abspath("//") returns "//" specifically for 2 slashes.
if target.startswith("//"):
target = target[1:]
if not path:
return target
if not isinstance(path, string_types):
raise ValueError("Unexpected input for path: %s" % path)
# os.path.join("/etc", "/foo") returns "/foo". Chomp all leading /.
while len(path) and path[0] == "/":
path = path[1:]
return os.path.join(target, path)
class RunInChroot(ChrootableTarget):
"""Backwards compatibility for RunInChroot (LP: #1617375).
It needs to work like:
with RunInChroot("/target") as in_chroot:
in_chroot(["your", "chrooted", "command"])"""
__call__ = ChrootableTarget.subp
def shlex_split(str_in):
# shlex.split takes a string
# but in python2 if input here is a unicode, encode it to a string.
# http://stackoverflow.com/questions/2365411/
# python-convert-unicode-to-ascii-without-errors
if sys.version_info.major == 2:
try:
if isinstance(str_in, unicode):
str_in = str_in.encode('utf-8')
except NameError:
pass
return shlex.split(str_in)
else:
return shlex.split(str_in)
def load_shell_content(content, add_empty=False, empty_val=None):
"""Given shell like syntax (key=value\nkey2=value2\n) in content
return the data in dictionary form. If 'add_empty' is True
then add entries in to the returned dictionary for 'VAR='
variables. Set their value to empty_val."""
data = {}
for line in shlex_split(content):
key, value = line.split("=", 1)
if not value:
value = empty_val
if add_empty or value:
data[key] = value
return data
def uses_systemd():
""" Check if current enviroment uses systemd by testing if
/run/systemd/system is a directory; only present if
systemd is available on running system.
"""
global _USES_SYSTEMD
if _USES_SYSTEMD is None:
_USES_SYSTEMD = os.path.isdir('/run/systemd/system')
return _USES_SYSTEMD
# vi: ts=4 expandtab syntax=python
|