summaryrefslogtreecommitdiff
path: root/src/op_mode/image_installer.py
blob: fdfaa1e17810535dd03bf57f400e8d74eb1b8b3e (plain)
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
#!/usr/bin/env python3
#
# Copyright 2023-2024 VyOS maintainers and contributors <maintainers@vyos.io>
#
# This file is part of VyOS.
#
# VyOS is free software: you can redistribute it and/or modify it under the
# terms of the GNU General Public License as published by the Free Software
# Foundation, either version 3 of the License, or (at your option) any later
# version.
#
# VyOS 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 General Public License for more
# details.
#
# You should have received a copy of the GNU General Public License along with
# VyOS. If not, see <https://www.gnu.org/licenses/>.

from argparse import ArgumentParser, Namespace
from pathlib import Path
from shutil import copy, chown, rmtree, copytree
from glob import glob
from sys import exit
from os import environ
from typing import Union
from urllib.parse import urlparse
from passlib.hosts import linux_context
from errno import ENOSPC

from psutil import disk_partitions

from vyos.configtree import ConfigTree
from vyos.configquery import ConfigTreeQuery
from vyos.remote import download
from vyos.system import disk, grub, image, compat, raid, SYSTEM_CFG_VER
from vyos.template import render
from vyos.utils.io import ask_input, ask_yes_no, select_entry
from vyos.utils.file import chmod_2775
from vyos.utils.process import cmd, run
from vyos.version import get_remote_version

# define text messages
MSG_ERR_NOT_LIVE: str = 'The system is already installed. Please use "add system image" instead.'
MSG_ERR_LIVE: str = 'The system is in live-boot mode. Please use "install image" instead.'
MSG_ERR_NO_DISK: str = 'No suitable disk was found. There must be at least one disk of 2GB or greater size.'
MSG_ERR_IMPROPER_IMAGE: str = 'Missing sha256sum.txt.\nEither this image is corrupted, or of era 1.2.x (md5sum) and would downgrade image tools;\ndisallowed in either case.'
MSG_INFO_INSTALL_WELCOME: str = 'Welcome to VyOS installation!\nThis command will install VyOS to your permanent storage.'
MSG_INFO_INSTALL_EXIT: str = 'Exiting from VyOS installation'
MSG_INFO_INSTALL_SUCCESS: str = 'The image installed successfully; please reboot now.'
MSG_INFO_INSTALL_DISKS_LIST: str = 'The following disks were found:'
MSG_INFO_INSTALL_DISK_SELECT: str = 'Which one should be used for installation?'
MSG_INFO_INSTALL_RAID_CONFIGURE: str = 'Would you like to configure RAID-1 mirroring?'
MSG_INFO_INSTALL_RAID_FOUND_DISKS: str = 'Would you like to configure RAID-1 mirroring on them?'
MSG_INFO_INSTALL_RAID_CHOOSE_DISKS: str = 'Would you like to choose two disks for RAID-1 mirroring?'
MSG_INFO_INSTALL_DISK_CONFIRM: str = 'Installation will delete all data on the drive. Continue?'
MSG_INFO_INSTALL_RAID_CONFIRM: str = 'Installation will delete all data on both drives. Continue?'
MSG_INFO_INSTALL_PARTITONING: str = 'Creating partition table...'
MSG_INPUT_CONFIG_FOUND: str = 'An active configuration was found. Would you like to copy it to the new image?'
MSG_INPUT_CONFIG_CHOICE: str = 'The following config files are available for boot:'
MSG_INPUT_CONFIG_CHOOSE: str = 'Which file would you like as boot config?'
MSG_INPUT_IMAGE_NAME: str = 'What would you like to name this image?'
MSG_INPUT_IMAGE_DEFAULT: str = 'Would you like to set the new image as the default one for boot?'
MSG_INPUT_PASSWORD: str = 'Please enter a password for the "vyos" user:'
MSG_INPUT_PASSWORD_CONFIRM: str = 'Please confirm password for the "vyos" user:'
MSG_INPUT_ROOT_SIZE_ALL: str = 'Would you like to use all the free space on the drive?'
MSG_INPUT_ROOT_SIZE_SET: str = 'Please specify the size (in GB) of the root partition (min is 1.5 GB)?'
MSG_INPUT_CONSOLE_TYPE: str = 'What console should be used by default? (K: KVM, S: Serial)?'
MSG_INPUT_COPY_DATA: str = 'Would you like to copy data to the new image?'
MSG_INPUT_CHOOSE_COPY_DATA: str = 'From which image would you like to save config information?'
MSG_INPUT_COPY_ENC_DATA: str = 'Would you like to copy the encrypted config to the new image?'
MSG_INPUT_CHOOSE_COPY_ENC_DATA: str = 'From which image would you like to copy the encrypted config?'
MSG_WARN_ISO_SIGN_INVALID: str = 'Signature is not valid. Do you want to continue with installation?'
MSG_WARN_ISO_SIGN_UNAVAL: str = 'Signature is not available. Do you want to continue with installation?'
MSG_WARN_ROOT_SIZE_TOOBIG: str = 'The size is too big. Try again.'
MSG_WARN_ROOT_SIZE_TOOSMALL: str = 'The size is too small. Try again'
MSG_WARN_IMAGE_NAME_WRONG: str = 'The suggested name is unsupported!\n'\
'It must be between 1 and 64 characters long and contains only the next characters: .+-_ a-z A-Z 0-9'
MSG_WARN_PASSWORD_CONFIRM: str = 'The entered values did not match. Try again'
CONST_MIN_DISK_SIZE: int = 2147483648  # 2 GB
CONST_MIN_ROOT_SIZE: int = 1610612736  # 1.5 GB
# a reserved space: 2MB for header, 1 MB for BIOS partition, 256 MB for EFI
CONST_RESERVED_SPACE: int = (2 + 1 + 256) * 1024**2

