code0-license 0.1.0.pre.release.testing

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a873c8ebbcf3823d0172aefb63983db2a55313e3b6427b77e21fcebd0140bba6
+  data.tar.gz: '0459751c4df8fea3f7f1ee7fad190a9ae6db9841b7eed8281c316ff986afac57'
+SHA512:
+  metadata.gz: 71ec932d10edbd3085691e257b6c0b6817a5baa8fd7fc88a6d362a2b72d9efb2afbd5ba1d17c15517c4f1d43608155a208a6191bf521bed70a95dba524357871
+  data.tar.gz: 60cc0049743b50bcd25705a95cb4627062ed498a9ad2b19f06780c2eb529aca5276d6fe939ea6b33cfa22e2357e6c91da43d255a9a299a8f89512f863aa387bf

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,33 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.0.0
+  NewCops: enable
+
+Gemspec/DevelopmentDependencies:
+  EnforcedStyle: gemspec
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.2.2

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in code0-license.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,76 @@
+PATH
+  remote: .
+  specs:
+    code0-license (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.1)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
+    parallel (1.24.0)
+    parser (3.3.1.0)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    regexp_parser (2.9.0)
+    rexml (3.2.6)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.63.4)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    rubocop-capybara (2.20.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.25.1)
+      rubocop (~> 1.41)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.29.1)
+      rubocop (~> 1.40)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+      rubocop-rspec_rails (~> 2.28)
+    rubocop-rspec_rails (2.28.3)
+      rubocop (~> 1.40)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.5.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  code0-license!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  rubocop-rake (~> 0.6)
+  rubocop-rspec (~> 2.29)
+
+BUNDLED WITH
+   2.4.12

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Niklas van Schrick
+
+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,17 @@
+# Code0::License
+
+`Code0::License` can create and validate software licenses.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add code0-license
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install code0-license
+
+## Usage
+
+To start using the gem, you need to have a public and private RSA key.

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/code0-license.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/code0/license/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "code0-license"
+  spec.version = Code0::License::VERSION
+  spec.authors = ["Niklas van Schrick"]
+  spec.email = ["mc.taucher2003@gmail.com"]
+
+  spec.summary = "code0-license is used to validate software licenses"
+  spec.homepage = "https://github.com/code0-tech/code0-license"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/releases"
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ spec/ .git .github])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 1.21"
+  spec.add_development_dependency "rubocop-rake", "~> 0.6"
+  spec.add_development_dependency "rubocop-rspec", "~> 2.29"
+  spec.metadata["rubygems_mfa_required"] = "true"
+end

data/lib/code0/license/boundary.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Code0
+  class License
+    # Responsible for adding and removing boundaries of strings
+    module Boundary
+      BOUNDARY_START  = /(\A|\r?\n)-*BEGIN .+? LICENSE-*\r?\n/
+      BOUNDARY_END    = /\r?\n-*END .+? LICENSE-*(\r?\n|\z)/
+
+      class << self
+        def add_boundary(data, license_name)
+          data = remove_boundary(data)
+
+          [
+            pad("BEGIN #{license_name} LICENSE", 60),
+            data.strip,
+            pad("END #{license_name} LICENSE", 60)
+          ].join("\n")
+        end
+
+        def remove_boundary(data)
+          after_boundary = data.split(BOUNDARY_START).last
+          after_boundary.split(BOUNDARY_END).first
+        end
+
+        private
+
+        def pad(str, length)
+          total_padding = [length - str.length, 0].max
+
+          padding = total_padding / 2.0
+          [
+            "-" * padding.ceil,
+            str,
+            "-" * padding.floor
+          ].join
+        end
+      end
+    end
+  end
+end

