freydis 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '0381ec85064f282916907626e1a1783ee8a86ce5df1769deb91f4e1b0e5eb4dc'
+  data.tar.gz: 8c100e7428ec1fc7261a271a677d77fafe84b337541b507c8a9c71d964524e10
+SHA512:
+  metadata.gz: 135daf7438ab4439396d45a99dc2300c916edcb2d2fcdef97dbaf907c19add34503d027b3b4d51836b92aaca979b5953d674609e411c1b1249bb0d589938b4e3
+  data.tar.gz: 8a0e398ca35e07f161bb0c02a0c33bbe68c09f16f492633a36707304720bb8690c41e087dbe34bfc61be410fe23e73af663c349d464cab5c95a27bdc6a0b563e

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+## 0.0.2, release 2021/05/18
+* New options `--open` and `--close`.
+* Encrypt/Decrypt with `cryptsetup`.
+* Add Rsync for backup and restore.
+* Can add/remove paths with the `--cli`.
+* Can (u)mount the encrypted device at the default `/mnt/freydis`.
+* Checking all ID (partuuid, uuid, id) from a given device.
+* YAML config file in ~/.config/freydis/freydis.yaml.
+
+## 0.0.1, release 2021/05/04
+* Initial push, code freeying !
+

data/LICENSE

@@ -0,0 +1,10 @@
+MIT License
+
+Copyright (c) 2021 szorfein
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/README.md

@@ -0,0 +1,62 @@
+# Freydis
+Backup and restore data on encrypted device.
+
+## Requirements
+Freydis use `rsync` and `cryptsetup`.
+
+## Gem build
+
+    gem build freydis.gemspec
+
+## Install freydis locally
+
+    gem install freydis-0.0.1.gem -P HighSecurity
+
+## Usage
+
+#### 0x01 - Config file
+First, you need a config file. You can use `freydis --init` or make one with your favorite editor.  
+The config file should be placed at `~/.config/freydis/freydis.yaml`.
+
+An example of final config:
+
+```yaml
+---
+:disk: sdc
+:disk_id: usb-SABRENT_SABRENT_DB9876543214E-0:0
+:disk_uuid: 10f531df-51dc-x19e-9bd1-bbd6659f0c3f
+:disk_partuuid: ''
+:paths:
+- "/home/daggoth/labs"
+- "/home/daggoth/musics"
+- "/home/daggoth/.password-store"
+- "/home/daggoth/documents"
+```
+
+As you see:
++ disk: sdc -> Use only `sd[a-z]` without partition.
++ disk_id -> (Optionnal), freydis will find it if void.
++ disk_uuid -> (Optionnal)
++ disk_partuuid -> (Optionnal)
++ paths -> Contain a list of absolute paths on each line.
+
+#### 0x02 - Encrypt the disk
+Freydis will use `cryptsetup` with `luks2` and format the disk with `ext4`:
+
+    $ freydis --encrypt
+
+#### 0x03 - Other options
+Make an incremental backup, will copy all `paths` include in the config file:
+
+    $ freydis --backup
+
+Restore files in your system `/`:
+
+    $ freydis --restore
+
+If you lost the config file, `freydis` has made a copy on your device when you're done your first `--backup`:
+
+    $ freydis --open --disk sdc
+    $ cp -a /mnt/freydis/home/user/.config/freydis ~/.config/
+
+And you can use `freydis` normally.

data/Rakefile

@@ -0,0 +1,21 @@
+# https://github.com/seattlerb/minitest#running-your-tests-
+require "rake/testtask"
+require File.dirname(__FILE__) + "/lib/freydis/version"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/test_*.rb"]
+end
+
+# Usage: rake gem:build
+namespace :gem do
+  desc "build the gem"
+  task :build do
+    Dir["freydis*.gem"].each {|f| File.unlink(f) }
+    system("gem build freydis.gemspec")
+    system("gem install freydis-#{Freydis::VERSION}.gem")
+  end
+end
+
+task :default => :test

data/bin/freydis

