getch 0.0.8 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d697434a5e8a44edb8027582ece052145c440247524597afe5ad28118115154
-  data.tar.gz: 42eb9e224e6581752f28d6997a9e10feb0e65c432e0dd80bc87236d7e597d828
+  metadata.gz: c141cfefd0484364edafbbf424bc6e3d1fe98d26d5a2fa96411ae88efaae501a
+  data.tar.gz: 117fb8c04c3525ac5c5be3da0683eac0b68de537f674955fe6d363091233ab0b
 SHA512:
-  metadata.gz: 2e17128164b81b58d59f296e360197a2b9fbb33fd2b1cbd58128b1b04885eef4480d067c5588d40802c889e5a80861b63c37454b685bdb6263e9806b2e99b208
-  data.tar.gz: f8eee6f6b37fb036a05003d109672615cc7439dcc5277f2d4604d58e66b2407fa648bdccb850269545f2aef5441777a0d936842326cecb7410b05dfb6dbcee64
+  metadata.gz: fbf00fb976d8e4a1ea8a4e3abf64de42f9804b4b33b125548021f733d27e2458d6c6ec2e9712f3f92806b66253550c600c217f3ece4bf3310f5b39c5cb58aebf
+  data.tar.gz: ed7af46af82c816f17296ba01301aece81d6655d4fc31c166fce5a013be8c20e5b89b8965c3d855913628c3566a47bd8b2ed123263c7dedaef5b3e3fdd0a6b4e

data/CHANGELOG.md

@@ -1,6 +1,50 @@
+## 0.1.3, release 2021-05-17
+* LVM use the format /dev/vg_name/lv_name for mount/format/fstab.
+* Stop using `euse` from `gentoolkit`, use native Ruby code here.
+* Optimization on package installation, they shouln't be installed more than once.
+* Regroup use flags under Getch::Gentoo::UseFlag.
+* Upd Bask v0.5 (zstd compression, better support for wifi...)
+* Config for systemd-resolved, enable DNS over TLS with Quad9 (9.9.9.9)
+* Add configs for systemd-network with DHCP for wifi and ethernet.
+* Correct permissions (/home/[user] and /etc/portage)
+
+## 0.1.2, release 2021-05-12
+* DOCS update.
+* Keep Nano for those who need :)
+* ZFS use the last version >=2.0 with kernel stable =5.10
+* ZFS create a Log device and Cache device if getch is used with `--separate-cache`.
+* GRUB or Systemd-boot can now be installed on separate disk with `--separate-boot`.
+* Adding flag for ZFS `-o autotrim=on` (used with `zpool create`).
+* Encrypted swap use: `cipher=aes-xts-plain64:sha256,size=512` by default.
+* In the make.conf: add `-fomit-frame-pointer`, designed to reduce generated code size.
+
+## 0.1.1, release 2020-11-01
+* 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.
+* Add a message when getch have finish, keep /mnt/gentoo if you need to add something.
+* Use systemd-detect-virt to detect a Virtual Guest.
+
+## 0.0.9, release 2020-10-03
+* Add encryption on ext4 and lvm (BIOS,UEFI)
+* Correct KEYMAP="yes" with genkernel
+* Renaming option keyboard with keymap
+* GPG verification for ebuild
+
+## 0.0.8, release 2020-09-30
 * Adding LVM via the option fs, `--fs lvm`.
 * Systemd-boot use the value of PARTUUID without initramfs.
 * Include lib logger.
+* Enhance functions to call program system Emerge, Make, ...
 
 ## 0.0.7, release 2020-09-22
 * Correct fstab.

data/README.md

@@ -3,15 +3,17 @@ A CLI tool to install Gentoo.
 
 ## Description
 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.  
 
-Filesystem supported by Getch are: (the list will evolve...)
-+ ext4 with GRUB2 for BIOS based system and systemd-boot for UEFI systems.
+BIOS system will use `Grub2` and `systemd-boot` for UEFI. Filesystem supported by Getch are for now:
++ Ext4
++ LVM
++ ZFS
 