# define directories and paths
DIR_INSTALLATION: str = '/mnt/installation'
DIR_ROOTFS_SRC: str = f'{DIR_INSTALLATION}/root_src'
DIR_ROOTFS_DST: str = f'{DIR_INSTALLATION}/root_dst'
DIR_ISO_MOUNT: str = f'{DIR_INSTALLATION}/iso_src'
DIR_DST_ROOT: str = f'{DIR_INSTALLATION}/disk_dst'
DIR_KERNEL_SRC: str = '/boot/'
FILE_ROOTFS_SRC: str = '/usr/lib/live/mount/medium/live/filesystem.squashfs'
ISO_DOWNLOAD_PATH: str = '/tmp/vyos_installation.iso'

external_download_script = '/usr/libexec/vyos/simple-download.py'

# default boot variables
DEFAULT_BOOT_VARS: dict[str, str] = {
    'timeout': '5',
    'console_type': 'tty',
    'console_num': '0',
    'console_speed': '115200',
    'bootmode': 'normal'
}


def bytes_to_gb(size: int) -> float:
    """Convert Bytes to GBytes, rounded to 1 decimal number

    Args:
        size (int): input size in bytes

    Returns:
        float: size in GB
    """
    return round(size / 1024**3, 1)


def gb_to_bytes(size: float) -> int:
    """Convert GBytes to Bytes

    Args:
        size (float): input size in GBytes

    Returns:
        int: size in bytes
    """
    return int(size * 1024**3)


def find_disks() -> dict[str, int]:
    """Find a target disk for installation

    Returns:
        dict[str, int]: a list of available disks by name and size
    """
    # check for available disks
    print('Probing disks')
    disks_available: dict[str, int] = disk.disks_size()
    for disk_name, disk_size in disks_available.copy().items():
        if disk_size < CONST_MIN_DISK_SIZE:
            del disks_available[disk_name]
    if not disks_available:
        print(MSG_ERR_NO_DISK)
        exit(MSG_INFO_INSTALL_EXIT)

    num_disks: int = len(disks_available)
    print(f'{num_disks} disk(s) found')

    return disks_available


def ask_root_size(available_space: int) -> int:
    """Define a size of root partition

    Args:
        available_space (int): available space in bytes for a root partition

    Returns:
        int: defined size
    """
    if ask_yes_no(MSG_INPUT_ROOT_SIZE_ALL, default=True):
        return available_space

    while True:
        root_size_gb: str = ask_input(MSG_INPUT_ROOT_SIZE_SET)
        root_size_kbytes: int = (gb_to_bytes(float(root_size_gb))) // 1024

        if root_size_kbytes > available_space:
            print(MSG_WARN_ROOT_SIZE_TOOBIG)
            continue
        if root_size_kbytes < CONST_MIN_ROOT_SIZE / 1024:
            print(MSG_WARN_ROOT_SIZE_TOOSMALL)
            continue

        return root_size_kbytes

def create_partitions(target_disk: str, target_size: int,
                      prompt: bool = True) -> None:
    """Create partitions on a target disk

    Args:
        target_disk (str): a target disk
        target_size (int): size of disk in bytes
    """
    # define target rootfs size in KB (smallest unit acceptable by sgdisk)
    available_size: int = (target_size - CONST_RESERVED_SPACE) // 1024
    if prompt:
        rootfs_size: int = ask_root_size(available_size)
    else:
        rootfs_size: int = available_size

    print(MSG_INFO_INSTALL_PARTITONING)
    raid.clear()
    disk.disk_cleanup(target_disk)
    disk_details: disk.DiskDetails = disk.parttable_create(target_disk,
                                                           rootfs_size)

    return disk_details


def search_format_selection(image: tuple[str, str]) -> str:
    """Format a string for selection of image

    Args:
        image (tuple[str, str]): a tuple of image name and drive

    Returns:
        str: formatted string
    """
    return f'{image[0]} on {image[1]}'


