trocla 0.5.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c97189ff5ad5fa72b1bd544184e6f6d7908f5a2c4bb2a7e26354e8752f0896d
-  data.tar.gz: 98dce1e963a7e1be22e74fe5664cd1e691af5ed7feed97e87f43f584991d433f
+  metadata.gz: 1e516b5dbf1bdca34c4c47a440672337c3c7f8694593ff2b06ae2a2602a6b907
+  data.tar.gz: ce60947349c3faf08f7d0cda00fa3ddeeae6c09a1b8f8947695134c74e72b101
 SHA512:
-  metadata.gz: b860303d450b55006d09ec67af5827b5d5f4421d00ec37a83258a6be04f0b5689af23edba371839650d196f95b2d2a9563fc836743888554fbafcc777a4f00a5
-  data.tar.gz: 3d3aec51b897e5236e0936f791bc100c00524fb16dd1524b23766ac8716b5ad93b439b86cf2a31ab7cf547b5b0834701fb76b3332c100aa83076f590a3276d6b
+  metadata.gz: 900ce53ad161c3a8819353205c685ebae03d95f303df6af34e5cd4771ab1fc4711684aad9411bdd9aab85d8426873ea179a03f288b47e38c9351b1c49c757528
+  data.tar.gz: eb344684031b86e4e56cd75c2530f9542d051fc1e395141c4c68070f03e4ba53784d6bdfcdbcf08d563af62e770526b1a7e2d9a1ac56c7daf6371ac6120a5397

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## to 0.7.0
+
+* bump support for various dependencies and ruby versions
+* get rid off jeweler gem
+
+## to 0.6.0
+
+* move away from sha1 since they are not supported anymore on all distributions
+* fix tests on various platforms and newer ruby versions
+* introduce hooks for set and delete actions
+
 ## to 0.5.1
 
 * support more moneta versions (#78) - Thank you [jcharaoui](https://github.com/jcharaoui)

data/README.md

@@ -1,5 +1,5 @@
 # trocla
-[![Build Status](https://travis-ci.org/duritong/trocla.png)](https://travis-ci.org/duritong/trocla)
+[![Ruby](https://github.com/duritong/trocla/actions/workflows/ruby.yml/badge.svg)](https://github.com/duritong/trocla/actions/workflows/ruby.yml)
 
 Trocla provides you a simple way to create and store (random) passwords on a
 central server, which can be retrieved by other applications. An example for
@@ -373,6 +373,37 @@ encryption_options:
     :public_key: '/var/lib/puppet/ssl/public_keys/trocla.pem'
 ```
 
+## Hooks
+
+You can specify hooks to be called whenever trocla sets or deletes a password. The idea is that this allows you to run custom code that can trigger further actions based on deleting or setting a password.
+
+Enabling hooks is done through the following configuration:
+
+```YAML
+hooks:
+  set:
+    my_hook: /path/to/my_hook_file.rb
+  delete:
+    other_hook: /path/to/my_other_hook_file.rb
+```
+
+A hook must have the following implementation based on the above config:
+
+```Ruby
+class Trocla
+  module Hooks
+    def self.my_hook(trocla, key, format, options)
+      # [... your code ...]
+    end
+  end
+end
+```
+You can specify only either one or both kinds of hooks.
+
+Hooks must not raise any exceptions or interrupt the flow itself. They can also not change the value that was set or revert a deletion.
+
+However, they have Trocla itself available (through `trocla`) and you must ensure to not create infinite loops.
+
 ## Update & Changes
 
 See [Changelog](CHANGELOG.md)

data/lib/trocla/hooks.rb

@@ -0,0 +1,33 @@
+class Trocla
+  module Hooks
+    class Runner
+      attr_reader :trocla
+      def initialize(trocla)
+        @trocla = trocla
+      end
+
+      def run(action, key, format, options)
+        return unless hooks[action]
+        hooks[action].each do |cmd|
+          Trocla::Hooks.send(cmd, trocla, key, format, options)
+        end
+      end
+
+      private
+
+      def hooks
+        @hooks ||= begin
+          res = {}
+          (trocla.config['hooks'] || {}).each do |action,action_hooks|
+            res[action] ||= []
+            action_hooks.each do |cmd,file|
+              require File.join(file)
+              res[action] << cmd
+            end
+          end
+          res
+        end
+      end
+    end
+  end
+end

data/lib/trocla/version.rb

@@ -1,20 +1,11 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 class Trocla
-  # VERSION
-  class VERSION
-    version = {}
-    File.read(File.join(File.dirname(__FILE__), '../', 'VERSION')).each_line do |line|
-      type, value = line.chomp.split(':')
-      next if type =~ /^\s+$/ || value =~ /^\s+$/
-
-      version[type] = value
-    end
-
-    MAJOR = version['major']
-    MINOR = version['minor']
-    PATCH = version['patch']
-    BUILD = version['build']
+  module VERSION
+    MAJOR = 0
+    MINOR = 7
+    PATCH = 0
+    BUILD = nil
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')
 

data/lib/trocla.rb

@@ -3,6 +3,7 @@ require 'trocla/util'
 require 'trocla/formats'
 require 'trocla/encryptions'
 require 'trocla/stores'
+require 'trocla/hooks'
 
 # Trocla class
 class Trocla
@@ -67,6 +68,7 @@ class Trocla
 
   def delete_password(key, format = nil, options = {})
     v = store.delete(key, format)
+    hooks_runner.run('delete', key, format, options)
     if v.is_a?(Hash)
       Hash[*v.map do |f, encrypted_value|
         [f, render(format, decrypt(encrypted_value), options)]
@@ -78,6 +80,7 @@ class Trocla
 
   def set_password(key, format, password, options = {})
     store.set(key, format, encrypt(password), options)
+    hooks_runner.run('set', key, format, options)
     render(format, password, options)
   end
 
@@ -122,6 +125,12 @@ class Trocla
     clazz.new(config['store_options'], self)
   end
 
+  def hooks_runner
+    @hooks_runner ||= begin
+      Trocla::Hooks::Runner.new(self)
+    end
+  end
+
   def read_config
     if @config_file.nil?
       default_config

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: trocla
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.7.0
 platform: ruby
 authors:
 - mh
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-17 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -16,161 +15,153 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: moneta
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: bcrypt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: sshkey
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: base64
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 0.3.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
-  name: addressable
+  name: pstore
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '0.2'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
-  name: jeweler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.13'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rspec-pending_for
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
-  name: rspec-pending_for
+  name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.0'
 description: Trocla helps you to generate random passwords and to store them in various
-  formats (plain, MD5, bcrypt) for later retrival.
-email: mh+trocla@immerda.ch
+  formats (plain, MD5, bcrypt) for later retrieval.
+email:
+- mh+trocla@immerda.ch
 executables:
 - trocla
 extensions: []
-extra_rdoc_files:
-- LICENSE.txt
-- README.md
+extra_rdoc_files: []
 files:
-- ".document"
-- ".github/workflows/ruby.yml"
-- ".rspec"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - bin/trocla
-- ext/redhat/rubygem-trocla.spec
-- lib/VERSION
 - lib/trocla.rb
 - lib/trocla/default_config.yaml
 - lib/trocla/encryptions.rb
@@ -189,6 +180,7 @@ files:
 - lib/trocla/formats/sshkey.rb
 - lib/trocla/formats/wireguard.rb
 - lib/trocla/formats/x509.rb
+- lib/trocla/hooks.rb
 - lib/trocla/store.rb
 - lib/trocla/stores.rb
 - lib/trocla/stores/memory.rb
@@ -196,23 +188,13 @@ files:
 - lib/trocla/stores/vault.rb
 - lib/trocla/util.rb
 - lib/trocla/version.rb
-- spec/data/.keep
-- spec/spec_helper.rb
-- spec/trocla/encryptions/none_spec.rb
-- spec/trocla/encryptions/ssl_spec.rb
-- spec/trocla/formats/pgsql_spec.rb
-- spec/trocla/formats/sshkey_spec.rb
-- spec/trocla/formats/x509_spec.rb
-- spec/trocla/store/memory_spec.rb
-- spec/trocla/store/moneta_spec.rb
-- spec/trocla/util_spec.rb
-- spec/trocla_spec.rb
-- trocla.gemspec
 homepage: https://tech.immerda.ch/2011/12/trocla-get-hashed-passwords-out-of-puppet-manifests/
 licenses:
-- GPLv3
-metadata: {}
-post_install_message:
+- GPL-3.0-or-later
+metadata:
+  homepage_uri: https://tech.immerda.ch/2011/12/trocla-get-hashed-passwords-out-of-puppet-manifests/
+  source_code_uri: https://github.com/duritong/trocla
+  changelog_uri: https://github.com/duritong/trocla/blob/master/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib
@@ -220,15 +202,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
-signing_key:
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Trocla a simple password generator and storage
 test_files: []

data/.document

@@ -1,4 +0,0 @@
-lib/**/*.rb
-bin/*
-- 
-LICENSE.txt

data/.github/workflows/ruby.yml

@@ -1,24 +0,0 @@
----
-name: Ruby
-on: [push, pull_request]
-jobs:
-  spec:
-    runs-on: ubuntu-latest
-    steps:
-      - name: check out repository
-        uses: actions/checkout@v3
-      - name: set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          bundler-cache: true
-          ruby-version: ${{ matrix.ruby }}
-      - name: install dependencies
-        run: bundle install
-      - name: install wireguard
-        run: sudo apt install -y wireguard
-      - name: run rspec
-        run: bundle exec rake spec
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby: ['2.5','2.7', '3.0', '3.1','head','jruby','jruby-head']

data/.rspec

@@ -1 +0,0 @@
---color --format documentation

data/Gemfile

@@ -1,24 +0,0 @@
-source 'http://rubygems.org'
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
-
-gem 'highline', '~> 2.0.0'
-gem 'moneta', '~> 1.0'
-
-if defined?(RUBY_ENGINE) && (RUBY_ENGINE == 'jruby')
-  gem 'jruby-openssl'
-end
-gem 'bcrypt'
-gem 'sshkey'
-
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
-group :development do
-  gem 'rake'
-  gem 'addressable'
-  gem 'jeweler', '~> 2.0'
-  gem 'rdoc'
-  gem 'rspec'
-  gem 'rspec-pending_for'
-end

data/Rakefile

@@ -1,53 +0,0 @@
-# encoding: utf-8
-
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'rake'
-
-
-require 'jeweler'
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))
-require 'trocla'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "trocla"
-  gem.homepage = "https://tech.immerda.ch/2011/12/trocla-get-hashed-passwords-out-of-puppet-manifests/"
-  gem.license = "GPLv3"
-  gem.summary = "Trocla a simple password generator and storage" 
-  gem.description = "Trocla helps you to generate random passwords and to store them in various formats (plain, MD5, bcrypt) for later retrival."
-  gem.email = "mh+trocla@immerda.ch"
-  gem.authors = ["mh"]
-  gem.version = Trocla::VERSION::STRING
-  # dependencies defined in Gemfile
-end
-Jeweler::RubygemsDotOrgTasks.new
-
-require 'rspec/core'
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
-end
-
-RSpec::Core::RakeTask.new(:rcov) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
-
-task :default => :spec
-
-gem 'rdoc'
-require 'rdoc/task'
-RDoc::Task.new do |rdoc|
-  version = Trocla::VERSION::STRING
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "trocla #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/ext/redhat/rubygem-trocla.spec

@@ -1,120 +0,0 @@
-# Generated from trocla-0.1.2.gem by gem2rpm -*- rpm-spec -*-
-%global gem_name trocla
-
-Name: rubygem-%{gem_name}
-Version: 0.3.0
-Release: 1%{?dist}
-Summary: Trocla a simple password generator and storage
-Group: Development/Languages
-License: GPLv3
-URL: https://tech.immerda.ch/2011/12/trocla-get-hashed-passwords-out-of-puppet-manifests/
-Source0: https://rubygems.org/gems/%{gem_name}-%{version}.gem
-Requires: rubygem-moneta
-Requires: rubygem-bcrypt
-Requires: rubygem-highline
-BuildRequires: rubygem-moneta = 0.7.20
-BuildRequires: rubygem-bcrypt
-BuildRequires: rubygem-highline
-%if 0%{?rhel} >= 7
-BuildRequires: ruby(release)
-%endif
-BuildRequires: rubygems-devel
-BuildRequires: ruby
-# BuildRequires: rubygem(mocha)
-# BuildRequires: rubygem(rspec) => 2.4
-# BuildRequires: rubygem(rspec) < 3
-# BuildRequires: rubygem(jeweler) => 1.6
-# BuildRequires: rubygem(jeweler) < 2
-BuildArch: noarch
-
-%description
-Trocla helps you to generate random passwords and to store them in various
-formats (plain, MD5, bcrypt) for later retrival.
-
-
-%package doc
-Summary: Documentation for %{name}
-Group: Documentation
-Requires: %{name} = %{version}-%{release}
-BuildArch: noarch
-
-%description doc
-Documentation for %{name}.
-
-%prep
-gem unpack %{SOURCE0}
-
-%setup -q -D -T -n  %{gem_name}-%{version}
-
-gem spec %{SOURCE0} -l --ruby > %{gem_name}.gemspec
-
-%build
-# Create the gem as gem install only works on a gem file
-gem build %{gem_name}.gemspec
-
-# %%gem_install compiles any C extensions and installs the gem into ./%%gem_dir
-# by default, so that we can move it into the buildroot in %%install
-%gem_install
-
-%install
-mkdir -p %{buildroot}%{gem_dir}
-cp -a .%{gem_dir}/* \
-        %{buildroot}%{gem_dir}/
-
-
-mkdir -p %{buildroot}%{_bindir}
-mkdir -p %{buildroot}%{_sysconfdir}
-mkdir -p %{buildroot}/%{_sharedstatedir}/%{gem_name}
-touch %{buildroot}/%{_sharedstatedir}/%{gem_name}/%{gem_name}_data.yaml
-
-cp -pa .%{_bindir}/* \
-        %{buildroot}%{_bindir}/
-
-chmod a+x %{buildroot}%{gem_instdir}/bin/%{gem_name}
-
-cat <<EOF > %{buildroot}/%{_sysconfdir}/%{gem_name}rc.yaml
----
-store: :moneta
-store_options:
-  adapter: :YAML
-  adapter_options:
-    :file: '%{_sharedstatedir}/%{gem_name}/%{gem_name}_data.yaml'
-EOF
-
-# Run the test suite
-%check
-pushd .%{gem_instdir}
-
-popd
-
-%files
-%dir %{gem_instdir}
-%{_bindir}/trocla
-%{gem_instdir}/.rspec
-%exclude %{gem_instdir}/.travis.yml
-%exclude %{gem_instdir}/.rspec
-%exclude %{gem_instdir}/ext/redhat/%{name}.spec
-%license %{gem_instdir}/LICENSE.txt
-%{gem_instdir}/bin
-%{gem_libdir}
-%exclude %{gem_cache}
-%{gem_spec}
-%config(noreplace) %{_sysconfdir}/%{gem_name}rc.yaml
-%dir %attr(-, -, -) %{_sharedstatedir}/%{gem_name}
-%config(noreplace) %attr(660, root, root) %{_sharedstatedir}/%{gem_name}/%{gem_name}_data.yaml
-
-%files doc
-%doc %{gem_docdir}
-%doc %{gem_instdir}/.document
-%{gem_instdir}/Gemfile
-%doc %{gem_instdir}/README.md
-%doc %{gem_instdir}/CHANGELOG.md
-%{gem_instdir}/Rakefile
-%{gem_instdir}/spec
-%{gem_instdir}/trocla.gemspec
-
-%changelog
-* Mon Dec 21 2015 mh - 0.2.0-1
-- Release of v0.2.0
-* Sun Jun 21 2015 mh - 0.1.2-1
-- Initial package

data/lib/VERSION

@@ -1,4 +0,0 @@
-major:0
-minor:5
-patch:1
-build: