actionhash 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e572be34c1fe6fb616b9337a9cbeb30f8aae54b5ed838429fb1deb3e0e182184
+  data.tar.gz: f85bb350444e5bac864404934980d0dcbc29befc5c4089c3a8eab6b98b78f878
+SHA512:
+  metadata.gz: 6c23cbe7e6aeefe57d7e1fcc277ff2a22eb0d45d067dac399c54c7ca566a564bfc86f29dfe0e2f03e2ba31162a7d84251898a8a6d5f866c536c45c6c6a142368
+  data.tar.gz: 7943e8f3d80b98ac96d9b4e162063ac74eeab2ac969e448852f6fc77a26f5f611108e15cf7569f460e85baa6b1d73baef30a1aaea58fb11473c644373ca5c9c1

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at ceo@pixelatedstudios.net. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,65 @@
+PATH
+  remote: .
+  specs:
+    actionhash (1.0.0)
+      dotenv (~> 2.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    base64 (0.1.1)
+    diff-lcs (1.5.0)
+    dotenv (2.8.1)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.1)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.56.3)
+      base64 (~> 0.1.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  actionhash!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.4.10

data/LICENSE

@@ -0,0 +1,71 @@
+PixelRidge Business Exclusive General Public Use License for Software Executables (PixelRidge-BEGPULSE)
+
+## Version 1.3
+
+### Preamble
+
+This License governs the terms under which the software ("Software") provided by PixelRidge Softworks ("Licensor") may be used, modified, and distributed.
+
+### 1. Definitions
+
+- **Software**: The original software and associated documentation provided under this license.
+- **Business Purposes**: Any activity designed with the main intent to generate revenue or profit.
+- **Modification**: Any change or addition to the Software's source code or executable.
+- **Distribution**: The act of making the Software available to third parties.
+- **Contributor**: Any individual or entity that modifies or distributes the Software.
+
+### 2. License Grant
+
+Subject to the terms and conditions of this License, Licensor hereby grants you a worldwide, non-exclusive, non-transferable, non-sublicensable license to use and modify the Software.
+
+### 3. Attribution
+
+You must provide attribution to the Licensor by including a plain-view URI (or link) to the Licensor's website. This link must be easily visible to all users and not hidden under any circumstances. It should be noted that this should only apply in the event that it can. In the event a public link is impossible due to the nature of the usage of the Software, it's expected that attribution be given in a way such that the attribution complies with the Open Source Initiative standards for Open Source Attribution.
+
+### 4. Business Use
+
+If you wish to use the Software for Business Purposes, you must obtain written permission from PixelRidge Softworks. Failure to obtain such permission will result in a violation of this License.
+
+### 5. Indemnification
+
+You agree to indemnify, defend, and hold harmless PixelRidge Softworks and its affiliates from and against any and all claims, damages, losses, liabilities, costs, and expenses arising out of or relating to your use or distribution of the Software.
+
+### 6. No Warranty and Limitation of Liability
+
+The Software is provided "AS-IS," without any warranty of any kind, either express or implied. The Software is designed to be highly secure but will only be as secure as the system on which it is deployed. On an insecure system, the Software may exacerbate existing security issues. PixelRidge Softworks shall not be liable for any damages arising from the use of the Software.
+
+### 7. Updates and Versioning
+
+PixelRidge Softworks may or may not provide updates to the Software in the future. There is no obligation to provide updates or support for the Software. The latest version of this License shall always be considered the governing terms. PixelRidge Softworks will provide reasonable notice in the event of a license change. Notice shall be provided via email. Due to spam laws, we cannot just email you. You may opt into our specialized mailing list for licensing on our website.
+
+### 8. Source Code Availability
+
+Any modifications to the Software must remain open-source and source-available in their entirety unless another agreement with the Licensor is formed.
+
+### 9. Compliance Monitoring
+
+Compliance with this License may or may not be monitored by PixelRidge Softworks. You grant PixelRidge Softworks the right to monitor for compliance as it sees fit.
+
+### 10. Data Collection
+
+If the Software collects any data, such data will be used in accordance with PixelRidge Softworks' privacy policy.
+
+### 11. Export Control
+
+You agree not to use the Software in violation of any export laws or regulations.
+
+### 12. Termination and Revocation
+
+This License will automatically terminate if you fail to comply with any of its terms or conditions. Revocation is allowed only in the event of a violation of this License.
+
+### 13. Dispute Resolution
+
+Any disputes arising out of this License shall be resolved through arbitration in Alberta, Canada.
+
+### 14. Jurisdiction
+
+This License shall be governed by the laws of Alberta, Canada.
+
+### 15. Miscellaneous
+
+This License constitutes the entire agreement between you and PixelRidge Softworks concerning the Software.

data/README.md

@@ -0,0 +1,97 @@
+# ActionHash
+
+## Overview
+
+ActionHash is a Ruby gem designed to validate a series of actions while obfuscating the associated data. It's particularly useful in scenarios where you want to ensure the integrity of a sequence of actions or data points, such as in gaming, financial transactions, IoT devices, and more.
+
+> :warning: **Security Note**: While ActionHash does obfuscate data, it should not be considered a form of encryption. If someone gains access to the generated secret key, the hashes can be undone. Use this gem as a part of your security strategy, not as the sole mechanism for securing sensitive information.
+
+## Installation
+
+```bash
+gem install actionhash
+```
+
+Or add it to your Gemfile:
+
+```ruby
+gem 'actionhash'
+```
+
+Then run:
+
+```bash
+bundle install
+```
+
+## Basic Usage
+
+Here's a simple example to get you started:
+
+```ruby
+require 'actionhash'
+
+# Initialize
+keys = [ActionHash.generate_new_key]
+hashes = []  # Array to store finished hashes
+action_count = 0
+prev_hash = '0'
+data = "some_data"
+
+# Create a hash
+new_hash = ActionHash.create(prev_hash, data, keys.last)
+hashes << new_hash  # Store the hash
+```
+
+### Validating a Hash
+
+You can validate a hash using the `valid_hash?` method as follows:
+
+```ruby
+# Validate the hash
+is_valid = ActionHash.valid_hash?(hashes.last, keys.last, 20)
+
+if is_valid
+  puts "Hash is valid."
+else
+  puts "Hash is invalid."
+end
+```
+
+The `valid_hash?` method works by recursively decrypting the hash and checking if it reaches a base hash of '0'. It takes the hash, the key, and an optional level parameter to limit the depth of validation.
+
+Here's the method definition for your reference:
+
+```ruby
+def self.valid_hash?(hash, key, level = 20)
+  current_level = 0
+  loop do
+    puts "Debug: Validating hash=#{hash} with key=#{key} at level=#{current_level}"
+    return false if current_level >= level
+
+    decrypted_data = down_layer(hash, key)
+    return true if decrypted_data[:prev_hash] == '0'
+    return false if decrypted_data[:prev_hash].nil? || decrypted_data[:prev_hash].empty?
+
+    hash = decrypted_data[:prev_hash]
+    current_level += 1
+  end
+end
+```
+
+## Development Builds
+
+For those interested in using development builds of ActionHash, you can install them directly from our Gem server hosted at PixelRidge Softworks.
+
+Here's how you can install a development build:
+
+```bash
+gem install ActionHash --source "https://git.pixelridgesoftworks.com/api/packages/PixelRidge-Softworks/rubygems"
+```
+
+As an example, if you want to install a different gem from our Gem server, you can use the following command:
+
+```bash
+gem install Miniparser --source "https://git.pixelridgesoftworks.com/api/packages/PixelRidge-Softworks/rubygems"
+```
+

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/actionhash.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'lib/actionhash/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'actionhash'
+  spec.version = Actionhash::VERSION
+  spec.authors = ['PixelRidge Softworks']
+  spec.email = ['ceo@pixelridgesoftworks.com']
+
+  spec.summary = 'A custom hash mechanism for action tracking and validation.'
+  spec.description = 'ActionHash is a Ruby gem designed to validate a series of actions while obfuscating the associated
+                      data. Its particularly useful in scenarios where you want to ensure the integrity of a sequence of
+                      actions or data points, such as in gaming, financial transactions, IoT devices, and more. Please
+                      go to the homepage for more information about how to use this gem!'
+  spec.homepage = 'https://git.pixelridgesoftworks.com/PixelRidge-Softworks/ActionHash'
+  spec.license = 'PixelRidge-BEGPULSE'
+  spec.required_ruby_version = '>= 3.2.2'
+
+  spec.metadata['allowed_push_host'] = 'https://git.pixelridgesoftworks.com/api/packages/PixelRidge-Softworks/rubygems'
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://git.pixelridgesoftworks.com/PixelRidge-Softworks/ActionHash'
+
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+end

data/lib/actionhash/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Actionhash
+  VERSION = '1.0.0'
+end

data/lib/actionhash.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_relative 'actionhash/version'
+require 'securerandom'
+
+module ActionHash
+  class Error < StandardError; end
+
+  @key_usage_count = {}
+  MAX_ACTIONS_PER_KEY = 10
+
+  # Generate a new key
+  def self.generate_new_key
+    SecureRandom.hex(8)
+  end
+
+  # Create a new Action Hash
+  def self.create(prev_hash, input_data, key)
+    # Check if the key has reached its limit
+    @key_usage_count[key] ||= 0
+    if @key_usage_count[key] >= MAX_ACTIONS_PER_KEY
+      raise Error, 'Key has reached its maximum usage. Please generate a new key.'
+    end
+
+    data = [prev_hash, input_data].join(',')
+    encrypted_data = xor_encrypt(data, key)
+    encrypted_hex = encrypted_data.unpack1('H*') # Convert to hex
+
+    # Increment the usage count for the key
+    @key_usage_count[key] += 1
+
+    encrypted_hex
+  end
+
+  # Decrypt an Action Hash to its components
+  def self.down_layer(hash, key)
+    hex_decoded = [hash].pack('H*') # Convert from hex
+    decrypted_data = xor_encrypt(hex_decoded, key)
+    prev_hash, input_data = decrypted_data.split(',')
+    { prev_hash: prev_hash.to_s, input_data: input_data.to_s }
+  end
+
+  # XOR encrypt/decrypt (symmetric)
+  def self.xor_encrypt(data, key)
+    data.bytes.zip(key.bytes.cycle).map { |a, b| (a ^ b).chr }.join
+  end
+
+  # Validate if a hash can be traced back to '0'
+  def self.valid_hash?(hash, key, level = 20)
+    current_level = 0
+    loop do
+      return false if current_level >= level
+
+      decrypted_data = down_layer(hash, key)
+      return true if decrypted_data[:prev_hash] == '0'
+      return false if decrypted_data[:prev_hash].nil? || decrypted_data[:prev_hash].empty?
+
+      hash = decrypted_data[:prev_hash]
+      current_level += 1
+    end
+  end
+end

data/sig/actionhash.rbs

@@ -0,0 +1,4 @@
+module Actionhash
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/tests/hash_generator.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'actionhash' # Update this path to where your ActionHash module is located
+
+class ActionHashTest
+  def initialize
+    @keys = [ActionHash.generate_new_key] # Initialize an array to store keys
+    puts "Generated key: #{@keys.last}"
+    @hashes = []
+    @action_count = 0
+  end
+
+  def run_test(depth)
+    prev_hash = '0'
+    data = 30
+
+    depth.times do |i|
+      puts "Layer #{i + 1}:"
+
+      # Check if the key has reached its limit and generate a new one if necessary
+      if @action_count >= ActionHash::MAX_ACTIONS_PER_KEY
+        @keys << ActionHash.generate_new_key # Generate and store a new key
+        puts "Generated new key: #{@keys.last}"
+        @action_count = 0
+        prev_hash = '0' # Reset prev_hash for the new key
+      end
+
+      current_key = @keys.last # Use the last key in the array
+      new_hash = ActionHash.create(prev_hash, data.to_s, current_key)
+      puts "Generated hash: #{new_hash}"
+      @hashes << { hash: new_hash, key: current_key }
+      prev_hash = new_hash
+      data *= 2
+
+      @action_count += 1
+    end
+
+    validate_hashes
+  end
+
+  def validate_hashes
+    puts "\nValidating hashes..."
+    all_valid = true
+    prev_hash = '0' # Initialize prev_hash to '0' as in the run_test method
+    current_key_index = 0 # Initialize index to keep track of the current key
+
+    @hashes.each_with_index do |hash_data, index|
+      hash = hash_data[:hash]
+      key = hash_data[:key]
+
+      # Check if we need to switch to the next key
+      if current_key_index < @keys.length - 1 && key != @keys[current_key_index]
+        current_key_index += 1
+        prev_hash = '0' # Reset prev_hash for the new key
+      end
+
+      decrypted_data = ActionHash.down_layer(hash, key)
+      puts "Decrypted data: #{decrypted_data[:prev_hash]},#{decrypted_data[:input_data]}"
+      puts "Current level: #{index + 1}"
+      puts "Current hash: #{hash}"
+
+      if decrypted_data[:prev_hash] != prev_hash
+        puts "Hash at level #{index + 1} is invalid."
+        all_valid = false
+        break
+      end
+
+      prev_hash = hash # Update prev_hash for the next iteration
+    end
+
+    puts all_valid ? 'All hashes are valid.' : 'Hash validation failed.'
+  end
+end
+
+if ARGV.length != 1 || !ARGV[0].match?(/^\d+$/)
+  puts "Usage: ruby #{__FILE__} [depth]"
+  exit 1
+end
+
+depth = ARGV[0].to_i
+test = ActionHashTest.new
+test.run_test(depth)

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: actionhash
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- PixelRidge Softworks
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-09-20 00:00:00.000000000 Z
+dependencies: []
+description: |-
+  ActionHash is a Ruby gem designed to validate a series of actions while obfuscating the associated
+                        data. Its particularly useful in scenarios where you want to ensure the integrity of a sequence of
+                        actions or data points, such as in gaming, financial transactions, IoT devices, and more. Please
+                        go to the homepage for more information about how to use this gem!
+email:
+- ceo@pixelridgesoftworks.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- actionhash.gemspec
+- lib/actionhash.rb
+- lib/actionhash/version.rb
+- sig/actionhash.rbs
+- tests/hash_generator.rb
+homepage: https://git.pixelridgesoftworks.com/PixelRidge-Softworks/ActionHash
+licenses:
+- PixelRidge-BEGPULSE
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://git.pixelridgesoftworks.com/PixelRidge-Softworks/ActionHash
+  source_code_uri: https://git.pixelridgesoftworks.com/PixelRidge-Softworks/ActionHash
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: A custom hash mechanism for action tracking and validation.
+test_files: []