def search_previous_installation(disks: list[str]) -> None:
    """Search disks for previous installation config and SSH keys

    Args:
        disks (list[str]): a list of available disks
    """
    mnt_config = '/mnt/config'
    mnt_encrypted_config = '/mnt/encrypted_config'
    mnt_ssh = '/mnt/ssh'
    mnt_tmp = '/mnt/tmp'
    rmtree(Path(mnt_config), ignore_errors=True)
    rmtree(Path(mnt_ssh), ignore_errors=True)
    Path(mnt_tmp).mkdir(exist_ok=True)
    Path(mnt_encrypted_config).unlink(missing_ok=True)

    print('Searching for data from previous installations')
    image_data = []
    encrypted_configs = []
    for disk_name in disks:
        for partition in disk.partition_list(disk_name):
            if disk.partition_mount(partition, mnt_tmp):
                if Path(mnt_tmp + '/boot').exists():
                    for path in Path(mnt_tmp + '/boot').iterdir():
                        if path.joinpath('rw/config/.vyatta_config').exists():
                            image_data.append((path.name, partition))
                if Path(mnt_tmp + '/luks').exists():
                    for path in Path(mnt_tmp + '/luks').iterdir():
                        encrypted_configs.append((path.name, partition))

                disk.partition_umount(partition)

    image_name = None
    image_drive = None
    encrypted = False

    if len(image_data) > 0:
        if len(image_data) == 1:
            print('Found data from previous installation:')
            print(f'\t{" on ".join(image_data[0])}')
            if ask_yes_no(MSG_INPUT_COPY_DATA, default=True):
                image_name, image_drive = image_data[0]

        elif len(image_data) > 1:
            print('Found data from previous installations')
            if ask_yes_no(MSG_INPUT_COPY_DATA, default=True):
                image_name, image_drive = select_entry(image_data,
                                                       'Available versions:',
                                                       MSG_INPUT_CHOOSE_COPY_DATA,
                                                       search_format_selection)
    elif len(encrypted_configs) > 0:
        if len(encrypted_configs) == 1:
            print('Found encrypted config from previous installation:')
            print(f'\t{" on ".join(encrypted_configs[0])}')
            if ask_yes_no(MSG_INPUT_COPY_ENC_DATA, default=True):
                image_name, image_drive = encrypted_configs[0]
                encrypted = True

        elif len(encrypted_configs) > 1:
            print('Found encrypted configs from previous installations')
            if ask_yes_no(MSG_INPUT_COPY_ENC_DATA, default=True):
                image_name, image_drive = select_entry(encrypted_configs,
                                          'Available versions:',
                                          MSG_INPUT_CHOOSE_COPY_ENC_DATA,
                                          search_format_selection)
                encrypted = True

    else:
        print('No previous installation found')
        return

    if not image_name:
        return

    disk.partition_mount(image_drive, mnt_tmp)

    if not encrypted:
        copytree(f'{mnt_tmp}/boot/{image_name}/rw/config', mnt_config)
    else:
        copy(f'{mnt_tmp}/luks/{image_name}', mnt_encrypted_config)

    Path(mnt_ssh).mkdir()
    host_keys: list[str] = glob(f'{mnt_tmp}/boot/{image_name}/rw/etc/ssh/ssh_host*')
    for host_key in host_keys:
        copy(host_key, mnt_ssh)

    disk.partition_umount(image_drive)

def copy_preserve_owner(src: str, dst: str, *, follow_symlinks=True):
    if not Path(src).is_file():
        return
    if Path(dst).is_dir():
        dst = Path(dst).joinpath(Path(src).name)
    st = Path(src).stat()
    copy(src, dst, follow_symlinks=follow_symlinks)
    chown(dst, user=st.st_uid)


def copy_previous_installation_data(target_dir: str) -> None:
    if Path('/mnt/config').exists():
        copytree('/mnt/config', f'{target_dir}/opt/vyatta/etc/config',
                 dirs_exist_ok=True)
    if Path('/mnt/ssh').exists():
        copytree('/mnt/ssh', f'{target_dir}/etc/ssh',
                 dirs_exist_ok=True)


def copy_previous_encrypted_config(target_dir: str, image_name: str) -> None:
    if Path('/mnt/encrypted_config').exists():
        Path(target_dir).mkdir(exist_ok=True)
        copy('/mnt/encrypted_config', Path(target_dir).joinpath(image_name))


def ask_single_disk(disks_available: dict[str, int]) -> str:
    """Ask user to select a disk for installation

    Args:
        disks_available (dict[str, int]): a list of available disks
    """
    print(MSG_INFO_INSTALL_DISKS_LIST)
    default_disk: str = list(disks_available)[0]
    for disk_name, disk_size in disks_available.items():
        disk_size_human: str = bytes_to_gb(disk_size)
        print(f'Drive: {disk_name} ({disk_size_human} GB)')
    disk_selected: str = ask_input(MSG_INFO_INSTALL_DISK_SELECT,
                                   default=default_disk,
                                   valid_responses=list(disks_available))

    # create partitions
    if not ask_yes_no(MSG_INFO_INSTALL_DISK_CONFIRM):
        print(MSG_INFO_INSTALL_EXIT)
        exit()

    search_previous_installation(list(disks_available))

    disk_details: disk.DiskDetails = create_partitions(disk_selected,
                                                       disks_available[disk_selected])

    disk.filesystem_create(disk_details.partition['efi'], 'efi')
    disk.filesystem_create(disk_details.partition['root'], 'ext4')

    return disk_details


def check_raid_install(disks_available: dict[str, int]) -> Union[str, None]:
    """Ask user to select disks for RAID installation

    Args:
        disks_available (dict[str, int]): a list of available disks
    """
    if len(disks_available) < 2:
        return None

    if not ask_yes_no(MSG_INFO_INSTALL_RAID_CONFIGURE, default=True):
        return None

    def format_selection(disk_name: str) -> str:
        return f'{disk_name}\t({bytes_to_gb(disks_available[disk_name])} GB)'

    disk0, disk1 = list(disks_available)[0], list(disks_available)[1]
    disks_selected: dict[str, int] = { disk0: disks_available[disk0],
                                       disk1: disks_available[disk1] }

    target_size: int = min(disks_selected[disk0], disks_selected[disk1])

    print(MSG_INFO_INSTALL_DISKS_LIST)
    for disk_name, disk_size in disks_selected.items():
        disk_size_human: str = bytes_to_gb(disk_size)
        print(f'\t{disk_name} ({disk_size_human} GB)')
    if not ask_yes_no(MSG_INFO_INSTALL_RAID_FOUND_DISKS, default=True):
        if not ask_yes_no(MSG_INFO_INSTALL_RAID_CHOOSE_DISKS, default=True):
            return None
        else:
            disks_selected = {}
            disk0 = select_entry(list(disks_available), 'Disks available:',
                                 'Select first disk:', format_selection)

            disks_selected[disk0] = disks_available[disk0]
            del disks_available[disk0]
            disk1 = select_entry(list(disks_available), 'Remaining disks:',
                                 'Select second disk:', format_selection)
            disks_selected[disk1] = disks_available[disk1]

            target_size: int = min(disks_selected[disk0],
                                   disks_selected[disk1])

    # create partitions
    if not ask_yes_no(MSG_INFO_INSTALL_RAID_CONFIRM):
        print(MSG_INFO_INSTALL_EXIT)
        exit()

    search_previous_installation(list(disks_available))

    disks: list[disk.DiskDetails] = []
    for disk_selected in list(disks_selected):
        print(f'Creating partitions on {disk_selected}')
        disk_details = create_partitions(disk_selected, target_size,
                                         prompt=False)
        disk.filesystem_create(disk_details.partition['efi'], 'efi')

        disks.append(disk_details)

    print('Creating RAID array')
    members = [disk.partition['root'] for disk in disks]
    raid_details: raid.RaidDetails = raid.raid_create(members)
    # raid init stuff
    print('Updating initramfs')
    raid.update_initramfs()
    # end init
    print('Creating filesystem on RAID array')
    disk.filesystem_create(raid_details.name, 'ext4')

    return raid_details


def prepare_tmp_disr() -> None:
    """Create temporary directories for installation
    """
    print('Creating temporary directories')
    for dir in [DIR_ROOTFS_SRC, DIR_ROOTFS_DST, DIR_DST_ROOT]:
        dirpath = Path(dir)
        dirpath.mkdir(mode=0o755, parents=True)


def setup_grub(root_dir: str) -> None:
    """Install GRUB configurations

    Args:
        root_dir (str): a path to the root of target filesystem
    """
    print('Installing GRUB configuration files')
    grub_cfg_main = f'{root_dir}/{grub.GRUB_DIR_MAIN}/grub.cfg'
    grub_cfg_vars = f'{root_dir}/{grub.CFG_VYOS_VARS}'
    grub_cfg_modules = f'{root_dir}/{grub.CFG_VYOS_MODULES}'
    grub_cfg_menu = f'{root_dir}/{grub.CFG_VYOS_MENU}'
    grub_cfg_options = f'{root_dir}/{grub.CFG_VYOS_OPTIONS}'

    # create new files
    render(grub_cfg_main, grub.TMPL_GRUB_MAIN, {})
    grub.common_write(root_dir)
    grub.vars_write(grub_cfg_vars, DEFAULT_BOOT_VARS)
    grub.modules_write(grub_cfg_modules, [])
    grub.write_cfg_ver(1, root_dir)
    render(grub_cfg_menu, grub.TMPL_GRUB_MENU, {})
    render(grub_cfg_options, grub.TMPL_GRUB_OPTS, {})


