getch 0.0.5 → 0.1.0

data/lib/getch/filesystem/zfs/deps.rb

@@ -0,0 +1,90 @@
+module Getch
+  module FileSystem
+    module Zfs
+      class Deps < Getch::FileSystem::Zfs::Device
+        def initialize
+          super
+          install_deps
+          zfs_mountpoint
+          auto_module_rebuild
+        end
+
+        def make
+          hostid
+          options_make
+          Getch::Make.new("genkernel --kernel-config=/usr/src/linux/.config all").run!
+        end
+
+        private
+        def install_deps
+          exec("euse -E libzfs") if ! Helpers::grep?("#{MOUNTPOINT}/etc/portage/make.conf", /libzfs/)
+          exec("euse -E rootfs") if ! Helpers::grep?("#{MOUNTPOINT}/etc/portage/make.conf", /rootfs/)
+          Getch::Garden.new('-a zfs').run!
+          Getch::Make.new("make modules_prepare").run!
+          Getch::Make.new("make -j$(nproc)").run!
+          Getch::Emerge.new('genkernel sys-fs/zfs').pkg!
+        end
+
+        # See: https://wiki.archlinux.org/index.php/ZFS#Using_zfs-mount-generator
+        def zfs_mountpoint
+          Helpers::mkdir("#{MOUNTPOINT}/etc/zfs/zfs-list.cache")
+          Helpers::touch("#{MOUNTPOINT}/etc/zfs/zfs-list.cache/#{@boot_pool_name}") if @dev_boot
+          Helpers::touch("#{MOUNTPOINT}/etc/zfs/zfs-list.cache/#{@pool_name}")
+          exec("ln -fs /usr/libexec/zfs/zed.d/history_event-zfs-list-cacher.sh /etc/zfs/zed.d/")
+          exec("systemctl start zfs-zed.service")
+          Helpers::sys("sed -Ei \"s|/mnt/?|/|\" #{MOUNTPOINT}/etc/zfs/zfs-list.cache/*")
+          exec("systemctl enable zfs-zed.service")
+          exec("systemctl enable zfs.target")
+        end
+
+        def auto_module_rebuild
+          g_dir="#{MOUNTPOINT}/etc/portage/env/sys-kernel"
+          Helpers::mkdir(g_dir)
+          # See https://wiki.gentoo.org/wiki/Kernel/Upgrade#Automated_build_and_installation
+          content=<<EOF
+post_pkg_postinst() {
+  # BUG: reinstalls of a source will cause errors
+  CURRENT_KV=$(uname -r)
+  # Check to see if genkernel has been run previously for the running kernel and use that config
+  if [[ -f "${EROOT}/etc/kernels/kernel-config-${CURRENT_KV}" ]] ; then
+    genkernel --kernel-config="${EROOT}/etc/kernels/kernel-config-${CURRENT_KV}" all
+  elif [[ -f "${EROOT}/usr/src/linux-${CURRENT_KV}/.config" ]] ; then # Use latest kernel config from current kernel
+    genkernel --kernel-config="${EROOT}/usr/src/linux-${CURRENT_KV}/.config" all
+  else # No valid configs known
+    genkernel all
+  fi
+}
+EOF
+          File.write("#{g_dir}/gentoo-sources", content)
+        end
+
+        def hostid
+          hostid_value=`hostid`.chomp
+          File.write("#{MOUNTPOINT}/etc/hostid", hostid_value, mode: 'w')
+        end
+
+        def options_make
+          bootloader = Helpers::efi? ? 'BOOTLOADER="no"' : 'BOOTLOADER="grub2"'
+          datas = [
+            '',
+            bootloader,
+            'INSTALL="yes"',
+            'MENUCONFIG="no"',
+            'CLEAN="yes"',
+            'SAVE_CONFIG="yes"',
+            'MOUNTBOOT="no"',
+            'MRPROPER="no"',
+            'ZFS="yes"',
+            'MODULEREBUILD="yes"'
+          ]
+          file = "#{MOUNTPOINT}/etc/genkernel.conf"
+          File.write(file, datas.join("\n"), mode: 'a')
+        end
+
+        def exec(cmd)
+          Getch::Chroot.new(cmd).run!
+        end
+      end
+    end
+  end
+end

data/lib/getch/filesystem/zfs/device.rb

