h 4.0.0 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c0ae3b158ff41bdca434eaaacd48a2c2e9ebd79d
-  data.tar.gz: e5019914b6044ea05a060636a8778e9d0c128640
+SHA256:
+  metadata.gz: 74221be01ab8dc401a378861ec34dc6503137000783ec47bb1f1ea3f00cf2307
+  data.tar.gz: baa11435f26bd735ab88248180a95e63fed3eb48e6b373121d4de84a0adee389
 SHA512:
-  metadata.gz: e9fc33a412e2a2a90f1780c4749c4b7e1fe9a7b547983d40e1685a2ee49afa7f1e40d405fe4e89fff04d6b5b44336c1b578a6341e7cbf73a8dca7d05b323f752
-  data.tar.gz: 45bab5002bd34e05e5116b90bca05f6416744cd75063ebee381bc241441dc3f676f4e1b1824523f350b176545ce29b92e509b55b285ed2bf7910c3e5a6abf011
+  metadata.gz: 16aad9027f3feb7e62c3f6a5b26bc08b2d8dc7e9bacaf6a1b546d43475d01b48b575488fed5b4f31c7894b367e381d0636342c84198691240bd68a5d25b9034e
+  data.tar.gz: db986b971cf607961ca5696d0bffa240a89e95609781dc87070e1b2bcd751e075b5a8ecc204f71cb58fe581db166a6ecd2e6e49c7a7ef4450ab9f4bd86c00429

data/LICENSE.md

@@ -1,13 +1,21 @@
-Copyright (c) 2011, Cyril Kato
-
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted, provided that the above
-copyright notice and this permission notice appear in all copies.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
-WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
-MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
-ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
-WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
-ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
-OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+The MIT License (MIT)
+
+Copyright (c) 2011-2025 Cyril Kato
+
+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

@@ -1,4 +1,4 @@
-# H
+# H.rb
 
 ## Overview
 
@@ -14,23 +14,35 @@ Small tool that generates salted hashes, scented with the SHA-256 hash function.
 
 ## Configuration
 
-H reads its configuration from the `~/.h` file at initialization.
+**H** reads its configuration from the `~/.h` file at initialization.
 This file, which should be readable by its owner only, have the salt value.
 
 ## Examples
 
+Settings:
+
+```sh
+echo "my-secret" > ~/.h
+```
+
 Generate a digest from the system:
 
 ```sh
-$ echo "my-secret" > ~/.h
+h p@ssw0rd
+```
+
+Result:
 
-$ h p@ssw0rd
-+KsELdbw7gM0e2lQsnCskf1albEXgl9MtXgrmvYkIaM=
+> `+KsELdbw7gM0e2lQsnCskf1albEXgl9MtXgrmvYkIaM=`
 
-$ h シークレット
-NaNvnGJGWWzzU9DlRSRKZQQER1/9/libXrrghMgBWbU=
+```sh
+h シークレット
 ```
 
+Result:
+
+> `NaNvnGJGWWzzU9DlRSRKZQQER1/9/libXrrghMgBWbU=`
+
 Same operations, with Ruby:
 
 ```ruby
@@ -38,17 +50,42 @@ require "h"
 
 builder = H::Builder.new("my-secret")
 
-builder.call("p@ssw0rd") # => +KsELdbw7gM0e2lQsnCskf1albEXgl9MtXgrmvYkIaM=
-builder.call("シークレット") # => NaNvnGJGWWzzU9DlRSRKZQQER1/9/libXrrghMgBWbU=
+builder.call("p@ssw0rd") # => "+KsELdbw7gM0e2lQsnCskf1albEXgl9MtXgrmvYkIaM="
+builder.call("シークレット") # => "NaNvnGJGWWzzU9DlRSRKZQQER1/9/libXrrghMgBWbU="
+```
+
+## Alternative Implementations
+
+Shell script implementations are available in the `alternatives/` directory:
+
+### Bash Implementation
+
+A POSIX-compliant version focusing on compatibility and security:
+
+```sh
+./alternatives/bash/h.sh p@ssw0rd
+```
+
+Result:
+
+> `+KsELdbw7gM0e2lQsnCskf1albEXgl9MtXgrmvYkIaM=`
+
+### Zsh Implementation
+
+A modern implementation using ZSH-specific features:
+
+```sh
+./alternatives/zsh/h.zsh p@ssw0rd
 ```
 
-## Status
+Result:
 