def configure_authentication(config_file: str, password: str) -> None:
    """Write encrypted password to config file

    Args:
        config_file (str): path of target config file
        password (str): plaintext password

    N.B. this can not be deferred by simply setting the plaintext password
    and relying on the config mode script to process at boot, as the config
    will not automatically be saved in that case, thus leaving the
    plaintext exposed
    """
    encrypted_password = linux_context.hash(password)

    with open(config_file) as f:
        config_string = f.read()

    config = ConfigTree(config_string)
    config.set([
        'system', 'login', 'user', 'vyos', 'authentication',
        'encrypted-password'
    ],
               value=encrypted_password,
               replace=True)
    config.set_tag(['system', 'login', 'user'])

    with open(config_file, 'w') as f:
        f.write(config.to_string())

def validate_signature(file_path: str, sign_type: str) -> None:
    """Validate a file by signature and delete a signature file

    Args:
        file_path (str): a path to file
        sign_type (str): a signature type
    """
    print('Validating signature')
    signature_valid: bool = False
    # validate with minisig
    if sign_type == 'minisig':
        pub_key_list = glob('/usr/share/vyos/keys/*.minisign.pub')
        for pubkey in pub_key_list:
            if run(f'minisign -V -q -p {pubkey} -m {file_path} -x {file_path}.minisig'
                  ) == 0:
                signature_valid = True
                break
        Path(f'{file_path}.minisig').unlink()
    # validate with GPG
    if sign_type == 'asc':
        if run(f'gpg --verify ${file_path}.asc ${file_path}') == 0:
            signature_valid = True
        Path(f'{file_path}.asc').unlink()

    # warn or pass
    if not signature_valid:
        if not ask_yes_no(MSG_WARN_ISO_SIGN_INVALID, default=False):
            exit(MSG_INFO_INSTALL_EXIT)
    else:
        print('Signature is valid')

def download_file(local_file: str, remote_path: str, vrf: str,
                  username: str, password: str,
                  progressbar: bool = False, check_space: bool = False):
    environ['REMOTE_USERNAME'] = username
    environ['REMOTE_PASSWORD'] = password
    if vrf is None:
        download(local_file, remote_path, progressbar=progressbar,
                 check_space=check_space, raise_error=True)
    else:
        vrf_cmd = f'REMOTE_USERNAME={username} REMOTE_PASSWORD={password} \
                ip vrf exec {vrf} {external_download_script} \
                --local-file {local_file} --remote-path {remote_path}'
        cmd(vrf_cmd)

def image_fetch(image_path: str, vrf: str = None,
                username: str = '', password: str = '',
                no_prompt: bool = False) -> Path:
    """Fetch an ISO image

    Args:
        image_path (str): a path, remote or local

    Returns:
        Path: a path to a local file
    """
    # Latest version gets url from configured "system update-check url"
    if image_path == 'latest':
        config = ConfigTreeQuery()
        if config.exists('system update-check url'):
            configured_url_version = config.value('system update-check url')
            remote_url_list = get_remote_version(configured_url_version)
            image_path = remote_url_list[0].get('url')

    try:
        # check a type of path
        if urlparse(image_path).scheme:
            # download an image
            download_file(ISO_DOWNLOAD_PATH, image_path, vrf,
                          username, password,
                          progressbar=True, check_space=True)

            # download a signature
            sign_file = (False, '')
            for sign_type in ['minisig', 'asc']:
                try:
                    download_file(f'{ISO_DOWNLOAD_PATH}.{sign_type}',
                                  f'{image_path}.{sign_type}', vrf,
                                  username, password)
                    sign_file = (True, sign_type)
                    break
                except Exception:
                    print(f'{sign_type} signature is not available')
            # validate a signature if it is available
            if sign_file[0]:
                validate_signature(ISO_DOWNLOAD_PATH, sign_file[1])
            else:
                if (not no_prompt and
                    not ask_yes_no(MSG_WARN_ISO_SIGN_UNAVAL, default=False)):
                    cleanup()
                    exit(MSG_INFO_INSTALL_EXIT)

            return Path(ISO_DOWNLOAD_PATH)
        else:
            local_path: Path = Path(image_path)
            if local_path.is_file():
                return local_path
            else:
                raise FileNotFoundError
    except Exception as e:
        print(f'The image cannot be fetched from: {image_path} {e}')
        exit(1)


def migrate_config() -> bool:
    """Check for active config and ask user for migration

    Returns:
        bool: user's decision
    """
    active_config_path: Path = Path('/opt/vyatta/etc/config/config.boot')
    if active_config_path.exists():
        if ask_yes_no(MSG_INPUT_CONFIG_FOUND, default=True):
            return True
    return False


def copy_ssh_host_keys() -> bool:
    """Ask user to copy SSH host keys

    Returns:
        bool: user's decision
    """
    if ask_yes_no('Would you like to copy SSH host keys?', default=True):
        return True
    return False


