freydis 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8963ba3af539bf5e5893778cf4e19164cca071b4aa33f42c7bfed8b184016604
-  data.tar.gz: 235dba3157fda782be2927b08094970065511aaa36f5b0898499cc1fd421f3fb
+  metadata.gz: 3e071855bc8658bc5c785f31c78782e5551f21c007527d5198110c6040f1c8ca
+  data.tar.gz: b3b106797d2bddfafb5e9aeabd4b353e4f88d2d7fcd8ad82867fb103f56ea50a
 SHA512:
-  metadata.gz: 5ce910c91f09a88ca6e3fb9a47e5b64f5f76b0a5ac5d78c44baa79b81d29a60c2fe7566f631962792b7192a435ce537258469e5d3f84f1471816d10f0bad8902
-  data.tar.gz: 8098c0c471bb5f6dbb9a71f5553244a496bfe7d29cd37ad848b95b4fd312c48ffe4c7c5c5f305d551db1a45feec5dec935a615dd1fc0a946126de9ddbbe48248
+  metadata.gz: 80a41013b5a8f8c5bbefea435e32d5f6fa52a4b2dafb3f712d67191b2a16e29d3ff869132ad86d67100fb43e4048ced45e4ec8d60cc8796076ee449b07f4594d
+  data.tar.gz: af96444a6d4c3047adf667cd98dddbfb19a80caf4e094d3dab869575b7b3a61ca51f2693bb166e0306d57498bbe1ea881239cfb4ac9c0c564de166122d260b8d

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 0.2.0, release 2023/10/23
+* Define constant OPTIONS and ACTIONS
+* Correct rsync options
+* Can save gpg recipient in freydis.yaml
+* Enhance output of freydis -L
+* Move engine in Freydis::Main
+
+## 0.1.1, release 2022/10/8
+* Restore archive with sudo if permission are insufficient.
+
 ## 0.1.0, release 2022/09/20
 * New dependencies for `Freydis::Secrets`: `bsdtar`, `shred` and `gnupg`.
 * Option store a new field `gpg_recipient`.

data/README.md

@@ -43,7 +43,7 @@ The config file will be created at `~/.config/freydis/freydis.yaml`.
 #### 0x02 - First backup
 Freydis will use `rsync`, all paths must be separated by a comma:
 
-    $ freydis --backup --paths-add "/home,/etc" --save
+    $ freydis --backup --paths-add /home,/etc --save
 
 #### 0x03 - Restore
 With `--disk` and `--paths-add` saved in the config file, you only need to write:

data/lib/freydis/config.rb

@@ -9,36 +9,30 @@ module Freydis
   class Config
     include Msg
 
-    attr_accessor :gpg_recipient, :disk, :paths
-
     def initialize
-      @cpath = "#{ENV['HOME']}/.config/freydis/freydis.yaml"
-      @disk = nil
-      @gpg_recipient = nil
-      @paths = []
+      @cpath = ENV['XDG_CONFIG_HOME'] ?
+                 "#{ENV['XDG_CONFIG_HOME']}/freydis/freydis.yaml" :
+                 "#{ENV['HOME']}/.config/freydis/freydis.yaml"
+
+    end
+
+    def save
+      FileUtils.mkdir_p Pathname.new(@cpath).parent.to_s
+      File.write @cpath, YAML::dump(OPTIONS)
+      success "Saving options to #{@cpath}..."
     end
 
     def load
       if File.exist? @cpath
         info 'Loading config...'
         data_load = YAML.load_file @cpath
-        @disk = data_load[:disk]
-        @gpg_recipient = data_load[:gpg_recipient]
-        @paths = data_load[:paths]
+        OPTIONS[:disk] = data_load[:disk]
+        OPTIONS[:gpg_recipient] = data_load[:gpg_recipient]
+        OPTIONS[:backup_paths] = data_load[:backup_paths]
       else
         info "Creating config file #{@cpath}..."
         save
       end
     end