@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby
+require "freydis"
+
+puts "Freydis v." + Freydis::VERSION
+
+cli = Freydis::Options.new(ARGV)
+data = Freydis::Data.new
+data.load
+
+if cli.disk
+  data.options[:disk] = cli.disk
+end
+
+if cli.init
+  Freydis::Init.run(data.options)
+  data.save
+  exit 0
+end
+
+if !cli.backup && !cli.restore && !cli.encrypt &&
+   !cli.open && !cli.close
+  puts "Ok... glad to see you too."
+  exit 1
+end
+
+if cli.encrypt
+  puts "Encrypting disk #{data.options[:disk]}..."
+  disk = Freydis::Disk.new(data.options[:disk])
+  disk.encrypt(data)
+  data.save
+elsif cli.backup
+  puts "Saving..."
+  disk = Freydis::Disk.new(data.options[:disk])
+  disk.open(data)
+  rsync = Freydis::Rsync.new(data)
+  rsync.backup
+  disk.close(data)
+elsif cli.restore
+  puts "Restoring..."
+  disk = Freydis::Disk.new(data.options[:disk])
+  disk.open(data)
+  rsync = Freydis::Rsync.new(data)
+  rsync.restore
+  disk.close(data)
+elsif cli.open
+  puts "Opening disk #{data.options[:disk]}."
+  disk = Freydis::Disk.new(data.options[:disk])
+  disk.open(data)
+elsif cli.close
+  puts "Closing disk #{data.options[:disk]}."
+  disk = Freydis::Disk.new(data.options[:disk])
+  disk.close(data)
+end

data/freydis.gemspec

@@ -0,0 +1,33 @@
+require File.dirname(__FILE__) + "/lib/freydis/version"
+
+# https://guides.rubygems.org/specification-reference/
+Gem::Specification.new do |s|
+  s.files = `git ls-files`.split(" ")
+  s.files.reject! { |fn| fn.include? "certs" }
+  s.name = "freydis"
+  s.summary = "Backup and Restore data from encrypted device."
+  s.version = Freydis::VERSION
+  s.description = <<-EOF
+    Freydis is a CLI tool to encrypt a disk device, backup and restore easyly. Freydis use `cryptsetup` and `rsync` mainly.
+  EOF
+  s.email = "szorfein@protonmail.com"
+  s.homepage = "https://github.com/szorfein/freydis"
+  s.license = "MIT"
+  s.metadata = {
+    "bug_tracker_uri" => "https://github.com/szorfein/freydis/issues",
+    "changelog_uri" => "https://github.com/szorfein/freydis/blob/master/CHANGELOG.md",
+    "source_code_uri" => "https://github.com/szorfein/freydis",
+    "wiki_uri" => "https://github.com/szorfein/freydis/wiki",
+    "funding_uri" => "https://patreon.com/szorfein",
+  }
+  s.author = "szorfein"
+  s.bindir = "bin"
+  s.cert_chain = ["certs/szorfein.pem"]
+  s.executables << "freydis"
+  s.extra_rdoc_files = ['README.md']
+  s.required_ruby_version = ">=2.6"
+  s.requirements << 'cryptsetup, v2.3'
+  s.requirements << 'rsync, v3.2'
+  s.signing_key = File.expand_path("~/.ssh/gem-private_key.pem") if $@ =~ /gem\z/
+end
+

data/lib/freydis.rb

@@ -0,0 +1,12 @@
+require_relative 'freydis/version'
+require_relative 'freydis/options'
+require_relative 'freydis/init'
+require_relative 'freydis/data'
+require_relative 'freydis/disk'
+require_relative 'freydis/cryptsetup'
+require_relative 'freydis/rsync'
+require_relative 'freydis/guard'
+
+module Freydis
+end
+

data/lib/freydis/cryptsetup.rb

