glogin 0.10.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cbb6b682a4165d9835c47fc78a8ca518ddc3fb01b8292a1f3eb202aad075f6fd
-  data.tar.gz: b697264e4615fc83a4039781001ff324d632e393cba2d1f759fcf6ab3c21b600
+  metadata.gz: d64766709045453b457180e430e7c21e92e0d2aa83aaf5045496dd579f20ecb4
+  data.tar.gz: '0829be0aa00b90774dfe10c2f2a0957dac27bb516f3c5558127432dea85453fc'
 SHA512:
-  metadata.gz: 12201bbccf0b2f44210030dc3e8bef73a323a33b773f855ffb853b207eff281ff266de90ee344e54470d1d997d58c01f66274ce3cddb187ad81bb433ade74bee
-  data.tar.gz: 0031771355c95b84efb2b7293ef60d7e3cbb313fda141bc0470db792b95383ee980ac027984189ec0f4751a51449b6f1e7131fa5c1c10afe6d4029e8ba01349a
+  metadata.gz: 6242a74d222652a65b6039c10c584e4bd32f581e279d38c86e435f40a1abaac0fcde212f8b827a826d7ebef36e80310072b6636ffe840b341ae3cf636a2499c3
+  data.tar.gz: af688ddc396853533c69b4377c9fe3e4dc3308d8cb9c11d8ef0113c39aa806c8f78d6b22562853aafc26ac89c89d75f0b4604fbc74b8a062c83c2afd1773f4e1

data/.github/workflows/codecov.yml

@@ -6,7 +6,7 @@ on:
       - master
 jobs:
   codecov:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     steps:
       - uses: actions/checkout@v3
       - uses: ruby/setup-ruby@v1

data/.github/workflows/pdd.yml

@@ -5,7 +5,7 @@ on:
   pull_request:
 jobs:
   pdd:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     steps:
       - uses: actions/checkout@v3
       - uses: g4s8/pdd-action@master

data/.github/workflows/xcop.yml

@@ -5,7 +5,7 @@ on:
   pull_request:
 jobs:
   xcop:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     steps:
       - uses: actions/checkout@v3
       - uses: g4s8/xcop-action@master

data/.rubocop.yml

@@ -20,8 +20,8 @@ Metrics/AbcSize:
 Metrics/BlockLength:
   Max: 30
 Metrics/CyclomaticComplexity:
-  Max: 10
+  Max: 20
 Metrics/PerceivedComplexity:
-  Max: 10
+  Max: 20
 Layout/EmptyLineAfterGuardClause:
   Enabled: false

data/.rultor.yml

@@ -3,9 +3,11 @@ docker:
 assets:
   rubygems.yml: yegor256/home#assets/rubygems.yml
 install: |
+  sudo gem install openssl -- --with-openssl-dir=/usr/local/rvm/rubies/ruby-3.0.1/lib/ruby/3.0.0/openssl
   pdd -f /dev/null
   sudo bundle install --no-color "--gemfile=$(pwd)/Gemfile"
 release:
+  pre: false
   script: |-
     [[ "${tag}" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]] || exit -1
     bundle exec rake

data/Gemfile

@@ -23,3 +23,12 @@
 
 source 'https://rubygems.org'
 gemspec
+
+gem 'minitest', '5.19.0', require: false
+gem 'rake', '13.0.6', require: false
+gem 'rdoc', '6.5.0', require: false
+gem 'rspec-rails', '6.0.3', require: false
+gem 'rubocop', '1.56.0', require: false
+gem 'rubocop-rspec', '2.23.2', require: false
+gem 'simplecov', '0.22.0', require: false
+gem 'webmock', '3.18.1', require: false

data/glogin.gemspec

@@ -41,14 +41,7 @@ Gem::Specification.new do |s|
   s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
   s.rdoc_options = ['--charset=UTF-8']
   s.extra_rdoc_files = ['README.md', 'LICENSE.txt']
-  s.add_runtime_dependency 'base58', '0.2.3'
-  s.add_development_dependency 'minitest', '5.16.1'
-  s.add_development_dependency 'rake', '13.0.6'
-  s.add_development_dependency 'rdoc', '6.4.0'
-  s.add_development_dependency 'rspec-rails', '5.1.2'
-  s.add_development_dependency 'rubocop', '1.31.1'
-  s.add_development_dependency 'rubocop-rspec', '2.11.1'
-  s.add_development_dependency 'simplecov', '0.22.0'
-  s.add_development_dependency 'webmock', '3.14.0'
+  s.add_runtime_dependency 'base58', '~>0.2'
+  s.add_runtime_dependency 'openssl', '~>3.1'
   s.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/glogin/codec.rb