def cleanup(mounts: list[str] = [], remove_items: list[str] = []) -> None:
    """Clean up after installation

    Args:
        mounts (list[str], optional): List of mounts to unmount.
        Defaults to [].
        remove_items (list[str], optional): List of files or directories
        to remove. Defaults to [].
    """
    print('Cleaning up')
    # clean up installation directory by default
    mounts_all = disk_partitions(all=True)
    for mounted_device in mounts_all:
        if mounted_device.mountpoint.startswith(DIR_INSTALLATION) and not (
                mounted_device.device in mounts or
                mounted_device.mountpoint in mounts):
            mounts.append(mounted_device.mountpoint)
    # add installation dir to cleanup list
    if DIR_INSTALLATION not in remove_items:
        remove_items.append(DIR_INSTALLATION)
    # also delete an ISO file
    if Path(ISO_DOWNLOAD_PATH).exists(
    ) and ISO_DOWNLOAD_PATH not in remove_items:
        remove_items.append(ISO_DOWNLOAD_PATH)

    if mounts:
        print('Unmounting target filesystems')
        for mountpoint in mounts:
            disk.partition_umount(mountpoint)
        for mountpoint in mounts:
            disk.wait_for_umount(mountpoint)
    if remove_items:
        print('Removing temporary files')
        for remove_item in remove_items:
            if Path(remove_item).exists():
                if Path(remove_item).is_file():
                    Path(remove_item).unlink()
                if Path(remove_item).is_dir():
                    rmtree(remove_item, ignore_errors=True)


def cleanup_raid(details: raid.RaidDetails) -> None:
    efiparts = []
    for raid_disk in details.disks:
        efiparts.append(raid_disk.partition['efi'])
    cleanup([details.name, *efiparts],
            ['/mnt/installation'])


def is_raid_install(install_object: Union[disk.DiskDetails, raid.RaidDetails]) -> bool:
    """Check if installation target is a RAID array

    Args:
        install_object (Union[disk.DiskDetails, raid.RaidDetails]): a target disk

    Returns:
        bool: True if it is a RAID array
    """
    if isinstance(install_object, raid.RaidDetails):
        return True
    return False