-* [![Gem Version](https://badge.fury.io/rb/h.png)](http://badge.fury.io/rb/h)
-* [![Build Status](https://secure.travis-ci.org/cyril/h.rb.png)](//travis-ci.org/cyril/h.rb)
-* [![Dependency Status](https://gemnasium.com/cyril/h.rb.svg)](//gemnasium.com/cyril/h.rb)
-* ![](https://ruby-gem-downloads-badge.herokuapp.com/h?type=total)
+> `+KsELdbw7gM0e2lQsnCskf1albEXgl9MtXgrmvYkIaM=`
 
-***
+Both shell implementations:
+- Use the same configuration file (`~/.h`)
+- Provide identical output format
+- Enforce secure file permissions
+- Handle cleanup automatically
 
-Copyright (c) 2014 Cyril Kato, released under the [ISC license](LICENSE.md)
+See individual READMEs in the `alternatives/` directory for implementation details.

data/bin/h

@@ -1,19 +1,18 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require_relative File.join('..', 'lib', 'h')
+require_relative File.join("..", "lib", "h")
 
-CONF_PATH = File.join(File.expand_path('~'), '.h')
+CONF_PATH = File.join(File.expand_path("~"), ".h")
 
 unless File.exist?(CONF_PATH)
   print "Creating #{CONF_PATH} file... "
 
-  File.open(CONF_PATH, 'w') do |f|
-    f.write('secret')
-  end
+  File.write(CONF_PATH, "secret")
 
-  File.chmod(0600, CONF_PATH)
+  File.chmod(600, CONF_PATH)
 
-  puts 'Done.'
+  puts "Done."
 end
 
 secret  = File.open(CONF_PATH)

data/lib/h.rb

@@ -1,13 +1,28 @@
-require 'digest/sha2'
+# frozen_string_literal: true
 
+require "digest/sha2"
+
+# H module provides secure password hashing functionality
+# @example
+#   builder = H::Builder.new("my-secret-salt")
+#   hash = builder.call("my-password")
 module H
+  # Builder handles the creation of salted password hashes using SHA-256
   class Builder
+    # @return [String] the secret salt used for hashing
     attr_reader :secret
 
+    # Initialize a new Builder with a secret salt
+    # @param secret [Object] the salt to use for hashing (will be converted to String)
     def initialize(secret)
-      @secret = secret
+      @secret = String(secret)
+
+      freeze
     end
 
+    # Generate a salted hash of the provided value
+    # @param value [String] the value to hash
+    # @return [String] Base64 encoded SHA-256 hash
     def call(value)
       ::Digest::SHA256.base64digest("#{value}++#{secret}")
     end

metadata

@@ -1,110 +1,33 @@
 --- !ruby/object:Gem::Specification
 name: h
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.0.1
 platform: ruby
 authors:
 - Cyril Kato
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-25 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.15'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.15'
-- !ruby/object:Gem::Dependency
-  name: fix
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.17'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.17'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.1'
-- !ruby/object:Gem::Dependency
-  name: coveralls
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-description: Small tool that generates salted hashes, scented with the SHA2 function,
+date: 2025-01-07 00:00:00.000000000 Z
+dependencies: []
+description: 'Small tool that generates salted hashes, scented with the SHA2 function,
   for those who prefer to put makeup on passwords rather than yield them to Manager™.
-email:
-- contact@cyril.email
+
+  '
+email: contact@cyril.email
 executables:
-- console
 - h
-- setup
 extensions: []
 extra_rdoc_files: []
 files:
-- ".coveralls.yml"
-- ".gitignore"
-- ".ruby-version"
-- ".travis.yml"
-- ".yardoc/checksums"
-- ".yardoc/complete"
-- ".yardoc/object_types"
-- ".yardoc/objects/root.dat"
-- ".yardoc/proxy_types"
-- Gemfile
 - LICENSE.md
 - README.md
-- Rakefile
-- VERSION.semver
-- bin/console
 - bin/h
-- bin/setup
-- h.gemspec
 - lib/h.rb
-- test/_test_helper.rb
-- test/support.rb
-- test/support/coverage.rb
-- test/test_h.rb
 homepage: https://github.com/cyril/h.rb
 licenses:
-- ISC
-metadata: {}
-post_install_message: 
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -112,20 +35,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Salted hashes tool
-test_files:
-- test/_test_helper.rb
-- test/support.rb
-- test/support/coverage.rb
-- test/test_h.rb
+test_files: []

data/.coveralls.yml

@@ -1 +0,0 @@
-service_name: travis-ci

data/.gitignore

@@ -1,5 +0,0 @@
-*.gem
-.bundle
-Gemfile.lock
-pkg/*
-/coverage/

data/.ruby-version

@@ -1 +0,0 @@
-2.4.1

data/.travis.yml

@@ -1,13 +0,0 @@
-language: ruby
-sudo: false
-cache: bundler
-script: 'bundle exec rake test:coverage --trace'
-before_install:
-  - gem install bundler
-rvm:
-  - 2.0
-  - 2.1
-  - 2.2
-  - ruby-head
-  - jruby-head
-  - rbx-2

data/.yardoc/checksums

@@ -1 +0,0 @@
-lib/h.rb 8584911e99ca0561a69fe42a5228a2082f705432

data/Gemfile

@@ -1,3 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec

data/Rakefile

@@ -1,16 +0,0 @@
-require 'bundler/gem_tasks'
-require 'rake/testtask'
-
-Rake::TestTask.new do |t|
-  t.verbose = true
-  t.warning = true
-end
-
-namespace :test do
-  task :coverage do
-    ENV['COVERAGE'] = 'true'
-    Rake::Task['test'].invoke
-  end
-end
-
-task default: %i[test]

data/VERSION.semver

@@ -1 +0,0 @@
-4.0.0

data/bin/console

@@ -1,7 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'bundler/setup'
-require 'h'
-
-require 'irb'
-IRB.start

data/bin/setup

@@ -1,6 +0,0 @@
-#!/bin/bash
-
-set -euo pipefail
-IFS=$'\n\t'
-
-bundle install

data/h.gemspec

@@ -1,22 +0,0 @@
-Gem::Specification.new do |spec|
-  spec.name          = 'h'
-  spec.version       = File.read('VERSION.semver')
-  spec.authors       = ['Cyril Kato']
-  spec.email         = ['contact@cyril.email']
-  spec.homepage      = 'https://github.com/cyril/h.rb'
-  spec.summary       = 'Salted hashes tool'
-  spec.description   = 'Small tool that generates salted hashes, scented '    \
-                       'with the SHA2 function, for those who prefer to put ' \
-                       'makeup on passwords rather than yield them to Manager™.'
-  spec.license       = 'ISC'
-
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(/^test\//)
-  spec.require_paths = ['lib']
-
-  spec.add_development_dependency 'bundler',    '~> 1.15'
-  spec.add_development_dependency 'fix',        '~> 0.17'
-  spec.add_development_dependency 'rake',       '~> 12.1'
-  spec.add_development_dependency 'coveralls',  '~> 0.8'
-end

data/test/_test_helper.rb

@@ -1,3 +0,0 @@
-require_relative 'support'
-require_relative File.join '..', 'lib', 'h'
-require 'fix'

data/test/support/coverage.rb

@@ -1,9 +0,0 @@
-require 'simplecov'
-require 'coveralls'
-
-SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
-  SimpleCov::Formatter::HTMLFormatter,
-  Coveralls::SimpleCov::Formatter
-]
-
-SimpleCov.start

data/test/support.rb

@@ -1,3 +0,0 @@
-Dir[File.join File.dirname(__FILE__), 'support', '**' '*.rb'].each do |filename|
-  require_relative filename
-end

data/test/test_h.rb

@@ -1,31 +0,0 @@
-require_relative '_test_helper'
-
-Fix.describe H::Builder do
-  on :new, 'my-secret' do
-    on :call, nil do
-      it { MUST eql 'NKLNPIzInF96PBmMCqZR1jFaIoHn9c1y0n8jtMam4cs=' }
-    end
-
-    on :call, 'p@ssw0rd' do
-      it { MUST eql '+KsELdbw7gM0e2lQsnCskf1albEXgl9MtXgrmvYkIaM=' }
-    end
-
-    on :call, 'シークレット' do
-      it { MUST eql 'NaNvnGJGWWzzU9DlRSRKZQQER1/9/libXrrghMgBWbU=' }
-    end
-  end
-
-  on :new, nil do
-    on :call, nil do
-      it { MUST eql 'z8DAYHozgPeXU0azDBSvgoT1ST2XgbDthH9JnwG0do4=' }
-    end
-
-    on :call, 'p@ssw0rd' do
-      it { MUST eql 'M1YbuYA4RzKHPYXaUm/GH49wLTA8JOu4WCGbt8QVOrE=' }
-    end
-
-    on :call, 'シークレット' do
-      it { MUST eql 'jBU9DIODvHm1tTS7LHHJ1fM/SD3dIgwbYs8sXQkttJw=' }
-    end
-  end
-end