getch 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 259461a4875fb46c062067c9663e211c206475aaaaa89d3066f85d1b3be2c19b
-  data.tar.gz: 3ab40d87e3f039ef840156cc81df8ee75e3f8f76c332ae4ba08335b04440625f
+  metadata.gz: 80a9841959ac12d1fccf5a4dc5834001e802b36dd1798e297db0cd85f772be03
+  data.tar.gz: 4bcdc9927577f8de4ba1d992e055d00cc11fe42f8aa8a66b52fff06f2c93ca95
 SHA512:
-  metadata.gz: eef130ea5b78dcde7f2897d16f3f74293c16da487ca029c0d47c905489d5cd4d9f32d5bffeba30fe06ab13694370f99a380aceaec6da053dece11598eb938ba4
-  data.tar.gz: f9f4584abb87c4287ba81e16bb0274c483627a712916728fbcc9a4667a2d91f03e09a092bdf09400bd1f92318c67ddabdf4c20217eff1eeb64f2d8d0c97a1a02
+  metadata.gz: 837136b17e66962df98d4e982a4fc10bcd3aefd58fdcf72014079d639d605c1f41b7e9663e1d8e95dba8e78705e448b06a86c36158b8b2590d34febbfdfcd541
+  data.tar.gz: cb9b794f65827c4c7facc6441bd17ebb01409c3d07fc1fc68ca9e7ee6f741b4571cc19e62634069e3eeb4c45ca055c4eb0c2babc58cad033d1e32996c53e0b76

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+* Change mountpoint for the esp at /efi rather than /boot/efi
+* Replace Garden by Bask https://github.com/szorfein/bask
+* Correct option --username USERNAME, do not create a new partition.
+* New set of options --separate-{boot,cache,home} to install them on another disk
+* Refactor codes
+* Add cpu name to COMMON_FLAGS
+* Add cpuflags with app-portage/cpuid2cpuflags
++ Use the whole disk space available for / when option --username is unset
+
 ## 0.1.0, release 2020-10-15
 * Add the (Zeta) filesystem ZFS
 * `emerge --depclean` to save space.

data/README.md