@@ -0,0 +1,74 @@
+# lib/cryptsetup.rb
+
+module Freydis
+  class Cryptsetup
+    def initialize(data)
+      @data = data
+      @dev_ids = [
+        "/dev/disk/by-id/" + @data.options[:disk_id] ||= " ",
+        "/dev/disk/by-uuid/" + @data.options[:disk_uuid] ||= " ",
+        "/dev/disk/by-partuuid/" + @data.options[:disk_partuuid] ||= " ",
+        "/dev/" + @data.options[:disk]
+      ]
+      @mapper_name = "freydis-enc"
+      @mountpoint ="/mnt/freydis"
+    end
+
+    def encrypt
+      @dev_ids.each { |f|
+        if File.exists? f
+          exec "cryptsetup -v --type luks2 --verify-passphrase luksFormat #{f}"
+          break if $?.success?
+        end
+      }
+    end
+
+    def open
+      @dev_ids.each { |f|
+        if File.exists? f
+          exec "cryptsetup -v open #{f} #{@mapper_name}"
+          break if $?.success?
+        end
+      }
+    end
+
+    def close
+      umount
+      exec "cryptsetup -v close #{@mapper_name}" if File.exists? "/dev/mapper/#{@mapper_name}"
+    end
+
+    def format
+      exec "mkfs.ext4 /dev/mapper/#{@mapper_name}"
+    end
+
+    def mount
+      create_mountpoint
+      puts "Mounting disk at #{@mountpoint}"
+      exec "mount -t ext4 /dev/mapper/#{@mapper_name} #{@mountpoint}"
+    end
+
+    private
+
+    def create_mountpoint
+      if Process.uid === 0
+        Dir.mkdir @mountpoint unless Dir.exist? @mountpoint
+      else
+        exec "mkdir -p #{@mountpoint}" unless Dir.exist? @mountpoint
+      end
+    end
+
+    def umount
+      dir_length = Dir.glob("#{@mountpoint}/*").length
+      if dir_length >= 1 # should contain lost+found if mount
+        exec "umount #{@mountpoint}"
+      end
+    end
+
+    def exec(command)
+      sudo = Process.uid != 0 ? 'sudo' : ''
+      if !system("#{sudo} #{command}")
+        raise StandardError, "[-] #{command}"
+      end
+    end
+  end
+end

data/lib/freydis/data.rb

@@ -0,0 +1,39 @@
+# lib/data.rb
+
+require 'yaml'
+
+module Freydis
+  class Data
+    attr_accessor :options
+
+    def initialize
+      @config_file = "#{ENV['HOME']}/.config/freydis/freydis.yaml"
+      @options = {
+        :disk => "",
+        :disk_id => "",
+        :disk_uuid => "",
+        :disk_partuuid => "",
+        :paths => []
+      }
+    end
+
+    def load
+      if File.exist? @config_file
+        options_config = YAML.load_file @config_file
+        @options.merge!(options_config)
+      else
+        save
+        STDERR.puts "Initialized config at #{@config_file}"
+      end
+    end
+
+    def save
+      conf_dir = "#{ENV['HOME']}/.config/freydis"
+      Dir.mkdir conf_dir if !Dir.exists? conf_dir
+
+      File.open(@config_file, 'w') { |f|
+        YAML::dump(@options, f)
+      }
+    end
+  end
+end

data/lib/freydis/disk.rb