-
-    def save
-      FileUtils.mkdir_p Pathname.new(@cpath).parent.to_s
-      File.write @cpath, YAML::dump({
-        disk: @disk,
-        gpg_recipient: @gpg_recipient,
-        paths: @paths.uniq
-      })
-      success "Saving options to #{@cpath}..."
-    end
   end
 end

data/lib/freydis/cryptsetup.rb

@@ -9,9 +9,9 @@ module Freydis
     include Msg
 
     def initialize
-      Guard.disk_id(CONFIG.disk)
+      Guard.disk_id(OPTIONS[:disk])
 
-      @disk = Disk.new(CONFIG.disk).search_sdx
+      @disk = Disk.new(OPTIONS[:disk]).search_sdx
       @mapper_name = 'freydis-encrypt'
       @mountpoint = '/mnt/freydis'
     end

data/lib/freydis/disk_luks.rb

@@ -13,7 +13,7 @@ module Freydis
       cryptsetup.open
       cryptsetup.format
       cryptsetup.close
-      success "Disk #{CONFIG.disk} fully encrypted."
+      success "Disk #{OPTIONS[:disk]} fully encrypted."
     end
 
     def open
@@ -21,13 +21,13 @@ module Freydis
       cryptsetup.close
       cryptsetup.open
       cryptsetup.mount
-      success "Disk #{CONFIG.disk} opened."
+      success "Disk #{OPTIONS[:disk]} opened."
     end
 
     def close
       cryptsetup = Freydis::Cryptsetup.new
       cryptsetup.close
-      success "Disk #{CONFIG.disk} closed."
+      success "Disk #{OPTIONS[:disk]} closed."
     end
   end
 end

data/lib/freydis/main.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+# lib/main.rb
+
+module Freydis
+  class Main
+    # Code here
+    def initialize(args)
+      Options.new(args[:argv])
+    end
+
+    def start
+      DiskLuks.encrypt if ACTIONS[:encrypt]
+      DiskLuks.open if ACTIONS[:open]
+      DiskLuks.close if ACTIONS[:close]
+      Rsync.new.backup if ACTIONS[:backup]
+      Rsync.new.restore if ACTIONS[:restore]
+      Secrets.backup if ACTIONS[:secrets_backup]
+      Secrets.restore if ACTIONS[:secrets_restore]
+      Config.new.save if ACTIONS[:config_save]
+    end
+
+    def bye
+      puts
+      puts "Bye !"
+      exit
+    end
+  end
+end

data/lib/freydis/options.rb

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
 
 require 'optparse'
+require 'mods/msg'
 
 module Freydis
   class Options
+    include Msg
+
     def initialize(argv)
       parse(argv)
     end
@@ -15,67 +18,78 @@ module Freydis
         opts.banner = 'Usage: freydis.rb [options]'
         opts.version = VERSION
 
-        opts.on('--disk NAME', /^sd[a-z]$/, 'Use the disk NAME (e.g: sda, sdb).') do |disk|
-          Freydis::CONFIG.disk = Guard.disk(disk)
+        opts.on('--disk NAME', /^sd[a-z]$/,
+                'Use the disk NAME (e.g: sda, sdb).') do |disk|
+          OPTIONS[:disk] = Guard.disk(disk)
         end
 
         opts.on('--gpg-recipient NAME', String, 'Use gpg key NAME.') do |key|
-          Freydis::CONFIG.gpg_recipient = Guard.gpg(key)
+          OPTIONS[:gpg_recipient] = Guard.gpg(key)
+          info "Using key #{OPTIONS[:gpg_recipient]}"
         end
 
-        opts.on('-p PATHS', '--paths-add PATHS', Array, 'Add absolute PATHS to the backup list.') do |paths|
+        opts.on('-p PATHS', '--paths-add PATHS', Array,
+                'Add absolute PATHS to the backup list.') do |paths|
           paths.each do |p|
             Freydis::Guard.path? p
-            Freydis::CONFIG.paths << p
-          end
 
+            info p
+            OPTIONS[:backup_paths] << p unless OPTIONS[:backup_paths].include? p
+          end
         end
 