-I would also add disk encryption soon.
+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.  
@@ -26,21 +28,68 @@ When you boot from an `iso`, you can install `ruby`, `getch` and correct your `P
     # sh <(curl -L https://raw.githubusercontent.com/szorfein/getch/master/bin/setup.sh)
     # source ~/.zshrc # or ~/.bashrc
 
+If you want to try the master branch:
+
+    # git clone https://github.com/szorfein/getch
+    # cd getch
+    # ruby -I lib bin/getch -h
+
 ## Usage
+Just ensure than the script is run with a root account.
+
+    # getch -h
 
-    $ getch -h
+After an install by Getch, take a look on the [wiki](https://github.com/szorfein/getch/wiki).
 
 ## Examples
 For a french user:
 
-    # getch --username ninja --zoneinfo "Europe/Paris" --language fr_FR --keyboard fr
-
-After an install by Getch, take a look on the [wiki](https://github.com/szorfein/getch/wiki).
+    # getch --zoneinfo "Europe/Paris" --language fr_FR --keymap fr
 
 Install Gentoo on LVM:
 
     # getch --format lvm --disk sda
 
+Encrypt your disk with LVM with a french keymap
+
+    # getch --format lvm --encrypt --keymap fr
+
+Encrypt with ext4 and create a home directory /home/ninja
+
+    # getch --format ext4 --encrypt --username ninja
+
+With ZFS:
+
+    # getch --format zfs
+
+## Troubleshooting
+
+#### LVM
+Unless your old LVM volume group is also named `vg0`, `getch` may fail to partition your disk. You have to clean up your device before proceed with `vgremove` and `pvremove`. An short example how doing this with a volume group named `vg0`:
+
+    # vgdisplay | grep vg0
+    # vgremove -f vg0
+    # pvremove -f /dev/sdb
+
+#### Encryption enable on BIOS with ext4
+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 Gentoo 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:
+
+You need the partuuid, pool are create with the first 5 characters, just replace `sdX` by your real device:
+
+    # ls -l /dev/disk/by-partuuid/ | grep sdX4
+    -> 150ed969...
+    # zpool import -N -R /mnt rpool-150ed
+
+And export them correctly:
+
+    # zpool export -a
+
+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/bin/setup.sh

@@ -72,10 +72,12 @@ set_shell() {
   [ -f ~/.zshrc ] && your_shell=~/.zshrc
 
   [ -f "$your_shell" ] && {
-    if ! grep -q ".gem/ruby/[0-9.]*/bin" "$your_shell" ; then
+    if ! grep -q "ruby" "$your_shell" ; then
       echo "export PATH=\$PATH:$(ruby -e 'puts Gem.user_dir')/bin" >> "$your_shell"
     fi
-    . "$your_shell"
+    if $(. "$your_shell") ; then
+      echo "Shell loaded"
+    fi
   }
 }
 

data/lib/getch.rb

@@ -5,16 +5,20 @@ require_relative 'getch/filesystem'
 require_relative 'getch/command'
 require_relative 'getch/helpers'
 require_relative 'getch/log'
+require_relative 'getch/config'
 
 module Getch
 
   DEFAULT_OPTIONS = {
     language: 'en_US',
     zoneinfo: 'US/Eastern',
-    keyboard: 'us',
+    keymap: 'us',
     disk: 'sda',
     fs: 'ext4',
     username: nil,
+    boot_disk: nil,
+    cache_disk: nil,
+    home_disk: nil,
     encrypt: false,
     verbose: false
   }
@@ -30,20 +34,38 @@ module Getch
   }
 
   MOUNTPOINT = "/mnt/gentoo".freeze
-  OPTIONS_FS = {
-    'ext4' => DEFAULT_OPTIONS[:encrypt] ? Getch::FileSystem::Ext4::Encrypt : Getch::FileSystem::Ext4,
-    'lvm' => DEFAULT_OPTIONS[:encrypt] ? Getch::FileSystem::Lvm::Encrypt : Getch::FileSystem::Lvm
+  DEFAULT_FS = {
+    true => {
+      ext4: Getch::FileSystem::Ext4::Encrypt,
+      lvm: Getch::FileSystem::Lvm::Encrypt,
+      zfs: Getch::FileSystem::Zfs::Encrypt
+    },
+    false => {
+      ext4: Getch::FileSystem::Ext4,
+      lvm: Getch::FileSystem::Lvm,
+      zfs: Getch::FileSystem::Zfs,
+    }
   }.freeze
 
+  def self.class_fs
+    encrypt = DEFAULT_OPTIONS[:encrypt]
+    fs = DEFAULT_OPTIONS[:fs].to_sym
+    DEFAULT_FS[encrypt][fs]
+  end
+
   def self.resume_options(opts)
     puts "\nBuild Gentoo with the following args:\n"
-    puts "lang: #{DEFAULT_OPTIONS[:language]}"
-    puts "zoneinfo: #{DEFAULT_OPTIONS[:zoneinfo]}"
-    puts "keyboard: #{DEFAULT_OPTIONS[:keyboard]}"
-    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
@@ -62,8 +84,8 @@ module Getch
     case gets.chomp
     when /^y|^Y/
       log.info("Partition start")
-      OPTIONS_FS[fs]::Partition.new
-      OPTIONS_FS[fs]::Format.new
+      class_fs::Partition.new
+      class_fs::Format.new
     else
       exit 1
     end
@@ -73,18 +95,24 @@ module Getch
     gentoo = Getch::Gentoo
     gentoo.stage3
     gentoo.config(options)
-    gentoo.chroot
+    gentoo.chroot(options)
     gentoo.kernel
     gentoo.boot(options)
   end
 
+  def self.configure(options)
+    config = Getch::Config.new
+    config.network
+  end
+
   def self.main(argv)
     options = Options.new(argv)
     DEFAULT_OPTIONS.freeze
     resume_options(options)
     Getch::States.new # Update States
     format(options.disk, options.fs, options.username)
-    OPTIONS_FS[DEFAULT_OPTIONS[:fs]]::Mount.new.run
+    class_fs::Mount.new.run
     init_gentoo(options)
+    configure(options)
   end
 end

data/lib/getch/command.rb

@@ -17,7 +17,7 @@ module Getch
 
         # only stderr
         begin
-          @log.error stderr.readline until stderr.eof.nil?
+          @log.debug stderr.readline until stderr.eof.nil?
         rescue EOFError
         end
 
@@ -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.5"
     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,5 +154,24 @@ 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
+    def initialize(cmd)
+      super
+      @cmd = "chroot #{MOUNTPOINT} /bin/bash -c \"source /etc/profile; #{cmd}\""
+    end
   end
 end

data/lib/getch/config.rb

@@ -0,0 +1,58 @@
+module Getch
+  class Config
+    def initialize
+      @systemd_net_dir = "#{MOUNTPOINT}/etc/systemd"
+    end
+
+    def network
+      ethernet
+      wifi
+      resolved
+      Getch::Chroot.new('systemctl enable systemd-networkd').run!
+      Getch::Chroot.new('systemctl enable systemd-resolved').run!
+    end
+
+    private
+
+    def ethernet
+      conf = "#{@systemd_net_dir}/network/20-ethernet.network"
+      datas = [
+        "[Match]",
+        "Name=en*",
+        "Name=eth*",
+        "[Network]",
+        "DHCP=yes",
+        "IPv6PrivacyExtensions=yes",
+        "[DHCP]",
+        "RouteMetric=512"
+      ]
+      File.write(conf, datas.join("\n"), mode: 'w')
+    end
+
+    def wifi
+      conf = "#{@systemd_net_dir}/network/20-wireless.network"
+      datas = [
+        "[Match]",
+        "Name=wlp*",
+        "Name=wlan*",
+        "[Network]",
+        "DHCP=yes",
+        "IPv6PrivacyExtensions=yes",
+        "[DHCP]",
+        "RouteMetric=1024",
+      ]
+      File.write(conf, datas.join("\n"), mode: 'w')
+    end
+
+    def resolved
+      conf = "#{@systemd_net_dir}/resolved.conf.d/dns_over_tls.conf"
+      datas = [
+        "[Resolve]",
+        "DNS=9.9.9.9#dns.quad9.net",
+        "DNSOverTLS=yes",
+      ]
+      Helpers::create_dir("#{@systemd_net_dir}/resolved.conf.d")
+      File.write(conf, datas.join("\n"), mode: 'w')
+    end
+  end
+end

data/lib/getch/filesystem.rb

@@ -3,5 +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