@@ -0,0 +1,19 @@
+module Getch
+  module FileSystem
+    module Zfs
+      class Device
+        def initialize
+          @disk = DEFAULT_OPTIONS[:disk]
+          @user = DEFAULT_OPTIONS[:username]
+          @dev_boot_efi = Helpers::efi? ? "/dev/#{@disk}1" : nil
+          @dev_boot = Helpers::efi? ? nil : "/dev/#{@disk}2"
+          @dev_swap = Helpers::efi? ? "/dev/#{@disk}2" : "/dev/#{@disk}3"
+          @dev_root = Helpers::efi? ? "/dev/#{@disk}3" : "/dev/#{@disk}4"
+          @boot_pool_name = 'bpool'
+          @pool_name = 'zpool'
+          @zfs_home = @user ? true : false
+        end
+      end
+    end
+  end
+end

data/lib/getch/filesystem/zfs/encrypt.rb

@@ -0,0 +1,15 @@
+module Getch
+  module FileSystem
+    module Zfs
+      module Encrypt
+      end
+    end
+  end
+end
+
+require_relative 'encrypt/device'
+require_relative 'encrypt/partition'
+require_relative 'encrypt/format'
+require_relative 'encrypt/mount'
+require_relative 'encrypt/config'
+require_relative 'encrypt/deps'

data/lib/getch/filesystem/zfs/encrypt/config.rb

@@ -0,0 +1,67 @@
+module Getch
+  module FileSystem
+    module Zfs
+      module Encrypt
+        class Config < Getch::FileSystem::Zfs::Encrypt::Device
+          def initialize
+            super
+            gen_uuid
+            @root_dir = MOUNTPOINT
+            @init = '/usr/lib/systemd/systemd'
+            crypttab
+          end
+
+          def fstab
+            file = "#{@root_dir}/etc/fstab"
+            datas = data_fstab
+            File.write(file, datas.join("\n"))
+          end
+
+          def systemd_boot
+            return if ! Helpers::efi? 
+            esp = '/boot/efi'
+            dir = "#{@root_dir}/#{esp}/loader/entries/"
+            datas_gentoo = [
+              'title Gentoo Linux',
+              'linux /vmlinuz',
+              'initrd /initramfs',
+              "options root=ZFS=#{@pool_name}/ROOT/gentoo init=#{@init} dozfs keymap=#{DEFAULT_OPTIONS[:keymap]}"
+            ]
+            File.write("#{dir}/gentoo.conf", datas_gentoo.join("\n"))
+          end
+
+          def crypttab
+            datas = [
+              "cryptswap UUID=#{@uuid_swap} /dev/urandom swap,cipher=aes-xts-plain64:sha256,size=256"
+            ]
+            File.write("#{@root_dir}/etc/crypttab", datas.join("\n"))
+          end
+
+          # See https://wiki.gentoo.org/wiki/ZFS#ZFS_root
+          def grub
+            return if Helpers::efi?
+            file = "#{@root_dir}/etc/default/grub"
+            cmdline = [ 
+              "GRUB_CMDLINE_LINUX=\"root=ZFS=#{@pool_name}/ROOT/gentoo init=#{@init} dozfs keymap=#{DEFAULT_OPTIONS[:keymap]}\""
+            ]
+            File.write("#{file}", cmdline.join("\n"), mode: 'a')
+          end
+
+          private
+
+          def gen_uuid
+            @uuid_swap = `lsblk -o "UUID" #{@dev_swap} | tail -1`.chomp()
+            @uuid_boot_efi = `lsblk -o "UUID" #{@dev_boot_efi} | tail -1`.chomp() if @dev_boot_efi
+          end
+
+          def data_fstab
+            boot_efi = @dev_boot_efi ? "UUID=#{@uuid_boot_efi} /boot/efi vfat noauto,noatime 1 2" : ''
+            swap = @dev_swap ? "/dev/mapper/cryptswap none swap discard 0 0" : ''
+
+            [ boot_efi, swap ]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/getch/filesystem/zfs/encrypt/deps.rb