@@ -0,0 +1,81 @@
+# lib/disk.rb
+
+module Freydis
+  class Disk
+    def initialize(dev)
+      @disk = dev.match(/sd[a-z]{1}/)
+      @dev = "/dev/#{@disk}"
+      @mountpoint = "/mnt/freydis"
+    end
+
+    def size
+      `lsblk -dno SIZE #{@dev}`.chomp
+    end
+
+    def complete_info
+      `lsblk -dno "NAME,LABEL,FSTYPE,SIZE" #{@dev}`.chomp
+    end
+
+    def populate_data(data)
+      puts "Checking IDs on #{@disk}..."
+      search_uuid(data)
+      search_id(data)
+      search_partuuid(data)
+    end
+
+    def encrypt(data)
+      populate_data(data)
+      puts "id -> #{data.options[:disk_id]}"
+      puts "uuid -> #{data.options[:disk_uuid]}"
+      puts "partuuid -> #{data.options[:disk_partuuid]}"
+      data.save
+
+      cryptsetup = Freydis::Cryptsetup.new(data)
+      cryptsetup.close
+
+      cryptsetup.encrypt
+      cryptsetup.open
+      cryptsetup.format
+
+      cryptsetup.close
+    end
+
+    def open(data)
+      cryptsetup = Freydis::Cryptsetup.new(data)
+      cryptsetup.close
+      cryptsetup.open
+      cryptsetup.mount
+    end
+
+    def close(data)
+      cryptsetup = Freydis::Cryptsetup.new(data)
+      cryptsetup.close
+    end
+
+    private
+
+    def search_uuid(data)
+      Dir.glob("/dev/disk/by-uuid/*").each { |f|
+        if File.readlink(f).match(/#{@disk}/)
+          data.options[:disk_uuid] = f.delete_prefix("/dev/disk/by-uuid/")
+        end
+      }
+    end
+
+    def search_id(data)
+      Dir.glob("/dev/disk/by-id/*").each { |f|
+        if File.readlink(f).match(/#{@disk}/)
+          data.options[:disk_id] = f.delete_prefix("/dev/disk/by-id/")
+        end
+      }
+    end
+
+    def search_partuuid(data)
+      Dir.glob("/dev/disk/by-partuuid/*").each { |f|
+        if File.readlink(f).match(/#{@disk}/)
+          data.options[:disk_partuuid] = f.delete_prefix("/dev/disk/by-partuuid/")
+        end
+      }
+    end
+  end
+end

data/lib/freydis/guard.rb

@@ -0,0 +1,9 @@
+module Freydis
+  module Guard
+    def self.disk?(name)
+      raise ArgumentError, "Bad name #{name}, should match with sdX" if !name.match(/^sd[a-z]{1}$/)
+      raise ArgumentError, "No disk /dev/#{name}" if !File.exist? "/dev/#{name}"
+      true
+    end
+  end
+end

data/lib/freydis/init.rb

@@ -0,0 +1,78 @@
+# lib/init.rb
+
+module Freydis
+  module Init
+
+    puts "===> Starting Init"
+
+    def self.run(options)
+      loop do
+        puts %q{Please select an option:
+
+  1. Choose a disk (plug on)
+  2. Add more paths
+  3. Reset paths
+  4. Show options
+  5. Save & Quit}
+
+        case gets.chomp
+        when '1'
+          select_disk(options)
+        when '2'
+          puts "Add a path..."
+          add_path(options)
+        when '3'
+          puts "Reseting paths..."
+          options[:paths] = []
+        when '4'
+          show_options(options)
+        else
+          puts "Quit."
+          return
+        end
+      end
+    end
+
+    private
+
+    def self.select_disk(options)
+      disks_list = Dir.glob("/dev/sd?")
+      puts "Available disks: (only type sdX)"
+      disks_list.each { |d|
+        your_disk = Freydis::Disk.new(d)
+        puts "+ " + your_disk.complete_info
+      }
+      print "> "
+      answer = $stdin.gets
+      disk = answer.chomp
+      if File.exist? "/dev/#{disk}"
+        options[:disk] = disk
+        puts "Disk #{disk} added."
+      else
+        puts "No disk #{disk} found."
+      end
+    end
+
+    def self.add_path(options)
+      print "> "
+      answer = $stdin.gets
+      new_path = answer.chomp if answer
+      if Dir.exists? new_path
+        options[:paths] << new_path
+        puts "Path '#{new_path}' added"
+        display_path(options)
+      else
+        puts "#{new_path} no found"
+      end
+    end
+
+    def self.display_path(options)
+      puts "Current paths:"
+      options[:paths].each { |p| puts "+ #{p}" }
+    end
+
+    def self.show_options(options)
+      puts options
+    end
+  end
+end

data/lib/freydis/options.rb

@@ -0,0 +1,62 @@
+require 'optparse'
+
+module Freydis
+  class Options
+    attr_accessor :init, :backup, :restore, :encrypt,
+                  :open, :close,
+                  :disk
+
+    def initialize(args)
+      @init = false
+      @backup = false
+      @restore = false
+      @encrypt = false
+      @open = false
+      @close = false
+      @disk = nil
+      parse(args)
+    end
+
+    private
+
+    def parse(argv)
+      OptionParser.new do |opts|
+        opts.banner = "Usage: freydis.rb [options]"
+
+        opts.on("-i", "--init", "Create a config file.") do
+          @init = true
+        end
+
+        opts.on("-b", "--backup", "Perform a backup.") do
+          @backup = true
+        end
+
+        opts.on("-r", "--restore", "Restore saved datas on your system.") do
+          @restore = true
+        end
+
+        opts.on("-e", "--encrypt", "Encrypt your device.") do
+          @encrypt = true
+        end
+
+        opts.on("-o", "--open", "Open and mount encrypted device at /mnt/freydis.") do
+          @open = true
+        end
+
+        opts.on("-c", "--close", "Umount & close encrypted device.") do
+          @close = true
+        end
+
+        opts.on("-dNAME", "--disk NAME", "To use the disk NAME (e.g: sda, sdb).") do |disk|
+          @disk = disk if Freydis::Guard.disk? disk
+        end
+
+        begin
+          opts.parse!(argv)
+        rescue OptionParser::ParseError => e
+          STDERR.puts e.message, "\n", opts
+        end
+      end
+    end
+  end
+end

data/lib/freydis/rsync.rb

@@ -0,0 +1,53 @@
+# lib/rsync.rb
+
+module Freydis
+  class Rsync
+    def initialize(data)
+      @data = data
+      @mountpoint = '/mnt/freydis'
+      @exclude_paths = [
+        "/dev/*",
+        "/proc/*",
+        "/sys/*",
+        "/tmp/*",
+        "/run/*",
+        "/mnt/*",
+        "/media/*",
+        "/home/*/.thumbnails/*",
+        "/home/*/.cache/mozilla/*",
+        "/home/*/.cache/chromium/*",
+        "/home/*/.local/share/Trash/*",
+        "/lost+found",
+      ]
+      @opts = "-aAXHv"
+    end
+
+    def backup
+      add_config
+      exil = @exclude_paths * ","
+      save = @data.options[:paths] * " "
+      @opts += " --delete"
+      exec("rsync #{@opts} --exclude={#{exil}} #{save} #{@mountpoint}")
+    end
+
+    def restore
+      exil = @exclude_paths * ","
+      exec("rsync #{@opts} --exclude={#{exil}} #{@mountpoint} /")
+    end
+
+    private
+
+    def add_config
+      if !@data.options[:paths].include?("#{ENV['HOME']}/.config/freydis")
+        @data.options[:paths] << "#{ENV['HOME']}/.config/freydis"
+      end
+    end
+
+    def exec(command)
+      sudo = Process.uid != 0 ? 'sudo' : ''
+      if !system("#{sudo} #{command}")
+        raise StandardError, "[-] #{command}"
+      end
+    end
+  end
+end

data/lib/freydis/version.rb

@@ -0,0 +1,4 @@
+module Freydis
+  VERSION = '0.0.2'.freeze
+end
+

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: freydis
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- szorfein
+autorequire:
+bindir: bin
+cert_chain:
+- certs/szorfein.pem
+date: 2021-05-18 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.\n"
+email: szorfein@protonmail.com
+executables:
+- freydis
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- Rakefile
+- bin/freydis
+- freydis.gemspec
+- lib/freydis.rb
+- lib/freydis/cryptsetup.rb
+- lib/freydis/data.rb
+- lib/freydis/disk.rb
+- lib/freydis/guard.rb
+- lib/freydis/init.rb
+- lib/freydis/options.rb
+- lib/freydis/rsync.rb
+- lib/freydis/version.rb
+homepage: https://github.com/szorfein/freydis
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/szorfein/freydis/issues
+  changelog_uri: https://github.com/szorfein/freydis/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/szorfein/freydis
+  wiki_uri: https://github.com/szorfein/freydis/wiki
+  funding_uri: https://patreon.com/szorfein
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- cryptsetup, v2.3
+- rsync, v3.2
+rubygems_version: 3.0.9
+signing_key:
+specification_version: 4
+summary: Backup and Restore data from encrypted device.
+test_files: []