-        opts.on('-d PATH', '--path-del PATH', String, 'Remove absolute PATH from the backup list.') do |p|
+        opts.on('-d PATH', '--path-del PATH', String,
+                'Remove absolute PATH from the backup list.') do |p|
           Freydis::Guard.path? p
-          Freydis::CONFIG.paths.delete p if CONFIG.paths.include? p
+
+          if OPTIONS[:backup_paths].include? p
+            OPTIONS[:backup_paths].delete p
+          else
+            error "#{p} is no found in #{OPTIONS[:backup_paths]}"
+          end
         end
 
         opts.on('-L', '--paths-list', 'List all paths from your list.') do
-          if Freydis::CONFIG.paths.nil?
-            puts 'Nothing in paths yet...'
+          if OPTIONS[:backup_paths].nil?
+            error 'Nothing in paths yet...'
           else
-            puts Freydis::CONFIG.paths
+            success "Listing paths to backup..."
+            OPTIONS[:backup_paths].each { |p| info p }
           end
         end
 
         # Engines options
 
         opts.on('-e', '--encrypt', 'Encrypt and format (ext4) your device.') do
-          Freydis::DiskLuks.encrypt
+          ACTIONS[:encrypt] = true
         end
 
         opts.on('-o', '--open', 'Open and mount encrypted disk at /mnt/freydis.') do
-          Freydis::DiskLuks.open
+          ACTIONS[:open] = true
         end
 
         opts.on('-c', '--close', 'Umount and close encrypted disk.') do
-          Freydis::DiskLuks.close
+          ACTIONS[:close] = true
         end
 
         opts.on('-b', '--backup', 'Perform a backup.') do
-          Freydis::Rsync.new.backup
+          ACTIONS[:backup] = true
         end
 
         opts.on('-r', '--restore', 'Restore saved datas on your system.') do
-          Freydis::Rsync.new.restore
+          ACTIONS[:restore] = true
         end
 
         opts.on('--secrets-backup', 'Backup only secrets, including GPG keys.') do |s|
-          Freydis::Secrets.backup
+          ACTIONS[:secrets_backup] = true
         end
 
         opts.on('--secrets-restore', 'Restore secrets.') do |s|
-          Freydis::Secrets.restore
+          ACTIONS[:secrets_restore] = true
         end
 
         opts.on('-s', '--save', 'Save current arguments in the config file.') do
-          Freydis::CONFIG.save
+          ACTIONS[:config_save] = true
         end
 
         begin

data/lib/freydis/rsync.rb

@@ -7,41 +7,56 @@ module Freydis
     include Exec
 
     def initialize
-      @workdir = '/mnt/freydis/backup/'
+      @workdir = '/mnt/freydis/backup'
       @exclude_paths = %w[
-        /dev/*
-        /proc/*
-        /sys/*
-        /tmp/*
-        /run/*
-        /mnt/*
-        /media/*
-        /var/lib/dhcpcd/*
-        /home/*/.gvfs
-        /home/*/.thumbnails/*
-        /home/*/.cache/*
-        /home/*/.local/share/*
-        /home/*/.Xauthority
-        /home/*/.xsession-errors
-        /lost+found
+        "/dev/*"
+        "/proc/*"
+        "/sys/*"
+        "/tmp/*"
+        "/run/*"
+        "/mnt/*"
+        "/media/*"
+        "/var/lib/dhcpcd/*"
+        "*/.gvfs"
+        "*/.vim/*"
+        "*/.weechat/*"
+        "*/.thumbnails/*"
+        "*/.oh-my-zsh/*"
+        "*/.cache/*"
+        "*/.emacs.d/*"
+        "*/.local/share/*"
+        "*/.Xauthority"
+        "*/.xsession-errors"
+        "*/.quickemu/*"
+        "*/.config/BraveSoftware/*"
+        "*/.config/Min/*"
+        "*/.config/emacs"
+        "*/build/*"
+        "*/tmp/*"
+        "*/.npm"
+        "*/.history"
+        "*lost+found"
       ]