data/lib/code0/license/encryptor.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module Code0
+  class License
+    # Contains the encryption logic. Decoupled from actual license logic
+    class Encryptor
+      class Error < Code0::License::Error; end
+      class KeyError < Error; end
+      class DecryptionError < Error; end
+
+      attr_accessor :key
+
+      def initialize(key)
+        raise KeyError, "No RSA encryption key provided." if key && !key.is_a?(OpenSSL::PKey::RSA)
+
+        @key = key
+      end
+
+      def encrypt(data)
+        raise KeyError, "Provided key is not a private key." unless key.private?
+
+        # Encrypt the data using symmetric AES encryption.
+        cipher = OpenSSL::Cipher.new("aes-128-cbc")
+        cipher.encrypt
+        aes_key = cipher.random_key
+        aes_iv  = cipher.random_iv
+
+        encrypted_data = cipher.update(data) + cipher.final
+
+        # Encrypt the AES key using asymmetric RSA encryption.
+        encrypted_key = key.private_encrypt(aes_key)
+
+        encryption_data = {
+          "data" => Base64.encode64(encrypted_data),
+          "key" => Base64.encode64(encrypted_key),
+          "iv" => Base64.encode64(aes_iv)
+        }
+
+        json_data = JSON.dump(encryption_data)
+        Base64.encode64(json_data)
+      end
+
+      def decrypt(data)
+        raise KeyError, "Provided key is not a public key." unless key.public?
+
+        json_data = Base64.decode64(data.chomp)
+
+        begin
+          encryption_data = JSON.parse(json_data)
+        rescue JSON::ParserError
+          raise DecryptionError, "Encryption data is invalid JSON."
+        end
+
+        unless %w[data key iv].all? { |key| encryption_data[key] }
+          raise DecryptionError, "Required field missing from encryption data."
+        end
+
+        encrypted_data  = Base64.decode64(encryption_data["data"])
+        encrypted_key   = Base64.decode64(encryption_data["key"])
+        aes_iv          = Base64.decode64(encryption_data["iv"])
+
+        begin
+          # Decrypt the AES key using asymmetric RSA encryption.
+          aes_key = self.key.public_decrypt(encrypted_key)
+        rescue OpenSSL::PKey::RSAError
+          raise DecryptionError, "AES encryption key could not be decrypted."
+        end
+
+        # Decrypt the data using symmetric AES encryption.
+        cipher = OpenSSL::Cipher.new("aes-128-cbc")
+        cipher.decrypt
+
+        begin
+          cipher.key = aes_key
+        rescue OpenSSL::Cipher::CipherError
+          raise DecryptionError, "AES encryption key is invalid."
+        end
+
+        begin
+          cipher.iv = aes_iv
+        rescue OpenSSL::Cipher::CipherError
+          raise DecryptionError, "AES IV is invalid."
+        end
+
+        begin
+          data = cipher.update(encrypted_data) + cipher.final
+        rescue OpenSSL::Cipher::CipherError
+          raise DecryptionError, "Data could not be decrypted."
+        end
+
+        data
+      end
+    end
+  end
+end

data/lib/code0/license/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Code0
+  class License
+    VERSION = "0.1.0.pre.release.testing"
+  end
+end

data/lib/code0/license.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require "openssl"
+require "base64"
+require "date"
+require "json"
+
+require_relative "license/boundary"
+require_relative "license/version"
+
+module Code0
+  # Logic relating to license. Delegates encryption to Encryptor
+  class License
+    class Error < StandardError; end
+    class ValidationError < Error; end
+
+    class << self
+      def encryption_key=(key)
+        raise Error, "No RSA key provided." if key && !key.is_a?(OpenSSL::PKey::RSA)
+
+        @encryption_key = key
+      end
+
+      def load(data)
+        raise ValidationError, "No data" if data.nil?
+
+        data = Boundary.remove_boundary(data)
+
+        decrypted_license = encryptor.decrypt(data)
+
+        new(JSON.parse(decrypted_license))
+      rescue JSON::ParserError
+        raise ValidationError, "License data is invalid JSON"
+      end
+
+      def export(license, license_name)
+        license_data = JSON.dump(license.data)
+        encrypted_license = encryptor.encrypt(license_data)
+        Boundary.add_boundary(encrypted_license, license_name)
+      end
+
+      def encryptor
+        Encryptor.new(@encryption_key)
+      end
+    end
+
+    ATTRIBUTES = %i[
+      start_date
+      end_date
+      licensee
+      restrictions
+      options
+    ].freeze
+    attr_reader(*ATTRIBUTES)
+
+    def initialize(data)
+      assign_attributes(data)
+    end
+
+    def valid?
+      return false if !licensee || !licensee.is_a?(Hash) || licensee.empty?
+      return false if !start_date || !start_date.is_a?(Date)
+      return false if (!end_date || !end_date.is_a?(Date)) && !options["allow_missing_end_date"]
+
+      true
+    end
+
+    def in_active_time?
+      return false if start_date > Date.today
+      return true if !end_date && options["allow_missing_end_date"]
+      return false if !end_date && !options["allow_missing_end_date"]
+
+      end_date >= Date.today
+    end
+
+    def data
+      ATTRIBUTES.map { |attr| [attr, send(attr)] }.to_h
+    end
+
+    private
+
+    attr_writer(*ATTRIBUTES)
+
+    def assign_attributes(data)
+      %w[start_date end_date].each do |property|
+        value = data[property]
+        value = parse_date(data[property]) unless data[property].is_a?(Date)
+        send("#{property}=", value)
+      end
+
+      send("licensee=", data["licensee"])
+      send("restrictions=", data["restrictions"] || {})
+      send("options=", data["options"] || {})
+    end
+
+    def parse_date(str)
+      Date.parse(str)
+    rescue StandardError
+      nil
+    end
+  end
+end
+
+# this depends on constants defined in this class
+require_relative "license/encryptor"

data/sig/code0/license/boundary.rbs

@@ -0,0 +1,16 @@
+module Code0
+  class License
+    module Boundary
+      BOUNDARY_END: Regexp
+      BOUNDARY_START: Regexp
+
+      def self.add_boundary: (String, String) -> String
+
+      def self.pad: (String, Integer) -> String
+
+      private
+
+      def self.remove_boundary: (String) -> String
+    end
+  end
+end

data/sig/code0/license/encryptor.rbs

@@ -0,0 +1,13 @@
+module Code0
+  class License
+    class Encryptor
+      @key: OpenSSL::PKey::RSA
+      attr_accessor key: OpenSSL::PKey::RSA
+
+      def initialize: (OpenSSL::PKey::RSA) -> Encryptor
+
+      def decrypt: (String) -> String
+      def encrypt: (String) -> String
+    end
+  end
+end

data/sig/code0/license.rbs

@@ -0,0 +1,29 @@
+module Code0
+  class License
+    ATTRIBUTES: Array[Symbol]
+    VERSION: String
+
+    self.@encryption_key: OpenSSL::PKey::RSA
+    @data: Hash[String, any]
+
+    def self.encryption_key=: (OpenSSL::PKey::RSA) -> void
+
+    def self.export: (License, String) -> String
+
+    def self.load: (String) -> License
+
+    def self.encryptor: -> Encryptor
+
+    attr_reader data: Hash[String, any]
+
+    def in_active_time?: -> bool
+
+    def valid?: -> bool
+
+    private
+
+    def assign_attributes: (Hash[String, any]) -> void
+
+    def parse_date: (String) -> Date?
+  end
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: code0-license
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre.release.testing
+platform: ruby
+authors:
+- Niklas van Schrick
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.29'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.29'
+description: 
+email:
+- mc.taucher2003@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".tool-versions"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- code0-license.gemspec
+- lib/code0/license.rb
+- lib/code0/license/boundary.rb
+- lib/code0/license/encryptor.rb
+- lib/code0/license/version.rb
+- sig/code0/license.rbs
+- sig/code0/license/boundary.rbs
+- sig/code0/license/encryptor.rbs
+homepage: https://github.com/code0-tech/code0-license
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/code0-tech/code0-license
+  source_code_uri: https://github.com/code0-tech/code0-license
+  changelog_uri: https://github.com/code0-tech/code0-license/releases
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.4.10
+signing_key: 
+specification_version: 4
+summary: code0-license is used to validate software licenses
+test_files: []