def install_image() -> None:
    """Install an image to a disk
    """
    if not image.is_live_boot():
        exit(MSG_ERR_NOT_LIVE)

    print(MSG_INFO_INSTALL_WELCOME)
    if not ask_yes_no('Would you like to continue?'):
        print(MSG_INFO_INSTALL_EXIT)
        exit()

    # configure image name
    running_image_name: str = image.get_running_image()
    while True:
        image_name: str = ask_input(MSG_INPUT_IMAGE_NAME,
                                    running_image_name)
        if image.validate_name(image_name):
            break
        print(MSG_WARN_IMAGE_NAME_WRONG)

    # ask for password
    while True:
        user_password: str = ask_input(MSG_INPUT_PASSWORD, no_echo=True,
                                       non_empty=True)
        confirm: str = ask_input(MSG_INPUT_PASSWORD_CONFIRM, no_echo=True,
                                 non_empty=True)
        if user_password == confirm:
            break
        print(MSG_WARN_PASSWORD_CONFIRM)

    # ask for default console
    console_type: str = ask_input(MSG_INPUT_CONSOLE_TYPE,
                                  default='K',
                                  valid_responses=['K', 'S'])
    console_dict: dict[str, str] = {'K': 'tty', 'S': 'ttyS'}

    config_boot_list = ['/opt/vyatta/etc/config/config.boot',
                        '/opt/vyatta/etc/config.boot.default']
    default_config = config_boot_list[0]

    disks: dict[str, int] = find_disks()

    install_target: Union[disk.DiskDetails, raid.RaidDetails, None] = None
    try:
        install_target = check_raid_install(disks)
        if install_target is None:
            install_target = ask_single_disk(disks)

        # if previous install was selected in search_previous_installation,
        # directory /mnt/config was prepared for copy below; if not, prompt:
        if not Path('/mnt/config').exists():
            default_config: str = select_entry(config_boot_list,
                                               MSG_INPUT_CONFIG_CHOICE,
                                               MSG_INPUT_CONFIG_CHOOSE,
                                               default_entry=1) # select_entry indexes from 1

        # create directories for installation media
        prepare_tmp_disr()

        # mount target filesystem and create required dirs inside
        print('Mounting new partitions')
        if is_raid_install(install_target):
            disk.partition_mount(install_target.name, DIR_DST_ROOT)
            Path(f'{DIR_DST_ROOT}/boot/efi').mkdir(parents=True)
        else:
            disk.partition_mount(install_target.partition['root'], DIR_DST_ROOT)
            Path(f'{DIR_DST_ROOT}/boot/efi').mkdir(parents=True)
            disk.partition_mount(install_target.partition['efi'], f'{DIR_DST_ROOT}/boot/efi')

        # a config dir. It is the deepest one, so the comand will
        # create all the rest in a single step
        print('Creating a configuration file')
        target_config_dir: str = f'{DIR_DST_ROOT}/boot/{image_name}/rw/opt/vyatta/etc/config/'
        Path(target_config_dir).mkdir(parents=True)
        chown(target_config_dir, group='vyattacfg')
        chmod_2775(target_config_dir)
        # copy config
        copy(default_config, f'{target_config_dir}/config.boot')
        configure_authentication(f'{target_config_dir}/config.boot',
                                 user_password)
        Path(f'{target_config_dir}/.vyatta_config').touch()

        # create a persistence.conf
        Path(f'{DIR_DST_ROOT}/persistence.conf').write_text('/ union\n')

        # copy system image and kernel files
        print('Copying system image files')
        for file in Path(DIR_KERNEL_SRC).iterdir():
            if file.is_file():
                copy(file, f'{DIR_DST_ROOT}/boot/{image_name}/')
        copy(FILE_ROOTFS_SRC,
             f'{DIR_DST_ROOT}/boot/{image_name}/{image_name}.squashfs')

        # copy saved config data and SSH keys
        # owner restored on copy of config data by chmod_2775, above
        copy_previous_installation_data(f'{DIR_DST_ROOT}/boot/{image_name}/rw')

        # copy saved encrypted config volume
        copy_previous_encrypted_config(f'{DIR_DST_ROOT}/luks', image_name)

        if is_raid_install(install_target):
            write_dir: str = f'{DIR_DST_ROOT}/boot/{image_name}/rw'
            raid.update_default(write_dir)

        setup_grub(DIR_DST_ROOT)
        # add information about version
        grub.create_structure()
        grub.version_add(image_name, DIR_DST_ROOT)
        grub.set_default(image_name, DIR_DST_ROOT)
        grub.set_console_type(console_dict[console_type], DIR_DST_ROOT)

        if is_raid_install(install_target):
            # add RAID specific modules
            grub.modules_write(f'{DIR_DST_ROOT}/{grub.CFG_VYOS_MODULES}',
                               ['part_msdos', 'part_gpt', 'diskfilter',
                                'ext2','mdraid1x'])
        # install GRUB
        if is_raid_install(install_target):
            print('Installing GRUB to the drives')
            l = install_target.disks
            for disk_target in l:
                disk.partition_mount(disk_target.partition['efi'], f'{DIR_DST_ROOT}/boot/efi')
                grub.install(disk_target.name, f'{DIR_DST_ROOT}/boot/',
                             f'{DIR_DST_ROOT}/boot/efi',
                             id=f'VyOS (RAID disk {l.index(disk_target) + 1})')
                disk.partition_umount(disk_target.partition['efi'])
        else:
            print('Installing GRUB to the drive')
            grub.install(install_target.name, f'{DIR_DST_ROOT}/boot/',
                         f'{DIR_DST_ROOT}/boot/efi')

        # sort inodes (to make GRUB read config files in alphabetical order)
        grub.sort_inodes(f'{DIR_DST_ROOT}/{grub.GRUB_DIR_VYOS}')
        grub.sort_inodes(f'{DIR_DST_ROOT}/{grub.GRUB_DIR_VYOS_VERS}')

        # umount filesystems and remove temporary files
        if is_raid_install(install_target):
            cleanup([install_target.name],
                    ['/mnt/installation'])
        else:
            cleanup([install_target.partition['efi'],
                     install_target.partition['root']],
                    ['/mnt/installation'])

        # we are done
        print(MSG_INFO_INSTALL_SUCCESS)
        exit()

    except Exception as err:
        print(f'Unable to install VyOS: {err}')
        # unmount filesystems and clenup
        try:
            if install_target is not None:
                if is_raid_install(install_target):
                    cleanup_raid(install_target)
                else:
                    cleanup([install_target.partition['efi'],
                             install_target.partition['root']],
                            ['/mnt/installation'])
        except Exception as err:
            print(f'Cleanup failed: {err}')

        exit(1)