-      @opts = '-aAXHvRx'
+      #@opts = '-aAXHvR'
+      @opts = '-aAXHv --relative'
+      #@opts = '-aAXHvRx'
     end
 
     def backup
-      Freydis::DiskLuks.open
+      DiskLuks.open
       mkdir @workdir
       exil = @exclude_paths * ','
-      save = CONFIG.paths * ' '
+      save = OPTIONS[:backup_paths] * ' '
       @opts += ' --delete'
       x "rsync #{@opts} --exclude={#{exil}} #{save} #{@workdir}"
-      Freydis::DiskLuks.close
+      puts "Saved path #{save}"
+      DiskLuks.close
     end
 
     def restore
-      Freydis::DiskLuks.open
+      DiskLuks.open
       x "rsync #{@opts} #{@workdir} /"
-      Freydis::DiskLuks.close
+      DiskLuks.close
     end
   end
 end

data/lib/freydis/secrets/archive.rb

@@ -12,7 +12,7 @@ module Freydis
 
       def initialize(gpg)
         @workdir = '/mnt/freydis/secrets'
-        @filename = "#{@workdir}/#{CONFIG.gpg_recipient}_#{Date.today}.tar.gz"
+        @filename = "#{@workdir}/#{OPTIONS[:gpg_recipient]}_#{Date.today}.tar.gz"
         @restore_dir = '/tmp'
         @include_paths = %w[]
         @gpg = gpg
@@ -30,7 +30,8 @@ module Freydis
 
       # Restore the most recent archive in your $HOME
       def restore
-        last_archive = Dir.glob("#{@workdir}/*").sort[0]
+        last_archive = find_last_archive
+        error 'No archive found.' unless last_archive
 
         mkdir @restore_dir
         info "Restoring #{last_archive}..."
@@ -48,6 +49,15 @@ module Freydis
                      #{@gpg.pubkey_path}])
       end
 
+      def find_last_archive
+        if Process.uid == 0
+          Dir.glob("#{@workdir}/#{CONFIG.gpg_recipient}*").sort[0]
+        else
+          archive = `sudo ls #{@workdir}/ | grep #{CONFIG.gpg_recipient} | sort | head -1`.chomp
+          "#{@workdir}/#{archive}" if archive
+        end
+      end
+
       private
 
       def search_paths(paths)

data/lib/freydis/secrets/gpg.rb

@@ -9,7 +9,7 @@ module Freydis
       attr_reader :seckey_path, :pubkey_path
 
       def initialize
-        @recipient = Guard.gpg(CONFIG.gpg_recipient)
+        @recipient = Guard.gpg(OPTIONS[:gpg_recipient])
         @seckey_path = "/tmp/#{@recipient}-secret.key"
         @pubkey_path = "/tmp/#{@recipient}-public.key"
       end

data/lib/freydis/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Freydis
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end
 

data/lib/freydis.rb

@@ -10,24 +10,29 @@ require_relative 'freydis/rsync'
 require_relative 'freydis/error'
 require_relative 'freydis/guard'
 require_relative 'freydis/secrets'
+require_relative 'freydis/main'
 
 module Freydis
-  CONFIG = Config.new
-  CONFIG.load
-  
-  class Main
-    def initialize(args)
-      @argv = args[:argv]
-    end
+  OPTIONS = {
+    disk: '',
+    gpg_recipient: '',
+    backup_paths: []
+  }
 
-    def start
-      Options.new(@argv)
-    end
+  ACTIONS = {
+    encrypt: false,
+    open: false,
+    close: false,
+    backup: false,
+    restore: false,
+    secrets_backup: false,
+    secrets_restore: false,
+    config_save: true
+  }
 
-    def bye
-      puts
-      puts "Bye !"
-      exit
-    end
-  end
+  # Load options from YAML
+  Config.new.load
+
+  # If problem with the config load
+  OPTIONS[:backup_paths] = [] if OPTIONS[:backup_paths] == nil
 end

data/lib/mods/exec.rb

@@ -3,8 +3,10 @@
 module Exec
   def x(command)
     sudo = Process.uid != 0 ? 'sudo' : ''