@@ -25,6 +25,7 @@ require 'securerandom'
 require 'openssl'
 require 'digest/sha1'
 require 'base58'
+require 'base64'
 
 # Codec.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
@@ -36,9 +37,13 @@ module GLogin
     # When can't decode.
     class DecodingError < StandardError; end
 
-    def initialize(secret = '')
+    # Ctor.
+    # +secret+: The secret to do the encoding
+    # +base64+: If TRUE, Base-64 will be used, otherwise Base-58
+    def initialize(secret = '', base64: false)
       raise 'Secret can\'t be nil' if secret.nil?
       @secret = secret
+      @base64 = base64
     end
 
     def decrypt(text)
@@ -48,9 +53,13 @@ module GLogin
       else
         cpr = cipher
         cpr.decrypt
-        cpr.key = digest
-        raise DecodingError unless /^[a-zA-Z0-9]+$/.match?(text)
-        plain = Base58.base58_to_binary(text)
+        cpr.key = digest(cpr.key_len)
+        if @base64
+          raise DecodingError, 'This is not Base64' unless %r{^[a-zA-Z0-9\\+/=]+$}.match?(text)
+        else
+          raise DecodingError, 'This is not Base58' unless /^[a-zA-Z0-9]+$/.match?(text)
+        end
+        plain = @base64 ? Base64.decode64(text) : Base58.base58_to_binary(text)
         raise DecodingError if plain.empty?
         decrypted = cpr.update(plain)
         decrypted << cpr.final
@@ -71,16 +80,18 @@ module GLogin
       else
         cpr = cipher
         cpr.encrypt
-        cpr.key = digest
+        cpr.key = digest(cpr.key_len)
         salt = SecureRandom.base64(Random.rand(8..32))
         encrypted = cpr.update("#{salt} #{text}")
         encrypted << cpr.final
-        Base58.binary_to_base58(encrypted)
+        @base64 ? Base64.encode64(encrypted).gsub("\n", '') : Base58.binary_to_base58(encrypted)
       end
     end
 
-    def digest
-      Digest::SHA1.hexdigest(@secret)[0..31]
+    private
+
+    def digest(len)
+      Digest::SHA1.hexdigest(@secret)[0..len - 1]
     end
 
     def cipher

data/lib/glogin/version.rb

@@ -26,5 +26,5 @@
 # Copyright:: Copyright (c) 2017-2023 Yegor Bugayenko
 # License:: MIT
 module GLogin
-  VERSION = '0.10.0'
+  VERSION = '0.12.0'
 end

data/test/glogin/test_codec.rb

@@ -54,12 +54,25 @@ class TestCodec < Minitest::Test
     assert(!text.include?("\n"), text)
   end
 
+  def test_encrypts_using_base64
+    codec = GLogin::Codec.new('6hFGrte5LLmwi', base64: true)
+    text = 'Hello, world!'
+    enc = codec.encrypt(text)
+    assert_equal(text, codec.decrypt(enc))
+  end
+
   def test_decrypts_broken_text
     assert_raises GLogin::Codec::DecodingError do
       GLogin::Codec.new('the key').decrypt('этот текст не был зашифрован')
     end
   end
 
+  def test_decrypts_broken_text_with_empty_key
+    assert_raises GLogin::Codec::DecodingError do
+      GLogin::Codec.new('key').decrypt('')
+    end
+  end
+
   def test_encrypts_and_decrypts_with_empty_key
     crypt = GLogin::Codec.new
     text = 'This is the text, дорогой друг!'

metadata

@@ -1,141 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: glogin
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-02 00:00:00.000000000 Z
+date: 2023-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base58
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: '0.2'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: openssl
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.16.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 5.16.1
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 13.0.6
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 13.0.6
-- !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 6.4.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 6.4.0
-- !ruby/object:Gem::Dependency
-  name: rspec-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 5.1.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 5.1.2
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.31.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.31.1
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.11.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.11.1
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.22.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.22.0
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 3.14.0
-  type: :development
+        version: '3.1'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.14.0
+        version: '3.1'
 description: Enables login/logout functionality for a Ruby web app
 email: yegor256@gmail.com
 executables: []