grdn 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7b229d9582680e5555879fd1734b774668c4303cba71edfb7a461fd12e599349
+  data.tar.gz: 00f51d7b7850b46a0a40fb1dcad251d4ea673373f5880708c21149d5b977a904
+SHA512:
+  metadata.gz: fca162b2539e2173073d249fdc5eaca3a5effeb9131e8d2cb805178ea62ac15419fb0b3a040f142ef74115b38c4cdeb0e1414df23d1f8b3b9f1eaafd8cac18c4
+  data.tar.gz: 6a7bd6c7a4d5960aea6e32706db92599afd3e113f597dbc794a7ef4ec64c3e8d22e68d819b7035367412a3e1eb9f86e6575e50433ee9e19ad35c14b56b331195

data/.github/workflows/main.yml

@@ -0,0 +1,16 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7.0
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.grdn
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in grdn.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    grdn (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    rake (13.0.6)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+
+PLATFORMS
+  ruby
+  x86_64-darwin-20
+
+DEPENDENCIES
+  grdn!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.2.17

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Kevin Smith
+
+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,15 @@
+# Garden - a place for your seeds
+
+This tool stores seed phrases in a local directory (~/.grdn), and allows you to organize them hierarchically. Seeds are AES-128 encrypted with a password (the same one for all seeds), and stored in a tree structure. This allows organization by purpose, location, application, wallet, or anything else you can think of. They can be nested as deeply as you want. This tool is not recommended for security-critical usecases. 
+
+## Installation
+
+    $ gem install grdn
+
+## Usage
+
+To see usage information, run `grdn help`.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "grdn"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/grdn

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require "grdn"
+Grdn::CLI.new.execute

data/grdn.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/grdn/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "grdn"
+  spec.version       = Grdn::VERSION
+  spec.authors       = ["Kevin Smith"]
+  spec.email         = ["kevin.smith@coinbase.com"]
+
+  spec.summary       = "This is a program for organizing seed phrases and storing them locally, encrypted"
+  spec.homepage      = "https://github.com/ksmithbaylor/grdn"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/ksmithbaylor/grdn"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/grdn/cli.rb

@@ -0,0 +1,149 @@
+require 'io/console'
+
+module Grdn
+  class CLI
+    def execute
+      if ARGV.size == 0 || ['-h', '--help', 'help'].include?(ARGV[0])
+        cmd_help
+        exit
+      end
+
+      password = ask_password
+      @storage = Storage.new(password)
+
+      case ARGV.shift
+      when 'get'
+        cmd_get
+      when 'set'
+        cmd_set
+      when 'list'
+        cmd_list
+      when 'remove'
+        cmd_remove
+      else
+        raise Grdn::Error.new('Unknown command')
+      end
+    rescue Grdn::Error => e
+      STDERR.puts e.message
+      exit 1
+    end
+
+    def ask_password
+      IO::console.getpass 'Password: '
+    end
+
+    def cmd_help
+      puts <<~HELP
+                       Garden: a place for your seeds
+                            _
+                          _(_)_                          wWWWw   _
+              @@@@       (_)@(_)   vVVVv     _     @@@@  (___) _(_)_
+             @@()@@ wWWWw  (_)\\    (___)   _(_)_  @@()@@   Y  (_)@(_)
+              @@@@  (___)     `|/    Y    (_)@(_)  @@@@   \\|/   (_)\\
+               /      Y       \\|    \\|/    /(_)    \\|      |/      |
+            \\ |     \\ |/       | / \\ | /  \\|/       |/    \\|      \\|/
+            \\\\|//   \\\\|///  \\\\\\|//\\\\\\|/// \\|///  \\\\\\|//  \\\\|//  \\\\\\|// 
+        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+          This tool stores seed phrases in a local directory (~/.grdn),
+          and allows you to organize them hierarchically. Seeds are
+          AES-128 encrypted with a password (the same one for all seeds),
+          and stored in a tree structure. This allows organization by
+          purpose, location, application, wallet, or anything else you
+          can think of. They can be nested as deeply as you want. This
+          tool is not recommended for security-critical usecases.
+
+        =================================================================
+
+        Usage: grdn <command> [args]
+
+        Commands:
+          list                              List your seeds
+          set a [b c d e f ...]             Add a seed
+          get a [b c d e f ...]             Retrieve a seed
+          remove a [b c d e f ...]          Remove a seed
+
+        Example:
+          The following commands:
+            $ grdn set commerce development my.email+test@domain.com
+            $ grdn set commerce production my.email@domain.com
+            $ grdn set commerce production my.other.email@domain.com
+            $ grdn set phone coinbase-wallet username
+            $ grdn set laptop electrum default_wallet
+            $ grdn set random
+
+          would product this output:
+            $ grdn list
+
+            commerce
+              development
+                my.email+test@domain.com
+              production
+                my.email@domain.com
+                my.other.email@domain.com
+            laptop
+              electrum
+                default_wallet
+            phone
+              coinbase-wallet
+                username
+            random
+      HELP
+    end
+
+    def cmd_get
+      if ARGV.empty?
+        STDERR.puts "Path must contain at least one segment"
+        exit
+      end
+      puts @storage.get(ARGV)
+    end
+
+    def cmd_set
+      if ARGV.empty?
+        STDERR.puts "Path must contain at least one segment"
+        exit
+      end
+
+      print 'Seed (type or paste, then hit enter three times): '
+      $/ = "\n\n\n"
+      input = STDIN.noecho(&:gets)
+      $/ = "\n"
+      seed = input.strip.split.join(' ')
+      words = seed.split.size
+      valid_seed_lengths = [12, 24]
+      if !valid_seed_lengths.include? words
+        STDERR.puts "Invalid seed. That one is #{words} words, must be " \
+                    "#{valid_seed_lengths.join('/')} words"
+        exit 1
+      end
+      @storage.set(ARGV, seed)
+      STDERR.puts 'Seed saved!'
+      STDERR.puts "#{seed}"
+    end
+
+    def cmd_list
+      print_tree @storage.list
+      STDERR.puts
+    end
+
+    def cmd_remove
+      STDERR.puts "Printing here for safety: #{@storage.get(ARGV)}"
+      @storage.remove(ARGV)
+      STDERR.puts 'Seed removed!'
+    end
+
+    private
+
+    def print_tree(tree, indent = 2)
+      puts
+      tree.sort.to_h.each do |key, value|
+        next if key == Storage::FINAL_MARKER
+
+        print ' ' * indent
+        puts value[Storage::FINAL_MARKER] ? key.underline : key
+        print_tree(value, indent + 2) unless value.empty?
+      end
+    end
+  end
+end

data/lib/grdn/storage.rb

@@ -0,0 +1,115 @@
+require 'fileutils'
+require 'openssl'
+require 'digest'
+
+module Grdn
+  class Storage
+    DIR_NAME = '.grdn'
+    DEFAULT_LOCATION = File.expand_path(File.join(ENV['HOME'], DIR_NAME))
+    SALT = "\xB9R\xB5d\xBC#I?I7\x85<\xCD\xD6UW"
+    VALUE_FILENAME = 'seed.enc'
+    FINAL_MARKER = '____final____'
+    KEY_TEXT = 'password is correct'
+
+    def initialize(password, location = DEFAULT_LOCATION)
+      @location = location
+      @key = key_for(password)
+      FileUtils.mkdir_p @location
+      set_or_verify_password
+    end
+
+    def set(path, value)
+      if exists? path
+        raise Grdn::Error.new('Already exists, refusing to overwrite') 
+      end
+
+      FileUtils.mkdir_p dir_for(path)
+      File.write value_file_for(path), encrypt(value)
+    end
+
+    def get(path)
+      unless exists? path
+        raise Grdn::Error.new('Does not exist') 
+      end
+
+      decrypt File.read(value_file_for(path))
+    end
+
+    def remove(path)
+      FileUtils.rm_rf dir_for(path)
+    end
+
+    def list
+      absolute_paths = Dir.glob(File.join(@location, '**', VALUE_FILENAME))
+      paths = absolute_paths
+        .map { |p| File.dirname p }
+        .map { |p| p.gsub(@location + '/', '') }
+        .map { |p| p.split('/') }
+
+      tree = {}
+      
+      paths.each do |path|
+        cursor = tree
+        path.each do |part|
+          cursor[part] ||= {}
+          cursor = cursor[part]
+        end
+        cursor[FINAL_MARKER] = true
+      end
+      
+      tree
+    end
+
+    private
+
+    def exists?(path)
+      File.exist? value_file_for(path)
+    end
+
+    def set_or_verify_password
+      keyfile = File.join(@location, '.key')
+      if File.exist? keyfile
+        decrypt File.read(keyfile)
+      else
+        File.write(keyfile, encrypt(KEY_TEXT))
+      end
+    rescue OpenSSL::Cipher::CipherError
+      raise Grdn::Error.new('Wrong password')
+    end
+
+    def dir_for(path)
+      File.join(@location, *path)
+    end
+
+    def value_file_for(path)
+      dir = dir_for(path)
+      File.join(dir, VALUE_FILENAME)
+    end
+
+    def encrypt(string)
+      cipher = aes.encrypt
+      cipher.key = @key
+      cipher.update(string) + cipher.final
+    end
+
+    def decrypt(string)
+      cipher = aes.decrypt
+      cipher.key = @key
+      cipher.update(string) + cipher.final
+    end
+
+    def aes
+      OpenSSL::Cipher::AES.new(128, :CBC)
+    end
+
+    def key_for(password)
+      OpenSSL::KDF.pbkdf2_hmac(
+        password,
+        salt: SALT,
+        iterations: 1,
+        length: 16,
+        hash: OpenSSL::Digest::SHA256.new
+      )
+    end
+  end
+end

data/lib/grdn/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Grdn
+  VERSION = "0.1.0"
+end

data/lib/grdn.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative "grdn/version"
+
+class String
+  def underline
+    "\e[4m#{self}\e[24m"
+  end
+end
+
+module Grdn
+  class Error < StandardError; end
+  # Your code goes here...
+end
+
+require_relative "grdn/storage"
+require_relative "grdn/cli"

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: grdn
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kevin Smith
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-02-09 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- kevin.smith@coinbase.com
+executables:
+- grdn
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/grdn
+- grdn.gemspec
+- lib/grdn.rb
+- lib/grdn/cli.rb
+- lib/grdn/storage.rb
+- lib/grdn/version.rb
+homepage: https://github.com/ksmithbaylor/grdn
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/ksmithbaylor/grdn
+  source_code_uri: https://github.com/ksmithbaylor/grdn
+  changelog_uri: https://github.com/ksmithbaylor/grdn
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: This is a program for organizing seed phrases and storing them locally, encrypted
+test_files: []