@compat.grub_cfg_update
def add_image(image_path: str, vrf: str = None, username: str = '',
              password: str = '', no_prompt: bool = False) -> None:
    """Add a new image

    Args:
        image_path (str): a path to an ISO image
    """
    if image.is_live_boot():
        exit(MSG_ERR_LIVE)

    # fetch an image
    iso_path: Path = image_fetch(image_path, vrf, username, password, no_prompt)
    try:
        # mount an ISO
        Path(DIR_ISO_MOUNT).mkdir(mode=0o755, parents=True)
        disk.partition_mount(iso_path, DIR_ISO_MOUNT, 'iso9660')

        # check sums
        print('Validating image checksums')
        if not Path(DIR_ISO_MOUNT).joinpath('sha256sum.txt').exists():
            cleanup()
            exit(MSG_ERR_IMPROPER_IMAGE)
        if run(f'cd {DIR_ISO_MOUNT} && sha256sum --status -c sha256sum.txt'):
            cleanup()
            exit('Image checksum verification failed.')

        # mount rootfs (to get a system version)
        Path(DIR_ROOTFS_SRC).mkdir(mode=0o755, parents=True)
        disk.partition_mount(f'{DIR_ISO_MOUNT}/live/filesystem.squashfs',
                             DIR_ROOTFS_SRC, 'squashfs')

        cfg_ver: str = image.get_image_tools_version(DIR_ROOTFS_SRC)
        version_name: str = image.get_image_version(DIR_ROOTFS_SRC)

        disk.partition_umount(f'{DIR_ISO_MOUNT}/live/filesystem.squashfs')

        if cfg_ver < SYSTEM_CFG_VER:
            raise compat.DowngradingImageTools(
                f'Adding image would downgrade image tools to v.{cfg_ver}; disallowed')

        if not no_prompt:
            while True:
                image_name: str = ask_input(MSG_INPUT_IMAGE_NAME, version_name)
                if image.validate_name(image_name):
                    break
                print(MSG_WARN_IMAGE_NAME_WRONG)
            set_as_default: bool = ask_yes_no(MSG_INPUT_IMAGE_DEFAULT, default=True)
        else:
            image_name: str = version_name
            set_as_default: bool = True

        # find target directory
        root_dir: str = disk.find_persistence()

        # a config dir. It is the deepest one, so the comand will
        # create all the rest in a single step
        target_config_dir: str = f'{root_dir}/boot/{image_name}/rw/opt/vyatta/etc/config/'
        # copy config
        if no_prompt or migrate_config():
            print('Copying configuration directory')
            # copytree preserves perms but not ownership:
            Path(target_config_dir).mkdir(parents=True)
            chown(target_config_dir, group='vyattacfg')
            chmod_2775(target_config_dir)
            copytree('/opt/vyatta/etc/config/', target_config_dir,
                     copy_function=copy_preserve_owner, dirs_exist_ok=True)
        else:
            Path(target_config_dir).mkdir(parents=True)
            chown(target_config_dir, group='vyattacfg')
            chmod_2775(target_config_dir)
            Path(f'{target_config_dir}/.vyatta_config').touch()

        target_ssh_dir: str = f'{root_dir}/boot/{image_name}/rw/etc/ssh/'
        if no_prompt or copy_ssh_host_keys():
            print('Copying SSH host keys')
            Path(target_ssh_dir).mkdir(parents=True)
            host_keys: list[str] = glob('/etc/ssh/ssh_host*')
            for host_key in host_keys:
                copy(host_key, target_ssh_dir)

        # copy system image and kernel files
        print('Copying system image files')
        for file in Path(f'{DIR_ISO_MOUNT}/live').iterdir():
            if file.is_file() and (file.match('initrd*') or
                                   file.match('vmlinuz*')):
                copy(file, f'{root_dir}/boot/{image_name}/')
        copy(f'{DIR_ISO_MOUNT}/live/filesystem.squashfs',
             f'{root_dir}/boot/{image_name}/{image_name}.squashfs')

        # unmount an ISO and cleanup
        cleanup([str(iso_path)])

        # add information about version
        grub.version_add(image_name, root_dir)
        if set_as_default:
            grub.set_default(image_name, root_dir)

    except OSError as e:
        # if no space error, remove image dir and cleanup
        if e.errno == ENOSPC:
            cleanup(mounts=[str(iso_path)],
                    remove_items=[f'{root_dir}/boot/{image_name}'])
        else:
            # unmount an ISO and cleanup
            cleanup([str(iso_path)])
        exit(f'Error: {e}')

    except Exception as err:
        # unmount an ISO and cleanup
        cleanup([str(iso_path)])
        exit(f'Error: {err}')


def parse_arguments() -> Namespace:
    """Parse arguments

    Returns:
        Namespace: a namespace with parsed arguments
    """
    parser: ArgumentParser = ArgumentParser(
        description='Install new system images')
    parser.add_argument('--action',
                        choices=['install', 'add'],
                        required=True,
                        help='action to perform with an image')
    parser.add_argument('--vrf',
                        help='vrf name for image download')
    parser.add_argument('--no-prompt', action='store_true',
                        help='perform action non-interactively')
    parser.add_argument('--username', default='',
                        help='username for image download')
    parser.add_argument('--password', default='',
                        help='password for image download')
    parser.add_argument('--image-path',
        help='a path (HTTP or local file) to an image that needs to be installed'
    )
    # parser.add_argument('--image_new_name', help='a new name for image')
    args: Namespace = parser.parse_args()
    # Validate arguments
    if args.action == 'add' and not args.image_path:
        exit('A path to image is required for add action')

    return args


if __name__ == '__main__':
    try:
        args: Namespace = parse_arguments()
        if args.action == 'install':
            install_image()
        if args.action == 'add':
            add_image(args.image_path, args.vrf,
                      args.username, args.password, args.no_prompt)

        exit()

    except KeyboardInterrupt:
        print('Stopped by Ctrl+C')
        cleanup()
        exit()

    except Exception as err:
        exit(f'{err}')