-    unless system("#{sudo} #{command}")
-      Msg.error "Execute: #{command}"
+    cmd = "#{sudo} #{command}"
+    unless system(cmd)
+      warn "[-] Execute: #{cmd}"
+      exit 1
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: freydis
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - szorfein
@@ -12,31 +12,31 @@ cert_chain:
   -----BEGIN CERTIFICATE-----
   MIIEhTCCAu2gAwIBAgIBATANBgkqhkiG9w0BAQsFADBEMREwDwYDVQQDDAhzem9y
   ZmVpbjEaMBgGCgmSJomT8ixkARkWCnByb3Rvbm1haWwxEzARBgoJkiaJk/IsZAEZ
-  FgNjb20wHhcNMjIwOTA4MDYyNjE5WhcNMjMwOTA4MDYyNjE5WjBEMREwDwYDVQQD
+  FgNjb20wHhcNMjMxMDIzMTcyMTA4WhcNMjQxMDIyMTcyMTA4WjBEMREwDwYDVQQD
   DAhzem9yZmVpbjEaMBgGCgmSJomT8ixkARkWCnByb3Rvbm1haWwxEzARBgoJkiaJ
-  k/IsZAEZFgNjb20wggGiMA0GCSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQDEJNhl
-  Gd0JNHLXysR7GvbCKD+y1prQbmS333GpoFgPR2chEGv8Y7l0We2UFXCZ59CVOs1v
-  KBVQhhNvxWAHWhfe/8stb1JFBxZpnCi7S0BGpqeblaGBXVlhBOzbZ6d1NrOwMfDS
-  6EzdX4WAOH55HnAz29T5KREUdbONVLU7HJNIIFVZvf6ethOv84pnkWbdWjV0RB3A
-  ERYste5QHGx1YQOYGTuJMlu8113kqTbB8wpEw6X00aJwmXcJvnKXkhN5mxd06yss
-  EE96lOk16raTWCh7DeYR3/ilVet3DpLlCvpFNtMIuko1HFa3HTW+57003VxD8Ozk
-  VGQKn823D+ReujKh+jgxbl8Q+r652C9Wl1N+C5CSma4mDtNGKr0XmEOEQycpSx0z
-  Z9J6/27wS8s6SJ0rLxueFQ6gb2oPEQb8jKJuNEuXWLmO3Idrwlv9Z7ymhnksjyqM
-  fAw+NMGEOCITNphXmssazlLX+bnxcbpr7rbTHa1xBmmHoUVudAnxAG43PrMCAwEA
-  AaOBgTB/MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQWBBRzxda94CPF
-  Ll9UQ5l55l65RCZuEzAiBgNVHREEGzAZgRdzem9yZmVpbkBwcm90b25tYWlsLmNv
+  k/IsZAEZFgNjb20wggGiMA0GCSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQCqe1yx
+  EG2oM25jeHp08A8zkaDNmbI3MujjrRM/WPEYZX2dVwOxkIS20hQVuxcAsBBA4W/W
+  kuPbqRkvLboaGaxLrllkSEJw9HA/GesTdXLyCFYmNzSFqGh5BafNSkxoiDhTavxp
+  xvYzAkYR/3CzSOWSxJk73wIg+F7w/nWJPTt2tgJE9hgR8uuFY+EzPOlFZhkFTdCV
+  88sBGuZPMjq7ASQVBE3UA+Y1xJeXE3/FhIhYvLnjevkkDLSLFmox0ZQf6nx6abuL
+  KTOGRA1bfLfkW5HMh5X5JwViliwG3RWhqAukJUgHTUk+oKtejlzSDqupwOenKZf0
+  xI2/BnS8zOsS6Te08iLxqZfI/lsG8wcPduekSetRI4VIOZ5QoRK54PiQjrOBhbnD
+  OQBB/XF1C80imZtRtdUqh6bK9WeWI4RYZ2/KwXL1AScEbXkBkkOECWoVrD18WgRm
+  siuX6RkNIelhtb0En7f3bizgPqlO0qPQV+wPi9TSBxdVG12C0OmjCQYMQD0CAwEA
+  AaOBgTB/MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQWBBTlKnQ3qMUF
+  zydvZaKwdP+dnj2uajAiBgNVHREEGzAZgRdzem9yZmVpbkBwcm90b25tYWlsLmNv
   bTAiBgNVHRIEGzAZgRdzem9yZmVpbkBwcm90b25tYWlsLmNvbTANBgkqhkiG9w0B