@@ -0,0 +1,94 @@
+module Getch
+  module FileSystem
+    module Zfs
+      module Encrypt
+        class Deps < Getch::FileSystem::Zfs::Encrypt::Device
+          def initialize
+            super
+            install_deps
+            zfs_mountpoint
+            auto_module_rebuild
+          end
+
+          def make
+            hostid
+            options_make
+            Getch::Make.new("genkernel --kernel-config=/usr/src/linux/.config all").run!
+          end
+
+          private
+          def install_deps
+            exec("euse -E libzfs") if ! Helpers::grep?("#{MOUNTPOINT}/etc/portage/make.conf", /libzfs/)
+            exec("euse -E rootfs") if ! Helpers::grep?("#{MOUNTPOINT}/etc/portage/make.conf", /rootfs/)
+            exec("euse -E cryptsetup") if ! Helpers::grep?("#{MOUNTPOINT}/etc/portage/make.conf", /cryptsetup/)
+            Getch::Garden.new('-a zfs').run!
+            Getch::Make.new("make modules_prepare").run!
+            Getch::Make.new("make -j$(nproc)").run!
+            Getch::Emerge.new('genkernel sys-fs/zfs sys-apps/systemd sys-fs/cryptsetup').pkg!
+          end
+
+          # See: https://wiki.archlinux.org/index.php/ZFS#Using_zfs-mount-generator
+          def zfs_mountpoint
+            Helpers::mkdir("#{MOUNTPOINT}/etc/zfs/zfs-list.cache")
+            Helpers::touch("#{MOUNTPOINT}/etc/zfs/zfs-list.cache/#{@boot_pool_name}") if @dev_boot
+            Helpers::touch("#{MOUNTPOINT}/etc/zfs/zfs-list.cache/#{@pool_name}")
+            exec("ln -fs /usr/libexec/zfs/zed.d/history_event-zfs-list-cacher.sh /etc/zfs/zed.d/")
+            exec("systemctl start zfs-zed.service")
+            Helpers::sys("sed -Ei \"s|/mnt/?|/|\" #{MOUNTPOINT}/etc/zfs/zfs-list.cache/*")
+            exec("systemctl enable zfs-zed.service")
+            exec("systemctl enable zfs.target")
+          end
+
+          def auto_module_rebuild
+            g_dir="#{MOUNTPOINT}/etc/portage/env/sys-kernel"
+            Helpers::mkdir(g_dir)
+            # See https://wiki.gentoo.org/wiki/Kernel/Upgrade#Automated_build_and_installation
+            content=<<EOF
+post_pkg_postinst() {
+  # BUG: reinstalls of a source will cause errors
+  CURRENT_KV=$(uname -r)
+  # Check to see if genkernel has been run previously for the running kernel and use that config
+  if [[ -f "${EROOT}/etc/kernels/kernel-config-${CURRENT_KV}" ]] ; then
+    genkernel --kernel-config="${EROOT}/etc/kernels/kernel-config-${CURRENT_KV}" all
+  elif [[ -f "${EROOT}/usr/src/linux-${CURRENT_KV}/.config" ]] ; then # Use latest kernel config from current kernel
+    genkernel --kernel-config="${EROOT}/usr/src/linux-${CURRENT_KV}/.config" all
+  else # No valid configs known
+    genkernel all
+  fi
+}
+EOF
+            File.write("#{g_dir}/gentoo-sources", content)
+          end
+
+          def hostid
+            hostid_value=`hostid`.chomp
+            File.write("#{MOUNTPOINT}/etc/hostid", hostid_value, mode: 'w')
+          end
+
+          def options_make
+            bootloader = Helpers::efi? ? 'BOOTLOADER="no"' : 'BOOTLOADER="grub2"'
+            datas = [
+              '',
+              bootloader,
+              'INSTALL="yes"',
+              'MENUCONFIG="no"',
+              'CLEAN="yes"',
+              'KEYMAP="yes"',
+              'SAVE_CONFIG="yes"',
+              'MOUNTBOOT="no"',
+              'MRPROPER="no"',
+              'ZFS="yes"',
+              'MODULEREBUILD="yes"'
+            ]
+            file = "#{MOUNTPOINT}/etc/genkernel.conf"
+            File.write(file, datas.join("\n"), mode: 'a')
+          end
+
+          def exec(cmd)
+            Getch::Chroot.new(cmd).run!
+          end
+        end
+      end
+    end
+  end
+end

data/lib/getch/filesystem/zfs/encrypt/device.rb

@@ -0,0 +1,21 @@
+module Getch
+  module FileSystem
+    module Zfs
+      module Encrypt
+        class Device
+          def initialize
+            @disk = DEFAULT_OPTIONS[:disk]
+            @user = DEFAULT_OPTIONS[:username]
+            @dev_boot_efi = Helpers::efi? ? "/dev/#{@disk}1" : nil
+            @dev_boot = Helpers::efi? ? nil : "/dev/#{@disk}2"
+            @dev_swap = Helpers::efi? ? "/dev/#{@disk}2" : "/dev/#{@disk}3"
+            @dev_root = Helpers::efi? ? "/dev/#{@disk}3" : "/dev/#{@disk}4"
+            @boot_pool_name = 'bpool'
+            @pool_name = 'zpool'
+            @zfs_home = @user ? true : false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/getch/filesystem/zfs/encrypt/format.rb