@@ -5,14 +5,16 @@ A CLI tool to install Gentoo.
 Actually, Getch support only the [AMD64 handbook](https://wiki.gentoo.org/wiki/Handbook:AMD64) and only with the last `stage3-amd64-systemd`.  
 It also require a disk (only one for now) with a minimum of 20G.  
 
-BIOS system will use Grub2 and UEFI, systemd-boot. Filesystem supported by Getch are for now:
-+ ext4
-+ lvm
+BIOS system will use `Grub2` and `systemd-boot` for UEFI. Filesystem supported by Getch are for now:
++ Ext4
++ LVM
++ ZFS
 
 Encryption is also supported.
 
 The ISO images i was able to test and that works:
 + [Archlinux](https://www.archlinux.org/download/)
++ [Archaeidae](https://github.com/szorfein/archaeidae): Custom Archiso that includes ZFS support.
 
 ## Install
 Getch is cryptographically signed, so add my public key (if you haven’t already) as a trusted certificate.  
@@ -28,7 +30,7 @@ When you boot from an `iso`, you can install `ruby`, `getch` and correct your `P
     # source ~/.zshrc # or ~/.bashrc
 
 ## Usage
-Just ensure than the script is run with a root account, not just sudo.
+Just ensure than the script is run with a root account.
 
     # getch -h
 
@@ -51,6 +53,10 @@ Encrypt with ext4 and create a home directory /home/ninja
 
     # getch --format ext4 --encrypt --username ninja
 
+With ZFS:
+
+    # getch --format zfs
+
 ## Troubleshooting
 
 #### LVM
@@ -60,6 +66,14 @@ Unless your old LVM volume group is also named `vg0`, `getch` may fail to partit
 To decrypt your disk on BIOS system, you have to enter your password two times. One time for Grub and another time for the initramfs (Genkernel). [post](https://wiki.archlinux.org/index.php/GRUB#Encrypted_/boot).  
 Also with GRUB, only a `us` keymap is working.
 
+#### With ZFS
+When you boot, the pool may fail to start, it's happen when the pool has not been `export` to the ISO. So just reboot on your ISO:
+
+    # zpool import -N -R /mnt zpool
+    # zpool export -a
+
+And it's all.
+
 ## Issues
 If need more support for your hardware (network, sound card, ...), you can submit a [new issue](https://github.com/szorfein/getch/issues/new) and post the output of the following command:
 + lspci

data/lib/getch.rb

@@ -15,6 +15,9 @@ module Getch
     disk: 'sda',
     fs: 'ext4',
     username: nil,
+    boot_disk: nil,
+    cache_disk: nil,
+    home_disk: nil,
     encrypt: false,
     verbose: false
   }
@@ -51,13 +54,17 @@ module Getch
 
   def self.resume_options(opts)
     puts "\nBuild Gentoo with the following args:\n"
-    puts "lang: #{DEFAULT_OPTIONS[:language]}"
-    puts "zoneinfo: #{DEFAULT_OPTIONS[:zoneinfo]}"
-    puts "keymap: #{DEFAULT_OPTIONS[:keymap]}"
-    puts "disk: #{DEFAULT_OPTIONS[:disk]}"
-    puts "fs: #{DEFAULT_OPTIONS[:fs]}"
-    puts "username: #{DEFAULT_OPTIONS[:username]}"
-    puts "encrypt: #{DEFAULT_OPTIONS[:encrypt]}"
+    puts "Lang: #{DEFAULT_OPTIONS[:language]}"
+    puts "Zoneinfo: #{DEFAULT_OPTIONS[:zoneinfo]}"
+    puts "Keymap: #{DEFAULT_OPTIONS[:keymap]}"
+    puts "Disk: #{DEFAULT_OPTIONS[:disk]}"
+    puts "Filesystem: #{DEFAULT_OPTIONS[:fs]}"
+    puts "Username: #{DEFAULT_OPTIONS[:username]}"
+    puts "Encrypt: #{DEFAULT_OPTIONS[:encrypt]}"
+    puts
+    puts "separate-boot disk: #{DEFAULT_OPTIONS[:boot_disk]}"
+    puts "separate-cache disk: #{DEFAULT_OPTIONS[:cache_disk]}"
+    puts "separate-home disk: #{DEFAULT_OPTIONS[:home_disk]}"
     puts
     print "Continue? (n,y) "
     case gets.chomp

data/lib/getch/command.rb

@@ -127,19 +127,21 @@ module Getch
     end
   end
 
-  class Garden
+  class Bask
     def initialize(cmd)
       @gentoo = MOUNTPOINT
       @cmd = cmd
       @log = Getch::Log.new
+      @version = "0.4"
     end
 
     def run!
-      @log.info "Running Garden: #{@cmd}"
+      download_bask if ! Dir.exist? "#{MOUNTPOINT}/root/bask-#{@version}"
+      @log.info "Running Bask: #{@cmd}"
       cmd = "chroot #{@gentoo} /bin/bash -c \"source /etc/profile \
         && env-update \
-        && cd /root/garden-master \
-        && ./kernel.sh #{@cmd} -k /usr/src/linux\""
+        && cd /root/bask-#{@version} \
+        && ./bask.sh #{@cmd} -k /usr/src/linux\""
       Open3.popen2e(cmd) do |stdin, stdout_err, wait_thr|
         while line = stdout_err.gets
           puts line
@@ -152,6 +154,18 @@ module Getch
         end
       end
     end
+
+    private 
+
+    def download_bask
+      @log.info "Installing Bask..."
+      url = "https://github.com/szorfein/bask/archive/v#{@version}.tar.gz"
+      file = "bask-#{@version}.tar.gz"
+
+      Dir.chdir("#{MOUNTPOINT}/root")
+      Helpers::get_file_online(url, file)
+      Getch::Command.new("tar xzf #{file}").run!
+    end
   end
 
   class Chroot < Command

data/lib/getch/filesystem.rb

@@ -3,6 +3,11 @@ module Getch
   end
 end
 
+require_relative 'filesystem/device'
+require_relative 'filesystem/clean'
+require_relative 'filesystem/partition'
+require_relative 'filesystem/mount'
+
 require_relative 'filesystem/ext4'
 require_relative 'filesystem/lvm'
 require_relative 'filesystem/zfs'

data/lib/getch/filesystem/clean.rb

@@ -0,0 +1,51 @@
+module Getch
+  module FileSystem
+    module Clean
+      def self.clean_hdd(disk)
+        return if ! disk
+        raise ArgumentError, "Disk #{disk} is no found." if ! File.exist? "/dev/#{disk}"
+        puts
+        print "Cleaning data on #{disk}, can be long, avoid this on Flash Memory (SSD,USB,...) ? [y,N] "
+        case gets.chomp
+        when /^y|^Y/
+          bloc=`blockdev --getbsz /dev/#{disk}`.chomp
+          Helpers::sys("dd if=/dev/urandom of=/dev/#{disk} bs=#{bloc} status=progress")
+        else
+          return
+        end
+      end
+
+      def self.clean_struct(disk)
+        return if ! disk
+        raise ArgumentError, "Disk #{disk} is no found." if ! File.exist? "/dev/#{disk}"
+        Helpers::sys("sgdisk -Z /dev/#{disk}")
+        Helpers::sys("wipefs -a /dev/#{disk}")
+      end
+
+      def self.hdd(*disks)
+        disks.each { |d| clean_hdd(d) }
+      end
+      # See https://wiki.archlinux.org/index.php/Solid_state_drive/Memory_cell_clearing
+      # for SSD
+      def self.sdd
+      end
+
+      def self.struct(*disks)
+        disks.each { |d| clean_struct(d) }
+      end
+
+      def self.old_vg(disk, vg)
+        oldvg = `vgdisplay | grep #{vg}`.chomp
+        Helpers::sys("vgremove -f #{vg}") if oldvg != ''
+        Helpers::sys("pvremove -f #{disk}") if oldvg != '' and File.exist? disk
+      end
+
+      def self.old_zpool
+        oldzpool = `zpool status | grep pool:`.gsub(/pool: /, '').delete(' ').split("\n")
+        if oldzpool[0] != "" and $?.success?
+          oldzpool.each { |p| Helpers::sys("zpool destroy #{p}") if p }
+        end
+      end
+    end
+  end
+end

data/lib/getch/filesystem/device.rb

@@ -0,0 +1,55 @@
+module Getch
+  module FileSystem
+    class Device
+      def initialize
+        @efi = Helpers::efi?
+        @root_part = 1
+        @user = DEFAULT_OPTIONS[:username]
+
+        @disk = DEFAULT_OPTIONS[:disk]
+        @boot_disk = DEFAULT_OPTIONS[:boot_disk]
+        @cache_disk = DEFAULT_OPTIONS[:cache_disk]
+        @home_disk = DEFAULT_OPTIONS[:home_disk]
+
+        search_boot
+        search_swap
+        search_root
+        search_home
+      end
+
+      private
+      def search_boot
+        if @boot_disk
+          @dev_gpt = @efi ? nil : "/dev/#{@boot_disk}1"
+          @dev_esp  = @efi ? "/dev/#{@boot_disk}1" : nil
+        else
+          @dev_gpt = @efi ? nil : "/dev/#{@disk}#{@root_part}"
+          @dev_esp = @efi ? "/dev/#{@disk}#{@root_part}" : nil
+          @boot_disk = @disk # used by grub
+          @root_part += 1
+        end
+      end
+
+      def search_swap
+        if @cache_disk
+          @dev_swap = "/dev/#{@cache_disk}1"
+        else
+          @dev_swap = "/dev/#{@disk}#{@root_part}"
+          @root_part += 1
+        end
+      end
+
+      def search_root
+        @dev_root = "/dev/#{@disk}#{@root_part}"
+      end
+
+      def search_home
+        if @home_disk
+          @dev_home = "/dev/#{@home_disk}1"
+        else
+          @dev_home = nil
+        end
+      end
+    end
+  end
+end

data/lib/getch/filesystem/ext4/config.rb

@@ -17,7 +17,7 @@ module Getch
 
         def systemd_boot
           return if ! Helpers::efi? 
-          esp = '/boot/efi'
+          esp = '/efi'
           dir = "#{@root_dir}/#{esp}/loader/entries/"
           datas_gentoo = [
             'title Gentoo Linux',
@@ -30,28 +30,27 @@ module Getch
         def grub
           return if Helpers::efi?
           file = "#{@root_dir}/etc/default/grub"
-          cmdline = "GRUB_CMDLINE_LINUX=\"resume=#{@dev_swap} root=#{@dev_root} init=#{@init} rw slub_debug=P page_poison=1 slab_nomerge pti=on vsyscall=none spectre_v2=on spec_store_bypass_disable=seccomp iommu=force\"\n"
+          cmdline = "GRUB_CMDLINE_LINUX=\"resume=PARTUUID=#{@partuuid_swap} root=PARTUUID=#{@partuuid_root} init=#{@init} rw slub_debug=P page_poison=1 slab_nomerge pti=on vsyscall=none spectre_v2=on spec_store_bypass_disable=seccomp iommu=force\"\n"
           File.write(file, cmdline, mode: 'a')
         end
 
         private
 
         def gen_uuid
-          @partuuid_root = `lsblk -o "PARTUUID" #{@dev_root} | tail -1`.chomp() if @dev_root
-          @uuid_swap = `lsblk -o "UUID" #{@dev_swap} | tail -1`.chomp() if @dev_swap
+          @partuuid_root = Helpers::partuuid(@dev_root)
+          @partuuid_swap = Helpers::partuuid(@dev_swap)
           @uuid_root = `lsblk -o "UUID" #{@dev_root} | tail -1`.chomp() if @dev_root
-          @uuid_boot = `lsblk -o "UUID" #{@dev_boot} | tail -1`.chomp() if @dev_boot
-          @uuid_boot_efi = `lsblk -o "UUID" #{@dev_boot_efi} | tail -1`.chomp() if @dev_boot_efi
+          @uuid_esp = `lsblk -o "UUID" #{@dev_esp} | tail -1`.chomp() if @dev_esp
           @uuid_home = `lsblk -o "UUID" #{@dev_home} | tail -1`.chomp() if @dev_home
         end
 
         def data_fstab
-          boot_efi = @dev_boot_efi ? "UUID=#{@uuid_boot_efi} /boot/efi vfat noauto,noatime 1 2" : ''
-          swap = @dev_swap ? "UUID=#{@uuid_swap} none swap discard 0 0" : ''
+          esp = @dev_esp ? "UUID=#{@uuid_esp} /efi vfat noauto,noatime 1 2" : ''
+          swap = @dev_swap ? "PARTUUID=#{@partuuid_swap} none swap discard 0 0" : ''
           root = @dev_root ? "UUID=#{@uuid_root} / ext4 defaults 0 1" : ''
           home = @dev_home ? "UUID=#{@uuid_home} /home/#{@user} ext4 defaults 0 2" : ''
 
-          [ boot_efi, swap, root, home ]
+          [ esp, swap, root, home ]
         end
       end
     end

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

@@ -1,14 +1,9 @@
 module Getch
   module FileSystem
     module Ext4
-      class Device
+      class Device < Getch::FileSystem::Device
         def initialize
-          @disk = DEFAULT_OPTIONS[:disk]
-          @user = DEFAULT_OPTIONS[:username]
-          @dev_boot_efi = Helpers::efi? ? "/dev/#{@disk}1" : nil
-          @dev_root = "/dev/#{@disk}2"
-          @dev_swap = "/dev/#{@disk}3"
-          @dev_home = @user ? "/dev/#{@disk}4" : nil
+          super
         end
       end
     end

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

@@ -22,21 +22,21 @@ module Getch
 
           def systemd_boot
             return if ! Helpers::efi?
-            esp = '/boot/efi'
+            esp = '/efi'
             dir = "#{@root_dir}/#{esp}/loader/entries/"
             datas_gentoo = [
               'title Gentoo Linux',
               'linux /vmlinuz',
               'initrd /initramfs',
-              "options crypt_root=UUID=#{@uuid_root} root=/dev/mapper/root init=#{@init} keymap=#{DEFAULT_OPTIONS[:keymap]} rw"
+              "options crypt_root=PARTUUID=#{@partuuid_root} root=/dev/mapper/root init=#{@init} keymap=#{DEFAULT_OPTIONS[:keymap]} rw"
             ]
             File.write("#{dir}/gentoo.conf", datas_gentoo.join("\n"))
           end
 
           def crypttab
-            home = @dev_home ? "crypthome UUID=#{@uuid_home} /root/secretkeys/crypto_keyfile.bin luks" : ''
+            home = @home_disk ? "crypthome UUID=#{@uuid_home} /root/secretkeys/crypto_keyfile.bin luks" : ''
             datas = [
-              "cryptswap UUID=#{@uuid_swap} /dev/urandom swap,cipher=aes-xts-plain64:sha256,size=256",
+              "cryptswap PARTUUID=#{@partuuid_swap} /dev/urandom swap,cipher=aes-xts-plain64:sha256,size=256",
               home
             ]
             File.write("#{@root_dir}/etc/crypttab", datas.join("\n"))
@@ -46,7 +46,7 @@ module Getch
             return if Helpers::efi?
             file = "#{@root_dir}/etc/default/grub"
             cmdline = [
-              "GRUB_CMDLINE_LINUX=\"crypt_root=UUID=#{@uuid_dev_root} init=#{@init} rw slub_debug=P page_poison=1 slab_nomerge pti=on vsyscall=none spectre_v2=on spec_store_bypass_disable=seccomp iommu=force keymap=#{DEFAULT_OPTIONS[:keymap]}\"",
+              "GRUB_CMDLINE_LINUX=\"crypt_root=PARTUUID=#{@partuuid_root} init=#{@init} rw slub_debug=P page_poison=1 slab_nomerge pti=on vsyscall=none spectre_v2=on spec_store_bypass_disable=seccomp iommu=force keymap=#{DEFAULT_OPTIONS[:keymap]}\"",
               "GRUB_ENABLE_CRYPTODISK=y"
             ]
             File.write(file, cmdline.join("\n"), mode: 'a')
@@ -55,16 +55,16 @@ module Getch
           private
 
           def gen_uuid
-            @partuuid_root = `lsblk -o "PARTUUID" #{@dev_root} | tail -1`.chomp() if @dev_root
-            @uuid_swap = `lsblk -o "UUID" #{@dev_swap} | tail -1`.chomp() if @dev_swap
+            @partuuid_root = Helpers::partuuid(@dev_root)
+            @partuuid_swap = Helpers::partuuid(@dev_swap)
             @uuid_dev_root = `lsblk -d -o "UUID" #{@dev_root} | tail -1`.chomp() if @dev_root
-            @uuid_boot_efi = `lsblk -o "UUID" #{@dev_boot_efi} | tail -1`.chomp() if @dev_boot_efi
+            @uuid_esp = Helpers::uuid(@dev_esp) if @dev_esp
             @uuid_root = `lsblk -d -o "UUID" #{@luks_root} | tail -1`.chomp() if @dev_root
             @uuid_home = `lsblk -d -o "UUID" #{@dev_home} | tail -1`.chomp() if @luks_home
           end
 
           def data_fstab
-            boot_efi = @dev_boot_efi ? "UUID=#{@uuid_boot_efi} /boot/efi vfat noauto,noatime 1 2" : ''
+            boot_efi = @dev_esp ? "UUID=#{@uuid_esp} /efi vfat noauto,noatime 1 2" : ''
             swap = @dev_swap ? "#{@luks_swap} none swap discard 0 0 " : ''
             root = @dev_root ? "UUID=#{@uuid_root} / ext4 defaults 0 1" : ''
             home = @dev_home ? "#{@luks_home} /home/#{@user} ext4 defaults 0 2" : ''

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

@@ -50,7 +50,7 @@ module Getch
           end
 
           def exec(cmd)
-            Helpers::run_chroot(cmd, MOUNTPOINT)
+            Getch::Chroot.new(cmd).run!
           end
         end
       end

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

@@ -2,16 +2,11 @@ module Getch
   module FileSystem
     module Ext4
       module Encrypt
-        class Device
+        class Device < Getch::FileSystem::Device
           def initialize
-            @disk = DEFAULT_OPTIONS[:disk]
-            @user = DEFAULT_OPTIONS[:username]
-            @dev_boot_efi = Helpers::efi? ? "/dev/#{@disk}1" : nil
-            @dev_root = "/dev/#{@disk}2"
-            @dev_swap = "/dev/#{@disk}3"
-            @dev_home = @user ? "/dev/#{@disk}4" : nil
+            super
             @luks_root = "/dev/mapper/cryptroot"
-            @luks_home = @user ? "/dev/mapper/crypthome" : nil
+            @luks_home = @home_disk ? "/dev/mapper/crypthome" : nil
             @luks_swap = "/dev/mapper/cryptswap"
           end
         end

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

@@ -5,18 +5,16 @@ module Getch
         class Format < Getch::FileSystem::Ext4::Encrypt::Device
           def initialize
             super
-            @fs = 'ext4'
             @state = Getch::States.new()
             format
           end
 
           def format
             return if STATES[:format]
-            puts "Format #{@disk} with #{@fs}"
-            exec("mkfs.fat -F32 #{@dev_boot_efi}") if Helpers::efi?
-            exec("mkfs.#{@fs} -F #{@luks_root}")
+            exec("mkfs.fat -F32 #{@dev_esp}") if @dev_esp
+            exec("mkfs.ext4 -F #{@luks_root}")
             exec("mkswap -f #{@dev_swap}")
-            exec("mkfs.#{@fs} -F #{@luks_home}") if @dev_home
+            exec("mkfs.ext4 -F #{@luks_home}") if @dev_home
             @state.format
           end