-  AQsFAAOCAYEAPhavFyzIP60Zw7y40zJhzQpMK2IWtdw9HrRJq313Ea4UT1Kgv7F9
-  lCFtQzI5XMzooYiLMoPz7xBMXaUz+DDFOOcgGSinVrFbfPA4rOGEkBjnlwC39lBc
-  AiyXFzCV7Wqn4VhtqQQyvmoNYL4Q666K+nL8/nsXZWsXtRQ119LeAvrI2A+xmYAb
-  FPE5bD3Jx1JCoJdVN1DmE4YYdM8mVmb0XjCK9Tp1M01EDKDvAX7f3B+X6A5D7uBq
-  63X6Kx09VkntVOrifd3W4TwjDlyAMpB+50OIi3ErPnH2R4i09qnCiZmcVWATBVKw
-  e2QSloIAUZJwEFkrRqWPNVi8sr+BcMeuKpXaOwpbkP+xq/W2EKlUQKhPXMXS4jvC
-  MuTi+RjpSNKZxzBrOlK2eMIpiFrugF7nzKcM9EGnWRWUb899drCcD4VJhjPtgpn+
-  aEJeKq4/BlIwMlXPe+W5C8zp2i8hgG1/OYbwbGE1p2iRi1NIK7G/HyRqQjOqJxzE
-  LLknX69FN7/G
+  AQsFAAOCAYEAFjnBWWfaMeA8hP0Q76WmBCFckGN5I42X5RQkVYRRXIaeXIS1td/t
+  O1v1iQLo6ABfASMi6We7T16+ita68xwNOmSkMNHHXBr/fdGbHExxFSX7BXNRbwla
+  SS6Vy0bXKMDJbXcvkrmIolpYhEFm1218FCRCT6ogM1oWAJAfhfF9pMeRxrxjQYFn
+  ko8XgjIHxb83miOILgdq/lgJ4gfD7PsGfJtLCLiCKCcxIb4TtmKAzRwCDVpb6wqM
+  5xJZffAmHI7v8lVer53sPzm3INPu5xFZyfZ/SXYXPKKwln0efH63K5vuXYwEN7NI
+  SBSRTN03Hb65t86m6/r084SrNnLntQjCSqApzFBt1QwJ5cmiVilODN4V7y2hZpyK
+  hSk3b2VOotDPiWIm1p/IPXQDfm5x67Z5fJQPAlBTsse4jKyVyW1lZLmERSBuRZ2O
+  urXgRIzALxd/xazPCnoLSXPzfJSI6Y77S1EBvhPd9RaSO8IyH9RhPDP9mnTvW2Kl
+  NAUnoL+txK5a
   -----END CERTIFICATE-----
-date: 2022-09-20 00:00:00.000000000 Z
+date: 2023-10-23 00:00:00.000000000 Z
 dependencies: []
 description: 'Freydis is a CLI tool to encrypt a disk device, backup and restore easyly.
   Freydis use `cryptsetup` and `rsync` mainly.
@@ -60,6 +60,7 @@ files:
 - lib/freydis/disk_luks.rb
 - lib/freydis/error.rb
 - lib/freydis/guard.rb
+- lib/freydis/main.rb
 - lib/freydis/options.rb
 - lib/freydis/rsync.rb
 - lib/freydis/secrets.rb
@@ -93,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - cryptsetup
 - rsync
-rubygems_version: 3.3.19
+rubygems_version: 3.3.25
 signing_key:
 specification_version: 4
 summary: Backup and Restore data from encrypted device.