@@ -0,0 +1,22 @@
+module Getch
+  module FileSystem
+    module Zfs
+      module Encrypt
+        class Format < Getch::FileSystem::Zfs::Encrypt::Device
+          def initialize
+            super
+            @state = Getch::States.new()
+            format
+          end
+
+          def format
+            return if STATES[:format]
+            system("mkfs.fat -F32 #{@dev_boot_efi}") if @dev_boot_efi
+            system("mkswap -f #{@dev_swap}")
+            @state.format
+          end
+        end
+      end
+    end
+  end
+end

data/lib/getch/filesystem/zfs/encrypt/mount.rb

@@ -0,0 +1,67 @@
+require 'fileutils'
+
+module Getch
+  module FileSystem
+    module Zfs
+      module Encrypt
+        class Mount < Getch::FileSystem::Zfs::Encrypt::Device
+          def initialize
+            super
+            @root_dir = MOUNTPOINT
+            @boot_dir = "#{@root_dir}/boot"
+            @boot_efi_dir = "#{@root_dir}/boot/efi"
+            @state = Getch::States.new()
+            @log = Getch::Log.new
+          end
+
+          def run
+            return if STATES[:mount]
+            exec("zpool export -a")
+            exec("rm -rf #{MOUNTPOINT}/*")
+            exec("zpool import -N -R #{MOUNTPOINT} #{@pool_name}")
+            exec("zpool import -N -R #{MOUNTPOINT} #{@boot_pool_name}") if @dev_boot
+            exec("zfs load-key -a")
+            mount_swap
+            mount_root
+            mount_boot
+            mount_boot_efi
+            exec("zfs mount -a")
+            @state.mount
+          end
+
+          private
+
+          def mount_swap
+            if Helpers::grep?('/proc/swaps', /^\/dev/)
+              exec("swapoff #{@dev_swap}")
+            end
+
+            exec("swapon #{@dev_swap}")
+          end
+
+          def mount_root
+            Helpers::mkdir(@root_dir)
+            exec("zfs mount #{@pool_name}/ROOT/gentoo")
+          end
+
+          def mount_boot_efi
+            return if ! @dev_boot_efi
+            Helpers::mkdir(@boot_efi_dir)
+            exec("mount #{@dev_boot_efi} #{@boot_efi_dir}")
+          end
+
+          def mount_boot
+            return if ! @dev_boot
+            Helpers::mkdir(@boot_dir)
+            exec("zfs mount #{@boot_pool_name}/BOOT/gentoo")
+          end
+
+          def exec(cmd)
+            @log.info("==> #{cmd}")
+            Helpers::sys(cmd)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/getch/filesystem/zfs/encrypt/partition.rb

@@ -0,0 +1,151 @@
+module Getch
+  module FileSystem
+    module Zfs
+      module Encrypt
+        class Partition < Getch::FileSystem::Zfs::Encrypt::Device
+          def initialize
+            super
+            @state = Getch::States.new()
+            @log = Getch::Log.new()
+            run_partition
+          end
+
+          def run_partition
+            return if STATES[:partition ]
+            clear_struct
+            cleaning
+            partition
+            zfs
+            @state.partition
+          end
+
+          private
+
+          def clear_struct
+            oldvg = `vgdisplay | grep #{@vg}`.chomp
+            oldzpool = `zpool status | grep pool:`.gsub(/pool: /, '').delete(' ').split("\n")
+            if oldzpool[0] != "" and $?.success?
+              oldzpool.each { |p| exec("zpool destroy #{p}") if p }
+            end
+            exec("vgremove -f #{@vg}") if oldvg != '' # remove older volume group
+            exec("pvremove -f #{@dev_root}") if oldvg != '' and File.exist? @dev_root # remove older volume group
+
+            exec("sgdisk -Z /dev/#{@disk}")
+            exec("wipefs -a /dev/#{@disk}")
+          end
+
+          # See https://wiki.archlinux.org/index.php/Solid_state_drive/Memory_cell_clearing
+          # for SSD
+          def cleaning
+            @bloc=`blockdev --getbsz /dev/#{@disk}`.chomp
+            puts
+            print "Cleaning data on #{@disk}, can be long, avoid this on Flash Memory (SSD,USB,...) ? (n,y) "
+            case gets.chomp
+            when /^y|^Y/
+              exec("dd if=/dev/urandom of=/dev/#{@disk} bs=#{@bloc} status=progress")
+            else
+              return
+            end
+          end
+
+          def partition
+            mem=`awk '/MemTotal/ {print $2}' /proc/meminfo`.chomp + 'K'
+            if Helpers::efi?
+              exec("sgdisk -n1:1M:+260M -t1:EF00 /dev/#{@disk}")
+              exec("sgdisk -n2:0:+#{mem} -t2:8200 /dev/#{@disk}")
+              exec("sgdisk -n3:0:+0 -t3:BF00 /dev/#{@disk}")
+            else
+              exec("sgdisk -n1:1MiB:+1MiB -t1:EF02 /dev/#{@disk}")
+              exec("sgdisk -n2:0:+2G -t2:BE00 /dev/#{@disk}") # boot pool GRUB
+              exec("sgdisk -n3:0:+#{mem} -t3:8200 /dev/#{@disk}")
+              exec("sgdisk -n4:0:+0 -t4:BF00 /dev/#{@disk}")
+            end
+          end
+
+          def zfs
+            ashift = case @bloc
+                     when 8096
+                       13
+                     when 4096
+                       12
+                     else # 512
+                       9
+                     end
+
+            Helpers::mkdir(MOUNTPOINT)
+
+            @log.debug("ashift found for #{@bloc} - #{ashift}")
+            if ! Helpers::efi? 
+              # https://openzfs.github.io/openzfs-docs/Getting%20Started/Ubuntu/Ubuntu%2020.04%20Root%20on%20ZFS.html
+              @log.info("Creating boot pool on #{@pool_name}")
+              exec("zpool create -f \\
+                -o ashift=#{ashift} -d \\
+                -o feature@async_destroy=enabled \\
+                -o feature@bookmarks=enabled \\
+                -o feature@embedded_data=enabled \\
+                -o feature@empty_bpobj=enabled \\
+                -o feature@enabled_txg=enabled \\
+                -o feature@extensible_dataset=enabled \\
+                -o feature@filesystem_limits=enabled \\
+                -o feature@hole_birth=enabled \\
+                -o feature@large_blocks=enabled \\
+                -o feature@lz4_compress=enabled \\
+                -o feature@spacemap_histogram=enabled \\
+                -O acltype=posixacl -O canmount=off -O compression=lz4 \\
+                -O devices=off -O normalization=formD -O atime=off -O xattr=sa \\
+                -O mountpoint=/boot -R #{MOUNTPOINT} \\
+                #{@boot_pool_name} #{@dev_boot}
+              ")
+            end
+
+            exec("zpool create -f -o ashift=#{ashift} \\
+              -O encryption=aes-256-gcm \\
+              -O keylocation=prompt -O keyformat=passphrase \\
+              -O acltype=posixacl -O canmount=off -O compression=lz4 \\
+              -O dnodesize=auto -O normalization=formD -O atime=off \\
+              -O xattr=sa -O mountpoint=/ -R #{MOUNTPOINT} \\
+              #{@pool_name} #{@dev_root}
+            ")
+
+            add_datasets
+          end
+
+          def add_datasets
+            exec("zfs create -o canmount=off -o mountpoint=none #{@pool_name}/ROOT")
+            exec("zfs create -o canmount=off -o mountpoint=none #{@boot_pool_name}/BOOT") if @dev_boot
+
+            exec("zfs create -o canmount=noauto -o mountpoint=/ #{@pool_name}/ROOT/gentoo")
+            # set bootfs
+            #exec("zpool set bootfs=#{@pool_name}/ROOT/gentoo #{@pool_name}")
+            exec("zfs create -o canmount=noauto -o mountpoint=/boot #{@boot_pool_name}/BOOT/gentoo") if @dev_boot
+
+            exec("zfs create -o canmount=off #{@pool_name}/ROOT/gentoo/usr")
+            exec("zfs create #{@pool_name}/ROOT/gentoo/usr/src")
+            exec("zfs create -o canmount=off #{@pool_name}/ROOT/gentoo/var")
+            exec("zfs create #{@pool_name}/ROOT/gentoo/var/log")
+            exec("zfs create #{@pool_name}/ROOT/gentoo/var/db")
+            exec("zfs create #{@pool_name}/ROOT/gentoo/var/tmp")
+
+            exec("zfs create -o canmount=off -o mountpoint=/ #{@pool_name}/USERDATA")
+            exec("zfs create -o canmount=on -o mountpoint=/root #{@pool_name}/USERDATA/root")
+            exec("zfs create -o canmount=on -o mountpoint=/home/#{@user} #{@pool_name}/USERDATA/#{@user}") if @user
+          end
+
+          # Follow https://wiki.archlinux.org/index.php/Partitioning
+          # Partition_efi
+          # /boot/efi - EFI system partition - 260MB
+          # /         - Root
+
+          # Partition_bios
+          # None      - Bios Boot Partition - 1MiB
+          # /boot     - Boot - 8300
+          # /         - Root
+
+          def exec(cmd)
+            Helpers::sys(cmd)
+          end
+        end
+      end
+    end
+  end
+end